Get a payables invoice

Request

Returns a single payables invoice by its external ID. Implementation is required.

Tax note: Tax-related fields (e.g., tax on amounts, tax code references) are marked as required but are optional for non-tax / US-based accounts. BravoTran determines the tax mode based on the authenticated account.

Payables invoices contain nested charge lines, each referencing a job and optionally an accrual.

Security

OAuth2.0-Partner or Bearer-Token-Partner

Path

external_idstringrequired

The unique, immutable identifier for the entity in the FFS.

curl -i -X GET \
  'https://apidocs.bravotran.com/_mock/openapi/payables-invoices/{external_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Payables invoice details

Bodyapplication/json

external_idstringrequired

Unique, immutable identifier for this invoice.

updated_atstring, (date-time)required

ISO 8601 timestamp of when this invoice was last updated.

creditorobject(EntityRef)required

Reference to the creditor org that issued this invoice.

invoice_numberstringrequired

Invoice number. Must be unique scoped to the creditor.

invoice_datestring, (date)required

ISO 8601 date of the invoice.

statusstringrequired

Current status of the invoice in the FFS:

draft — entered but not yet posted to the ledger
posted — posted to the ledger

Enum:"draft""posted"

overseas_amountobject(AmountWithTax)required

Total invoice amount in the overseas (invoice) currency.

charge_linesArray of objects, non-empty(ChargeLine)required

Line items on the invoice.

Response

{
  "external_id": "b6d1fdec-81ff-43b9-b422-ae27513047ce",
  "updated_at": "2025-02-15T03:18:13Z",
  "creditor": {
    "external_id": "feaa09da-9551-47f8-b30d-6e303b6ad6d5"
  },
  "invoice_number": "SYD923891",
  "invoice_date": "2025-02-15",
  "status": "posted",
  "overseas_amount": {
    "currency": "AUD",
    "pre_tax": 1770,
    "tax": 20,
    "total": 1790
  },
  "charge_lines": [
    { … },
    { … }
  ]
}