v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Vendors

Get vendor outstanding bills

List outstanding (unpaid) bills for a vendor.

Returns bills with status APPROVED_TO_PAY.

get/vendors/{id}/outstanding-bills

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

Outstanding bills retrieved

totalOutstandingnumber required

Total outstanding balance

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"
      }
    }
  ]
}