List invoices

GET

/invoices

• Development
• Production

Retrieve a paginated list of invoices. Portal users (contacts) are scoped to their own customer; other callers may filter by customer_id. Optional filters include paid_in_full and invoice_aging bucket.

Authorizations

• basicAuth

Parameters

Query Parameters

limit

integer

default: 100

Maximum number of invoices to return

offset

integer

0

Number of records to skip for pagination

customer_id

string

Filter by customer ID (ignored for portal users)

paid_in_full

boolean

Filter by payment status (true or false)

invoice_aging

string

Filter by aging bucket (e.g. 0-30, 31-60, 61-90, Over90)

Responses

200

Paginated list of invoices

object

invoices

required

Array<object>

Invoice record for receivables and aging

object

id

Invoice ID

string

company_id

string | null

customer_id

string | null

external_id

string | null

invoice_date

string | null format: date

terms_due_date

string | null format: date

total_amount

Numeric value as string

string | null

amount_paid

Numeric value as string

string | null

amount_remaining

Numeric value as string

string | null

paid_in_full

boolean | null

invoice_aging

Aging bucket e.g. 0-30, 31-60, 61-90, Over90

string | null

days_past_due

Numeric value as string

string | null

organization_id

string | null

sales_rep_id

string | null

ship_to_id

string | null

order_header_id

string | null

last_modified_date

string | null format: date-time

invoiceCount

required

Total number of invoices matching the filters

integer

401

Unauthorized

object

success

required

boolean

error

required

string

Example

An error occurred

403

Forbidden

object

success

required

boolean

error

required

string

Example

An error occurred