GET
View combined income statement
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.
  • from and to are required, and to must be on or after from. Fiscal years are not used because each book has its own years.
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.

from
string<date-time>
required

Required. Start of the range, ISO 8601 date.

to
string<date-time>
required

Required. End of the range, ISO 8601 date, on or after from.

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.

from
string<date>
required

Start date of the window, ISO 8601 date format, as requested.

to
string<date>
required

End date of the window, ISO 8601 date format, as requested.

produits
object
required

Revenue (class 7 accounts). An object with rows (accounts of the bucket: account_id, code, name, amount; plus books in a combined report) and total. Amounts are in minor units of currency_code (divide by 10 to the power currency_exponent). Closing entries of the year are left out.

charges
object
required

Expenses (class 6 accounts). An object with rows (accounts of the bucket: account_id, code, name, amount; plus books in a combined report) and total. Amounts are in minor units of currency_code (divide by 10 to the power currency_exponent). Closing entries are left out.

hao
object
required

Out-of-ordinary-activity items (class 8 accounts), split into charges and produits.

participation_line
object
required

Employee profit-sharing line of the statement. An object with rows (accounts of the bucket: account_id, code, name, amount; plus books in a combined report) and total. Amounts are in minor units of currency_code (divide by 10 to the power currency_exponent).

income_tax_line
object
required

Income tax line of the statement (accounts of the income-tax prefix 89). An object with rows (accounts of the bucket: account_id, code, name, amount; plus books in a combined report) and total. Amounts are in minor units of currency_code (divide by 10 to the power currency_exponent).

result
integer
required

Net result: revenue minus expenses, plus out-of-ordinary income minus out-of-ordinary expenses, minus profit-sharing and income tax. Positive for a profit, negative for a loss, in minor units of currency_code (divide by 10 to the power currency_exponent).

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