Querying for agency bill payments

Retrieve 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}

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"
        },
        ...
    }
}