# AccountProperties

Type: object

Schema: [AccountProperties](https://sourcey-firefly.pages.dev/api/models/accountproperties/index.md)

- `created_at` (optional)
  Type: string, date-time
  
  readOnly: true
  
  Example:
  
  ```json
  "2026-10-01T00:00:00+00:00"
  ```

- `updated_at` (optional)
  Type: string, date-time
  
  readOnly: true
  
  Example:
  
  ```json
  "2026-10-01T00:00:00+00:00"
  ```

- `active` (optional)
  Type: boolean
  
  default: true
  
  Example:
  
  ```json
  false
  ```

- `order` (optional)
  Type: integer, int32; nullable
  
  Order of the account. Is NULL if account is not asset or liability.
  
  Example:
  
  ```json
  1
  ```

- `name` (required)
  Type: string, string
  
  Example:
  
  ```json
  "My checking account"
  ```

- `type` (required)
  Reference: [ShortAccountTypeProperty](https://sourcey-firefly.pages.dev/api/models/shortaccounttypeproperty/index.md); Type: string, string
  
  Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually.
  
  enum: ["asset","expense","import","revenue","cash","liability","liabilities","initial-balance","reconciliation"]
  
  Example:
  
  ```json
  "asset"
  ```

- `account_role` (optional)
  Reference: [AccountRoleProperty](https://sourcey-firefly.pages.dev/api/models/accountroleproperty/index.md); Type: string, string; nullable
  
  Is only mandatory when the type is asset.
  
  enum: ["defaultAsset","sharedAsset","savingAsset","ccAsset","cashWalletAsset",null]
  
  Example:
  
  ```json
  "defaultAsset"
  ```

- `object_group_id` (optional)
  Type: string, string; nullable
  
  The group ID of the group this object is part of. NULL if no group.
  
  Example:
  
  ```json
  "5"
  ```

- `object_group_order` (optional)
  Type: integer, int32; nullable
  
  The order of the group. At least 1, for the highest sorting.
  
  readOnly: true
  
  Example:
  
  ```json
  5
  ```

- `object_group_title` (optional)
  Type: string, string; nullable
  
  The name of the group. NULL if no group.
  
  Example:
  
  ```json
  "Example Group"
  ```

- `object_has_currency_setting` (optional)
  Type: boolean
  
  Indicates whether the account has a currency setting. If false, the account uses the administration's primary currency. Asset accounts and liability accounts always have a currency setting, while expense and revenue accounts do not.
  
  readOnly: true
  
  Example:
  
  ```json
  true
  ```

- `currency_id` (optional)
  Type: string, string
  
  The currency ID of the currency associated with this object.
  
  Example:
  
  ```json
  "5"
  ```

- `currency_name` (optional)
  Type: string, string
  
  The currency name of the currency associated with this object.
  
  Example:
  
  ```json
  "Euro"
  ```

- `currency_code` (optional)
  Type: string, string
  
  The currency code of the currency associated with this object.
  
  Example:
  
  ```json
  "EUR"
  ```

- `currency_symbol` (optional)
  Type: string, string
  
  readOnly: true
  
  Example:
  
  ```json
  "$"
  ```

- `currency_decimal_places` (optional)
  Type: integer, int32
  
  readOnly: true
  
  Example:
  
  ```json
  2
  ```

- `primary_currency_id` (optional)
  Type: string, string
  
  The currency ID of the administration's primary currency.
  
  readOnly: true
  
  Example:
  
  ```json
  "5"
  ```

- `primary_currency_name` (optional)
  Type: string, string
  
  The currency name of the administration's primary currency.
  
  readOnly: true
  
  Example:
  
  ```json
  "Euro"
  ```

- `primary_currency_code` (optional)
  Type: string, string
  
  The currency code of the administration's primary currency.
  
  readOnly: true
  
  Example:
  
  ```json
  "EUR"
  ```

- `primary_currency_symbol` (optional)
  Type: string, string
  
  The currency symbol of the administration's primary currency.
  
  readOnly: true
  
  Example:
  
  ```json
  "$"
  ```

- `primary_currency_decimal_places` (optional)
  Type: integer, int32
  
  The currency decimal places of the administration's primary currency.
  
  readOnly: true
  
  Example:
  
  ```json
  2
  ```

- `current_balance` (optional)
  Type: string, amount
  
  The current balance of the account in the account's currency. If the account has no currency, this is the balance in the administration's primary currency. Either way, the `currency_*` fields reflect the currency used.
  
  readOnly: true
  
  Example:
  
  ```json
  "123.45"
  ```

- `pc_current_balance` (optional)
  Type: string, amount; nullable
  
  The current balance of the account in the administration's primary currency. The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings.
  
  readOnly: true
  
  Example:
  
  ```json
  "123.45"
  ```

- `balance_difference` (optional)
  Type: string, amount
  
  If you submit a start AND end date, this will be the difference between those two moments.
  
  readOnly: true
  
  Example:
  
  ```json
  "123.45"
  ```

- `pc_balance_difference` (optional)
  Type: string, amount; nullable
  
  If you submit a start AND end date, this will be the difference in the currency of the account or the administration's primary currency between those two moments.
  
  readOnly: true
  
  Example:
  
  ```json
  "123.45"
  ```

- `opening_balance` (optional)
  Type: string, amount
  
  Represents the opening balance, the initial amount this account holds in the currency of the account or the administration's primary currency if the account has no currency. Either way, the `currency_*` fields reflect the currency used.
  
  Example:
  
  ```json
  "-1012.12"
  ```

- `pc_opening_balance` (optional)
  Type: string, amount
  
  The opening balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings.
  
  Example:
  
  ```json
  "-1012.12"
  ```

- `virtual_balance` (optional)
  Type: string, amount
  
  The virtual balance of the account in the account's currency or the administration's primary currency if the account has no currency.
  
  Example:
  
  ```json
  "123.45"
  ```

- `pc_virtual_balance` (optional)
  Type: string, amount
  
  The virtual balance of the account in the administration's primary currency (pc). The `primary_currency_*` fields reflect the currency used. This field is NULL if the user does have 'convert to primary' set to true in their settings.
  
  Example:
  
  ```json
  "123.45"
  ```

- `debt_amount` (optional)
  Type: string, amount; nullable
  
  In liability accounts (loans, debts and mortgages), this is the amount of debt in the account's currency (see the `currency_*` fields). In asset accounts, this is NULL.
  
  Example:
  
  ```json
  "1012.12"
  ```

- `pc_debt_amount` (optional)
  Type: string, amount; nullable
  
  In liability accounts (loans, debts and mortgages), this is the amount of debt in the administration's primary currency (see the `currency_*` fields. In asset accounts, this is NULL.
  
  Example:
  
  ```json
  "1012.12"
  ```

- `current_balance_date` (optional)
  Type: string, date-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.
  
  readOnly: true
  
  Example:
  
  ```json
  "2026-10-31T23:59:59+00:00"
  ```

- `notes` (optional)
  Type: string, string; nullable
  
  Example:
  
  ```json
  "Some example notes"
  ```

- `monthly_payment_date` (optional)
  Type: string, date-time; nullable
  
  Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank.
  
  Example:
  
  ```json
  "2026-10-01T00:00:00+00:00"
  ```

- `credit_card_type` (optional)
  Reference: [CreditCardTypeProperty](https://sourcey-firefly.pages.dev/api/models/creditcardtypeproperty/index.md); Type: string, string; nullable
  
  Mandatory when the account_role is ccAsset. Can only be monthlyFull or null.
  
  enum: ["monthlyFull",null]
  
  Example:
  
  ```json
  "monthlyFull"
  ```

- `account_number` (optional)
  Type: string, string; nullable
  
  Example:
  
  ```json
  "7009312345678"
  ```

- `iban` (optional)
  Type: string, iban; nullable
  
  Example:
  
  ```json
  "GB98MIDL07009312345678"
  ```

- `bic` (optional)
  Type: string, string; nullable
  
  Example:
  
  ```json
  "BOFAUS3N"
  ```

- `opening_balance_date` (optional)
  Type: string, date-time; nullable
  
  Represents the date of the opening balance.
  
  Example:
  
  ```json
  "2026-10-01T00:00:00+00:00"
  ```

- `liability_type` (optional)
  Reference: [LiabilityTypeProperty](https://sourcey-firefly.pages.dev/api/models/liabilitytypeproperty/index.md); Type: string, string; nullable
  
  Mandatory when type is liability. Specifies the exact type.
  
  enum: ["loan","debt","mortgage",null]
  
  Example:
  
  ```json
  "loan"
  ```

- `liability_direction` (optional)
  Reference: [LiabilityDirectionProperty](https://sourcey-firefly.pages.dev/api/models/liabilitydirectionproperty/index.md); Type: string, string; nullable
  
  'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabilities.
  
  enum: ["credit","debit",null]
  
  Example:
  
  ```json
  "credit"
  ```

- `interest` (optional)
  Type: string, string; nullable
  
  Mandatory when type is liability. Interest percentage.
  
  Example:
  
  ```json
  "5.3"
  ```

- `interest_period` (optional)
  Reference: [InterestPeriodProperty](https://sourcey-firefly.pages.dev/api/models/interestperiodproperty/index.md); Type: string, string; nullable
  
  Mandatory when type is liability. Period over which the interest is calculated.
  
  enum: ["daily","weekly","monthly","quarterly","half-year","yearly",null]
  
  Example:
  
  ```json
  "monthly"
  ```

- `include_net_worth` (optional)
  Type: boolean
  
  default: true
  
  Example:
  
  ```json
  true
  ```

- `longitude` (optional)
  Type: number, double; nullable
  
  Latitude of the accounts's location, if applicable. Can be used to draw a map.
  
  Example:
  
  ```json
  5.916667
  ```

- `latitude` (optional)
  Type: number, double; nullable
  
  Latitude of the accounts's location, if applicable. Can be used to draw a map.
  
  Example:
  
  ```json
  51.983333
  ```

- `zoom_level` (optional)
  Type: integer, int32; nullable
  
  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.
  
  Example:
  
  ```json
  6
  ```

- `last_activity` (optional)
  Type: string, date-time; nullable
  
  Last activity of the account.
  
  Example:
  
  ```json
  "2026-10-01T00:00:00+00:00"
  ```