Skip to main content
POST
/
recurring-journal-entries
Create a recurring journal entry template
curl --request POST \
  --url https://api.arcuserp.com/v1/recurring-journal-entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "next_run_date": "2023-12-25",
  "template_lines": [
    {
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "debit": 1,
      "credit": 1,
      "description": "<string>"
    }
  ],
  "description": "<string>",
  "is_active": true
}
'
import requests

url = "https://api.arcuserp.com/v1/recurring-journal-entries"

payload = {
"name": "<string>",
"next_run_date": "2023-12-25",
"template_lines": [
{
"account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"debit": 1,
"credit": 1,
"description": "<string>"
}
],
"description": "<string>",
"is_active": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
next_run_date: '2023-12-25',
template_lines: [
{
account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
debit: 1,
credit: 1,
description: '<string>'
}
],
description: '<string>',
is_active: true
})
};

fetch('https://api.arcuserp.com/v1/recurring-journal-entries', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.arcuserp.com/v1/recurring-journal-entries",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'next_run_date' => '2023-12-25',
'template_lines' => [
[
'account_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'debit' => 1,
'credit' => 1,
'description' => '<string>'
]
],
'description' => '<string>',
'is_active' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.arcuserp.com/v1/recurring-journal-entries"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"next_run_date\": \"2023-12-25\",\n \"template_lines\": [\n {\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"debit\": 1,\n \"credit\": 1,\n \"description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"is_active\": true\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.arcuserp.com/v1/recurring-journal-entries")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"next_run_date\": \"2023-12-25\",\n \"template_lines\": [\n {\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"debit\": 1,\n \"credit\": 1,\n \"description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"is_active\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.arcuserp.com/v1/recurring-journal-entries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"next_run_date\": \"2023-12-25\",\n \"template_lines\": [\n {\n \"account_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"debit\": 1,\n \"credit\": 1,\n \"description\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"is_active\": true\n}"

response = http.request(request)
puts response.read_body
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "description": "<string>",
  "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"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}
{
"error": "not_found",
"code": "not_found",
"type": "not_found",
"hint": "The requested order does not exist or does not belong to this entity.",
"param": "expand[0]",
"required": "accounts:read",
"request_id": "req_abc123"
}

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.

Body

application/json
name
string
required
frequency
enum<string>
required
Available options:
daily,
weekly,
monthly,
quarterly,
annually
next_run_date
string<date>
required
template_lines
object[]
required
Minimum array length: 2
description
string
is_active
boolean
default:true

Response

Created recurring journal entry 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