Fields: Fund Balances
See the associated Accounting Funds resource section for more information on how to use this resource and supported operations.
Additional references
| Type | Value | Additional information |
|---|---|---|
| Permissions resource | accounting/funds/balances | Permissions |
| Hooks filename | accounting.funds.balances.groovy | Pre- and Post-Processing Hooks |
| Tenant-supported | No | Tenants |
| Distinct query-supported | No | Distinct |
API version 3
Represents a report of fund balance.
| Field Name | Type | Description |
|---|---|---|
| id | Long |
The unique fund identifier |
| allocated | BigDecimal |
The total adjusted allocations. This value is affected positively by deposits, activations and destination transfers and affected negatively by withdrawals, deactivations and source transfers that have occurred since the last reset. |
| allocations | Set<Allocation> |
Allocations associated with this fund |
| amount | BigDecimal |
The sum of active allocation amounts within this fund. It does not take into fund current liens. |
| available | BigDecimal |
The total amount available for charging. |
| balance | BigDecimal |
The allocation total not blocked by liens. |
| capacity | BigDecimal |
The total amount allocated via deposits and credit limits. |
| creationTime | Date |
Date this fund was created |
| creditLimit | BigDecimal |
The sum of active credit limits within this fund |
| description | String |
The fund description |
| fundConstraints | Set<FundConstraint> |
Constraints on fund usage. |
| modificationTime | Date |
The date this fund was last modified |
| name | String |
The name of this fund |
| percentRemaining | Double |
The percentage of allocation remaining. |
| percentUsed | Double | |
| reserved | BigDecimal |
The sum of active lien amounts against this fund |
| used | BigDecimal |
The total amount used this allocation cycle. |
An allocation is a time-bounded pool of resource or service credits associated with an fund. An fund may have multiple allocations, each for use during a different time period.
An allocation has a start time and an end time that defines the time period during which the allocation may be used. By default an allocation is created with an unbounded time period (-infinity to infinity). An active flag is automatically updated to true if the fund is within its valid timeframe or false if it is not. An allocation may also have a credit limit representing the amount by which it can go negative. Thus, by having a positive balance in the Amount field, the fund is like a debit fund, implementing a pay-first use-later model. By establishing a credit limit instead of depositing an initial balance, the fund will be like a credit fund, implementing a use-first pay-later model. These strategies can be combined by depositing some amount of funds coupled with a credit limit, implementing a form of overdraft protection where the funds will be used down to the negative of the credit limit.
Constraints designate which entities (such as Users, Accounts, Machines, Classes, Organizations, etc.) may access the encapsulated credits in a fund or for which aspects of usage the funds are intended (QualityOfService, GeographicalArea, etc.).
API version 2
Represents a report of fund balance.
| Field Name | Type | Description |
|---|---|---|
| id | Long |
The unique fund identifier |
| allocated | BigDecimal |
The total adjusted allocations. This value is affected positively by deposits, activations and destination transfers and affected negatively by withdrawals, deactivations and source transfers that have occurred since the last reset. |
| allocations | Set<Allocation> |
Allocations associated with this fund |
| amount | BigDecimal |
The sum of active allocation amounts within this fund. It does not take into fund current liens. |
| available | BigDecimal |
The total amount available for charging. |
| balance | BigDecimal |
The allocation total not blocked by liens. |
| capacity | BigDecimal |
The total amount allocated via deposits and credit limits. |
| creationTime | Date |
Date this fund was created |
| creditLimit | BigDecimal |
The sum of active credit limits within this fund |
| description | String |
The fund description |
| fundConstraints | Set<FundConstraint> |
Constraints on fund usage. |
| modificationTime | Date |
The date this fund was last modified |
| name | String |
The name of this fund |
| percentRemaining | Double |
The percentage of allocation remaining. |
| percentUsed | Double | |
| reserved | BigDecimal |
The sum of active lien amounts against this fund |
| used | BigDecimal |
The total amount used this allocation cycle. |
An allocation is a time-bounded pool of resource or service credits associated with an fund. An fund may have multiple allocations, each for use during a different time period.
An allocation has a start time and an end time that defines the time period during which the allocation may be used. By default an allocation is created with an unbounded time period (-infinity to infinity). An active flag is automatically updated to true if the fund is within its valid timeframe or false if it is not. An allocation may also have a credit limit representing the amount by which it can go negative. Thus, by having a positive balance in the Amount field, the fund is like a debit fund, implementing a pay-first use-later model. By establishing a credit limit instead of depositing an initial balance, the fund will be like a credit fund, implementing a use-first pay-later model. These strategies can be combined by depositing some amount of funds coupled with a credit limit, implementing a form of overdraft protection where the funds will be used down to the negative of the credit limit.
Constraints designate which entities (such as Users, Accounts, Machines, Classes, Organizations, etc.) may access the encapsulated credits in a fund or for which aspects of usage the funds are intended (QualityOfService, GeographicalArea, etc.).
Related Topics