Run a period-close task

Operation ID: executeAccountingPeriodTask

Group: Accounting › Accounting Period Status

Open in the interactive reference

POST /accounting/period-status/{id}/execute-task

Retry-safe: A write that accepts Idempotency-Key: repeating a request with the same key replays the stored answer instead of executing twice.

Runs a period-close task. A task runs on one accounting period status. For example, it opens, closes, or reopens the period, or locks or unlocks accounts payable (AP), accounts receivable (AR), journals, or revenue.

Some tasks also change related periods. 'open' also opens earlier periods of the same legal entity and accounting book that aren't open yet. 'reopen' and the unlock tasks also reopen later closed periods, and the parent legal entity's period if it is closed. 'lockAR', 'unlockAR', 'lockAP', and 'unlockAP' also apply to the legal entity's other accounting books.

Before you send the request, read closeTasks on GET accounting/period-status/:id. For a task in the list, check isExecutable. For 'reopen' or an unlock task, check isReversible on the task it undoes.

The response is empty. Read the result with GET accounting/period-status/:id.

Parameters

Name In Type Required Description
Api-Version header string · v1 yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
Idempotency-Key header string no An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with 400 IDEMPOTENCY_NOT_SUPPORTED rather than silently ignored.
id path string yes The unique identifier for the entity-book period status row to run the task against. This is the id of a record from GET accounting/period-status, not the shared accountingPeriodId.

Request body

Required, application/json: executeAccountingPeriodTaskInput.

Field Type Required Description
task string yes The close task to run. Possible values: 'open', 'close', 'reopen', 'lockAR', 'unlockAR', 'lockAP', 'unlockAP', 'lockJournals', 'unlockJournals', 'lockRevenue', 'unlockRevenue', 'runRevaluation', 'calculateConsolidationRates'. These are the taskCode values on closeTasks. An unrecognized code fails with UNKNOWN_TASK. A recognized code that cannot run now fails with TASK_NOT_EXECUTABLE.
reopeningReason string no A free-text reason recorded against the period. Used only by the 'reopen' task, which stores it as the period's reopeningReason and shows it on both read routes. Other tasks ignore it. Supply it when reopening a closed period, since it is the only record of why the close was undone. 
{
  "task": "<task>",
  "reopeningReason": "<reopeningReason>"
}

Response

200 Success

{
  "data": {},
  "diagnostics": [
    {
      "code": "<code>",
      "message": "<message>",
      "severity": "error",
      "path": [
        "<path>"
      ],
      "details": "<details>"
    }
  ]
}

Response headers

Errors

Code Status
NOT_FOUND 400
UNKNOWN_TASK 400
TASK_NOT_EXECUTABLE 400
IDEMPOTENCY_KEY_CONFLICT 409
IDEMPOTENCY_PAYLOAD_MISMATCH 422

Statuses