Enhanced funds use events and use event groupings

An enhanced funds use event (also just called a funds use event) represents an event that debits or credits some or all of the balance of an unapplied fund slice. Common funds use events include credit allocations toward invoice items, disbursements, write-offs, or funds transfers.

In the user interface, funds use events are visible in the Slice History tab on Enhanced Funds Tracking screens.

In Cloud API, funds use events are accessible from the following endpoints:

GET /billing/v1/t-accounts/{tAccountId}/unapplied-fund-slices/{unappliedFundSliceId}/enhanced-funds-use-events
GET /billing/v1/t-accounts/{tAccountId}/unapplied-fund-slices/{unappliedFundSliceId}/enhanced-funds-use-events/{enhancedFundsUseEventId}

Enhanced funds use events objects contain information about the funds that were used and how they were used. This includes the fields:

amount: The amount that was credited or debited in the funds use event.
context: A description of the transaction for the funds use event, as a reference to the FundsUseEventContext typelist. For example, Agency Bill Credit Distributed.
eventGrouping: The group of funds use events that the specific funds use event belongs to. See the section below for more.

For example, suppose that an account has an undistributed direct bill money received for $30. A billing administrator makes a distribution in which three dollars each are allocated to three invoice items. There is one unapplied funds slice for the original direct bill money received, and there are four enhanced funds use events: one for $30 for the original direct bill money received, and three for each distribution item. Querying for this information looks like this:

Command

GET /billing/v1/t-accounts/bc:STS5y7vxcxAPzNYy1RjBL/unapplied-fund-slices/bc:SR9kcISlfkJMjgs0AuQA6/enhanced-funds-use-events

Response

{
    "count": 4,
    "data": [
        {
            "attributes": {
                "amount": {
                    "amount": "30.00",
                    "currency": "usd"
                },
                "context": {
                    "code": "AccountPaymentCreated",
                    "name": "Account Payment Created"
                },
                "currency": {
                    "code": "usd",
                    "name": "USD"
                },
                "eventDate": "2026-07-02",
                "eventGrouping": {
                    "displayName": "EnhancedFundsUseEventGrouping bc:SALl4YUpmGcU4z8q7trjG",
                    "id": "bc:SALl4YUpmGcU4z8q7trjG",
                    "type": "EnhancedFundsUseEventGrouping",
                    "uri": "/billing/v1/enhanced-funds-use-event-groupings/bc:SALl4YUpmGcU4z8q7trjG"
                },
                "id": "bc:SQGSNvy3QKyKuYI3OsU0i",
                "transaction": {
                    "displayName": "Direct Bill Money Received",
                    "id": "bc:SFn9G7nuFZqMB6Lt7-CL9",
                    "type": "Transaction",
                    "uri": "/billing/v1/transactions/bc:SFn9G7nuFZqMB6Lt7-CL9"
                }
            },
            "checksum": "0",
            "links": {
                "self": {
                    "href": "/billing/v1/t-accounts/bc:STS5y7vxcxAPzNYy1RjBL/unapplied-fund-slices/bc:SR9kcISlfkJMjgs0AuQA6/enhanced-funds-use-events/bc:SQGSNvy3QKyKuYI3OsU0i",
                    "methods": [
                        "get"
                    ]
                }
            }
        },
        {
            "attributes": {
                "amount": {
                    "amount": "-3.00",
                    "currency": "usd"
                },
                "context": {
                    "code": "AccountPaymentDistributed",
                    "name": "Account Payment Distributed"
                },
                "currency": {
                    "code": "usd",
                    "name": "USD"
                },
                "eventDate": "2026-07-03",
                "eventGrouping": {
                    "displayName": "EnhancedFundsUseEventGrouping bc:S4Nsal-vvLwOiOG-DtUwv",
                    "id": "bc:S4Nsal-vvLwOiOG-DtUwv",
                    "type": "EnhancedFundsUseEventGrouping",
                    "uri": "/billing/v1/enhanced-funds-use-event-groupings/bc:S4Nsal-vvLwOiOG-DtUwv"
                },
                "id": "bc:Sk5oDADLeqn3BLC-eBZTK",
                "transaction": {
                    "displayName": "Premium Paid From Account",
                    "id": "bc:SBrriXw_WcUZRHghRdEyT",
                    "type": "Transaction",
                    "uri": "/billing/v1/transactions/bc:SBrriXw_WcUZRHghRdEyT"
                }
            },
            "checksum": "0",
            "links": {
                "self": {
                    "href": "/billing/v1/t-accounts/bc:STS5y7vxcxAPzNYy1RjBL/unapplied-fund-slices/bc:SR9kcISlfkJMjgs0AuQA6/enhanced-funds-use-events/bc:Sk5oDADLeqn3BLC-eBZTK",
                    "methods": [
                        "get"
                    ]
                }
            }
        },
        {
            "attributes": {
                "amount": {
                    "amount": "-3.00",
                    "currency": "usd"
                },
                "context": {
                    "code": "AccountPaymentDistributed",
                    "name": "Account Payment Distributed"
                },
                "currency": {
                    "code": "usd",
                    "name": "USD"
                },
                "eventDate": "2026-07-03",
                "eventGrouping": {
                    "displayName": "EnhancedFundsUseEventGrouping bc:S4Nsal-vvLwOiOG-DtUwv",
                    "id": "bc:S4Nsal-vvLwOiOG-DtUwv",
                    "type": "EnhancedFundsUseEventGrouping",
                    "uri": "/billing/v1/enhanced-funds-use-event-groupings/bc:S4Nsal-vvLwOiOG-DtUwv"
                },
                "id": "bc:Sz_d41UbDuMGiqjqPr5bF",
                "transaction": {
                    "displayName": "Premium Paid From Account",
                    "id": "bc:SiBN3RRcVhjTMlkmh-Zez",
                    "type": "Transaction",
                    "uri": "/billing/v1/transactions/bc:SiBN3RRcVhjTMlkmh-Zez"
                }
            },
            "checksum": "0",
            "links": {
                "self": {
                    "href": "/billing/v1/t-accounts/bc:STS5y7vxcxAPzNYy1RjBL/unapplied-fund-slices/bc:SR9kcISlfkJMjgs0AuQA6/enhanced-funds-use-events/bc:Sz_d41UbDuMGiqjqPr5bF",
                    "methods": [
                        "get"
                    ]
                }
            }
        },
        {
            "attributes": {
                "amount": {
                    "amount": "-3.00",
                    "currency": "usd"
                },
                "context": {
                    "code": "AccountPaymentDistributed",
                    "name": "Account Payment Distributed"
                },
                "currency": {
                    "code": "usd",
                    "name": "USD"
                },
                "eventDate": "2026-07-03",
                "eventGrouping": {
                    "displayName": "EnhancedFundsUseEventGrouping bc:S4Nsal-vvLwOiOG-DtUwv",
                    "id": "bc:S4Nsal-vvLwOiOG-DtUwv",
                    "type": "EnhancedFundsUseEventGrouping",
                    "uri": "/billing/v1/enhanced-funds-use-event-groupings/bc:S4Nsal-vvLwOiOG-DtUwv"
                },
                "id": "bc:Sp3r5t7TUcFSwdF0-RCOf",
                "transaction": {
                    "displayName": "Premium Paid From Account",
                    "id": "bc:S3maKL2j8yTA7O5rQknxK",
                    "type": "Transaction",
                    "uri": "/billing/v1/transactions/bc:S3maKL2j8yTA7O5rQknxK"
                }
            },
            "checksum": "0",
            "links": {
                "self": {
                    "href": "/billing/v1/t-accounts/bc:STS5y7vxcxAPzNYy1RjBL/unapplied-fund-slices/bc:SR9kcISlfkJMjgs0AuQA6/enhanced-funds-use-events/bc:Sp3r5t7TUcFSwdF0-RCOf",
                    "methods": [
                        "get"
                    ]
                }
            }
        }
    ],
    "links": {
        "first": {
            "href": "/billing/v1/t-accounts/bc:STS5y7vxcxAPzNYy1RjBL/unapplied-fund-slices/bc:SR9kcISlfkJMjgs0AuQA6/enhanced-funds-use-events",
            "methods": [
                "get"
            ]
        },
        "self": {
            "href": "/billing/v1/t-accounts/bc:STS5y7vxcxAPzNYy1RjBL/unapplied-fund-slices/bc:SR9kcISlfkJMjgs0AuQA6/enhanced-funds-use-events",
            "methods": [
                "get"
            ]
        }
    }
}

Funds use event groupings

In some cases, there may be large amounts of funds use events associated with an unapplied fund slice. BillingCenter Cloud API provides groupings for funds use events based on the transactions that affect the amount in the unapplied fund. For example, when an amount in the unapplied fund slice is distributed to invoice items, the funds use events for each distribution item are grouped together.

Use the following endpoint to get funds use event groupings:

GET /billing/v1/enhanced-funds-use-event-groupings/{enhancedFundsUseEventGroupingId}

To get the Id of a funds use event grouping, query for the funds use event, and retrieve the Id or the URI from the eventGrouping field on the funds use event.

The enhanced funds use event grouping object is a thin object containing the following fields:

context: A description of the transaction of the grouping, as a reference to the FundsUseEventContext typelist. For example, Agency Bill Credit Distributed.
currency: The currency used in the transaction, as a reference to the Currency typelist.
fundsSource: A reference to the funds source used in the transaction that the grouping is based on.

Consider the previous example, in which there was a $30 direct bill money received and a separate distribution transaction in which there were three funds use events. Both the direct bill money received transaction and the distribution transaction have a single funds use event grouping. Retrieving the funds use event grouping for the distribution looks like this:

Command

GET /billing/v1/enhanced-funds-use-event-groupings/bc:S4Nsal-vvLwOiOG-DtUwv

Response

{
    "data": {
        "attributes": {
            "context": {
                "code": "AccountPaymentDistributed",
                "name": "Account Payment Distributed"
            },
            "currency": {
                "code": "usd",
                "name": "USD"
            },
            "fundsSource": {
                "displayName": "Funds Source of $30.00 of type Direct Bill Money Received",
                "id": "bc:S9bFalJtJXN70k7OgdL48",
                "type": "EnhancedFundsSource",
                "uri": "/billing/v1/enhanced-funds-sources/bc:S9bFalJtJXN70k7OgdL48"
            },
            "id": "bc:S4Nsal-vvLwOiOG-DtUwv"
        },
        "checksum": "0",
        "links": {
            "enhanced-funds-use-events": {
                "href": "/billing/v1/enhanced-funds-use-event-groupings/bc:S4Nsal-vvLwOiOG-DtUwv/enhanced-funds-use-events",
                "methods": [
                    "get"
                ]
            },
            "self": {
                "href": "/billing/v1/enhanced-funds-use-event-groupings/bc:S4Nsal-vvLwOiOG-DtUwv",
                "methods": [
                    "get"
                ]
            }
        }
    }
}

Retrieve funds use events in a grouping

You can also retrieve all funds use events in a grouping using the following endpoint:

GET /billing/v1/enhanced-funds-use-event-groupings/{enhancedFundsUseEventGroupingId}/enhanced-funds-use-events