GET
Analytic income statement (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.
  • A closed window is required: a fiscal period, a fiscal year, or both from and to. Without any range the current fiscal year is used when one covers today; with only from or only to the call is refused.
  • Fiscal period takes precedence over fiscal year, which takes precedence over from/to.
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). Always set: a range with only one date is refused.

to
string<date> | null
required

End of the period covered, as a date (YYYY-MM-DD). Always set: a range with only one date is refused.

sections
tuple
required

One column per section of the axis that has allocations in the period, ordered by code. Each has a section object (id, code, label), the six buckets charges, produits, hao_charges, hao_produits, participation and income_tax, and result, all integers in minor units. Sections with no allocation are not listed.

unallocated
object
required

Result of the allocable lines that carry no allocation on this axis, read from the lines themselves.

total
object
required

The general income statement of the book for the same period, used as the total column.

coherence
object
required

Check that the analytic columns plus the unallocated part add up to the general result.

currency_code
string
required

ISO currency code of the fiscal year covering the end of the period; 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.