Withdraw a pending period-close request

Required API key scope: accounting:close_period

Withdraws a period-close request that has been raised but not yet approved, returning the period from pending_approval to open.

BOOKS-100 PERIOD-CLOSE-UNDO (2026-08-28). Before this endpoint the only exits from pending_approval were (a) a second person APPROVING the request, which closes the period — the opposite of what someone who mis-clicked wants — or (b) a raw UPDATE. And pending_approval is a posting-blocking state, so one stray click froze a month of the ledger with no in-product undo. This is the Rule 25 api-v1 twin of the Cognito-JWT POST /gl/periods/{id}/withdraw-close-request; both call the same canonical handler, so authorization and guards are identical.

Authorization, two tiers (Rule 33 point 5 — self-service on your OWN record never requires the org permission):

1. Floor — gl.close_period, the permission that let you RAISE the request in the first place. Gating the route itself on gl.approve_close would lock the REQUESTER out of taking back their own mis-click, which is the whole population this endpoint exists for.
2. Plus — if the caller is NOT close_requested_by, they additionally need gl.approve_close. Cancelling someone else’s request is an approval-authority act. Returns 403 only_requester_or_approver_can_withdraw.

Guards:

• Layer 1 isolation — the period is scoped to the API key’s entity_id; cross-tenant attempts return 404.
• State guard — only pending_approval periods can be withdrawn. Returns 409 period_not_in_pending_approval with current_status.
• Row lock — the state read takes FOR UPDATE, and the UPDATE re-asserts status = 'pending_approval', so a concurrent approve-close cannot slip between the test and the flip. A lost race returns 409 period_state_changed.
• Audit log (Rule 20) — an activity_log row records the prior state, the original requester, the withdrawing user, whether the withdrawer WAS the requester, and the optional reason.
• Broadcast (Rule 13) — gl.period.close_request_withdrawn is emitted, mirroring the gl.period.close_requested event it undoes.

Write surface is deliberately three columns and no more: status back to open, plus close_requested_by and close_requested_at cleared. close_approved_by / close_approved_at / close_checksum_hex are NOT touched — on a pending_approval row they are NULL by construction (approve-close writes them in the SAME statement that flips status to closed), so writing them would be a claim about state this handler has not measured.

POST /periods/{id}/withdraw-close-request

Withdraw a pending period-close request

cURL

curl --request POST \
  --url https://api.arcuserp.com/v1/periods/{id}/withdraw-close-request \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Raised the close request by mistake while reviewing the period."
}
'

200

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "period_name": "<string>",
    "start_date": "2023-12-25",
    "end_date": "2023-12-25",
    "status": "open",
    "closed_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "closed_at": "2023-11-07T05:31:56Z",
    "close_requested_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "close_requested_at": "2023-11-07T05:31:56Z",
    "close_approved_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "close_approved_at": "2023-11-07T05:31:56Z",
    "reopen_reason": "<string>",
    "reopened_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "reopened_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_ Test keys use ark_test_ent_. Both are issued per entity via Settings > Developers > API Keys.

Path Parameters

id · string<uuid> · required

Body

application/json

reason · string

Optional free-text justification. Recorded verbatim in the activity_log description and metadata. No length validation.

Example:

"Raised the close request by mistake while reviewing the period."

Response

200

application/json

Close request withdrawn; period returned to open.

data · object

An accounting period. Closed periods refuse new journal entry postings (Rule A3). Year-end closing entries that roll revenue and expense activity into retained earnings are posted via a separate explicit endpoint (POST /v1/accounting_periods/{id}/close-fiscal-year). The monthly-period close does NOT by itself post a retained-earnings rollover JE. Verified against live dev RDS accounting.accounting_periods.

Show child attributes