CLcloudbeds
Accounts Receivable Ledger

List accounts receivable ledgers

Retrieve a paginated list of accounts receivable (AR) ledgers for a property. You can filter by status, date range, balance range, profile, and search query. Use AR ledgers to track balances that have been transferred from reservations or group profiles for later collection.

get/accounting/v1.0/accounts-receivable-ledgers

Request

  • Base URL
    https://api.cloudbeds.com
  • URL
    https://api.cloudbeds.com/accounting/v1.0/accounts-receivable-ledgers
  • Auth
    • HTTP bearer
    • or OAuth 2
      Implicit: https://hotels.cloudbeds.com/api/v1.2/oauth
      Scopes: read:payment

Query parameters

searchQuerystring
createdDateTimeFromstring date-time
createdDateTimeTostring date-time
balanceFrominteger
balanceTointeger
totalFrominteger
totalTointeger
paidFrominteger
paidTointeger
profileIdinteger
statusAccountsReceivableLedgerStatus[]
sortBy'status' | 'name' | 'created_at' | 'balance' | 'paid' | 'total'

Sort field

sortDirection'asc' | 'desc'

Direction for sort - asc or desc

pageTokenstring
pageSizeinteger

Headers

X-Property-IDinteger required

Unique identifier of the property. Required for all requests to scope data to a specific property.

Response

OK

nextPageTokenstring

Token for fetching the next page of results

Example response

{
  "content": [
    {
      "createdAt": "2017-07-21T17:32:28Z",
      "updatedAt": "2017-07-21T17:32:28Z"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.