POST
Allocate the year result (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.
  • A result can be allocated once: refused when a posted allocation already exists for the year (a reopened year allows a new one after the old one was reversed).
  • No later fiscal year of the book may be closed.
  • The year must have closed with a non-zero result.
  • The amounts of the allocations must add up exactly to the absolute value of the result, with no tolerance.
  • The accounting date must fall in the next fiscal year (the one starting the day after this one ends), which is created by rollover when missing; a gap between the years is refused. The date must also fall in an open period.
  • The result must still stand on the result account 131 (profit) or 139 (loss); refused when it was moved by hand.
  • For a profit each target must map to an account of the book; the legal reserve cannot go beyond 20 % of the capital.
  • For a loss only retained_earnings is accepted as target.
  • Each target can appear only once in the list.
  • The account mappings the allocation uses must be configured: the result account, the account of each chosen target, and the capital account when the legal reserve is a target.
What else happens
  • Posts one entry in the miscellaneous (OD) journal, dated in the next year: for a profit, debits the result account 131 for the whole result and credits the chosen target accounts (legal reserve, other reserves, retained earnings, dividends payable); for a loss, debits retained earnings and credits the loss account 139.
  • The description defaults to ‘Affectation du résultat’ followed by the year label when omitted.
  • The closed year’s own figures are not changed.
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).

Query Parameters

response
enum<string>
default:none

Response mode. Default none; none answers 204 No Content.

Available options:
none,
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, owner_type, journal_id, fiscal_period_id, accounting_date, reference, description, source_type, source_id, source_event, metadata, currency_code, currency_exponent, status, reversal_of_entry_id, refund_of_entry_id, posted_at, created_at, updated_at, attachments_count.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: lines, lines.account, attachments.

Body

application/json
accounting_date
string<date>
required

Required. Date of the allocation entry, ISO 8601 date. It must fall in the fiscal year following the one being allocated (the shareholders' decision date) and in an open fiscal period.

allocations
object[]
required

Required list of at least one allocation. The amounts must add up exactly to the absolute result of the year. Each target may appear only once.

Minimum array length: 1
description
string | null

Optional description of the entry, up to 255 characters. Defaults to 'Affectation du résultat' followed by the year label.

Maximum string length: 255

Response

Resource (only with response=resource).

id

Identifier of the journal entry (27-character KSUID).

owner_type

Kind of book the entry belongs to: organization, company or client.

journal_id

Identifier of the journal the entry is posted in (27-character KSUID).

fiscal_period_id

Identifier of the fiscal period covering the accounting date, set by the server (27-character KSUID).

accounting_date

Date the entry counts for in the books (YYYY-MM-DD).

reference

Free-text reference given at posting, or copied from the original entry on a reversal; null when none.

description

Free-text description given at posting; on a reversal, a text naming the original entry; null when none.

source_type

Kind of record that generated the entry (for example reversal, opening_balances or recurring_entry, or a business flow); null for a manual entry.

source_id

Identifier of the record that generated the entry; null for a manual entry.

source_event

Event of the source record that generated the entry (for example reversed, opening or run: for a recurring occurrence); null for a manual entry.

metadata
object | null

Extra data stored by automatic postings, such as fee snapshots or the company identifier; null for most manual entries.

currency_code

ISO 4217 currency code of the entry, taken from the fiscal year (for example XOF).

currency_exponent
integer

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.

status

State of the entry: posted (in force), reversed (cancelled by a reversal entry) or refunded (refunded by a refund entry).

reversal_of_entry_id

When the entry is a reversal, the identifier of the entry it cancels; otherwise null.

refund_of_entry_id

When the entry is a refund, the identifier of the entry it refunds; otherwise null.

posted_at

Moment the entry was posted, ISO 8601, set by the server.

lines
array

Debit and credit lines of the entry. Present only when requested with include=lines; amounts are integers in minor units (divide by 10 to the power currency_exponent).

attachments_count
integer

Number of supporting documents attached to the entry.

attachments
array

Supporting documents of the entry. Present only when requested with include=attachments and the caller holds the entry_attachments.list permission.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).