Skip to main content
GET
Get an invoice by ID

Headers

X-Business-Id
string
required

Business identifier for external auth. Find in Polinate app → Business Settings → Integrations.

Example:

"{{businessId}}"

X-API-Key
string
required

Per-business API key for external auth. Find in Polinate app → Business Settings → Integrations.

Example:

"{{apiKey}}"

Path Parameters

id
string
required
Example:

"inv_123"

Response

OK

id
string
required
status
enum<string>
Available options:
DELETED,
DRAFT,
AUTHORISED,
PARTIALLY_PAID,
PAID,
OVERPAID,
OVERDUE,
VOIDED,
DEFAULTED,
CREDITED,
REFUNDED
reference
string
notes
string
createdAt
string
updatedAt
string
properties
object
invoiceLineItems
object[]