# Get a bill payment

Retrieve a bill payment by ID.

The response includes all payment applications and their associated bills.

Endpoint: GET /bill-payments/{id}
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):

  - `id` (string, required)
    Example: "550e8400-e29b-41d4-a716-446655440000"

  - `key` (string,null)
    Client-defined key

  - `recipientType` (string, required)
    Type of recipient for the payment.
- CARRIER: Payment to a carrier
- VENDOR: Payment to a vendor
    Enum: "CARRIER", "VENDOR"

  - `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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  - `carrierFactor` (object)

  - `carrierFactor.companyName` (string)

  - `carrierFactor.bankName` (string,null)

  - `paymentDate` (string, required)
    Date the payment was made

  - `paymentMethodType` (string)
    Payment method used for the bill payment.
- ACH_WIRE: ACH wire transfer
- CHECK: Paper check
- CREDIT_CARD: Credit card payment
- EFT_DIRECT_DEPOSIT: EFT direct deposit
- E_TRANSFER: Electronic transfer
- VENMO: Venmo payment
    Enum: "ACH_WIRE", "CHECK", "CREDIT_CARD", "EFT_DIRECT_DEPOSIT", "E_TRANSFER", "VENMO"

  - `reference` (string,null)
    Check number, transaction ID, etc.

  - `notes` (string,null)
    Additional notes

  - `totalAmount` (number, required)
    Total payment amount (sum of all applications)

  - `overpayment` (number,null)
    Amount paid in excess of invoice totals

  - `overpaymentCreditMemoId` (string,null)
    Credit memo created for overpayment

  - `applications` (array, required)
    Individual bill payments in this group

  - `applications.billId` (string, required)
    Bill (invoice) this payment applies to

  - `applications.billFriendlyId` (string,null)
    Human-readable bill ID

  - `applications.amount` (number, required)
    Amount applied to this bill

  - `applications.loadCarrierId` (string,null)
    Associated load carrier (for carrier bills)

  - `applications.vendedServiceId` (string,null)
    Associated vended service (for vendor bills)

  - `applications.shipmentId` (string,null)

  - `applications.shipmentFriendlyId` (string,null)

  - `qboId` (string,null)
    QuickBooks Online bill payment ID

  - `syncStatus` (string,null)
    QuickBooks sync status
    Enum: "pending", "synced", "error"

  - `syncError` (string,null)
    QuickBooks sync error message

  - `createdAt` (string, required)

  - `updatedAt` (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