Repair Orders (1.31.1)
The Repair Order API is a resource that can be used to read, write and modify Keyloop Repair Order data.
This resource is typically used to achieve outcomes within aftersales activities such as vehicle inspections, estimation, servicing and repair.
The Repair Order domain obeys the following hierarchy;
Repair Order A Repair Order is the primary object within the Repair Order domain
Repair Order Job A Repair Order may contain one or more Repair Order Jobs
- Repair Order Item A Repair Order Job may contain one or more Repair Order Items
The following definitions are pertinent to the usage of this API.
"Repair Orders" are the artifact within Keyloop systems which capture all information related to an individual job in the aftersales environment.
"Repair Order Jobs" or "Jobs" are a container within a Repair Order into which Repair Order Items can be placed. Repair Order Jobs are typically used to group together the components (Parts, Labor etc.) required to achieve a common outcome.
"Repair Order Items" or "Items" are the individual components that are added to Repair Orders in order to achieve the expected outcome for the customer. There are different types of Repair Order Items, such as Labor, Parts & Notes.
"Menus" are pre-defined lists of Repair Order Items, usually defined by manufacturers, that indicate the expected Repair Order Items required to achieve a specific outcome.
"Labor Items" are the physical activities required to achieve a specific outcome, which must be completed by a Human Resource (e.g. Vehicle Technician).
"Parts Items" are the physical components required to achieve a specific outcome.
"Notes Items" are non-normalized descriptions that can be added to capture additional information pertinent to the outcome that cannot be communicated using other items such as Parts & Labor.
The
contactAdvisor
is usually the advisor who has customer-facing responsibilities for the Repair Order. This may differ from the advisor to whom the Repair Order is currently assigned, which is defined by theassignedAdvisor
object.The
listPrice
is the list price of the item, excluding any discounts.The
orderPrice
is the selling price of the item, including any discounts.
[1.31.1]
- Removed ap2 from server list (FEATURE)
[1.31.0]
- Amend
contact
property to map to ContactDetails schema to include customer and address property forGET/repair-orders/{repairOrderId}
(FEATURE)
[1.30.0]
- Added CREDITED status to RepairOrderStatus, PartLineStatus, LaborLineStatus, NotesLineStatus and FeesLineStatus enumeration list schema (FEATURE)
[1.29.0]
- Added
address
property, amended Contact schema to addcustomer
property to RepairOrderSimple schema forGET/repair-orders
(FEATURE)
[1.28.2]
- Added
payerAccount
field toPOST/repair-orders
,PATCH/repair-orders/{repairOrderId}/details
(FEATURE)
[1.28.1]
- Renamed
operationId
to UpdateRepairOrderItems for endpointPATCH /repair-orders/{repairOrderId}/items
(FEATURE) - Renamed
operationId
to DeleteRepairOrderItems for endpointDELETE /repair-orders/{repairOrderId}/items
(FEATURE) - Removed
partdId
from PartUpdate schema - Renamed
itemId
toitemIds
in itemIdParam schema
[1.28.0]
- Added new endpoint
PATCH /repair-orders/{repairOrderId}/items
, enabling repair order items to be updated (FEATURE) - Added new endpoint
DELETE /repair-orders/{repairOrderId}/items
, enabling repair order items to be deleted (FEATURE) - Added
ItemsUpdate
,LaborUpdate
,PartUpdate
,FeeUpdate
,NotesUpdate
anditemIdParam
models (FEATURE)
[1.27.1]
- Typo corrected and re-worded text in change history section
- Added serviceTypes,customerWaiting properties to Details schema
- Removed nullable from Skill
- Added linkReference to Menu schema
[1.27.0]
- Added new DROP_OFF enum value to BookingOptionType
[1.26.3]
- Changed consumer value from internal to dms.external
[1.26.2]
- Rename properties of Skill schema (FEATURE)
[1.26.1]
- updatehistory amend to RepairOrder model (FEATURE)
- userId property added to ServiceAdvisor schema
[1.26.0]
- Added
skill
toLabor
schema. (FEATURE) - Added
linePayer
andserviceTypes
to POST/repair-orders, POST/repair-orders/{repairOrderId}/jobs and POST/repair-orders/{repairOrderId}/multipleJobs - Repair Order API Realignment (FEATURE)
- Added
updateHistory
property toRepairOrder
schema - Example text corrected for jobs property (FEATURE)
- Added
customerPurchaseOrderNumber
,payerAccount
,completedDateTime
,closedDateTime
todetails
schema - Added
feeType
andlinkReference
toFeeCreate
schema - Added
updateHistory
toRepairOrder
model - Added
details
andresources
property toRepairOrderSimple
schema - RepairOrderStatus enumerations updated with CANCELLED value
[1.25.2]
- Deleted example text for parts, fees schema (FEATURE)
[1.25.1]
- Updated reference of common to common.v1.1.10.yaml (FEATURE)
- Reverted labor and Notes properties for Menu schema
[1.25.0]
- Repair Order API Realignment (FEATURE)
DiscountCreate
,Discount
schema merged to single schemaDiscount
- Added
linkReference
property toPartCreate
andLaborCreate
schema - Added
workStartedDateTime
,workCompletedDateTime
andlinkReference
properties toJob
schema - Added
menuType
property toMenu
schema - Changed
Discount
schema inMenu
schema - Added
updateHistory
andlinkReference
properties toPart
Schema - Added
laborDepartmentType
,updateHistory
andlinkReference
properties toLabor
schema - Added
updateHistory
property toNotes
schema - Added
updateHistory
andlinkReference
properties toFee
schema - Added
takeOwnership
andadvisorId
properties toCheckInDetails
schema - Added
vehicleMileage
property toDetailsUpdate
schema - Added new endpoint 'check-out' to Repair Orders Actions section, to check-out vehicle
[1.24.0]
- Removed swaggerhub urls
- Fixed validation errors (removed JobSimple schema, among other changes)
[1.23.0]
- Added new end point to create multiple jobs for a repair order(FEATURE)
- Update Jira references and contact details
[1.22.0]
- Added
JobCreate
Schema toRepairOrderCreate
(FEATURE) - Replaced
JobSimple
withJob
inRepairOrder
Schema (FEATURE) - Updated Servers links to Keyloop
[1.21.0]
- Revert FeeCreate PriceCreate schema back to Price (SW)
[1.20.0]
- Added OAuth2 to for
AddMenuToJob
andAddItemsToJob
end points
[1.19.0]
- Add nullable property for
jobConditionCode
[1.18.0]
- Add new endpoint /jobs/{jobid}/items to allow adding multiple items to a job in one go. (FEATURE)
[1.17.0]
- Add ItemPriceCreate to remove discount split from menuLaborCreate and menuPartCreate (FEATURE)
[1.16.0]
- Add phone number to Repair Order search filter (FEATURE)
[1.14.0]
- Added VHC distinction, categorization in GetRepairorder and GetRepairorderJob. Added vehicle specification codes in Get Repair Order under Vehicle section as
referenceData
(FEATURE)
[1.13.0]
- Added
contactAdvisorId
to createRepairOrder and updateRepairOrderDetails end points request body. This will allow user to update Advisor on top of the repair order. (FEATURE)[1.12.1]
- Added nullable property to
DueInDateTime
andDueOutDateTime
objects. (EPIC)[1.12.0]
- Additional Onhold Statuses in RepairOrderAPI (EPIC MIDWARE-2148)
[1.11.0]
- Added RepairOrderType to RepairOrder and RepairOrderSimple objects. (EPIC)
[1.10.1]
- Changed LaborLineStatus enum value from 'HALTED' to 'ONHOLD'. (EPIC)
[1.10.0]
- Added oAuth for Repair Order update apis. (EPIC)
[1.9.0]
- Added Part, Labor, Notes and Fees line statuses and added TechnicianDetails to Labor. (EPIC)
- Removed common price object from Add labor and Add part end points. Added new price models locally for Add part and labor API's. (EPIC)
[1.8.0]
- Added new endpoints for update Details, Appointment and Planning (EPIC).
- Modified 'DetailsUpdate' to allow contact details update as well as 'CustomerId', 'CompanyId' and 'VehicleId', added new schema definitions for these and added references (EPIC).
[1.7.4]
- Add Parts and Labour Pricing (MIDWARE-1811)
[1.7.3]
- Added Labor Description in Add Labor (MIDWARE-1792)
[1.7.2]
- Added
x-onbehalf-of
for user authentication[1.7.1]
- Modified 'RepairOrderSimple' object 'contact' tag from 'ContactSearch' Shared object to 'Contact' Shared object.
[1.7.0]
- Added new endpoint or Add Fees to Job Added new endpoint or Add Fees to Job (EPIC).
[1.6.1]
- Added new query parameter 'reference' to find repair orders.
- Added additionalProperties as 'fasle' for each object.
- Removed Subscription end-point and PublicKey end-point. If, someone want's to implement this end-points in future please refer 1.6.0 version.
[1.6.0]
- PublicKey end-point
[1.5.0]
- Subscription end-point
[1.4.1]
- Updated missing tag descriptions
[1.4.0]
- Added CustomerWaiting flag to Details schema Appointment and checkin structure.
- Check-In post call(/repair-orders/{repairOrderId}/check-in) related changes
- customerSignature and damage are removed with respective schemas
- made "checkInDateTime" only as mandatory field.
Create Repair Order
Creates a new Repair Order for an existing Customer and Vehicle.
A valid
customerId
andvehicleId
must be provided in the request. These can be obtained using the 'Find Customer' and 'Find Vehicle' resources.A request to this endpoint will not result in the creation of new Customer or Vehicle records in the DMS
Authorizations:
header Parameters
x-on-behalf-of | string The user (id) of the user who is actually using this resource. This user Id should be known in the receiving system. |
Request Body schema: application/json
Information required to create a new Repair Order
vehicleId required | string A unique id that identifies a vehicle in the DMS. |
customerId | string A unique id that identifies a customer in the DMS.
|
companyId | string A unique id that identifies a customer in the DMS.
|
object (DetailsSimple) Details Model (Simple) | |
object (Contact) Contact person | |
contactAdvisorId | string (Contact Advisor) Contact advisor id |
object (AppointmentSimple) Appointment Model (Simple) | |
Array of objects (JobCreate) Collection of jobs that are performed to the vehicle. Single job represents a logical work that needs to be performed at the same time (10'000km service, oil change, change of something) |
Responses
Request samples
- Payload
{- "vehicleId": "00000000-0000-0000-0000-000000000000",
- "customerId": "00000000-0000-0000-0000-000000000000",
- "companyId": "00000000-0000-0000-0000-000000000000",
- "details": {
- "payerAccount": "A12345",
- "notes": "Vehicle cleaning not required"
}, - "contact": {
- "name": "string",
- "phone": "string",
- "email": "string",
- "companyName": "string"
}, - "contactAdvisorId": "1234",
- "appointment": {
- "dueInDateTime": "2019-08-24T14:15:22Z",
- "dueOutDateTime": "2019-08-24T14:15:22Z"
}, - "jobs": [
- {
- "description": "Replace worn front N/S brake disc + pads",
- "linkReference": "1",
- "classificationItem": [
- {
- "level": "1",
- "category": "maingroup",
- "code": "01",
- "description": "Engine"
}
], - "serviceTypes": [
- "SCHEDULED_MAINTENANCE"
], - "menus": [
- {
- "menuCode": "MENU1",
- "brandCode": "DEALER",
- "description": "Menu description",
- "linePayer": "CUSTOMER",
- "menuType": "FIXED",
- "menuPrice": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": "NET",
- "value": 100,
- "taxRate": 20
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "discountSplit": {
- "labor": 50,
- "parts": 50
}
}, - "menuComponents": {
- "labor": [
- {
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "description": "Labor Description",
- "allowedTimeInMinutes": 1,
- "linePayer": "CUSTOMER",
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": null,
- "value": null,
- "taxRate": null
}, - "discount": {
- "value": null,
- "currencyCode": null,
- "type": null,
- "description": null
}
}, - "linkReference": "1"
}
], - "parts": [
- {
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": null,
- "value": null,
- "taxRate": null
}, - "discount": {
- "value": null,
- "currencyCode": null,
- "type": null,
- "description": null
}
}, - "linkReference": "1"
}
], - "fees": [
- {
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "orderPrice": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": null,
- "value": null,
- "taxRate": null
}, - "discount": {
- "value": null,
- "currencyCode": null,
- "type": null,
- "description": null
}
}, - "notes": "Required to be collected as per regulatory"
}
], - "notes": [
- {
- "notes": "Vehicle cleaning not required"
}
]
}, - "linkReference": "1"
}
], - "labor": [
- {
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "description": "Labor Description",
- "allowedTimeInMinutes": 1,
- "linePayer": "CUSTOMER",
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "grossValue": 100,
- "taxRate": 15.23
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "linkReference": "1"
}
], - "parts": [
- {
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "grossValue": 100,
- "taxRate": 15.23
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "linkReference": "1"
}
], - "notes": [
- {
- "notes": "Vehicle cleaning not required"
}
], - "fees": [
- {
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "notes": "Required to be collected as per regulatory",
- "linkReference": "1"
}
]
}
]
}
Response samples
- 201
{- "repairOrderId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "type": "WARRANTY",
- "details": {
- "reference": "12345-67890-12345",
- "customerPurchaseOrderNumber": "PO123456",
- "payerAccount": "A12345",
- "notes": "Vehicle cleaning not required",
- "checkInDateTime": "2021-07-16T00:00:00.000Z",
- "checkOutDateTime": "2021-07-16T00:00:00.000Z",
- "completedDateTime": "2022-05-20T00:00:00.000Z",
- "closedDateTime": "2022-05-20T00:00:00.000Z",
- "checkInMileage": {
- "unit": "KM",
- "value": 120000
}, - "checkOutMileage": {
- "unit": "KM",
- "value": 120000
}, - "onHoldReason": "Waiting for customer approval",
- "serviceTypes": [
- "SCHEDULED_MAINTENANCE"
], - "customerWaiting": true
}, - "vehicle": {
- "vehicleId": "00000000-0000-0000-0000-000000000000",
- "reference": "10345",
- "class": "CAR",
- "makeId": "FORD",
- "description": "string",
- "vin": "string",
- "licensePlate": "string",
- "referenceData": {
- "providerId": "DMS",
- "makeCode": "FO",
- "modelCode": "FOCUS",
- "variantCode": "123560",
- "vehicleCode": "ABC12345656"
}
}, - "customer": {
- "customerId": "string",
- "familyName": "string",
- "givenName": "string",
- "titleCommon": "string"
}, - "company": {
- "companyId": "string",
- "name": "string"
}, - "contact": {
- "name": "Michael Midlander",
- "customer": "Michael Midlander",
- "phone": "123-123123",
- "email": "mike@domain.com",
- "companyName": "Company Ltd.",
- "address": {
- "streetType": "Avenue",
- "streetName": "Mill Lane",
- "houseNumber": "7",
- "buildingName": "string",
- "floorNumber": "string",
- "doorNumber": "string",
- "blockName": "string",
- "estate": "string",
- "postalCode": "SE4 1UU",
- "suburb": "string",
- "city": "London",
- "county": "string",
- "province": "string",
- "countryCode": "GB"
}
}, - "resources": {
- "assignedAdvisor": {
- "serviceAdvisorId": "1234567",
- "name": "Service Advisor",
- "userId": "user1"
}, - "contactAdvisor": {
- "serviceAdvisorId": "1234567",
- "name": "Service Advisor",
- "userId": "user1"
}
}, - "appointment": {
- "notes": "The customer would like a coffee on arrival.",
- "bookingOptions": {
- "type": "NONE"
}, - "dueInDateTime": "2019-03-20T00:00:00.000Z",
- "dueOutDateTime": "2019-03-20T00:00:00.000Z",
- "customerWaiting": true
}, - "planning": {
- "plannedIn": "2019-03-20T00:00:00.000Z",
- "plannedOut": "2019-03-20T00:00:00.000Z"
}, - "jobs": [
- {
- "jobId": "00000000-0000-0000-0000-000000000000",
- "description": "Replace worn front N/S brake disc + pads",
- "serviceTypes": [
- "SCHEDULED_MAINTENANCE"
], - "workStartedDateTime": "2021-07-16T00:00:00.000Z",
- "workCompletedDateTime": "2021-07-16T00:00:00.000Z",
- "linkReference": "1",
- "isVhc": true,
- "vhcDetails": {
- "jobConditionCode": "GREEN",
- "vhcOperator": "Smith"
}, - "menus": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "sequenceNumber": 1,
- "brandCode": "DEALER",
- "menuCode": "MENU1",
- "menuType": "FIXED",
- "parts": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "OPEN",
- "sequenceNumber": 1,
- "notes": "Brake disc may take 500km to wear in. Customer is advised to take extra caution.",
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "unitOfMeasure": {
- "unit": "PIECE",
- "value": 0.5
}, - "quantity": 1,
- "description": "Front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "labor": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Requires disassembly of wheel-arch to allow sufficient access",
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "allowedTimeInMinutes": 90,
- "description": "Replace front brake disc",
- "laborDepartmentType": "MOBILESERVICE",
- "skill": {
- "code": "E",
- "description": "Electrical Jobs"
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "technician": {
- "technicianId": "1234567",
- "name": "Smith"
}, - "linkReference": "1"
}
], - "notes": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Vehicle cleaning not required",
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}
}
], - "fees": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Environmental fee is added automatically",
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "quantity": 1,
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "description": "Replace front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "linkReference": "1"
}
], - "labor": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Requires disassembly of wheel-arch to allow sufficient access",
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "allowedTimeInMinutes": 90,
- "description": "Replace front brake disc",
- "laborDepartmentType": "MOBILESERVICE",
- "skill": {
- "code": "E",
- "description": "Electrical Jobs"
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "technician": {
- "technicianId": "1234567",
- "name": "Smith"
}, - "linkReference": "1"
}
], - "parts": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "OPEN",
- "sequenceNumber": 1,
- "notes": "Brake disc may take 500km to wear in. Customer is advised to take extra caution.",
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "unitOfMeasure": {
- "unit": "PIECE",
- "value": 0.5
}, - "quantity": 1,
- "description": "Front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "notes": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Vehicle cleaning not required",
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}
}
], - "fees": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Environmental fee is added automatically",
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "quantity": 1,
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "links": [
- {
- "method": "GET",
- "rel": "self",
- "href": "string",
- "title": "string"
}
]
}
], - "updateHistory": {
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "previousRepairOrderId": "00000000-0000-0000-0000-000000000000",
- "mainRepairOrderId": "00000000-0000-0000-0000-000000000000",
- "subOrders": [
- {
- "repairOrderId": "00000000-0000-0000-0000-000000000000"
}
]
}, - "links": [
- {
- "method": "GET",
- "rel": "self",
- "href": "href"
}
]
}
Find Repair Orders
Returns a list of Repair Orders that match the parameters provided.
- At least one query parameter must be provided for the request to successfully return results > * All paramaters support partial search requests unless indicated otherwise
Authorizations:
query Parameters
contactName | string Refines the search results by the Contact Name associated with the Repair Order |
licensePlate | string Refines search results by vehicle license plate(s). |
phone | string Phone filter |
status | Array of strings (Repair order status) Items Enum: "CREATED" "ONHOLD" "CHECKEDIN" "WORKSTARTED" "WORKCOMPLETED" "CHECKEDOUT" "CLOSED" "CANCELLED" "CREDITED" Example: status=CREATED Specifies the Repair Order status(es) that should be included in the search
|
dueInDateFrom | string <date> Refines search results by the date the Vehicle is booked in for repair. Can be combined with the |
dueInDateTo | string <date> Refines search results by the date the Vehicle is booked in for repair. Can be combined with the |
reference | string Refines search results by the DMS internal reference id for repair orders. |
page | integer >= 1 Default: 1 Examples:
A non-zero integer representing the page of the results |
pageSize | integer >= 50 Default: 50 Examples:
A non-negative, non-zero integer indicating the maximum number of results to return at one time |
Responses
Response samples
- 200
- 400
{- "repairOrders": [
- {
- "repairOrderId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "type": "WARRANTY",
- "reference": "123456",
- "vehicle": {
- "vehicleId": "00000000-0000-0000-0000-000000000000",
- "reference": "10345",
- "class": "CAR",
- "makeId": "FORD",
- "description": "string",
- "vin": "string",
- "licensePlate": "string",
- "referenceData": {
- "providerId": "DMS",
- "makeCode": "FO",
- "modelCode": "FOCUS",
- "variantCode": "123560",
- "vehicleCode": "ABC12345656"
}
}, - "contact": {
- "name": "Michael Midlander",
- "customer": "Michael Midlander",
- "phone": "123-123123",
- "email": "mike@domain.com",
- "companyName": "Company Ltd.",
- "address": {
- "streetType": "Avenue",
- "streetName": "Mill Lane",
- "houseNumber": "7",
- "buildingName": "string",
- "floorNumber": "string",
- "doorNumber": "string",
- "blockName": "string",
- "estate": "string",
- "postalCode": "SE4 1UU",
- "suburb": "string",
- "city": "London",
- "county": "string",
- "province": "string",
- "countryCode": "GB"
}
}, - "appointment": {
- "dueInDateTime": "2019-08-24T14:15:22Z",
- "dueOutDateTime": "2019-08-24T14:15:22Z"
}, - "details": {
- "reference": "12345-67890-12345",
- "customerPurchaseOrderNumber": "PO123456",
- "payerAccount": "A12345",
- "notes": "Vehicle cleaning not required",
- "checkInDateTime": "2021-07-16T00:00:00.000Z",
- "checkOutDateTime": "2021-07-16T00:00:00.000Z",
- "completedDateTime": "2022-05-20T00:00:00.000Z",
- "closedDateTime": "2022-05-20T00:00:00.000Z",
- "checkInMileage": {
- "unit": "KM",
- "value": 120000
}, - "checkOutMileage": {
- "unit": "KM",
- "value": 120000
}, - "onHoldReason": "Waiting for customer approval",
- "serviceTypes": [
- "SCHEDULED_MAINTENANCE"
], - "customerWaiting": true
}, - "resources": {
- "assignedAdvisor": {
- "serviceAdvisorId": "1234567",
- "name": "Service Advisor",
- "userId": "user1"
}, - "contactAdvisor": {
- "serviceAdvisorId": "1234567",
- "name": "Service Advisor",
- "userId": "user1"
}
}
}
], - "totalItems": 4,
- "totalPages": 1,
- "links": {
- "method": "GET",
- "rel": "self",
- "href": "string",
- "title": "string"
}
}
Get Repair Order
Retrieves a Repair Order including a summary of associated Repair Order Jobs.
- Detailed information about a specific job including a breakdown of items can be obtained using the 'Get Repair Order Job' resource and a valid
jobId
Authorizations:
path Parameters
repairOrderId required | string A unique id that identifies an individual Repair Order, which may differ from the |
Responses
Response samples
- 200
- 404
{- "repairOrderId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "type": "WARRANTY",
- "details": {
- "reference": "12345-67890-12345",
- "customerPurchaseOrderNumber": "PO123456",
- "payerAccount": "A12345",
- "notes": "Vehicle cleaning not required",
- "checkInDateTime": "2021-07-16T00:00:00.000Z",
- "checkOutDateTime": "2021-07-16T00:00:00.000Z",
- "completedDateTime": "2022-05-20T00:00:00.000Z",
- "closedDateTime": "2022-05-20T00:00:00.000Z",
- "checkInMileage": {
- "unit": "KM",
- "value": 120000
}, - "checkOutMileage": {
- "unit": "KM",
- "value": 120000
}, - "onHoldReason": "Waiting for customer approval",
- "serviceTypes": [
- "SCHEDULED_MAINTENANCE"
], - "customerWaiting": true
}, - "vehicle": {
- "vehicleId": "00000000-0000-0000-0000-000000000000",
- "reference": "10345",
- "class": "CAR",
- "makeId": "FORD",
- "description": "string",
- "vin": "string",
- "licensePlate": "string",
- "referenceData": {
- "providerId": "DMS",
- "makeCode": "FO",
- "modelCode": "FOCUS",
- "variantCode": "123560",
- "vehicleCode": "ABC12345656"
}
}, - "customer": {
- "customerId": "string",
- "familyName": "string",
- "givenName": "string",
- "titleCommon": "string"
}, - "company": {
- "companyId": "string",
- "name": "string"
}, - "contact": {
- "name": "Michael Midlander",
- "customer": "Michael Midlander",
- "phone": "123-123123",
- "email": "mike@domain.com",
- "companyName": "Company Ltd.",
- "address": {
- "streetType": "Avenue",
- "streetName": "Mill Lane",
- "houseNumber": "7",
- "buildingName": "string",
- "floorNumber": "string",
- "doorNumber": "string",
- "blockName": "string",
- "estate": "string",
- "postalCode": "SE4 1UU",
- "suburb": "string",
- "city": "London",
- "county": "string",
- "province": "string",
- "countryCode": "GB"
}
}, - "resources": {
- "assignedAdvisor": {
- "serviceAdvisorId": "1234567",
- "name": "Service Advisor",
- "userId": "user1"
}, - "contactAdvisor": {
- "serviceAdvisorId": "1234567",
- "name": "Service Advisor",
- "userId": "user1"
}
}, - "appointment": {
- "notes": "The customer would like a coffee on arrival.",
- "bookingOptions": {
- "type": "NONE"
}, - "dueInDateTime": "2019-03-20T00:00:00.000Z",
- "dueOutDateTime": "2019-03-20T00:00:00.000Z",
- "customerWaiting": true
}, - "planning": {
- "plannedIn": "2019-03-20T00:00:00.000Z",
- "plannedOut": "2019-03-20T00:00:00.000Z"
}, - "jobs": [
- {
- "jobId": "00000000-0000-0000-0000-000000000000",
- "description": "Replace worn front N/S brake disc + pads",
- "serviceTypes": [
- "SCHEDULED_MAINTENANCE"
], - "workStartedDateTime": "2021-07-16T00:00:00.000Z",
- "workCompletedDateTime": "2021-07-16T00:00:00.000Z",
- "linkReference": "1",
- "isVhc": true,
- "vhcDetails": {
- "jobConditionCode": "GREEN",
- "vhcOperator": "Smith"
}, - "menus": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "sequenceNumber": 1,
- "brandCode": "DEALER",
- "menuCode": "MENU1",
- "menuType": "FIXED",
- "parts": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "OPEN",
- "sequenceNumber": 1,
- "notes": "Brake disc may take 500km to wear in. Customer is advised to take extra caution.",
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "unitOfMeasure": {
- "unit": "PIECE",
- "value": 0.5
}, - "quantity": 1,
- "description": "Front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "labor": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Requires disassembly of wheel-arch to allow sufficient access",
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "allowedTimeInMinutes": 90,
- "description": "Replace front brake disc",
- "laborDepartmentType": "MOBILESERVICE",
- "skill": {
- "code": "E",
- "description": "Electrical Jobs"
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "technician": {
- "technicianId": "1234567",
- "name": "Smith"
}, - "linkReference": "1"
}
], - "notes": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Vehicle cleaning not required",
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}
}
], - "fees": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Environmental fee is added automatically",
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "quantity": 1,
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "description": "Replace front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "linkReference": "1"
}
], - "labor": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Requires disassembly of wheel-arch to allow sufficient access",
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "allowedTimeInMinutes": 90,
- "description": "Replace front brake disc",
- "laborDepartmentType": "MOBILESERVICE",
- "skill": {
- "code": "E",
- "description": "Electrical Jobs"
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "technician": {
- "technicianId": "1234567",
- "name": "Smith"
}, - "linkReference": "1"
}
], - "parts": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "OPEN",
- "sequenceNumber": 1,
- "notes": "Brake disc may take 500km to wear in. Customer is advised to take extra caution.",
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "unitOfMeasure": {
- "unit": "PIECE",
- "value": 0.5
}, - "quantity": 1,
- "description": "Front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "notes": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Vehicle cleaning not required",
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}
}
], - "fees": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Environmental fee is added automatically",
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "quantity": 1,
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "links": [
- {
- "method": "GET",
- "rel": "self",
- "href": "string",
- "title": "string"
}
]
}
], - "updateHistory": {
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "previousRepairOrderId": "00000000-0000-0000-0000-000000000000",
- "mainRepairOrderId": "00000000-0000-0000-0000-000000000000",
- "subOrders": [
- {
- "repairOrderId": "00000000-0000-0000-0000-000000000000"
}
]
}, - "links": [
- {
- "method": "GET",
- "rel": "self",
- "href": "href"
}
]
}
Create Repair Order Jobs
Creates Repair Order Jobs on an existing Repair Order.
Authorizations:
path Parameters
repairOrderId required | string A unique id that identifies an individual Repair Order, which may differ from the |
header Parameters
x-on-behalf-of | string The user (id) of the user who is actually using this resource. This user Id should be known in the receiving system. |
Request Body schema: application/json
Repair order job
description | string A description of the Repair Order Job.
|
linkReference | string Identifier of job for external use |
Array of objects (ClassificationItem) A list of classification items for repair order job. | |
serviceTypes | Array of strings (Service Type) Items Enum: "BODYSHOP" "INTERNAL" "MOT" "RECOVERY" "SCHEDULED_MAINTENANCE" "SERVICE" "UNSCHEDULED_MAINTENANCE" "WARRANTY" The service type(s) associated with the job |
Array of objects (MenuCreate) A pre-defined list of Repair Order Items, usually defined by manufacturers, that indicates the expected Repair Order Items required to achieve a specific outcome. | |
Array of objects (LaborCreate) The physical activities required to achieve a specific outcome, which must be completed by a Human Resource (e.g. Vehicle Technician) | |
Array of objects (PartCreate) The physical components required to achieve a specific outcome. | |
Array of objects (NotesCreate) Non-normalized notes that can be added to capture additional information pertinent to the outcome, that cannot be communicated using other items such as Parts & Labor. | |
Array of objects (FeeCreate) Fee Items |
Responses
Request samples
- Payload
{- "description": "Replace worn front N/S brake disc + pads",
- "linkReference": "1",
- "classificationItem": [
- {
- "level": "1",
- "category": "maingroup",
- "code": "01",
- "description": "Engine"
}
], - "serviceTypes": [
- "SCHEDULED_MAINTENANCE"
], - "menus": [
- {
- "menuCode": "MENU1",
- "brandCode": "DEALER",
- "description": "Menu description",
- "linePayer": "CUSTOMER",
- "menuType": "FIXED",
- "menuPrice": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": "NET",
- "value": 100,
- "taxRate": 20
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "discountSplit": {
- "labor": 50,
- "parts": 50
}
}, - "menuComponents": {
- "labor": [
- {
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "description": "Labor Description",
- "allowedTimeInMinutes": 1,
- "linePayer": "CUSTOMER",
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": "NET",
- "value": 100,
- "taxRate": 20
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "linkReference": "1"
}
], - "parts": [
- {
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": "NET",
- "value": 100,
- "taxRate": 20
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "linkReference": "1"
}
], - "fees": [
- {
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "orderPrice": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": "NET",
- "value": 100,
- "taxRate": 20
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "notes": "Required to be collected as per regulatory"
}
], - "notes": [
- {
- "notes": "Vehicle cleaning not required"
}
]
}, - "linkReference": "1"
}
], - "labor": [
- {
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "description": "Labor Description",
- "allowedTimeInMinutes": 1,
- "linePayer": "CUSTOMER",
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "grossValue": 100,
- "taxRate": 15.23
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "linkReference": "1"
}
], - "parts": [
- {
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "grossValue": 100,
- "taxRate": 15.23
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "linkReference": "1"
}
], - "notes": [
- {
- "notes": "Vehicle cleaning not required"
}
], - "fees": [
- {
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "notes": "Required to be collected as per regulatory",
- "linkReference": "1"
}
]
}
Response samples
- 201
- 404
{- "jobId": "00000000-0000-0000-0000-000000000000",
- "description": "Replace worn front N/S brake disc + pads",
- "serviceTypes": [
- "SCHEDULED_MAINTENANCE"
], - "workStartedDateTime": "2021-07-16T00:00:00.000Z",
- "workCompletedDateTime": "2021-07-16T00:00:00.000Z",
- "linkReference": "1",
- "isVhc": true,
- "vhcDetails": {
- "jobConditionCode": "GREEN",
- "vhcOperator": "Smith"
}, - "menus": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "sequenceNumber": 1,
- "brandCode": "DEALER",
- "menuCode": "MENU1",
- "menuType": "FIXED",
- "parts": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "OPEN",
- "sequenceNumber": 1,
- "notes": "Brake disc may take 500km to wear in. Customer is advised to take extra caution.",
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "unitOfMeasure": {
- "unit": "PIECE",
- "value": 0.5
}, - "quantity": 1,
- "description": "Front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "labor": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Requires disassembly of wheel-arch to allow sufficient access",
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "allowedTimeInMinutes": 90,
- "description": "Replace front brake disc",
- "laborDepartmentType": "MOBILESERVICE",
- "skill": {
- "code": "E",
- "description": "Electrical Jobs"
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "technician": {
- "technicianId": "1234567",
- "name": "Smith"
}, - "linkReference": "1"
}
], - "notes": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Vehicle cleaning not required",
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}
}
], - "fees": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Environmental fee is added automatically",
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "quantity": 1,
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "description": "Replace front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "linkReference": "1"
}
], - "labor": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Requires disassembly of wheel-arch to allow sufficient access",
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "allowedTimeInMinutes": 90,
- "description": "Replace front brake disc",
- "laborDepartmentType": "MOBILESERVICE",
- "skill": {
- "code": "E",
- "description": "Electrical Jobs"
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "technician": {
- "technicianId": "1234567",
- "name": "Smith"
}, - "linkReference": "1"
}
], - "parts": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "OPEN",
- "sequenceNumber": 1,
- "notes": "Brake disc may take 500km to wear in. Customer is advised to take extra caution.",
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "unitOfMeasure": {
- "unit": "PIECE",
- "value": 0.5
}, - "quantity": 1,
- "description": "Front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "notes": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Vehicle cleaning not required",
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}
}
], - "fees": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Environmental fee is added automatically",
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "quantity": 1,
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "links": [
- {
- "method": "GET",
- "rel": "self",
- "href": "string",
- "title": "string"
}
]
}
Create Multiple Repair Order Jobs
Creates Multiple Repair Order Jobs on an existing Repair Order.
Authorizations:
path Parameters
repairOrderId required | string A unique id that identifies an individual Repair Order, which may differ from the |
header Parameters
x-on-behalf-of | string The user (id) of the user who is actually using this resource. This user Id should be known in the receiving system. |
Request Body schema: application/json
Repair order jobs create
Array of objects (JobCreate) |
Responses
Request samples
- Payload
{- "jobsCreate": [
- {
- "description": "Replace worn front N/S brake disc + pads",
- "linkReference": "1",
- "classificationItem": [
- {
- "level": "1",
- "category": "maingroup",
- "code": "01",
- "description": "Engine"
}
], - "serviceTypes": [
- "SCHEDULED_MAINTENANCE"
], - "menus": [
- {
- "menuCode": "MENU1",
- "brandCode": "DEALER",
- "description": "Menu description",
- "linePayer": "CUSTOMER",
- "menuType": "FIXED",
- "menuPrice": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": "NET",
- "value": 100,
- "taxRate": 20
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "discountSplit": {
- "labor": 50,
- "parts": 50
}
}, - "menuComponents": {
- "labor": [
- {
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "description": "Labor Description",
- "allowedTimeInMinutes": 1,
- "linePayer": "CUSTOMER",
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": null,
- "value": null,
- "taxRate": null
}, - "discount": {
- "value": null,
- "currencyCode": null,
- "type": null,
- "description": null
}
}, - "linkReference": "1"
}
], - "parts": [
- {
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": null,
- "value": null,
- "taxRate": null
}, - "discount": {
- "value": null,
- "currencyCode": null,
- "type": null,
- "description": null
}
}, - "linkReference": "1"
}
], - "fees": [
- {
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "orderPrice": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": null,
- "value": null,
- "taxRate": null
}, - "discount": {
- "value": null,
- "currencyCode": null,
- "type": null,
- "description": null
}
}, - "notes": "Required to be collected as per regulatory"
}
], - "notes": [
- {
- "notes": "Vehicle cleaning not required"
}
]
}, - "linkReference": "1"
}
], - "labor": [
- {
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "description": "Labor Description",
- "allowedTimeInMinutes": 1,
- "linePayer": "CUSTOMER",
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "grossValue": 100,
- "taxRate": 15.23
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "linkReference": "1"
}
], - "parts": [
- {
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "grossValue": 100,
- "taxRate": 15.23
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "linkReference": "1"
}
], - "notes": [
- {
- "notes": "Vehicle cleaning not required"
}
], - "fees": [
- {
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "notes": "Required to be collected as per regulatory",
- "linkReference": "1"
}
]
}
]
}
Response samples
- 201
- 404
{- "jobs": [
- {
- "jobId": "00000000-0000-0000-0000-000000000000",
- "description": "Replace worn front N/S brake disc + pads",
- "serviceTypes": [
- "SCHEDULED_MAINTENANCE"
], - "workStartedDateTime": "2021-07-16T00:00:00.000Z",
- "workCompletedDateTime": "2021-07-16T00:00:00.000Z",
- "linkReference": "1",
- "isVhc": true,
- "vhcDetails": {
- "jobConditionCode": "GREEN",
- "vhcOperator": "Smith"
}, - "menus": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "sequenceNumber": 1,
- "brandCode": "DEALER",
- "menuCode": "MENU1",
- "menuType": "FIXED",
- "parts": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "OPEN",
- "sequenceNumber": 1,
- "notes": "Brake disc may take 500km to wear in. Customer is advised to take extra caution.",
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "unitOfMeasure": {
- "unit": "PIECE",
- "value": 0.5
}, - "quantity": 1,
- "description": "Front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "labor": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Requires disassembly of wheel-arch to allow sufficient access",
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "allowedTimeInMinutes": 90,
- "description": "Replace front brake disc",
- "laborDepartmentType": "MOBILESERVICE",
- "skill": {
- "code": "E",
- "description": "Electrical Jobs"
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "technician": {
- "technicianId": "1234567",
- "name": "Smith"
}, - "linkReference": "1"
}
], - "notes": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Vehicle cleaning not required",
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}
}
], - "fees": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Environmental fee is added automatically",
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "quantity": 1,
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "description": "Replace front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "linkReference": "1"
}
], - "labor": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Requires disassembly of wheel-arch to allow sufficient access",
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "allowedTimeInMinutes": 90,
- "description": "Replace front brake disc",
- "laborDepartmentType": "MOBILESERVICE",
- "skill": {
- "code": "E",
- "description": "Electrical Jobs"
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "technician": {
- "technicianId": "1234567",
- "name": "Smith"
}, - "linkReference": "1"
}
], - "parts": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "OPEN",
- "sequenceNumber": 1,
- "notes": "Brake disc may take 500km to wear in. Customer is advised to take extra caution.",
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "unitOfMeasure": {
- "unit": "PIECE",
- "value": 0.5
}, - "quantity": 1,
- "description": "Front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "notes": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Vehicle cleaning not required",
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}
}
], - "fees": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Environmental fee is added automatically",
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "quantity": 1,
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "links": [
- {
- "method": "GET",
- "rel": "self",
- "href": "string",
- "title": "string"
}
]
}
]
}
Get Repair Order Job
Retrieves a specific Repair Order Job.
Authorizations:
path Parameters
repairOrderId required | string A unique id that identifies an individual Repair Order, which may differ from the |
jobId required | string A unique id that identifies the Repair Order Job. Can be obtained using the 'Get Repair Order' resource |
Responses
Response samples
- 200
- 404
{- "jobId": "00000000-0000-0000-0000-000000000000",
- "description": "Replace worn front N/S brake disc + pads",
- "serviceTypes": [
- "SCHEDULED_MAINTENANCE"
], - "workStartedDateTime": "2021-07-16T00:00:00.000Z",
- "workCompletedDateTime": "2021-07-16T00:00:00.000Z",
- "linkReference": "1",
- "isVhc": true,
- "vhcDetails": {
- "jobConditionCode": "GREEN",
- "vhcOperator": "Smith"
}, - "menus": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "sequenceNumber": 1,
- "brandCode": "DEALER",
- "menuCode": "MENU1",
- "menuType": "FIXED",
- "parts": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "OPEN",
- "sequenceNumber": 1,
- "notes": "Brake disc may take 500km to wear in. Customer is advised to take extra caution.",
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "unitOfMeasure": {
- "unit": "PIECE",
- "value": 0.5
}, - "quantity": 1,
- "description": "Front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "labor": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Requires disassembly of wheel-arch to allow sufficient access",
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "allowedTimeInMinutes": 90,
- "description": "Replace front brake disc",
- "laborDepartmentType": "MOBILESERVICE",
- "skill": {
- "code": "E",
- "description": "Electrical Jobs"
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "technician": {
- "technicianId": "1234567",
- "name": "Smith"
}, - "linkReference": "1"
}
], - "notes": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Vehicle cleaning not required",
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}
}
], - "fees": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Environmental fee is added automatically",
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "quantity": 1,
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "description": "Replace front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "linkReference": "1"
}
], - "labor": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Requires disassembly of wheel-arch to allow sufficient access",
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "allowedTimeInMinutes": 90,
- "description": "Replace front brake disc",
- "laborDepartmentType": "MOBILESERVICE",
- "skill": {
- "code": "E",
- "description": "Electrical Jobs"
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "technician": {
- "technicianId": "1234567",
- "name": "Smith"
}, - "linkReference": "1"
}
], - "parts": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "OPEN",
- "sequenceNumber": 1,
- "notes": "Brake disc may take 500km to wear in. Customer is advised to take extra caution.",
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "unitOfMeasure": {
- "unit": "PIECE",
- "value": 0.5
}, - "quantity": 1,
- "description": "Front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "notes": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Vehicle cleaning not required",
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}
}
], - "fees": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Environmental fee is added automatically",
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "quantity": 1,
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "links": [
- {
- "method": "GET",
- "rel": "self",
- "href": "string",
- "title": "string"
}
]
}
Delete Repair Order Jobs
Deletes Repair Order Jobs from a Repair Order.
- Jobs cannot be deleted if any of their constituent items have already had time clocked against them
Authorizations:
path Parameters
repairOrderId required | string A unique id that identifies an individual Repair Order, which may differ from the |
jobId required | string A unique id that identifies the Repair Order Job. Can be obtained using the 'Get Repair Order' resource |
header Parameters
x-on-behalf-of | string The user (id) of the user who is actually using this resource. This user Id should be known in the receiving system. |
Responses
Response samples
- 404
{- "correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c",
- "message": "Invalid request",
- "details": [
- {
- "field": "Status",
- "value": "string",
- "issue": "The value 'XYZ' is not valid."
}
], - "links": [
- {
- "method": "GET",
- "rel": "self",
- "href": "string",
- "title": "string"
}
]
}
Add Labor
Adds Labor Items to the Repair Order.
Labor Items are identified by the
laborCode
, which must be used in conjunction with a valid brandCode.Must be combined with a
jobId
to specify which Repair Order Job the Parts Item should be added to
Authorizations:
path Parameters
repairOrderId required | string A unique id that identifies an individual Repair Order, which may differ from the |
jobId required | string A unique id that identifies the Repair Order Job. Can be obtained using the 'Get Repair Order' resource |
header Parameters
x-on-behalf-of | string The user (id) of the user who is actually using this resource. This user Id should be known in the receiving system. |
Request Body schema: application/json
Information required to add a new Labor Item
laborCode | string A unique id that identifies pre-defined Labor Tasks within Keyloop systems. The |
brandCode | string A unique id that identifies the Brand with which the |
description | string Description for Labor Tasks. |
allowedTimeInMinutes | integer <int32> Flat rate labor allowance (standard time) time in minutes issued by the provider. This is the time how long (in average) it should take to perform the labor operation. |
linePayer | string (Line Payer) Enum: "CUSTOMER" "DEALER" "WARRANTY" "CONTRACT" "OTHER" The party responsible for paying for the Item. |
object (PriceCreate) Price details to use while create anything related to money. | |
linkReference | string Identifier of labor for external use |
Responses
Request samples
- Payload
{- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "description": "Labor Description",
- "allowedTimeInMinutes": 1,
- "linePayer": "CUSTOMER",
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "grossValue": 100,
- "taxRate": 15.23
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "linkReference": "1"
}
Response samples
- 200
- 404
{- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Requires disassembly of wheel-arch to allow sufficient access",
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "allowedTimeInMinutes": 90,
- "description": "Replace front brake disc",
- "laborDepartmentType": "MOBILESERVICE",
- "skill": {
- "code": "E",
- "description": "Electrical Jobs"
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "technician": {
- "technicianId": "1234567",
- "name": "Smith"
}, - "linkReference": "1"
}
Add Parts
Adds Parts Items to the Repair Order.
Parts Items are identified using the
partId
. If thepartId
is not known, it can be obtained using the 'Find Parts' resourceMust be combined with a
jobId
to specify which Repair Order Job the Parts Item should be added to
Authorizations:
path Parameters
repairOrderId required | string A unique id that identifies an individual Repair Order, which may differ from the |
jobId required | string A unique id that identifies the Repair Order Job. Can be obtained using the 'Get Repair Order' resource |
header Parameters
x-on-behalf-of | string The user (id) of the user who is actually using this resource. This user Id should be known in the receiving system. |
Request Body schema: application/json
Repair order job part item
partId | string A unique id that identifies a Part in the DMS. |
brandCode | string The part's brand code, used with the part code to find the partId. This can be retrieved using the /parts/brands end-point. |
partCode | string The part's code, used with the brand code to find the partId |
linePayer | string (Line Payer) Enum: "CUSTOMER" "DEALER" "WARRANTY" "CONTRACT" "OTHER" The party responsible for paying for the Item. |
quantity | number <double> The quantity of the Part.
|
object (PriceCreate) Price details to use while create anything related to money. | |
linkReference | string Identifier of part for external use |
Responses
Request samples
- Payload
{- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "grossValue": 100,
- "taxRate": 15.23
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "linkReference": "1"
}
Response samples
- 200
- 404
{- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "OPEN",
- "sequenceNumber": 1,
- "notes": "Brake disc may take 500km to wear in. Customer is advised to take extra caution.",
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "unitOfMeasure": {
- "unit": "PIECE",
- "value": 0.5
}, - "quantity": 1,
- "description": "Front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
Add Notes
Adds Notes to the Repair Order to capture additional information relevant to the Job.
- Must be combined with a
jobId
to specify which Repair Order Job the Notes should be added to- Multiple notes can be added to a single Job
- Notes have no value, and cannot have time entries captured against them
- Care should be taken as Notes may appear on customer-facing documentation
Authorizations:
path Parameters
repairOrderId required | string A unique id that identifies an individual Repair Order, which may differ from the |
jobId required | string A unique id that identifies the Repair Order Job. Can be obtained using the 'Get Repair Order' resource |
header Parameters
x-on-behalf-of | string The user (id) of the user who is actually using this resource. This user Id should be known in the receiving system. |
Request Body schema: application/json
Repair order notes item
notes | string Notes or comments that add additional context. |
Responses
Request samples
- Payload
{- "notes": "Vehicle cleaning not required"
}
Response samples
- 200
- 404
{- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Vehicle cleaning not required",
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}
}
Add Fees
Adds Fee Items to the Repair Order.
Fee Items are identified by the
feeCode
.Must be combined with a
jobId
to specify which Repair Order Job the Fee Item should be added to
Authorizations:
path Parameters
repairOrderId required | string A unique id that identifies an individual Repair Order, which may differ from the |
jobId required | string A unique id that identifies the Repair Order Job. Can be obtained using the 'Get Repair Order' resource |
header Parameters
x-on-behalf-of | string The user (id) of the user who is actually using this resource. This user Id should be known in the receiving system. |
Request Body schema: application/json
Information required to add a new Fee Item
feeCode | string A unique id that identifies pre-defined Fees within Keyloop systems. Not required if using a 'feeType' |
feeType | string (FeeType) Enum: "Other" "Environmental" "OilDisposal" "ThirdPartyLaborCost" "SmallMaterialCostsOnLabor" "SmallMaterialCostsOnParts" A fee type which will be mapped in the DMS to a 'feeCode' |
description | string A description of the fee item.
|
linePayer | string (Line Payer) Enum: "CUSTOMER" "DEALER" "WARRANTY" "CONTRACT" "OTHER" The party responsible for paying for the Item. |
quantity | number Quantity for fee item. |
object (Price) This is common Price section that is used always when anything money related information is handled. | |
notes | string Notes or comments that add additional context. |
linkReference | string Identifier of fee for external use |
Responses
Request samples
- Payload
{- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "notes": "Required to be collected as per regulatory",
- "linkReference": "1"
}
Response samples
- 200
- 404
{- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Environmental fee is added automatically",
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "quantity": 1,
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
Add menus
Add menu to the Repair Order Job
Authorizations:
path Parameters
repairOrderId required | string A unique id that identifies an individual Repair Order, which may differ from the |
jobId required | string A unique id that identifies the Repair Order Job. Can be obtained using the 'Get Repair Order' resource |
header Parameters
x-on-behalf-of | string The user (id) of the user who is actually using this resource. This user Id should be known in the receiving system. |
Request Body schema: application/json
Information required to add a new menu
menuCode | string A unique code that identifies the Menu. |
brandCode | string A unique id that identifies the Brand with which the |
description | string Description of menu. |
linePayer | string (Line Payer) Enum: "CUSTOMER" "DEALER" "WARRANTY" "CONTRACT" "OTHER" The party responsible for paying for the Item. |
menuType | string (MenuType) Enum: "DMS_DEFINED" "FIXED" "ITEMISED" A type of menu. |
object (MenuPriceCreate) Price details to use while create anything related to money. | |
object Components are only required if a menuCode has not been supplied | |
linkReference | string Identifier of menu for external use |
Responses
Request samples
- Payload
{- "menuCode": "MENU1",
- "brandCode": "DEALER",
- "description": "Menu description",
- "linePayer": "CUSTOMER",
- "menuType": "FIXED",
- "menuPrice": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": "NET",
- "value": 100,
- "taxRate": 20
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "discountSplit": {
- "labor": 50,
- "parts": 50
}
}, - "menuComponents": {
- "labor": [
- {
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "description": "Labor Description",
- "allowedTimeInMinutes": 1,
- "linePayer": "CUSTOMER",
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": "NET",
- "value": 100,
- "taxRate": 20
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "linkReference": "1"
}
], - "parts": [
- {
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": "NET",
- "value": 100,
- "taxRate": 20
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "linkReference": "1"
}
], - "fees": [
- {
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "orderPrice": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": "NET",
- "value": 100,
- "taxRate": 20
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "notes": "Required to be collected as per regulatory"
}
], - "notes": [
- {
- "notes": "Vehicle cleaning not required"
}
]
}, - "linkReference": "1"
}
Response samples
- 201
- 404
{- "itemId": "00000000-0000-0000-0000-000000000000",
- "sequenceNumber": 1,
- "brandCode": "DEALER",
- "menuCode": "MENU1",
- "menuType": "FIXED",
- "parts": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "OPEN",
- "sequenceNumber": 1,
- "notes": "Brake disc may take 500km to wear in. Customer is advised to take extra caution.",
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "unitOfMeasure": {
- "unit": "PIECE",
- "value": 0.5
}, - "quantity": 1,
- "description": "Front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "labor": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Requires disassembly of wheel-arch to allow sufficient access",
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "allowedTimeInMinutes": 90,
- "description": "Replace front brake disc",
- "laborDepartmentType": "MOBILESERVICE",
- "skill": {
- "code": "E",
- "description": "Electrical Jobs"
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "technician": {
- "technicianId": "1234567",
- "name": "Smith"
}, - "linkReference": "1"
}
], - "notes": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Vehicle cleaning not required",
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}
}
], - "fees": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Environmental fee is added automatically",
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "quantity": 1,
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "description": "Replace front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "linkReference": "1"
}
Add items
Add multiple items to the Repair Order Job
Authorizations:
path Parameters
repairOrderId required | string A unique id that identifies an individual Repair Order, which may differ from the |
jobId required | string A unique id that identifies the Repair Order Job. Can be obtained using the 'Get Repair Order' resource |
header Parameters
x-on-behalf-of | string The user (id) of the user who is actually using this resource. This user Id should be known in the receiving system. |
Request Body schema: application/json
Information required to add a new menu
Array of objects (MenuCreate) Menus included in this item list | |
Array of objects (LaborCreate) Labor included in this item list | |
Array of objects (PartCreate) Parts included in this item list | |
Array of objects (FeeCreate) Fees included in this item list | |
Array of objects (NotesCreate) Notes included in this item list |
Responses
Request samples
- Payload
{- "menus": [
- {
- "menuCode": "MENU1",
- "brandCode": "DEALER",
- "description": "Menu description",
- "linePayer": "CUSTOMER",
- "menuType": "FIXED",
- "menuPrice": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": "NET",
- "value": 100,
- "taxRate": 20
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "discountSplit": {
- "labor": 50,
- "parts": 50
}
}, - "menuComponents": {
- "labor": [
- {
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "description": "Labor Description",
- "allowedTimeInMinutes": 1,
- "linePayer": "CUSTOMER",
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": "NET",
- "value": 100,
- "taxRate": 20
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "linkReference": "1"
}
], - "parts": [
- {
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": "NET",
- "value": 100,
- "taxRate": 20
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "linkReference": "1"
}
], - "fees": [
- {
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "orderPrice": {
- "currencyCode": "GBP",
- "listPrice": {
- "valueType": "NET",
- "value": 100,
- "taxRate": 20
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "notes": "Required to be collected as per regulatory"
}
], - "notes": [
- {
- "notes": "Vehicle cleaning not required"
}
]
}, - "linkReference": "1"
}
], - "labor": [
- {
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "description": "Labor Description",
- "allowedTimeInMinutes": 1,
- "linePayer": "CUSTOMER",
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "grossValue": 100,
- "taxRate": 15.23
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "linkReference": "1"
}
], - "parts": [
- {
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "grossValue": 100,
- "taxRate": 15.23
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "linkReference": "1"
}
], - "fees": [
- {
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "linePayer": "CUSTOMER",
- "quantity": 1,
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "notes": "Required to be collected as per regulatory",
- "linkReference": "1"
}
], - "notes": [
- {
- "notes": "Vehicle cleaning not required"
}
]
}
Response samples
- 201
- 404
{- "menus": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "sequenceNumber": 1,
- "brandCode": "DEALER",
- "menuCode": "MENU1",
- "menuType": "FIXED",
- "parts": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "OPEN",
- "sequenceNumber": 1,
- "notes": "Brake disc may take 500km to wear in. Customer is advised to take extra caution.",
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "unitOfMeasure": {
- "unit": "PIECE",
- "value": 0.5
}, - "quantity": 1,
- "description": "Front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "labor": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Requires disassembly of wheel-arch to allow sufficient access",
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "allowedTimeInMinutes": 90,
- "description": "Replace front brake disc",
- "laborDepartmentType": "MOBILESERVICE",
- "skill": {
- "code": "E",
- "description": "Electrical Jobs"
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "technician": {
- "technicianId": "1234567",
- "name": "Smith"
}, - "linkReference": "1"
}
], - "notes": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Vehicle cleaning not required",
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}
}
], - "fees": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Environmental fee is added automatically",
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "quantity": 1,
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "description": "Replace front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "linkReference": "1"
}
], - "parts": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "OPEN",
- "sequenceNumber": 1,
- "notes": "Brake disc may take 500km to wear in. Customer is advised to take extra caution.",
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "unitOfMeasure": {
- "unit": "PIECE",
- "value": 0.5
}, - "quantity": 1,
- "description": "Front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "labor": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Requires disassembly of wheel-arch to allow sufficient access",
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "allowedTimeInMinutes": 90,
- "description": "Replace front brake disc",
- "laborDepartmentType": "MOBILESERVICE",
- "skill": {
- "code": "E",
- "description": "Electrical Jobs"
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "technician": {
- "technicianId": "1234567",
- "name": "Smith"
}, - "linkReference": "1"
}
], - "notes": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Vehicle cleaning not required",
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}
}
], - "fees": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Environmental fee is added automatically",
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "quantity": 1,
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
]
}
Update items
Update items in the Repair Order
Authorizations:
path Parameters
repairOrderId required | string A unique id that identifies an individual Repair Order, which may differ from the |
header Parameters
x-on-behalf-of | string The user (id) of the user who is actually using this resource. This user Id should be known in the receiving system. |
Request Body schema: application/json
Information required to add a new menu
Array of objects (LaborUpdate) Labor included in this item list. | |
Array of objects (PartUpdate) Part included in this item list. | |
Array of objects (FeeUpdate) Fees included in the item list. | |
Array of objects (NotesUpdate) Notes included in this item list. |
Responses
Request samples
- Payload
{- "labor": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "description": "Labor Description",
- "allowedTimeInMinutes": 1,
- "linePayer": "CUSTOMER",
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "grossValue": 100,
- "taxRate": 15.23
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "linkReference": "1"
}
], - "parts": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "quantity": 1,
- "linePayer": "CUSTOMER",
- "price": {
- "currencyCode": "GBP",
- "listPrice": {
- "grossValue": 100,
- "taxRate": 15.23
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
}, - "linkReference": "1"
}
], - "fees": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "description": "Environmental Fee",
- "quantity": 1,
- "linePayer": "CUSTOMER",
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "notes": "Required to be collected as per regulatory",
- "linkReference": "1"
}
], - "notes": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "notes": "Vehicle cleaning not required"
}
]
}
Response samples
- 404
{- "correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c",
- "message": "Invalid request",
- "details": [
- {
- "field": "Status",
- "value": "string",
- "issue": "The value 'XYZ' is not valid."
}
], - "links": [
- {
- "method": "GET",
- "rel": "self",
- "href": "string",
- "title": "string"
}
]
}
Delete Items
Delete items in the Repair Order
Authorizations:
path Parameters
repairOrderId required | string A unique id that identifies an individual Repair Order, which may differ from the |
query Parameters
itemIds required | Array of strings Repair order item id |
header Parameters
x-on-behalf-of | string The user (id) of the user who is actually using this resource. This user Id should be known in the receiving system. |
Responses
Response samples
- 404
{- "correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c",
- "message": "Invalid request",
- "details": [
- {
- "field": "Status",
- "value": "string",
- "issue": "The value 'XYZ' is not valid."
}
], - "links": [
- {
- "method": "GET",
- "rel": "self",
- "href": "string",
- "title": "string"
}
]
}
Set Item Discount
Sets the discount for a Labor or Parts Item.
- Setting a discount will overwrite any previous discount parameters set for the specified item
Authorizations:
path Parameters
repairOrderId required | string A unique id that identifies an individual Repair Order, which may differ from the |
jobId required | string A unique id that identifies the Repair Order Job. Can be obtained using the 'Get Repair Order' resource |
itemId required | string Repair order item id |
header Parameters
x-on-behalf-of | string The user (id) of the user who is actually using this resource. This user Id should be known in the receiving system. |
Request Body schema: application/json
Discount to update
value required | number <double> Set the value to the amount you wish to deduct, using the 'type' to determine if a percentage or unit amount |
currencyCode | string[A-Z]{3} Currency code used when discount given is of GROSSVALUE type in ISO 4217. |
type required | string Enum: "PERCENTAGE" "GROSSVALUE" Use PERCENTAGE to deduct the 'value' as a precentage |
description | string Discount description |
Responses
Request samples
- Payload
{- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}
Response samples
- 404
{- "correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c",
- "message": "Invalid request",
- "details": [
- {
- "field": "Status",
- "value": "string",
- "issue": "The value 'XYZ' is not valid."
}
], - "links": [
- {
- "method": "GET",
- "rel": "self",
- "href": "string",
- "title": "string"
}
]
}
Check In Customer
Updates the status of the Repair Order, and allows certain data to be added, such as;
- Vehicle mileage on arrival
- Customer waiting preferences
- Additional notes about the repair
Authorizations:
path Parameters
repairOrderId required | string A unique id that identifies an individual Repair Order, which may differ from the |
header Parameters
x-on-behalf-of | string The user (id) of the user who is actually using this resource. This user Id should be known in the receiving system. |
Request Body schema: application/json
create checkIn
notes | string Additional notes for check-in |
object (VehicleMileage) Vehicle odometer reading | |
takeOwnership | boolean Defines whether ownership of the Repair Order should be transferred to the current advisor. If |
customerWaiting | boolean Defines whether the customer is waiting on-site for work to be completed. If |
advisorId | string The Id of the Advisor who checked in the customer |
checkInDateTime | string <date-time> The date and time the vehicle was checked in. |
Responses
Request samples
- Payload
{- "notes": "Additional",
- "checkInMileage": {
- "unit": "KM",
- "value": 120000
}, - "takeOwnership": true,
- "customerWaiting": true,
- "advisorId": "rca1",
- "checkInDateTime": "2021-07-16T00:00:00.000Z"
}
Response samples
- 200
- 404
{- "repairOrderId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "type": "WARRANTY",
- "details": {
- "reference": "12345-67890-12345",
- "customerPurchaseOrderNumber": "PO123456",
- "payerAccount": "A12345",
- "notes": "Vehicle cleaning not required",
- "checkInDateTime": "2021-07-16T00:00:00.000Z",
- "checkOutDateTime": "2021-07-16T00:00:00.000Z",
- "completedDateTime": "2022-05-20T00:00:00.000Z",
- "closedDateTime": "2022-05-20T00:00:00.000Z",
- "checkInMileage": {
- "unit": "KM",
- "value": 120000
}, - "checkOutMileage": {
- "unit": "KM",
- "value": 120000
}, - "onHoldReason": "Waiting for customer approval",
- "serviceTypes": [
- "SCHEDULED_MAINTENANCE"
], - "customerWaiting": true
}, - "vehicle": {
- "vehicleId": "00000000-0000-0000-0000-000000000000",
- "reference": "10345",
- "class": "CAR",
- "makeId": "FORD",
- "description": "string",
- "vin": "string",
- "licensePlate": "string",
- "referenceData": {
- "providerId": "DMS",
- "makeCode": "FO",
- "modelCode": "FOCUS",
- "variantCode": "123560",
- "vehicleCode": "ABC12345656"
}
}, - "customer": {
- "customerId": "string",
- "familyName": "string",
- "givenName": "string",
- "titleCommon": "string"
}, - "company": {
- "companyId": "string",
- "name": "string"
}, - "contact": {
- "name": "Michael Midlander",
- "customer": "Michael Midlander",
- "phone": "123-123123",
- "email": "mike@domain.com",
- "companyName": "Company Ltd.",
- "address": {
- "streetType": "Avenue",
- "streetName": "Mill Lane",
- "houseNumber": "7",
- "buildingName": "string",
- "floorNumber": "string",
- "doorNumber": "string",
- "blockName": "string",
- "estate": "string",
- "postalCode": "SE4 1UU",
- "suburb": "string",
- "city": "London",
- "county": "string",
- "province": "string",
- "countryCode": "GB"
}
}, - "resources": {
- "assignedAdvisor": {
- "serviceAdvisorId": "1234567",
- "name": "Service Advisor",
- "userId": "user1"
}, - "contactAdvisor": {
- "serviceAdvisorId": "1234567",
- "name": "Service Advisor",
- "userId": "user1"
}
}, - "appointment": {
- "notes": "The customer would like a coffee on arrival.",
- "bookingOptions": {
- "type": "NONE"
}, - "dueInDateTime": "2019-03-20T00:00:00.000Z",
- "dueOutDateTime": "2019-03-20T00:00:00.000Z",
- "customerWaiting": true
}, - "planning": {
- "plannedIn": "2019-03-20T00:00:00.000Z",
- "plannedOut": "2019-03-20T00:00:00.000Z"
}, - "jobs": [
- {
- "jobId": "00000000-0000-0000-0000-000000000000",
- "description": "Replace worn front N/S brake disc + pads",
- "serviceTypes": [
- "SCHEDULED_MAINTENANCE"
], - "workStartedDateTime": "2021-07-16T00:00:00.000Z",
- "workCompletedDateTime": "2021-07-16T00:00:00.000Z",
- "linkReference": "1",
- "isVhc": true,
- "vhcDetails": {
- "jobConditionCode": "GREEN",
- "vhcOperator": "Smith"
}, - "menus": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "sequenceNumber": 1,
- "brandCode": "DEALER",
- "menuCode": "MENU1",
- "menuType": "FIXED",
- "parts": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "OPEN",
- "sequenceNumber": 1,
- "notes": "Brake disc may take 500km to wear in. Customer is advised to take extra caution.",
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "unitOfMeasure": {
- "unit": "PIECE",
- "value": 0.5
}, - "quantity": 1,
- "description": "Front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "labor": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Requires disassembly of wheel-arch to allow sufficient access",
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "allowedTimeInMinutes": 90,
- "description": "Replace front brake disc",
- "laborDepartmentType": "MOBILESERVICE",
- "skill": {
- "code": "E",
- "description": "Electrical Jobs"
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "technician": {
- "technicianId": "1234567",
- "name": "Smith"
}, - "linkReference": "1"
}
], - "notes": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Vehicle cleaning not required",
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}
}
], - "fees": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Environmental fee is added automatically",
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "quantity": 1,
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "description": "Replace front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "linkReference": "1"
}
], - "labor": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Requires disassembly of wheel-arch to allow sufficient access",
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "allowedTimeInMinutes": 90,
- "description": "Replace front brake disc",
- "laborDepartmentType": "MOBILESERVICE",
- "skill": {
- "code": "E",
- "description": "Electrical Jobs"
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "technician": {
- "technicianId": "1234567",
- "name": "Smith"
}, - "linkReference": "1"
}
], - "parts": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "OPEN",
- "sequenceNumber": 1,
- "notes": "Brake disc may take 500km to wear in. Customer is advised to take extra caution.",
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "unitOfMeasure": {
- "unit": "PIECE",
- "value": 0.5
}, - "quantity": 1,
- "description": "Front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "notes": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Vehicle cleaning not required",
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}
}
], - "fees": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Environmental fee is added automatically",
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "quantity": 1,
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "links": [
- {
- "method": "GET",
- "rel": "self",
- "href": "string",
- "title": "string"
}
]
}
], - "updateHistory": {
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "previousRepairOrderId": "00000000-0000-0000-0000-000000000000",
- "mainRepairOrderId": "00000000-0000-0000-0000-000000000000",
- "subOrders": [
- {
- "repairOrderId": "00000000-0000-0000-0000-000000000000"
}
]
}, - "links": [
- {
- "method": "GET",
- "rel": "self",
- "href": "href"
}
]
}
Update repair order details
- Updates the Repair Order details, such as Notes or Contact details
- A valid
customerId
andvehicleId
must be provided in the request. These can be obtained using the 'Find Customer' and 'Find Vehicle' resources.
Authorizations:
path Parameters
repairOrderId required | string repairOrderId |
header Parameters
x-on-behalf-of | string The user (id) of the user who is actually using this resource. This user Id should be known in the receiving system. |
Request Body schema: application/json
Repair Order details
vehicleId | string (VehicleId) A unique id that identifies a vehicle in the DMS. |
customerId | string (CustomerId) A unique id that identifies a customer in the DMS.
|
companyId | string (CompanyId) A unique id that identifies a customer in the DMS.
|
payerAccount | string (PayerAccount) The account number for the person or organisation paying the invoice. |
notes | string Notes or comments that add additional context. |
object (Contact) Contact person | |
contactAdvisorId | string (Contact Advisor) Contact advisor id |
object (VehicleMileage) Vehicle odometer reading |
Responses
Request samples
- Payload
{- "vehicleId": "00000000-0000-0000-0000-000000000000",
- "customerId": "00000000-0000-0000-0000-000000000000",
- "companyId": "00000000-0000-0000-0000-000000000000",
- "payerAccount": "A12345",
- "notes": "Vehicle cleaning not required",
- "contact": {
- "name": "string",
- "phone": "string",
- "email": "string",
- "companyName": "string"
}, - "contactAdvisorId": "1234",
- "vehicleMileage": {
- "unit": "KM",
- "value": 120000
}
}
Response samples
- 404
{- "correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c",
- "message": "Invalid request",
- "details": [
- {
- "field": "Status",
- "value": "string",
- "issue": "The value 'XYZ' is not valid."
}
], - "links": [
- {
- "method": "GET",
- "rel": "self",
- "href": "string",
- "title": "string"
}
]
}
Update repair order appointment details
Updates the Repair Order appointment details, such as;
- Customer due-in and due-out dates
- Customer waiting preferences
Authorizations:
path Parameters
repairOrderId required | string repairOrderId |
header Parameters
x-on-behalf-of | string The user (id) of the user who is actually using this resource. This user Id should be known in the receiving system. |
Request Body schema: application/json
Appointment details
dueInDateTime | string or null <date-time> (DueInDateTime) The date and time the vehicle is due to arrive at the workshop. |
dueOutDateTime | string or null <date-time> (DueOutDateTime) The date and time the vehicle is due to be collected. |
customerWaiting | boolean Defines whether the customer is waiting on-site for work to be completed. If |
Responses
Request samples
- Payload
{- "dueInDateTime": "2019-03-20T00:00:00.000Z",
- "dueOutDateTime": "2019-03-20T00:00:00.000Z",
- "customerWaiting": true
}
Response samples
- 404
{- "correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c",
- "message": "Invalid request",
- "details": [
- {
- "field": "Status",
- "value": "string",
- "issue": "The value 'XYZ' is not valid."
}
], - "links": [
- {
- "method": "GET",
- "rel": "self",
- "href": "string",
- "title": "string"
}
]
}
Update repair order planning details
This endpoint is typically used by 3rd party planning applications to update the Repair Order planning details, such as;
- Workshop planned-in and planned-out dates
Authorizations:
path Parameters
repairOrderId required | string repairOrderId |
header Parameters
x-on-behalf-of | string The user (id) of the user who is actually using this resource. This user Id should be known in the receiving system. |
Request Body schema: application/json
Planning details
plannedIn | string <date-time> The date and time the work is planned to start in the workshop. |
plannedOut | string <date-time> The date and time when the work is planned to finish in the workshop. |
Responses
Request samples
- Payload
{- "plannedIn": "2019-03-20T00:00:00.000Z",
- "plannedOut": "2019-03-20T00:00:00.000Z"
}
Response samples
- 403
- 404
{- "correlationId": "48fb4cd3-2ef6-4479-bea1-7c92721b988c",
- "message": "Invalid request",
- "details": [
- {
- "field": "Status",
- "value": "string",
- "issue": "The value 'XYZ' is not valid."
}
], - "links": [
- {
- "method": "GET",
- "rel": "self",
- "href": "string",
- "title": "string"
}
]
}
Check Out Vehicle
Updates the status of the Repair Order, and allows certain data to be added, such as:
- Vehicle mileage on departure
- Additional notes about the repair
Authorizations:
path Parameters
repairOrderId required | string repairOrderId |
header Parameters
x-on-behalf-of | string The user (id) of the user who is actually using this resource. This user Id should be known in the receiving system. |
Request Body schema: application/json
create checkOut
notes | string Additional notes for check-out |
object (VehicleMileage) Vehicle odometer reading | |
advisorId | string The Id of the Advisor who checked out the customer |
checkOutDateTime required | string <date-time> The date and time the vehicle was checked out. |
Responses
Request samples
- Payload
{- "notes": "Additional",
- "checkOutMileage": {
- "unit": "KM",
- "value": 120000
}, - "advisorId": "rca1",
- "checkOutDateTime": "2021-07-16T00:00:00.000Z"
}
Response samples
- 200
- 404
{- "repairOrderId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "type": "WARRANTY",
- "details": {
- "reference": "12345-67890-12345",
- "customerPurchaseOrderNumber": "PO123456",
- "payerAccount": "A12345",
- "notes": "Vehicle cleaning not required",
- "checkInDateTime": "2021-07-16T00:00:00.000Z",
- "checkOutDateTime": "2021-07-16T00:00:00.000Z",
- "completedDateTime": "2022-05-20T00:00:00.000Z",
- "closedDateTime": "2022-05-20T00:00:00.000Z",
- "checkInMileage": {
- "unit": "KM",
- "value": 120000
}, - "checkOutMileage": {
- "unit": "KM",
- "value": 120000
}, - "onHoldReason": "Waiting for customer approval",
- "serviceTypes": [
- "SCHEDULED_MAINTENANCE"
], - "customerWaiting": true
}, - "vehicle": {
- "vehicleId": "00000000-0000-0000-0000-000000000000",
- "reference": "10345",
- "class": "CAR",
- "makeId": "FORD",
- "description": "string",
- "vin": "string",
- "licensePlate": "string",
- "referenceData": {
- "providerId": "DMS",
- "makeCode": "FO",
- "modelCode": "FOCUS",
- "variantCode": "123560",
- "vehicleCode": "ABC12345656"
}
}, - "customer": {
- "customerId": "string",
- "familyName": "string",
- "givenName": "string",
- "titleCommon": "string"
}, - "company": {
- "companyId": "string",
- "name": "string"
}, - "contact": {
- "name": "Michael Midlander",
- "customer": "Michael Midlander",
- "phone": "123-123123",
- "email": "mike@domain.com",
- "companyName": "Company Ltd.",
- "address": {
- "streetType": "Avenue",
- "streetName": "Mill Lane",
- "houseNumber": "7",
- "buildingName": "string",
- "floorNumber": "string",
- "doorNumber": "string",
- "blockName": "string",
- "estate": "string",
- "postalCode": "SE4 1UU",
- "suburb": "string",
- "city": "London",
- "county": "string",
- "province": "string",
- "countryCode": "GB"
}
}, - "resources": {
- "assignedAdvisor": {
- "serviceAdvisorId": "1234567",
- "name": "Service Advisor",
- "userId": "user1"
}, - "contactAdvisor": {
- "serviceAdvisorId": "1234567",
- "name": "Service Advisor",
- "userId": "user1"
}
}, - "appointment": {
- "notes": "The customer would like a coffee on arrival.",
- "bookingOptions": {
- "type": "NONE"
}, - "dueInDateTime": "2019-03-20T00:00:00.000Z",
- "dueOutDateTime": "2019-03-20T00:00:00.000Z",
- "customerWaiting": true
}, - "planning": {
- "plannedIn": "2019-03-20T00:00:00.000Z",
- "plannedOut": "2019-03-20T00:00:00.000Z"
}, - "jobs": [
- {
- "jobId": "00000000-0000-0000-0000-000000000000",
- "description": "Replace worn front N/S brake disc + pads",
- "serviceTypes": [
- "SCHEDULED_MAINTENANCE"
], - "workStartedDateTime": "2021-07-16T00:00:00.000Z",
- "workCompletedDateTime": "2021-07-16T00:00:00.000Z",
- "linkReference": "1",
- "isVhc": true,
- "vhcDetails": {
- "jobConditionCode": "GREEN",
- "vhcOperator": "Smith"
}, - "menus": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "sequenceNumber": 1,
- "brandCode": "DEALER",
- "menuCode": "MENU1",
- "menuType": "FIXED",
- "parts": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "OPEN",
- "sequenceNumber": 1,
- "notes": "Brake disc may take 500km to wear in. Customer is advised to take extra caution.",
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "unitOfMeasure": {
- "unit": "PIECE",
- "value": 0.5
}, - "quantity": 1,
- "description": "Front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "labor": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Requires disassembly of wheel-arch to allow sufficient access",
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "allowedTimeInMinutes": 90,
- "description": "Replace front brake disc",
- "laborDepartmentType": "MOBILESERVICE",
- "skill": {
- "code": "E",
- "description": "Electrical Jobs"
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "technician": {
- "technicianId": "1234567",
- "name": "Smith"
}, - "linkReference": "1"
}
], - "notes": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Vehicle cleaning not required",
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}
}
], - "fees": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Environmental fee is added automatically",
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "quantity": 1,
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "description": "Replace front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "linkReference": "1"
}
], - "labor": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Requires disassembly of wheel-arch to allow sufficient access",
- "laborCode": "LABOR1",
- "brandCode": "DEALER",
- "allowedTimeInMinutes": 90,
- "description": "Replace front brake disc",
- "laborDepartmentType": "MOBILESERVICE",
- "skill": {
- "code": "E",
- "description": "Electrical Jobs"
}, - "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "technician": {
- "technicianId": "1234567",
- "name": "Smith"
}, - "linkReference": "1"
}
], - "parts": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "OPEN",
- "sequenceNumber": 1,
- "notes": "Brake disc may take 500km to wear in. Customer is advised to take extra caution.",
- "partId": "00000000-0000-0000-0000-000000000000",
- "brandCode": "BRAND",
- "partCode": "8765432",
- "unitOfMeasure": {
- "unit": "PIECE",
- "value": 0.5
}, - "quantity": 1,
- "description": "Front brake disc",
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "listPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "notes": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Vehicle cleaning not required",
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}
}
], - "fees": [
- {
- "itemId": "00000000-0000-0000-0000-000000000000",
- "status": "CREATED",
- "sequenceNumber": 1,
- "notes": "Environmental fee is added automatically",
- "feeCode": "ENVFEE",
- "feeType": "Environmental",
- "description": "Environmental Fee",
- "quantity": 1,
- "discount": {
- "value": 10,
- "currencyCode": "EUR",
- "type": "PERCENTAGE",
- "description": "string"
}, - "linePayer": "CUSTOMER",
- "orderPrice": {
- "netValue": 100,
- "grossValue": 120,
- "taxValue": 20,
- "taxRate": 19.99,
- "currencyCode": "GBP"
}, - "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "linkReference": "1"
}
], - "links": [
- {
- "method": "GET",
- "rel": "self",
- "href": "string",
- "title": "string"
}
]
}
], - "updateHistory": {
- "updateHistory": {
- "created": "2008-09-15T15:53:00.000Z",
- "lastModified": "2022-05-15T15:53:00.000Z"
}, - "previousRepairOrderId": "00000000-0000-0000-0000-000000000000",
- "mainRepairOrderId": "00000000-0000-0000-0000-000000000000",
- "subOrders": [
- {
- "repairOrderId": "00000000-0000-0000-0000-000000000000"
}
]
}, - "links": [
- {
- "method": "GET",
- "rel": "self",
- "href": "href"
}
]
}