Query for agency bill payments

You can query for a producer’s agency bill payments using the following endpoints:
  • GET /billing/v1/producers/{producerId}/ab-money-rcvds
  • GET /billing/v1/producers/{producerId}/ab-money-rcvds/{agencyBillMoneyRcvdId}

These endpoints retrieve agency bill payments regardless of what state they are in. Returned payments may be saved, executed, reversed, or modified.

The following request retrieves a single agency bill payment of $340 USD.

Command

GET /billing/v1/producers/bc:423/ab-money-rcvds/bc:435

Response

{
    "data": {
        "attributes": {
            "amount": {
                "amount": "340.00",
                "currency": "usd"
            },
            "appliedDate": "2024-10-27T15:57:52.333Z",
            "currency": {
                "code": "usd",
                "name": "USD"
            },
            "id": "bc:SlPUf1dPanQLwWqk0iIY9",
            "modified": false,
            "paymentInstrument": {
                "displayName": "Check",
                "id": "bc:Sad-gdQzXPb79g-_vKMph",
                "type": "UniversalPaymentInstrument",
                "uri": "/billing/v1/universal-payment-instruments/bc:Sad-gdQzXPb79g-_vKMph"
            },
            "receivedDate": "2024-10-27T15:54:44.282Z",
            "subtype": "AgencyBillMoneyRcvd"
        },
        ...
    }
}

Retrieving modified agency bill payments

When an agency bill payment is modified, BillingCenter creates an entirely new payment entity while preserving the original payment entity in the database. Therefore, the Cloud API may return more payments than what appears in the user interface.

Cloud API returns both payments that were created as a result of modification and the original payments before they were modified. To only display current payments and omit payments that have been changed, use the ?filter=modified:eq:false query parameter in the GET request.

The original pre-modification payments are preserved for record keeping. For more, see Modify agency bill payments and distributions.