Models S

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.

SaveDashboardDefinitionRequest

Property	Type	Description
name	string	Can be null.
layoutJson	string	Can be null.
isPersonal	boolean

SearchCriteria

Property	Type	Description
page	integer (int32)
itemsPerPage	integer (int32)
searchTerm	string	Can be null.
sortBy	string	Can be null.
sortDirection	integer (int32)	One of: 0 (Ascending), 1 (Descending).
pageStartIndex	integer (int32)	Read-only.
roles	array of string	Can be null.
orderStatus	array of string	Can be null. One of: Dreft, Quote, Order, Deleted, Closed.
driverStatus	array of string	Can be null. One of: Active, Inactive, Deleted, Draft, New, Invited, Disabled.
isOrder	boolean
date	string (date-time)	Can be null.
customers	array of integer (int32)	Can be null.
drivers	array of integer (int32)	Can be null.
dateRange	array of string (date-time)	Can be null.
fromAddress	array of string	Can be null.
toAddress	array of string	Can be null.
stopType	string	Can be null. One of: Pickup, Delivery, Transfer.
hasInvoice	boolean	Can be null.
tripStatus	array of string	Can be null. One of: Open, Assigned, InTransit, Delivered.
shipmentTypeIds	array of integer (int32)	Can be null.
tnxTypes	array of string	Can be null.
tnxStatus	array of string	Can be null. One of: Draft, Approved, Open, Paid, Overdue, PartialPaid, Deleted.
filterTnxStatus	array of string	Can be null. One of: Draft, Approved, Open, Paid, Overdue, PartialPaid, Deleted.
companyTypes	array of string	Can be null. One of: Customer, Outsource.
driverTypes	array of string	Can be null. One of: Default, Outsource, Mixed.
inspectionStatus	array of integer (int32)	Can be null. One of: 1 (Pending), 2 (Failed), 3 (Maintenance), 4 (Completed).
orderPaymentStatus	array of integer (int32)	Can be null. One of: 1 (NotPaidAndCompleted), 2 (NotPaidAndAssigned), 3 (NotPaidAndUnassigned), 4 (Paid), 5 (PartlyPaid).
minPrice	integer (int32)	Can be null.
maxPrice	integer (int32)	Can be null.
inQb	boolean	Can be null.
qbSyncStates	array of string	Can be null.
orderNumber	string	Can be null.
driverName	string	Can be null.
zone	string	Can be null.
latitude	number (double)	Can be null.
longitude	number (double)	Can be null.
zoneIds	array of integer (int32)	Can be null.
outsourceCompanyIds	array of integer (int32)	Can be null.
countryIds	array of integer (int32)	Can be null.
countries	array of string	Can be null.
states	array of string	Can be null.
cities	array of string	Can be null.
zip	array of string	Can be null.
locationTerm	string	Can be null.
useCombinedLocationSearch	boolean
driverPayoutTypes	array of string	Can be null. One of: Hourly, FixedSalary, Distance, FixDistance, FixHourly, Percent, DistanceAndPercent, FixedCost, Pallets.
outsourceCompanyTypesOfWork	array of integer (int32)	Can be null. One of: 1 (Fixed), 2 (Distance), 4 (Hourly), 8 (Pallets). Values can be combined by adding them together.
offset	integer (int32)	Can be null.
invoiceStatus	array of string	Can be null. One of: Draft, Opened, Pending, Approved, Completed.
isInvoiced	boolean	Can be null.
isDefault	boolean	Can be null.
isOnlyCreatedByCurrentUser	boolean	Can be null.
viewedEntityType	string	Can be null. One of: Quote, Customer, CustomerMessage, Order.
isEmailSent	boolean	Can be null.
invoiceTypes	array of string	Can be null.
paymentStatuses	array of string	Can be null.
searchByOrder	array of integer (int32)	Can be null.
includedInvoice	boolean	Can be null.
excludedInvoice	boolean	Can be null.
customInvoice	boolean	Can be null.

SendMessageDto

Property	Type	Description
chatId	integer (int32)
text	string	Can be null.
mediaUrl	string	Can be null. Storage key of an already-uploaded attachment.

SentEmail

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
sentEmailId	integer (int32)
tenantId	string (uuid)
companyId	integer (int32)
isOpenedEmail	boolean
emailType	integer (int32)	One of: 0 (Quote), 1 (BillOfLanding), 2 (Invoice), 3 (Customer), 4 (FreightPayment).
to	string	Can be null.
subject	string	Can be null.
orderId	integer (int32)	Can be null.
invoiceId	integer (int32)	Can be null.
customerId	integer (int32)	Can be null.
freightPaymentId	integer (int32)	Can be null.
order	Order
invoice	Invoice
customer	Customer
freightPayment	FreightPayment
company	Company
tenant	object
customerIds	array of integer (int32)	Can be null.

SetCompanyDocumentCategoriesDto

Property	Type	Description
categories	array of string	Can be null.

SetCompanyDocumentTagsDto

Property	Type	Description
tags	array of string	Can be null.

SetInboundEmailAllowedDomainsDto

Property	Type	Description
domains	array of string	Can be null.

SetInboundEmailCustomEmailDto

Property	Type	Description
customEmailAddress	string	Can be null.

SetInboundEmailEnabledDto

Property	Type	Description
enabled	boolean

SetInboundEmailLocalPartDto

Property	Type	Description
localPart	string	Can be null.

ShipmentType

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
shipmentTypeId	integer (int32)
name	string	Can be null.
companyId	integer (int32)
tenantId	string (uuid)
status	string	One of: Active, Inactive, Deleted.
tenant	object
markup	number (double)
feeFragile	number (double)
feeHazardous	number (double)
feeRefrigerated	number (double)
feeOverweight	number (double)
feeOther	number (double)
pricesPerLoadType	array of LoadTypePrice	Can be null.
perMilePrices	array of PerMilePrice	Can be null.
perHourPrices	array of PerHourPrice	Can be null.
perLbPrices	array of PerLbPrice	Can be null.
perCftPrices	array of PerCftPrice	Can be null.
customerId	integer (int32)	Can be null.
customer	Customer

ShipmentTypePagedList

A page of results. See Pagination and filtering.

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

SnoozeNotificationRequest

Property	Type	Description
until	string (date-time)

State

Property	Type	Description
stateId	integer (int32)
countryId	integer (int32)
name	string	Can be null.

SupportTicketDto

A ticket as the customer sees it.

Property	Type	Description
supportTicketId	integer (int32)
subject	string	Can be null.
description	string	Can be null.
status	string	One of: Open, In Progress, Resolved, Archived.
priority	string	One of: Low, Normal, High, Urgent.
dueDate	string (date-time)	Can be null.
createdTime	string (date-time)
updatedTime	string (date-time)	Can be null.
resolvedAt	string (date-time)	Can be null.
isAssigned	boolean	True once a staff member owns it.
messageCount	integer (int32)
messages	array of SupportTicketMessageDto	Can be null. Populated on the single-ticket read.

SupportTicketMessageDto

Property	Type	Description
supportTicketMessageId	integer (int32)
text	string	Can be null.
isFromCustomer	boolean
authorName	string	Can be null.
date	string (date-time)

SupportTicketPagedList

A page of results. See Pagination and filtering.

Property	Type	Description
list	array of SupportTicketDto	Can be null.
totalCount	integer (int32)