Skip to main content
GET
/
gl-accounts
List GL accounts (chart of accounts)
curl --request GET \
  --url https://api.arcuserp.com/v1/gl-accounts \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "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"
    }
  ]
}

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_type
enum<string>

Filter by account type

Available options:
asset,
liability,
equity,
revenue,
expense,
cogs
​
is_active
boolean

Filter by active status (default true)

​
postable_only
boolean

When true, returns only leaf accounts (is_header=false, is_active=true). Use for GL pickers to enforce Rule 21 (no header account postings).

​
system_account_key
string

Filter by system_account_key (e.g. ar_account, cogs, revenue)

​
is_bank_account
boolean

When true, returns only bank account leaves

​
context
enum<string>

Canonical context filter (Rule 21 preferred pattern). Restricts accounts to those appropriate for the given posting context.

Available options:
manual_je_line,
ap_bill_expense_line,
ar_invoice_revenue_line,
bank_rec_line,
inventory_adj_line,
payment_clearing,
cogs_posting
​
search
string

Search by account name or number

Response

Paginated list of GL accounts

​
data
object[]