Vendors
Get vendor bills available for payment
List bills available for payment from a vendor.
Returns bills with status APPROVED_TO_PAY and open balance.
get/vendors/{id}/bills-for-payment
Path parameters
idstring required
Resource ID (UUID) or client key
Query parameters
by'id' | 'key'
Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.
Response
Bills for payment retrieved
Example response
{
"bills": [
{
"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"
}
}
],
"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"
}
}