Operation data model

This is the data structure that you will receive every time you are trying to get opcodes and factory menus from our APIs or listening to our events.

Summary of the fields.

Parameter Name	Description
laborOpCode	The laborOpcode (Unique Identifier) associated with the operation.
opCodeName	The name of the operation code.
description	A brief description of the operation.
totalPrice	The total price of the operation.
opCodeDurationInMinutes	The duration of the operation in minutes.
isValid	A flag indicating whether the operation is valid.
uuid	The unique identifier (UUID) for the operation.
inMobileService	Indicates if the operation is available in mobile service.
inOnlineScheduler	Indicates if the operation is available in the online scheduler.
communicationCode	The communication code associated with the operation.
payType	The type of payment associated with the operation.
inServiceCart	Indicates if the operation is included in the service cart.
inDealerAppScheduler	Indicates if the operation is available in the dealer app scheduler.
dmsDescription	The DMS (Dealer Management System) description of the operation.
laborPrice	The labor price for the operation.
dmsLaborPrice	The DMS labor price for the operation.
partsPrice	The parts price for the operation.
dmsPartsPrice	The DMS parts price for the operation.
taxAmount	The tax amount associated with the operation.
dmsTaxAmount	The DMS tax amount associated with the operation.
dmsTotalPrice	The total price according to the DMS.
sortOrder	The sort order of the operation.
correction	The correction information related to the operation.
cause	The cause information related to the operation.
soldHours	The number of hours sold for the operation.
dispatchCode	The dispatch code associated with the operation.
comebackFlag	Indicates if the operation is a comeback.
usagePercentile	The usage percentile of the operation.
position	The position of the operation.
leadTimeInMinutes	The lead time in minutes for the operation.
isIndexed	Indicates if the operation is indexed.
isDefault	Indicates if the operation is set as default.
notes	Any additional notes related to the operation.
serviceType	The type of service associated with the operation. Possible values are MAINTENANCE, REPAIR, INSPECT, SERVICE
serviceTypeServiceCart	The service type for the service cart.
recallId	The recall ID associated with the operation.
vehicleMileageConfigDTOList[].brandDTO.id	The identifier for the brand in the mileage configuration.
vehicleMileageConfigDTOList[].brandDTO.name	The name of the brand in the mileage configuration.
vehicleMileageConfigDTOList[].brandDTO.motorsMakeId	The identifier for the motors make in the mileage configuration.
vehicleMileageConfigDTOList[].brandDTO.motorsMakeName	The name of the motors make in the mileage configuration.
vehicleMileageConfigDTOList[].year	The year associated with the vehicle mileage configuration.
vehicleMileageConfigDTOList[].model	The model associated with the vehicle mileage configuration.
vehicleMileageConfigDTOList[].trim	The trim associated with the vehicle mileage configuration.
vehicleMileageConfigDTOList[].engine	The engine type associated with the vehicle mileage configuration.
vehicleMileageConfigDTOList[].mileageUuid	The unique identifier (UUID) for the mileage configuration.
vehicleMileageConfigDTOList[].uuid	The unique identifier (UUID) for the vehicle mileage configuration.
vehicleMileageConfigDTOList[].motorsBaseVehicleId	The base vehicle ID in the motors configuration.
vehicleMileageConfigDTOList[].motorsEngineId	The engine ID in the motors configuration.
vehicleMileageConfigDTOList[].isValid	Indicates if the vehicle mileage configuration is valid.
dailyLimitConfigDTOList[].dayNumber	The day number for the daily limit configuration.
dailyLimitConfigDTOList[].dayLimit	The limit for the specified day in the daily limit configuration.
pullEstimateInSC	Indicates if the estimate should be pulled into the service cart.
miscPrice	The miscellaneous price associated with the operation.
useDmsPrice	Indicates if the DMS price should be used for the operation.
showDmsPriceMismatchWarning	Indicates if a warning should be shown when there is a price mismatch between the DMS and MyKaarma.
noPartsNeeded	Indicates if no parts are needed for the operation.
inCheckIn	Indicates if the operation is available during check-in.
quickOpLiteUuid	The unique identifier (UUID) for the parent operation code. Only needed for service-menu.
invoiceLineList[]	A list of invoice lines (operations codes) associated with the service-menu.
menuName	The name of the service-menu.
.operationType	The type of operation, OPCODE or SERVICEMENU.
dealerUuid	The unique identifier (UUID) of the dealer associated with the operation.
isCustomConcern	Indicates if the operation is a custom concern.
taxonomyId	The taxonomy identifier associated with the operation.
severityFlag	The severity flag associated with the operation.
isSeverityNormal	Indicates if the severity of the operation is normal.
isSeveritySevere	Indicates if the severity of the operation is severe.
notesSevere[]	A list of notes related to severe operations.
notesNormal[]	A list of notes related to normal operations.
motorsOperationName	The name of the motors operation.
mileage	The mileage associated with the operation.
motorsMake	The make of the motors associated with the operation.
motorsMakeId	The identifier for the motors make.

Note - Above summary of the fields doesn't contain all the fields that we return in the response. We will be updating this documentation to include the summary of all fields.