curl --request POST \
--url https://api.upwell.com/api/rest/customer_payments/search \
--header 'Content-Type: application/json' \
--data '
{
"limit": 10,
"offset": 0,
"orderBy": {},
"where": {}
}
'{
"customerPayments": [
{
"checkDate": "2023-12-25",
"checkOrAchNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"currency": "AED",
"id": "<string>",
"paymentLineItems": [
{
"createdAt": "2023-11-07T05:31:56Z",
"customerId": "<string>",
"id": "<string>",
"invoiceId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"status": "<string>",
"totalAmount": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"totalAmount": 123,
"transactionDate": "2023-12-25",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}Search for customer payments based on specified criteria
curl --request POST \
--url https://api.upwell.com/api/rest/customer_payments/search \
--header 'Content-Type: application/json' \
--data '
{
"limit": 10,
"offset": 0,
"orderBy": {},
"where": {}
}
'{
"customerPayments": [
{
"checkDate": "2023-12-25",
"checkOrAchNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"currency": "AED",
"id": "<string>",
"paymentLineItems": [
{
"createdAt": "2023-11-07T05:31:56Z",
"customerId": "<string>",
"id": "<string>",
"invoiceId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"status": "<string>",
"totalAmount": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"totalAmount": 123,
"transactionDate": "2023-12-25",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY
Query parameters can also be provided in the request body as a JSON object
Boolean expression to filter rows from the table "payments". All fields are combined with a logical 'AND'.
Show child attributes
PaymentsBoolExp (simplified)
DateComparisonExp (simplified)
StringComparisonExp (simplified)
TimestamptzComparisonExp (simplified)
CurrencyCodeEnumComparisonExp (simplified)
StringComparisonExp (simplified)
PaymentLineItemsBoolExp (simplified)
PaymentLineItemsAggregateBoolExp (simplified)
StringComparisonExp (simplified)
StringComparisonExp (simplified)
JsonbComparisonExp (simplified)
StringComparisonExp (simplified)
IntComparisonExp (simplified)
DateComparisonExp (simplified)
TimestamptzComparisonExp (simplified)
Responses for POST /api/rest/customer_payments/search
Show child attributes
A date string, such as 2024-02-03 (YYYY-MM-DD)
A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
AED, AUD, BRL, CAD, CHF, CNY, EGP, EUR, GBP, HKD, IDR, INR, JPY, KRW, MXN, MYR, NZD, QAR, SAR, SGD, THB, TRY, TWD, USD, VND, ZAR Show child attributes
A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
A date string, such as 2024-02-03 (YYYY-MM-DD)
A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00