Periods

Accounting periods and close.

List periods

GET /periods

Sends Vortex-Entity.

Parameters

NameInTypeAbout
fiscal_yearqueryinteger

Answers

  • 200 object. The entity's periods.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what

Close a period

POST /periods/{period_id}/close

Sends Vortex-Entity and Idempotency-Key.

Soft close warns on new postings; hard close rejects them. Reopening a hard-closed period is not available through the API; an admin does it in the app with a logged reason. Requires periods:close, which agents never hold.

Parameters

NameInTypeAbout
period_id requiredpathstring

Body

FieldTypeAbout
mode requiredstring

One of: soft, hard.

Answers

  • 200 Period. The period.
  • 4XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what
  • 5XX Problem. An error. `code` is stable and safe to branch on; `detail` says in plain English what