Bills
Filter bills
Search for AP bills using filter criteria.
Common Filters
- By carrier: { "filter": { "carrierId": { "equalTo": "uuid" } } }
- By vendor: { "filter": { "vendorId": { "equalTo": "uuid" } } }
- Awaiting approval: { "filter": { "status": { "equalTo": "IN_REVIEW" } } }
- By shipment: { "filter": { "shipmentId": { "equalTo": "uuid" } } }
- Overdue: { "filter": { "overdue": true } }
post/bills/filter
Request body
Response
Bills matching filter criteria
Example response
{
"data": [
{
"id": "550e8400-e29b-41d4-a716-446655440000",
"friendlyId": "BILL-00001",
"carrier": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-CARRIER-SWIFT",
"name": "Swift Transportation",
"phoneNumber": "+1-555-987-6543",
"email": "dispatch@swifttrans.com",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
},
"vendor": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-VENDOR-ABC-001",
"friendlyId": "V123456",
"name": "ABC Warehouse Services",
"email": "billing@abcwarehouse.com",
"phone": "+1-555-123-4567",
"status": "ACTIVE",
"currency": "USD",
"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"
},
"carrierFactor": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"key": "ERP-FACTOR-001",
"companyName": "Capital Factoring Services Inc",
"email": "accounting@capitalfactoring.com",
"phoneNumber": "+1-555-234-5678",
"currency": "USD",
"createdAt": "2025-01-15T10:00:00Z",
"updatedAt": "2025-01-15T14:30:00Z"
}
}
],
"pagination": {
"pageSize": 50,
"hasNextPage": true,
"endCursor": "eyJpZCI6IjU1MGU4NDAwLWUyOWItNDFkNC1hNzE2LTQ0NjY1NTQ0MDAwMCJ9"
}
}