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.

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": "2025-12-17T21:49:50.582Z",
    "allow_short_loads": 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"
        }
      },
      "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"
        }
      },
      "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"
        }
      },
      "assignee": {
        "username": "string",
        "name": "string"
      }
    }
  }
]
Loading...