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
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.

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).

fromDatedatetimeOptional

Start date for filtering transactions by transaction charge date. Default is current – 7 days

invoiceIdslist of stringsOptional
List of invoice IDs to filter transactions
invoicedStatusbooleanOptional

Filter Transactions by invoicing status:

  • True(Billed Transactions)
  • False(Unbilled Transactions)
  • null (Billed + Unbilled Transactions)
pageSizeintegerOptional

Number of transactions to return per page (default is 100, to be entered when API is called for first time). Must be between 1 and 1000.

referenceIdslist of stringsOptional

List of reference IDs (like Shipment ID, WRO id) to filter transactions (can be numeric or string identifiers).

referenceTypeslist of stringsOptional

The type of reference associated with the ReferenceId. Available options:

  • Shipment
  • Return
  • WRO
  • URO
sortOrderenumOptional
toDatedatetimeOptional
End date for filtering transactions by transaction charge date. Default is current date.
transactionFeeslist of stringsOptional

To get all the available transaction fees use this endpoint:- ‘/transaction-fees’

transactionTypeslist of stringsOptional

The classification or nature of the transaction Transaction Types - Charge, Refund, Credit, Payment, BalanceAdjustment

Response

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

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error