Create a bill payment

Record a payment for one or more carrier/vendor bills.

What happens

PaymentGroup record is created
Payment applications are created for each bill
Bill open balances are reduced
Load/service status updates to PAID when fully paid

Carrier factor payments

To pay a carrier's factor instead of the carrier directly, specify carrierFactorId in the request.

Overpayments

If allowOverpayment is true and payment exceeds bill totals, a credit memo is automatically created for the difference.

Request body

paymentDatestring date required

Date of payment

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

carrierFactorIdstring uuid

Carrier factor to pay (for factored payments)

referencestring

Check number, transaction ID, etc.

notesstring

Additional notes

allowOverpaymentboolean

Allow payment amount to exceed bill totals

Response

Bill payment created 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"
  }
}

v1