Formats and timezones
The field’s endpoint schema determines its representation. Fields with the same business meaning can have different REST and webhook representations. Stop appointmentTimezone and actualTimezone carry the local scheduling/event context separately.
Missing values and updates
Omit an optional field on update to leave its value unchanged. Null is a value, not an instruction to use today’s date: only send it where the endpoint accepts clearing that field. Do not send an empty string as a date. Requiredness, write access, and defaults are endpoint-specific; an absent date is not evidence that the event occurred.REST and webhook names
REST generally uses camelCase; invoice webhook payloads use snake_case. For example, issue_date corresponds to issueDate, due_date to dueDate, ship_date to shipDate, and sent_at to sentAt. They link to the same business definitions below. The invoice create/update field is issueDate, not invoiceDate. Vendor invoices and remittance lines have their own invoiceDate field.Business and lifecycle definitions
Issue date
Field:issueDate
Entities: Bills; Carrier invoice webhook payload; Carrier invoices; Customer invoice webhook payload; Customer invoices.
Date the invoice was issued, as printed on the invoice. This is the invoice date for customer and carrier invoices; creating the Upwell record is a separate event recorded by createdAt.
Invoice date
Field:invoiceDate
Entities: Remittance webhook line items; Vendor invoices.
Date printed on the vendor invoice, or the invoice date reported on a remittance line. Customer and carrier invoice endpoints call this field issueDate; invoiceDate is not an alias accepted by those endpoints.
Due date
Field:dueDate
Entities: Bills; Carrier invoice webhook payload; Carrier invoices; Customer invoice webhook payload; Customer invoices; Vendor invoices.
Date payment is due under the invoice payment terms. Used for accounts-receivable aging and reminders; it is not the shipment delivery date.
Ready date
Field:readyDate
Entities: Shipments.
Date the shipment is scheduled to be ready for pickup. This is a readiness/planning date, not confirmation that pickup occurred. Source integrations may populate it from the earliest scheduled pickup date.
Ship date
Field:shipDate
Entities: Customer invoice webhook payload; Customer invoices.
Shipping date recorded on the invoice or reported by its source system. It describes the freight movement, not invoice issuance. Source systems may report a planned or actual shipping date; this field alone does not certify actual pickup. Use shipment/stop event timestamps for recorded movement events.
Delivery date
Field:deliveryDate
Entities: Customer invoice webhook payload; Customer invoices; Purchase-order line schedules (schedules[]).
Freight delivery date recorded on the invoice. On a purchase-order line schedule, the scheduled delivery date of that release. It does not mean the invoice email was delivered; invoice sending is recorded separately by sentAt.
Pickup at
Field:pickupAt
Entities: Shipments.
Pickup timestamp recorded for the shipment. A source integration may supply an actual event or a scheduling fallback; inspect stop actualArrival/actualDeparture for explicitly recorded actual events. Distinct from the date-only readyDate.
Delivered at
Field:deliveredAt
Entities: Shipments.
Delivery timestamp recorded for the shipment and used by post-delivery invoice workflows. Some creation/import workflows supply a fallback value, so it is not by itself proof of delivery. Distinct from invoice delivery/sending.
Release date
Field:releaseDate
Entities: Shipments.
Shipment release/planned-start date supplied by the source system. Some integrations copy readyDate or use the planned load start; it is not a guarantee of actual departure.
Covered date
Field:coveredDate
Entities: Shipments.
Date the shipment was recorded as covered by a carrier in the source system. Distinct from dispatch, pickup, and delivery.
Dispatched date
Field:dispatchedDate
Entities: Shipments.
Date the shipment was recorded as dispatched in the source system. Dispatch does not confirm physical pickup.
Loaded date
Field:loadedDate
Entities: Shipments.
Date the shipment was recorded as loaded in the source system. Distinct from the planned readiness date.
Billed date
Field:billedDate
Entities: Shipments.
Date the shipment was recorded as billed in the source system. This shipment lifecycle date need not equal an associated invoice’s issueDate.
Appointment start
Field:appointmentStart
Entities: Shipment stops.
Start of the scheduled appointment window at a stop. Use appointmentTimezone to interpret the stop’s local scheduling context; this is not an actual arrival event.
Appointment end
Field:appointmentEnd
Entities: Shipment stops.
End of the scheduled appointment window at a stop. Use appointmentTimezone for the local scheduling context; this is not an actual departure event.
Actual arrival
Field:actualArrival
Entities: Shipment stops.
Recorded actual arrival time at a stop. Distinct from appointmentStart, which describes the scheduled window. actualTimezone identifies the local event context.
Actual departure
Field:actualDeparture
Entities: Shipment stops.
Recorded actual departure time from a stop. Distinct from appointmentEnd, which describes the scheduled window. actualTimezone identifies the local event context.
Paid date
Field:paidDate
Entities: Customer invoices.
Timestamp recorded for invoice payment. It is separate from individual payment transaction dates and from a scheduled or promised payment date. Determine the outstanding amount from balance and payment records.
Scheduled payment date
Field:scheduledPaymentDate
Entities: Customer invoice webhook payload; Customer invoices.
Expected or scheduled date of payment reported for the invoice. It is a forecast, not proof that funds were received.
Transaction date
Field:transactionDate
Entities: Bill payments; Carrier payment line items; Customer payment line items; Customer payments.
Accounting transaction date recorded on a payment or payment allocation. It can differ from the date printed on a check and the date funds become available at the bank.
Check date
Field:checkDate
Entities: Customer payment line items; Customer payments.
Date printed on the check or reported by the payment source for the check/ACH remittance. It does not establish when the bank settled the payment.
Payment date
Field:paymentDate
Entities: Remittance webhook payload.
Payment date reported in the remittance webhook. This reflects the source remittance’s payment date, not the webhook delivery time.
Value date
Field:valueDate
Entities: Document annotations (purchase orders and vendor invoices).
Date value extracted for a document annotation on a purchase order or vendor invoice, such as a date written beside a signature or stamp. Interpret it with the annotation’s fieldLabel, text, and type. It is not inherently a bank settlement date or an invoice issue date.
Po date
Field:poDate
Entities: Purchase orders.
Date the purchase order was issued, as recorded on the document. Distinct from requested shipment and delivery dates.
Order date
Field:orderDate
Entities: Vendor invoices.
Order date stated on the purchase order or vendor invoice. This describes the underlying order, not invoice creation in Upwell.
Revision date
Field:revisionDate
Entities: Purchase orders.
Date of the document revision, as printed on the purchase order. It does not represent the original order date.
Requested ship date
Field:requestedShipDate
Entities: Purchase orders.
Date the buyer requests goods to be shipped. A requested date is not confirmation that shipment occurred.
Requested delivery date
Field:requestedDeliveryDate
Entities: Purchase orders; Purchase-order line items.
Date the buyer requests goods or a particular order line to be delivered. A requested date is not confirmation of delivery.
Promised delivery date
Field:promisedDeliveryDate
Entities: Purchase-order line items.
Delivery date promised or scheduled by the supplier for an order line. Distinct from the buyer’s requestedDeliveryDate and actual delivery.
Cancel after date
Field:cancelAfterDate
Entities: Purchase orders.
Purchase-order cancellation cutoff printed on the document. Recording this date does not itself cancel an order in Upwell.
Pickup date
Field:pickupDate
Entities: Purchase orders.
Pickup date stated on the source purchase order or vendor document. This document field is distinct from the shipment pickupAt timestamp.
Shipped date
Field:shippedDate
Entities: Vendor invoice shipment details (shipmentInfo).
Shipping date printed in a vendor invoice’s shipmentInfo block. It reflects the source document rather than an independently observed shipment event.
Cargo insurance expire date
Field:cargoInsuranceExpireDate
Entities: Carriers.
Expiration date recorded for the carrier’s cargo insurance policy. A populated date is not a verification that coverage is currently valid.
General liability insurance expire date
Field:generalLiabilityInsuranceExpireDate
Entities: Carriers.
Expiration date recorded for the carrier’s general liability insurance policy. Distinct from cargo and other liability coverage.
Liability insurance expire date
Field:liabilityInsuranceExpireDate
Entities: Carriers.
Expiration date recorded for the carrier’s liability insurance policy. Consult the policy for coverage details; this field is not a coverage guarantee.
Automation go live date
Field:automationGoLiveDate
Entities: Customer automation settings (customerRule).
Configured go-live date for customer automation. It is an automation setting, not an invoice issue date or shipment event.
Created at
Field:createdAt
Entities: Addresses; Bill line items; Bill payments; Bills; Carrier invoice approval requests; Carrier invoice documents; Carrier invoice exceptions; Carrier invoice webhook event envelope; Carrier invoice webhook payload; Carrier invoices; Carrier payment line items; Carriers; Companies; Customer invoice documents; Customer invoice exceptions; Customer invoice line items; Customer invoice webhook event envelope; Customer invoice webhook payload; Customer invoices; Customer payment line items; Customer payments; Customers; Document reference specifications; Documents; Field-update webhook event envelope; Invoice–shipment links; Notes (shipments and carrier invoices); Purchase orders; Remittance webhook event envelope; Remittance webhook line items; Remittance webhook payload; Rules; Shipment documents; Shipment line items; Shipment stops; Shipments; Vendor invoices; Vendors; Webhook event envelope.
Timestamp when this record was created in Upwell. It is not the business document date and may be much later when historical data is imported.
Updated at
Field:updatedAt
Entities: Addresses; Bill line items; Bill payments; Bills; Carrier invoice approval requests; Carrier invoice documents; Carrier invoice exceptions; Carrier invoice webhook event envelope; Carrier invoice webhook payload; Carrier invoices; Carrier payment line items; Carriers; Companies; Customer invoice documents; Customer invoice exceptions; Customer invoice line items; Customer invoice webhook event envelope; Customer invoice webhook payload; Customer invoices; Customer payment line items; Customer payments; Customers; Document reference specifications; Field-update webhook event envelope; Remittance webhook event envelope; Remittance webhook line items; Remittance webhook payload; Rules; Shipment documents; Shipment line items; Shipment stops; Shipments; Vendors; Webhook event envelope.
Timestamp of the record’s latest recorded update in Upwell. It is not a shipment event, payment date, or document revision date.
Deleted at
Field:deletedAt
Entities: Carrier invoice webhook payload; Carrier invoices; Companies; Customers.
Timestamp recorded when the object was marked deleted. A deletion marker is separate from invoice cancellation status.
Sent at
Field:sentAt
Entities: Customer invoice webhook payload; Customer invoices.
Timestamp recorded for sending the invoice. It does not establish freight delivery or guarantee that the recipient opened or accepted the invoice.
Received at
Field:receivedAt
Entities: Carrier invoice webhook payload; Carrier invoices; Customer invoice webhook payload; Customer invoices.
Timestamp when the relevant inbound record or document was received. It is not the date printed on that document.
Pinned at
Field:pinnedAt
Entities: Notes (shipments and carrier invoices).
Timestamp when the note was pinned. It is a note-management event rather than a financial or shipment date.
Scheduled at
Field:scheduledAt
Entities: Carrier invoice webhook event envelope; Customer invoice webhook event envelope; Field-update webhook event envelope; Remittance webhook event envelope; Webhook event envelope.
Timestamp when the asynchronous job is scheduled to run. It is not a promise of completion at that time.
Processed at
Field:processedAt
Entities: Carrier invoice webhook event envelope; Customer invoice webhook event envelope; Field-update webhook event envelope; Remittance webhook event envelope; Webhook event envelope.
Timestamp recorded for processing the event or job. It is separate from the event’s underlying business date.
Synced at
Field:syncedAt
Entities: Remittance webhook payload.
Timestamp recorded when the synchronization ran. It describes data synchronization, not invoice issuance or shipment movement.
Exceptions last evaluated at
Field:exceptionsLastEvaluatedAt
Entities: Carrier invoices; Customer invoices.
Timestamp when the record’s exception checks were last evaluated. It is a processing marker, not the date an exception first occurred or was resolved.
Portal documents uploaded at
Field:portalDocumentsUploadedAt
Entities: Shipments.
Timestamp recorded for shipment document upload to the portal. It is not the freight delivery time or invoice issue date.
Enabled at
Field:enabledAt
Entities: Customers.
Timestamp when the associated feature or workflow was enabled. This lifecycle timestamp does not describe the invoice or shipment itself.
Final check passed at
Field:finalCheckPassedAt
Entities: Customer invoices.
Timestamp when the invoice’s final processing check was recorded as passed. It is separate from approval, sending, and payment dates.
Lifecycle event at
Field:lifecycleEventAt
Entities: Customer payments.
Timestamp recorded for the associated lifecycle event. Interpret it with that event’s type rather than treating it as an invoice issue date.
Debits updated at
Field:debits_updated_at
Entities: Customer invoice webhook payload.
Timestamp when the invoice’s debit-related data was updated. This is a change-tracking marker in the webhook payload.
Documents modified at
Field:documents_modified_at
Entities: Carrier invoice webhook payload.
Timestamp when the invoice’s document data was modified. This is a change-tracking marker, not a document issue date.
Documents type or customer visibility updated at
Field:documents_type_or_customer_visibility_updated_at
Entities: Carrier invoice webhook payload.
Timestamp when document classification or customer visibility changed. This is distinct from the document’s own issue date.
File associations updated at
Field:file_associations_updated_at
Entities: Customer invoice webhook payload.
Timestamp when the invoice’s file associations changed. It tracks attachment links rather than invoice issuance.
Line items last updated at
Field:line_items_last_updated_at
Entities: Customer invoice webhook payload.
Timestamp when invoice line-item data was last updated. It is a change-tracking marker rather than a financial transaction date.