GET
Analytic balance report (organization)
Organization space Accounting module For: Accountant · Permission: journal_entries.viewreports Conditions
  • The accounting module must be included in the plan of the organization.
  • The caller must have been granted access to the book named in the path.
  • analytic_axis_id is required and must be an axis of this book.
  • fiscal_year_id and fiscal_period_id, when sent, must belong to this book.
  • to must not be before from.
  • The period is taken from fiscal_period_id first, then fiscal_year_id, then from/to; when none is sent the fiscal year covering today is used, and the call is refused when no fiscal year covers today.
  • When the period has an end date, a fiscal year of the book must cover that date to read the currency; otherwise the call answers not found. With only a start date, the latest fiscal year of the book is used.
Part of Allocate lines and read analytic reports.

Authorizations

Authorization
string
header
required

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

Path Parameters

book
string
required

Identifier of the book (27-character KSUID string): the organization itself or one of its companies, opened through the caller's access grants.

Response

book
object
required

The book the report was computed for.

axis
object
required

The analytic axis the report is computed on.

from
string<date> | null
required

Start of the period covered, as a date (YYYY-MM-DD). Null when the range was given with only a to date.

to
string<date> | null
required

End of the period covered, as a date (YYYY-MM-DD). Null when the range was given with only a from date.

sections
string[]
required

Every section of the axis, ordered by code with each parent before its children (a flat list, with depth). Each row has id, parent_id, code, label, depth (0 for a root), is_postable, own_debit and own_credit (allocated directly to the section), debit and credit (own plus all descendants), and net (debit minus credit). All amounts are integers in minor units (divide by 10 to the power currency_exponent). Sections with no allocation appear with zeros.

Required array length: 0 element
allocated_totals
object
required

Total allocated across the root sections of the axis, descendants included.

unallocated
object
required

The part of the allocable lines (accounts of class 6, 7 and 8 by default) not allocated on this axis, computed as the general totals minus the allocated totals.

general_totals
object
required

Totals of all lines on allocable account classes in the period, allocated or not. The closing entry and its reversal are left out.

currency_code
string
required

ISO currency code of the fiscal year covering the end of the period (the latest fiscal year of the book when the period has no end date); all amounts are in this currency.

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.