Query Parameters
Query Parameters
Status of the invoice (`DRAFT`, `DUE`, `PAID`, `VOID`, `UN_COLLECTIBLE`, `INITIATE_REFUND`, `REFUND_COMPLETED`, `MERGED`)
Class to which the invoice is categorized (`INVOICE`, `ORDER`, `BILLABLE`)
Unique identifier of the owner associated with the invoice
Date of the invoice
Unique identifier of the customer associated with the invoice
Unique identifier of the price plan associated with the invoice
Start date of the invoice
End date of the invoice
Filterable Fields
Filterable Fields
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
Searchable Fields
Searchable Fields
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Pagination token used as a marker to get records from next page.
Example:
"eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ=="
Filter option to filter by status.
Filter option to filter based on owner id.
Example:
"ACC001"
Filter option to filter based on customer id.
Example:
"1234"
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 filter in epoch milli seconds
Example:
1650110402000
End time filter in epoch milli seconds
Example:
1650110402000