POST
Close a fiscal period (client account)
Client space Accounting module Cannot be undone For: Accountant · Permission: fiscal_periods.close Conditions
  • The accounting module must be part of the organization’s plan.
  • The period must not already be closed.
  • Every earlier period of the book, in any fiscal year, must already be closed.
  • When the period is the last open period of its fiscal year, the previous fiscal year (the one ending the day before this one starts) must be closed, and its result must have been allocated when it closed with a non-zero result.
What else happens
  • Marks the period closed and records the closing time and the actor; entries, depreciation runs, disposals and rollbacks dated in a closed period are then refused.
  • No action of this unit reopens a period, and reopening the fiscal year does not reopen its periods.
Part of Fiscal years and periods.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

fiscalPeriod
string
required

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

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, fiscal_year_id, label, start_date, end_date, 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 period (27-character KSUID).

owner_type

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

fiscal_year_id

Identifier of the fiscal year the period belongs to.

label

Name of the period; unique within its fiscal year. Periods generated with a year are labelled Y-m.

start_date

First day of the period, ISO 8601 date.

end_date

Last day of the period, ISO 8601 date.

is_closed
boolean

True once the period is closed and accepts no more entries. Periods start open.

closed_at

When the period was closed, ISO 8601; null while it is open.

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