POST
Close a fiscal year (organization)
Organization space Accounting module For: Accountant · Permission: fiscal_years.close Conditions
  • The accounting module must be part of the organization’s plan.
  • A year that is already closed is refused.
  • Every fiscal period of the year must be closed.
  • Once a VAT declaration exists in the book, every period of the year from the first declared period onward must have its VAT declaration; the first period without one blocks the close.
  • Every earlier fiscal year of the book must already be closed.
  • When the previous year is closed and had a non-zero result, that result must already be allocated; otherwise the close is refused.
What else happens
  • Posts closing entries in the closing journal (CL) dated on the year’s end date: one clears the revenue accounts (class 7) and one clears the expense accounts (classes 6 and 8) into the net result account (131).
  • When the year ends in a loss, posts a third entry moving the loss from 131 to the loss result account (139).
  • Marks the year as closed with the closing time and author. Entries dated in the year are refused because its periods are all closed, not because of this flag.
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, label, start_date, end_date, currency_code, currency_exponent, is_closed, closed_at, created_at, updated_at.

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

Response

Resource (only with response=resource).

id

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

owner_type

Kind of book that owns the year; set by the server from the selected book.

label

Name of the fiscal year.

start_date

First day of the year, ISO 8601 date.

end_date

Last day of the year, ISO 8601 date.

currency_code

Three-letter currency code in which the year's entries are kept.

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.

is_closed
boolean

True once the year is closed by the year-end closing; years start open.

closed_at

When the year was closed, ISO 8601; null while it is open or after it is reopened.

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