go-firefly3/docs/Account.md

Account

Properties

Name	Type	Description	Notes
CreatedAt	time.Time		[optional] [default to null]
UpdatedAt	time.Time		[optional] [default to null]
Active	bool	If omitted, defaults to true.	[optional] [default to true]
Order	int32	Order of the account. Is NULL if account is not asset or liability.	[optional] [default to null]
Name	string		[default to null]
Type_	*ShortAccountTypeProperty		[default to null]
AccountRole	*AccountRoleProperty		[optional] [default to null]
CurrencyId	string	Use either currency_id or currency_code. Defaults to the user's default currency.	[optional] [default to null]
CurrencyCode	string	Use either currency_id or currency_code. Defaults to the user's default currency.	[optional] [default to null]
CurrencySymbol	string		[optional] [default to null]
CurrencyDecimalPlaces	int32		[optional] [default to null]
CurrentBalance	string		[optional] [default to null]
CurrentBalanceDate	time.Time	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] [default to null]
Iban	string		[optional] [default to null]
Bic	string		[optional] [default to null]
AccountNumber	string		[optional] [default to null]
OpeningBalance	string	Represents the opening balance, the initial amount this account holds.	[optional] [default to null]
CurrentDebt	string	Represents the current debt for liabilities.	[optional] [default to null]
OpeningBalanceDate	time.Time	Represents the date of the opening balance.	[optional] [default to null]
VirtualBalance	string		[optional] [default to null]
IncludeNetWorth	bool	If omitted, defaults to true.	[optional] [default to true]
CreditCardType	*CreditCardTypeProperty		[optional] [default to null]
MonthlyPaymentDate	time.Time	Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank.	[optional] [default to null]
LiabilityType	*LiabilityTypeProperty		[optional] [default to null]
LiabilityDirection	*LiabilityDirectionProperty		[optional] [default to null]
Interest	string	Mandatory when type is liability. Interest percentage.	[optional] [default to null]
InterestPeriod	*InterestPeriodProperty		[optional] [default to null]
Notes	string		[optional] [default to null]
Latitude	float64	Latitude of the accounts's location, if applicable. Can be used to draw a map.	[optional] [default to null]
Longitude	float64	Latitude of the accounts's location, if applicable. Can be used to draw a map.	[optional] [default to null]
ZoomLevel	int32	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] [default to null]

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