← ExamplesAPI documentation

Ledger API navigation

Create account

Accounts and transactions · JSON contract

Read specification

Creates a financial account with a unique name and an available account type. The new account starts with a zero balance in USD.

POST/api/accounts

Parameters

namestring · required: Unique without regard to case. Must contain 1–80 characters.
accountTypeenum · required: One of Asset, Liability, Equity, Revenue or Expense. Reporting currency is USD.

Returns

The created account object. The Location response header identifies /api/accounts/106. Invalid fields and duplicate names do not create a record.

Response codes

201: Created account · Location: /api/accounts/106
400: Invalid account fields
409: Duplicate account name

Illustrative API contract. Set $API_ORIGIN to your own backend; this example does not host these endpoints.

Request

cURL

POST/api/accounts

curl -X POST "$API_ORIGIN/api/accounts" \
  -H 'Content-Type: application/json' \
  -d '{"name":"Reserve fund","accountType":"Asset"}'

Response

Created account · Location: /api/accounts/106

{
  "accountType": "Asset",
  "balance": 0,
  "currency": "USD",
  "id": 106,
  "name": "Reserve fund"
}

Invalid account fields

{
  "error": "validation_failed",
  "fields": {
    "name": "Enter a unique account name of 1\u201380 characters."
  }
}

Duplicate account name

{
  "error": "account_name_exists"
}