Carrier Payment Line Items
Vendors
Invoice Line Items
Carrier Invoices
Carrier Invoice Documents
Addresses
Carriers
Bill Line Items
Customer Payments
Bills
Customer Payment Line Items
Invoice Shipments
Invoices
Customers
Carrier Invoice Approval Requests
Shipments
Shipment Documents
Bill Payments
Webhooks
- HOOKHandle carrier invoice events
- HOOKHandle carrier invoice status approved events
- HOOKHandle carrier invoice status portal exception events
- HOOKHandle carrier invoice shipment creation events
- HOOKHandle carrier invoice shipment update events
- HOOKHandle payments events
- HOOKHandles invoice events
- HOOKHandle invoice status portal exception events
- HOOKHandle invoice status sent events
- HOOKHandles remittance events
- HOOKHandle shipment documents events
Handle carrier invoice status portal exception events
Triggered when the status of a carrier invoice record is updated to portal_exception.
Body
Details that are sent over to the webhook
A payload structure for webhook events triggered by specific field updates in Upwell resources, detailing the affected resource, tenant, operation type, and resource state.
The unique identifier for the event.
The timestamp when the event was created.
The timestamp when the event was last updated.
The timestamp when the event is scheduled to be processed.
The timestamp when the event was processed.
The status of the event (e.g., PENDING).
The operation type that triggered the event. Format for specific field updates is UPDATE.<field>.<value>, where <field> is the updated field, and <value> is the new value, e.g., UPDATE.status.SENT or UPDATE.carrier_invoice.APPROVED.
Data regarding the state of the resource involved in the event.
Show child attributes
Show child attributes
The new values of the resource after the operation. Contains all fields of the resource.
Show child attributes
Show child attributes
Amount in cents (or smallest currency unit). For example, $10.00 would be represented as 1000.
The division within the company this invoice belongs to
The timestamp when the invoice was created
ID of the email message that created this invoice
Three-letter ISO currency code, e.g., USD, CAD, EUR, GBP
The unique identifier of the customer
The timestamp when the invoice debits were last updated
The date when the invoice was delivered
Methods used to deliver the invoice
List of exceptions related to invoice documents
The date when the invoice payment is due
The timestamp when file associations were last updated
Whether the invoice is held for review
ID of the event that created this invoice
The date when the invoice was issued
The timestamp when line items were last updated
Additional metadata associated with the invoice
The invoice number
Exception details from the portal processing
The portal identifier associated with this invoice
The timestamp when the invoice was received
The portal slug from which the invoice was received
Reference numbers associated with the invoice
The date when payment is scheduled
The timestamp when the invoice was sent
The portal slug to which the invoice was sent
The date when the goods were shipped
The system where the invoice originated
The ID of the invoice in the source system
Additional metadata from the source system
The ID of the statement this invoice belongs to
APPROVED, CANCELLED, CREATED, DELIVERED, DISPUTED, OPEN, OVERDUE, PAID, PART_PAID, PORTAL_EXCEPTION, PORTAL_RESOLVED, PROCESSING, REFUNDED, SEND_ERROR, SENT, VIEWED, WRITE_OFF The ID of the tenant this invoice belongs to
Amount in cents (or smallest currency unit). For example, $10.00 would be represented as 1000.
Amount in cents (or smallest currency unit). For example, $10.00 would be represented as 1000.
The timestamp when the invoice was last updated
The previous values of the resource before the operation. Contains all fields of the resource.
Show child attributes
Show child attributes
Amount in cents (or smallest currency unit). For example, $10.00 would be represented as 1000.
The division within the company this invoice belongs to
The timestamp when the invoice was created
ID of the email message that created this invoice
Three-letter ISO currency code, e.g., USD, CAD, EUR, GBP
The unique identifier of the customer
The timestamp when the invoice debits were last updated
The date when the invoice was delivered
Methods used to deliver the invoice
List of exceptions related to invoice documents
The date when the invoice payment is due
The timestamp when file associations were last updated
Whether the invoice is held for review
ID of the event that created this invoice
The date when the invoice was issued
The timestamp when line items were last updated
Additional metadata associated with the invoice
The invoice number
Exception details from the portal processing
The portal identifier associated with this invoice
The timestamp when the invoice was received
The portal slug from which the invoice was received
Reference numbers associated with the invoice
The date when payment is scheduled
The timestamp when the invoice was sent
The portal slug to which the invoice was sent
The date when the goods were shipped
The system where the invoice originated
The ID of the invoice in the source system
Additional metadata from the source system
The ID of the statement this invoice belongs to
APPROVED, CANCELLED, CREATED, DELIVERED, DISPUTED, OPEN, OVERDUE, PAID, PART_PAID, PORTAL_EXCEPTION, PORTAL_RESOLVED, PROCESSING, REFUNDED, SEND_ERROR, SENT, VIEWED, WRITE_OFF The ID of the tenant this invoice belongs to
Amount in cents (or smallest currency unit). For example, $10.00 would be represented as 1000.
Amount in cents (or smallest currency unit). For example, $10.00 would be represented as 1000.
The timestamp when the invoice was last updated
The type of resource in the Upwell application where the event occurred.
The unique identifier for the resource affected by the event.
The unique identifier for the webhook subscription.
The ID of the event being retried, if applicable.
An array of retry attempts for the event.
Response
Return a 200 status to indicate that the data was received successfully