API ReferenceBilling

Get Invoices

View as Markdown
Gets a paginated list of invoices, optionally filtered by invoice types and date range

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Query parameters

CursorstringOptional

[Optional] A pagination token used to jump to first, last, next or previous pages. When supplied, it overrides all other filter parameters.

FromDatedatetimeOptional

[Optional] Start date for filtering invoices by invoice date. Default is current - 1 month date.

ToDatedatetimeOptional

[Optional] End date for filtering invoices by invoice date. Default is current date.

InvoiceTypeslist of stringsOptional

[Optional] Filter invoices by invoice type. Valid values: Shipping,WarehouseStorage,Inbound Fee,Return,AdditionalFee,Credits

PageSizeintegerOptional

Number of invoices to return per page (default: 100). Must be between 1 and 1000.

SortOrderstringOptional

Sort invoices by Invoice Date. Values - Ascending, Descending. Default: Descending.

Response

Success
firststring or null
Go to the first page
itemslist of objects or null
laststring or null
Go to the Last page
nextstring or null
Go to the Next page
prevstring or null
Go to the Previous page

Errors