Sha256: 13725907c613c56bfbc4adaf651ff480e5bfc5b1cba8d5de2402460873f950fa

Contents?: true

Size: 1.63 KB

Versions: 5

Compression:

Stored size: 1.63 KB

Contents

# MoneyKit::AccountBalances

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **currency** | **String** | A three-character currency code (ISO-4217 or similar, *e.g.*, `USD`, `CAD`) for the account balances. | [optional] |
| **available** | **Float** | The amount of funds available for use.  Not all institutions report the available balance.             <p>Note that the available balance typically does not include overdraft limits. | [optional] |
| **current** | **Float** | The total amount of funds in the account.             <p>For credit or loan accounts, a positive number indicates the amount owed by the account holder.             If the balance is negative (this is rare), this indicates an amount owed **to** the account holder.             <p>For depository or investment accounts, a positive number is the asset value of the account.             If the balance is negative (this is rare), this indicates an overdraft or margin condition. | [optional] |
| **limit** | **Float** | The credit limit on the account.  Typically this exists only for credit-type accounts.             <p>In some cases, this may represent the overdraft limit for depository accounts. | [optional] |
| **balance_date** | **Time** | The date that the balance was captured at.  This may not include a time. When this field is null, the balance was captured at an unknown time. | [optional] |

## Example

```ruby
require 'moneykit'

instance = MoneyKit::AccountBalances.new(
  currency: USD,
  available: 340.12,
  current: 445.89,
  limit: 500,
  balance_date: 2021-08-12T15:23:00Z
)
```

Version data entries

5 entries across 5 versions & 1 rubygems

Version Path
moneykit-0.1.15 docs/AccountBalances.md
moneykit-0.1.14 docs/AccountBalances.md
moneykit-0.1.13 docs/AccountBalances.md
moneykit-0.1.12 docs/AccountBalances.md
moneykit-0.1.11 docs/AccountBalances.md