Skip to content

List charge codes

Request

Returns the full list of charge codes.

Optional. Provided as an alternative to flat file delivery of charge code data. Accruals and charge lines reference charge codes by external_id.

Security
OAuth2.0-Partner or Bearer-Token-Partner
curl -i -X GET \
  https://apidocs.bravotran.com/_mock/openapi/charge-codes \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List of charge codes.

Bodyapplication/json
Array [
external_idstringrequired

Unique, immutable identifier for this charge code.

updated_atstring, (date-time)required

ISO 8601 timestamp of when this charge code was last updated.

codestringrequired

Short code the user might know for this charge code.

descriptionstringrequired

Human-readable description of the charge code.

charge_typestringrequired

Classification of the charge:

  • freight — freight / carriage charges
  • origin — origin-side charges
  • destination — destination-side charges
  • other — anything else
Enum:"freight""origin""destination""other"
tax_codeEntityRef (object) or nullrequired
One of:

Reference to the default tax code for this charge code. Must match an external_id from the tax codes data. Required for GST/VAT accounts; may be null for non-tax / US-based accounts.

is_activebooleanrequired

Whether this charge code is currently active.

]
Response
[
  {
    "external_id": "eda74483-b7d9-4168-9a20-82155e59395f",
    "updated_at": "2024-08-21T11:30:02Z",
    "code": "FRT",
    "description": "International Freight",
    "charge_type": "freight",
    "tax_code": { … },
    "is_active": true
  },
  {
    "external_id": "ff815915-de16-4c63-8248-4757aea906e9",
    "updated_at": "2024-08-21T11:30:02Z",
    "code": "CCL",
    "description": "Customs Clearance Fee",
    "charge_type": "destination",
    "tax_code": { … },
    "is_active": true
  }
]