Skip to main content
POST
/
periods
/
{id}
/
request-close
Request a period close (initiates SoD workflow)
curl --request POST \
  --url https://api.arcuserp.com/v1/periods/{id}/request-close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "notes": "<string>"
}
'
{
  "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",
  "created_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.arcuserp.com/llms.txt

Use this file to discover all available pages before exploring further.

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
​
notes
string

Response

Period marked close_requested

An accounting period. Closed periods refuse new journal entry postings (Rule A3). Closing auto-generates a retained-earnings rollover JE at fiscal year end. Verified against live dev RDS accounting.accounting_periods.

​
id
string<uuid>
read-only
​
entity_id
string<uuid>
read-only
​
period_name
string

Human-readable name (e.g. 'January 2025')

​
start_date
string<date>
​
end_date
string<date>
​
status
enum<string>
read-only
Available options:
open,
close_requested,
closed
​
closed_by
string<uuid> | null
read-only
​
closed_at
string<date-time> | null
read-only
​
close_requested_by
string<uuid> | null
read-only
​
close_requested_at
string<date-time> | null
read-only
​
close_approved_by
string<uuid> | null
read-only
​
close_approved_at
string<date-time> | null
read-only
​
created_at
string<date-time>
read-only