Sign in
Invoices

Mark invoice as awaiting payment

Mark invoice as awaiting payment.

What happens

  • Sets invoice date and due date
  • Updates order status to DELIVERED_UNPAID
  • Invoice is now ready for payment collection
post/invoices/{id}/mark-awaiting

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.

Request body

invoiceDatestring date

Invoice date (defaults to today)

dueDatestring date

Due date (defaults based on payment term)

Response

Invoice marked as awaiting payment

idstring uuid required
friendlyIdstring required

Human-readable invoice ID

keystring nullable

Client-defined key

orderIdstring uuid

Associated order ID

orderKeystring nullable

Order friendly ID

shipmentIdstring uuid

Associated shipment ID

shipmentKeystring nullable

Shipment friendly ID

status'DRAFT' | 'AWAITING_PAYMENT' | 'PARTIALLY_PAID' | 'PAID' | 'VOIDED' required

Current status of the invoice.

  • DRAFT: Invoice record exists but not finalized
  • AWAITING_PAYMENT: Invoice finalized, awaiting payment
  • PARTIALLY_PAID: Some payments received, balance remains
  • PAID: Fully paid
  • VOIDED: Invoice cancelled/voided
invoiceDatestring date required

Date invoice was issued

dueDatestring date nullable

Payment due date

amountnumber required

Total invoice amount

currencystring nullable

Currency code (USD, CAD)

referencestring nullable

External reference number

amountPaidnumber

Total payments received

amountOwednumber

Outstanding balance

creditsAppliednumber nullable

Total credits applied

factorName'ARTISPAY' | 'DENIM' | 'HAUL_PAY' | 'TRIUMPH'

Factoring provider for invoice financing.

  • DENIM: Denim factoring
  • HAULPAY: HaulPay factoring
factorJobIdstring nullable

External factoring job ID

factorStatusstring nullable

Current factoring status

qboIdstring nullable

QuickBooks Online invoice ID

documentIdstring uuid nullable

Generated invoice PDF document ID

documentUrlstring nullable

Download URL for invoice PDF

createdAtstring date-time required
updatedAtstring date-time nullable

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "friendlyId": "INV-00001",
  "customer": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-CUSTOMER-ACME",
    "name": "Acme Manufacturing Corp",
    "friendlyId": "A123456",
    "status": "ACTIVE",
    "phoneNumber": "+1-555-123-4567",
    "website": "https://acme-manufacturing.com",
    "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"
  }
}

Changes

Changed in 1 of the 4 revisions of this API.113

  • ce0e9003047c113See the full diff
    • ●

      added the new ARTISPAY enum value to the factorName response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new BLOCKED enum value to the customer/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new CLOSED enum value to the customer/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new CONTACTED enum value to the customer/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new HAUL_PAY enum value to the factorName response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new NEW enum value to the customer/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new NURTURING enum value to the customer/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new PENDING enum value to the customer/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new QUALIFIED enum value to the customer/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new QUOTED enum value to the customer/status response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new TRIUMPH enum value to the factorName response property for the response status 200

      response-property-enum-value-added

    • ○

      removed the CHURNED enum value from the customer/status response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the HAULPAY enum value from the factorName response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the PROSPECT enum value from the customer/status response property for the response status 200

      response-property-enum-value-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog