Invoices
Filter invoices
Search for AR invoices using filter criteria.
Common Filters
- By customer: { "filter": { "customerId": { "equalTo": "uuid" } } }
- Unpaid: { "filter": { "status": { "in": ["AWAITING_PAYMENT", "PARTIALLY_PAID"] } } }
- Overdue: { "filter": { "overdue": true } }
- By shipment: { "filter": { "shipmentId": { "equalTo": "uuid" } } }
post/invoices/filter
Request body
Response
Invoices matching filter criteria
Example response
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"friendlyId": "INV-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",
"paymentTerm": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-PAYTERM-NET30",
"name": "Net 30",
"description": "Payment due 30 days from invoice date",
"days": 30,
"quickPayFee": 0.05,
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
}
}
],
"pagination": {
"pageSize": 50,
"hasNextPage": true,
"endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
}
}