Alladdin

Work in progress

Site en construction

الموقع قيد الإنشاء

Alladdin
GET

List chart of accounts

Scope: accounting:chart-of-accounts.read https://api.alladdin.com/api/v2/accounting-accounts

Returns the list of all accounting accounts in your chart of accounts.
The response includes each account's number, name, and group. Use this endpoint to discover available accounts before creating ledger entries.

Parameters

Query parameters

archived boolean optional

Include archived accounts when true

start_date string<date> optional

Filter accounts with activity from this date (YYYY-MM-DD)

end_date string<date> optional

Filter accounts with activity up to this date (YYYY-MM-DD)

include_empty boolean optional

Include accounts with no transactions when true

text string optional

Case-insensitive partial search on account name or number

Request

python
import requests

url = "https://api.alladdin.com/api/v2/accounting-accounts?archived=value&start_date=2024-01-01&end_date=2024-12-31"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Accept": "application/json",
}

response = requests.get(url, headers=headers)
print(response.json())

Responses

Response

json
{
  "items": [
    {
      "id": "507f1f77bcf86cd799439011",
      "color": "#FF5733",
      "number": 4300,
      "name": "string",
      "description": "string",
      "group": "string",
      "debit": "1500.00",
      "credit": "500.00",
      "balance": "1000.00",
      "archived": false,
      "non_deductible": false
    }
  ]
}

Success responses

200 List of accounting accounts application/json object items[] object[] id string

Unique identifier of the accounting account

color string | null

Color code for visual identification

number integer

Numeric code from the chart of accounts

name string

Display name of the account

description string

Free-text description of the account. Empty when none was set

group string | null

Accounting group this account belongs to

debit string

Decimal as string for precision

credit string

Decimal as string for precision

balance string

Decimal as string for precision

archived boolean

Whether the account has been archived

non_deductible boolean

Whether this expense account (group 6) is excluded from deductible-expense calculations

Error responses

401 Invalid or missing API key application/json 403 Insufficient permissions application/json 429 Rate limit exceeded application/json

← PreviousCreate a ledger entry →

Next →List ledger entries →