GET
View combined balance sheet
Organization space Accounting module For: Accountant, Administrator · Permission: journal_entries.viewreports Conditions
  • The accounting module must be part of the organization’s plan.
  • Not available to the client space: combined reports exist only in the organization space.
  • books[] is optional, must be a list of at most 100 distinct identifiers, and every id must be a book you have an accounting access grant on; each refused id is reported at its index with a validation error. Without books[], every book you can access is combined.
  • A book whose currency differs from the organization currency needs an exchange rate valid on the report date (the end date or as_of); without one the call is refused.
  • The combination is a plain sum of the books: flows between the books are not removed, so it is not a consolidation.
  • as_of is required.
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

books[]
string[]
required

Optional. Identifiers of the books to combine (27-character KSUID strings), each one a book you have an accounting access grant on. Without it every accessible book is combined.

as_of
string<date-time>
required

Required. Date to state the combined balance sheet at, ISO 8601 format.

Response

books
any[]
required

The books included in the report: for each, type, id and name. These are the books you may access, narrowed to books[] when it was sent.

as_of
string<date>
required

Date the combined balance sheet is stated at, ISO 8601 date format, as requested.

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 on the 131 (profit) or 139 (loss) line: code, label, amount, provisional and books (the share of each book, with its original amount). Provisional and computed from the entries of unclosed years, or the posted closing amount. Null when no year is open 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 organization currency, in which every amount is stated.

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.

conversion
required

Audit of the currency conversion into the organization currency. An object with target_currency_code, target_currency_exponent, rate_date and conversions (one entry per book: source currency, exchange rate id, rate, rate origin and the rounding adjustment on the debit and credit sides). conversions is an empty list when no book had any amount to convert. A rate valid on the report date (the end date or as_of) must exist for each book whose currency differs, otherwise the call is refused.

Required array length: 0 element