Models

AccountStore

object

namestringrequired

Example

My checking account

typeShortAccountTypePropertyassetexpenseimportrevenuecashliabilityliabilitiesinitial-balancereconciliationrequired

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

Example

asset

ibanstring<iban> | null

Example

GB98MIDL07009312345678

bicstring | null

Example

BOFAUS3N

account_numberstring | null

Example

7009312345678

opening_balancestring<amount>

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

Example

-1012.12

opening_balance_datestring<date-time> | null

Represents the date of the opening balance.

Example

2026-10-01T00:00:00+00:00

virtual_balancestring<amount>

Example

123.45

currency_idstring

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

Example

currency_codestring

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

Example

EUR

activebooleantrue

If omitted, defaults to true.

Example

false

orderinteger<int32>

Order of the account

Example

include_net_worthbooleantrue

If omitted, defaults to true.

Example

true

account_roleAccountRoleProperty | nulldefaultAssetsharedAssetsavingAssetccAssetcashWalletAssetnull

Is only mandatory when the type is asset.

Example

defaultAsset

credit_card_typeCreditCardTypeProperty | nullmonthlyFullnull

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

Example

monthlyFull

monthly_payment_datestring<date-time> | null

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

Example

2026-10-01T00:00:00+00:00

liability_typeLiabilityTypeProperty | nullloandebtmortgagenull

Mandatory when type is liability. Specifies the exact type.

Example

loan

liability_directionLiabilityDirectionProperty | nullcreditdebitnull

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

Example

credit

intereststring | null0

Mandatory when type is liability. Interest percentage.

Example

5.3

interest_periodInterestPeriodProperty | nulldailyweeklymonthlyquarterlyhalf-yearyearlynull

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

Example

monthly

notesstring | null

Example

Some example notes

latitudenumber<double> | null

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

Example

51.983333

longitudenumber<double> | null

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

Example

5.916667

zoom_levelinteger<int32> | null

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

{
  "name": "My checking account",
  "type": "asset",
  "iban": "GB98MIDL07009312345678",
  "bic": "BOFAUS3N",
  "account_number": "7009312345678",
  "opening_balance": "-1012.12",
  "opening_balance_date": "2026-10-01T00:00:00+00:00",
  "virtual_balance": "123.45",
  "currency_id": "12",
  "currency_code": "EUR",
  "active": false,
  "order": 1,
  "include_net_worth": true,
  "account_role": "defaultAsset",
  "credit_card_type": "monthlyFull",
  "monthly_payment_date": "2026-10-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
}