Skip to main content

Counterparty All Ep

POST 
/v1/counterparty/all

Counterparty All

Retrieves detailed information about all counterparties in the system, including their roles, contact information, and associated data.

Required Scopes (ia.r)

Response​

id: str
Internal identifier for the counterparty.

name: str
The unique name of the counterparty.

types: list[str] | None = None
Indicates all the counterparty’s types or roles. A counterparty can fulfill multiple roles.

Show Types

Carrier
A counterparty that acts as a carrier.

Internal
An internal counterparty.

Supplier
A supplier of fuel.

Customer
A customer of fuel.

Other
Any other type of counterparty.

scac: str | None = None
If the counterparty is of type carrier, this is the Standard Carrier Alpha Code.

trailer_config: str | None = None
The trailer configuration associated with the counterparty, if applicable.

source_id: int | None = None
If received from integration, the identifier within the source system.

source_system_id: int | None = None
If received from integration, the identifier for the source system.

emails: list[str] | None = None
List of email addresses associated with the counterparty.

extra_data: object | None = None
Any additional data provided by the client or managed through integration endpoints.

updated_on: datetime | None = None
The timestamp of the most recent update to the counterparty data.

Show Deprecated

carrier_type: str | None = None
Deprecated. If the counterparty has type Carrier in types, specifies the type of carrier, which can be Simple, Managed, or Other. A counterparty can have only one carrier type.

available_credit: float | None = None
The amount of available credit for the counterparty.

hold: bool | None = False
Indicates if the counterparty is on credit hold or not.

active: bool = True
Whether the counterparty is active.

goid: str | None = None
The counterparty's global organization id, used to identify it across the partner network.

source_system: str | None = None
If received from integration, the name of the source system.

sourcing_strategy: SourcingStrategy | None = None
The counterparty's default sourcing strategy, applied to orders that do not specify one. One of Specific Supply, Tank Supply Default, Use Best, or Manual.

allow_short_loads: bool | None = False
Whether orders for this counterparty may be built as short loads.

requires_approval: bool | None = False
Whether orders for this counterparty require approval.

order_notification_preferences: list[OrderReqNotificationStates] | None = []
Which order-request states this counterparty is notified on. Values: received, acknowledged, in progress, arrived at terminal, delivered, canceled, no notifications.

supply_map: list[SourceMap] | None = []
List of source_system and source_id mappings. Used for the eBOL process.

Show SourceMap Attributes

source_system: str
System name.

source_id: str
ID in the source system.

ebol_all_terminals: bool = True
Whether this supplier participates in eBOL matching at every terminal. When False, only the terminals in ebol_terminal_ids participate and movements elsewhere are exempt rather than unmatched.

ebol_terminal_ids: list[str] = []
The terminals that participate in eBOL matching for this supplier when ebol_all_terminals is False.

supplier_rec_hold: bool = False
When True, supplier-reconciliation matches for this supplier are held rather than auto-approved.

supplier_rec_config: SupplierRecConfig | None = None
Per-supplier reconciliation rules.

Show Child Attributes

auto_match_rules: MatchRules | None = None
Which comparisons must agree for an invoice to auto-match to a BOL.

auto_approve_rules: MatchRules | None = None
Which comparisons must agree for a match to auto-approve.

warning_rules: MatchRules | None = None
Which comparisons raise a warning rather than block.

assignee: Assignee | None = None
Default assignee for this supplier's matches, as a username / name pair.

Show MatchRules Attributes

Each rule is an object with an enabled flag; threshold-bearing rules add a threshold and a fixed unit.

by_total_amount: ThresholdRule
Match on invoice total, within a currency threshold.

by_bol_date: TimeThresholdRule
Match on BOL date, within a threshold in hours.

by_terminal: BasicRule
Require the terminal to agree.

by_supplier: BasicRule
Require the supplier to agree.

by_product: BasicRule
Require the product to agree.

by_total_gross_volume: PercentThresholdRule
Match on gross volume, within a percent threshold (0–1).

by_total_net_volume: PercentThresholdRule
Match on net volume, within a percent threshold (0–1).

by_total_product_cost: PercentThresholdRule
Match on product cost, within a percent threshold (0–1).

by_total_per_unit: PercentThresholdRule
Match on per-volume price, within a percent threshold (0–1).

by_tax_total: PercentThresholdRule
Match on tax total, within a percent threshold (0–1).

max_invoice_total: ThresholdRule
Cap the invoice total eligible for the rule set, in currency.

attributes: dict[str, bool | float | str] = {}
Custom attributes applied to the counterparty, keyed by attribute definition id. Attribute definitions are managed in the application; each definition fixes the value type of its entry (boolean, number, string, or presence-only exists).

Responses​

Successful Response

[
  {
    "id": "string",
    "name": "string",
    "goid": "string",
    "scac": "string",
    "types": [
      "string"
    ],
    "carrier_type": "string",
    "trailer_config": "string",
    "source_id": "string",
    "source_system": "string",
    "source_system_id": "string",
    "emails": [
      "string"
    ],
    "sourcing_strategy": "Specific Supply",
    "extra_data": {},
    "updated_on": "2026-09-25T19:33:18.193Z",
    "allow_short_loads": true,
    "requires_approval": true,
    "order_notification_preferences": [
      "received"
    ],
    "supply_map": [
      {
        "source_system": "string",
        "source_id": "string"
      }
    ],
    "available_credit": 0,
    "hold": true,
    "supplier_rec_hold": false,
    "supplier_rec_config": {
      "auto_match_rules": {
        "by_total_amount": {
          "enabled": false,
          "threshold": 0,
          "unit": "currency"
        },
        "by_bol_date": {
          "enabled": false,
          "unit": "hours",
          "threshold": 0
        },
        "by_terminal": {
          "enabled": false
        },
        "by_supplier": {
          "enabled": false
        },
        "by_product": {
          "enabled": false
        },
        "by_total_gross_volume": {
          "enabled": false,
          "threshold": 0,
          "unit": "percent"
        },
        "by_total_net_volume": {
          "enabled": false,
          "threshold": 0,
          "unit": "percent"
        },
        "by_total_product_cost": {
          "enabled": false,
          "threshold": 0,
          "unit": "percent"
        },
        "by_total_per_unit": {
          "enabled": false,
          "threshold": 0,
          "unit": "percent"
        },
        "by_tax_total": {
          "enabled": false,
          "threshold": 0,
          "unit": "percent"
        },
        "max_invoice_total": {
          "enabled": false,
          "threshold": 0,
          "unit": "currency"
        }
      },
      "auto_approve_rules": {
        "by_total_amount": {
          "enabled": false,
          "threshold": 0,
          "unit": "currency"
        },
        "by_bol_date": {
          "enabled": false,
          "unit": "hours",
          "threshold": 0
        },
        "by_terminal": {
          "enabled": false
        },
        "by_supplier": {
          "enabled": false
        },
        "by_product": {
          "enabled": false
        },
        "by_total_gross_volume": {
          "enabled": false,
          "threshold": 0,
          "unit": "percent"
        },
        "by_total_net_volume": {
          "enabled": false,
          "threshold": 0,
          "unit": "percent"
        },
        "by_total_product_cost": {
          "enabled": false,
          "threshold": 0,
          "unit": "percent"
        },
        "by_total_per_unit": {
          "enabled": false,
          "threshold": 0,
          "unit": "percent"
        },
        "by_tax_total": {
          "enabled": false,
          "threshold": 0,
          "unit": "percent"
        },
        "max_invoice_total": {
          "enabled": false,
          "threshold": 0,
          "unit": "currency"
        }
      },
      "warning_rules": {
        "by_total_amount": {
          "enabled": false,
          "threshold": 0,
          "unit": "currency"
        },
        "by_bol_date": {
          "enabled": false,
          "unit": "hours",
          "threshold": 0
        },
        "by_terminal": {
          "enabled": false
        },
        "by_supplier": {
          "enabled": false
        },
        "by_product": {
          "enabled": false
        },
        "by_total_gross_volume": {
          "enabled": false,
          "threshold": 0,
          "unit": "percent"
        },
        "by_total_net_volume": {
          "enabled": false,
          "threshold": 0,
          "unit": "percent"
        },
        "by_total_product_cost": {
          "enabled": false,
          "threshold": 0,
          "unit": "percent"
        },
        "by_total_per_unit": {
          "enabled": false,
          "threshold": 0,
          "unit": "percent"
        },
        "by_tax_total": {
          "enabled": false,
          "threshold": 0,
          "unit": "percent"
        },
        "max_invoice_total": {
          "enabled": false,
          "threshold": 0,
          "unit": "currency"
        }
      },
      "assignee": {
        "username": "string",
        "name": "string"
      }
    },
    "active": true,
    "ebol_all_terminals": true,
    "ebol_terminal_ids": [
      "string"
    ],
    "attributes": {}
  }
]
Loading...