Skip to main content
POST
/
journal-entries
Create a manual journal entry
curl --request POST \
  --url https://api.arcuserp.com/v1/journal-entries \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entry_date": "2023-12-25",
  "description": "<string>",
  "lines": [
    {
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "debit": 1,
      "credit": 1,
      "description": "<string>",
      "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "department_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "class_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "source_type": "<string>",
  "source_id": "<string>",
  "source_module": "<string>",
  "bypass_period_check": false
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entry_number": "<string>",
  "entry_date": "2023-12-25",
  "period_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "entry_type": "<string>",
  "status": "draft",
  "approval_status": "auto_approved",
  "description": "<string>",
  "source_type": "<string>",
  "source_id": "<string>",
  "source_module": "<string>",
  "is_reversing": true,
  "reversed_by_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reversal_of_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "reverse_in_period_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "batch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "total_debit": 123,
  "total_credit": 123,
  "posted_at": "2023-11-07T05:31:56Z",
  "approved_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "approved_at": "2023-11-07T05:31:56Z",
  "rejected_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rejected_at": "2023-11-07T05:31:56Z",
  "rejection_reason": "<string>",
  "idempotency_key": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "lines": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "journal_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "line_number": 123,
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "debit_amount": 1,
      "credit_amount": 1,
      "description": "<string>",
      "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "department_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "class_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "reconciled": true,
      "reconciled_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.

Body

application/json
​
entry_date
string<date>
required

ISO date (YYYY-MM-DD). Must fall within an open accounting period.

​
description
string
required
​
lines
object[]
required

Journal entry lines. Every line must reference a postable (non-header, active, entity-scoped) GL account. Exactly one of debit or credit must be > 0 per line. DR sum must equal CR sum across all lines.

Minimum array length: 2
​
source_type
string

Source type label (defaults to MANUAL). Use canonical JE_SOURCE_TYPE values when creating programmatic entries.

​
source_id
string

UUID or reference of the source document

​
source_module
string
​
bypass_period_check
boolean
default:false

Migration-only. Requires migration:write scope. Silently dropped for all other callers. Every use is audit-logged.

Response

Created journal entry (auto-approved or pending-approval)

A double-entry journal entry. DR sum = CR sum across all lines (Rule A1 / assertGLBalance). entry_date must fall in an open accounting period (Rule A3). Once posted, entries are immutable -- use reverse to undo. Verified against live dev RDS accounting.journal_entries.

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

Human-readable number (e.g. SB-JE-0000001)

​
entry_date
string<date>
​
period_id
string<uuid> | null
read-only
​
entry_type
string | null
​
status
enum<string>
read-only
Available options:
draft,
pending_approval,
posted,
reversed,
voided,
rejected
​
approval_status
enum<string> | null
read-only
Available options:
auto_approved,
pending_approval,
approved,
rejected
​
description
string
​
source_type
string

Event source (e.g. MANUAL, FULFILLMENT, PAYMENT, REFUND, PO_RECEIPT, VENDOR_BILL, SHOPIFY_IMPORT, RECURRING_JE, MANUAL_REVERSAL).

​
source_id
string | null
​
source_module
string | null
​
is_reversing
boolean
read-only
​
reversed_by_id
string<uuid> | null
read-only
​
reversal_of_id
string<uuid> | null
read-only
​
reverse_in_period_id
string<uuid> | null
read-only
​
batch_id
string<uuid> | null

Groups JEs from one business event (e.g. fulfillment posts revenue + COGS + tax + shipping in one batch). Use GET /v1/journal-entries?batch_id= to retrieve all JEs in a batch.

​
total_debit
number
read-only
​
total_credit
number
read-only
​
posted_at
string<date-time> | null
read-only
​
approved_by
string<uuid> | null
read-only
​
approved_at
string<date-time> | null
read-only
​
rejected_by
string<uuid> | null
read-only
​
rejected_at
string<date-time> | null
read-only
​
rejection_reason
string | null
read-only
​
idempotency_key
string | null
​
created_at
string<date-time>
read-only
​
updated_at
string<date-time>
read-only
​
lines
object[]
read-only

JE lines (included on GET single; omitted on list responses)