Sign in

v1

latestOpenAPI 3.0.12026-07-245277551.2 MB
Accounts Receivable Ledger

Get an accounts receivable ledger by ID

Retrieve a single accounts receivable (AR) ledger by its unique identifier. The response includes the ledger name, status, total charges, amount paid, and outstanding balance.

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

Path parameters

accountsReceivableLedgerIdinteger required

Unique identifier of the accounts receivable ledger.

Headers

X-Property-IDinteger required

Property id

Response

OK

idstring
namestring
descriptionstring
status'OPEN' | 'CLOSED'

Status of an accounts receivable ledger. OPEN ledgers can receive balance transfers and payments. CLOSED ledgers are settled and no longer accept new transactions.

propertyIdstring
profileIdstring int64

Profile ID associated with this accounts receivable ledger

totalnumber

Total amount of all charges transferred to this AR ledger, in the smallest currency unit.

paidnumber

Total amount of payments applied to this AR ledger, in the smallest currency unit.

balancenumber

Outstanding balance (total minus paid), in the smallest currency unit.

createdAtstring

Created datetime (ISO 8601) in UTC

updatedAtstring

Updated datetime (ISO 8601) in UTC

Example response

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