v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB

Bills

Record a bill

Record a carrier or vendor bill (invoice).

What happens

Bill record is created for the load carrier or vended service
Entity status updates to IN_REVIEW
Due date calculated from payment term if not provided

Prerequisites

LoadCarrier or VendedService must exist
Entity must be in AWAITING_INVOICE status

post/bills

Request body

entityType'CARRIER' | 'VENDOR' required

Type of entity the bill is for.

CARRIER: Bill for a carrier (LoadCarrier)
VENDOR: Bill for a vendor service (VendedService)

entityIdstring uuid required

LoadCarrier ID or VendedService ID

invoiceDatestring date required

Invoice date from carrier/vendor

dueDatestring date

Payment due date

amountnumber required

Invoice amount

referencestring

Carrier/vendor invoice reference number

currencystring

Currency code (defaults to carrier/vendor currency)

paymentTermIdstring uuid

Payment term

Response

Bill created successfully

idstring uuid required

friendlyIdstring required

Human-readable bill ID

keystring nullable

Client-defined key

entityType'CARRIER' | 'VENDOR' required

Type of entity the bill is for.

CARRIER: Bill for a carrier (LoadCarrier)
VENDOR: Bill for a vendor service (VendedService)

loadCarrierIdstring uuid nullable

Associated load carrier ID (if carrier bill)

vendedServiceIdstring uuid nullable

Associated vended service ID (if vendor bill)

loadIdstring uuid nullable

loadKeystring nullable

shipmentIdstring uuid nullable

shipmentKeystring nullable

status'AWAITING_INVOICE' | 'IN_REVIEW' | 'APPROVED_TO_PAY' | 'PAID' required

Current status of the bill (AP invoice).

AWAITING_INVOICE: Waiting for carrier/vendor to submit invoice
IN_REVIEW: Invoice received, under review
APPROVED_TO_PAY: Approved and ready for payment
PAID: Fully paid

invoiceDatestring date nullable

Date of carrier/vendor invoice

dueDatestring date nullable

Payment due date

amountnumber required

Bill amount

currencystring nullable

Currency code

referencestring nullable

Carrier/vendor invoice reference number

amountPaidnumber

Total payments received

amountOwednumber

Outstanding balance

factorJobIdstring nullable

External factoring job ID

factorStatusstring nullable

Current factoring status

qboIdstring nullable

QuickBooks Online bill ID

createdAtstring date-time required

updatedAtstring date-time nullable

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "friendlyId": "BILL-00001",
  "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"
  },
  "currency": "USD",
  "paymentTerm": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-PAYTERM-NET30",
    "name": "Net 30",
    "description": "Payment due 30 days from invoice date",
    "days": 30,
    "quickPayFee": 0.05,
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z"
  },
  "carrierFactor": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-FACTOR-001",
    "companyName": "Capital Factoring Services Inc",
    "email": "accounting@capitalfactoring.com",
    "phoneNumber": "+1-555-234-5678",
    "currency": "USD",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z"
  }
}