POST
Carry balances to next year (organization)
Organization space Accounting module For: Accountant · Permission: fiscal_years.carry_forward Conditions
  • The accounting module must be part of the organization’s plan.
  • The year must be closed.
  • A carry forward can be posted once: refused when a posted one already exists for the year (a reopened year allows a new one).
  • When next_fiscal_year_id is sent it must be a year of the book; otherwise the year starting the day after this one ends is used, or created by rollover when missing. The target year must start the day after this one ends; a gap is refused.
  • The accounting date, when sent, must fall inside the next year; it defaults to the next year’s start date. It must also fall in an open fiscal period.
  • The AN (carry forward) journal must exist in the book.
What else happens
  • Posts one entry in the carry-forward (AN) journal restating every class 1 to 5 account balance standing at year end, including the result on 13x, dated in the next year.
  • When the year has open accruals or deferrals (regularization events with an amount remaining), posts a second entry in the AN journal on the same date reversing them, records a reversal line on each event and sets those events to reversed.
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 accounting book (27-character KSUID string); the route parameter carries this name by mistake and does not name the year, which is given by fiscal_year.

fiscal_year
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
next_fiscal_year_id
string | null

Identifier of the fiscal year that receives the opening balances (27-character KSUID string), a year of the same book. Optional; when omitted, the year starting the day after this one ends is used, and the carry-forward is refused if the next year does not start on that day.

accounting_date
string<date> | null

Optional date of the carry-forward entries, ISO 8601 date. Must fall inside the next fiscal year and in an open period. Defaults to the start date of the next year.

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