Models A–B

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.

ActivityNoteDto

Property	Type	Description
note	string	Can be null.

AddMileageChargeRequestDto

Property	Type	Description
minMileage	integer (int32)
maxMileage	integer (int32)
priceForPallet1	number (double)
priceForPallet2	number (double)

Address

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
addressId	integer (int32)
tenantId	string (uuid)
companyId	integer (int32)
outsourceCompanyId	integer (int32)	Can be null.
customerId	integer (int32)	Can be null.
countryId	integer (int32)	Can be null.
autoCountryId	integer (int32)	Can be null.
tenant	object
entityType	integer (int32)	One of: 1 (Customer), 2 (Order), 3 (OrderItem), 4 (OrderStop), 5 (CustomerContact), 6 (CustomerPaymentMethod), 7 (RouteTransfer), 8 (Quotes), 9 (Orders), 10 (Warehouse), 11 (Driver), 12 (TenantPaymentMethod), 13 (Payment), 14 (Invoice), 15 (Route), 16 (Truck), 17 (OutsourceCompany), 18 (OutsourceCompanyContact), 19 (Goods), 20 (Document), 21 (DrivingLog), 22 (Barcode), 23 (Check), 24 (DriverLicense), 25 (InsuranceCard), 26 (RegistrationCard: use the number), 27 (LoadUnit), 28 (LoadUnitContent), 29 (Violation), 30 (DriverStatusCheck), 31 (DriverIssue), 32 (Damage), 33 (FreightPayment).
ext	string	Can be null.
startTimeHoursOfOperation	string (date-time)	Can be null.
endTimeHoursOfOperation	string (date-time)	Can be null.
tag	integer (int32)	One of: 0 (Tag).
name	string	Can be null.
addressLine1	string	Can be null.
addressLine2	string	Can be null.
city	string	Can be null.
state	string	Can be null.
cityId	integer (int32)	Can be null.
stateId	integer (int32)	Can be null.
zip	string	Can be null.
isActive	boolean
gate	string	Can be null.
companyType	string	One of: Customer, Outsource.
companyLocation	string	One of: Office, House.
phoneNumber	string	Can be null.
phoneCountryCode	string	Can be null. Up to 4 characters.
phoneCountryIso	string	Can be null. Up to 3 characters.
appointmentNeeded	boolean
companyName	string	Can be null.
companyPhone	string	Can be null.
notes	string	Can be null.
cityOnly	boolean
instructions	string	Can be null.
isHidden	boolean
deactivatedByCustomerDelete	boolean
hiddenBeforeCustomerDelete	boolean
pipeline	integer (int32)	One of: 0 (Prospect), 1 (Customer), 2 (Lead).
country	object
fullAddress	string	Read-only. Can be null.
googlePlaceId	string	Can be null.
frontEndGroup	string	Read-only. Can be null.
addressDetails	string	Can be null.
latitude	number (double)	Can be null.
longitude	number (double)	Can be null.
googleMapsLink	string	Can be null.
useZipInNormalizedAddressFields	boolean
countryNameFromGoogle	string	Can be null.
normalizedKey	string	Read-only. Can be null.
normalizedFullAddress	string	Read-only. Can be null.

AddressPagedList

A page of results. See Pagination and filtering.

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

AddSupportTicketMessageRequest

Property	Type	Description
text	string	Can be null.

AppliedPayment

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
appliedPaymentId	integer (int32)
payment	Payment
invoice	Invoice
amount	number (double)
isDeleted	boolean
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
paymentId	integer (int32)	Can be null.
invoiceId	integer (int32)	Can be null.

ApproveAccessRequestDto

Every field is an override.

Property	Type	Description
email	string	Can be null.
firstName	string	Can be null.
lastName	string	Can be null.

ArAgingBucketDto

Property	Type	Description
label	string	Can be null.
invoiceCount	integer (int32)
outstanding	number (double)
invoicesWithNoPaymentRecorded	integer (int32)

ArAgingDto

Property	Type	Description
buckets	array of ArAgingBucketDto	Can be null.
totalOutstanding	number (double)
totalInvoices	integer (int32)
invoicesWithNoPaymentRecorded	integer (int32)

AssignHubRequest

Property	Type	Description
hubRequirementId	integer (int32)
pickupOrderStopId	integer (int32)
deliveryOrderStopId	integer (int32)
pickupWarehouseId	integer (int32)	Warehouse the pickup leg delivers to.
deliveryWarehouseId	integer (int32)	Warehouse the delivery leg collects from.

AssignUnassignedStopRequest

Property	Type	Description
orderStopId	integer (int32)
insertAfterRouteItemId	integer (int32)	Can be null.
alsoReroute	boolean	Re-optimize the whole route after adding the stop.
optimizationMode	string	One of: Distance, Priority.

Attachment

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
attachmentId	integer (int32)
companyId	integer (int32)
tenantId	string (uuid)
entityId	integer (int32)
entityType	integer (int32)	One of: 1 (Customer), 2 (Order), 3 (OrderItem), 4 (OrderStop), 5 (CustomerContact), 6 (CustomerPaymentMethod), 7 (RouteTransfer), 8 (Quotes), 9 (Orders), 10 (Warehouse), 11 (Driver), 12 (TenantPaymentMethod), 13 (Payment), 14 (Invoice), 15 (Route), 16 (Truck), 17 (OutsourceCompany), 18 (OutsourceCompanyContact), 19 (Goods), 20 (Document), 21 (DrivingLog), 22 (Barcode), 23 (Check), 24 (DriverLicense), 25 (InsuranceCard), 26 (RegistrationCard: use the number), 27 (LoadUnit), 28 (LoadUnitContent), 29 (Violation), 30 (DriverStatusCheck), 31 (DriverIssue), 32 (Damage), 33 (FreightPayment).
pageType	string	One of: MainPage, BackPage, SignaturePage, Other.
bucketType	integer (int32)	One of: 0 (Documents), 1 (Images), 2 (Media).
pageNumber	integer (int32)
orderItemId	integer (int32)	Can be null.
orderStopId	integer (int32)	Can be null.
orderId	integer (int32)	Can be null.
driverId	integer (int32)	Can be null.
drivingLogId	integer (int32)	Can be null.
loadUnitId	integer (int32)	Can be null.
loadUnitContentId	integer (int32)	Can be null.
violationId	integer (int32)	Can be null.
driverStatusCheckId	integer (int32)	Can be null.
driverIssueId	integer (int32)	Can be null.
url	string	Can be null.
name	string	Can be null.
convertedFileName	string	Can be null.
pageLabel	string	Can be null.
orderItem	OrderItem
orderStop	OrderStop
order	Order
tenant	object
company	Company
violation	object
driverIssue	object

AttemptRequest

Property	Type	Description
isAttempt	boolean
reason	string	Can be null.
reAttemptDate	string (date-time)	Can be null.
waitingTime	number (double)	Can be null.
arrivalDateTime	string (date-time)	Can be null.
departureDateTime	string (date-time)	Can be null.

AutoRerouteRouteRequest

Property	Type	Description
useCurrentTruckLocation	boolean
firstRouteItemId	integer (int32)	Can be null.
optimizationMode	string	One of: Distance, Priority.
excludedRouteItemIds	array of integer (int32)	Can be null.
countryIds	array of integer (int32)	Can be null.

BarcodeScanCodeDto

Property	Type	Description
barcodeScanRecordId	integer (int32)
code	string	Can be null.
barcodeFormat	integer (int32)	One of: 0 (Unknown), 1 (Qr), 2 (Aztec), 3 (Codabar), 4 (Code39), 5 (Code93), 6 (Code128), 7 (DataMatrix), 8 (Ean13), 9 (Ean8), 10 (Itf14), 11 (Pdf417), 12 (UpcA), 13 (UpcE), 99 (Manual).
scanMode	string	One of: Unknown, FullPallet, PalletOnly, PalletWithContent, Simple.
scanPhase	string	One of: Unknown, Pallet, Boxes, Bags, Others, Box, Bag, Crate, Drum, Roll, Container, Tote, Cage, Bundle, Parcel, Other.
loadUnitType	string	One of: Unknown, Pallet, Box, Bag, Crate, Drum, Roll, Container, Tote, Cage, Bundle, Parcel, Other.
scannedAt	string (date-time)
palletIndex	integer (int32)	Can be null.
driverId	integer (int32)	Can be null.

BarcodeScanRecord

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
barcodeScanRecordId	integer (int32)
tenantId	string (uuid)
companyId	integer (int32)
barcodeValue	string	Required.
barcodeFormat	integer (int32)	One of: 0 (Unknown), 1 (Qr), 2 (Aztec), 3 (Codabar), 4 (Code39), 5 (Code93), 6 (Code128), 7 (DataMatrix), 8 (Ean13), 9 (Ean8), 10 (Itf14), 11 (Pdf417), 12 (UpcA), 13 (UpcE), 99 (Manual).
scannedAt	string (date-time)
entryMethod	string	One of: Scan, Manual.
scanMode	string	One of: Unknown, FullPallet, PalletOnly, PalletWithContent, Simple.
scanPhase	string	One of: Unknown, Pallet, Boxes, Bags, Others, Box, Bag, Crate, Drum, Roll, Container, Tote, Cage, Bundle, Parcel, Other.
loadUnitType	string	One of: Unknown, Pallet, Box, Bag, Crate, Drum, Roll, Container, Tote, Cage, Bundle, Parcel, Other.
palletIndex	integer (int32)	Can be null.
loadUnitId	integer (int32)	Can be null.
loadUnit	LoadUnit
loadUnitContentId	integer (int32)	Can be null.
loadUnitContent	LoadUnitContent
orderItemStopId	integer (int32)	Can be null.
orderItemStop	OrderItemStop
orderStopId	integer (int32)	Can be null.
driverId	integer (int32)	Can be null.

BroadcastDto

One active system-wide broadcast, shown pinned (no per-user state).

Property	Type	Description
systemBroadcastId	integer (int32)
date	string (date-time)
title	string	Can be null.
content	string	Can be null.
imageUrl	string	Can be null.
linkUrl	string	Can be null.
visibleFrom	string (date-time)
visibleUntil	string (date-time)
isBroadcast	boolean
isRevoked	boolean