Models C

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.

ChangeOrderRouteRequest

Property	Type	Description
oldRouteId	integer (int32)
newRouteId	integer (int32)
orderId	integer (int32)
orderStopId	integer (int32)
status	integer (int32)	One of: 0 (ToDo), 1 (Done), 2 (Pending).
routeItemType	string	Can be null. One of: Pickup, DeliveryToTransfer, PickupFromTransfer, Delivery.

ChargeType

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
chargeTypeId	integer (int32)
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
name	string	Can be null.
isActive	boolean
isItemsSubtotal	boolean
qbItemName	string	Can be null.
qbAccountName	string	Can be null.
isOverridablePrice	boolean
pricePerUnit	number (double)	Can be null.
isWaitingTime	boolean
isAttempt	boolean
isApplicableToStop	boolean
isMoneyAmount	boolean
isSystemForOrder	boolean	When true, this charge type is a system charge for Orders and is hidden from the Order details (Stop "Additional Charges") selection dropdown.
isSystemForInvoice	boolean	When true, this charge type is a system charge for Invoices and is hidden from the Invoice (edit mode) selection dropdown.
calculationBasis	string	One of: Flat, PerUnit, PercentOfFreight, PercentOfValue.
unitBasis	string	What a per-unit charge counts (pallets, kg, stops, customs documents…). One of: Shipment, Pallet, Kg, Piece, Stop, Document.
percentRate	number (double)	Can be null.
percentRateMax	number (double)	Can be null. Upper bound when the sheet quoted the percentage as a range ("3%–5%").
minAmount	number (double)	Can be null.
maxAmount	number (double)	Can be null.
freeUnits	integer (int32)
customerId	integer (int32)	Can be null. Null = a Settings-level (company-wide) charge type.
customer	Customer
sourceChargeTypeId	integer (int32)	Can be null.
qty	number (double)
selected	boolean
routeItemChargeId	integer (int32)	Can be null.
priceOverride	number (double)	Can be null.
note	string	Can be null.

ChatDto

A chat thread as returned by the Chats API, with its last message and the calling user's unread count.

Property	Type	Description
chatId	integer (int32)	Unique identifier of the chat.
type	string	Can be null.
scope	string	Can be null.
orderId	integer (int32)	Can be null.
orderNumber	string	Can be null. Human-readable number of the linked order.
routeId	integer (int32)	Can be null.
name	string	Can be null. Display name, always populated.
createdAt	string (date-time)	Can be null. UTC timestamp of chat creation.
archivedAt	string (date-time)	Can be null. UTC timestamp the chat was archived.
taskId	integer (int32)	Can be null.
adminApproved	boolean	Whether an admin has approved this chat.
unreadCount	integer (int32)
channelName	string	Can be null.
driverId	integer (int32)	Can be null.
driverName	string	Can be null.
lastMessage	ChatMessageDto	Most recent non-deleted message, for list previews.

ChatMessageDto

A single chat message.

Property	Type	Description
chatMessageId	integer (int32)	Unique identifier of the message.
chatId	integer (int32)	Id of the chat the message belongs to.
senderUserId	string	Can be null.
senderDriverId	integer (int32)	Can be null. Driver id of the sender.
senderName	string	Can be null. Display name of the sender.
senderType	string	Can be null.
senderImageUrl	string	Can be null.
text	string	Can be null.
mediaUrl	string	Can be null.
isSystemMessage	boolean
redirectedToInbox	boolean
createdAt	string (date-time)	Can be null. UTC timestamp the message was created.

ChatParticipantDto

Property	Type	Description
chatParticipantId	integer (int32)
chatId	integer (int32)	Id of the chat this participation belongs to.
userId	string	Can be null.
driverId	integer (int32)	Can be null. Driver id when the participant is a driver.
name	string	Can be null. Display name of the participant.
type	string	Can be null.
canWrite	boolean	Whether this participant may post.
lastReadAt	string (date-time)	Can be null. UTC timestamp of this participant's last read.

ChatUnreadSummaryDto

Property	Type	Description
total	integer (int32)	Total unread messages across all of the user's chats.
routeChats	integer (int32)	Unread messages in "Route" chats.
driverChats	integer (int32)
byType	map of integer (int32)	Can be null.

City

Property	Type	Description
cityId	integer (int32)
stateId	integer (int32)
countryId	integer (int32)
name	string	Can be null.
postalCodesFetchedTime	string (date-time)	Can be null.

CityPostalCodesDto

Property	Type	Description
cityId	integer (int32)
cityName	string	Can be null.
stateName	string	Can be null.
countryName	string	Can be null.
primaryPostalCode	string	Can be null.
postalCodes	array of PostalCodeDto	Can be null.
providerAvailable	boolean

Company

Property	Type	Description
companyId	integer (int32)
tenantId	string (uuid)
tenant	object
companyName	string	Can be null.
registrationNumber	string	Can be null.
companySize	integer (int32)
companyStatus	integer (int32)	One of: 0 (Pending), 1 (Active), 2 (Inactive).
nonWorkingDays	array of NonWorkingDay	Can be null.
customers	array of Customer	Can be null.
country	object
countryId	integer (int32)
invoices	array of Invoice	Can be null.
payments	array of Payment	Can be null.
website	string	Can be null.
weight	string	Can be null. One of: Inches, Centimeters, Pounds, Kilograms, Miles, Kilometers.
distance	string	Can be null. One of: Inches, Centimeters, Pounds, Kilograms, Miles, Kilometers.
size	string	Can be null. One of: Inches, Centimeters, Pounds, Kilograms, Miles, Kilometers.
orderNumbersIndex	integer (int32)	Can be null.
transactionNumberIndex	integer (int32)	Can be null.
defaultGasState	string	Can be null.
defaultDriverWage	integer (int32)
costPerMile	number (double)
defaultMarkupPercent	number (double)
logoUrl	string	Can be null.
phoneNumber	string	Can be null.
email	string	Can be null.
fullAddress	string	Can be null.
faxNumber	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.
termsAndConditions	string	Can be null.
invoiceNotes	string	Can be null.
emailCC	string	Can be null.
emailFromOrder	string	Can be null.
emailFromAccounting	string	Can be null.
fromEmail	string	Can be null.
maxFreeWaitingTime	integer (int32)
waitingTimes	object
useNewPricing	boolean
hasGoogleMapsKey	boolean	Whether a per-company Google Maps key override is configured.
truckMilesPerMonth	integer (int32)
truckMonthlyExpenses	array of TruckMonthlyExpense	Can be null.
truckAxleNumberForTollPricing	integer (int32)
invoiceDaily	boolean
invoiceWeekly	boolean
invoiceMonthly	boolean
invoicePerOrder	boolean
invoicePerLoad	boolean
invoicePerShipment	boolean
invoiceCreationMode	integer (int32)	One of: 0 (CreatedAndCompleted), 1 (Completed), 2 (Manual).
invoiceCustomerBalanceCalculationMode	integer (int32)	One of: 0 (OnlyDefault), 1 (AllInvoices).
quickBooksCreationMode	integer (int32)	One of: 0 (Auto), 1 (Manual).
maxRouteAddresses	integer (int32)
allTabAutoClose	integer (int32)	One of: 0 (Never), 1 (FiveMin), 2 (TenMin), 3 (FifteenMin), 4 (ThirtyMin), 5 (OneHour), 6 (TwoHours), 7 (ThreeHours), 8 (SixHours), 9 (NineHours), 10 (TwelveHours), 11 (TwentyFourHours).
quoteTabAutoClose	integer (int32)	One of: 0 (Never), 1 (FiveMin), 2 (TenMin), 3 (FifteenMin), 4 (ThirtyMin), 5 (OneHour), 6 (TwoHours), 7 (ThreeHours), 8 (SixHours), 9 (NineHours), 10 (TwelveHours), 11 (TwentyFourHours).
orderTabAutoClose	integer (int32)	One of: 0 (Never), 1 (FiveMin), 2 (TenMin), 3 (FifteenMin), 4 (ThirtyMin), 5 (OneHour), 6 (TwoHours), 7 (ThreeHours), 8 (SixHours), 9 (NineHours), 10 (TwelveHours), 11 (TwentyFourHours).
dispatchTabAutoClose	integer (int32)	One of: 0 (Never), 1 (FiveMin), 2 (TenMin), 3 (FifteenMin), 4 (ThirtyMin), 5 (OneHour), 6 (TwoHours), 7 (ThreeHours), 8 (SixHours), 9 (NineHours), 10 (TwelveHours), 11 (TwentyFourHours).
customerTabAutoClose	integer (int32)	One of: 0 (Never), 1 (FiveMin), 2 (TenMin), 3 (FifteenMin), 4 (ThirtyMin), 5 (OneHour), 6 (TwoHours), 7 (ThreeHours), 8 (SixHours), 9 (NineHours), 10 (TwelveHours), 11 (TwentyFourHours).
invoiceTabAutoClose	integer (int32)	One of: 0 (Never), 1 (FiveMin), 2 (TenMin), 3 (FifteenMin), 4 (ThirtyMin), 5 (OneHour), 6 (TwoHours), 7 (ThreeHours), 8 (SixHours), 9 (NineHours), 10 (TwelveHours), 11 (TwentyFourHours).
driverTabAutoClose	integer (int32)	One of: 0 (Never), 1 (FiveMin), 2 (TenMin), 3 (FifteenMin), 4 (ThirtyMin), 5 (OneHour), 6 (TwoHours), 7 (ThreeHours), 8 (SixHours), 9 (NineHours), 10 (TwelveHours), 11 (TwentyFourHours).
outsourceTabAutoClose	integer (int32)	One of: 0 (Never), 1 (FiveMin), 2 (TenMin), 3 (FifteenMin), 4 (ThirtyMin), 5 (OneHour), 6 (TwoHours), 7 (ThreeHours), 8 (SixHours), 9 (NineHours), 10 (TwelveHours), 11 (TwentyFourHours).
mapType	string	One of: GoogleMaps, Mapbox, TrimbleMaps, OpenStreetMap, Radar, Here.
osmTileUrl	string	Can be null. Up to 1024 characters.
includeTransfersInBol	boolean
useDetailedAddressLookup	boolean
useZipInAddressNormalizedKey	boolean
showTransferCards	boolean
driverRouteViewMode	string	One of: Full, Restricted.
restrictedModeShowFirstStop	boolean
restrictedModeShowNextStop	boolean
restrictedModeShowLastStop	boolean
restrictedModeShowPreviousStops	boolean
restrictedModeShowStopsAfterNext	boolean
autoAccessorialBillingMode	integer (int32)	One of: 0 (Off), 1 (Preview), 2 (Apply).
autoBillFuelSurcharge	boolean
intlPriceUponRequestMode	string	What happens when a rate card matches an international lane but cannot price it. One of: Off, Warn, Block.
enableCostLedger	boolean
geocodeAddressesOnSave	boolean
documentRetentionDays	integer (int32)	Can be null.
defaultCurrencyCode	string	Can be null. Up to 3 characters.
enabledCurrencyCodes	array of string	Can be null. The enabled currency set.
customerPortalAiAssistantEnabled	boolean
driverRouteViewAppliesToTenant	boolean
driverRouteViewAppliesToOutsource	boolean
driverRouteViewOrgOverrideEnabled	boolean
driverRouteViewDriverOverrideEnabled	boolean

CompanyDocumentBulkErrorDto

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

CompanyDocumentBulkRequestDto

Property	Type	Description
ids	array of integer (int32)	Can be null.
action	string	One of: Archive, Unarchive, Delete, AddTags, RemoveTags, SetCategories.
tags	array of string	Can be null.
categories	array of string	Can be null.

CompanyDocumentBulkResultDto

Property	Type	Description
requested	integer (int32)
succeeded	integer (int32)
failed	integer (int32)
errors	array of CompanyDocumentBulkErrorDto	Can be null.

CompanyDocumentDto

Property	Type	Description
id	integer (int32)
name	string	Can be null.
originalFileName	string	Can be null.
mimeType	string	Can be null.
sizeBytes	integer (int64)
status	string	One of: Uploaded, Processing, Ready, Failed.
isArchived	boolean
source	string	One of: Chat, DocumentsPage, SystemGenerated, EmailInbound.
documentType	string	One of: Unknown, OrderSheet, Manifest, PackingList, PurchaseOrder, PriceSheet, ShippingDocument, Invoice, CustomerDocument, Other, UserCreated, Receipt.
summary	string	Can be null.
pageCount	integer (int32)	Can be null.
tags	array of string	Can be null.
categories	array of string	Can be null.
uploadedByUserId	string	Can be null.
uploadedByName	string	Can be null.
createdAt	string (date-time)
extractionError	string	Can be null.
hasMarkdown	boolean	True once extraction produced Markdown (drives the preview's markdown path).
hasPreparedImport	boolean
autoPreparedProfileId	integer (int32)	Can be null.
needsReview	boolean
extractionConfidence	number (double)	Can be null.
linkedEntityCount	integer (int32)	How many business records (orders / customers / pricing models / charge types) an AI import created or updated from this document.
version	integer (int32)
captureMetadata	object

CompanyDocumentDtoPagedList

A page of results. See Pagination and filtering.

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

CompanyDocumentEmailResultDto

Property	Type	Description
recipients	array of string	Can be null.
cc	array of string	Can be null.
subject	string	Can be null.

CompanyDocumentFilterNameCountDto

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

CompanyDocumentFiltersDto

Property	Type	Description
categories	array of CompanyDocumentFilterNameCountDto	Can be null.
tags	array of CompanyDocumentFilterNameCountDto	Can be null.
documentTypes	array of CompanyDocumentFilterTypeCountDto	Can be null.

CompanyDocumentFilterTypeCountDto

Property	Type	Description
type	string	One of: Unknown, OrderSheet, Manifest, PackingList, PurchaseOrder, PriceSheet, ShippingDocument, Invoice, CustomerDocument, Other, UserCreated, Receipt.
count	integer (int32)

CompanyDocumentLinkDto

Property	Type	Description
entityType	string	One of: Order, Customer, PricingModel, ChargeType, LoadUnit, Invoice, Quote, Driver.
entityId	integer (int32)
label	string	Can be null.

CompanyDocumentMarkdownDto

Property	Type	Description
markdown	string	Can be null.
status	string	One of: Uploaded, Processing, Ready, Failed.
error	string	Can be null.

CompanyDocumentSourceCountDto

Property	Type	Description
source	string	One of: Chat, DocumentsPage, SystemGenerated, EmailInbound.
count	integer (int32)

CompanyDocumentStatsDto

Property	Type	Description
byType	array of CompanyDocumentFilterTypeCountDto	Can be null.
byStatus	array of CompanyDocumentStatusCountDto	Can be null.
bySource	array of CompanyDocumentSourceCountDto	Can be null.
totalSizeBytes	integer (int64)
last30dUploads	integer (int32)
last30dImports	integer (int32)

CompanyDocumentStatusCountDto

Property	Type	Description
status	string	One of: Uploaded, Processing, Ready, Failed.
count	integer (int32)

CompanyDto

Property	Type	Description
companyId	integer (int32)
companyName	string	Can be null.

CompanyDtoPagedList

A page of results. See Pagination and filtering.

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

CompanyUser

Property	Type	Description
id	string	Can be null.
company	Company
companyId	integer (int32)
tenantId	string (uuid)
firstName	string	Can be null.
middleName	string	Can be null.
lastName	string	Can be null.
email	string	Can be null.
phone	string	Can be null.
cellPhone	string	Can be null.
cellPhoneCountryCode	string	Can be null.
cellPhoneCountryIso	string	Can be null.
addressLine1	string	Can be null.
city	string	Can be null.
state	string	Can be null.
zip	string	Can be null.
countryId	integer (int32)	Can be null.
tempPasswordChanged	boolean
mustChangePassword	boolean
profileImageUrl	string	Can be null.
isDisabled	boolean
isDeleted	boolean
customerId	integer (int32)	Can be null.
disableDate	string (date-time)	Can be null. Optional date on which the user is automatically disabled.
fullName	string	Read-only. Can be null.

ComposeEmailRequest

Property	Type	Description
to	string	Can be null.
cc	string	Can be null.
bcc	string	Can be null.
subject	string	Can be null.
htmlBody	string	Can be null.

ContactUsageDto

Property	Type	Description
customerContactId	integer (int32)
contactName	string	Can be null.
isPrimary	boolean
hasDesignations	boolean
designationNames	array of string	Can be null.
totalOrderCount	integer (int32)	All referencing orders and quotes, including deleted ones.
activeOrderCount	integer (int32)
primaryContactId	integer (int32)	Can be null.
primaryContactName	string	Can be null.

CostLine

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
costLineId	integer (int32)
order	Order
costType	integer (int32)	One of: 0 (FuleCharges), 1 (Toll), 2 (Milage), 3 (DriverCost), 4 (Accessories), 5 (Other), 6 (Surcharge), 7 (Fee), 8 (MinPrice), 9 (Weight), 10 (Cubic), 11 (Item), 12 (FragileFee), 13 (HazardousFee), 14 (OverweightFee), 15 (RefrigeratedFee), 16 (Time), 17 (Truck), 18 (AdditionalCharges).
quantity	number (double)
rate	number (double)
totalCost	number (double)
itemDescription	string	Can be null.
isActive	boolean
isOverwritten	boolean
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
orderId	integer (int32)	Can be null.
orderStopId	integer (int32)	Can be null.

CountryDto

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

CreateCompanyDocumentDto

Property	Type	Description
name	string	Can be null.
format	string	One of: Markdown, Html, Pdf, Word.
contentHtml	string	Can be null.
contentMarkdown	string	Can be null.

CreateDriverToDriverChatDto

Property	Type	Description
driverIds	array of integer (int32)	Can be null.
orderId	integer (int32)
taskId	integer (int32)	Can be null. Optional task reference stored on the chat.

CreateGroupChatDto

Property	Type	Description
name	string	Can be null. Display name of the group.
userIds	array of integer (int32)	Can be null. Office users to add as participants.
driverIds	array of integer (int32)	Can be null. Drivers to add as participants, each with write access.

CreateSupportTicketRequest

Property	Type	Description
subject	string	Can be null.
description	string	Can be null.
priority	string	One of: Low, Normal, High, Urgent.
dueDate	string (date-time)	Can be null.

CreateUpdateTermsAndConditionsDto

Property	Type	Description
name	string	Can be null.
content	string	Can be null.

Customer

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
customerId	integer (int32)
companyId	integer (int32)
tenantId	string (uuid)
tenant	object
ratings	integer (int32)
customerName	string	Can be null.
localName	string	Can be null.
phone	string	Can be null.
phoneCountryCode	string	Can be null. Up to 4 characters.
phoneCountryIso	string	Can be null. Up to 3 characters.
phoneExtension	string	Can be null.
logo	string	Can be null.
salesRep	string	Can be null.
howDidYouHear	string	Can be null.
isBrokerAccount	boolean
status	integer (int32)	One of: 0 (Active), 1 (Deleted).
customerToken	string	Can be null.
addresses	array of Address	Can be null.
customerEmails	array of CustomerEmail	Can be null.
customerContacts	array of CustomerContact	Can be null.
customerPaymentMethods	array of CustomerPaymentMethod	Can be null.
openBalance	number (double)	Can be null.
invoices	array of Invoice	Can be null.
payments	array of Payment	Can be null.
pipeline	integer (int32)	One of: 0 (Prospect), 1 (Customer), 2 (Lead).
shipmentTypes	array of ShipmentType	Can be null.
isEntrepreneur	boolean
source	integer (int32)	One of: 0 (Default), 1 (Web), 2 (CustomerPortal).
quickBooksEmail	string	Can be null.
contactDate	string (date-time)	Can be null.
nextContactDate	string (date-time)	Can be null.
outreachResult	string	Can be null.
outreachStatus	integer (int32)	One of: 0 (None), 1 (Blank), 2 (SentEmail), 3 (SentQuote), 4 (Called), 5 (FoundCheaper), 6 (ChangedMind), 7 (Postponed), 8 (NeedExtraService).
sentEmailCardknoxConfigStatus	integer (int32)	One of: 1 (Sent), 2 (NotSent), 4 (Edited). Values can be combined by adding them together.
paymentTermsInDays	integer (int32)	Can be null.
isHasCardknoxConfig	boolean	Read-only.
isConfiguredCardknoxConfig	boolean	Read-only.
firstEmail	string	Read-only. Can be null.
mainAddress	Address
defaultCC	CustomerPaymentMethod

CustomerAccessRequestDto

Property	Type	Description
customerId	integer (int32)
customerName	string	Can be null.
email	string	Can be null.
phone	string	Can be null.
contactFirstName	string	Can be null.
contactLastName	string	Can be null.
city	string	Can be null.
state	string	Can be null.
requestedAt	string (date-time)
canApprove	boolean	False when the signup left no usable email address, so the invitation cannot be sent until an admin supplies one.

CustomerAccessRequestDtoPagedList

A page of results. See Pagination and filtering.

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

CustomerBalanceStats

Property	Type	Description
spent	number (double)
availableBalance	number (double)
totalOrders	number (double)
amountSpent	number (double)
displayDateMonth	string	Can be null.

CustomerContact

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
customerContactId	integer (int32)
customerId	integer (int32)	Can be null.
outsourceCompanyId	integer (int32)	Can be null.
countryId	integer (int32)	Can be null.
firstName	string	Can be null.
lastName	string	Can be null.
phone	string	Can be null.
phoneCountryCode	string	Can be null. Up to 4 characters.
phoneCountryIso	string	Can be null. Up to 3 characters.
phoneExtension	string	Can be null.
cell	string	Can be null.
cellCountryCode	string	Can be null. Up to 4 characters.
cellCountryIso	string	Can be null. Up to 3 characters.
email	string	Can be null.
isPrimary	boolean
active	boolean
deactivatedByCustomerDelete	boolean
companyType	string	One of: Customer, Outsource.
emailTypes	integer (int32)	One of: 0 (None), 1 (Email), 2 (Accounting), 4 (Billing), 8 (BillOfLanding), 16 (Invoice), 32 (Contact), 64 (Marketing), 128 (Appointment), 256 (Cardknox), 512 (AcceptPayment). Values can be combined by adding them together.
imageUrl	string	Can be null.
location	string	Can be null.
state	string	Can be null.
city	string	Can be null.
zip	string	Can be null.
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
country	object
creationType	integer (int32)	One of: 0 (Legacy), 1 (Default).
setCustomerContactName	boolean

CustomerContactDetailsResponse

Property	Type	Description
customerName	string	Can be null. Name of the customer.
customerId	integer (int32)	Can be null. Unique identifier of the customer.
customerEmails	array of CustomerEmail	Can be null. List of customer email addresses associated with the customer.
customerContacts	array of CustomerContact	Can be null. List of customer contact records associated with the customer.

CustomerEmail

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
customerEmailId	integer (int32)
tenantId	string (uuid)
companyId	integer (int32)
emailType	string	Can be null.
email	string	Can be null.
isActive	boolean
deactivatedByCustomerDelete	boolean
companyType	string	One of: Customer, Outsource.
emailTypes	integer (int32)	One of: 0 (None), 1 (Email), 2 (Accounting), 4 (Billing), 8 (BillOfLanding), 16 (Invoice), 32 (Contact), 64 (Marketing), 128 (Appointment), 256 (Cardknox), 512 (AcceptPayment). Values can be combined by adding them together.
customerId	integer (int32)	Can be null.
outsourceCompanyId	integer (int32)	Can be null.
company	Company
tenant	object

CustomerListDto

Property	Type	Description
customerId	integer (int32)
openBalance	number (double)
ratings	integer (int32)
customerName	string	Can be null.
localName	string	Can be null.
logo	string	Can be null.
phone	string	Can be null.
salesRep	string	Can be null.
howDidYouHear	string	Can be null.
isBrokerAccount	boolean
paymentTermsInDays	integer (int32)	Can be null.
customerPaymentMethods	array of CustomerPaymentMethod	Can be null.
customerContacts	array of CustomerContact	Can be null.
customerEmails	array of CustomerEmail	Can be null.
addresses	array of Address	Can be null.

CustomerListDtoPagedList

A page of results. See Pagination and filtering.

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

CustomerMessage

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
customerMessageId	integer (int32)
tenantId	string (uuid)
companyId	integer (int32)
customerId	integer (int32)
isDeleted	boolean
isPriceOffer	boolean
isAccepted	boolean
isRejected	boolean
type	string	One of: Incoming, Outcoming.
replyToMessageId	integer (int32)	Can be null.
orderId	integer (int32)	Can be null.
orderNumber	string	Can be null.
orderStopId	integer (int32)	Can be null.
isAppointmentRequest	boolean
appointmentStopLabel	string	Can be null.
appointmentStopCompanyName	string	Can be null.
appointmentAddress	string	Can be null.
appointmentContactPhone	string	Can be null.
appointmentFromDateTime	string (date-time)	Can be null.
appointmentTillDateTime	string (date-time)	Can be null.
messageFromUserId	string	Can be null.
text	string	Can be null.
customer	Customer
replyToMessage	CustomerMessage
messageFromUser	object
files	array of CustomerMessageFile	Can be null.
tags	array of CustomerMessageTag	Can be null.
reactions	array of Reaction	Can be null.

CustomerMessageFile

Property	Type	Description
customerMessageFileId	integer (int32)
tenantId	string (uuid)
companyId	integer (int32)
customerMessageId	integer (int32)
fileName	string	Can be null.
url	string	Can be null.
customerMessage	CustomerMessage

CustomerMessageTag

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

CustomerMessageTagDto

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

CustomerPagedList

A page of results. See Pagination and filtering.

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

CustomerPaymentMethod

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
name	string	Can be null.
paymentType	integer (int32)	One of: 0 (CreditCard), 1 (Ach), 2 (Paypal), 3 (Cash).
token	string	Can be null.
cardType	integer (int32)	One of: 0 (Visa), 1 (Amex), 2 (MasterCard), 3 (Discover), 4 (GiftCard).
maskedNumber	string	Can be null.
expDate	string	Can be null.
routingNumber	string	Can be null.
paypalEmail	string	Can be null.
isDefault	boolean
isDeleted	boolean
address	Address
formatedMethod	string	Read-only. Can be null.
customerPaymentMethodId	integer (int32)
customerId	integer (int32)
companyId	integer (int32)
company	Company
tenantId	string (uuid)
tenant	object
addressId	integer (int32)	Can be null.

CustomerPortalUserDto

Property	Type	Description
userId	string	Can be null.
email	string	Can be null.
firstName	string	Can be null.
lastName	string	Can be null.
customerId	integer (int32)
customerName	string	Can be null.
isDisabled	boolean
mustChangePassword	boolean
initialPassword	string	Can be null.

CustomerStats

Property	Type	Description
totalOrders	integer (int32)
amountSpent	number (double)
ordersChart	map of integer (int32)	Can be null.
creditAmount	number (double)
creditSpent	number (double)
creditAvailable	number (double)