PUT
Rename a fiscal year (organization)
Organization space Accounting module For: Accountant · Permission: fiscal_years.update Conditions
  • The book must be one the caller’s access opens.
  • The accounting module must be part of the organization’s plan.
  • Only the label can change; a null or missing label leaves it as it is. Nothing checks whether the year is closed.
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

fiscalYear
string
required

Identifier of the accounting book, not of the year: the generated path names the books segment {fiscalYear}; the year is the {fiscal_year} segment.

fiscal_year
string
required

Identifier of the fiscal year (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, 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: .

Body

application/json
label
string | null

New name of the fiscal year. Optional: null or missing keeps the current one. Nothing else can be changed.

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