Skip to navigation

Retrieve an invoice

Beta

Returns a single invoice by its id.

Beta: available to selected customers. Contact your Kota account manager for access.

Authentication

AuthorizationBearer
Authorization header using the Bearer scheme

Path parameters

invoice_idstringRequiredformat: "inv_.+"

Headers

X-Platform-IdstringOptional

The target platform id. Required only when calling with a dashboard (WorkOS AuthKit) access token instead of a platform API key — the token carries no platform claim, so the caller must say which platform it means. Ignored for platform API key / embed session token callers.

Response

OK
idstringformat: "inv_.+"

Unique identifier for the invoice. Prefixed with inv_.

provider_idstringformat: "pr_.+"

The provider that issued the invoice. Prefixed with pr_.

employer_idslist of strings

The employers this invoice is linked to. Prefixed with er_.

invoice_datedate
The date the invoice was issued.
currencystring
ISO 4217 currency code.
total_grossdouble

Total gross amount of the invoice (net plus tax).

documentslist of objects
The original documents issued by the provider for this invoice, such as the invoice itself and its itemised detail.
objectstringOptionalRead-only

The object type. Always invoice.

invoice_numberstring or nullOptional
The provider's invoice reference, where the provider issues one.
total_taxdouble or nullOptional
Total tax on the invoice.

Errors

404
Not Found Error