# Get carrier bills available for payment

List bills available for payment from a carrier.

Returns bills with status APPROVED_TO_PAY and open balance.

## Carrier factor

If the carrier has a factor configured, factor details are included.

Endpoint: GET /carriers/{id}/bills-for-payment
Version: 1.0.0
Security: BearerAuth

## Path parameters:

  - `id` (string, required)
    Resource ID (UUID) or client key
    Example: "550e8400-e29b-41d4-a716-446655440000"

## Query parameters:

  - `by` (string)
    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.
    Enum: "id", "key"

## Response 200 fields (application/json):

  - `bills` (array, required)

  - `bills.id` (string)

  - `bills.friendlyId` (string)

  - `bills.entityType` (string)
    Type of entity the bill is for.
- CARRIER: Bill for a carrier (LoadCarrier)
- VENDOR: Bill for a vendor service (VendedService)
    Enum: "CARRIER", "VENDOR"

  - `bills.carrier` (object)
    Enhanced reference to a carrier resource (returned in responses).
Includes full carrier details in addition to id/key.

Note: Does NOT include nested references (contacts, etc.) to prevent recursion.
Maximum nesting depth: 1 level.

  - `bills.carrier.id` (string, required)
    Carrier UUID
    Example: "550e8400-e29b-41d4-a716-446655440000"

  - `bills.carrier.key` (string,null)
    Client-defined reference ID if set
    Example: "ERP-CARRIER-SWIFT"

  - `bills.carrier.name` (string, required)
    Carrier company name
    Example: "Swift Transportation"

  - `bills.carrier.phoneNumber` (string,null)
    Primary phone number
    Example: "+1-555-987-6543"

  - `bills.carrier.email` (string,null)
    Primary email address
    Example: "dispatch@swifttrans.com"

  - `bills.carrier.createdAt` (string, required)
    When the carrier was created
    Example: "2025-01-15T10:00:00Z"

  - `bills.carrier.updatedAt` (string, required)
    When the carrier was last updated
    Example: "2025-01-15T14:30:00Z"

  - `bills.carrier.deletedAt` (string,null)
    When the carrier was soft deleted (null if active)

  - `bills.vendor` (object)
    Enhanced reference to a vendor profile.
Includes full vendor details in addition to id/key.

  - `bills.vendor.id` (string, required)
    Vendor UUID
    Example: "550e8400-e29b-41d4-a716-446655440000"

  - `bills.vendor.friendlyId` (string, required)
    Human-readable vendor identifier
    Example: "V123456"

  - `bills.vendor.name` (string, required)
    Vendor legal name
    Example: "ABC Warehouse Services"

  - `bills.vendor.phone` (string,null)
    Primary phone number
    Example: "+1-555-123-4567"

  - `bills.vendor.status` (string,null)
    Vendor status
    Example: "ACTIVE"

  - `bills.vendor.currency` (string,null)
    Preferred currency code (ISO 4217)
    Example: "USD"

  - `bills.vendor.createdAt` (string, required)
    When the vendor was created
    Example: "2025-01-15T10:00:00Z"

  - `bills.vendor.updatedAt` (string, required)
    When the vendor was last updated
    Example: "2025-01-15T14:30:00Z"

  - `bills.invoiceDate` (string,null)

  - `bills.dueDate` (string,null)

  - `bills.amount` (number)

  - `bills.amountPaid` (number)

  - `bills.openBalance` (number)

  - `bills.isOverdue` (boolean)

  - `bills.shipmentId` (string,null)

  - `bills.shipmentFriendlyId` (string,null)

  - `totalOutstanding` (number, required)
    Total outstanding balance

  - `carrierFactor` (object)

  - `carrierFactor.companyName` (string)

  - `carrierFactor.bankName` (string,null)

## Response 401 fields (application/json):

  - `error` (string, required)
    Error code

  - `message` (string, required)
    Human-readable error message

## Response 404 fields (application/json):

  - `error` (string, required)
    Error code

  - `message` (string, required)
    Human-readable error message