Sign in
accounts

Update existing account.

Used to update a single account. All fields that are not submitted will be cleared (set to NULL). The model will tell you which fields are mandatory.

put/v1/accounts/{id}

Path parameters

idstring required
Example:123

The ID of the account.

Headers

X-Trace-Idstring uuid
Example:40c71bbb-c676-4f24-83cf-cc725d7d7a00

Unique identifier associated with this request.

Request body

namestring string required
ibanstring iban nullable
bicstring string nullable
account_numberstring string nullable
opening_balancestring amount
opening_balance_datestring date-time nullable
virtual_balancestring amount
currency_idstring string

Use either currency_id or currency_code. Defaults to the user's financial administration's currency.

currency_codestring string

Use either currency_id or currency_code. Defaults to the user's financial administration's currency.

activeboolean

If omitted, defaults to true.

orderinteger

Order of the account

include_net_worthboolean

If omitted, defaults to true.

account_role'defaultAsset' | 'sharedAsset' | 'savingAsset' | 'ccAsset' | 'cashWalletAsset' | 'null' string nullable

Is only mandatory when the type is asset.

credit_card_type'monthlyFull' | 'null' string nullable

Mandatory when the account_role is ccAsset. Can only be monthlyFull or null.

monthly_payment_datestring date-time nullable

Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank.

liability_type'loan' | 'debt' | 'mortgage' | 'null' string nullable

Mandatory when type is liability. Specifies the exact type.

intereststring string nullable

Mandatory when type is liability. Interest percentage.

interest_period'daily' | 'weekly' | 'monthly' | 'quarterly' | 'half-year' | 'yearly' | 'null' string nullable

Mandatory when type is liability. Period over which the interest is calculated.

notesstring string nullable
latitudenumber double nullable

Latitude of the account's location, if applicable. Can be used to draw a map. If omitted, the existing location will be kept. If submitted as NULL, the current location will be removed.

longitudenumber double nullable

Latitude of the account's location, if applicable. Can be used to draw a map. If omitted, the existing location will be kept. If submitted as NULL, the current location will be removed.

zoom_levelinteger nullable

Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. If omitted, the existing location will be kept. If submitted as NULL, the current location will be removed.

Example request

{
  "name": "My checking account",
  "iban": "GB98MIDL07009312345678",
  "bic": "BOFAUS3N",
  "account_number": "7009312345678",
  "opening_balance": "-1012.12",
  "opening_balance_date": "2026-08-01T00:00:00+00:00",
  "virtual_balance": "123.45",
  "currency_id": "12",
  "currency_code": "EUR",
  "order": 1,
  "include_net_worth": true,
  "account_role": "defaultAsset",
  "credit_card_type": "monthlyFull",
  "monthly_payment_date": "2026-08-01T00:00:00+00:00",
  "liability_type": "loan",
  "interest": "5.3",
  "interest_period": "monthly",
  "notes": "Some example notes",
  "latitude": 51.983333,
  "longitude": 5.916667,
  "zoom_level": 6
}

Response

Updated account stored, result in response

Changes

No recorded changes to this endpoint across all 1 revision of this API.