GET
/
invoices

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version
enum<string>

Use this header to select an API version

Available options:
2024-07-30

Query Parameters

before
string

Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.

after
string

Pagination cursor. To page through items, omit this parameter to retrieve the first page, and then successively use the value you get from pagination.after or pagination.before to retrieve each page.

limit
integer

Maximum number of objects to return per-page. Must be between 1 and 100 (inclusive).

sortOrder
string

Sort order. Default: DESC (descending, most often used for reverse chronological sorting).

sortBy
string

Sort column. Default: creation time. Options: CUSTOMER_LEGAL_COMPANY_NAME, GROSS_TOTAL, ACCOUNTING_DATE

invoiceStatus
string

Filter by invoice status. Options: IN_PROGRESS, DRAFT, FINAL, SENT, VOIDED

invoicePaymentStatus
string

Filter by payment status. Options: UNPAID, PARTIALLY_PAID, PAID, UNCOLLECTIBLE

customerId
string

Filter by customer id.

billingScheduleId
string

Filter by billing schedule id.

dueBefore
string

Filter by due date before. Format: yyyy-MM-dd

dueAfter
string

Filter by due date after. Format: yyyy-MM-dd

sentBefore
string

Filter by sent date before. Format: yyyy-MM-dd

sentAfter
string

Filter by sent date after. Format: yyyy-MM-dd

invoiceBefore
string

Filter by invoice date before. Format: yyyy-MM-dd

invoiceAfter
string

Filter by invoice date after. Format: yyyy-MM-dd

excludeZeroQuantity
boolean

Exclude invoices with zero quantity.

invoiceCurrency
string

Get invoices for a specific currency (provide a comma-separated list)

Response

200 - application/json
items
object[]
required

Invoices

pagination
object
required

Results pagination

Update an Invoice Render SettingsCreate an invoice