Skip to main content
WEBHOOK
onCarrierInvoiceEvent
{
  "id": "whe_example",
  "createdAt": "2024-11-17T18:23:03.945732",
  "updatedAt": "2024-11-17T18:23:03.945732",
  "scheduledAt": null,
  "processedAt": null,
  "status": "PENDING",
  "operation": "UPDATE",
  "payload": {
    "new": {
      "id": "cari_example",
      "status": "RECEIVED",
      "balance": 250741,
      "bill_id": null,
      "currency": "EUR",
      "due_date": "2024-12-19",
      "metadata": null,
      "tenant_id": "ten_example",
      "carrier_id": "car_example",
      "created_at": "2024-11-16T00:59:33.492433+00:00",
      "deleted_at": null,
      "issue_date": "2023-09-10",
      "updated_at": "2024-11-17T18:22:58.990876+00:00",
      "load_number": "LOAD-2343",
      "received_at": "2024-11-16T00:59:33.492433+00:00",
      "shipment_id": null,
      "total_amount": 250741,
      "invoice_number": "1027",
      "total_tax_amount": 0,
      "reference_numbers": null,
      "source_system_meta": {
        "type": "ACCOUNTS_PAYABLE",
        "mergeId": "fd4c7a80-5813-4782-b6ee-fc6627bb0dc8",
        "remoteId": "75",
        "field_mappings": {
          "organization_defined_targets": null,
          "linked_account_defined_targets": null
        },
        "remote_updated_at": "2023-01-26T20:54:08Z",
        "remote_was_deleted": false,
        "tracking_categories": []
      },
      "customer_invoice_id": null,
      "created_from_email_message_id": null,
      "documents_type_or_customer_visibility_updated_at": null
    },
    "old": {
      "id": "cari_example",
      "status": "RECEIVED",
      "balance": 250741,
      "bill_id": null,
      "currency": "USD",
      "due_date": "2024-12-19",
      "metadata": null,
      "tenant_id": "ten_example",
      "carrier_id": "car_example",
      "created_at": "2024-11-16T00:59:33.492433+00:00",
      "deleted_at": null,
      "issue_date": "2023-09-10",
      "updated_at": "2024-11-16T00:59:33.492433+00:00",
      "load_number": "LOAD-1027",
      "received_at": "2024-11-16T00:59:33.492433+00:00",
      "shipment_id": null,
      "total_amount": 250741,
      "invoice_number": "1027",
      "total_tax_amount": "0",
      "reference_numbers": null,
      "source_system_meta": {
        "type": "ACCOUNTS_PAYABLE",
        "mergeId": "fd4c7a80-5813-4782-b6ee-fc6627bb0dc8",
        "remoteId": "75",
        "field_mappings": {
          "organization_defined_targets": null,
          "linked_account_defined_targets": null
        },
        "remote_updated_at": "2023-01-26T20:54:08Z",
        "remote_was_deleted": false,
        "tracking_categories": []
      },
      "customer_invoice_id": null,
      "created_from_email_message_id": null,
      "documents_type_or_customer_visibility_updated_at": null
    }
  },
  "table": "carrier_invoices",
  "webhookSubscriptionId": "whs_example",
  "resourceId": "cari_example",
  "retryOfId": null,
  "retries": []
}

Body

application/json

Details that are sent over to the webhook

ā€‹
id
string
required

The unique identifier for the event.

ā€‹
createdAt
string<date-time>
required

The timestamp when the event was created.

ā€‹
updatedAt
string<date-time>
required

The timestamp when the event was last updated.

ā€‹
status
string
required

The status of the event (e.g., PENDING).

ā€‹
operation
enum<string>
required

The operation type that triggered the event.

Available options:
INSERT,
UPDATE,
DELETE
ā€‹
payload
object
required
ā€‹
scheduledAt
string<date-time> | null

The timestamp when the event is scheduled to be processed.

ā€‹
processedAt
string<date-time> | null

The timestamp when the event was processed.

Response

200

Return a 200 status to indicate that the data was received successfully