GET
View balance sheet (organization)
Organization space Accounting module For: Accountant, Administrator · Permission: journal_entries.viewreports Conditions
  • The accounting module must be part of the organization’s plan.
  • In the organization space, the caller needs an accounting access grant on the book.
  • The book must have a fiscal year that contains as_of (or today when nothing is sent), or the one named by fiscal_year_id; 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.

Path Parameters

book
string
required

Identifier of the book the report covers (27-character KSUID string): the organization itself or one of its companies of the session organization.

Query Parameters

fiscal_year_id
string | null

Fiscal year used to find the report date and currency when as_of is not sent: the report is stated at its end date. When as_of is sent without it, the year containing that date is used.

fiscal_period_id
string | null

Accepted but not used by this report; send fiscal_year_id or as_of instead.

from
string<date-time> | null

Accepted but not used by this report; send as_of instead.

to
string<date-time> | null

Accepted but not used by this report; send as_of instead.

as_of
string<date-time> | null

Date to state the balance sheet at, ISO 8601 format. Defaults to the end date of the fiscal year used, or, without any year parameter, of the fiscal year containing today. Without fiscal_year_id, the book must have a fiscal year containing the date, otherwise the call answers 404.

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.

as_of
string<date>
required

Date the balance sheet is stated at, ISO 8601 date format: the requested as_of, or the end date of the fiscal year used when none was sent.

assets
tuple
required

Asset lines (accounts of classes 2 and 3, and class 4 and 5 accounts whose balance is a debit). Each line has account_id, code, name, class and amount in minor units; contra-accounts carry a negative amount.

equity_liabilities
tuple
required

Equity and liability lines (accounts of class 1, and class 4 and 5 accounts whose balance is a credit). Same line shape as assets.

result_line
object | null
required

Result of the year shown on the 131 (profit) or 139 (loss) line: code, label, amount in minor units, and provisional. It is provisional and computed from the entries when the year is not closed yet, and the posted closing amount otherwise. Null when the year is closed and no 131/139 line is posted.

totals
object
required

Totals of the two sides, assets and equity_liabilities, in minor units. The provisional result is added to the equity and liabilities side.

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.