Get an accounting period
Finance module
GET/accounting-periods/{id}accountingPeriods.get
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.
- Requires the capability finance.journal.read.
- OAuth scopes: finance.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the accounting period. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: 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 GET "$XOS_BASE_URL/accounting-periods/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.accountingPeriods.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.accounting_periods.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos accounting-periods get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f