Invoices

List invoices

Retrieve existing invoices. By default, invoices with status open are not included.

get/v2/invoices

Query parameters

limitnumber

Maximum number of items to return (1-100).

Example:50

Maximum number of items to return (1-100).

cursorstring

Opaque cursor returned in the previous response's next_cursor. Omit to fetch the first page.

Opaque cursor returned in the previous response's next_cursor. Omit to fetch the first page.

boolean
OR
'true' | 'false'

Set to true to include total in the response.

order'asc' | 'desc'

Sort direction.

Example:desc

Sort direction.

sort'created_at' | 'emitted_at'

Field used to sort the results.

Field used to sort the results.

'invoice' | 'refund' | 'document' | 'child_invoice_ref' | 'child_creditnote_ref'
OR
string

invoice,refund

'invoice' | 'refund' | 'document' | 'child_invoice_ref' | 'child_creditnote_ref'
OR
string

invoice,refund

'all' | 'open' | 'grace_period' | 'to_pay' | 'to_reconcile' | 'error' | 'paid' | 'partially_paid' | 'outstanding' | 'refunded' | 'late' | 'draft' | 'voided' | 'closed' | 'uncollectible' | 'pending_consolidation' | 'consolidated'
OR
string

all,open

'all' | 'open' | 'grace_period' | 'to_pay' | 'to_reconcile' | 'error' | 'paid' | 'partially_paid' | 'outstanding' | 'refunded' | 'late' | 'draft' | 'voided' | 'closed' | 'uncollectible' | 'pending_consolidation' | 'consolidated'
OR
string

all,open

customer_idstring
customer_id__notstring
customer_id__isNullstring
customer_id__isNotNullstring
customer_id__equalsstring
customer_id__containsstring
customer_id__startsWithstring
customer_id__endWithstring
customer_external_idstring
subscription_idstring
subscription_id__notstring
subscription_id__isNullstring
subscription_id__isNotNullstring
subscription_id__equalsstring
subscription_id__containsstring
subscription_id__startsWithstring
subscription_id__endWithstring
invoicing_entity_idstring
invoicing_entity_id__notstring
invoicing_entity_id__isNullstring
invoicing_entity_id__isNotNullstring
invoicing_entity_id__equalsstring
invoicing_entity_id__containsstring
invoicing_entity_id__startsWithstring
invoicing_entity_id__endWithstring
invoice_numberstring
invoice_number__notstring
invoice_number__isNullstring
invoice_number__isNotNullstring
invoice_number__equalsstring
invoice_number__containsstring
invoice_number__startsWithstring
invoice_number__endWithstring
original_invoice_idstring
original_invoice_id__notstring
original_invoice_id__isNullstring
original_invoice_id__isNotNullstring
original_invoice_id__equalsstring
original_invoice_id__containsstring
original_invoice_id__startsWithstring
original_invoice_id__endWithstring
original_invoice_numberstring
original_invoice_number__notstring
original_invoice_number__isNullstring
original_invoice_number__isNotNullstring
original_invoice_number__equalsstring
original_invoice_number__containsstring
original_invoice_number__startsWithstring
original_invoice_number__endWithstring
line_item_idstring
period_startstring date-time
period_start__notstring date-time
period_start__isNullstring date-time
period_start__isNotNullstring date-time
period_start__equalsstring date-time
period_start__ltstring date-time
period_start__ltestring date-time
period_start__gtstring date-time
period_start__gtestring date-time
period_endstring date-time
period_end__notstring date-time
period_end__isNullstring date-time
period_end__isNotNullstring date-time
period_end__equalsstring date-time
period_end__ltstring date-time
period_end__ltestring date-time
period_end__gtstring date-time
period_end__gtestring date-time
issued_atstring date-time
issued_at__notstring date-time
issued_at__isNullstring date-time
issued_at__isNotNullstring date-time
issued_at__equalsstring date-time
issued_at__ltstring date-time
issued_at__ltestring date-time
issued_at__gtstring date-time
issued_at__gtestring date-time
due_atstring date-time
due_at__notstring date-time
due_at__isNullstring date-time
due_at__isNotNullstring date-time
due_at__equalsstring date-time
due_at__ltstring date-time
due_at__ltestring date-time
due_at__gtstring date-time
due_at__gtestring date-time
updated_atstring date-time
updated_at__notstring date-time
updated_at__isNullstring date-time
updated_at__isNotNullstring date-time
updated_at__equalsstring date-time
updated_at__ltstring date-time
updated_at__ltestring date-time
updated_at__gtstring date-time
updated_at__gtestring date-time

Response

CursorPaginatedInvoice required— unresolved $ref

Changes