GET
View income statement (client account)
Client space Accounting module For: Accountant, Administrator · Permission: journal_entries.viewreports Conditions
  • The accounting module must be part of the organization’s plan.
  • At least one of fiscal_year_id, fiscal_period_id or a from and to pair must be sent; otherwise the call is refused with a validation error.
  • to must be on or after from.
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

fiscal_year_id
string | null

Identifier of a fiscal year of this book (27-character KSUID string). At least one of fiscal_year_id, fiscal_period_id or a from and to pair is required.

fiscal_period_id
string | null

Identifier of a fiscal period of this book (27-character KSUID string). Takes precedence over the fiscal year and over from/to.

from
string<date-time> | null

Start of the range, a date in ISO 8601 format. Used together with to; a range given alone is ignored. A from/to pair takes precedence over fiscal_year_id.

to
string<date-time> | null

End of the range, a date in ISO 8601 format, on or after from. Used together with from.

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.

from
string<date> | null
required

Start date of the window actually used, in ISO 8601 date format.

to
string<date> | null
required

End date of the window actually used, in ISO 8601 date format.

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 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.