GET
Preview result allocation (client account)
Client space Accounting module For: Accountant · Permission: fiscal_years.allocate_result Conditions
  • The accounting module must be part of the organization’s plan.
  • The year must be closed.
Part of Close the fiscal year.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

fiscalYear
string
required

Identifier of the fiscal year (27-character KSUID string).

Response

fiscal_year_id
string
required

Identifier of the fiscal year the result belongs to (27-character KSUID string).

result_amount
integer
required

Absolute value of the year's result, in minor units (divide by 10 to the power currency_exponent). The direction is given by result_direction.

result_direction
enum<string>
required

credit when the year closed with a profit (or a zero result), debit when it closed with a loss.

Available options:
credit,
debit
capital_amount
integer
required

Credit balance of the capital account at year end, in minor units; zero or negative balances count as no capital in the ceiling.

Credit balance of the legal reserve account at year end, in minor units.

Maximum the legal reserve may reach: 20 % of the capital, in minor units (0 when there is no capital).

Part of a profit the proposal puts into the legal reserve, in minor units: 10 % of the result, limited to what is left under the ceiling. 0 for a loss.

retained_earnings_proposed
integer
required

Part of the result the proposal puts into retained earnings, in minor units: the rest of a profit, or the whole loss.

allocations
tuple
required

The proposed split, as a list of objects with target (legal_reserve or retained_earnings) and amount in minor units. Targets with a zero amount are left out, so the list is empty when the result is zero. It is only a proposal: the posted allocation may differ.

currency_code
string
required

Currency code of the fiscal year (ISO 4217).

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.