GET
View aged balance (client account)
Client space Accounting module For: Accountant, Administrator · Permission: journal_entries.viewreports Conditions
  • The accounting module must be part of the organization’s plan.
  • The side parameter is required and must be customers or vendors.
  • The book must have at least one fiscal year, which supplies the currency; otherwise the call answers 404.
Part of Accounting reports.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

side
enum<string>
required

Required. Third parties to report on: customers (receivables, customer accounts) or vendors (payables, supplier accounts).

Available options:
customers,
vendors
as_of
string<date-time> | null

Date to state the open balances at, ISO 8601 format. Defaults to today. Items dated after this date are ignored, and an item lettered with a line dated after it still counts as open.

Response

book
object
required

The book the report covers. In the client space it is the session client's book; in the organization space it is the book named in the URL.

side
string
required

Which third parties the report covers, as requested: customers (receivables) or vendors (payables).

as_of
string<date>
required

Date the open balances are stated at, ISO 8601 date format: the requested as_of, or today when none was sent.

aging_basis
enum<string>
required

What the age of an item is counted from. Always accounting_date: the age is the number of days from the accounting date of the entry line to as_of, not from a due date.

Available options:
accounting_date
rows
array
required

One row per third-party account with open items: account_id, code, name, auxiliary_id, balance and the buckets not_due, b_0_30, b_31_60, b_61_90, b_91_180 and b_180_plus. Amounts are in minor units of currency_code (divide by 10 to the power currency_exponent): positive when the third party owes you (customers) or you owe it (vendors). not_due is always 0 because lines carry no due date yet.

totals
object
required

Sum of balance and of each age bucket over all rows, in minor units of currency_code.

currency_code
string
required

ISO 4217 code of the currency of every amount in the report.

currency_exponent
integer
required

Number of decimal places of the currency (0 for XOF). An amount in minor units divided by 10 to this power gives the amount in the currency.