Querying for direct bill payments

Use the following endpoints to query for an account’s direct bill payments:

  • GET /billing/v1/accounts/{accountId}/db-money-rcvds
  • GET /billing/v1/accounts/{accountId}/db-money-rcvds/{dbMoneyRcvdId}

For example, the following request queries for all the direct bill payments for account bc:101:

Command
GET /billing/v1/accounts/bc:101/db-money-rcvds
Response payload
{
    "count": 1,
    "data": [
        {
            "attributes": {
                "amount": {
                    "amount": "170.00",
                    "currency": "usd"
                },
                "appliedDate": "2024-05-23T04:55:09.027Z",
                "currency": {
                    "code": "usd",
                    "name": "USD"
                },
                "id": "bc:Se-lTmKjyIRI3SBGUSBwF",
                "paymentInstrument": {
                    "displayName": "Check",
                    "id": "bc:SDJXvckskdMnaBgYg6t_2"
                },
                "receivedDate": "2024-05-23T04:54:18.266Z",
                "subtype": "DirectBillMoneyRcvd",
                "unappliedFund": {
                    "displayName": "Default",
                    "id": "bc:SJaGjJxYFIkpsRTbMHrXm"
                }
            },
            ...

Additional filter options

Some GET endpoints that return collections have filter options that may not appear in the API definition for one reason or another. This documentation refers to them as additional filter options.

The GET /billing/v1/accounts/{accountId}/db-money-rcvds endpoint has the following additional filter options:

  • invoiceId
  • moneyBeingModifiedId
  • paymentInstrumentId
  • policyPeriodId