GET
View trial 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.
  • At least one of fiscal_year_id or fiscal_period_id must be sent; a from/to range alone is refused with a validation error.
  • to must be on or after from.
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

fiscal_year_id
string | null

Identifier of a fiscal year of this book (27-character KSUID string). At least one of fiscal_year_id or fiscal_period_id is required (a from/to range alone is refused). A from/to pair sent with a year takes precedence over the year.

fiscal_period_id
string | null

Identifier of a fiscal period of this book (27-character KSUID string). Takes precedence over the fiscal year and over from/to.

from
string<date-time> | null

Start of the range, a date in ISO 8601 format. Used together with to; a range given alone is ignored.

to
string<date-time> | null

End of the range, a date in ISO 8601 format, on or after from. Used together with from.

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.

from
string<date> | null
required

Start date of the window actually used, in ISO 8601 date format. It is the start of the requested period, the requested from, or the start of the requested fiscal year.

to
string<date> | null
required

End date of the window actually used, in ISO 8601 date format.

rows
tuple
required

One row per account that has an opening balance or a movement, ordered by account code. Each row has account_id, code, name, class (first digit of the code) and the six columns opening_debit, opening_credit, period_debit, period_credit, closing_debit and closing_credit. Amounts are in minor units of currency_code (divide by 10 to the power currency_exponent).

totals
object
required

Sum of each of the six columns over all rows, in minor units of currency_code. Debit and credit totals agree for a balanced book.

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.