Data modelsBanking

Deposits & savings

Money set aside — for a term, or for a purpose

View as Markdown

Where it lives: at deposits in the Financial Position, and on its own from the deposits endpoint. Both kinds arrive from the same endpoint; sub_family tells them apart.

Time deposits

Money committed for a term at an agreed rate: the classic fixed deposit.

idstringRequiredformat: "object-id"
product"financial_deposit"Required
sub_family"financial_deposit:time"Required
fetch_datestringRequiredformat: "datetime"
Date this product was fetched
accountobjectRequired
Deposit Account
customer_segmentenumRequired
product_namestringRequired
Product name
availableobjectRequired
The total accessible funds, available for withdrawal.
balanceobjectRequired
The amount of founds currently deposited.
contractobjectOptional
Contract if present
product_aliasstringOptional
Product alias
product_descriptionstringOptional
Product Description
start_datedateOptional
Deposit start date
last_datedateOptional
Deposit last date
interest_rateobjectOptional
Deposit interest rate

Savings goals

The modern equivalent many banks now offer: a pot inside an account, with a target attached. goal_amount is what the customer is saving towards, balance is how far they have got.

idstringRequiredformat: "object-id"
product"financial_deposit"Required
sub_family"financial_deposit:goal"Required
fetch_datestringRequiredformat: "datetime"
Date this product was fetched
accountobjectRequired
Deposit Account
customer_segmentenumRequired
product_namestringRequired
Product name
availableobjectRequired
The total accessible funds, available for withdrawal.
balanceobjectRequired
The amount of founds currently deposited.
contractobjectOptional
Contract if present
product_aliasstringOptional
Product alias
product_descriptionstringOptional
Product Description
start_datedateOptional
Deposit start date
last_datedateOptional
Deposit last date
interest_rateobjectOptional
Deposit interest rate
goal_amountobjectOptional
The goal amount of founds to be deposited.

A savings goal is a signal, not just a balance. Somebody with a funded goal and a steady contribution behaves differently from somebody with the same balance sitting in a current account — which is worth knowing when the question is stability rather than wealth.