Meaning and importance of data fields

Meaning and importance of account-data fields

The following table outlines the fields used in the request payload for manual upload of accounts. Each field is briefly described in terms of its meaning, expected data type, and relative importance. Fields which are not required might still benefit the quality of analyses or display.

Field	Description	Data Type	Required	Notes
accountId	Internal identifier for the account	string	no	If not set, an ID will be generated
accountNumber	Domestic account number	string	no	Not used in most analyses, except IBAN is missing
balance	Current account balance	float	yes
bankCode	Bank's code	string	no	Recommended to provide if available
bankName	Name of the bank	string	yes
bic	Bank Identifier Code	string	no	Recommended to provide if available
overdraft.amount	Maximum value of the agreed overdraft by the bank	boolean	no	Not mandatory for analysis but should be provided if the value is known
overdraft.available	Defines if an overdraft is available	string	no	Should be provided if overdraft.amount is known to be 0
currency	ISO 4217 currency code	string	no	If not set, default will be 'EUR'
iban	IBAN of the account	string	yes
icon	URL to bank's logo/icon	string	no
name	Descriptive account name (account product-name in many cases)	string	no
owner	Name of account owner	string	yes
type	Account type (GIRO, KREDIT_KARTE, DEPOT, etc.)	string	yes	Default value is 'GIRO'. Must be one of 'BAUSPAREN', 'DEPOT', 'FESTGELD', 'FONDSDEPOT', 'GIRO', 'KREDIT_KARTE', 'KREDIT_KONTO', 'KREDITDARLEHEN', 'SPARBUCH', 'TAGESGELD', 'UNKNOWN', 'OTHER'
transactions	Array of transactions to pre-fill the account	array of transaction-objects	yes	Not required if account-type is 'DEPOT'. More details on transaction-fields can be found below
securities	Array of securities for DEPOT accounts	array of securities-objects	yes	Only required if account-type is 'DEPOT'
standingOrders	Pre-existing recurring payments	array of standing-order-objects	yes	More details on securities-fields can be found below

Meaning and importance of transaction-data fields

The next section provides an overview of the JSON fields of transactions for manual upload.

Field	Description	Data Type	Required	Notes
transactionId	Unique ID for each transaction	string	no	If no ID is provided, it will be generated
amount	Transaction amount	float	yes	Outgoing money should be provided with a minus, while incoming money needs no plus sign or such
currency	ISO 4217 currency code	string	no	Default value is 'EUR'
bookingDate	Unix timestamp of booking	integer	yes
valueDate	Unix timestamp when funds are available	integer	no
bookingText	Description-text for the transaction	string	no
purpose	Purpose text of transaction	string	yes	It is beneficial when meta-information (like SEPA-IDs and such) is added along with the purpose-text
paymentPartner.bic	Bank Identifier Code of payment partner	string	no
paymentPartner.creditorId	Creditor identifier of payment partner	string	yes*
paymentPartner.iban	IBAN of the payment partner	string	yes	Some transactions, like bank-internal charges, cash withdrawals and such, do not always need an IBAN
paymentPartner.name	Name of the payment partner	string	yes
differentCreditor / differentDebitor	Ultimate payer/receiver if different from payment partner	string	no
eref	End-to-end-reference number	string	yes*
mref	Mandate-reference number	string	yes*
sepaPurposeCode	Four-character SEPA classification code	string	no
transactionCode	Classification ID for types of transactions	integer	no	Typically a one- to three-digit code

* only applies to SEPA direct-debits

Meaning and importance of securities-data fields

In the following section, the different fields for securities and their respective daty type are listed. As of now, securities-data is only used for display and not for further analyses, so that each field is optional and it is recommended to provide them if possible.

Field	Description	Data Type	Required	Notes
name	Name of the stock	string	no
isin	ISIN (International Securities Identification Number) of the stock	string	no
wkn	WKN (Wertpapierkennnummer) of the stock	string	no
currency	The currency in which the stock was purchased	string	no
quantity	Number of shares of the stock held	float	no
amount	Amount (in currency from "currency") of the stock held	float	no	Can be calculated by quantity multiplied by price
amountOriginalCurrency	Equals "amount" unless it was bought in a different currency than stated in "currency"	float	no
price	Price of the stock held	float	no
purchasePrice	Price the stock shares were purchased for	float	no