Retrieve an invoice
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_id
Headers
X-Platform-Id
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
id
Unique identifier for the invoice. Prefixed with inv_.
provider_id
The provider that issued the invoice. Prefixed with pr_.
employer_ids
The employers this invoice is linked to. Prefixed with er_.
invoice_date
The date the invoice was issued.
currency
ISO 4217 currency code.
total_gross
Total gross amount of the invoice (net plus tax).
documents
The original documents issued by the provider for this invoice, such as the invoice itself and its itemised detail.
object
The object type. Always invoice.
invoice_number
The provider's invoice reference, where the provider issues one.
total_tax
Total tax on the invoice.
Errors
404
Not Found Error

