Skip to main content
GET
Get Invoice

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

invoiceId
string<uuid>
required

The unique identifier for the invoice

Response

get invoice response

An invoice document

id
string<uuid>
Example:

"8ef9a712-cdae-4110-b1ea-9ba95abbee6e"

status
enum<string>
Available options:
pending,
approved,
rejected,
partially paid,
paid,
overdue,
cancelled
Example:

"paid"

source
enum<string>

Origin of the invoice. Only invoices with source CONTRACTOR_SUBMITTED are reviewable via the review endpoint.

Available options:
SYSTEM,
USER,
REIMBURSEMENT,
PAYROLL,
CONTRACTOR_SUBMITTED
Example:

"CONTRACTOR_SUBMITTED"

invoiceNumber
string

Human-readable invoice number

Example:

"1764332528"

date
string<date>

Invoice date

Example:

"2025-11-28"

dueDate
string<date>

Payment due date

Example:

"2025-11-26"

from
object

Invoice issuer

billTo
object

Invoice recipient

items
object[]
subtotal
object

Subtotal before any adjustments

total
object

Total amount due

baseCurrency
string

Base currency for the invoice

Example:

"USD"

fxRates
object

Exchange rates used in this invoice

Example:
purpose
string

Purpose of the invoice

Example:

"Payment Processing Fee"

notes
string

Additional notes

Example:

"Payment for services rendered"

createdTimestamp
integer<int64>

Unix timestamp when invoice was created

Example:

1764332530

lastUpdatedTimestamp
integer<int64>

Unix timestamp when invoice was last updated

Example:

1764339673