Models D–H

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.

DailyOrderNumbersDto

Property	Type	Description
date	string (date-time)
count	integer (int32)

DashboardDefinitionDto

Property	Type	Description
dashboardDefinitionId	integer (int32)
name	string	Can be null.
isDefault	boolean
isPersonal	boolean	True = personal dashboard of the current user.
layoutJson	string	Can be null.
updatedTime	string (date-time)	Can be null.

DeleteContactResultDto

Property	Type	Description
customerContactId	integer (int32)
contactName	string	Can be null.
reassignedOrderCount	integer (int32)	Orders and quotes re-pointed at the primary contact.
reassignedToContactId	integer (int32)	Can be null.
reassignedToContactName	string	Can be null.

DepositAccount

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
depositAccountId	integer (int32)
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
name	string	Can be null.
isActive	boolean
isDefault	boolean
total	number (double)

DocumentAuditEventDto

Property	Type	Description
id	integer (int32)
eventType	string	One of: Uploaded, Captured, ImportCommitted, EntityCreated, Deleted, Reprocessed, BulkAction, Emailed.
linkEntityType	string	Can be null. One of: Order, Customer, PricingModel, ChargeType, LoadUnit, Invoice, Quote, Driver.
entityId	integer (int32)	Can be null.
userId	string	Can be null.
userName	string	Can be null.
detailsJson	string	Can be null.
at	string (date-time)

DocumentRetentionExcludedItemDto

An aged document that is retained, with the reason it is excluded from purge.

Property	Type	Description
companyDocumentId	integer (int32)
name	string	Can be null.
createdTime	string (date-time)
sizeBytes	integer (int64)
status	string	One of: Uploaded, Processing, Ready, Failed.
reason	string	Can be null.

DocumentRetentionItemDto

One document in the retention preview's candidate list.

Property	Type	Description
companyDocumentId	integer (int32)
name	string	Can be null.
createdTime	string (date-time)
sizeBytes	integer (int64)
status	string	One of: Uploaded, Processing, Ready, Failed.

DocumentRetentionPreviewDto

Property	Type	Description
enabled	boolean
retentionDays	integer (int32)	The configured window in days (0 when disabled).
cutoff	string (date-time)	Can be null. Documents created strictly before this UTC instant are "aged" (null when disabled).
candidateCount	integer (int32)
candidateSizeBytes	integer (int64)	Total bytes the candidates occupy.
excludedCount	integer (int32)
candidates	array of DocumentRetentionItemDto	Can be null.
excluded	array of DocumentRetentionExcludedItemDto	Can be null.

Driver

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
driverId	integer (int32)
userId	string	Can be null.
companyId	integer (int32)
tenantId	string (uuid)
outsourceCompanyId	integer (int32)	Can be null.
countryId	integer (int32)	Can be null.
company	Company
outsourceCompany	object
tenant	object
driverImage	string	Can be null.
firstName	string	Can be null.
middleName	string	Can be null.
lastName	string	Can be null.
phoneNumber	string	Can be null.
phoneCountryCode	string	Can be null. Up to 4 characters.
phoneCountryIso	string	Can be null. Up to 3 characters.
cellNumber	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.
addressLine1	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.
ssn	string	Can be null.
gender	string	Can be null. One of: Male, Female.
dob	string (date-time)	Can be null.
licenseImage	string	Can be null.
licenseNumber	string	Can be null.
licenseType	string	Can be null.
licenseExpires	string (date-time)	Can be null.
licenseCountry	string	Can be null.
licenseState	string	Can be null.
status	string	One of: Active, Inactive, Deleted, Draft, New, Invited, Disabled.
quickBooksClassName	string	Can be null.
telegramUserId	string	Can be null.
experience	integer (int32)
language	string	Can be null.
registationCardImage	string	Can be null.
insurancenCardImage	string	Can be null.
vehicleBrand	string	Can be null.
plateNumber	string	Can be null.
vehicleToDisplay	string	Can be null.
ratings	integer (int32)
country	object
routes	array of Route	Can be null.
driverStatusChecks	array of DriverStatusCheck	Can be null.
sentEmailStatus	integer (int32)	One of: 1 (Sent), 2 (NotSent), 4 (Edited). Values can be combined by adding them together.
driverType	string	One of: Default, Outsource, Mixed.
driverStatus	string	One of: New, Approved, Blocked, Deactivated.
employment	string	Can be null. One of: FullTime, PartTime, OneTime.
payout	string	Can be null. One of: Hourly, FixedSalary, Distance, FixDistance, FixHourly, Percent, DistanceAndPercent, FixedCost, Pallets.
openBalance	number (double)
deactivatedAt	string (date-time)	Can be null.
deactivatedReason	string	Can be null.
erasureRequestedAt	string (date-time)	Can be null.
erasedAt	string (date-time)	Can be null. UTC instant at which the erasure actually completed.
driverRouteViewOverrideEnabled	boolean
driverRouteViewMode	string	One of: Full, Restricted.
fullName	string	Read-only. Can be null.
companyName	string	Can be null.
isAssigned	boolean	Can be null.
chatId	integer (int32)	Can be null.
isChat	boolean
unreadCount	integer (int32)

DriverApplicationSettings

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
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
requireDvirStartOfShift	boolean
requireDvirEndOfShift	boolean
requireSignatureOnDelivery	boolean
requirePhotosOnDelivery	boolean
blockCompletionOnMissingRequirements	boolean
distanceUnit	integer (int32)	One of: 0 (Miles), 1 (Kilometers).
mapProvider	integer (int32)	One of: 0 (Google), 1 (PlatformDefault).
locationTrackingIntervalSeconds	integer (int32)
routeRefreshMinutes	integer (int32)
stopProximityNotificationKm	number (double)
lateArrivalThresholdMins	integer (int32)
attemptTransferHandling	integer (int32)	How a stop attempt ("Retry later today" / "Can't pickup today") affects planned transfer legs that depend on the attempted stop. One of: 0 (RemoveAndNotify), 1 (RemoveSilently), 2 (KeepTransferLegs).
enableHosFeature	boolean
enableNearbyAmenities	boolean
enableIssueReporting	boolean
enableViolationsView	boolean
enableChargesCollection	boolean
enablePaperworkScanning	boolean

DriverPagedList

A page of results. See Pagination and filtering.

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

DriversStats

Property	Type	Description
driverId	integer (int32)
totalOrders	integer (int32)
totalHours	integer (int32)
violations	integer (int32)
lateDeliveries	integer (int32)

DriverStatusCheck

Property	Type	Description
id	integer (int32)
companyId	integer (int32)
tenantId	string (uuid)
driverId	integer (int32)
isActive	boolean
headlightsCheck	boolean
turnSignalsCheck	boolean
brakeLightsCheck	boolean
fluidLeaksCheck	boolean
hornCheck	boolean
mirrorsCheck	boolean
breaksCheck	boolean
breaksLightsCheck	boolean
reverseLightsBackupAlarmCheck	boolean
date	string (date-time)
createdAt	string (date-time)
type	integer (int32)	One of: 0 (StartDay), 1 (EndDay).
inspectionStatus	integer (int32)	One of: 1 (Pending), 2 (Failed), 3 (Maintenance), 4 (Completed).
truckId	integer (int32)	Can be null.
routeId	integer (int32)	Can be null.
plateNumber	string	Can be null.
frontTruckImage	string	Can be null.
backTruckImage	string	Can be null.
headlightsCheckComment	string	Can be null.
turnSignalsCheckComment	string	Can be null.
brakeLightsCheckComment	string	Can be null.
fluidLeaksCheckComment	string	Can be null.
hornCheckComment	string	Can be null.
mirrorsCheckComment	string	Can be null.
breaksCheckComment	string	Can be null.
breaksLightsCheckComment	string	Can be null.
reverseLightsBackupAlarmCheckComment	string	Can be null.
inspectionSignatureImage	string	Can be null.
notes	string	Can be null.
customChecksJson	string	Can be null.
truck	Truck
driver	Driver
company	Company
tenant	object
attachments	array of Attachment	Can be null.

DriverStatusCheckPagedList

A page of results. See Pagination and filtering.

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

EditableCompanyDocumentDto

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

EmailAttachmentDto

Property	Type	Description
id	integer (int32)
fileName	string	Can be null.
mimeType	string	Can be null.
sizeBytes	integer (int64)
companyDocumentId	integer (int32)	Can be null.
hasBlob	boolean

EmailCompanyDocumentDto

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

EmailMessageDetailDto

Property	Type	Description
id	integer (int32)
direction	string	One of: Inbound, Outbound.
status	string	One of: Received, Sent, Failed, SkippedNonProduction, Draft, Suppressed, SkippedNoRecipient.
sensitivity	string	One of: None, SecretRedacted.
fromAddress	string	Can be null.
fromName	string	Can be null.
toAddresses	string	Can be null.
subject	string	Can be null.
snippet	string	Can be null.
isRead	boolean
sentAt	string (date-time)	Can be null.
receivedAt	string (date-time)	Can be null.
createdTime	string (date-time)
hasAttachments	boolean
attachmentCount	integer (int32)
orderId	integer (int32)	Can be null.
invoiceId	integer (int32)	Can be null.
customerId	integer (int32)	Can be null.
quoteId	integer (int32)	Can be null.
htmlBody	string	Can be null.
textBody	string	Can be null.
rawHeaders	string	Can be null.
providerMessageId	string	Can be null.
statusDetail	string	Can be null.
to	array of string	Can be null.
cc	array of string	Can be null.
bcc	array of string	Can be null.
attachments	array of EmailAttachmentDto	Can be null.

EmailMessageListDto

Property	Type	Description
id	integer (int32)
direction	string	One of: Inbound, Outbound.
status	string	One of: Received, Sent, Failed, SkippedNonProduction, Draft, Suppressed, SkippedNoRecipient.
sensitivity	string	One of: None, SecretRedacted.
fromAddress	string	Can be null.
fromName	string	Can be null.
toAddresses	string	Can be null.
subject	string	Can be null.
snippet	string	Can be null.
isRead	boolean
sentAt	string (date-time)	Can be null.
receivedAt	string (date-time)	Can be null.
createdTime	string (date-time)
hasAttachments	boolean
attachmentCount	integer (int32)
orderId	integer (int32)	Can be null.
invoiceId	integer (int32)	Can be null.
customerId	integer (int32)	Can be null.
quoteId	integer (int32)	Can be null.

EmailMessageListDtoPagedList

A page of results. See Pagination and filtering.

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

EmailRecipient

Property	Type	Description
email	string	Can be null.
customerId	integer (int32)	Can be null.
addNewContact	boolean	Can be null.

EmailSendRequest

Property	Type	Description
email	array of string	Can be null.
emailRecipient	array of EmailRecipient	Can be null.
message	string	Can be null.
tags	array of CustomerMessageTagDto	Can be null.

EmailTypeInfo

Property	Type	Description
value	integer (int32)
name	string	Can be null.
kind	integer (int32)	One of: 0 (Regular), 1 (Static).
isStatic	boolean

ExpandUrlRequestDto

Property	Type	Description
link	string	Can be null.

ExpandUrlResponseDto

Property	Type	Description
fullLink	string	Can be null.

Expense

A single recorded operating cost.

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
expenseId	integer (int32)
companyId	integer (int32)
tenantId	string (uuid)
company	Company
tenant	object
type	integer (int32)	One of: 0 (Trucks), 1 (DriverRoutePayout), 2 (OutsourceCompanyRoutePayout), 3 (Office).
subtype	integer (int32)	One of: 0 (TruckGas), 1 (TruckInsurance), 2 (TruckMaintenance), 3 (TruckPayment), 4 (TruckTrailer), 5 (TruckLicense), 6 (TruckTool), 7 (TruckOther), 8 (TruckMiles), 9 (OdometerStart), 10 (OdometerEnd), 100 (OfficeGPS), 101 (OfficeInternet), 102 (OfficeOther).
amount	number (double)
truckId	integer (int32)	Can be null.
truck	Truck
date	string (date-time)
status	string	One of: Active, Inactive, Deleted.
name	string	Can be null.
deletionDate	string (date-time)	Can be null.
isDefault	boolean	Indicates that this expense is default for a month that has no actual record but draws from a previous real expense.
categoryId	integer (int32)	Can be null.
category	object
vendorId	integer (int32)	Can be null.
vendor	object
vendorNameSnapshot	string	Can be null. Up to 255 characters.
driverId	integer (int32)	Can be null.
orderId	integer (int32)	Can be null.
routeId	integer (int32)	Can be null.
outsourceCompanyId	integer (int32)	Can be null. Set when the payee is a known carrier/subcontractor rather than a free vendor.
currencyCode	string	Can be null. Iso-4217, null = the company default. Up to 3 characters.
quantity	number (double)	Can be null.
uom	string	Can be null. Up to 20 characters.
unitPrice	number (double)	Can be null.
fuelType	string	Can be null. One of: Diesel, DieselExhaustFluid, ReeferDiesel, Gasoline, Cng, Lng, Propane, Electric, Biodiesel, Other.
jurisdictionState	string	Can be null. Jurisdiction the fuel was bought in. Up to 10 characters.
odometerReading	number (double)	Can be null. Odometer at the time of purchase.
isIftaEligible	boolean
isBillableToOrder	boolean
rebillStatus	string	One of: NotBillable, Pending, Invoiced, Absorbed.
invoiceLineId	integer (int32)	Can be null. The invoice line this cost was recovered on, once it has been billed.
approvalStatus	string	One of: Approved, Draft, Submitted, Rejected.
approvedByUserId	string	Can be null. Up to 450 characters.
approvedAt	string (date-time)	Can be null.
rejectionReason	string	Can be null. Up to 500 characters.
submittedByUserId	string	Can be null. Up to 450 characters.
submittedAt	string (date-time)	Can be null.
source	string	One of: MonthlyGrid, Manual, Mobile, Receipt, FuelCardImport, Recurring, Api, Import.
sourceDocumentId	integer (int32)	Can be null.
paymentMethod	string	Can be null. One of: Unspecified, Cash, CreditCard, FuelCard, Check, Ach, Comchek, DriverAdvance, Other.
isCapital	boolean	True when the purchase should be capitalised to a fixed-asset register rather than expensed.
notes	string	Can be null. Up to 1000 characters.
referenceNumber	string	Can be null. Vendor invoice number, trip number or fuel-card transaction reference. Up to 100 characters.
externalId	string	Can be null. Stable key from the originating system. Up to 128 characters.
recurringScheduleId	integer (int32)	Can be null.
isAccrual	boolean	True when the amount is a periodic slice of a larger prepaid outlay (an annual insurance premium spread over 12 months) rather than a cash event in this period.

ExpenseAmountByCategoryDto

Property	Type	Description
categoryId	integer (int32)
name	string	Can be null.
amount	number (double)
percentOfTotal	number (double)	Percent of the period's total spend.
costBehavior	string	One of: Variable, Fixed, SemiVariable.
rowCount	integer (int32)

ExpenseAmountByTypeDto

Property	Type	Description
type	integer (int32)	One of: 0 (Trucks), 1 (DriverRoutePayout), 2 (OutsourceCompanyRoutePayout), 3 (Office).
typeName	string	Can be null.
amount	number (double)
rowCount	integer (int32)

ExpenseAnalyticsSummaryDto

Property	Type	Description
startDate	string (date-time)
endDate	string (date-time)	End of the window actually used.
totalSpend	number (double)
currencyCode	string	Can be null. The company's default iso-4217 code.
rowCount	integer (int32)
byType	array of ExpenseAmountByTypeDto	Can be null.
byCategory	array of ExpenseAmountByCategoryDto	Can be null.
fixedSpend	number (double)
variableSpend	number (double)
semiVariableSpend	number (double)
uncategorizedSpend	number (double)	Spend with no readable category.
totalMiles	number (double)
costPerMile	object	Total-mile cost per mile.
fixedCostPerMile	object	Fixed spend ÷ total miles.
variableCostPerMile	object
truckOnlyCostPerMile	object
activeTruckCount	integer (int32)
costPerTruck	object
priorPeriodStartDate	string (date-time)
priorPeriodEndDate	string (date-time)
priorPeriodTotalSpend	number (double)
deltaPercent	number (double)	Can be null. Percent change vs the prior window.
pendingApprovalCount	integer (int32)
pendingApprovalAmount	number (double)
missingReceiptCount	integer (int32)

ExpenseAssignOrderDto

Property	Type	Description
orderId	integer (int32)	Can be null. The order to attach the cost to, or null to detach it.

ExpenseBenchmarkDto

Property	Type	Description
source	string	Can be null. Full citation of the publication these figures come from.
asOfYear	integer (int32)	The year the underlying operational data describes (not the publication year).
currencyCode	string	Can be null.
lines	array of ExpenseBenchmarkLineDto	Can be null. The nine line items.
totalPerMile	number (double)	Average marginal cost, usd per mile.
totalExcludingFuelPerMile	number (double)	Total less the fuel line.
costPerHour	number (double)	Average marginal cost, usd per hour.
deadheadPercentNonTank	number (double)	Industry empty-mile share for non-tank operations, percent.
disclaimer	string	Can be null. Human-readable "this is not your data" warning, safe to render verbatim.

ExpenseBenchmarkLineDto

One published industry per-mile line item.

Property	Type	Description
key	string	Can be null.
name	string	Can be null.
perMile	number (double)	Industry average, usd per mile.
mapsToSubtype	integer (int32)	Can be null. One of: 0 (TruckGas), 1 (TruckInsurance), 2 (TruckMaintenance), 3 (TruckPayment), 4 (TruckTrailer), 5 (TruckLicense), 6 (TruckTool), 7 (TruckOther), 8 (TruckMiles), 9 (OdometerStart), 10 (OdometerEnd), 100 (OfficeGPS), 101 (OfficeInternet), 102 (OfficeOther).
mapsToSubtypeName	string	Can be null.
note	string	Can be null. Definition caveats that change what a fair comparison is.

ExpenseBulkActionDto

Body of the bulk approve / reject / categorize endpoints.

Property	Type	Description
expenseIds	array of integer (int32)	Can be null.
reason	string	Can be null.
categoryId	integer (int32)	Can be null. Required by bulk categorize.

ExpenseBulkItemResultDto

One id's outcome inside a bulk operation.

Property	Type	Description
expenseId	integer (int32)
success	boolean
errorCode	string	Can be null.
message	string	Can be null.

ExpenseBulkResultDto

Outcome of a bulk operation.

Property	Type	Description
succeededCount	integer (int32)
failedCount	integer (int32)
results	array of ExpenseBulkItemResultDto	Can be null.

ExpenseBySubtypeStats

Property	Type	Description
subtype	integer (int32)	One of: 0 (TruckGas), 1 (TruckInsurance), 2 (TruckMaintenance), 3 (TruckPayment), 4 (TruckTrailer), 5 (TruckLicense), 6 (TruckTool), 7 (TruckOther), 8 (TruckMiles), 9 (OdometerStart), 10 (OdometerEnd), 100 (OfficeGPS), 101 (OfficeInternet), 102 (OfficeOther).
amount	number (double)

ExpenseByTruckDto

One truck's cost line.

Property	Type	Description
truckId	integer (int32)
truckName	string	Can be null.
plateNumber	string	Can be null.
totalSpend	number (double)
miles	number (double)
costPerMile	object
fuelSpend	number (double)
maintenanceSpend	number (double)
insuranceSpend	number (double)
rowCount	integer (int32)

ExpenseCategoryDto

Property	Type	Description
expenseCategoryId	integer (int32)	0 or absent creates a new category.
name	string	Can be null.
parentId	integer (int32)	Can be null.
parentName	string	Can be null.
costBehavior	string	One of: Variable, Fixed, SemiVariable.
defaultCostObject	string	One of: Overhead, Truck, Driver, Order.
mapsToType	integer (int32)	One of: 0 (Trucks), 1 (DriverRoutePayout), 2 (OutsourceCompanyRoutePayout), 3 (Office).
mapsToSubtype	integer (int32)	One of: 0 (TruckGas), 1 (TruckInsurance), 2 (TruckMaintenance), 3 (TruckPayment), 4 (TruckTrailer), 5 (TruckLicense), 6 (TruckTool), 7 (TruckOther), 8 (TruckMiles), 9 (OdometerStart), 10 (OdometerEnd), 100 (OfficeGPS), 101 (OfficeInternet), 102 (OfficeOther).
isIftaFuel	boolean	Counts toward IFTA taxable gallons.
isBillableDefault	boolean
requiresReceipt	boolean	Blocks approval until a receipt document is attached.
approvalThresholdOverride	number (double)	Can be null.
glAccountCode	string	Can be null.
qbAccountName	string	Can be null.
isSystem	boolean
isActive	boolean
sortOrder	integer (int32)
description	string	Can be null.

ExpenseCategoryTrendDto

Property	Type	Description
categoryId	integer (int32)
categoryName	string	Can be null.
costBehavior	string	One of: Variable, Fixed, SemiVariable.
currencyCode	string	Can be null.
points	array of ExpenseCategoryTrendPointDto	Can be null.

ExpenseCategoryTrendPointDto

Property	Type	Description
month	string	Can be null.
total	number (double)
rowCount	integer (int32)

ExpenseCommittedSpendAmountDto

One currency's slice of a bucket.

Property	Type	Description
currencyCode	string	Can be null. Up to 3 characters.
cashAmount	number (double)
accruedAmount	number (double)
occurrenceCount	integer (int32)	Occurrences whose cash lands in this bucket.

ExpenseCommittedSpendDto

Property	Type	Description
from	string (date-time)
to	string (date-time)	The effective window end.
defaultCurrencyCode	string	Can be null. Up to 3 characters.
isMultiCurrency	boolean	True when the schedules in scope span more than one currency.
months	array of ExpenseCommittedSpendMonthDto	Can be null. One entry per calendar month in the window, oldest first.
totals	array of ExpenseCommittedSpendAmountDto	Can be null. Whole-window totals, one entry per currency.
schedulesConsidered	integer (int32)	Schedules that contributed nothing (finished, or nothing due inside the window).
schedulesContributing	integer (int32)	Schedules that contributed at least one amount to the window.

ExpenseCommittedSpendMonthDto

One calendar month of the forecast.

Property	Type	Description
monthStart	string (date-time)
year	integer (int32)
month	integer (int32)
amounts	array of ExpenseCommittedSpendAmountDto	Can be null. Per-currency amounts for this month.

ExpenseDto

Property	Type	Description
expenseId	integer (int32)
type	integer (int32)	One of: 0 (Trucks), 1 (DriverRoutePayout), 2 (OutsourceCompanyRoutePayout), 3 (Office).
subtype	integer (int32)	One of: 0 (TruckGas), 1 (TruckInsurance), 2 (TruckMaintenance), 3 (TruckPayment), 4 (TruckTrailer), 5 (TruckLicense), 6 (TruckTool), 7 (TruckOther), 8 (TruckMiles), 9 (OdometerStart), 10 (OdometerEnd), 100 (OfficeGPS), 101 (OfficeInternet), 102 (OfficeOther).
amount	number (double)
date	string (date-time)
status	string	One of: Active, Inactive, Deleted.
name	string	Can be null.
deletionDate	string (date-time)	Can be null.
categoryId	integer (int32)	Can be null.
categoryName	string	Can be null.
vendorId	integer (int32)	Can be null.
vendorName	string	Can be null.
vendorNameSnapshot	string	Can be null.
truckId	integer (int32)	Can be null.
truckName	string	Can be null.
driverId	integer (int32)	Can be null.
driverName	string	Can be null.
orderId	integer (int32)	Can be null.
orderNumber	string	Can be null.
routeId	integer (int32)	Can be null.
outsourceCompanyId	integer (int32)	Can be null.
currencyCode	string	Can be null.
quantity	number (double)	Can be null.
uom	string	Can be null.
unitPrice	number (double)	Can be null.
fuelType	string	Can be null. One of: Diesel, DieselExhaustFluid, ReeferDiesel, Gasoline, Cng, Lng, Propane, Electric, Biodiesel, Other.
jurisdictionState	string	Can be null. Two-letter US state / Canadian province the fuel was bought in.
odometerReading	number (double)	Can be null.
isIftaEligible	boolean	Can be null.
isBillableToOrder	boolean
rebillStatus	string	One of: NotBillable, Pending, Invoiced, Absorbed.
invoiceLineId	integer (int32)	Can be null.
approvalStatus	string	One of: Approved, Draft, Submitted, Rejected.
approvedByUserId	string	Can be null.
approvedAt	string (date-time)	Can be null.
rejectionReason	string	Can be null.
submittedByUserId	string	Can be null.
submittedAt	string (date-time)	Can be null.
source	string	One of: MonthlyGrid, Manual, Mobile, Receipt, FuelCardImport, Recurring, Api, Import.
sourceDocumentId	integer (int32)	Can be null.
hasReceipt	boolean
paymentMethod	string	Can be null. One of: Unspecified, Cash, CreditCard, FuelCard, Check, Ach, Comchek, DriverAdvance, Other.
isCapital	boolean
notes	string	Can be null.
referenceNumber	string	Can be null.
externalId	string	Can be null.
recurringScheduleId	integer (int32)	Can be null.
isAccrual	boolean
isMeasurementRow	boolean
createdTime	string (date-time)
updatedTime	string (date-time)	Can be null.

ExpenseMonthlyTrendPointDto

Property	Type	Description
month	string	Can be null.
total	number (double)
rowCount	integer (int32)
byType	array of ExpenseAmountByTypeDto	Can be null.

ExpensePagedList

A page of results. See Pagination and filtering.

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

ExpenseRecurringRunResultDto

Result of posting a schedule's occurrences on demand ("run now").

Property	Type	Description
expenseRecurringScheduleId	integer (int32)
rowsCreated	integer (int32)
occurrencesProcessed	integer (int32)	Occurrences the run walked past (posted or already-posted).
nextRunDate	string (date-time)	Can be null. The schedule's next unposted occurrence after this run.

ExpenseRecurringScheduleDto

Property	Type	Description
expenseRecurringScheduleId	integer (int32)
name	string	Can be null. Up to 200 characters.
categoryId	integer (int32)	Can be null.
categoryName	string	Can be null. Up to 150 characters.
vendorId	integer (int32)	Can be null.
vendorName	string	Can be null. Up to 255 characters.
amount	number (double)	Amount of one occurrence, before any amortisation split.
currencyCode	string	Can be null. Up to 3 characters.
frequency	string	One of: Monthly, Weekly, BiWeekly, Quarterly, SemiAnnual, Annual.
startDate	string (date-time)
endDate	string (date-time)	Can be null.
dayOfMonth	integer (int32)
truckId	integer (int32)	Can be null.
truckName	string	Can be null. Up to 255 characters.
driverId	integer (int32)	Can be null.
amortizeMonths	integer (int32)	Can be null.
autoPost	boolean
nextRunDate	string (date-time)	Can be null.
lastRunDate	string (date-time)	Can be null.
nextOccurrenceDate	string (date-time)	Can be null.
varianceAlertPercent	number (double)	Can be null.
isActive	boolean
notes	string	Can be null. Up to 1000 characters.

ExpenseRejectDto

Property	Type	Description
reason	string	Can be null.

ExpensesByTypeStats

Property	Type	Description
amount	number (double)
type	integer (int32)	One of: 0 (Trucks), 1 (DriverRoutePayout), 2 (OutsourceCompanyRoutePayout), 3 (Office).
subtypeStats	array of ExpenseBySubtypeStats	Can be null.

ExpenseSearchResultDto

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

ExpenseTruckDetailDto

Property	Type	Description
truckId	integer (int32)
truckName	string	Can be null.
plateNumber	string	Can be null.
vin	string	Can be null.
truckType	string	Can be null.
truckStatus	string	One of: Active, Inactive, Deleted.
truckMissing	boolean
excludedForPeriod	boolean
startDate	string (date-time)
endDate	string (date-time)
currencyCode	string	Can be null.
totalSpend	number (double)
rowCount	integer (int32)
miles	number (double)
costPerMile	object
fleetCostPerMile	object	The whole fleet's rate over the same window, for context.
priorPeriodTotalSpend	number (double)
deltaPercent	number (double)	Can be null. Null when the prior window had no spend.
bySubtype	array of ExpenseTruckSubtypeDto	Can be null.
byCategory	array of ExpenseAmountByCategoryDto	Can be null.
monthlyTrend	array of ExpenseMonthlyTrendPointDto	Can be null. Trailing months for this truck alone, oldest first.

ExpenseTruckSubtypeDto

Property	Type	Description
subtype	integer (int32)	One of: 0 (TruckGas), 1 (TruckInsurance), 2 (TruckMaintenance), 3 (TruckPayment), 4 (TruckTrailer), 5 (TruckLicense), 6 (TruckTool), 7 (TruckOther), 8 (TruckMiles), 9 (OdometerStart), 10 (OdometerEnd), 100 (OfficeGPS), 101 (OfficeInternet), 102 (OfficeOther).
subtypeName	string	Can be null.
amount	number (double)
rowCount	integer (int32)

ExpenseVendorDto

Property	Type	Description
expenseVendorId	integer (int32)
name	string	Can be null. Up to 255 characters.
addressLine1	string	Can be null. Up to 255 characters.
city	string	Can be null. Up to 100 characters.
state	string	Can be null. Up to 50 characters.
zip	string	Can be null. Up to 20 characters.
country	string	Can be null. Up to 50 characters.
phone	string	Can be null. Up to 50 characters.
email	string	Can be null. Up to 255 characters.
taxId	string	Can be null. Up to 50 characters.
is1099Vendor	boolean	Marks the payee as 1099-nec reportable.
defaultCategoryId	integer (int32)	Can be null. Pre-selects a category when this vendor is chosen.
defaultCategoryName	string	Can be null. Up to 150 characters.
paymentTermsInDays	integer (int32)	Can be null. Net-N terms, for AP aging.
qbVendorName	string	Can be null. Up to 150 characters.
outsourceCompanyId	integer (int32)	Can be null.
vendorCode	string	Can be null. Fuel-network vendor code (Pilot, Loves, TA…). Up to 50 characters.
isActive	boolean	Can be null.
notes	string	Can be null. Up to 1000 characters.
createdTime	string (date-time)	Can be null. When the vendor was first recorded.
totalSpend	number (double)	Can be null. Total expensed to this vendor inside the requested window, for the spend-concentration and 1099-prep views.
expenseCount	integer (int32)	Can be null.

ExpenseVendorDtoPagedList

A page of results. See Pagination and filtering.

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

ExportContactsRequestModel

Property	Type	Description
ids	array of integer (int32)	Can be null.
selectedColumns	array of string	Can be null.

File

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

FreightPayment

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
freightPaymentId	integer (int32)
tenantId	string (uuid)
companyId	integer (int32)
payerCustomerId	integer (int32)
receiverCustomerId	integer (int32)
orderStopId	integer (int32)
isActive	boolean
paymentType	string	One of: Cardknox, Stripe, PayPal, Cash, Check, ACH, Other.
paymentProviderType	string	One of: Cardknox, Stripe, PayPal, Manual, Other.
totalAmount	number (double)
paymentEmail	string	Can be null.
sentEmailStatus	integer (int32)	One of: 1 (Sent), 2 (NotSent), 4 (Edited). Values can be combined by adding them together.
sentEmails	array of SentEmail	Can be null.
transactions	array of FreightPaymentTransaction	Can be null.
amountPaid	number (double)	Read-only.
paymentStatus	string	Read-only. One of: Pending, Authorized, Paid, PartialPaid, Failed.

FreightPaymentTransaction

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
freightPaymentTransactionId	integer (int32)
tenantId	string (uuid)
companyId	integer (int32)
freightPaymentId	integer (int32)
amount	number (double)
status	string	One of: Pending, Authorized, Paid, PartialPaid, Failed.
paymentProviderType	string	One of: Cardknox, Stripe, PayPal, Manual, Other.
manualReference	string	Can be null. Human-entered receipt, check, or other reference for Manual payments only.
manualReferenceType	string	Can be null. One of: Receipt, CheckNumber, Other.
email	string	Can be null.

FullAddressInfo

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.

FullAddressInfoPagedList

A page of results. See Pagination and filtering.

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

FxRate

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)
tenantId	string (uuid)
companyId	integer (int32)
fromCurrencyCode	string	Can be null. Up to 3 characters.
destinationCurrencyCode	string	Can be null. Up to 3 characters.
rateDate	string (date-time)	The day this rate applies from, as a date (the time component is not meaningful).
rate	number (double)
source	string	Can be null. Up to 200 characters.