Lock accounting period
POST/finance/periods/{id}/lock
Locks or unlocks the accounting period associated with a specific GL close run. Locking prevents further journal postings for that period. Pass is_locked=false to reverse a lock without creating a new run.
Request
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id | integer | Yes | The integer ID of the FinanceGlCloseRun whose period should be locked. Example: |
Request body
Content type application/json.
| Field | Type | Required | Description |
|---|---|---|---|
is_locked | boolean | No | Set to true (default) to lock the period or false to unlock it. Default: |
reason | string | No | Optional explanation for why the period is being locked or unlocked, stored for audit purposes. Max length: 2000 |
Example
{
"is_locked": true,
"reason": "Approved by finance manager — all reconciliations complete."
}Responses
302 Redirect to the finance ops index on success
404 GL close run not found
422 Validation error on request body fields
Example request
curl -X POST "https://{tenant}.faciotech.net/api/v1/finance/periods/{id}/lock" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"is_locked": true, "reason": "Approved by finance manager — all reconciliations complete."}'