Account Management APIs

Create an Account in a Chart

A finance team creates a new account under a specific chart to track transactions for a business unit. This ensures proper financial categorization and reporting within the platform.

put

Creates or updates a chart account.

Path parameters

namestringRequired

Body

application/json

Information about an account that is supplied by an agent.

@typestring · enumRequiredPossible values:

referencestringRequired

The reference by which the account will be referenced externally. References are only required to be unique within their chart/group.

tagsstring[]Optional

Tags that are assigned to classify the account.

Responses

200

Response to /api/v1/chart/{name}

application/json

default

default response to /api/v1/chart/{name}

application/json

put

/api/v1/chart/{name}

HTTPcURLJavaScriptPython

PUT /api/v1/chart/{name} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "@type": "cac_ledger_schema_info_ledger_account_info",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "reference": "text",
  "tags": [
    "text"
  ]
}

{
  "@type": "cac_ledger_schema_element_ledger_account_elem",
  "chart": {
    "@type": "cac_ledger_schema_element_ledger_chart_elem",
    "created_at": "2025-12-05T22:54:28.112Z",
    "id": 1,
    "info": {
      "@type": "cac_ledger_schema_info_ledger_chart_info",
      "name": "text"
    },
    "updated_at": "2025-12-05T22:54:28.112Z"
  },
  "created_at": "2025-12-05T22:54:28.112Z",
  "group": {
    "@type": "cac_ledger_schema_element_ledger_group_elem",
    "created_at": "2025-12-05T22:54:28.112Z",
    "id": 1,
    "info": {
      "@type": "cac_ledger_schema_info_ledger_group_info",
      "name": "text"
    },
    "updated_at": "2025-12-05T22:54:28.112Z"
  },
  "id": 1,
  "info": {
    "@type": "cac_ledger_schema_info_ledger_account_info",
    "attributes": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "reference": "text",
    "tags": [
      "text"
    ]
  },
  "revision": 1,
  "status": "CLOSED",
  "updated_at": "2025-12-05T22:54:28.112Z"
}

List Accounts in a Chart

An admin retrieves all accounts under a specific chart to review financial structures and ensure correct account mappings. This helps with auditing and maintaining financial accuracy.

get

Queries recorded chart accounts.

Query parameters

filterstringRequired

page[size]stringOptional

page[number]stringOptional

sortstringOptional

Responses

200

Response to /api/v1/chart/*/

No content

default

default response to /api/v1/chart/*/

application/json

get

/api/v1/chart/*/

HTTPcURLJavaScriptPython

GET /api/v1/chart/*/?filter=text HTTP/1.1
Host: 
Accept: */*

No content

Best Practices for Adding Accounts

• Use Consistent Naming: Clearly define account references (e.g., MAIN_ACCOUNT, REVENUE_ACCOUNT) to improve readability and maintenance.

• Plan Wallets Ahead: Determine the currencies or assets an account will manage before assigning wallets to avoid misconfiguration.

• Validate Accounts: Test transactions and verify balances to ensure expected behavior before activating the account for live usage.