v1

latestOpenAPI 3.0.12026-07-245277551.2 MB

Accounts Receivable Ledger

List transactions for an AR ledger

Retrieve a paginated list of transactions belonging to a specific accounts receivable (AR) ledger. You can filter by transaction state (posted or pending), date ranges, transaction type, and more. Use this endpoint to review the detailed financial activity within an AR ledger.

get/accounting/v1.0/accounts-receivable-ledgers/{accountsReceivableLedgerId}/transactions

Path parameters

accountsReceivableLedgerIdinteger required

Unique identifier of the accounts receivable ledger.

Query parameters

pageTokenstring

Opaque token for cursor-based pagination. Pass the nextPageToken value from a previous response to retrieve the next page. Omit this parameter (or pass null) for the first page.

pageSizeinteger

Number of results to return per page. If not specified, the server uses a default page size.

transactionStatesTransactionState[]

transaction states

searchQuerystring

transactionDateFromstring date

transactionDateTostring date

checkinDateFromstring date

checkinDateTostring date

checkoutDateFromstring date

checkoutDateTostring date

transactionTypestring[]

userIdinteger[]

sortBy'CHECKOUT_DATE' | 'CHECKIN_DATE' | 'TRANSACTION_DATE' | 'AMOUNT'

Sort field

sortDirection'asc' | 'desc'

Direction for sort - asc or desc

Headers

X-Property-IDinteger required

Property id

Response

nextPageTokenstring

Token for fetching the next page of results