Skip to main content
POST
/
api
/
rest
/
customer_payment_line_items
/
search
Search Customer Payment Line Items
curl --request POST \
  --url https://api.upwell.com/api/rest/customer_payment_line_items/search \
  --header 'Content-Type: application/json' \
  --data '
{
  "limit": 10,
  "offset": 0,
  "orderBy": {},
  "where": {}
}
'
{
  "customerPaymentLineItems": [
    {
      "checkDate": "2023-12-25",
      "checkOrAchNumber": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "currency": "AED",
      "customerId": "<string>",
      "exchangeRate": "<string>",
      "fees": 123,
      "id": "<string>",
      "invoiceId": "<string>",
      "notes": "<string>",
      "paymentId": "<string>",
      "sourceSystemId": "<string>",
      "sourceSystemMeta": "<unknown>",
      "status": "<string>",
      "totalAmount": 123,
      "totalAmountWithFees": 123,
      "transactionDate": "2023-12-25",
      "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

​
limit
integer
default:10
​
offset
integer
default:0

Body

application/json

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

​
limit
integer | null
default:10
​
offset
integer | null
default:0
​
orderBy
object[] | null
​
where
PaymentLineItemsBoolExp · object

Boolean expression to filter rows from the table "payment_line_items". All fields are combined with a logical 'AND'.

Response

200 - application/json

Responses for POST /api/rest/customer_payment_line_items/search

​
customerPaymentLineItems
PaymentLineItems · object[]