GET
View a statement note (organization)
Organization space Accounting module For: Accountant, Administrator · Permission: journal_entries.viewreports, statement_note_inputs.retrieve 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.retrieve.
  • The note code must exist in the catalogue, otherwise the call answers 404.
  • 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.

Path Parameters

noteCode
string
required

Code of the note in the statement note catalogue (for example 3A). Matched exactly; a code that is not in the catalogue answers 404. In the organization space the OpenAPI path repeats this name where the book identifier belongs: the first segment is the book identifier and the last is the note code.

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.

note
object
required

The requested note, resolved like one entry of the notes list: code, title, mode (computed, sourced or declarative), mandatory, available and data. For a declarative note it also carries updated_at, updated_by and updated_by_type; for an unavailable sourced note, a reason and a message.

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.