Models T–Z

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.

Tag

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
id	integer (int32)
companyId	integer (int32)
tenantId	string (uuid)
emoji	string	Can be null.
name	string	Can be null.
company	Company
tenant	object

TaggableEntityDto

Property	Type	Description
entityType	string	One of: Order, Invoice, Bol.
entityId	integer (int32)
label	string	Can be null.

TermsAndConditionsDto

Property	Type	Description
termsAndConditionsId	integer (int32)
name	string	Can be null.
content	string	Can be null.
companyId	integer (int32)
tenantId	string (uuid)

TodaySummaryDto

Property	Type	Description
generatedAtUtc	string (date-time)
ordersCreatedToday	integer (int32)
quotesCreatedToday	integer (int32)
scheduledToday	integer (int32)	Active orders with at least one active stop scheduled today.
completedToday	integer (int32)	Orders delivered today (an active delivery stop with an actual arrival today).
completedTodayDeltaPct	number (double)	Can be null.
inTransitCount	integer (int32)
unassignedCount	integer (int32)
dispatchedCount	integer (int32)	Assigned to a route but not yet picked up.
onHoldCount	integer (int32)
lateCount	integer (int32)	Active orders with a stop still outstanding past its grace deadline.
lateOrders	array of LateOrderSummaryDto	Can be null.
routesActive	integer (int32)
routesPending	integer (int32)
driversOnRoute	integer (int32)	Distinct drivers assigned to an active route right now.
driversAvailable	integer (int32)	Active drivers not currently on an active route.
driversTotalActive	integer (int32)

Transaction

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).

TransactionPagedList

A page of results. See Pagination and filtering.

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

TransferStop

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
transferStopId	integer (int32)
address	Address
orderItem	OrderItem
deliveryDate	string (date-time)	Can be null.
deliveryTime	string (date-time)	Can be null.
deliveryDateTime	string (date-time)	Can be null.
pickupDate	string (date-time)	Can be null.
pickupTime	string (date-time)	Can be null.
pickupDateTime	string (date-time)	Can be null.
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
addressId	integer (int32)	Can be null.
orderItemId	integer (int32)	Can be null.
warehouseId	integer (int32)	Can be null.
warehouseItemId	integer (int32)	Can be null.
routeItems	array of RouteItem	Can be null.
warehouse	Warehouse
warehouseItem	WarehouseItem
orderNumber	string	Can be null.
customer	Customer
dropOffRouteItem	RouteItem
pickupRouteItem	RouteItem
orderItems	array of OrderItem	Can be null.
isHub	boolean	Read-only.

Truck

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
truckId	integer (int32)
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
name	string	Can be null.
plateNumber	string	Can be null.
status	string	One of: Active, Inactive, Deleted.
type	string	Can be null.
routes	array of Route	Can be null.
insurancePrice	number (double)
excludeExpensesStartDate	string (date-time)	Can be null.
excludeExpensesEndDate	string (date-time)	Can be null.
deletionDate	string (date-time)	Can be null.
removeExpenses	boolean
samsaraId	string	Can be null.
vin	string	Can be null. Up to 50 characters.

TruckMonthlyExpense

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
truckMonthlyExpenseId	integer (int32)
company	Company
companyId	integer (int32)
tenantId	string (uuid)
price	number (double)
type	integer (int32)	One of: 0 (Unspecified), 1 (Gas), 2 (Insurance), 3 (Maintenance).
name	string	Can be null.
tenant	object

TruckMonthlyExpensePagedList

A page of results. See Pagination and filtering.

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

TruckPagedList

A page of results. See Pagination and filtering.

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

TruckWithExpenses

Property	Type	Description
truckName	string	Can be null.
truckId	integer (int32)	Can be null.
createdTime	string (date-time)	Can be null.
excludeExpensesStartDate	string (date-time)	Can be null.
excludeExpensesEndDate	string (date-time)	Can be null.
status	string	One of: Active, Inactive, Deleted.
expenses	array of Expense	Can be null.

TruckWithExpensesPagedList

A page of results. See Pagination and filtering.

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

TruckWithVehicle

Property	Type	Description
truck	Truck
vehicle	object

TruckWithVehiclePagedList

A page of results. See Pagination and filtering.

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

TypeOfTruckCreateDto

Property	Type	Description
type	integer (int32)	One of: 1 (PickupTruck), 2 (BoxTruck), 3 (SemiTruck), 4 (RefrigeratorTruck), 5 (FurnitureTruck), 6 (FlatbedTruck).
name	string	Can be null.

TypeOfTruckDto

Property	Type	Description
typeOfTruckId	integer (int32)
tenantId	string (uuid)
companyId	integer (int32)
type	integer (int32)	One of: 1 (PickupTruck), 2 (BoxTruck), 3 (SemiTruck), 4 (RefrigeratorTruck), 5 (FurnitureTruck), 6 (FlatbedTruck).
isActive	boolean
name	string	Can be null.

TypeOfTruckDtoPagedList

A page of results. See Pagination and filtering.

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

UnassignedFilterOption

Property	Type	Description
type	string	One of: State, City, Zip.
value	string	Can be null.
city	string	Can be null.
state	string	Can be null. State part, set for City (when known) and State entries.

UnassignedFiltersRes

Options for the dispatch "Add Pickup" location filter.

Property	Type	Description
options	array of UnassignedFilterOption	Can be null.
cities	array of string	Can be null.
states	array of string	Can be null.
zipCodes	array of string	Can be null.

UnassignedOrderItemDto

Property	Type	Description
orderItemId	integer (int32)
orderId	integer (int32)	Can be null.
itemName	string	Can be null.
orderItemType	string	One of: Boxes & Crates, Pallets, Full Load, CFS, Other, Bags, Pallets+.
itemTypeQty	string	Can be null.
pickQuantity	integer (int32)
quantityToPick	integer (int32)
totalQuantity	number (double)
formatedMeasurements	string	Can be null.
sizeTypeName	string	Can be null.
sizeType	string	Can be null. One of: PalletStandard, PalletSmall, PalletLarge, Custom, LoadTrailer, LoadTruck, LoadVan.
sizeLength	number (double)	Can be null.
sizeWidth	number (double)	Can be null.
sizeHight	number (double)	Can be null.
sizeUnitOfMeasure	string	Can be null. One of: Inches, Centimeters, Pounds, Kilograms, Miles, Kilometers.
wight	number (double)	Can be null.
wightUnitOfMeasure	string	Can be null. One of: Inches, Centimeters, Pounds, Kilograms, Miles, Kilometers.
formattedUnitOfMeasure	string	Can be null.
isFragile	boolean
isHazardous	boolean
isRefrigerated	boolean
isOverweight	boolean
isOther	boolean
routePickupOrderItemStopId	integer (int32)	Can be null.
routeDeliveryOrderItemStopId	integer (int32)	Can be null.
orderItemStops	array of UnassignedOrderItemStopDto	Can be null.

UnassignedOrderItemStopDto

Property	Type	Description
orderItemStopId	integer (int32)
orderStopId	integer (int32)	Can be null.
orderItemId	integer (int32)	Can be null.
isActive	boolean
quantity	integer (int32)

UnassignedRouteGroupDto

Property	Type	Description
orderId	integer (int32)
orderNumber	string	Can be null.
purchaseOrderNumber	string	Can be null.
customer	object
pickupRouteBox	object
dropOffRouteBox	object
items	array of UnassignedOrderItemDto	Can be null.
orderItemIds	array of integer (int32)	Can be null.
priority	string	Can be null. One of: Low, Regular, High.

UnassignedRoutesSlimResData

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

UnassignedStopRouteSuggestionDto

One route offered as a home for an unassigned pickup, best first.

Property	Type	Description
routeId	integer (int32)
routeName	string	Can be null.
driverName	string	Can be null.
truckName	string	Can be null.
stopCount	integer (int32)	Open stops already on the route.
addedKm	number (double)	Extra travel the pickup adds at its cheapest insertion point.
insertPosition	integer (int32)	1-based position the pickup would take among the route's open stops.
insertAfterRouteItemId	integer (int32)	Can be null. The open stop it would follow.
isRecommended	boolean	True for the top suggestion.
reason	string	Can be null.
sameDayAsPickup	boolean	Whether the route already has stops on the pickup's scheduled day.
hasRelatedPickup	boolean	True when this route already carries the same order's still-pending pickup.

UnbilledClosedOrdersDto

Closed orders with NO non-deleted invoice.

Property	Type	Description
months	integer (int32)	Trailing window the orders were counted over.
orderCount	integer (int32)
unbilledFreight	number (double)

UpdateBuyingPriceDto

Property	Type	Description
buyingPrice	number (double)	Can be null.

UpdateCompanyDocumentContentDto

Property	Type	Description
contentHtml	string	Can be null.
contentMarkdown	string	Can be null.

UpdateCompanyDocumentMarkdownDto

Property	Type	Description
markdown	string	Can be null.

UpdateExcludeExpensesRequest

Property	Type	Description
truckId	integer (int32)
excludeExpensesStartDate	string (date-time)	Can be null.
excludeExpensesEndDate	string (date-time)	Can be null.

UpdateQuoteDto

Property	Type	Description
quote	Order
orderId	integer (int32)
quoteUpdateType	integer (int32)	One of: 0 (PickupDraft), 1 (PickupDone), 2 (DeliveryDraft), 3 (DeliveryDone), 4 (Pricing), 5 (Recurrence), 6 (OrderRouteBehavior).
returnQuote	boolean
preventDeepNestingForFrontend	boolean
orderRouteBehavior	integer (int32)	One of: 0 (Default), 1 (AssignToRoute).
routeId	integer (int32)	Can be null.
contactEmail	string	Can be null.
contactPhoneNumber	string	Can be null.
contactName	string	Can be null.

UpdateSupportTicketStatusRequest

Property	Type	Description
status	string	One of: Open, In Progress, Resolved, Archived.

UserPrompt

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
userPromptId	integer (int32)
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
text	string	Can be null.
order	integer (int32)
isDeleted	boolean
type	integer (int32)	One of: 0 (StartShift), 1 (Pickup), 2 (Dropoff), 3 (EndShift).
kind	integer (int32)	One of: 0 (Checkbox), 1 (Toggle).
state	integer (int32)	One of: 0 (Primary), 1 (Secondary).
secondaryText	string	Can be null.
code	string	Can be null. Up to 64 characters.
isEnabled	boolean	Whether the driver app shows this step.
isRequired	boolean

ValidateCustomerContactDto

Property	Type	Description
existedEmail	boolean
existedPhone	boolean
existedProspect	object

ValidateCustomerDto

Property	Type	Description
existedName	boolean
existedEmailIndex	array of integer (int32)	Can be null.
existedPhone	boolean
existedProspect	object
existedDeletedCustomer	object

ValidateDriverDisableDto

Property	Type	Description
hasActiveRoutes	boolean
hasPendingRoutes	boolean
activeRouteDriverNames	array of string	Can be null.
pendingRouteDriverNames	array of string	Can be null.

ValidateDriverDto

Property	Type	Description
existedEmail	boolean
existedPhone	boolean
existedCellNumber	boolean
existedSsn	boolean

ValidateEmailOrPhone

Property	Type	Description
excludeCustomerId	integer (int32)
email	string	Can be null.
phone	string	Can be null.

ValidateOutsourceCompanyDto

Property	Type	Description
existedCompanyName	boolean
existedEmailIndex	array of integer (int32)	Can be null.
existedPhone	boolean
existedOutsourceCompany	object

ValidateWarehouseDto

Property	Type	Description
existedAddress	boolean
existedName	boolean

Vehicle

Property	Type	Description
id	string	Can be null.
name	string	Can be null.
vin	string	Can be null.
odometerMeters	integer (int32)	Can be null.
engineHours	integer (int32)	Can be null.
fuelLevelPercent	number (double)	Can be null.
licensePlate	string	Can be null.
notes	string	Can be null.

VehicleLocation

Property	Type	Description
id	string	Can be null.
name	string	Can be null.
location	string	Can be null.
vin	string	Can be null.
onTrip	boolean
time	integer (int64)
latitude	number (double)
longitude	number (double)
heading	number (double)
speed	number (double)
odometerMeters	integer (int32)	Can be null.
odometerType	string	Can be null.

Warehouse

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
warehouseId	integer (int32)
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
name	string	Can be null.
address	Address
status	string	One of: Active, Inactive, Deleted.
addressId	integer (int32)	Can be null.
warehouseItems	array of WarehouseItem	Can be null.
isPrimary	boolean
country	string	Can be null.

WarehouseItem

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
warehouseItemId	integer (int32)
warehouse	Warehouse
orderItemStopId	integer (int32)
orderItemStop	OrderItemStop
warehouseId	integer (int32)	Can be null.
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
status	string	One of: Pending, Placed, Withdrawn.
datePlaced	string (date-time)
dateWithdrawn	string (date-time)

WarehousePagedList

A page of results. See Pagination and filtering.

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

WaypointDto

Property	Type	Description
address	string	Can be null.
isDone	boolean
index	integer (int32)
type	string	One of: Pickup, DeliveryToTransfer, PickupFromTransfer, Delivery.
orderStopId	integer (int32)	Can be null.

Zone

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
zoneId	integer (int32)
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
name	string	Can be null.
city	string	Can be null.
state	string	Can be null.
zipCodeRange	string	Can be null.
countryId	integer (int32)	Can be null.
country	object
status	string	One of: Active, Inactive, Deleted.
routes	array of Route	Can be null.
point	object
address	string	Read-only. Can be null.

ZonePagedList

A page of results. See Pagination and filtering.

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