Skip to main content
PATCH
/
recurring-journal-entries
/
{id}
Update a recurring journal entry template
curl --request PATCH \
  --url https://api.arcuserp.com/v1/recurring-journal-entries/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "frequency": "daily",
  "next_run_date": "2023-12-25",
  "is_active": true,
  "template_lines": [
    {}
  ]
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "frequency": "daily",
  "next_run_date": "2023-12-25",
  "last_run_date": "2023-12-25",
  "is_active": true,
  "template_lines": [
    {}
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_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
​
name
string
​
description
string
​
frequency
enum<string>
Available options:
daily,
weekly,
monthly,
quarterly,
annually
​
next_run_date
string<date>
​
is_active
boolean
​
template_lines
object[]

Response

Updated template

A recurring journal entry template. The scheduler job post_recurring_entries posts it on each next_run_date and advances by frequency. Idempotency key per run: recurring:<template_id>:<next_run_date>. Verified against live dev RDS accounting.recurring_journal_entries.

​
id
string<uuid>
read-only
​
entity_id
string<uuid>
read-only
​
name
string
​
description
string | null
​
frequency
enum<string>
Available options:
daily,
weekly,
monthly,
quarterly,
annually
​
next_run_date
string<date>
​
last_run_date
string<date> | null
read-only
​
is_active
boolean
​
template_lines
object[]

Line templates (account_id + debit or credit per line)

​
created_at
string<date-time>
read-only
​
updated_at
string<date-time>
read-only