TRANXACT.AI Help

Accounting · General Ledger

Fiscal Year Variants

How this company cuts its fiscal years: the calendar year, twelve months from another month, 4-4-5 / 4-5-4 / 5-4-4 weeks or thirteen four-week periods, with optional special (adjustment) periods. A variant is fixed once a year cut with it has postings; add a new one for the years to come.

Type REST6 operationsBase path /api/accounting/fiscal-year-variantsPublished as /api/v1/fiscal-year-variants

Download specification (OpenAPI 3.1) Screen: Fiscal Year Variants

Overview

PackageAccounting
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Accounting › Fiscal Year Variants on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen.
Tableacct.fiscal_year_variants · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

6 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/accounting/fiscal-year-variantsList fiscal year variants

Query parameters

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"col":"status","op":"eq","value":"open"}
<field>=<value>Shorthand for "field is value" 

Response 200

{
  "rows": [
    {
      "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "code": "COD-000001",
      "name": "Example",
      "kind": "Calendar year (January to December)",
      "start_month": "January",
      "week_anchor_day": "Sunday",
      "anchor_rule": "The last one in the month",
      "special_periods": 10,
      "is_default": true,
      "origin": "text",
      "description": "text",
      "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
      "created_at": "2026-10-30T09:00:00Z",
      "updated_at": "2026-10-30T09:00:00Z"
    }
  ],
  "count": 1
}

Sample request

curl "https://demo.tranxact.ai/api/accounting/fiscal-year-variants?limit=20" \
  -H "Authorization: Bearer $TOKEN"
GET/api/accounting/fiscal-year-variants/{id}Read one fiscal year variant

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "kind": "Calendar year (January to December)",
  "start_month": "January",
  "week_anchor_day": "Sunday",
  "anchor_rule": "The last one in the month",
  "special_periods": 10,
  "is_default": true,
  "origin": "text",
  "description": "text",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z",
  "updated_at": "2026-10-30T09:00:00Z"
}

404 when no record with that id is visible to the caller.

Sample request

curl "https://demo.tranxact.ai/api/accounting/fiscal-year-variants/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/fiscal-year-variantsCreate a fiscal year variant

Request body

The record as JSON. Fields marked Yes are required.

FieldTypeRequiredDescription
codetextYesCode — A short name, e.g. CAL, FYAPR, R445.
nametextYesName
kindtextNoHow the year is cut
Allowed: Calendar year (January to December) Twelve months from a start month (e.g. April to March) 4-4-5 weeks (52/53-week year) 4-5-4 weeks (52/53-week year) 5-4-4 weeks (52/53-week year) Thirteen four-week periods
start_monthintegerNoThe year starts in — A calendar year starts in January. A week-based year ends on the chosen weekday in the month before.
Allowed: January February March April May June July August September October November December
week_anchor_dayintegerNoThe year ends on a
Allowed: Sunday Monday Tuesday Wednesday Thursday Friday Saturday
anchor_ruletextNoWhich one
Allowed: The last one in the month The one nearest the month’s end
special_periodsintegerNoSpecial (adjustment) periods — 0 to 4, dated on the year’s last day, for audit and closing entries.
is_defaultbooleanNoDefault for new years
descriptiontextNoDescription

Sample body

{
  "code": "COD-000001",
  "name": "Example",
  "kind": "Calendar year (January to December)",
  "start_month": "January",
  "week_anchor_day": "Sunday",
  "anchor_rule": "The last one in the month"
}

Response 201

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "kind": "Calendar year (January to December)",
  "start_month": "January",
  "week_anchor_day": "Sunday",
  "anchor_rule": "The last one in the month",
  "special_periods": 10,
  "is_default": true,
  "origin": "text",
  "description": "text",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z",
  "updated_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/fiscal-year-variants" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example","kind":"Calendar year (January to December)","start_month":"January","week_anchor_day":"Sunday","anchor_rule":"The last one in the month"}'
PUT/api/accounting/fiscal-year-variants/{id}Change a fiscal year variant

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
codetextYesCode — A short name, e.g. CAL, FYAPR, R445.
nametextYesName
kindtextNoHow the year is cut
Allowed: Calendar year (January to December) Twelve months from a start month (e.g. April to March) 4-4-5 weeks (52/53-week year) 4-5-4 weeks (52/53-week year) 5-4-4 weeks (52/53-week year) Thirteen four-week periods
start_monthintegerNoThe year starts in — A calendar year starts in January. A week-based year ends on the chosen weekday in the month before.
Allowed: January February March April May June July August September October November December
week_anchor_dayintegerNoThe year ends on a
Allowed: Sunday Monday Tuesday Wednesday Thursday Friday Saturday
anchor_ruletextNoWhich one
Allowed: The last one in the month The one nearest the month’s end
special_periodsintegerNoSpecial (adjustment) periods — 0 to 4, dated on the year’s last day, for audit and closing entries.
is_defaultbooleanNoDefault for new years
descriptiontextNoDescription

Sample body

{
  "code": "COD-000001",
  "name": "Example"
}

Response 200

{
  "id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "code": "COD-000001",
  "name": "Example",
  "kind": "Calendar year (January to December)",
  "start_month": "January",
  "week_anchor_day": "Sunday",
  "anchor_rule": "The last one in the month",
  "special_periods": 10,
  "is_default": true,
  "origin": "text",
  "description": "text",
  "org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
  "created_at": "2026-10-30T09:00:00Z",
  "updated_at": "2026-10-30T09:00:00Z"
}

Sample request

curl -X PUT "https://demo.tranxact.ai/api/accounting/fiscal-year-variants/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"code":"COD-000001","name":"Example"}'
DELETE/api/accounting/fiscal-year-variants/{id}Delete a fiscal year variant

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Response 200

{ "deleted": true }

Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.

Sample request

curl -X DELETE "https://demo.tranxact.ai/api/accounting/fiscal-year-variants/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/accounting/fiscal-year-variants/{id}/copyCopy

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

overrides, preview, withLines

Response

200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.

Sample request

curl -X POST "https://demo.tranxact.ai/api/accounting/fiscal-year-variants/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"overrides":"value","preview":"value","withLines":"value"}'

Data model

Every field of a fiscal year variant, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
codetextread, writeCode — A short name, e.g. CAL, FYAPR, R445.
nametextread, writeName
kindtextread, writeHow the year is cut
Allowed: Calendar year (January to December) Twelve months from a start month (e.g. April to March) 4-4-5 weeks (52/53-week year) 4-5-4 weeks (52/53-week year) 5-4-4 weeks (52/53-week year) Thirteen four-week periods
start_monthintegerread, writeThe year starts in — A calendar year starts in January. A week-based year ends on the chosen weekday in the month before.
Allowed: January February March April May June July August September October November December
week_anchor_dayintegerread, writeThe year ends on a
Allowed: Sunday Monday Tuesday Wednesday Thursday Friday Saturday
anchor_ruletextread, writeWhich one
Allowed: The last one in the month The one nearest the month’s end
special_periodsintegerread, writeSpecial (adjustment) periods — 0 to 4, dated on the year’s last day, for audit and closing entries.
is_defaultbooleanread, writeDefault for new years
origintextread onlyOrigin
descriptiontextread, writeDescription
org_unit_iduuidread onlyOrg unit id
created_attimestamp with time zoneread onlyCreated at
updated_attimestamp with time zoneread onlyUpdated at
created_byuuidread onlyCreated by
updated_byuuidread onlyUpdated by
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Accounting › Fiscal Year Variants for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused by the same validation as the screen; the error names the field and why

Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.