VLMS SQS Events Documentation

SQS payload reference Envelope + domain events Search: / • Clear: Esc

Message Envelope Structure

All events are wrapped in a standard EventMessage envelope when published to SQS. 


            
          
{
  "$type": "VTVSolutions.MessageManager.Core.EventMessage, VTVSolutions.MessageManager.Core",
  "Id": "67b64375-02b5-4722-8bf1-2168a075ab6b",
  "EventTimestamp": "2025-12-01T14:38:35.8337645Z",
  "EventSource": {
    "$type": "VTVSolutions.MessageManager.Events.Systems.VLMSDomains.OrderEvents.{EventName}, VTVSolutions.MessageManager.Events",
    "Name": "{EventName}",
    "Domain": {
      "$type": "VTVSolutions.MessageManager.Events.Systems.VLMSDomains.{Domain}, VTVSolutions.MessageManager.Events",
      "Name": "{Domain}",
      "System": {
        "$type": "VTVSolutions.MessageManager.Events.Systems.VLMS, VTVSolutions.MessageManager.Events",
        "Name": "VLMS"
      }
    },
    "EventDtoType": "VTVSolutions.MessageManager.Events.DTOs.VLMS.{Domain}.{EventName}Dto, VTVSolutions.MessageManager.Events, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
  },
  "EventObj": {
    "$type": "VTVSolutions.MessageManager.Events.DTOs.VLMS.{Domain}.{EventName}Dto, VTVSolutions.MessageManager.Events"
    // ... payload fields
  },
  "InstanceKey": "{InstanceKey}"
}

Envelope Fields

  • Id — Unique message identifier (GUID)
  • EventTimestamp — UTC timestamp when event was created
  • EventSource.Name — Event name (e.g., "OrderForceRefresh")
  • EventSource.Domain.Name — Domain name (e.g., "Order", "Client", "Driver")
  • EventObj — The actual event payload (documented below)
  • InstanceKey — Environment/instance identifier

Table of Contents

Jump to a domain section:

Tip: Use the sidebar search to filter down to a specific event (e.g., “OrderDateChanged”, “CarrierPayable”, “VIN”).
Order Events Domain: Order
OrderStatusChanged
Triggered when an order's status changes
Triggered when an order's status changes.
{
  "OrderId": 12345,
  "NewStatus": "Delivered",
  "NewStatusDateTime": "2025-12-01T14:38:35Z",
  "ConsignorId": 100,
  "BillToId": 101,
  "ShipperId": 102,
  "OriginId": 200,
  "DestinationId": 201,
  "DestinationZip": "90210",
  "OrderType": "Standard"
}
OrderCancelled
Triggered when an order is cancelled
Triggered when an order is cancelled.
{
  "OrderId": 12345,
  "LoadParentId": 5000
}
OrderConsignorChanged
Triggered when an order's consignor changes
Triggered when an order's consignor changes.
{
  "OrderId": 12345,
  "OldConsignorId": 100,
  "NewConsignorId": 101,
  "ShipperId": 102,
  "OrderType": "Standard"
}
OrderBillToChanged
Triggered when an order's bill-to client changes
Triggered when an order's bill-to client changes.
{
  "OrderId": 12345,
  "OldBillToId": 100,
  "NewBillToId": 101,
  "ShipperId": 102,
  "OrderType": "Standard"
}
OrderOriginChanged
Triggered when an order's origin location changes
Triggered when an order's origin location changes.
{
  "OrderId": 12345,
  "OldOriginId": 200,
  "NewOriginId": 201,
  "ConsignorId": 100,
  "ShipperId": 102,
  "OrderType": "Standard"
}
OrderDestinationChanged
Triggered when an order's destination location changes
Triggered when an order's destination location changes.
{
  "OrderId": 12345,
  "OldDestinationId": 300,
  "NewDestinationId": 301,
  "ConsignorId": 100,
  "ShipperId": 102,
  "OrderType": "Standard"
}
OrderDateChanged
Triggered when an order date changes
Triggered when an order date changes.
{
  "OrderId": 12345,
  "OrderType": "Standard",
  "ConsignorId": 100,
  "ShipperId": 102,
  "OrderDateType": "ScheduledPickup",
  "NewDate": "2025-12-15T08:00:00Z",
  "LoadId": 5000,
  "OriginClientId": 200,
  "DestinationClientId": 201,
  "TruckId": 50,
  "TrailerId": 60,
  "OrderStatus": "Dispatched",
  "PuStop": 1,
  "DelvStop": 2,
  "Customer": "Acme Corp",
  "Created": "2025-12-01T10:00:00Z"
}
OrderCarrierAssigned
Carrier assigned
Triggered when a carrier is assigned to an order.
{
  "OrderId": 12345,
  "CarrierId": 500,
  "CarrierName": "ABC Transport"
}
OrderCarrierUnassigned
Carrier unassigned
Triggered when a carrier is unassigned from an order.
{
  "OrderId": 12345
}
OrderCarrierPayableChanged
Carrier payable changed
Triggered when an order's carrier payable amount changes.
{
  "OrderId": 12345,
  "OldCarrierPayable": 500.00,
  "NewCarrierPayable": 550.00
}
OrderPaymentTypeChanged
Payment type changed
Triggered when an order's payment type changes.
{
  "OrderId": 12345,
  "OldCreditStatus": "Cash",
  "NewCreditStatus": "Credit"
}
OrderClientReferenceNumberUpdated
Client reference updated
Triggered when a client reference number is updated on an order.
{
  "OrderId": 12345,
  "ClientReferenceNumberId": 999
}
OrderForceRefresh
Force refresh
Triggered to force a refresh of order data.
{
  "OrderId": 12345
}
OrderRelationChanged
Relationship changed
Triggered when an order's relationship to other orders changes.
{
  "OrderId": 12345,
  "ConsignorId": 100,
  "RelatedOrderId": 12346,
  "Action": "Added"
}
OrderReconciliation
Reconciliation
Triggered for order reconciliation events.
{
  "OrderId": 12345,
  "OrderType": "Standard",
  "LoadId": 5000,
  "OriginClientId": 200,
  "DestinationClientId": 201,
  "TruckId": 50,
  "TrailerId": 60,
  "OrderStatus": "Delivered",
  "PuStop": 1,
  "DelvStop": 2,
  "DriverId": 75
}
OrderAssignment
Assignment changed
Triggered when order assignment changes.
{
  "OrderId": 12345,
  "PerformedByClientId": 100,
  "PerformedByUserId": 25,
  "PerformedByUserName": "jsmith",
  "AssigningAction": "Assigned",
  "UnassignmentReason": null,
  "WhenPerformed": "2025-12-01T14:00:00Z",
  "OrderStatus": "Dispatched",
  "ScheduledPickup": "2025-12-15T08:00:00Z",
  "ActualPickup": null,
  "ScheduledDelivery": "2025-12-16T10:00:00Z",
  "Delivered": null,
  "Source": "Dispatch",
  "CarrierId": 500,
  "CarrierName": "ABC Transport",
  "DriverId": 75,
  "DriverName": "John Doe",
  "ProcessedDate": "2025-12-01T14:00:00Z"
}
OrderVehicleAdded
Vehicle added
Triggered when a vehicle is added to an order.
{
  "OrderId": 12345,
  "VehicleId": 9999
}
OrderVehicleRemoved
Vehicle removed
Triggered when a vehicle is removed from an order.
{
  "OrderId": 12345,
  "VehicleId": 9999
}
OrderFreightAdded
Freight added
Triggered when freight is added to an order.
{
  "OrderId": 12345,
  "FreightId": 800,
  "Bol": "BOL123456",
  "Length": 48.0,
  "Width": 8.5,
  "Height": 9.0,
  "Volume": 3672.0,
  "Weight": 45000.0,
  "Stackable": true,
  "NonPalletized": false,
  "TopLoadOnly": false,
  "Hazmat": false,
  "FreightType": "Palletized"
}
OrderFreightRemoved
Freight removed
Triggered when freight is removed from an order.
{
  "OrderId": 12345,
  "FreightId": 800
}
OrderPayableAdded
Payable added
Triggered when a payable is added to an order.
{
  "OrderId": 12345,
  "OrderPayableId": 700,
  "PayableAmount": 250.00
}
OrderPayableRemoved
Payable removed
Triggered when a payable is removed from an order.
Note: Unlike OrderPayableAdded, this event does not include the PayableAmount field.
{
  "OrderId": 12345,
  "OrderPayableId": 700
}
OrderSplitLeg
Leg split
Triggered when an order leg is split.
{
  "MlpId": 10000,
  "PreviousLegId": 12345,
  "NewLegOriginId": 12346,
  "NewLegDestinationId": 12347,
  "NewLegPrice": 500.00
}
OrderSplitLoad
Load split
Triggered when a load is split.
{
  "LoadParentId": 5000,
  "NewLegDestinationId": 12347
}
DeliveryEstimateRequest
Estimate requested
Triggered when a delivery estimate is requested.
{
  "OrderId": 12345,
  "OrderDateType": "EstimatedDelivery",
  "OrderDateTime": "2025-12-16T10:00:00Z",
  "ClientId": 100,
  "Miles": 450.5,
  "Price": 1200.00,
  "OriginZip": "60601",
  "DestinationZip": "90210"
}
LegDelivered
Leg delivered
Triggered when a leg of a multi-leg order is delivered.
{
  "OrderId": 12345
}
MlpCreated
Multi-leg parent created
Triggered when a multi-leg parent order is created.
{
  "OrderId": 10000,
  "OrderStatus": "New",
  "LegChilds": [
    {
      "OrderId": 12345,
      "LoadParentId": 5000,
      "DownStreamOrderId": 12346,
      "OrderStatus": "New"
    },
    {
      "OrderId": 12346,
      "LoadParentId": null,
      "DownStreamOrderId": null,
      "OrderStatus": "New"
    }
  ]
}
Load Events Domain: Order
LoadOrderAdded
Order added to load
Triggered when an order is added to a load.
{
  "LoadParentId": 5000,
  "OrderId": 12345,
  "OrderStatus": "Dispatched",
  "DeliveryStopSequence": 2,
  "ScheduledPickup": "2025-12-15T08:00:00Z",
  "OriginName": "ABC Warehouse",
  "OriginClientId": 200,
  "OriginAddr1": "123 Main St",
  "OriginAddr2": "Suite 100",
  "OriginCity": "Chicago",
  "OriginState": "IL",
  "OriginZip": "60601",
  "OriginCountry": "USA",
  "OriginLatitude": 41.8781,
  "OriginLongitude": -87.6298,
  "OriginGeocodeStatus": "Success",
  "OriginKey": "ABC-CHI",
  "DestinationName": "XYZ Distribution",
  "DestinationClientId": "201",
  "DestinationAddr1": "456 Oak Ave",
  "DestinationAddr2": null,
  "DestinationCity": "Los Angeles",
  "DestinationState": "CA",
  "DestinationZip": "90210",
  "DestinationCountry": "USA",
  "DestinationLatitude": 34.0522,
  "DestinationLongitude": -118.2437,
  "DestinationGeocodeStatus": "Success",
  "DestinationKey": "XYZ-LA",
  "LoadStops": [
    {
      "OrderId": 12345,
      "OrderType": "Standard",
      "LoadStopSequence": 1
    }
  ]
}
LoadOrderRemoved
Order removed from load
Triggered when an order is removed from a load.
{
  "OrderId": 12345,
  "OrderStatus": "Available"
}
LoadOrderCompleted
Order(s) completed
Triggered when an order within a load is completed.
{
  "LoadParentId": 5000,
  "Orders": [
    {
      "HOS_ID": "HOS123",
      "IsPaperWorkRequired": true,
      "ExperienceLevel": "Senior",
      "SeniorityDateTime": "2020-01-15T00:00:00Z",
      "TwicCardExpiration": "2026-06-30T00:00:00Z",
      "HOS_drivingRuleName": "60/7",
      "OrderID": 12345,
      "TruckID": 50,
      "OrderType": "Standard",
      "Status": "Delivered",
      "Price": 1200.00,
      "CarrierPayable": 900.00,
      "DriverBasePay": 800.00,
      "Miles": 450.5,
      "RateMiles": 450.5,
      "PUStopSequence": 1,
      "DelvStopSequence": 2,
      "OrigRouteCode": "CHI",
      "DestRouteCode": "LA",
      "AltRateCode": null,
      "IsRushSold": false,
      "ThirdPartyCarrierPay": null,
      "GeoServicesDuration": "PT8H30M",
      "AgeCustomerBusinessDays": 5.0,
      "FirstName": "John",
      "LastName": "Doe",
      "DateCreated": "2025-12-01T10:00:00Z",
      "DateLastLogin": "2025-12-01T06:00:00Z",
      "DateOfBirth": "1985-03-15T00:00:00Z",
      "ClientID": 100,
      "OrderDates": [
        {
          "OrderDateType": "ScheduledPickup",
          "OrderDateTime": "2025-12-15T08:00:00Z"
        },
        {
          "OrderDateType": "ActualDelivery",
          "OrderDateTime": "2025-12-16T14:30:00Z"
        }
      ],
      "Locations": [
        {
          "LocationType": "Origin",
          "AddressType": "Physical",
          "Addr1": "123 Main St",
          "Addr2": null,
          "City": "Chicago",
          "State": "IL",
          "Zip": "60601",
          "Latitude": 41.8781,
          "Longitude": -87.6298
        }
      ]
    }
  ]
}
LoadOrderDriverAssigned
Driver(s) assigned
Triggered when a driver is assigned to an order in a load.
{
  "OrderId": 12345,
  "Drivers": [75, 76]
}
LoadTruckAssigned
Truck assigned
Triggered when a truck is assigned to a load.
{
  "OrderId": 12345,
  "TruckId": 50,
  "AssetNumber": "TRK-001",
  "TrailerIds": [60, 61]
}
LoadTruckUnassigned
Truck unassigned
Triggered when a truck is unassigned from a load.
{
  "OrderId": 12345,
  "TruckId": 50
}
LoadTrailerAssigned
Trailer assigned
Triggered when a trailer is assigned to a load.
{
  "OrderId": 12345,
  "TrailerId": 60,
  "AssetNumber": "TRL-001"
}
LoadTrailerUnassigned
Trailer unassigned
Triggered when a trailer is unassigned from a load.
{
  "OrderId": 12345,
  "TrailerId": 60
}
OrderLoadStopEventCreated
Stop event created
Triggered when a load stop event is created.
{
  "Billable": true,
  "IsSystemGenerated": false,
  "IsLoaded": true,
  "ScheduledEventDate": "2025-12-15T08:00:00Z",
  "ActualEventDate": "2025-12-15T08:15:00Z",
  "OrderLoadStopId": 1000,
  "OrderLoadStopEventId": 2000,
  "OrderLoadStopOrderId": 12345,
  "OrderLoadStopSequence": 1,
  "AssetPosition": 1,
  "ChassisId": null,
  "ContainerId": null,
  "DollyId": null,
  "LiftGateId": null,
  "OrderLoadStopClientId": 200,
  "TrailerId": 60,
  "OrderLoadStopMoveType": "Pickup",
  "StopEvent": "Arrived"
}
Also: OrderLoadStopEventUpdated and OrderLoadStopEventDeleted use the same structure.
Vehicle Events Domain: Order
VehicleVinChanged
VIN changed
Triggered when a vehicle VIN changes.
{
  "OldValue": "1HGBH41JXMN109186",
  "NewValue": "1HGBH41JXMN109187"
}
VehicleInopChanged
Inop changed
Triggered when a vehicle's inoperable status changes.
{
  "OldValue": false,
  "NewValue": true,
  "Vin": "1HGBH41JXMN109186"
}
VehicleBayChanged
Bay changed
Triggered when a vehicle's bay assignment changes.
{
  "OldBay": "A1",
  "NewBay": "B3",
  "Vin": "1HGBH41JXMN109186"
}
VehicleModelChanged
Model changed
Triggered when a vehicle's model changes.
{
  "OldModel": "Accord",
  "NewModel": "Civic",
  "Vin": "1HGBH41JXMN109186"
}
VehicleUnloadableCodeChanged
Unloadable code
Triggered when a vehicle's unloadable code changes.
{
  "VehicleId": 9999,
  "Vin": "1HGBH41JXMN109186",
  "NewUnloadableCode": "DAMAGED"
}
Driver Events Domain: Driver / DriverUnavailable
DriverUpdated
Driver info updated
Triggered when driver information is updated.
{
  "DriverId": 75,
  "UserName": "jdoe",
  "FirstName": "John",
  "LastName": "Doe",
  "ClientId": 100,
  "DriverType": "CompanyDriver",
  "BusinessName": null,
  "CanAcceptDeclineLoads": true,
  "CanAdjustEstimatedDeliveryDate": true,
  "CanAdjustScheduledPickupDate": false,
  "CanRejectOrders": false,
  "Comment": "Experienced driver",
  "DisallowSti": false,
  "DispatchStatus": "Available",
  "DispatchUnavailableReasonId": null,
  "DOTMedCardNationalNumber": "DOT123456",
  "DriverAssignmentsComment": null,
  "EmergencyContact1Name": "Jane Doe",
  "EmergencyContact1Number": "555-1234",
  "EmergencyContact2Name": null,
  "EmergencyContact2Number": null,
  "ExcludeFromTextFile": false,
  "ExperienceLevel": "Senior",
  "ExtraMileRate": 0.10,
  "FastExpiration": "2026-12-31T00:00:00Z",
  "FastNumber": "FAST123",
  "FederalTaxId": "123-45-6789",
  "FinishTime": "18:00:00",
  "FirstYearGuaranteedPay": false,
  "FirstYearGuaranteedPayComment": null,
  "ForceScan": 1,
  "FuelPlanFee": 50.00,
  "GlCode": "DRV001",
  "HandheldType": "Android",
  "HasHandheld": true,
  "IsLease": false,
  "IsOwnerOp": false,
  "IsPaperWorkRequired": true,
  "LiabilityInsurance": 1000000.00,
  "LicenseNumber": "D1234567",
  "LicenseState": "IL",
  "LoadTime": "06:00:00",
  "LocalOnly": false,
  "ManagementFee": null,
  "MaxAdvanceFunds": 500.00,
  "MaxMiles": 3000,
  "MaxReserve": 1000.00,
  "MinReserve": 100.00,
  "NegativeNetPay": 0.00,
  "NextLocation": "Chicago, IL",
  "NextLocationRequiredBy": "2025-12-16T08:00:00Z",
  "Notes": null,
  "OOFleetOwnerUserId": null,
  "PassportExpiration": "2030-06-15T00:00:00Z",
  "PassportNumber": "P123456789",
  "PayCurrency": "USD",
  "PayrollId": "PAY75",
  "PayType": "PerMile",
  "PerDiemAmount": 50.00,
  "PermResidentCardExpiration": null,
  "PermResidentCardNumber": null,
  "PetInCab": false,
  "PrepTime": "00:30:00",
  "ReserveAmount": 500.00,
  "ReservePercentage": 5.0,
  "ReservePerPayPeriod": 100.00,
  "SeniorityDateTime": "2020-01-15T00:00:00Z",
  "SSN": "***-**-6789",
  "StartTime": "06:00:00",
  "TwicCardExpiration": "2026-06-30T00:00:00Z",
  "VtasCanArriveDepart": true,
  "VtasCanCreateLoads": false,
  "VtasCanUseInventory": true,
  "VtasOdometerRequired": true,
  "VtasShowEstimatedPay": true,
  "PhoneNumber": "555-9876",
  "DateOfBirth": "1985-03-15T00:00:00Z"
}
DriverUnavailableAdded
Unavailable added
Triggered when a driver is marked unavailable.
{
  "DriverId": 75,
  "DriverUnavailableId": 1000,
  "UnavailableReasonId": 5,
  "UnavailableReason": "Vacation",
  "Note": "Annual vacation",
  "StartDate": "2025-12-20T00:00:00Z",
  "EndDate": "2025-12-27T00:00:00Z",
  "Location": "Home"
}
Also: DriverUnavailableEdited and DriverUnavailableDeleted use the same structure.
Client Events Domain: Client
ClientUpdated
Client updated
Triggered when client information is updated.
{
  "ClientId": 100,
  "Status": "Active",
  "Name": "Acme Corporation",
  "DbaName": "Acme Corp",
  "OwnersName": "John Smith",
  "Division": false,
  "BusinessType": "Shipper",
  "LocationType": "Warehouse",
  "StatusReason": null,
  "DefaultBillToId": null,
  "DefaultSalesRepId": 25,
  "DefaultSalesSourceTypeId": 1,
  "AccountingId": "ACME001",
  "InvoiceDeliveryMethod": "Email",
  "AttachEpodToInvoice": 1,
  "CurrencyType": "USD",
  "FactoringCompany": false,
  "FactoringEntityId": null,
  "PORequired": true,
  "DOT": "DOT123456",
  "FederalTaxID": "12-3456789",
  "IsTerminal": false,
  "IsShipper": true,
  "IsCarrier": false,
  "Email": "contact@acme.com",
  "InvoiceEmail": "billing@acme.com",
  "CreditStatus": "Approved",
  "CreditLimit": 50000.00,
  "DefaultPaymentMethod": "Net30",
  "ClientTypes": ["Shipper", "Consignor"],
  "Keys": [
    {
      "KeyType": "CustomerCode",
      "KeyValue": "ACME",
      "Domain": "VLMS"
    }
  ],
  "PrimaryAddress": {
    "Address1": "123 Main St",
    "Address2": "Suite 100",
    "City": "Chicago",
    "State": "IL",
    "Zip": "60601",
    "Country": "USA",
    "GeoCodeLatitude": 41.8781,
    "GeoCodeLongitude": -87.6298
  },
  "MailingAddress": {
    "Address1": "PO Box 1234",
    "Address2": null,
    "City": "Chicago",
    "State": "IL",
    "Zip": "60601",
    "Country": "USA",
    "GeoCodeLatitude": null,
    "GeoCodeLongitude": null
  },
  "TimeZoneId": "America/Chicago",
  "PrimaryPhoneNumber": "555-1234",
  "CellPhoneNumber": "555-5678",
  "WorkPhoneNumber": "555-9012",
  "FaxNumber": "555-3456",
  "WebSite": "https://www.acme.com",
  "BusinessHours": "Mon-Fri 8AM-5PM",
  "UpdatedAt": "2025-12-01T14:00:00Z",
  "TrailerLoadPickSeconds": 1800,
  "TrailerLoadLiveSeconds": 3600,
  "TrailerUnloadDropSeconds": 900,
  "TrailerUnloadLiveSeconds": 2700,
  "TrailerTimeToUnloadSeconds": 1800
}
ClientContactUpdated
Contact updated
Triggered when a client contact is updated.
{
  "ClientContactId": 500,
  "ClientId": 100,
  "ContactType": "Primary",
  "Preference": "Email",
  "FirstName": "Jane",
  "LastName": "Smith",
  "Email": "jane.smith@acme.com",
  "PrimaryPhone": "555-1111",
  "CellPhone": "555-2222",
  "WorkPhone": "555-3333",
  "Disabled": false,
  "UpdatedAt": "2025-12-01T14:00:00Z",
  "LastUpdateBy": 25
}
AddressUpdated
Address updated
Triggered when a client address is updated.
{
  "ClientId": 100,
  "Latitude": 41.8781,
  "Longitude": -87.6298,
  "TimeZone": "America/Chicago",
  "Customer": "Acme Corporation"
}
Carrier Payable Events Domain: CarrierPayable
CarrierPayableApproved
Approved
Triggered when a carrier payable is approved.
{
  "PayableNumber": "PAY-2025-001234",
  "LoadId": 5000,
  "OrderIds": [12345, 12346]
}
Also: CarrierPayableRejected and CarrierPayableDeleted use the same structure.
Invoice Events Domain: InvoiceBatch / Invoice
InvoiceBatchCreated
Batch created
Triggered when an invoice batch is created.
{
  "InvoiceBatchId": 3000,
  "ClientId": 100,
  "InvoiceIds": [4001, 4002, 4003]
}
OrderTransactionsDeactivated
Transactions deactivated
Triggered when order transactions are deactivated.
{
  "InvoiceId": 4001,
  "OrderId": 12345,
  "DeactivatedByUserId": 25,
  "DeactivatedDate": "2025-12-01T14:00:00Z"
}
Expense Events Domain: Expense / ExpenseSource
ExpenseCreated
Created
Triggered when an expense is created.
{
  "ExpenseId": 6000,
  "AccountId": 75,
  "Entity": "Driver",
  "AccountCode": "DRV-EXP",
  "Date": "2025-12-01T00:00:00Z",
  "Type": "Fuel",
  "Amount": 150.00,
  "InterestAmount": 0.00,
  "Item": "Fuel Purchase",
  "Comment": "Fuel stop in Kansas City",
  "EffectiveDate": "2025-12-01T00:00:00Z",
  "PostDate": null,
  "CreatedBy": 25,
  "ReferenceNo": "FUEL-001",
  "OriginalExpenseId": null
}
ExpenseUpdated
Updated
Triggered when an expense is updated.
{
  "ExpenseId": 6000,
  "AccountId": 75,
  "Entity": "Driver",
  "AccountCode": "DRV-EXP",
  "Date": "2025-12-01T00:00:00Z",
  "Type": "Fuel",
  "Amount": 155.00,
  "InterestAmount": 0.00,
  "Item": "Fuel Purchase",
  "Comment": "Fuel stop in Kansas City - corrected amount",
  "EffectiveDate": "2025-12-01T00:00:00Z",
  "PostDate": null,
  "CreatedBy": 25,
  "ReferenceNo": "FUEL-001",
  "OriginalExpenseId": null,
  "UpdatedBy": 26
}
ExpenseDeleted
Deleted
Triggered when an expense is deleted.
{
  "ExpenseId": 6000,
  "AccountId": 75,
  "Entity": "Driver",
  "AccountCode": "DRV-EXP",
  "Date": "2025-12-01T00:00:00Z",
  "Type": "Fuel",
  "Amount": 155.00,
  "InterestAmount": 0.00,
  "Item": "Fuel Purchase",
  "Comment": "Fuel stop in Kansas City - corrected amount",
  "EffectiveDate": "2025-12-01T00:00:00Z",
  "PostDate": null,
  "CreatedBy": 25,
  "ReferenceNo": "FUEL-001",
  "OriginalExpenseId": null,
  "DeletedBy": 26
}
ExpenseLoanSourceStatusChanged
Domain: ExpenseSource
Triggered when expense loan source status changes.
{
  "Id": 7000,
  "Name": "Equipment Loan",
  "Status": "Active",
  "ExpenseType": "Loan",
  "ExpenseItem": "Equipment",
  "StartDate": "2025-01-01T00:00:00Z",
  "UserId": 75
}
Payroll Events Domain: PayrollBatch
PayrollBatchClosed
Closed
Triggered when a payroll batch is closed.
{
  "PayrollBatchId": 8000,
  "ClientId": 100,
  "CloseDate": "2025-12-15T00:00:00Z"
}
PayrollBatchReopened
Reopened
Triggered when a payroll batch is reopened.
{
  "PayrollBatchId": 8000,
  "ClientId": 100
}
Equipment Events Domain: Equipment
EquipmentLocationAdded
Location added
Triggered when equipment location is added.
{
  "Id": 9000,
  "AssociatedOrderId": 12345,
  "ChassisIds": [101, 102],
  "ContainerIds": [201],
  "TrailerIds": [60],
  "TruckIds": [50],
  "CreatedAt": "2025-12-01T14:00:00Z",
  "CreatedBy": "jsmith",
  "Description": "Equipment staged at Chicago yard",
  "IsSystemCreated": false,
  "LocationClientId": 200,
  "Purpose": "Staging",
  "Longitude": -87.6298,
  "Latitude": 41.8781
}
Also: EquipmentLocationUpdated and EquipmentLocationDeleted use the same structure.
Voyage Events Domain: Voyage
OrderAssignedToVoyage
Assigned
Triggered when an order is assigned to a voyage.
{
  "OrderId": 12345,
  "VoyageId": 500,
  "PlaceOfReceipt": "Los Angeles, CA",
  "PortOfLoad": "Long Beach",
  "PortOfDelivery": "Yokohama",
  "PlaceOfDelivery": "Tokyo, Japan",
  "DropOffFirstName": "Taro",
  "DropOffLastName": "Yamada",
  "DropOffEmail": "taro@example.jp",
  "DropOffPhone": "+81-3-1234-5678",
  "PickupFirstName": "John",
  "PickupLastName": "Smith",
  "PickupEmail": "john@acme.com",
  "PickupPhone": "555-1234"
}
OrderRemovedFromVoyage
Removed
Triggered when an order is removed from a voyage. Same structure as OrderAssignedToVoyage.
OrderVoyageChanged
Changed
Triggered when an order's voyage assignment changes.
{
  "OrderId": 12345,
  "VoyageId": 501,
  "PriorVoyageId": 500,
  "PlaceOfReceipt": "Los Angeles, CA",
  "PortOfLoad": "Long Beach",
  "PortOfDelivery": "Yokohama",
  "PlaceOfDelivery": "Tokyo, Japan",
  "DropOffFirstName": "Taro",
  "DropOffLastName": "Yamada",
  "DropOffEmail": "taro@example.jp",
  "DropOffPhone": "+81-3-1234-5678",
  "PickupFirstName": "John",
  "PickupLastName": "Smith",
  "PickupEmail": "john@acme.com",
  "PickupPhone": "555-1234"
}
VoyageUpdated
Voyage updated
Triggered when a voyage is updated.
{
  "VoyageId": 500,
  "VoyageNumber": "VOY-2025-001",
  "OrderIds": [12345, 12346, 12347]
}
Truck Events Domain: Truck
TruckUpdated
Truck updated
Triggered when truck information is updated.
{
  "TruckId": 50,
  "ClientId": 100,
  "DriverId": 75,
  "CapacityCategory": "Large",
  "Status": "Active",
  "TruckType": "Semi",
  "CompanyOwned": true,
  "HasGpsLatLon": true,
  "Enclosed": true,
  "Floors": true,
  "Curtains": false,
  "IsCarbCompliant": true,
  "GpsDateTime": "2025-12-01T14:00:00Z",
  "GpsObdDateTime": "2025-12-01T14:00:00Z",
  "PreventMaintDueDateTime": "2026-01-15T00:00:00Z",
  "KilometersPerLiter": 3.5,
  "MaintPerKm": 0.05,
  "GpsEngineHoursRaw": "12500",
  "GpsEngineHours": 12500.0,
  "MilesPerGal": 8.5,
  "MaintPerMile": 0.08,
  "DepreciationPerDay": 50.00,
  "AdminOverheadPerDay": 25.00,
  "InsurancePerDay": 15.00,
  "CapacityVsf": 2500.0,
  "GpsOdometer": 450000.0,
  "PriorityVsfCapacity": 2400.0,
  "PreventMaintEngineHours": 15000.0,
  "DistanceUnit": "Miles",
  "Capacity": 8,
  "MdtId": "MDT-050",
  "LiftGateEquipped": 0,
  "Weight": 18000,
  "CapacityWeight": 45000,
  "PreventMaintOdomThresh": 500000,
  "PreventMaintWarnDays": 30,
  "PreventMaintWarnOdom": 10000,
  "HomeZip": "60601",
  "Description": "2022 Peterbilt 579",
  "RGeoCodeLocation": "Chicago, IL",
  "State": "IL",
  "Vin": "1XPWD40X1ED123456",
  "AssetNumber": "TRK-050",
  "AccountingId": "TRUCK050",
  "Location": "Chicago Yard",
  "LicenseNumber": "IL-12345",
  "LicenseExpiration": "2026-06-30T00:00:00Z",
  "TrailerNumber": "TRL-060",
  "TrailerPlateNumber": "TRL12345",
  "Comment": "Primary long-haul truck",
  "EldProvider": "KeepTruckin",
  "IndicatorColor": "Blue",
  "NumberOfAxles": 3,
  "FuelTankCapacityGallons": 300.0,
  "RunningCostPerMile": 1.85,
  "TareWeightDryLbs": 18000.0,
  "TotalTareWeightLbs": 19500.0,
  "GrossWeightLbs": 80000.0,
  "LicensedState": "IL",
  "IsRental": false,
  "RentalStartDate": null,
  "RentalEndDate": null,
  "LienHolderName": null,
  "TollTransponderNumber": "EZP-123456",
  "AnnualInspectionExpiration": "2026-03-15T00:00:00Z",
  "Longitude": -87.6298,
  "Latitude": 41.8781
}
TruckGPSUpdate
GPS update
Triggered when truck GPS position is updated.
{
  "TruckId": 50,
  "Latitude": 41.8781,
  "Longitude": -87.6298,
  "GPSDateTime": "2025-12-01T14:00:00Z",
  "DriverId1": 75,
  "DriverId2": null,
  "TrailerId1": 60,
  "TrailerId2": null
}
Trailer Events Domain: Trailer
TrailerUpdated
Trailer updated
Triggered when trailer information is updated.
{
  "TrailerId": 60,
  "OwnerType": "Company",
  "ClientId": 100,
  "GpsDateTime": "2025-12-01T14:00:00Z",
  "InServiceDate": "2022-01-15T00:00:00Z",
  "ManufactureDate": "2021-11-01T00:00:00Z",
  "OutOfServiceDate": null,
  "EquipmentType": "DryVan",
  "DriverId": 75,
  "Capacity": 8,
  "Height": 110,
  "Length": 53,
  "ModelYear": 2022,
  "NumberOfAxles": 2,
  "Weight": 14000,
  "Width": 102,
  "AssetNumber": "TRL-060",
  "AccountingId": "TRAILER060",
  "Description": "53ft Dry Van",
  "GpsLatRaw": "41.8781",
  "GpsLonRaw": "-87.6298",
  "GpsAddress": "123 Main St",
  "GpsCityStateZip": "Chicago, IL 60601",
  "LicenseNumber": "TRL12345",
  "LicenseState": "IL",
  "LicenseExpiration": "2026-06-30T00:00:00Z",
  "Location": "Chicago Yard",
  "Make": "Utility",
  "Model": "4000D-X",
  "PowerUnit": "TRK-050",
  "State": "IL",
  "Vin": "1UYVS2530MU123456",
  "Status": "Active",
  "TrailerType": "DryVan",
  "RentalStartDate": null,
  "RentalEndDate": null,
  "LienHolderName": null,
  "MdtId": "MDT-060",
  "EldProvider": "KeepTruckin",
  "AnnualInspectionDueDate": "2026-03-15T00:00:00Z",
  "PmDueDate": "2026-01-15T00:00:00Z",
  "PmDueDateWarningDays": 30,
  "LocationUpdatedAt": "2025-12-01T14:00:00Z",
  "LocationSource": "GPS",
  "LocationLat": 41.8781,
  "LocationLon": -87.6298,
  "LocationAddress1": "123 Main St",
  "LocationAddress2": null,
  "LocationCity": "Chicago",
  "LocationZip": "60601",
  "AnnualInspectionLastDateTime": "2025-03-15T00:00:00Z",
  "PmLastDateTime": "2025-07-15T00:00:00Z",
  "TrailerCurrentValue": 35000.00,
  "OwnerName": "Acme Transport"
}
Appointment Events Domain: Appointment
AppointmentStatusChanged
Status changed
Triggered when an appointment status changes.
{
  "OrderId": 12345,
  "AppointmentId": 2000,
  "Status": "Confirmed",
  "AppointmentDateTime": "2025-12-15T08:00:00Z",
  "VIN": "1HGBH41JXMN109186",
  "AppointmentType": "Pickup",
  "Location": "Chicago Yard"
}
Configuration Events Domain: LcsConfig
LcsConfigUpdated
Config updated
Triggered when load chain service configuration is updated.
{
  "DefaultTrailerLoadPickSeconds": 1800,
  "DefaultTrailerLoadLiveSeconds": 3600,
  "DefaultTrailerUnloadDropSeconds": 900,
  "DefaultTrailerUnloadLiveSeconds": 2700,
  "DefaultTrailerTimeToUnloadSeconds": 1800
}