Sign in
accounts

Create new account.

Creates a new account. The data required can be submitted as a JSON body or as a list of parameters (in key=value pairs, like a webform).

post/v1/accounts

Headers

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

Unique identifier associated with this request.

Request body

namestring string required
type'asset' | 'expense' | 'import' | 'revenue' | 'cash' | 'liability' | 'liabilities' | 'initial-balance' | 'reconciliation' string required

Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually.

ibanstring iban nullable
bicstring string nullable
account_numberstring string nullable
opening_balancestring amount

Represents the opening balance, the initial amount this account holds.

opening_balance_datestring date-time nullable

Represents the date of the opening balance.

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.

liability_direction'credit' | 'debit' | 'null' string nullable

'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabilities.

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 accounts's location, if applicable. Can be used to draw a map.

longitudenumber double nullable

Latitude of the accounts's location, if applicable. Can be used to draw a map.

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.

Example request

{
  "name": "My checking account",
  "type": "asset",
  "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",
  "liability_direction": "credit",
  "interest": "5.3",
  "interest_period": "monthly",
  "notes": "Some example notes",
  "latitude": 51.983333,
  "longitude": 5.916667,
  "zoom_level": 6
}

Response

New account stored, result in response.

Changes

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