Skip to content
XOS Developers

accountingPeriods

Finance module · 4 operations

List accounting period rows

GET/accounting-periods

An accounting period. A closed period refuses postings; an open period cannot become Audited without passing through Closed. Returns a cursor page of accounting period rows the caller may see. The default order is `starts_on` ascending. Supports sparse fieldsets and the filter grammar.

Create an accounting period

POST/accounting-periods

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.

Get an accounting period

GET/accounting-periods/{id}

An accounting period. A closed period refuses postings; an open period cannot become Audited without passing through Closed. Returns one accounting period with its `ETag`. A accounting period the caller may not see returns 404.

Transition an accounting period

POST/accounting-periods/{id}/transitions

Moves the period through Open, In Period, Closing, Closed, Audited and Archived. A closed period refuses postings; Audited is reachable only through Closed. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.