# AccountStore

Type: object

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

- `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"
  ```

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

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

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

- `opening_balance` (optional)
  Type: string, amount
  
  Represents the opening balance, the initial amount this account holds.
  
  Example:
  
  ```json
  "-1012.12"
  ```

- `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"
  ```

- `virtual_balance` (optional)
  Type: string, amount
  
  Example:
  
  ```json
  "123.45"
  ```

- `currency_id` (optional)
  Type: string, string
  
  Use either currency_id or currency_code. Defaults to the user's financial administration's currency.
  
  Example:
  
  ```json
  "12"
  ```

- `currency_code` (optional)
  Type: string, string
  
  Use either currency_id or currency_code. Defaults to the user's financial administration's currency.
  
  Example:
  
  ```json
  "EUR"
  ```

- `active` (optional)
  Type: boolean
  
  If omitted, defaults to true.
  
  default: true
  
  Example:
  
  ```json
  false
  ```

- `order` (optional)
  Type: integer, int32
  
  Order of the account
  
  Example:
  
  ```json
  1
  ```

- `include_net_worth` (optional)
  Type: boolean
  
  If omitted, defaults to true.
  
  default: true
  
  Example:
  
  ```json
  true
  ```

- `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"
  ```

- `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"
  ```

- `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"
  ```

- `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.
  
  default: "0"
  
  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"
  ```

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

- `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
  ```

- `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
  ```

- `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
  ```