List invoices

get

https://public-api.spendesk.com/v2/companies/{companyId}/invoices

Allowed Scopes: experimental:invoice:read

Returns supplier invoices for the company, most-recent first by default, using forward-only cursor pagination. The createdAfter, createdBefore, updatedAfter and updatedBefore filters use only the UTC date of the value: After includes that day, Before excludes it. Invoice data is cached for up to 20 minutes. Changes, including those made through the API, can take up to 20 minutes to appear.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

string

required

Company ID.

Query Params

ids

array of objects

length ≤ 50

ids

invoiceNumber

string

Filter by the supplier's invoice number (case-insensitive exact match). Ignored with type=creditNote; use search to find a credit note by its number.

supplierId

array of strings

length ≤ 50

supplierId

buyerId

array of strings

length ≤ 50

buyerId

purchaseOrderId

array of strings

length ≤ 50

purchaseOrderId

costCenterId

array of strings

length ≤ 50

costCenterId

expenseCategoryId

array of strings

length ≤ 50

Filter by expense category, matching the ids in the invoice expenseCategories. A split invoice matches if any of its categories does.

expenseCategoryId

type

string

enum

Kind of document the record represents.

Type	Description
`invoice`	A supplier invoice: an amount the company owes the supplier for goods or services. Amounts are positive.
`creditNote`	A supplier credit note: a document from the same supplier that reduces an amount owed (a refund, cancellation, or correction of a prior invoice). Amounts are negative.

Allowed:

stage

array of objects

Filter by stage; any of the listed values matches. When omitted, every stage except cancelled is returned; pass cancelled to get cancelled invoices. Draft and incomplete invoices are never listed here, not even under pendingApproval; fetch one by ID instead, which fails while it still lacks a supplier, issue date or currency. A credit note in dispute with the supplier is never returned or counted, under any stage.

stage

Allowed:

paymentStatus

array of objects

paymentStatus

Allowed:

paymentSource

array of objects

Not applied yet: results are not filtered by payment source.

paymentSource

Allowed:

paymentMethod

array of objects

Not applied yet: results are not filtered by payment method.

paymentMethod

exportStatus

array of objects

exportStatus

Allowed:

documentaryEvidenceStatus

array of objects

documentaryEvidenceStatus

Allowed:

isDisputed

boolean

true: only invoices currently in dispute with the supplier, the same as stage disputed; false: all others. Combined with stage, both must match. An invoice archived after a dispute is cancelled, not disputed, and credit notes are never returned as disputed.

currency

string

^[A-Z]{3}$

If the payment was made in a foreign currency, this amount will be the one in the payment currency. Three-letter ISO currency codes.

minGrossAmount

integer

maxGrossAmount

integer

issuedAfter

date

String containing a date expressed in ISO 8601 format like 2023-05-12.

issuedBefore

date

String containing a date expressed in ISO 8601 format like 2023-05-12.

dueAfter

date

String containing a date expressed in ISO 8601 format like 2023-05-12.

dueBefore

date

String containing a date expressed in ISO 8601 format like 2023-05-12.

createdAfter

date-time

String containing a UTC datetime expressed in ISO 8601 format like 2023-05-12T14:06:40Z.

createdBefore

date-time

String containing a UTC datetime expressed in ISO 8601 format like 2023-05-12T14:06:40Z.

updatedAfter

date-time

String containing a UTC datetime expressed in ISO 8601 format like 2023-05-12T14:06:40Z.

updatedBefore

date-time

String containing a UTC datetime expressed in ISO 8601 format like 2023-05-12T14:06:40Z.

string

limit

integer

1 to 100

Defaults to 20

Maximum number of invoices to return in one page.

cursor

string

Opaque pagination cursor returned as meta.pagination.nextCursor by a previous call. Omit to fetch the first page.

sortBy

string

enum

Defaults to createdAt

Field to sort by. Combined with sort to set direction.

Allowed:

sort

string

enum

Defaults to desc

Sort direction.

Allowed:

Responses

200Default Response

400Bad request

401Unauthorized

403Forbidden

429Too Many Requests

500Internal Server Error

503Service Unavailable