Models I–N

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.

InboundEmailAddressDto

Property	Type	Description
address	string	Can be null.
localPart	string	Can be null.
domain	string	Can be null.
enabled	boolean
defaultImportKind	string	Can be null.
allowedFromDomains	array of string	Can be null.
lastReceivedAt	string (date-time)	Can be null.
customEmailAddress	string	Can be null.

InviteCustomerRequest

Property	Type	Description
customerId	integer (int32)
email	string	Can be null.
firstName	string	Can be null.
lastName	string	Can be null.
password	string	Can be null. Optional initial password set by the inviting admin.

Invoice

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.
tnxType	string	One of: Invoice, Payment.
id	integer (int32)
lineCount	integer (int32)
balance	number (double)	Read-only.
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.
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).
invoiceId	integer (int32)
isDefault	boolean
orderId	integer (int32)	Can be null.
order	Order
lines	array of InvoiceLine	Can be null.
sentEmails	array of SentEmail	Can be null.
dueDate	string (date-time)	Can be null.
externalNumber	string	Can be null. Up to 100 characters.
totalAmount	number (double)	Read-only.
amountPaid	number (double)	Read-only.
creditAmount	number (double)
invoiceCreated	boolean	Can be null.
paymentStatus	string	Read-only. One of: Draft, Approved, Open, Paid, Overdue, PartialPaid, Deleted.

InvoiceActivityDto

Property	Type	Description
invoiceActivityId	integer (int32)
type	string	One of: Created Invoice, Created Custom Invoice, Set Default, Edit, Approved, Sent QB, QB Error, Email Sent, Email Error, Revised, Awaiting QuickBooks Eligibility, Payment Awaiting QuickBooks Eligibility.
date	string (date-time)
invoiceId	integer (int32)
orderId	integer (int32)	Can be null.
user	object
orderNumber	string	Can be null.
invoiceNumber	string	Can be null.
oldPrice	number (double)	Can be null.
newPrice	number (double)	Can be null.
emails	string	Can be null.
description	string	Can be null.
note	string	Can be null.

InvoiceCreatedDto

Property	Type	Description
invoiceId	integer (int32)
customerId	integer (int32)
number	string	Can be null.
orderId	integer (int32)	Can be null.
date	string (date-time)	Can be null.
dueDate	string (date-time)	Can be null.
status	string	One of: Draft, Approved, Open, Paid, Overdue, PartialPaid, Deleted.
paymentStatus	string	One of: Draft, Approved, Open, Paid, Overdue, PartialPaid, Deleted.
totalAmount	number (double)
amountPaid	number (double)
creditAmount	number (double)
currencyCode	string	Can be null.
inQb	boolean
exportQbStatus	integer (int32)	One of: 1 (Exported), 2 (NotExported), 4 (Edited). Values can be combined by adding them together.
orderNumber	string	Can be null. Null when the invoice is not attached to an order (a "custom" invoice).

InvoiceLine

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
invoiceLineId	integer (int32)
lineType	integer (int32)	One of: 1 (Item), 2 (Charge).
isActive	boolean
invoiceId	integer (int32)	Can be null.
itemName	string	Can be null.
itemDescription	string	Can be null.
itemType	string	Can be null.
quantity	integer (int32)	Can be null.
measurement	string	Can be null.
weight	string	Can be null.
pickupAddress	string	Can be null.
deliveryAddress	string	Can be null.
chargeTypeId	integer (int32)	Can be null.
address	string	Can be null.
chargeType	ChargeType
charge	string	Can be null.
date	string (date-time)	Can be null.
amount	number (double)	Can be null.
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
driverId	integer (int32)	Can be null.
driver	Driver

InvoicePagedList

A page of results. See Pagination and filtering.

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

InvoiceStats

Property	Type	Description
total	number (double)
paid	number (double)
dueInNext30Days	number (double)
outstanding	number (double)

JobSiteEmailDto

Property	Type	Description
email	string	Can be null. Email address of the job site contact.
customerId	integer (int32)	Can be null. Unique identifier of the customer associated with the job site.

LateOrderSummaryDto

Property	Type	Description
orderId	integer (int32)
customerName	string	Can be null.
stopCity	string	Can be null. City of the overdue stop, when its address is known.
stopType	string	Can be null. Pickup / Delivery / Transfer.
scheduledTime	string (date-time)	Can be null. The overdue stop's scheduled instant.
lateSinceTime	string (date-time)	Can be null. The moment this stop started counting as late.
minutesLate	integer (int32)
driverName	string	Can be null.
tripStatus	string	Can be null.

LicenseType

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
licenseTypeId	integer (int32)
tenantId	string (uuid)
companyId	integer (int32)
name	string	Can be null.
isActive	boolean
isDeleted	boolean

LicenseTypePagedList

A page of results. See Pagination and filtering.

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

LoadTypePrice

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
loadTypePriceId	integer (int32)
shipmentType	ShipmentType
from	integer (int32)
shipmentTypeId	integer (int32)	Can be null.
price	number (double)
loadType	string	One of: PalletStandard, PalletSmall, PalletLarge, Custom, LoadTrailer, LoadTruck, LoadVan.
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object

LoadUnit

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
loadUnitId	integer (int32)
tenantId	string (uuid)
companyId	integer (int32)
locationIndex	integer (int32)
length	number (double)
width	number (double)
height	number (double)
tareWeight	number (double)
isFullLoad	boolean
isActive	boolean
isDamaged	boolean
isDeleted	boolean
lengthUnit	string	One of: Meter, Centimeter, Millimeter, Inch, Foot.
weightUnit	string	One of: Kilogram, Gram, Pound, Tonne.
type	string	One of: Unknown, Pallet, Box, Bag, Crate, Drum, Roll, Container, Tote, Cage, Bundle, Parcel, Other.
size	string	One of: Unknown, Small, Medium, Large, ExtraLarge, Standard.
status	string	One of: Unknown, Pending, Loaded, Processing, Completed, Unloaded.
loadUnitShape	string	One of: Unknown, RectangularPrism, Cube, Cylinder, Cone, Irregular, Custom, Other.
locationType	string	One of: Unknown, Machine, ProductionLine, Truck, Trailer, Railcar, Vessel, Aircraft, Warehouse, Rack, Bin, ColdStorage, Dock, CrossDock, SortingArea, Yard, BufferZone, Other.
packaging	string	One of: None, Bagged, Wrapped, Boxed, OpenCrated, FullyCrated, Palletized, Caged, Containerized, Other.
protectionFeatures	integer (int32)	One of: 0 (None), 1 (ShockResistant), 2 (VibrationDamped), 4 (Stackable), 8 (MoistureResistant), 16 (Waterproof), 32 (DustProof), 64 (AntiCorrosion), 128 (GasProtected), 256 (ThermalInsulated), 512 (TemperatureControlled), 1024 (TamperEvident), 2048 (Sealed). Values can be combined by adding them together.
handlingInstructions	integer (int32)	One of: 0 (None), 1 (Fragile), 2 (ThisSideUp), 4 (KeepUpright), 8 (DoNotStack), 16 (DoNotDrop), 32 (DoNotClamp), 64 (KeepDry), 128 (UseForklift), 256 (NoForks), 512 (HandleWithCare), 1024 (TeamLiftRequired), 2048 (UseHandTruck), 4096 (AvoidSunlight). Values can be combined by adding them together.
longitudinalPosition	string	One of: Unknown, Front, Middle, Rear.
verticalPosition	string	One of: Unknown, Bottom, Middle, Top.
lateralPosition	string	One of: Unknown, Left, Center, Right, Corner.
capacityBasis	string	One of: Unknown, Volume, Weight, ItemCount.
orderItemStopId	integer (int32)	Can be null.
depthIndex	integer (int32)	Can be null.
diameter	number (double)	Can be null.
capacityUsedPercent	number (double)	Can be null.
name	string	Can be null.
number	string	Can be null.
description	string	Can be null.
notes	string	Can be null.
containerNumber	string	Can be null.
locationZoneCode	string	Can be null.
trackingNumber	string	Can be null.
contents	array of LoadUnitContent	Can be null.
scanRecords	array of BarcodeScanRecord	Can be null.
attachments	array of Attachment	Can be null.
contentsWeight	number (double)	Read-only.
grossWeight	number (double)	Read-only.

LoadUnitContent

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
loadUnitContentId	integer (int32)
tenantId	string (uuid)
companyId	integer (int32)
quantity	integer (int32)
indexOnUnit	integer (int32)
length	number (double)
width	number (double)
height	number (double)
weight	number (double)
isActive	boolean
isDamaged	boolean
isDeleted	boolean
lengthUnit	string	One of: Meter, Centimeter, Millimeter, Inch, Foot.
weightUnit	string	One of: Kilogram, Gram, Pound, Tonne.
type	string	One of: Unknown, Boxes, Bags, Pallets.
productCategory	string	One of: Unknown, Electronics, HouseholdAppliances, Furniture, ClothingAndApparel, BooksAndPrintedMedia, MedicalEquipment, MedicinesAndPharmaceuticals, FoodProducts, FoodIndustrySupplies, AutomotiveParts, IndustrialEquipment, MachineryAndSpareParts, ToolsAndMaintenanceEquipment, ConstructionEquipment, BuildingMaterials, WoodenStructures, Fabrics, CarpetsAndFloorCoverings, HouseholdChemicals, IndustrialChemicals, ShopEquipmentAndFixtures, AdvertisingAndSignage, WarehouseEquipment, OfficeSupplies, HouseholdSupplies, EnterpriseSupplies, Other.
contentForm	string	One of: Unknown, Boxed, Bagged, Sack, Palletized, Bundled, Loose, Drum, Barrel, Cylinder, Roll, Container, Tote, Cage, Bottle, Jar, Vial, Tube, Pipe, Other.
material	string	One of: Unknown, Wood, Metal, Plastic, Paper, Glass, Textile, Rubber, Composite, Foam, Ceramic, Powder, Granular, Liquid, Paste, Gel, Gas, Other.
traits	integer (int32)	One of: 0 (None), 1 (Fragile), 2 (Hazardous), 4 (Flammable), 8 (TemperatureSensitive), 16 (HumiditySensitive), 32 (LightSensitive), 64 (Refrigerated), 128 (Frozen), 256 (Liquid), 512 (Pressurized), 1024 (IrregularShape), 2048 (Perishable), 4096 (RequiresExpirationTracking), 8192 (Oversized), 16384 (Overweight), 32768 (HighValue), 65536 (Insured), 131072 (CannotAirShip), 262144 (CannotSeaShip). Values can be combined by adding them together.
verticalPosition	string	One of: Unknown, Bottom, Middle, Top.
horizontalPosition	string	One of: Unknown, Left, Center, Right, Corner.
attachments	array of Attachment	Can be null.
loadUnitId	integer (int32)	Can be null.
diameter	number (double)	Can be null.
name	string	Can be null.
number	string	Can be null.
description	string	Can be null.
notes	string	Can be null.
loadUnit	LoadUnit
totalWeight	number (double)	Read-only.

LoginRequest

Property	Type	Description
userName	string	Required. Username or email used for authentication.
password	string	Required.
fleetId	string	Can be null. Optional fleet identifier (used for company validation).

MergeCustomers

Property	Type	Description
parentCustomerId	integer (int32)
customerIds	array of integer (int32)	Can be null.

MileageChargeDto

Property	Type	Description
minMileage	integer (int32)
maxMileage	integer (int32)
additionalChargePercentage	number (double)

MoveToUnassignedRequest

Property	Type	Description
routeId	integer (int32)	Can be null.
orderStopId	integer (int32)	Can be null.
transferStopId	integer (int32)	Can be null.
stopGroups	array of RouteItemStopGroup	Can be null.
attempt	AttemptRequest

NewAppointmentRequestDto

Property	Type	Description
fromDateTime	string (date-time)
tillDateTime	string (date-time)

NonWorkingDay

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
nonWorkingDayId	integer (int32)
name	string	Can be null.
tenantId	string (uuid)
companyId	integer (int32)
tenant	object
company	Company
date	string (date-time)
type	integer (int32)	One of: 0 (Autogenerated), 1 (Custom).

NonWorkingDayPagedList

A page of results. See Pagination and filtering.

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

NormalizeContactsPreviewDto

Property	Type	Description
hasPrimaryContact	boolean	False means normalize is unavailable.
primaryContactId	integer (int32)	Can be null.
primaryContactName	string	Can be null.
totalContactCount	integer (int32)
contactsToDeactivate	integer (int32)
contactsInUse	integer (int32)
contactsUnused	integer (int32)
ordersToReassign	integer (int32)

NormalizeContactsResultDto

Outcome of a normalize run.

Property	Type	Description
primaryContactId	integer (int32)
primaryContactName	string	Can be null.
deactivatedContactCount	integer (int32)
reassignedContactCount	integer (int32)	Contacts that were referenced somewhere and had their orders moved to the primary.
unusedContactCount	integer (int32)	Contacts that were referenced nowhere and were simply retired.
reassignedOrderCount	integer (int32)	Total orders and quotes re-pointed at the primary contact.

NormalizedAddressWithCustomers

Property	Type	Description
address	Address
customers	array of Customer	Can be null.

NormalizedAddressWithCustomersPagedList

A page of results. See Pagination and filtering.

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

NotificationActionRequest

Property	Type	Description
approve	boolean	True = Approve, false = Deny.

NotificationDto

Coming soon

A new category value, QuickbooksConnection, is on its way. It is not part of the live API yet, so the category values listed below do not include it. See Notifications for what the new category covers, its default settings, and who receives it.

Property	Type	Description
notificationId	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.
category	string	One of: General, SystemAnnouncement, Documents, OrderLateDelivery, OrderStatus.
pictureType	string	One of: Default, ExclamationTriangle.
isRead	boolean
readTime	string (date-time)	Can be null.
snoozedUntil	string (date-time)	Can be null.
expiresAt	string (date-time)	Can be null.
actionState	string	One of: None, Pending, Approved, Denied.
actionKey	string	Can be null.
actionRespondedTime	string (date-time)	Can be null.
isBroadcast	boolean

NotificationDtoPagedList

A page of results. See Pagination and filtering.

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

NotificationPreferenceDto

Coming soon

A new category value, QuickbooksConnection, is on its way. It is not part of the live API yet, so the category values listed below do not include it. See Notifications for what the new category covers, its default settings, and who receives it.

Property	Type	Description
category	string	One of: General, SystemAnnouncement, Documents, OrderLateDelivery, OrderStatus.
inAppEnabled	boolean
emailEnabled	boolean
inAppLocked	boolean

NotificationPreferenceUpdateItem

Coming soon

A new category value, QuickbooksConnection, is on its way. It is not part of the live API yet, so the category values listed below do not include it. See Notifications for what the new category covers, its default settings, and who receives it.

Property	Type	Description
category	string	One of: General, SystemAnnouncement, Documents, OrderLateDelivery, OrderStatus.
inAppEnabled	boolean
emailEnabled	boolean