Create an accounting period

Finance module

POST/accounting-periodsaccountingPeriods.create

An accounting period. A closed period refuses postings; an open period cannot become Audited without passing through Closed. Creates an accounting period. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability finance.period.manage.
OAuth scopes: finance.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: AccountingPeriodCreate

accountingPeriods.create: AccountingPeriodCreate
Field	Type	Required	Description
starts_on	string (date)	Yes	First day.
ends_on	string (date)	Yes	Last day.

{
  "starts_on": "2026-10-08",
  "ends_on": "2026-10-08"
}

Response 201: AccountingPeriod

accountingPeriods.create: AccountingPeriod
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the accounting period.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
starts_on	string (date)	Yes	First day.
ends_on	string (date)	Yes	Last day.
period_state	AccountingPeriodState	Yes	Accounting period lifecycle. A closed period refuses postings.Constraints: one of "Open", "In Period", "Closing", "Closed", "Audited", "Archived"

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "starts_on": "2026-10-08",
  "ends_on": "2026-10-08",
  "period_state": "Open"
}

Code samples

curl -X POST "$XOS_BASE_URL/accounting-periods" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"starts_on":"2026-10-08","ends_on":"2026-10-08"}'

const { data } = await xos.accountingPeriods.create({
    "starts_on": "2026-10-08",
    "ends_on": "2026-10-08"
  });

response = xos.accounting_periods.create({"starts_on": "2026-10-08", "ends_on": "2026-10-08"})

xos accounting-periods create --data '{"starts_on":"2026-10-08","ends_on":"2026-10-08"}'