Skip to content

List tax codes

Request

Returns the full list of tax codes.

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

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

Responses

List of tax codes.

Bodyapplication/json
Array [
external_idstringrequired

Unique, immutable identifier for this tax code.

updated_atstring, (date-time)required

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

codestringrequired

Short code the user might know for this tax code.

descriptionstringrequired

Human-readable description of the tax code.

tax_ratenumber, [ 0 .. 100 ]required

Tax rate percentage between 0.0 and 100.0 (e.g., 10.0 for 10% GST).

is_activebooleanrequired

Whether this tax code is currently active.

]
Response
[
  {
    "external_id": "3c01e205-aecd-4d34-ac19-fe4dea96a195",
    "updated_at": "2024-07-02T09:15:33Z",
    "code": "GST",
    "description": "Goods and services tax (10%)",
    "tax_rate": 10,
    "is_active": true
  },
  {
    "external_id": "940dca09-88d4-403e-be23-79a23d37fffd",
    "updated_at": "2024-07-02T09:15:33Z",
    "code": "FRE",
    "description": "GST free",
    "tax_rate": 0,
    "is_active": true
  }
]