Querying for distribution information

After a direct bill payment has been distributed, you can retrieve information about the distribution through Cloud API. You can get information about the entire distribution and about the individual amounts that were distributed to invoice items.

Querying for distributions

Use these endpoints to get distributions:

  • GET /accounts/{accountId}/db-money-rcvds/{dbMoneyRcvdId}/direct-bill-payments
  • GET /accounts/{accountId}/db-money-rcvds/{dbMoneyRcvdId}/direct-bill-payments/{directBillPaymentId}

Regardless of which endpoint you use, there will always be one distribution. Distributions contain information such as the date the distribution occurred, the amount distributed, and the amount in suspense.

The direct bill payment has information about the entire distribution, like this:

Command

GET /billing/v1/accounts/bc:271/db-money-rcvds/bc:2209/direct-bill-payments

Response

{
    "count": 1,
    "data": [
        {
            "attributes": {
                "currency": {
                    "code": "usd",
                    "name": "USD"
                },
                "distributedDate": "2026-04-18T19:12:32.676Z",
                "frozenByArchiving": false,
                "id": "bc:14932",
                "netDistributedToInvoiceItems": {
                    "amount": "50.00",
                    "currency": "usd"
                },
                "netInSuspense": {
                    "amount": "0.00",
                    "currency": "usd"
                }
            },
            ...
        }
    ],
    ...
}

Querying for distribution items

Distributions contain information about the entire amount distributed, but not about the individual funds distributed to individual invoice items. To get this information, query for the distribution items.

  • GET /accounts/{accountId}/db-money-rcvds/{dbMoneyRcvdId}/direct-bill-payments/{directBillPaymentId}/direct-bill-payment-items
  • GET /accounts/{accountId}/db-money-rcvds/{dbMoneyRcvdId}/direct-bill-payments/{directBillPaymentId}/direct-bill-payment-items/{directBillPaymentItemId}

The following request retrieves the distribution items for distribution bc:14932.

Command

GET /billing/v1/accounts/bc:271/db-money-rcvds/bc:2209/direct-bill-payments/bc:14932/direct-bill-payment-items

Response

{
    "count": 2,
    "data": [
        {
            "attributes": {
                "currency": {
                    "code": "usd",
                    "name": "USD"
                },
                "executedDate": "2026-04-18",
                "grossAmountToApply": {
                    "amount": "23.00",
                    "currency": "usd"
                },
                "id": "bc:SoHd7AYhTMySa3KIk8jFX",
                "invoiceItem": {
                    "displayName": "02/18/2026 ($120.00)",
                    "id": "bc:SLuaAVuZPn8YuD9QPAcTm",
                    "type": "InvoiceItem",
                    "uri": "/billing/v1/charges/bc:SeV2Dbeg0o0Gh4QT-yn2k/invoice-items/bc:SLuaAVuZPn8YuD9QPAcTm"
                }
            },
            ...
        },
        {
            "attributes": {
                "currency": {
                    "code": "usd",
                    "name": "USD"
                },
                "executedDate": "2026-04-18",
                "grossAmountToApply": {
                    "amount": "27.00",
                    "currency": "usd"
                },
                "id": "bc:SPqK3hCPkAjY7t2T3mjSs",
                "invoiceItem": {
                    "displayName": "04/15/2026 ($98.19)",
                    "id": "bc:SNdyfbvocGsbFGhFoaftN",
                    "type": "InvoiceItem",
                    "uri": "/billing/v1/charges/bc:SeV2Dbeg0o0Gh4QT-yn2k/invoice-items/bc:SNdyfbvocGsbFGhFoaftN"
                }
            },
            ...
        }
    ],
    ...
}