Sign in

v1

latestOpenAPI 3.0.12026-07-144840447.2 KB
Ledger Accounts

Update a ledger account

Update a ledger account

ℹ️ This endpoint requires the following scope: ledger_accounts:all

put/api/external/firm/v1/companies/{company_id}/ledger_accounts/{id}

Path parameters

company_idinteger required
Example:123

Existing company identifier (id)

idinteger required
Example:234

Ledger Account ID

Request body

labelstring

Label that describes the ledger account

letterableboolean

Whether the ledger entries of this ledger account are letterable

Example request

{
  "label": "Capital",
  "letterable": true
}

Response

Returns the updated ledger account

idinteger required
numberstring required
labelstring required
vat_ratestring required

Ledger Account's VAT rate in percentage

country_alpha2string required

Ledger Account's country code (alpha2)

enabledboolean required
letterableboolean required
archived_atstring date-time nullable required

The time the Ledger Account has been archived

Example response

{
  "id": 124,
  "number": "512",
  "label": "Secondary Account",
  "vat_rate": "any",
  "country_alpha2": "FR",
  "enabled": true,
  "archived_at": "2023-08-30T10:08:08.146343Z"
}