CLcloudbeds
Accounts Receivable Ledger

Get AR ledger totals

Retrieve aggregated totals across all accounts receivable (AR) ledgers for a property. The response includes the combined total charges, amount paid, and outstanding balance. You can optionally filter by ledger status to see totals for only open or closed ledgers.

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

Request

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

Query parameters

statusAccountsReceivableLedgerStatus[]

Headers

X-Property-IDinteger required

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

Response

OK

totalnumber

Sum of all charges across matching AR ledgers, in the smallest currency unit.

paidnumber

Sum of all payments across matching AR ledgers, in the smallest currency unit.

balancenumber

Sum of outstanding balances across matching AR ledgers (total minus paid), in the smallest currency unit.

Changes

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