API ReferenceBilling

Search Transactions

View as Markdown

Search transactions with filters (date, invoice, fee type, etc.)

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token or OAuth2

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.

Request

Used to filter transactions based on search criteria. Required if cursor is not provided. Ignored when cursor is present (i.e., for paginated requests).

from_datedatetime or nullOptional
Start date for filtering transactions by charge date. Defaults to 7 days before the current date if not specified.
invoice_idslist of strings or nullOptional
List of invoice IDs to filter transactions by.
invoiced_statusboolean or nullOptional
Filter transactions by invoicing status. True returns billed transactions, false returns unbilled transactions, and null returns both billed and unbilled transactions.
page_sizeintegerOptional
Number of transactions to return per page. Default is 100. Must be between 1 and 1000.
reference_idslist of strings or nullOptional

List of reference IDs (such as Shipment IDs, WRO IDs) to filter transactions. Can be numeric or string identifiers.

reference_typeslist of enums or nullOptional
The types of references associated with the reference IDs to filter by.
Allowed values:
sort_orderenumOptionalDefaults to Descending
Sort order for results. Ascending sorts from lowest to highest, Descending sorts from highest to lowest.
Allowed values:
to_datedatetime or nullOptional
End date for filtering transactions by charge date. Defaults to the current date if not specified.
transaction_feeslist of strings or nullOptional

List of transaction fee types to filter by. To get all available transaction fees, use the ‘/transaction-fees’ endpoint.

transaction_typeslist of enums or nullOptional
The classification or nature of the transactions to filter by.
Allowed values:

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