Payments
Filter payments
Search for AR payments using filter criteria.
Common Filters
- By customer: { "filter": { "customerId": { "equalTo": "uuid" } } }
- By invoice: { "filter": { "invoiceId": { "equalTo": "uuid" } } }
- By date range: { "filter": { "paymentDate": { "greaterThanOrEqualTo": "2025-01-01" } } }
- By method: { "filter": { "paymentMethodType": { "equalTo": "check" } } }
post/payments/filter
Request body
Response
Payments matching filter criteria
Example response
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "PMT-00001",
"customer": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-CUSTOMER-ACME",
"name": "Acme Manufacturing Corp",
"friendlyId": "A123456",
"status": "ACTIVE",
"phoneNumber": "+1-555-123-4567",
"website": "https://acme-manufacturing.com",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"currency": "USD"
}
],
"pagination": {
"pageSize": 50,
"hasNextPage": true,
"endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
}
}