Skip to main content
GET
/
journal-entries
List journal entries
curl --request GET \
  --url https://api.arcuserp.com/v1/journal-entries \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
        }
      ]
    }
  ],
  "total": 123,
  "page": 123,
  "per_page": 123
}

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.

Query Parameters

​
status
enum<string>
Available options:
draft,
pending_approval,
posted,
reversed,
voided,
rejected
​
source_type
string

Filter by source_type string (e.g. MANUAL, FULFILLMENT, PAYMENT, REFUND, PO_RECEIPT, VENDOR_BILL, SHOPIFY_IMPORT, RECURRING_JE).

​
source_id
string

Filter by source_id (e.g. order_id, payment_id)

​
source_module
string
​
batch_id
string<uuid>

Filter by batch_id (groups JEs from one business event)

​
period_id
string<uuid>
​
entry_type
string
​
created_after
string<date-time>
​
created_before
string<date-time>
​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
default:25
Required range: 1 <= x <= 100

Response

Paginated list of journal entries

​
data
object[]
​
total
integer
​
page
integer
​
per_page
integer