POST
Reverse a fiscal event (organization)
Organization space Accounting module Cannot be undone For: Accountant · Permission: fiscal_events.reverse Conditions
  • The accounting module must be part of the organization’s plan.
  • Events of profile derogatory_depreciation are refused: they are taken back only by depreciation runs.
  • A cancelled event is refused.
  • The amount cannot exceed the remaining amount (amount minus already reversed).
  • The accounting date cannot be earlier than the date of the event’s opening entry (or the start of its fiscal year when it has none).
  • The accounting date must fall in an open fiscal period of the book.
  • For provision and reinvestment profiles the reversal account (set by the subtype, for example 791, 797, 7593, 7594 or 861) must exist in the book and be postable.
What else happens
  • Posts a reversal entry in the miscellaneous (OD) journal: the provision account is posted in the opposite direction to the opening entry and the other leg goes to the profile’s reversal account (for example 791 or 797), or to the event’s own counterpart account for accruals and deferrals (regularization).
  • Records a reversal line on the event with the amount, date, reason and author.
  • Increases the event’s reversed amount; its status becomes partially_reversed, or reversed once the whole amount is taken back.
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

fiscalEvent
string
required

Identifier of the accounting book (27-character KSUID string); the route parameter carries this name by mistake and does not name the event, which is given by fiscal_event.

fiscal_event
string
required

Identifier of the fiscal event (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, profile, subtype, label, description, fiscal_year_id, provision_account_id, counterpart_account_id, subject_type, subject_id, amount, reversed_amount, status, expected_reversal_on, currency_code, currency_exponent, dotation_journal_entry_id, origin_journal_entry_id, created_by, created_by_type, created_at, updated_at, remaining_amount.

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: provisionAccount, counterpartAccount, fiscalYear, reversals.

Body

application/json
amount
integer
required

Amount taken back, in minor units (an integer; divide by 10 to the power currency_exponent). At least 1 and not more than the amount remaining on the event.

Required range: x >= 1
accounting_date
string<date>
required

Accounting date of the reversal entry, ISO 8601 date. Required. It cannot be earlier than the date of the event's opening entry and must fall in an open fiscal period; any time part is ignored.

reason
string | null

Optional free-text reason kept on the reversal line, up to 255 characters.

Maximum string length: 255

Response

Resource (only with response=resource).

id

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

owner_type

Kind of book that owns the event, set by the server from the selected book (organization or client).

profile

Kind of event: provision, regularization (accruals and deferrals), derogatory_depreciation or reinvestment_gain. The last two are created by depreciation runs and disposals.

subtype

Subtype inside the profile, for example litigation, inventory, receivable, cca, pca, cap, par, derogatory.

label

Name of the event.

description

Free-text description, null when none was given.

fiscal_year_id

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

fiscal_year
object

The fiscal year, only when requested through include=fiscalYear and the caller may view fiscal years.

provision_account_id

Identifier of the provision (balance sheet) account (27-character KSUID string).

provision_account
object

The provision account, only when requested through include=provisionAccount and the caller may view accounting accounts.

counterpart_account_id

Identifier of the counterpart (expense or income) account (27-character KSUID string).

counterpart_account
object

The counterpart account, only when requested through include=counterpartAccount and the caller may view accounting accounts.

subject_type

Type of record the event relates to; fixed_asset or null.

subject_id

Identifier of the fixed asset the event relates to (27-character KSUID string), null when none.

amount
integer

Total amount of the event, in minor units (divide by 10 to the power currency_exponent).

reversed_amount
integer

Part of the amount already taken back, in minor units.

remaining_amount
integer

Amount still standing: amount minus reversed_amount, in minor units.

status

open (nothing taken back), partially_reversed, reversed (fully taken back) or cancelled (opening entry reversed).

expected_reversal_on

Date the event is expected to be taken back (ISO 8601 date), null when not set.

currency_code

Currency code of the event (ISO 4217), copied from the fiscal year.

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.

dotation_journal_entry_id

Identifier of the opening (dotation) journal entry (27-character KSUID string), null when none.

origin_journal_entry_id

Identifier of the journal entry of a depreciation run or disposal that opened the event, null for events opened by hand. Such events cannot be cancelled by hand.

reversals
array

The reversals recorded on the event, only when requested through include=reversals.

created_by

Identifier of the actor who created the event.

created_by_type

Type of the actor who created the event.

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