GET
List statement notes (client account)
Client space Accounting module For: Accountant, Administrator · Permission: journal_entries.viewreports, statement_note_inputs.list Conditions
  • The accounting module must be part of the organization’s plan.
  • In the organization space, the caller must have access to the book.
  • The fiscal_year_id is required and must be a fiscal year of the book.
  • The caller also needs the permission statement_note_inputs.list.
  • The call fails with a business-rule error when the statement note catalogue is not defined.
Part of Official annual statements.

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
required

Identifier of the fiscal year to report on (27-character KSUID string). Required. It must be a fiscal year of the selected book; a year of another book fails validation.

Response

book
object
required

The book (accounting owner) the statement was computed for.

fiscal_year
object
required

The fiscal year the statement covers, as requested by fiscal_year_id.

prior_fiscal_year
object | null
required

The fiscal year of the same book that ended before this one started (the most recent one), used for the N-1 comparative column. Null when the book has no earlier year.

notes
array
required

Every note of the statement catalogue for this book and year, each with code, title, mode, mandatory, available and data. In mode computed, data holds lines (code, label, level, n, n_1). In mode sourced, the figures come from another module; available is false with a reason and message while that module is absent. In mode declarative, data is what was entered (null if nothing yet) with updated_at, updated_by and updated_by_type.

currency_code
string
required

ISO currency code of the fiscal year. All amounts of the response 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.