ledger

Core Resources / Ledger

Overview

Ledger Resources manage the accounts, entries and postings related to contributions, reimbursements, adjustments and reversals.

The Account Resources can be of many different types. All accounts have a calculated balance derived from their debit or credit postings. The Xformative system of accounts is as follows.

Payment Sources have an Ingress Account for funding from payment sources, a Pending Ingress Account for pending funding from payment sources, an Egress Account for disbursements to payment sources and a Pending Egress Account for pending disbursements to payment sources.
Bureaus have an Available Balance Account that is available for authorized disbursements and funding, a Commitment Account to track outstanding Available Balance liability, a Store Credit Account with Available Balance funds that are being stored with a restriction from spend, a Cash Account for disbursement payments, an Interest Account for interest credits to participants and Fee Account to accept fees from participants, client programs and payees.
Programs have an Available Balance Account for funds that are available for authorized spending, a Commitment Account to track outstanding Available Balance liability, a Store Credit Account for funds that are being stored with a restriction from spending, a Cash Account for disbursement payments, Fee Accounts to accept fees from participants.
Program Offerings have an Available Balance Account available for authorized spending and a Commitment Account to track outstanding Available Balance liability.
When a participant enrolls in a program Participant's Program has a Cash Feature Available Balance Account used to make reimbursements and an Advance Feature Available Balance Account used to advance funds in the case of a purchase that exceeds the available balance.
When a participant enrolls in a program's offering, the Participant's Offering has an Available Balance Account for authorized payments and/or card transactions and a Commitment Account to track outstanding Available Balance liability.

Contribution events flow funds from commitment accounts to available balance accounts. Commitment Events are used to fund available balances with a commitment liability. A debit in a commitment account results in a credit on an available balance account. This accounting technique allows the system to credit an available balance account with a libility that has not yet cleared or settled. Eventually, based on the use case, the liabilities accrued in the commitment account will be funded via Funding Events that pay down the liability. .
‍

Reimbursement events flow funds from an individual's available balance to an individual's unrestricted cash account or to a payee available balance.
‍

Adjustment events flow funds in different ways depending on the actors involved. In the case of an individual's balance adjustment the funds are flowed from the bureau's commitment account to the individuals unrestricted cash account.
‍

Reversal events reverse an existing ledger event.
‍

Concepts

Account

Record in the ledger used to group postings.

Adjustments

Debit or credit posting to an account to adjust a balance.

Available Balance Account

Funded account available for disbursals.

Contributions

The funding of an available balance via a commitment account.

Commitment Account

Track obligations which require settlement.

Egress Account

Tracks outbound payments.

Entry

Collection of postings.

Fee Account

Tracks accrued fees.

Ingress Account

Tracks inbound payments.

Operational Account

Tracks finalization etc.

Posting

Debit or credit for a specific account.

Reimbursements

The transfer of funds to a payee.

Reversals

Reversing an entry.

Interest Account

Tracks accrued interest.

Contribution Events

new-contribution

Triggers a new contribution event to be processed. The process flows funds from a commitment account to an available balance account

Reimbursement Events

Reimbursement events flow funds from an individual's available balance to an individual's unrestricted cash account or to a payee available balance.

new-reimburse

Triggers a new reimburse event to be processed. The process does not utilize program configuration rules and flows funds from a specific participant offering available balance to the target available balance account.

new-reimbursement-request

Triggers a new participant reimbursement request event to be processed. The process utilizes the program configuration rules which will dictate account authorization and multi-purse depletion order. Once approved flows funds from one to many participant offering available balance(s) to the participants unrestricted cash feature available balance.

Adjustment Events

new-adjustment

Triggers a new adjustment event to be processed. The process flows funds between two accounts to adjust the balance of an available balance account or a adjust a payment allocation to the incorrect offering account.

Reversal Events

Reversal events reverse an existing ledger event.

new-reversal

Triggers a new reversal event to be processed. The process reverses a ledger event.

Fee Events

Fee events are

new-bureau-fee-sweep

Triggers a new bureau fee sweep event to be processed. The process flows funds from the bureau fee account to the bureau cash account.

new-program-fee

Triggers a new program fee event to be processed. The process flows funds from the program available balance to the bureau fee account.

new-participant-fee

Triggers a new participant offering fee event to be processed. The process flows funds from the program available balance to the bureau fee account.

new-payee-fee

Triggers a new reversal event to be processed. The process reverses a ledger event.

Transfer Events

Transfer events flow funds between two accounts of the same type.

new-transfer

Triggers a new transfer event to be processed. The process flows funds between two accounts of the same type. e.g. Commitment to Commitment or Available Balance to Available Balance

Fee Events

Interest events are utilized to credit interest entries . offerings where a participant's available balance is moved to the client's program's available balance when an offering end date is reached.

new-fee

Triggers a new fee event to be processed. The process moves moves funds from the an available balance account to the bureau fee account.

new-fee-sweep

Triggers a new bureau fee sweep event to be processed. The process moves moves funds from the bureau fee account to the bureau cash account.

Interest Events

Interest events are utilized to credit interest entries . offerings where a participant's available balance is moved to the client's program's available balance when an offering end date is reached.

new-interest

Triggers a new interest event to be processed. The process moves funds between the bureau interest account and an available balance account.

new-interest-sweep

Triggers a new interest sweep event to be processed. The process moves funds from the the bureau interest account to bureau cash account.