Skip to main content
GET
/
reports
/
account-ledger
Account ledger (transaction history for a GL account)
curl --request GET \
  --url https://api.arcuserp.com/v1/reports/account-ledger \
  --header 'Authorization: Bearer <token>'
{
  "account": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "account_number": "<string>",
    "name": "<string>",
    "description": "<string>",
    "account_type": "asset",
    "account_sub_type": "<string>",
    "normal_balance": "debit",
    "is_header": true,
    "parent_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_system_account": true,
    "system_account_key": "<string>",
    "is_bank_account": true,
    "is_active": true,
    "tax_line_mapping": "<string>",
    "opening_balance": 123,
    "opening_balance_date": "2023-12-25",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "opening_balance": 123,
  "closing_balance": 123,
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "entry_date": "2023-12-25",
      "description": "<string>",
      "debit": 123,
      "credit": 123,
      "running_balance": 123,
      "journal_entry_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

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

​
account_id
string<uuid>
required

GL account to retrieve ledger for (required)

​
from_date
string<date>
​
to_date
string<date>
​
period_id
string<uuid>
​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
default:50
Required range: 1 <= x <= 100

Response

Account ledger with running balance

​
account
object

A General Ledger account in the chart of accounts. Header accounts (is_header=true) aggregate child accounts and cannot receive postings (Rule A2 / Rule 21). Leaf accounts (is_header=false, is_active=true) are the only valid targets for journal entry lines. System accounts (is_system_account=true) are provisioned by entity-seed-helpers.mjs and cannot be created or modified via the API.

​
opening_balance
number
​
closing_balance
number
​
data
object[]