v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB

Bill Payments

Get a bill payment

Retrieve a bill payment by ID.

The response includes all payment applications and their associated bills.

get/bill-payments/{id}

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

Bill payment retrieved successfully

idstring uuid required

keystring nullable

Client-defined key

recipientType'CARRIER' | 'VENDOR' required

Type of recipient for the payment.

CARRIER: Payment to a carrier
VENDOR: Payment to a vendor

paymentDatestring date required

Date the payment was made

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

referencestring nullable

Check number, transaction ID, etc.

notesstring nullable

Additional notes

totalAmountnumber required

Total payment amount (sum of all applications)

overpaymentnumber nullable

Amount paid in excess of invoice totals

overpaymentCreditMemoIdstring uuid nullable

Credit memo created for overpayment

qboIdstring nullable

QuickBooks Online bill payment ID

syncStatus'pending' | 'synced' | 'error' nullable

QuickBooks sync status

syncErrorstring nullable

QuickBooks sync error message

createdAtstring date-time required

updatedAtstring date-time nullable

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "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"
  }
}