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 events
Triggered when a carrier invoice record is created, updated, or deleted
Body
Details that are sent over to the webhook
The unique identifier for the event.
The timestamp when the event was created.
The timestamp when the event was last updated.
The status of the event (e.g., PENDING).
The operation type that triggered the event.
INSERT, UPDATE, DELETE Show child attributes
Show child attributes
The new values of the resource after the operation (for INSERT and UPDATE events).
Show child attributes
Show child attributes
Primary key, unique identifier
A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
Identifier for the tenant
Identifier for the carrier
Invoice number
Timestamp with timezone in ISO 8601 format, or null
Timestamp with timezone in ISO 8601 format, or null
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.
Amount in cents (or smallest currency unit). For example, $10.00 would be represented as 1000.
Three-letter ISO currency code, e.g., USD, CAD, EUR, GBP
Current status of the invoice
APPROVED, AWAITING_BILL, AWAITING_CARRIER_RESPONSE, AWAITING_INVOICE, CANCELLED, CARRIER_EXCEPTION, CARRIER_RESPONDED, DISPUTED, EXCEPTION, PAID, PART_PAID, PROCESSING, RECEIVED, REFUNDED, REJECTED, UNDER_REVIEW Additional metadata from the source system
Reference numbers associated with the invoice
Additional metadata
A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
Associated shipment identifier
Associated bill identifier
Load number reference
Associated customer invoice identifier
Timestamp when document types or customer visibility was last updated
Email message ID if created from email
Timestamp with timezone in ISO 8601 format, or null
Timestamp when documents were last modified
The previous values of the resource before the operation (for UPDATE and DELETE events).
Show child attributes
Show child attributes
Primary key, unique identifier
A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
Identifier for the tenant
Identifier for the carrier
Invoice number
Timestamp with timezone in ISO 8601 format, or null
Timestamp with timezone in ISO 8601 format, or null
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.
Amount in cents (or smallest currency unit). For example, $10.00 would be represented as 1000.
Three-letter ISO currency code, e.g., USD, CAD, EUR, GBP
Current status of the invoice
APPROVED, AWAITING_BILL, AWAITING_CARRIER_RESPONSE, AWAITING_INVOICE, CANCELLED, CARRIER_EXCEPTION, CARRIER_RESPONDED, DISPUTED, EXCEPTION, PAID, PART_PAID, PROCESSING, RECEIVED, REFUNDED, REJECTED, UNDER_REVIEW Additional metadata from the source system
Reference numbers associated with the invoice
Additional metadata
A timestamp with timezone in ISO 8601 format, such as 2024-12-16T21:57:14.525733+00:00
Associated shipment identifier
Associated bill identifier
Load number reference
Associated customer invoice identifier
Timestamp when document types or customer visibility was last updated
Email message ID if created from email
Timestamp with timezone in ISO 8601 format, or null
Timestamp when documents were last modified
The timestamp when the event is scheduled to be processed.
The timestamp when the event was processed.
Response
Return a 200 status to indicate that the data was received successfully