Order

Table:
order
Model Version:
b69e922c70cb0725
JSON Schema:
Order
allowCollectPayment
boolean
allowCustomerAuthorization
boolean
allowCustomerViewActivity
boolean
allowCustomerViewAuthorizations
boolean
allowCustomerViewInspections
boolean
allowCustomerViewMessages
boolean
appointmentDates
string[]
archived
boolean
assignedTechnicianIds
string[]
authorized
boolean
authorizedDate
Nullable
date-time
coalescedName
Nullable
string
companyId
string
complaint
Nullable
string
completedAuthorizedLaborHours
number
completedDate
Nullable
date-time
completedLaborHours
number
conversationId
Nullable
string
createdDate
date-time
customFields
Nullable
object
custom field values
customerId
Nullable
string
deferredServiceCount
integer
deleted
boolean
if the record has been deleted
deletedDate
Nullable
date-time
the date that the record was deleted or null if not deleted
deletedReason
Nullable
string
the reason that the record was deleted
deletedUserId
Nullable
string
the user that deleted the record or null if not deleted
discountCents
integer
discountPercent
number
dueDate
Nullable
date-time
emailId
Nullable
string
id of the email to use instead of the customer's default email
epaCents
integer
externalNumber
Nullable
string
allow user to override generated number
feesCents
integer
fullyPaidDate
Nullable
date-time
generatedCustomerName
Nullable
string
"[firstName] [lastName]" pulled from the customer, if any
generatedName
Nullable
string
generatedVehicleName
Nullable
string
"[year] [make] [model] [submodel]" pulled from the vehicle, if any
gstCents
integer
hstCents
integer
id
Primary Key
string
imported
boolean
inspectionCount
integer
inspectionStatus
None, Completed, NotCompleted
invoiced
boolean
invoicedDate
Nullable
date-time
labels
object
laborCents
integer
locationId
string
messageCount
integer
messagedDate
Nullable
date-time
metadata
Nullable
object
metadata reserved for customers to control
mileageIn
Nullable
number
mileageOut
Nullable
number
name
Nullable
string
number
string
orderCreatedDate
date-time
allow user to override created date
paid
boolean
paidCostCents
integer
partsCents
integer
paymentDueDate
Nullable
date-time
paymentTermId
Nullable
string
id of the payment term for the order
phoneNumberId
Nullable
string
id of the phone number to use instead of the customer's default number
profitability
Nullable
object
pstCents
integer
publicId
string
purchaseOrderNumber
Nullable
string
readOnly
boolean
if this order should not be editable in the UI
readOnlyReason
Nullable
string
a friendly explanation of why (eg. "migrated from previous system")
recommendation
Nullable
string
remainingCostCents
Nullable
integer
repairOrderDate
Nullable
date-time
// the date the order was moved into repair order status
requestedDepositCents
integer
requireESignatureOnAuthorization
boolean
requireESignatureOnInvoice
boolean
sentToCarfax
boolean
serviceWriterId
Nullable
string
shopSuppliesCents
integer
shopUnreadMessageCount
integer
statementId
Nullable
string
a statement this order included in
status
Estimate, RepairOrder, Invoice
subcontractsCents
integer
taxCents
integer
taxConfigId
Nullable
string
tiresCents
integer
totalAuthorizedLaborHours
number
totalCostCents
integer
totalLaborHours
number
transactionFeeConfigId
Nullable
string
transactionalFeeSubtotalCents
integer
// value before taxes
transactionalFeeTotalCents
integer
updatedDate
Nullable
date-time
updatedSinceSignedInvoice
boolean
vehicleId
Nullable
string
workflowStatusDate
date-time
workflowStatusDuration
object
Stores how many time the order has been in each status
workflowStatusId
Nullable
string
workflowStatusPosition
Nullable
number