Models P–R

Data models used in RushHour API requests and responses. Property names are shown as the API sends them. See the API reference overview for how enumerated values are written.

PalletDiscountDto

Property	Type	Description
palletCount	integer (int32)
discountPercentage	number (double)
customizations	integer (int32)	Can be null. One of: 1 (CustomBase), 2 (CustomSameDay). Values can be combined by adding them together.

PalletMileagePriceDto

Property	Type	Description
palletCount	integer (int32)
minMileage	integer (int32)
maxMileage	integer (int32)
price	number (double)
isCustom	boolean
customizations	integer (int32)	Can be null. One of: 1 (CustomBase), 2 (CustomSameDay). Values can be combined by adding them together.

Payment

Property	Type	Description
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
createdCompanyUser	CompanyUser
updatedCompanyUser	CompanyUser
date	string (date-time)	Can be null.
companyId	integer (int32)
tenantId	string (uuid)
customerId	integer (int32)
company	Company
tenant	object
customer	Customer
billToDetails	string	Can be null.
status	string	One of: Draft, Approved, Open, Paid, Overdue, PartialPaid, Deleted.
sentEmailStatus	integer (int32)	One of: 1 (Sent), 2 (NotSent), 4 (Edited). Values can be combined by adding them together.
exportQbStatus	integer (int32)	One of: 1 (Exported), 2 (NotExported), 4 (Edited). Values can be combined by adding them together.
downloadStatus	integer (int32)	One of: 1 (Downloaded), 2 (NotDownloaded), 4 (Edited). Values can be combined by adding them together.
calculationCustomerBalanceStatus	string	One of: Included, Excluded.
inQb	boolean
number	string	Can be null.
currencyCode	string	Can be null. Up to 3 characters.
fxRateToCompanyDefault	number (double)	Can be null.
fxRateDate	string (date-time)	Can be null.
notes	string	Can be null.
commonNotes	string	Can be null.
appliedPayments	array of AppliedPayment	Can be null.
isDefault	boolean
tnxType	string	One of: Invoice, Payment.
id	integer (int32)
lineCount	integer (int32)
totalAmount	number (double)
amountPaid	number (double)
balance	number (double)	Read-only.
sentEmails	array of SentEmail	Can be null.
referenceId	integer (int32)	Can be null.
downloadCount	integer (int32)
lastDownloadedAt	string (date-time)	Can be null.
orderTripStatus	string	Can be null. One of: Open, Assigned, InTransit, Delivered.
transactionPaymentStatus	string	Read-only. One of: Draft, Approved, Open, Paid, Overdue, PartialPaid, Deleted.
orderStatus	string	Can be null. One of: Dreft, Quote, Order, Deleted, Closed.
orderId	integer (int32)	Can be null.
orderNumber	string	Can be null.
invoiceIds	array of integer (int32)	Can be null.
quickbooksSyncState	integer (int32)	One of: 0 (NotSent), 1 (Synced), 2 (Retrying), 3 (Failed).
paymentId	integer (int32)
paymentAmount	number (double)
isDeleted	boolean
paymentMethodType	integer (int32)	One of: 0 (Check), 1 (Cash), 2 (PaymentMethod).
paymentMethod	CustomerPaymentMethod
gatewayRef	string	Can be null.
refrence	string	Can be null.
paymentMethodId	integer (int32)	Can be null.
depositAccountId	integer (int32)	Can be null.
depositAccount	DepositAccount

PerCftPrice

Property	Type	Description
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
createdCompanyUser	CompanyUser
updatedCompanyUser	CompanyUser
perCftPriceId	integer (int32)
shipmentType	ShipmentType
price	number (double)
from	integer (int32)
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
shipmentTypeId	integer (int32)	Can be null.

PerHourPrice

Property	Type	Description
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
createdCompanyUser	CompanyUser
updatedCompanyUser	CompanyUser
perHourPriceId	integer (int32)
shipmentType	ShipmentType
price	number (double)
from	integer (int32)
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
shipmentTypeId	integer (int32)	Can be null.

PerLbPrice

Property	Type	Description
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
createdCompanyUser	CompanyUser
updatedCompanyUser	CompanyUser
perLbPriceId	integer (int32)
shipmentType	ShipmentType
price	number (double)
from	integer (int32)
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
shipmentTypeId	integer (int32)	Can be null.

PerMilePrice

Property	Type	Description
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
createdCompanyUser	CompanyUser
updatedCompanyUser	CompanyUser
perMilePriceId	integer (int32)
shipmentType	ShipmentType
price	number (double)
from	integer (int32)
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
shipmentTypeId	integer (int32)	Can be null.

PermissionDto

Property	Type	Description
permissionId	integer (int32)
name	string	Can be null.
displayName	string	Can be null.

PlaceHoldDto

Property	Type	Description
reason	string	Can be null.

PostalCodeDto

Property	Type	Description
postalCode	string	Can be null.
placeName	string	Can be null.
adminName	string	Can be null.
latitude	number (double)	Can be null.
longitude	number (double)	Can be null.
isPrimary	boolean

PostalCodeValidationDto

Property	Type	Description
postalCode	string	Can be null.
isValidFormat	boolean
isKnown	boolean
belongsToSelectedCity	boolean	Can be null.
knownCities	array of string	Can be null.
isAuthoritative	boolean
warning	string	Can be null.

PriceOfferDto

Property	Type	Description
customerId	integer (int32)
price	number (double)
isPriceOffer	boolean
isAccepted	boolean
isRejected	boolean
replyToMessageId	integer (int32)	Can be null.
quoteNumber	string	Can be null.
callbackUrl	string	Can be null.

PricingIntlRateBreakDto

Property	Type	Description
id	integer (int32)
minQty	number (double)
maxQty	number (double)
ratePerUnit	number (double)	Can be null.
ratePerUnitMax	number (double)	Can be null.
flatPrice	number (double)	Can be null.
flatPriceMax	number (double)	Can be null.
firstUnitPrice	number (double)	Can be null.
additionalUnitPrice	number (double)	Can be null.
minCharge	number (double)	Can be null.
sortOrder	integer (int32)
needsReview	boolean

PricingIntlRateDto

Property	Type	Description
id	integer (int32)
name	string	Can be null.
mode	string	One of: Ground, Ocean, Air.
effectiveFrom	string (date-time)	Can be null. Validity window, both bounds optional.
effectiveTo	string (date-time)	Can be null.
originCountryId	integer (int32)
destinationCountryId	integer (int32)
originZoneId	integer (int32)	Can be null.
destinationZoneId	integer (int32)	Can be null.
qtyBasis	string	One of: Pallets, ChargeableKg, Pieces, Cbm, Containers.
leg	string	One of: Composite, OriginPickup, Transport, DestinationDelivery.
weightRounding	string	One of: None, UpHalfKg, UpKg.
weightBreakDownCharge	boolean
deliveryOverageInteraction	string	One of: Additive, AreaReplacesOverage.
isInherited	boolean
currencyCode	string	Can be null.
minimumCharge	number (double)	Can be null.
fuelSurchargePercent	number (double)	Can be null.
includedPickups	integer (int32)
includedDeliveries	integer (int32)
includedWeightKg	number (double)	Can be null.
volumetricDivisor	integer (int32)	Can be null.
rangePolicy	string	One of: ChargeHigh, ChargeLow, ChargeMid, RequireConfirmation.
priority	integer (int32)
enabled	boolean
needsReview	boolean
reviewNotes	string	Can be null.
notes	string	Can be null.
sourceDocumentId	integer (int32)	Can be null.
breaks	array of PricingIntlRateBreakDto	Can be null.
sizeMultipliers	array of PricingIntlSizeMultiplierDto	Can be null.
surcharges	array of PricingIntlSurchargeDto	Can be null.

PricingIntlSizeMultiplierDto

Property	Type	Description
id	integer (int32)
sizeClass	string	One of: Standard, Medium, Large, Oversize.
upliftPercent	number (double)
upliftPercentMax	number (double)	Can be null.
description	string	Can be null.
needsReview	boolean
maxLengthCm	number (double)	Can be null.
maxWidthCm	number (double)	Can be null.
maxHeightCm	number (double)	Can be null.

PricingIntlSurchargeDto

A freight-side surcharge or inclusion overage.

Property	Type	Description
id	integer (int32)
label	string	Can be null.
scope	string	One of: Shipment, FirstUnit, EachUnit, PerLocation.
amount	number (double)	Can be null.
amountMax	number (double)	Can be null.
percent	number (double)	Can be null.
percentMax	number (double)	Can be null.
pricingZoneId	integer (int32)	Can be null.
appliesAt	string	One of: Any, OriginOnly, DestinationOnly.
percentBasis	string	One of: Freight, DeclaredValue.
minAmount	number (double)	Can be null.
maxAmount	number (double)	Can be null.
additionalUnitAmount	number (double)	Can be null.
areaOutcome	string	One of: Charge, Included, PriceUponRequest.
overageKind	string	One of: None, ExtraPickup, ExtraDelivery, ExcessWeightKg.
enabled	boolean
needsReview	boolean
sortOrder	integer (int32)

PricingModelDto

Property	Type	Description
id	integer (int32)	Can be null.
companyId	integer (int32)
customerId	integer (int32)	Can be null.
isDefault	boolean
fuelSurchargePercentage	number (double)	Can be null.
sameDayShippingPercentage	number (double)	Can be null.
rushFixedAmount	number (double)	Can be null.
rushPercentage	number (double)	Can be null.
palletDiscounts	array of PalletDiscountDto	Can be null.
mileageCharges	array of MileageChargeDto	Can be null.
palletMileagePrices	array of PalletMileagePriceDto	Can be null.
laneRates	array of PricingModelLaneRateDto	Can be null.
zoneRates	array of PricingModelZoneRateDto	Can be null.
currencyCode	string	Can be null. The iso-4217 currency this rate card is quoted in.
intlResolution	string	One of: Fork, Merge.
intlModeStrictness	string	One of: Permissive, Strict.
intlRates	array of PricingIntlRateDto	Can be null. International (cross-border) lane cards.
supportsPalletsOnly	boolean
maxSupportedMileage	integer (int32)	Can be null.

PricingModelLaneRateDto

Property	Type	Description
originText	string	Can be null.
destinationText	string	Can be null.
pricePerPallet	number (double)	Can be null.
flatPrice	number (double)	Can be null.
minPallets	integer (int32)	Can be null.
maxPallets	integer (int32)	Can be null.
enabled	boolean
notes	string	Can be null.

PricingModelZoneRateDto

Property	Type	Description
originZoneId	integer (int32)
destinationZoneId	integer (int32)
pricePerPallet	number (double)	Can be null.
flatPrice	number (double)	Can be null.
minPallets	integer (int32)	Can be null.
maxPallets	integer (int32)	Can be null.
enabled	boolean
notes	string	Can be null.

PricingZoneDto

Property	Type	Description
id	integer (int32)	Can be null.
name	string	Can be null.
countryId	integer (int32)	Can be null.
members	array of PricingZoneMemberDto	Can be null.
shapes	array of PricingZoneShapeDto	Can be null.

PricingZoneMemberDto

Property	Type	Description
matchType	string	One of: Zip5, ZipPrefix, City, CountryIso, Polygon.
value	string	Can be null.

PricingZoneShapeDto

Property	Type	Description
id	integer (int32)	Can be null.
name	string	Can be null.
geoJson	string	Can be null.

QuickbooksInvoiceSendBatchResult

Per-record outcome for a manual QuickBooks invoice batch.

Property	Type	Description
requestedInvoiceNumbers	array of string	Read-only. Can be null.
sentInvoiceNumbers	array of string	Read-only. Can be null.
rejectedInvoiceNumbers	array of string	Read-only. Can be null.
retryingInvoiceNumbers	array of string	Read-only. Can be null. Invoices awaiting the automatic retry after a transient QuickBooks conflict.
failedInvoiceNumbers	array of string	Read-only. Can be null.
skippedInvoiceNumbers	array of string	Read-only. Can be null.
sentPaymentNumbers	array of string	Read-only. Can be null.
rejectedPaymentNumbers	array of string	Read-only. Can be null.
retryingPaymentNumbers	array of string	Read-only. Can be null. Related payments awaiting the automatic retry after a transient QuickBooks conflict.
failedPaymentNumbers	array of string	Read-only. Can be null.

QuickbooksPaymentSendBatchResult

Per-record outcome for a manual QuickBooks payment batch.

Property	Type	Description
requestedPaymentNumbers	array of string	Read-only. Can be null.
sentPaymentNumbers	array of string	Read-only. Can be null.
rejectedPaymentNumbers	array of string	Read-only. Can be null.
retryingPaymentNumbers	array of string	Read-only. Can be null. Payments awaiting the automatic retry after a transient QuickBooks conflict.
failedPaymentNumbers	array of string	Read-only. Can be null.
skippedPaymentNumbers	array of string	Read-only. Can be null.

QuoteWarehousesRequest

Property	Type	Description
pickup	OrderStop
delivery	OrderStop

Reaction

Property	Type	Description
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
createdCompanyUser	CompanyUser
updatedCompanyUser	CompanyUser
reactionId	integer (int32)
tenantId	string (uuid)
companyId	integer (int32)
customerMessageId	integer (int32)
userId	string	Can be null.
code	string	Can be null.

ReceiptExpenseConfirmRequest

Property	Type	Description
documentId	integer (int32)
receipt	ReceiptExtractionResult
categoryId	integer (int32)	Can be null.
vendorId	integer (int32)	Can be null.
truckId	integer (int32)	Can be null.
driverId	integer (int32)	Can be null.
orderId	integer (int32)	Can be null.
routeId	integer (int32)	Can be null.
isBillableToOrder	boolean	Re-bill this cost to the order.
notes	string	Can be null.

ReceiptExpenseDraftDto

Property	Type	Description
expenseId	integer (int32)
amount	number (double)
currencyCode	string	Can be null.
date	string (date-time)
categoryId	integer (int32)	Can be null.
type	integer (int32)	One of: 0 (Trucks), 1 (DriverRoutePayout), 2 (OutsourceCompanyRoutePayout), 3 (Office).
subtype	integer (int32)	One of: 0 (TruckGas), 1 (TruckInsurance), 2 (TruckMaintenance), 3 (TruckPayment), 4 (TruckTrailer), 5 (TruckLicense), 6 (TruckTool), 7 (TruckOther), 8 (TruckMiles), 9 (OdometerStart), 10 (OdometerEnd), 100 (OfficeGPS), 101 (OfficeInternet), 102 (OfficeOther).
approvalStatus	string	One of: Approved, Draft, Submitted, Rejected.
source	string	One of: MonthlyGrid, Manual, Mobile, Receipt, FuelCardImport, Recurring, Api, Import.
sourceDocumentId	integer (int32)	Can be null.
vendorNameSnapshot	string	Can be null.
isIftaEligible	boolean

ReceiptExtractionResult

What the AI read off one uploaded receipt.

Property	Type	Description
companyDocumentId	integer (int32)
vendorName	string	Can be null. Merchant name as printed.
vendorAddress	string	Can be null.
vendorCity	string	Can be null.
vendorState	string	Can be null.
purchaseDate	string (date-time)	Can be null. The transaction date, UTC-normalised.
total	number (double)	Can be null.
currencyCode	string	Can be null.
taxAmount	number (double)	Can be null.
paymentMethod	string	Can be null. One of: Unspecified, Cash, CreditCard, FuelCard, Check, Ach, Comchek, DriverAdvance, Other.
referenceNumber	string	Can be null. Invoice / transaction / trip number printed on the receipt.
categoryHint	string	Can be null.
categoryId	integer (int32)	Can be null.
categoryName	string	Can be null.
odometerReading	number (double)	Can be null. Odometer/hubometer reading if the receipt prints one.
fuel	object	Null when this is not a fuel purchase.
lineItems	array of ReceiptLineItem	Can be null.
confidence	number (double)

ReceiptLineItem

One printed line of a receipt.

Property	Type	Description
description	string	Can be null.
amount	number (double)	Can be null.

RecipientSuggestionDto

Property	Type	Description
email	string	Can be null.
name	string	Can be null.
source	string	Can be null.

RejectAccessRequestDto

Property	Type	Description
reason	string	Can be null.

RenameCompanyDocumentDto

Property	Type	Description
name	string	Can be null.

ReplaceOrCreateNewInvoiceRequest

Property	Type	Description
isReplace	boolean
isUpdate	boolean
isCreateNewAdditionalInvoice	boolean

ReprocessCompanyDocumentDto

Property	Type	Description
forceOcr	boolean
ocrModel	string	Can be null.

ResolveHoldDto

Property	Type	Description
note	string	Can be null.

RevenueTrendDto

Property	Type	Description
days	integer (int32)
labels	array of string	Can be null. Yyyy-MM-dd per day, oldest first.
data	array of number (double)	Can be null.
total	number (double)

RoleDto

Property	Type	Description
appRoleId	string	Can be null.
name	string	Can be null.
description	string	Can be null.
permissions	array of RolePermissionDto	Can be null.

RoleDtoPagedList

A page of results. See Pagination and filtering.

Property	Type	Description
list	array of RoleDto	Can be null.
page	integer (int32)
itemsPerPage	integer (int32)
totalCount	integer (int32)

RolePermissionDto

Property	Type	Description
appRoleId	string	Can be null.
permissionId	integer (int32)
hasAccess	boolean
displayName	string	Can be null.

Route

Property	Type	Description
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
createdCompanyUser	CompanyUser
updatedCompanyUser	CompanyUser
routeId	integer (int32)
companyId	integer (int32)
tenantId	string (uuid)
tenant	object
company	Company
name	string	Can be null.
driverId	integer (int32)	Can be null.
driver	Driver
truck	Truck
zoneId	integer (int32)	Can be null.
zone	Zone
truckId	integer (int32)	Can be null.
routeItems	array of RouteItem	Can be null.
routeStopGroups	array of RouteItemGroup	Can be null.
directionsHash	string	Can be null.
directionsJson	string	Can be null.
aiOptimizedSignature	string	Can be null.
directions	object
chatId	integer (int32)	Can be null.
isChat	boolean
unreadCount	integer (int32)
millage	number (double)
duration	number (double)
isActive	boolean
avoidTolls	boolean
status	string	Can be null. One of: Active, Pending, Completed, Archive.
nextActiveCreatedTime	string (date-time)	Can be null.

RouteCardDto

Property	Type	Description
routeCardId	integer (int32)
routeId	integer (int32)
driverId	integer (int32)
payout	number (double)
millage	number (double)
duration	number (double)
driverType	string	One of: Default, Outsource, Mixed.
routeCardStopsType	string	One of: None, SameOrder, DifferentOrders.
outsourceCompanyFinanceId	integer (int32)	Can be null.
truckId	integer (int32)	Can be null.
outsourceCompanyId	integer (int32)	Can be null.
startOrderStopId	integer (int32)	Can be null.
startOrderId	integer (int32)	Can be null.
endOrderStopId	integer (int32)	Can be null.
endOrderId	integer (int32)	Can be null.
startPlannedDate	string (date-time)	Can be null.
startActualDate	string (date-time)	Can be null.
endPlannedDate	string (date-time)	Can be null.
endActualDate	string (date-time)	Can be null.
name	string	Can be null.
avatar	string	Can be null.
startLocationCompanyName	string	Can be null.
startAddress	string	Can be null.
endLocationCompanyName	string	Can be null.
endAddress	string	Can be null.
truckName	string	Can be null.
truckPlateNumber	string	Can be null.
truckType	string	Can be null.
driverPayoutType	string	Can be null. One of: Hourly, FixedSalary, Distance, FixDistance, FixHourly, Percent, DistanceAndPercent, FixedCost, Pallets.

RouteCardListDto

Property	Type	Description
orderId	integer (int32)
millage	number (double)
duration	number (double)
payout	number (double)
companyProfit	number (double)	Can be null.
driverType	string	One of: Default, Outsource, Mixed.
startOrderStopId	integer (int32)	Can be null.
endOrderStopId	integer (int32)	Can be null.
endLocationCompanyName	string	Can be null.
endAddress	string	Can be null.
startLocationCompanyName	string	Can be null.
startAddress	string	Can be null.
startPlannedDate	string (date-time)	Can be null.
startActualDate	string (date-time)	Can be null.
endPlannedDate	string (date-time)	Can be null.
endActualDate	string (date-time)	Can be null.
routeCardsDtos	array of RouteCardDto	Can be null.

RouteItem

Property	Type	Description
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
createdCompanyUser	CompanyUser
updatedCompanyUser	CompanyUser
routeItemId	integer (int32)
routeId	integer (int32)	Can be null.
route	Route
orderItem	OrderItem
orderItemId	integer (int32)	Can be null.
orderStopId	integer (int32)	Can be null.
transferStopId	integer (int32)	Can be null.
driverId	integer (int32)	Can be null.
orderItemStopId	integer (int32)	Can be null.
truckId	integer (int32)	Can be null.
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
orderItemStop	OrderItemStop
orderStop	OrderStop
transferStop	TransferStop
sortOrder	integer (int32)
type	string	One of: Pickup, DeliveryToTransfer, PickupFromTransfer, Delivery.
quantity	integer (int32)
status	integer (int32)	One of: 0 (ToDo), 1 (Done), 2 (Pending).
date	string (date-time)	Can be null.
time	string (date-time)	Can be null.
dateTime	string (date-time)
isActive	boolean
driver	Driver
truck	Truck
arrivalDateTime	string (date-time)	Can be null.
departureDateTime	string (date-time)	Can be null.
arrivalDateUpdatedOn	string (date-time)	Can be null.
notes	string	Can be null.
freeWaitingTime	integer (int32)
waitingTime	string	Can be null.
routeItemCharges	array of RouteItemCharge	Can be null.
isCorrectionUpdate	boolean	Can be null.
displayStatus	string	Read-only. One of: OnTime, PickedUp, PickedUpFromTransfer, Late, Delivered, DeliveredToTransfer.
isHasAnyDelivery	boolean
isAssignedAnyDelivery	boolean
pickQuantity	integer (int32)
qtyToPickup	integer (int32)	Read-only.
qtyPickedUp	integer (int32)	Read-only.
qtyToDeliver	integer (int32)	Read-only.
qtyDelivered	integer (int32)	Read-only.
totalQtyByRoute	map of integer (int32)	Read-only. Can be null.
assignPickup	boolean	Read-only.
assignDelivery	boolean	Read-only.
canHaveDelivery	boolean	Read-only.
assignTransfer	boolean	Read-only.
isInternational	boolean	Read-only.
assignHub	boolean	Read-only.
allocateItems	boolean	Read-only.
allocatePickupItems	boolean	Read-only.
allocateDeliveryItems	boolean	Read-only.
createDelivery	boolean	Read-only.
getTransferRouteItem	RouteItem

RouteItemCharge

Property	Type	Description
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
createdCompanyUser	CompanyUser
updatedCompanyUser	CompanyUser
routeItemChargeId	integer (int32)
routeItem	RouteItem
chargeType	ChargeType
qty	number (double)
note	string	Can be null.
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
chargeTypeId	integer (int32)	Can be null.
routeItemId	integer (int32)	Can be null.
orderStopId	integer (int32)	Can be null.
priceOverride	number (double)	Can be null.
source	integer (int32)	One of: 0 (Manual), 1 (AutoAccessorial).
sourcePricingInsightId	integer (int32)	Can be null.

RouteItemGroup

Property	Type	Description
routeId	integer (int32)
date	string (date-time)
isToday	boolean	Read-only.
routeItemStops	array of RouteItemStopGroup	Can be null.

RouteItemGroupPagedList

A page of results. See Pagination and filtering.

Property	Type	Description
list	array of RouteItemGroup	Can be null.
page	integer (int32)
itemsPerPage	integer (int32)
totalCount	integer (int32)

RouteItemStopGroup

Property	Type	Description
createdTime	string (date-time)
createdUser	string	Can be null.
updatedTime	string (date-time)	Can be null.
updatedUser	string	Can be null.
createdCompanyUser	CompanyUser
updatedCompanyUser	CompanyUser
orderId	integer (int32)
orderNumber	string	Can be null.
purchaseOrderNumber	string	Can be null.
customer	Customer
customerContact	CustomerContact
sortOrder	integer (int32)
referenceNumber	string	Can be null.
priority	string	Can be null. One of: Low, Regular, High.
type	string	One of: Pickup, DeliveryToTransfer, PickupFromTransfer, Delivery.
status	integer (int32)	One of: 0 (ToDo), 1 (Done), 2 (Pending).
routeItemId	integer (int32)
address	Address
dateType	string	Can be null. One of: None, Today, Tomorrow, Custom.
date	string (date-time)	Can be null.
groupDate	string (date-time)
timeType	string	Can be null. One of: None, Morning, Noon, Evening, Custom.
time	string (date-time)	Can be null.
dateTime	string (date-time)
addressDetails	string	Can be null.
shipmentType	ShipmentType
routeItems	array of RouteItem	Can be null.
charges	array of ChargeType	Can be null.
arrivalDateTime	string (date-time)	Can be null.
departureDateTime	string (date-time)	Can be null.
arrivalDateUpdatedOn	string (date-time)	Can be null.
minDateTime	string (date-time)	Can be null.
maxDateTime	string (date-time)	Can be null.
toPickUp	boolean	Read-only.
assignPickup	boolean	Read-only.
assignDelivery	boolean	Read-only.
assignTransfer	boolean	Read-only.
assignHub	boolean	Read-only.
allocateItems	boolean	Read-only.
allocatePickupItems	boolean	Read-only.
allocateDeliveryItems	boolean	Read-only.
createDelivery	boolean	Read-only.
confirmedWithoutAssignItems	boolean
getTransferRouteItem	RouteItem
freeWaitingTime	integer (int32)
waitingTime	string	Can be null.
orderStop	OrderStop
orderStopId	integer (int32)	Can be null.
transferStopId	integer (int32)	Can be null.
isTransferStop	boolean
transferPairRouteId	integer (int32)	Can be null.
transferStop	TransferStop
routeItemCharges	array of RouteItemCharge	Can be null.
isCorrectionUpdate	boolean	Can be null.
isRouteLast	boolean
displayStatus	string	Read-only. One of: OnTime, PickedUp, PickedUpFromTransfer, Late, Delivered, DeliveredToTransfer.

RouteOptimizationStatus

Property	Type	Description
isOptimizedByDistance	boolean
isOptimizedByPriority	boolean
isOptimizedByAi	boolean

RoutePagedList

A page of results. See Pagination and filtering.

Property	Type	Description
list	array of Route	Can be null.
page	integer (int32)
itemsPerPage	integer (int32)
totalCount	integer (int32)

RouteResponse

Property	Type	Description
route	Route
previousStop	string	Can be null.
nextStop	string	Can be null.
previousStopData	object
nextStopData	object
completedStopsCount	integer (int32)
completedStopsCountUnfiltered	integer (int32)
totalStopsCount	integer (int32)
totalStopsCountUnfiltered	integer (int32)
heldStopsCount	integer (int32)	Number of distinct stops on this route currently on hold.
hasHeldStop	boolean	Read-only. Whether this route has at least one stop on hold.
vehicleUsedCapacity	integer (int32)
vehicleFreeCapacity	integer (int32)	Read-only.
waypoints	array of WaypointDto	Can be null.

RouteResponsePagedList

A page of results. See Pagination and filtering.

Property	Type	Description
list	array of RouteResponse	Can be null.
page	integer (int32)
itemsPerPage	integer (int32)
totalCount	integer (int32)