Skip to main content
POST
/
api
/
rest
/
bill-payments
/
search
Search bill payments
curl --request POST \
  --url https://api.upwell.com/api/rest/bill-payments/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceSystem": "<string>",
  "sourceSystemId": "<string>"
}
'
{
  "billPayments": [
    {
      "amount": 123,
      "billPaymentLineItems": [
        {
          "amount": 123,
          "billId": "<string>",
          "billingAccountNumber": "<string>",
          "billingName": "<string>",
          "carrierId": "<string>",
          "checkOrAchNumber": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "id": "<string>",
          "notes": "<string>",
          "referenceNumber": 123,
          "sourceSystem": "<string>",
          "sourceSystemId": "<string>",
          "status": "<string>",
          "transactionDate": "<string>",
          "updatedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "carrierId": "<string>",
      "checkOrAchNumber": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "sourceSystem": "<string>",
      "sourceSystemId": "<string>",
      "status": "<string>",
      "transactionDate": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Headers

authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Query Parameters

sourceSystem
string

"sourceSystem" is required (enter it either in parameters or request body)

sourceSystemId
string

"sourceSystemId" is required (enter it either in parameters or request body)

Body

application/json

Query parameters can also be provided in the request body as a JSON object

sourceSystem
string
sourceSystemId
string

Response

200 - application/json

Responses for POST /api/rest/bill-payments/search

billPayments
BillPayments Ā· object[]