Skip to main content
GET
List invoices
enum
Status of the invoice (`DRAFT`, `DUE`, `PAID`, `VOID`, `UN_COLLECTIBLE`, `INITIATE_REFUND`, `REFUND_COMPLETED`, `MERGED`)
enum
Class to which the invoice is categorized (`INVOICE`, `ORDER`, `BILLABLE`)
string
Unique identifier of the owner associated with the invoice
string
Date of the invoice
string
Unique identifier of the customer associated with the invoice
string
Unique identifier of the price plan associated with the invoice
string
Start date of the invoice
string
End date of the invoice
string
string
string
string
string
string
string
string

Allowed filter combinations

  • status
  • class
  • class, owner_id
  • status, owner_id
  • status, class
  • status, class, owner_id
  • status, invoice_date
  • class, invoice_date
  • status, invoice_date, customer_id
  • class, invoice_date, customer_id
  • status, invoice_date, customer_id, owner_id
  • class, invoice_date, customer_id, owner_id
  • owner_id
  • owner_id, price_plan_id
  • owner_id, price_plan_id, start_date
  • owner_id, price_plan_id, start_date, end_date
Fields that can be searched on using _search query param
string
string
string
string
string
Fields with which the list response can be sorted using _sort query param
string
string
Default sort order:created_at DESC, id ASC

Authorizations

Authorization
string
header
required

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

Query Parameters

nextToken
string

Pagination token used as a marker to get records from next page.

Example:

"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ=="

status
string

Filter option to filter by status.

owner_id
string

Filter option to filter based on owner id.

Example:

"ACC001"

customer_id
string

Filter option to filter based on customer id.

Example:

"1234"

pageSize
integer

Maximum page size expected by client to return the record list.

NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided.

Example:

10

start_time
integer<int64>

Start time filter in epoch milli seconds

Example:

1650110402000

end_time
integer<int64>

End time filter in epoch milli seconds

Example:

1650110402000

Response

Success response

List invoices response

data
object[]
required
Maximum array length: 50
nextToken
string
Maximum string length: 500
Example:

"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ=="