POST
Record a fiscal event (organization)
Organization space Accounting module For: Accountant · Permission: fiscal_events.create Conditions
  • The accounting module must be part of the organization’s plan.
  • Only the profiles provision and regularization can be opened by hand; derogatory depreciation and reinvestment gain are created by depreciation runs and disposals.
  • The subtype must belong to the chosen profile; otherwise the call is refused.
  • The accounting date must fall within the chosen fiscal year, and in an open fiscal period.
  • The provision account and counterpart account, when sent, must exist in the book and be postable; when omitted the profile’s default chart account is looked up by code in the book and must exist.
  • For the regularization profile the counterpart account is required, because accruals and deferrals have no default counterpart.
  • subject_type and subject_id must be sent together; the only subject type is fixed_asset.
  • A regularization event cannot be added to a fiscal year that has already been carried forward.
  • The amount must be a positive integer.
What else happens
  • Posts the opening entry (dotation) in the miscellaneous (OD) journal: the provision account is posted in the profile’s direction and the counterpart account in the opposite direction, for the event amount.
  • Stores the event with status open, nothing reversed, the fiscal year’s currency, and the creating actor; the opening entry id is saved on the event.
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

book
string
required

Identifier of the accounting book (27-character KSUID string) the events belong to. Access to the book is checked before the action runs.

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

The year, the accounts and the subject must belong to the selected book: an id of another book is unknown here (422). The only subject is a fixed asset of the book.

profile
enum<string>
required

Kind of event. Required. provision (a provision or impairment) or regularization (accruals and deferrals); the other profiles are created only by depreciation runs and disposals and are refused here.

Available options:
provision,
regularization
subtype
string
required

Required, up to 64 characters. Must be a subtype of the chosen profile: for provision, for example litigation, customer_warranty, tax, pension, inventory, receivable or an impairment type; for regularization, cca, pca, cap or par. The subtype sets the default accounts and direction.

Maximum string length: 64
label
string
required

Required name of the event, up to 255 characters. It is used as the label of the posted entry lines.

Maximum string length: 255
fiscal_year_id
string
required

Required. Identifier of the fiscal year the event belongs to (27-character KSUID string). It must be a year of the selected book.

accounting_date
string<date>
required

Required. Accounting date of the opening entry, ISO 8601 date. It must fall within the fiscal year chosen above and in an open fiscal period.

amount
integer
required

Required. Amount of the event, in minor units (an integer of at least 1; divide by 10 to the power currency_exponent). The currency is the fiscal year's.

Required range: x >= 1
description
string | null

Optional free-text description.

provision_account_id
string | null

Optional identifier of the provision (balance sheet) account (27-character KSUID string), a postable account of the selected book. When omitted the subtype's default account is looked up in the book by its chart code.

counterpart_account_id
string | null

Identifier of the counterpart (expense or income) account (27-character KSUID string), a postable account of the selected book. Required when the profile is regularization; otherwise optional and defaulted from the subtype (for example 691 or 697).

subject_type
enum<string> | null

Type of record the event relates to. The only value is fixed_asset. Required when subject_id is sent.

Available options:
fixed_asset
subject_id
string | null

Identifier of the fixed asset the event relates to (27-character KSUID string). Required when subject_type is sent.

expected_reversal_on
string<date> | null

Optional date the event is expected to be taken back, ISO 8601 date. It drives the overdue filter of the list; it does not reverse anything by itself.

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