Transition an accounting period

Módulo Finance

POST/accounting-periods/{id}/transitionsaccountingPeriods.transition

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

Requiere la capacidad finance.period.close.
Alcances de OAuth: finance.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 404, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

accountingPeriods.transition: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the accounting period.

Cuerpo de la solicitud: AccountingPeriodTransitionRequest

accountingPeriods.transition: AccountingPeriodTransitionRequest
Campo	Tipo	Obligatorio	Descripción
expected_state	"Open" \| "In Period" \| "Closing" \| "Closed" \| "Audited" \| "Archived"	Sí	The state the caller believes the row is in (compare-and-set).
to_state	"Open" \| "In Period" \| "Closing" \| "Closed" \| "Audited" \| "Archived"	Sí	Target state.
reason	string	No	Reason, required by some transitions.Restricciones: length 1 to any

{
  "expected_state": "Closing",
  "to_state": "Closed",
  "reason": "Client approved the revised scope."
}

Respuesta 200: AccountingPeriod

accountingPeriods.transition: AccountingPeriod
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the accounting period.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
starts_on	string (date)	Sí	First day.
ends_on	string (date)	Sí	Last day.
period_state	AccountingPeriodState	Sí	Accounting period lifecycle. A closed period refuses postings.Restricciones: 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"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/accounting-periods/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/transitions" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"expected_state":"Closing","to_state":"Closed","reason":"Client approved the revised scope."}'

const { data } = await xos.accountingPeriods.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "expected_state": "Closing",
    "to_state": "Closed",
    "reason": "Client approved the revised scope."
  });

response = xos.accounting_periods.transition("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"expected_state": "Closing", "to_state": "Closed", "reason": "Client approved the revised scope."})

xos accounting-periods transition 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"expected_state":"Closing","to_state":"Closed","reason":"Client approved the revised scope."}'