← ExamplesAPI documentation

Ledger API navigation

Update account

Accounts and transactions · JSON contract

Read specification

Updates the account's name and type. Both fields are required by this illustrative contract; the account ID and existing balance remain unchanged.

PATCH/api/accounts/101

Parameters

idinteger · path · required: The identifier of an existing account.
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 updated account object, or a field-validation, missing-resource or duplicate-name error.

Response codes

200: Updated account
400: Invalid fields
404: Unknown account
409: Duplicate name

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

Request

cURL

PATCH/api/accounts/101

curl -X PATCH "$API_ORIGIN/api/accounts/101" \
  -H 'Content-Type: application/json' \
  -d '{"name":"Main operating account","accountType":"Asset"}'

Response

Updated account

{
  "accountType": "Asset",
  "balance": 15611,
  "currency": "USD",
  "id": 101,
  "name": "Main operating account"
}

Invalid fields

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

Unknown account

{
  "error": "not_found",
  "message": "The resource does not exist."
}

Duplicate name

{
  "error": "account_name_exists"
}