banks2ff/firefly-iii-api/docs/Account.md
Jacob Kiers f0b8df90b9 Initial commit
This is definitely not functional yet.

Signed-off-by: Jacob Kiers <code@kiers.eu>
2024-10-04 20:31:39 +02:00

3.3 KiB

Account

Properties

Name Type Description Notes
created_at Option<String> [optional][readonly]
updated_at Option<String> [optional][readonly]
active Option<bool> If omitted, defaults to true. [optional][default to true]
order Option<i32> Order of the account. Is NULL if account is not asset or liability. [optional]
name String
r#type models::ShortAccountTypeProperty
account_role Option<models::AccountRoleProperty> [optional]
currency_id Option<String> Use either currency_id or currency_code. Defaults to the user's default currency. [optional]
currency_code Option<String> Use either currency_id or currency_code. Defaults to the user's default currency. [optional]
currency_symbol Option<String> [optional][readonly]
currency_decimal_places Option<i32> [optional][readonly]
current_balance Option<String> [optional][readonly]
current_balance_date Option<String> The timestamp for this date is always 23:59:59, to indicate it's the balance at the very END of that particular day. [optional][readonly]
iban Option<String> [optional]
bic Option<String> [optional]
account_number Option<String> [optional]
opening_balance Option<String> Represents the opening balance, the initial amount this account holds. [optional]
current_debt Option<String> Represents the current debt for liabilities. [optional]
opening_balance_date Option<String> Represents the date of the opening balance. [optional]
virtual_balance Option<String> [optional]
include_net_worth Option<bool> If omitted, defaults to true. [optional][default to true]
credit_card_type Option<models::CreditCardTypeProperty> [optional]
monthly_payment_date Option<String> Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank. [optional]
liability_type Option<models::LiabilityTypeProperty> [optional]
liability_direction Option<models::LiabilityDirectionProperty> [optional]
interest Option<String> Mandatory when type is liability. Interest percentage. [optional]
interest_period Option<models::InterestPeriodProperty> [optional]
notes Option<String> [optional]
latitude Option<f64> Latitude of the accounts's location, if applicable. Can be used to draw a map. [optional]
longitude Option<f64> Latitude of the accounts's location, if applicable. Can be used to draw a map. [optional]
zoom_level Option<i32> 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. [optional]

[Back to Model list] [Back to API list] [Back to README]