> ## Documentation Index
> Fetch the complete documentation index at: https://docs.upwell.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Vocabulary

> Every enum value the API can produce — statuses, address types, document types, stop types — generated from the live spec so it cannot drift.

# Vocabulary

The core integration enums — statuses, exceptions, approvals, address types, stop types,
payment statuses, and document types. **Values are generated from the live API schema**, so
for every enum on this page the value list is complete and cannot drift, including values
whose meaning isn't documented yet (marked **\[GAP — definition pending]**). Field-level enums not listed here (e.g.
country and currency codes) are documented on their endpoints in the API reference.

## Carrier invoice statuses

The `status` field on carrier invoices (AP). Lifecycle guidance: [Knowing when a carrier invoice is processed](/api-guides/carrier-invoice-status).

| Value                       | Meaning                                                                                                   |
| --------------------------- | --------------------------------------------------------------------------------------------------------- |
| `APPROVED`                  | Approved — cleared to pay (review lifecycle).                                                             |
| `AWAITING_BILL`             | **\[GAP — definition pending]**                                                                           |
| `AWAITING_CARRIER_RESPONSE` | Waiting on the carrier.                                                                                   |
| `AWAITING_INVOICE`          | Created ahead of the invoice document; auto-promotes to `RECEIVED` when that document arrives and parses. |
| `CANCELLED`                 | **\[GAP — definition pending]**                                                                           |
| `CARRIER_EXCEPTION`         | A carrier-side issue needs resolving.                                                                     |
| `CARRIER_RESPONDED`         | The carrier has responded.                                                                                |
| `DISPUTED`                  | Disputed.                                                                                                 |
| `EXCEPTION`                 | An audit exception needs resolving.                                                                       |
| `PAID`                      | Fully paid.                                                                                               |
| `PART_PAID`                 | Partially paid.                                                                                           |
| `PROCESSING`                | In-flight processing.                                                                                     |
| `RECEIVED`                  | Submitted / in review. Ingestion (matching + audit) usually runs while status stays here.                 |
| `REFUNDED`                  | **\[GAP — definition pending]**                                                                           |
| `REJECTED`                  | Rejected.                                                                                                 |
| `UNDER_REVIEW`              | In manual review.                                                                                         |

<Note>Values marked **\[GAP — definition pending]** exist in the API but have no documented semantics yet.</Note>

## Customer invoice statuses

The `status` field on customer invoices (AR). Lifecycle guidance: [Managing customer invoices](/api-guides/customer-invoices).

| Value              | Meaning                                                    |
| ------------------ | ---------------------------------------------------------- |
| `APPROVED`         | Invoice has been approved for sending.                     |
| `CANCELLED`        | Invoice was cancelled.                                     |
| `CREATED`          | Invoice record exists but hasn't been finalized.           |
| `DELIVERED`        | Invoice delivery has been confirmed.                       |
| `DISPUTED`         | Customer has raised a dispute.                             |
| `DRAFT`            | **\[GAP — definition pending]**                            |
| `OPEN`             | Invoice is finalized and ready for delivery.               |
| `OVERDUE`          | Past due date with an outstanding balance.                 |
| `PAID`             | Fully paid — balance is `0`.                               |
| `PART_PAID`        | Partially paid — balance is between `0` and `totalAmount`. |
| `PORTAL_EXCEPTION` | The invoice hit an exception during portal delivery.       |
| `PORTAL_RESOLVED`  | A portal exception has been resolved.                      |
| `PROCESSING`       | Invoice is being processed for delivery.                   |
| `REFUNDED`         | A refund was issued.                                       |
| `REJECTED`         | Invoice was rejected.                                      |
| `SEND_ERROR`       | Invoice delivery failed.                                   |
| `SENT`             | Invoice has been delivered to the customer.                |
| `VIEWED`           | Customer has viewed the invoice (online portal).           |
| `WRITE_OFF`        | Written off as uncollectable.                              |

<Note>Values marked **\[GAP — definition pending]** exist in the API but have no documented semantics yet.</Note>

## Exception statuses

The lifecycle of an [exception](/concepts/exceptions). `OPEN` and `IN_PROGRESS` are the two "still needs attention" states that hold an invoice back.

| Value           | Meaning                                                             |
| --------------- | ------------------------------------------------------------------- |
| `CLOSED`        | Closed; no further action needed.                                   |
| `IN_PROGRESS`   | Someone is actively working it.                                     |
| `OPEN`          | Raised but not yet addressed — needs attention.                     |
| `RESOLVED`      | Worked and resolved.                                                |
| `RULE_DISABLED` | Suppressed because the audit rule that generated it was turned off. |

## Approval request statuses

The `status` on [carrier-invoice approval requests](/api-guides/carrier-invoice-approval). Your integration resolves a request by PATCHing `SUCCEEDED` or `FAILED`.

| Value         | Meaning                                                      |
| ------------- | ------------------------------------------------------------ |
| `ABANDONED`   | **\[GAP — definition pending]**                              |
| `FAILED`      | Resolved rejected.                                           |
| `INITIATED`   | **\[GAP — definition pending]**                              |
| `IN_PROGRESS` | **\[GAP — definition pending]**                              |
| `RETRYING`    | **\[GAP — definition pending]**                              |
| `SUCCEEDED`   | Resolved approved — moves the carrier invoice to `APPROVED`. |

<Note>Values marked **\[GAP — definition pending]** exist in the API but have no documented semantics yet.</Note>

## Address types

`type` is required on every address and several product surfaces query it exactly — see [Working with addresses](/conventions/addresses) for which types are load-bearing.

| Value                  | Meaning                                                                                                                                          |
| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ADDRESS_BOOK`         | **Inert — nothing reads it.** Not a safe generic default; always use the specific role type.                                                     |
| `CARRIER`              | A carrier's primary address (descriptive).                                                                                                       |
| `CARRIER_BILLING`      | Where a carrier wants payment sent (descriptive; remit-to logic is driven by factoring documents).                                               |
| `COMPANY_ADDRESS`      | **Load-bearing.** The only type the company pages render.                                                                                        |
| `CONTACT`              | An address on a contact record (descriptive).                                                                                                    |
| `CUSTOMER_BILLING`     | **Load-bearing.** A customer's billing address — the invoice bill-to block and delivery routing read this exact value. At most one per customer. |
| `DELIVERY_RECEIPT`     | Written by Upwell's document-parsing pipelines — read-only for integrations.                                                                     |
| `LUMPER_RECEIPT`       | Written by Upwell's document-parsing pipelines — read-only for integrations.                                                                     |
| `SHIPMENT_CONSIGNEE`   | A shipment's destination slot.                                                                                                                   |
| `SHIPMENT_PICKUP`      | A shipment's origin slot.                                                                                                                        |
| `STOP`                 | An address used by a route stop (descriptive).                                                                                                   |
| `SUPPORTING_DOC_PARTY` | Written by Upwell's document-parsing pipelines — you'll see it on reads; don't create it.                                                        |

## Stop types

The constrained vocabulary for a stop’s `type` field. Note the trap documented in [Syncing foundation entities](/api-guides/syncing-foundation-entities): the free-text `stopType` field is what’s actually read today — populate it, drawing values from this enum.

| Value             | Meaning                         |
| ----------------- | ------------------------------- |
| `CONSOLIDATION`   | **\[GAP — definition pending]** |
| `CROSS_DOCK`      | **\[GAP — definition pending]** |
| `CUSTOMS`         | **\[GAP — definition pending]** |
| `DECONSOLIDATION` | **\[GAP — definition pending]** |
| `DELIVERY`        | **\[GAP — definition pending]** |
| `DROP_OFF`        | **\[GAP — definition pending]** |
| `FUEL_STOP`       | **\[GAP — definition pending]** |
| `LAYOVER`         | **\[GAP — definition pending]** |
| `ORIGIN`          | **\[GAP — definition pending]** |
| `OTHER`           | **\[GAP — definition pending]** |
| `PICKUP`          | **\[GAP — definition pending]** |
| `RETURN`          | **\[GAP — definition pending]** |
| `STORAGE`         | **\[GAP — definition pending]** |
| `TERMINAL`        | **\[GAP — definition pending]** |
| `TRANSFER`        | **\[GAP — definition pending]** |

## Payment statuses

The `status` values on payment records. Per-value semantics are not yet documented — if one blocks you, ask [support@upwell.com](mailto:support@upwell.com).

| Value              | Meaning                         |
| ------------------ | ------------------------------- |
| `DISPUTED`         | **\[GAP — definition pending]** |
| `FAILED`           | **\[GAP — definition pending]** |
| `PAYMENT_REVERSED` | **\[GAP — definition pending]** |
| `PENDING`          | **\[GAP — definition pending]** |
| `REFUNDED`         | **\[GAP — definition pending]** |
| `SUCCEEDED`        | **\[GAP — definition pending]** |

## Document types

The canonical `documentType` codes (send the code, not a display label — `PROOF_OF_DELIVERY`, not "POD"). The full generated list follows the table; the table covers the types integrations set most, per the guides.

| Type                         | Meaning                                                                                                                                                                                                    |
| ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `BILL_OF_LADING`             | Bill of lading.                                                                                                                                                                                            |
| `CARRIER_INVOICE`            | The carrier's invoice document — parsing it populates blank header fields and line items on the carrier invoice.                                                                                           |
| `CARRIER_RATE_CONFIRMATION`  | The rate you agreed to **pay the carrier** — carrier cost; used by the carrier-invoice audit. Never type a customer rate con as this (or vice versa) — see [Document conventions](/conventions/documents). |
| `CUSTOMER_INVOICE`           | The customer-invoice PDF (AR).                                                                                                                                                                             |
| `CUSTOMER_RATE_CONFIRMATION` | The rate your **customer agreed to pay you** — revenue; used to validate customer invoices.                                                                                                                |
| `LUMPER_RECEIPT`             | A lumper service receipt.                                                                                                                                                                                  |
| `NOTICE_OF_ASSIGNMENT`       | A factoring notice — parsing it populates a carrier invoice's remit-to / factor.                                                                                                                           |
| `PROOF_OF_DELIVERY`          | Proof of delivery ("POD" is the display label).                                                                                                                                                            |
| `PURCHASE_ORDER`             | A standalone purchase order — uploaded via the presigned flow and parsed into a purchase-order record.                                                                                                     |
| `VENDOR_INVOICE`             | A standalone non-freight vendor invoice — parsed into a vendor-invoice record.                                                                                                                             |

All 133 values:

```text theme={null}
ACCESSORIAL_RECEIPT  ADVANCE_REQUEST  AGENT_INVOICE  ARRIVAL_NOTICE
ASBESTOS_DECLARATION  AUSFTA  AUTHORITY  AUTH_RELEASE
B3_CANADIAN_ENTRY  BALANCE_DUE  BILL_OF_LADING  CARRIER_ACH_SETUP_FORM
CARRIER_BOOKING_REQUEST  CARRIER_INSURANCE_CERTIFICATE  CARRIER_INVOICE  CARRIER_INVOICE_SUMMARY
CARRIER_INVOICE_WITH_SUPPORTING_DOCUMENTATION  CARRIER_RATE_CONFIRMATION  CARRIER_W9  CARTAGE_ADVICE_WITH_RECEIPT
CERTIFICATE_OF_ORIGIN  CFDI  CLAIM  CLAIM_NOTICE
COMCHECK  COMMERCIAL_INVOICE  CONSIGNMENT_SECURITY_DECLARATION  CONTRACT
CORRECTION_NOTICE  COVER_SHEET  CREDIT_APPLICATION  CUSTOMER_DOCUMENTS_OTHER
CUSTOMER_INVOICE  CUSTOMER_INVOICE_WITH_SUPPORTING_DOCUMENTATION  CUSTOMER_RATE_CONFIRMATION  CUSTOMER_RELEASE
CUSTOMS_AUTHORITY  CUSTOMS_CLEARANCE_REQUEST  CUSTOMS_DOCUMENT  CUSTOMS_ENTRY_SUMMARY
CUSTOMS_POWER_OF_ATTORNEY  DANGEROUS_GOODS_DECLARATION  DELIVERY_ORDER  DELIVERY_PHOTO
DELIVERY_RECEIPT  DEMURRAGE_RECEIPT  DETENTION_APPROVAL  DOCUMENT_BUNDLE
DOCUMENT_PACKET  DRIVER_FORM  ELECTRONIC_INTERCHANGE_RECEIPT  EMAIL_APPROVAL
EMAIL_SIGNATURE_IMAGE  ESCORT_RECEIPT  EXIT_PASS  EXPORT_AUTHORITY
EXPORT_DECLARATION  FACTOR_INVOICE  FERRY_RECEIPT  FINE
FORM_1113_PUBLIC_VOUCHER  FREETIME_NOTIFICATION  FREIGHT_LABEL  FUEL_RECEIPT
FUMIGATION_CERTIFICATE  FUNDING_REQUEST_FORM  GATE_PASS  GOVERNMENT_BOL
HIDDEN_BOL  HOUSE_AIRWAY_BILL  HOUSE_BOL  HOUSE_OCEAN_BOL
INSPECTION_CERTIFICATE  INSTRUCTION_PAGE  INTERMODAL_IN_TRANSIT_NOTICE  INTERNAL_DOCUMENTS_OTHER
INTERNAL_PROOF_OF_DELIVERY  INTERNATIONAL_BOL  INVOICE_STATEMENT  ISF_FILING_INSTRUCTION
LAYOVER_APPROVAL  LETTER_OF_ASSIGNMENT  LETTER_OF_CREDIT  LUMPER_APPROVAL
LUMPER_RECEIPT  MANIFEST  MASTER_AIRWAY_BILL  MASTER_BOL
MASTER_OCEAN_BOL  MOTOR_VEHICLE_CERT  MSDS  NAFTA_CERT
NMFC_W_I_CERT  NOTICE_OF_ASSIGNMENT  NOTICE_OF_RELEASE  OTHER
PACKING_DECLARATION  PACKING_SLIP  PALLET_RECEIPT  PERMIT_TO_TRANSFER
PER_DIEM_RECEIPT  PICKUP_NUMBER  PRE_ALERT  PROFORMA_INVOICE
PROOF_OF_DELIVERY  PURCHASE_ORDER  REMITTANCE  RUN_TICKET
SANITARY_CERTIFICATE  SCALE_TICKET  SHIPPERS_LETTER  SHIPPER_SECURITY_DECLARATION
SOLAS_FORM  SPOT_QUOTE_APPROVAL  STEAMING_RECEIPT  SUPPORTING_DOCUMENTATION
TELEX_RELEASE  TOLL_RECEIPT  TONU_APPROVAL  TRACKING_STATUS
TRAILER_INTERCHANGE_REPORT  TRUCK_BOL  UNKNOWN  US_CUSTOMS_DOC
VENDOR_INVOICE  VETERINARY_CERTIFICATE  VGM_CONTAINER_INFO  VOIDED_CHECK
WASH_RECEIPT  WAYBILL  WEIGHT_MEASUREMENT_REPORT  WEIGHT_TICKET
WEIGHT_UNLOADED
```