Balance

Represents a balance account within a profile.

idinteger, (int64)

Balance ID.

Example:200001

currencystring

Currency code (ISO 4217 Alphabetic Code).

Example:"EUR"

typestring

Type of balance account.

STANDARD - Standard balance account. Only one per currency per profile.
SAVINGS - Savings balance (Jar). Multiple allowed per currency.

Enum:"STANDARD""SAVINGS"

Example:"STANDARD"

namestring or null

Name of the balance. Required for SAVINGS balances.

Example:null

iconobject or null

Icon for the balance.

Example:null

investmentStatestring

Investment state of the balance.

NOT_INVESTED - Balance is not invested.
INVESTED - Balance is invested in assets.
INVESTING - Balance is being invested into assets.
DIVESTING - Balance is being divested from assets.
UNKNOWN - Investment state is unknown.

Enum:"NOT_INVESTED""INVESTED""INVESTING""DIVESTING""UNKNOWN"

Example:"NOT_INVESTED"

amountobject

Available balance that can be used to fund transfers.

reservedAmountobject

Amount reserved for transactions.

cashAmountobject

Cash amount in the account.

totalWorthobject

Current total worth.

creationTimestring, (date-time)

Date when the balance was created.

Example:"2020-05-20T14:43:16.658Z"

modificationTimestring, (date-time)

Date when the balance was last modified.

Example:"2020-05-20T14:43:16.658Z"

visibleboolean

Whether the balance is visible to the user.

Example:true

{
  "id": 200001,
  "currency": "EUR",
  "type": "STANDARD",
  "name": null,
  "icon": null,
  "investmentState": "NOT_INVESTED",
  "amount": {
    "value": 310.86,
    "currency": "EUR"
  },
  "reservedAmount": {
    "value": 0,
    "currency": "EUR"
  },
  "cashAmount": {
    "value": 310.86,
    "currency": "EUR"
  },
  "totalWorth": {
    "value": 310.86,
    "currency": "EUR"
  },
  "creationTime": "2020-05-20T14:43:16.658Z",
  "modificationTime": "2020-05-20T14:43:16.658Z",
  "visible": true
}