This documentation describes the Navigator Public API.
\nMost calla use an Api Key which is presented in the header key : x-api-key
\nTo use the API, you will need an Api Key issuing.
\nApi Keys will not necessarily allow access to the full api
\nWeb Site developers will need access to 3 key APIs in the library.
\nvehicles/stockList -> This will gain access to the full vehicle stock list. Normally, only advertised vehicles will be required and there is a filter for this. Each vehicle has a field called \"images\" which is a semi-colon list of images related to the vehicle.
\nThe images can then be downloaded using the vehicles/image api
\nThe vehicle database should not be used for live lookups but should be used once or twice a day to synchronise stock
\nFor transferring leads to Navigator, the enquiry/createEnquiry endpoint should be used.
\nEvengtscan be subscribed to using the webhooks/subscription api.
\nPart of the subscription defines which events you would like to subscribe to and the url to call.
\nAll webhooks are called as HTTP Post with a json payload.
\nThe data for each webhook is always in for generic format of :-
\n{
\"event\" :
{
\"id\" : \"{eventId}\"
...
}
}
The supported events currently are :-
\nThis event is raised whenever a stock record is updated in Navigator.
\nThe data returned in the webhook as as follows :-
\n{
\"event\":
{
\"id\": \"vehicle.update\",
\"vehicleId\": \"{stockiNumber}\",
\"branch\" :\"{branch}\"
}
}
This event is raised whenever a customer record is updated in Navigator.
\nThe data returned in the webhook as as follows :-
\n{
\"event\":
{
\"id\": \"customer.update\",
\"customerId\": \"{customer Id}\",
}
}
This endpoint allows you to search for customers in the DMS Navigator system using various search criteria. The search is flexible and returns matching customer records along with their associated vehicle information.
\nAuthentication is by a header key : x-api-key
\nSearch and retrieve customer records based on one or more identifying parameters such as surname, postcode, telephone number, or vehicle registration number.
\nThe request accepts a JSON object with the following optional search parameters:
\nNote: At least one search parameter should be provided for meaningful results. Empty strings are treated as no filter for that parameter.
\n{\n \"surname\": \"verona\",\n \"postCode\": \"\",\n \"telephone\": \"\",\n \"regNo\": \"\"\n}\n\nThe endpoint returns an array of customer objects. Each customer object contains:
\n[\n {\n \"#\": \"12637.3\",\n \"Title\": \"Mr\",\n \"First Name\": \"Simon\",\n \"Address\": \"AB10 1AA,1C THE HIGH STREET\",\n \"Company Name\": \"\",\n \"Co Address\": \"\",\n \"Co Telephone\": \" \",\n \"Surname\": \"Verona\",\n \"Reg\": \"OE71WMG\",\n \"Make\": \"Polestar\",\n \"Model\": \"2\",\n \"Telephone\": \"07388907708\"\n },\n {\n \"#\": \"14217.1\",\n \"Title\": \"Mr\",\n \"First Name\": \"Simon\",\n \"Address\": \"AB10 1AA,1C THE HIGH STREET\",\n \"Company Name\": \"\",\n \"Co Address\": \"\",\n \"Co Telephone\": \" \",\n \"Surname\": \"Verona\",\n \"Reg\": \"SX73SPV\",\n \"Make\": \"PORSCHE\",\n \"Model\": \"718\",\n \"Telephone\": \"07388907708\"\n }\n]\n\nThe search is case-insensitive
\nMultiple matching records may be returned as an array
\nEmpty result set returns an empty array []
Customers may have multiple vehicle records associated with them
\nSome fields may be empty strings if data is not available
\nThe # field serves as a unique customer identifier in the format {id}
This endpoint creates a new customer record in the DMS Navigator system. It accepts customer details including personal information and address, and returns a unique customer identifier upon successful creation.
\nAuthentication is by a header key : x-api-key
\nSuccess (200 OK)
\n{\n \"success\": true,\n \"customerId\": \"15328\"\n}\n\nAll string fields should be properly formatted and validated before submission
\nEmail addresses must be in valid format
\nThe customerId returned in the response should be stored for future reference and customer management operations
Phone and mobile numbers should include appropriate country codes if applicable
\nThis endpoint retrieves detailed customer information from the DMS Navigator system using a customer ID.
\nhttps://services.dmservices.co.uk/webhooks/customer/retrieveCustomerThis endpoint requires API key authentication. The API key should be passed using the apikey variable, which is typically included as a query parameter or header.
The request body must be in JSON format and include the following required field:
\n{\n \"id\": \"SL476.1\"\n}\nThe endpoint returns a JSON object containing the customer's information.
\n{\n \"success\": true,\n \"customer\": {\n \"id\": \"SL476.1\",\n \"firstName\": \"Olu\",\n \"email\": \"leanne@dmservices.co.uk\",\n \"address\": {\n \"houseNo\": \"\",\n \"line2\": \"\",\n \"line3\": \"\",\n \"line4\": \"\",\n \"postCode\": \"\"\n },\n \"title\": \"\",\n \"surname\": \"Parr\",\n \"phone\": \"\",\n \"mobile\": \"07972022552\"\n }\n}\nTo retrieve customer information, send a POST request with the customer ID in the request body. Ensure your API key is properly configured in the request authentication.
\nsuccess field indicates whether the customer was found and retrieved successfullyCalls to the Customer API will allow the retrieval, creation and updating of Customer Records in the Navigator Database.
\n","_postman_id":"2520739e-ea0a-4c6c-b586-862d66cda686","auth":{"type":"apikey","apikey":{"value":"{{apikey}}","key":"This endpoint creates a new sales enquiry in the DMS Navigator system. It captures customer information, vehicle of interest details, and optional part-exchange information for automotive dealerships.
\nThis endpoint requires API key authentication. The API key should be passed using the apikey variable (typically in headers or query parameters as configured in your environment).
Noites:-
\nEither a Customer ID or a Name is required.
\nA method of contact is required - either phone no, email or address
\nContains the customer's contact and address information.
\nDetails about the vehicle the customer is interested in purchasing.
\nIf the stockNo field is supplied then the other fields are not required.
\nInformation about the customer's vehicle for part-exchange (optional).
\n{\n \"success\": true,\n \"enquiryId\": \"3145\"\n}\n\nAll string fields should be properly encoded
\nPhone numbers can be in various formats
\nThe offered field in part-exchange should be a numeric string representing the currency value
Empty strings are acceptable for optional fields
\nThe enquiry ID returned can be used for subsequent operations like updating or retrieving enquiry details
\nThis endpoint updates an existig sales enquiry in the DMS Navigator system. It updatescustomer information, vehicle of interest details, and optional part-exchange information for automotive dealerships.
\nThis endpoint requires API key authentication. The API key should be passed using the apikey variable (typically in headers or query parameters as configured in your environment).
Noites:-
\nEither a Customer ID or a Name is required.
\nA method of contact is required - either phone no, email or address
\nContains the customer's contact and address information.
\nDetails about the vehicle the customer is interested in purchasing.
\nIf the stockNo field is supplied then the other fields are not required.
\nInformation about the customer's vehicle for part-exchange (optional).
\n{\n \"success\": true,\n \"enquiryId\": \"3145\"\n}\n\nAll string fields should be properly encoded
\nPhone numbers can be in various formats
\nThe offered field in part-exchange should be a numeric string representing the currency value
Empty strings are acceptable for optional fields
\nThe enquiry ID returned can be used for subsequent operations like updating or retrieving enquiry details
\nThis endpoint adds a contact to an existing enquiry in the DMS Navigator system. It allows you to associate contact information and notes with a specific enquiry number.
\nThis endpoint requires API key authentication using the apikey variable, which should be configured in your environment.
The request accepts a JSON payload with the following parameters:
\n{\n \"contactType\": \"telephone\",\n \"notes\": \"this is a test note\",\n \"enquiryNo\": \"3159\"\n}\n\n{\n \"success\": true\n}\n\nThe endpoint returns a simple JSON object indicating whether the contact was successfully added to the enquiry.
\nEnsure the enquiryNo corresponds to an existing enquiry in the system
The contactType value should match the expected contact type codes in your DMS Navigator configuration
All three parameters are required for successful contact creation
\nThe enquiry endpoint can be used to create or update a sales enquiry
\n","_postman_id":"62298a29-aabd-4ef1-9754-feb590e1de48","auth":{"type":"apikey","apikey":{"value":"{{apikey}}","key":"This endpoint retrieves a filtered list of vehicle stock from the DMS Navigator system. It allows you to query vehicle inventory based on multiple criteria including branch location, vehicle condition, and availability status.
\nThis endpoint requires API key authentication. The API key must be provided in the request headers.
\nbranches (array of strings)Description: Array of branch IDs to filter the stock list
\nExample: [\"1\", \"2\", \"3\"]
Required: Yes
\nNotes: Specify which dealership branches to include in the search
\nstyle (string)Description: Display style format for the response
\nExample: \"WEB\"
Required: No
\nDefault Values: \"WEB\"
newUsed (string)Description: Filter vehicles by condition
\nExample: \"used\"
Required: No - defaults to \"all\"
\nAccepted Values: \"new\", \"used\", \"all\"
inStockOnly (boolean)Description: When true, returns only vehicles currently in stock
Example: true
Required: No
\nDefault: true
\nunsoldOnly (boolean)Description: When true, returns only vehicles that have not been sold
Example: true
Required: no
\nDefault: true
\nadvertisedOnly (boolean)Description: When true, returns only vehicles that are currently advertised
Example: true
Required: no
\nDefault: true
\nuninvoicedOnly (boolean)Description: When true, returns only vehicles that have not been invoiced
Example: true
Required: no
\nDefault: true
\nstockNo (string)Description : The stock number that is required to be downloaded. Only one is allowed and the stock no should be formatted as an integer without the branch no. If supplied, the only other parameter that is required is branches and only the single branch should be supplied.
\nExample: 1234
\nRequired: No
\nDefault: null
\nReturns an array of vehicle objects. Each vehicle object contains:
\nSTOCK: Stock number/ID
\nReg: Vehicle registration number
\nMake: Vehicle manufacturer (e.g., \"Mini\")
\nModel: Vehicle model name
\nDerivative: Specific variant/trim level
\nColour: Vehicle color
\nYear: Year of manufacture
\nMileage: Current mileage
\nEngine_Size: Engine displacement in cc
\nEngine_Type: Fuel type (e.g., \"Petrol\", \"Diesel\")
\nTransmission: Transmission type and number of gears
\nType: Vehicle type (\"New\" or \"Used\")
\nRetail: Retail price
\nWeb_Price: Online display price
\nGuide_Retail: Guide retail price
\nPrevious_Price: Previous listing price
\nAvailable_for_Sale: Availability flag (\"1\" = available, \"0\" = not available)
\nAdvertising_Notes: Additional advertising information
\nManager_Comments: Internal comments from management
\nOptions: Additional features and options
\nSpecification: Detailed vehicle specification
\nImage: Image availability indicator
\nImageList: List of available images
\nInsurance_Group: Insurance classification
\nTax_Band_2: Vehicle tax band
\nCommercial: Commercial vehicle flag (\"1\" = yes, \"0\" = no)
\nEx_Demo: Ex-demonstration vehicle flag
\nPre_Registered: Pre-registered vehicle flag
\nDealer_Approved: Dealer approval status
\nFranchise_Approved: Franchise approval status
\nHpi_Checked: HPI check status
\nCar_Data_Checked: Data verification status
\nFeatures_Upgraded: Upgraded features list
\nSpecial_Offer: Special offer details
\nOrigin: Vehicle origin information
\nDelivery_Cost_Incl: Delivery cost inclusion flag
\nReg_Fee_Included: Registration fee inclusion flag
\nTax_Included: Tax inclusion flag
\nSub_Heading: Additional heading text
\nQ: Qualifying indicator
\n[\n {\n \"STOCK\": \"5620.1\",\n \"Reg\": \"S111MWL\",\n \"Make\": \"Mini\",\n \"Model\": \"One\",\n \"Derivative\": \"\",\n \"Colour\": \"Orange Glow\",\n \"Year\": \"2012\",\n \"Mileage\": \"14000\",\n \"Engine_Size\": \"1598\",\n \"Engine_Type\": \"Petrol\",\n \"Transmission\": \"Manual 6 Gears\",\n \"Type\": \"Used\",\n \"Retail\": \"0.00\",\n \"Web_Price\": \"0.00\",\n \"Available_for_Sale\": \"1\",\n \"Specification\": \"1598 Petrol Manual 6 Gears 3 Door Hatch...\"\n }\n]\n\nAll filter parameters work in combination (AND logic)
\nEmpty arrays or false boolean values will broaden the search results
\nPrice values of \"0.00\" may indicate pricing is not yet set or is available on request
\nThis endpoint retrieves an image from the DMS Navigator system. It allows you to fetch stored images using an API key and filename identifier.
\nThe endpoint uses a path-based parameter structure in the format: /GetImage/{apikey},{imageType},{filename}
{{apikey}} (required): Your API authentication key for accessing the DMS Navigator Web Service. This key must be obtained from your DMS Navigator account and should be kept secure.
1 (required): This should always be a 1
{{filename}} (required): The name or identifier of the image file you want to retrieve. This should match the filename as stored in the DMS Navigator system.
This endpoint requires API key authentication. The API key must be:
\nIncluded as part of the URL path (first parameter)
\nValid and active in the DMS Navigator system
\nAssociated with appropriate permissions to access image resources
\nSuccess Response:
\nContent-Type: image/jpeg, image/png, or other image MIME types depending on the stored file
Body: Binary image data that can be directly displayed or saved
\nError Responses:
\n401 Unauthorized: Invalid or missing API key
\n404 Not Found: Image file does not exist or filename is incorrect
\n403 Forbidden: API key does not have permission to access the requested image
\nGET /GetImage/your-api-key-here,1,12345_0.jpg\n\nUse this to fetch a vehicle image stored in the system for display on a website or application.
\nThe filename of a vehicle image is always the integer part of the image and the image no - starting at 0. So for stockno 12345.1 the first image will be 12345_0.jpg, the second image will be 12345_1.jpg
\nIf downloading all the images for a vehicle. cycle through all the images in turn 0,1,2,3,4 until no image is returned.
\nGET /GetImage/your-api-key-here,1,part_image_abc123.jpg\n\nFetch product or parts images for inventory management or e-commerce displays.
\nStore your API key securely using environment variables
\nImplement proper error handling for missing or invalid images
\nCache images appropriately to reduce API calls
\nValidate filenames before making requests to avoid unnecessary API calls
\nEnsure the filename matches exactly as stored in the DMS Navigator system (case-sensitive)
\nThe image type parameter (currently set to 1) may need to be adjusted based on your specific implementation
Large images may take longer to retrieve depending on network conditions
\nThis endpoint updates vehicle information in the DMS Navigator system. It allows you to modify various attributes of a vehicle record including pricing, specifications, and marketing details.
\nThis endpoint requires API key authentication using the apikey variable, which should be included in the request headers or query parameters.
{\n \"success\": true\n}\n\nThe endpoint returns a simple JSON object with a success boolean field indicating whether the vehicle information was updated successfully.
All price fields should be provided as strings with decimal notation (e.g., \"10000.00\")
\nDate format must be DD/MM/YYYY
\nNumeric values for dimensions and specifications should be provided as intgers
\nThe StockNo field is critical as it identifies which vehicle record to update - this should include the branch no suffix ie 1234.1 NOT 1234
Ensure all required fields are populated to maintain data integrity in the system
\nThis endpoint generates comprehensive profit reports for vehicle sales across specified branches and date ranges. It returns detailed financial data for each vehicle transaction, including costs, profits, margins, and associated business information.
\n{\n \"branches\": [\"1\", \"2\"],\n \"dateFrom\": \"01/8/25\",\n \"dateTo\": \"31/8/25\"\n}\n\nThe endpoint returns an array of vehicle profit records. Each record contains the following fields:
\nSM - Sales Executive
\nMAKE - Vehicle manufacturer (e.g., TESLA, VAUXHALL, CITROEN)
\nMODEL - Vehicle model name
\nDERIV - Vehicle derivative/trim specification
\nChassis - Vehicle chassis/VIN number
\nReg_No - Vehicle registration number
\nReg_Date - Vehicle registration date
\nVehicle_Type - Type of vehicle (e.g., Car)
\nVehicle_Category - Category classification (e.g., Motorhome)
\nType - Sale type (New/Used)
\nBranch - Branch name where the sale occurred
\nBusiness_Manager - Name of the business manager
\nCustomer - Customer name
\nClose_Date - Date the sale was closed (DD/MM/YY format)
\nInvoice_No - Invoice number for the transaction
\nInvoice_Date - Date the invoice was issued
\nVEHICLE_RETAIL - Retail price of the vehicle
\nVEHICLES_COST - Cost of the vehicle
\nVEHICLE_Disc - Discount applied to the vehicle
\nVEHICLE_PROFIT - Profit from the vehicle sale
\nTOTAL_PROFIT - Total profit including all components
\nTOTAL_PROFIT_LESS_HOUSE_CHARGE - Total profit after house charges
\nFINANCE_COMMSN - Finance commission earned
\nBONUSES - Bonuses associated with the sale
\nWARR_SALE - Warranty sale amount
\nWARR_PROFIT - Warranty profit
\nD-OPT_SALE - Dealer options sale amount
\nD-OPTS_PROFIT - Dealer options profit
\nFitted_Dealer_Options_sale - Fitted dealer options sale amount
\nFitted_Dealer_Options_margin - Fitted dealer options margin
\nRFL_Profit - Road Fund License profit
\nPDI/PREP - Pre-delivery inspection/preparation costs
\nOTHER_COSTS - Other miscellaneous costs
\nWRITE_DOWN - Write-down amount
\nSTOCK - Stock number
\nDays_in_stock - Number of days the vehicle was in stock
\nDate_Expected_Into_Stock - Expected stock arrival date
\nQty - Quantity (negative values indicate sales)
\nPx - Part exchange indicator
\nP-EXCH_W/DOWN - Part exchange write-down amount
\nPurchased_By - Person who purchased the vehicle for stock
\nSupplier - Supplier information
\nSource - Source of the vehicle (e.g., UNKNOWN)
\nEnquiry_Source - Source of the customer enquiry
\nEnquiry_Sub_Source - Sub-source of the enquiry
\nEnquiry_Type - Type of enquiry
\n[\n {\n \"SM\": \"SIMON-HOME\",\n \"MAKE\": \"TESLA\",\n \"MODEL\": \"MODEL\",\n \"DERIV\": \"5 Door Hatchback X 90D\",\n \"Chassis\": \"1FA6P8LH5K8263561\",\n \"Category\": \"Retail\",\n \"Branch\": \"Dev B1\",\n \"TOTAL_PROFIT\": \"-58942.50\",\n \"VEHICLE_RETAIL\": \"-37500.00\",\n \"Customer\": \"Ronaldo\",\n \"Close_Date\": \"01/08/25\",\n ...\n }\n]\n\nGenerate profit reports for specific branches over a monthly period to analyze sales performance, identify top-performing vehicles, and assess profitability.
\nCompare profit metrics across multiple branches for the same time period to identify best practices and areas for improvement.
\nExtract comprehensive financial data for accounting periods, including all revenue streams (vehicle sales, finance commission, warranties, dealer options).
\nAnalyze days in stock, write-downs, and profit margins to optimize inventory management and pricing strategies.
\nReview individual sales manager performance based on total profits, customer satisfaction, and deal structures.
\nDates in the request body use DD/M/YY format (e.g., \"01/8/25\" for August 1, 2025)
Response dates may use DD/MM/YY format (e.g., \"01/08/25\")
Single-digit months do not require leading zeros in the request
\nNegative Qty/Px: Indicates a sale (outgoing stock)
\nNegative profit values: May indicate losses or adjustments
\nNegative costs: May indicate credits or reversals
\nBranch IDs are passed as strings in an array
\nEnsure branch IDs are valid for your organization
\nSome fields may be empty strings or \"0.00\" when not applicable
\nThe Source field may show \"UNKNOWN\" if the vehicle source wasn't tracked
Business Manager and Enquiry fields may be empty for some records
\nThis endpoint generates a comprehensive pipeline profit report for vehicles based on specified criteria. It provides detailed financial and operational data for vehicles in the sales pipeline, including profit margins, customer information, and vehicle details. The pipeline profit report is generally used for vehicles that have not yet been closed to indicate expected profit for the deal. The figures are therefore a blended mix of actual and estimated costs (actuals tend to be used if they exceed estimated)
\nThis endpoint requires API key authentication. The API key should be provided using the apikey variable, which is configured in the active environment.
The endpoint returns an array of vehicle records with the following fields:
\nStock - Stock number/ID of the vehicle
Chassis_No - Vehicle chassis number
Reg_No - Registration number
Make - Vehicle manufacturer (e.g., \"Audi\")
Model - Vehicle model (e.g., \"R8\")
Deriv - Vehicle derivative/trim level
Year - Model year
Type - Vehicle type (e.g., \"Car\")
New/Used - Indicates whether vehicle is new or used
Category - Sales category (e.g., \"Retail\")
Vehicle_Accounting_Category - Accounting classification
Actual_profit - Actual profit amount (decimal)
Expected_profit - Expected profit amount (decimal)
Vehicle_sale - Vehicle sale price (decimal)
Vehicle_margin - Profit margin on vehicle sale (decimal)
Accessory_sale - Total accessory sales amount (decimal)
Accessory_margin - Profit margin on accessories (decimal)
Fitted_Dealer_Options_sale - Sales amount for fitted dealer options (decimal)
Fitted_Dealer_Options_margin - Profit margin on dealer options (decimal)
Finance_margin - Profit from finance arrangements (decimal)
Warr_sale - Warranty sales amount (decimal)
Warr_margin - Profit margin on warranty (decimal)
Rfl_Margin - RFL (Road Fund License) margin (decimal)
Bonus - Any bonus amounts (decimal)
PDI/Prep - Pre-delivery inspection and preparation costs (decimal)
Other_Costs - Other associated costs (decimal)
Sundry_Costs - Miscellaneous costs (decimal)
Write_down - Any write-down amounts (decimal)
Px_Overall. - Part exchange overall value (decimal)
Customer - Customer name
Customer_Email - Customer email address
Customer_Number - Customer reference number
Post_Code - Customer postal code
Salesman - Assigned salesperson
Ordered - Order date
Date_In_Stock - Date vehicle entered stock
Delivery - Scheduled delivery date
Delivered - Actual delivery date (if delivered)
Invoiced - Invoice date (if invoiced)
Branch - Branch ID where the vehicle is located
Quantity - Quantity (typically \"1\" for vehicles)
Consigned - Consignment status
Finance - Finance Commision
Ext._warr - Extended Warranty Profit
Finance_Co - Finance company name
Px - No of Part exchanges
Supplier - Supplier code/reference
Vat_Qualifying - Boolean indicating if VAT qualifying
not_used - Reserved field (not currently used)
Scenario: A dealership manager wants to generate a profit report for all new vehicles ordered in August 2025 across branches 1 and 2, including only those that have been invoiced.
\nRequest:
\n{\n \"branches\": [\"1\", \"2\"],\n \"dateFrom\": \"01/08/25\",\n \"dateTo\": \"31/08/25\",\n \"invoicedOnly\": true,\n \"vehicleType\": \"new\",\n \"dateSelection\": \"OrderDate\"\n}\n\nUse Case: This report helps management:
\nTrack profitability across multiple branches
\nAnalyze profit margins on vehicle sales and add-ons (accessories, warranties, finance)
\nMonitor sales performance by salesperson
\nIdentify high-margin vs low-margin deals
\nReview the complete financial picture including all costs and revenue streams
\nMake data-driven decisions about pricing and inventory management
\nThe response is returned as a JSON array with HTTP status code 200 on success. Each object in the array represents one vehicle record with all associated financial and operational data.
\n","auth":{"type":"apikey","apikey":{"value":"{{apikey}}","key":"This endpoint creates a new workshop booking in the DMS Navigator system. It allows you to schedule service appointments by providing booking details, vehicle information, and customer data in a single API call.
\nThis endpoint requires API key authentication using the apikey variable, which should be passed as a query parameter or header (depending on your configuration).
bookDate (string, required): The date of the booking in DD/MM/YYYY format (e.g., \"10/01/2022\")
\nbookTime (string, required): The time of the booking in HH:MM:SS format (e.g., \"09:00:00\")
\nbranchId (integer, required): The ID of the branch where the booking will take place
\njobLines array containing an array of job objects:-
\njobCode : Optional: The Navigator Job Code job codes (e.g., 1) -
\njobDescription job descriptions corresponding to the job code (e.g., \"Service\")
\nextraWork (string, optional): Free text field for additional work requirements or notes
\nvrm (string, required): Vehicle Registration Mark (license plate number)
\nregNo (string, required): Registration number (typically same as VRM)
\nregDate (string, optional): Vehicle registration date in DD/MM/YYYY format
\nvehicleColour (string, optional): Color of the vehicle
\nvehicleMake (string, required): Vehicle manufacturer (e.g., \"Audi\")
\nvehicleModel (string, required): Vehicle model (e.g., \"Etron\")
\nvehicleDerivative (string, optional): Specific vehicle variant or trim level
\nvehicleDoorPlan (string, optional): Number of doors or body style
\nvehicleEngineType (string, optional): Type of engine (e.g., petrol, diesel, electric)
\nvehicleEngineNumber (string, optional): Engine identification number
\nVehicleEngineSize (string, optional): Engine capacity/displacement
\nvehicleTransmission (string, optional): Transmission type (e.g., manual, automatic)
\nvehicleChassis (string, optional): Chassis or VIN number
\nvehicleYearOfManufacture (string, optional): Year the vehicle was manufactured
\nvehicleModelYear (string, optional): Model year of the vehicle
\ncustomerTitle (string, required): Customer's title (e.g., \"Mr\", \"Mrs\", \"Ms\")
\ncustomerForename (string, required): Customer's first name
\ncustomerSurname (string, required): Customer's last name
\nbuildingName (string, optional): Building name in customer's address
\naddr1 (string, required): First line of customer's address
\naddr2 (string, optional): Second line of customer's address
\naddr3 (string, optional): Third line of customer's address (typically city/town)
\naddr4 (string, optional): Fourth line of customer's address
\npostCode (string, required): Customer's postal code
\ntelNumber (string, required): Customer's telephone number
\nemailAddr (string, required): Customer's email address
\nOn successful booking creation, the API returns:
\n{\n \"success\": true,\n \"jobNo\": \"11515\"\n}\n\nsuccess (boolean): Indicates whether the booking was created successfully
\njobNo (string): The unique job number assigned to the booking
\nA customer calls to book their Audi Etron for a service and MOT on January 10th, 2022 at 9:00 AM. The service advisor uses this endpoint to create the booking, providing the vehicle registration (FV71AFK), customer details (Simon Verona), and the required job types (Service and MOT with codes \"1\" and \"2\"). The system returns a job number (11515) which can be used to track and reference this booking throughout the workshop process.
\n","auth":{"type":"apikey","apikey":{"value":"{{apikey}}","key":"This endpoint retrieves detailed diary/job information for a workshop within a specified date range. It returns a list of all jobs scheduled or in progress, including customer details, vehicle information, timing data, and technician assignments.
\nThis endpoint requires API key authentication using the apikey variable, which should be included in the request headers or query parameters.
The request body accepts the following JSON parameters:
\n{\n \"branch\": \"1\",\n \"shift\": \"1\",\n \"dateFrom\": \"10/01/26\",\n \"dateTo\": \"30/01/26\"\n}\n\nThe endpoint returns an array of job objects with the following fields:
\n[\n {\n \"Job_No\": \"11518.1\",\n \"Customer\": \"Mr S Verona\",\n \"Collection\": false,\n \"Chassis_No\": \"WF0NXXGCHNKT88129\",\n \"Courtesy_Car\": false,\n \"Date_Created\": \"10/01/26\",\n \"Customer_Address\": \"1C THE HIGH STREET SOME VILLAGE ABERDEEN\",\n \"Customer_Address\": \"1D THE HIGH STREET 0 ABERDEEN AB10 1AA\",\n \"Customer_Email\": \"simonverona87@gmail.com\",\n \"Reg\": \"AF69AMY\",\n \"Operation\": \"Due for Service\",\n \"Mot\": false,\n \"Model\": \"FOCUS\",\n \"Vehicle\": \"FOCUS\",\n \"Time/Date_In\": \"09:00 12/01/26\",\n \"Time_In\": \"09:00\",\n \"Technician\": \"\",\n \"Time_Out\": \"17:00\",\n \"Time_on_Job_Today\": \"6.00\",\n \"Time/Date_Out\": \"17:00 12/01/26\",\n \"Total_Time_of_job\": \"6.00\",\n \"Type\": \"\",\n \"Waiting\": false\n }\n]\n\nScenario: A workshop manager wants to view all scheduled jobs for Branch 1, Shift 1, between January 10th and January 30th, 2026.
\nRequest:
\nPOST https://services.dmservices.co.uk/webhooks/workshop/diaryDetail\nContent-Type: application/json\nAuthorization: {{apikey}}\n{\n \"branch\": \"1\",\n \"shift\": \"1\",\n \"dateFrom\": \"10/01/26\",\n \"dateTo\": \"30/01/26\"\n}\n\nResult: The API returns a complete list of all jobs within that date range, allowing the manager to:
\nReview upcoming workload
\nAssign technicians to unassigned jobs
\nPlan resource allocation
\nIdentify jobs requiring courtesy cars or collections
\nTrack job progress and timing
\nThis endpoint retrieves workshop diary availability data for a specified branch. It returns detailed scheduling information including available time slots, booked jobs, and resource allocation across multiple days. This is typically used to check workshop capacity and plan service bookings.
\nbranch (required)Type: String
\nDescription: The branch identifier for which to retrieve diary availability
\nExample: \"1\"
Notes: This should correspond to a valid branch ID in your DMS system
\nThe endpoint returns an array of availability objects, with each object representing a single day/shift combination:
\nDay: Day of the week (e.g., \"MONDAY\", \"TUESDAY\")
Dates: Date in DD/MM/YY format (e.g., \"12/01/26\")
Shift: Shift number for the day (typically \"1\" for standard shift)
Available: Total available hours for the day/shift
Available_Time: Percentage of time available (0-100)
Tot_Hours: Total working hours for the day/shift
Jobs: Number of jobs scheduled
Services: Number of service jobs
Service_Hours: Hours allocated to service work
MOTs: Number of MOT tests scheduled
Repair: Hours allocated to repair work
Warranty_Hours: Hours allocated to warranty work
Retail_Hours: Hours allocated to retail/customer-facing work
Retail_%: Percentage of retail work (0-100)
Loan: Number of loan vehicles available/allocated
Diagnosis: Number of diagnostic jobs
Sub_Con: Subcontractor work Count
CD: Customer delivery/collection count
ID23: Unique identifier for the diary entry (format: day_id.branch.shift)
Colour: Visual indicator/status color (may be empty)
Notes: Additional notes or comments for the day
Booking System Integration: Check available capacity before allowing customers to book service appointments
\nWorkshop Planning: Review upcoming availability to optimize resource allocation
\nCapacity Reporting: Generate reports on workshop utilization and available hours
\nMulti-branch Comparison: Query multiple branches to find the location with earliest availability
\nLoad Balancing: Identify days with low utilization to promote special offers or move bookings
\n[\n {\n \"Colour\": \" \",\n \"Available\": \"10.00\",\n \"Jobs\": \"1\",\n \"Repair\": \"0.00\",\n \"Sub_Con\": \"0\",\n \"CD\": \"0\",\n \"Available_Time\": \"62\",\n \"Day\": \"MONDAY\",\n \"Dates\": \"12/01/26\",\n \"Shift\": \"1\",\n \"Loan\": \"16\",\n \"Diagnosis\": \"0\",\n \"ID23\": \"21197.1.1\",\n \"Services\": \"1\",\n \"Service_Hours\": \"6.00\",\n \"MOTs\": \"0\",\n \"Retail_Hours\": \"6.00\",\n \"Retail_%\": \"100\",\n \"Notes\": \"\",\n \"Tot_Hours\": \"16.00\",\n \"Warranty_Hours\": \"0.00\"\n }\n]\n\nAll hour values are returned as strings with decimal precision
\nPercentage values are whole numbers (0-100)
\nEmpty string values indicate no data for that field
\nThe response typically covers multiple days/weeks of availability (up to the next 90 days)
\nThis endpoint retrieves a comprehensive Work In Progress (WIP) report for workshop jobs. It returns detailed information about jobs across specified branches, including financial data, customer information, vehicle details, and job status. The report helps track outstanding work, invoicing status, and job progress across the workshop.
\nThis endpoint requires API key authentication using the apikey variable, which should be included in the request headers or query parameters.
branches (array of strings, required)An array of branch IDs to filter the report. Only jobs from the specified branches will be included in the response.
\nExample: [\"1\", \"2\"] - Returns jobs from branches 1 and 2
Type: Array of strings
\nincludeInvoiced (boolean, required)Controls whether fully invoiced jobs should be included in the report.
\ntrue - Includes all jobs, including those that have been fully invoiced
false - Excludes fully invoiced jobs, showing only active WIP
Type: Boolean
\nExample: false
The endpoint returns an array of job objects. Each job object contains the following fields:
\nJob_No (string) - Unique job number identifier
Branch (string) - Branch ID where the job is located
Appt_Date (string) - Appointment date in DD/MM/YY format
Date_wanted (string) - Customer's requested completion date in DD/MM/YY format
Days_over (string) - Number of days the job is overdue
Invoiced_Amount (decimal) - Total amount that has been invoiced
Wip_Invoiced (decimal) - Work in progress amount that has been invoiced
Parts (decimal) - Total parts cost
Sub_contract (decimal) - Subcontractor costs
Balance (decimal) - Outstanding balance of hours on the job
Time_spent (decimal) - Total hours spent on the job
Hrs_Invoiced (decimal) - Hours that have been invoiced
Warranty (decimal) - Warranty hours on job
Internal (decimal) - Internal hours on job
Retail (decimal) - Retail hours on the job
Customer_name (string) - Name of the customer
Reg_No (string) - Vehicle registration number
Make (string) - Vehicle manufacturer
Model (string) - Vehicle model
Invoiced (boolean) - Whether the job has been invoiced
Partial_Invoice (boolean) - Whether the job has been partially invoiced
Part_paid (boolean) - Whether the job has been partially paid
Warr (boolean) - Whether this is a warranty job
Sales (boolean) - Whether this is a sales-related job
Loan_car (boolean) - Whether a loan car has been provided
Job_status (string) - Current status of the job (e.g., \"WAITING RESTART\", \"INVOICED\")
Work_type (string) - Type of work being performed (e.g., \"Electrician\", \"TEST 1\")
Filter by specific branches and exclude invoiced jobs to see active work in progress:
\n{\n \"branches\": [\"1\"],\n \"includeInvoiced\": false\n}\n\nUse case: Workshop managers reviewing daily outstanding jobs that need attention.
\nInclude all jobs, even invoiced ones, for comprehensive reporting:
\n{\n \"branches\": [\"1\", \"2\"],\n \"includeInvoiced\": true\n}\n\nUse case: End-of-day or end-of-week reporting to track all job activity.
\nReview jobs with high Days_over values to identify delayed work and prioritize completion.
Use Balance, Invoiced_Amount, and Wip_Invoiced fields to reconcile outstanding payments and identify jobs requiring invoicing.
Analyze Time_spent vs Hrs_Invoiced to understand labor utilization and identify unbilled hours.
[\n {\n \"Job_No\": \"11130\",\n \"Branch\": \"1\",\n \"Appt_Date\": \"19/11/24\",\n \"Balance\": \"-18.67\",\n \"Customer_name\": \"John Smith\",\n \"Date_wanted\": \"19/11/24\",\n \"Internal\": \"0.00\",\n \"Days_over\": \"418\",\n \"Hrs_Invoiced\": \"26.68\",\n \"Invoiced\": false,\n \"Invoiced_Amount\": \"1194.88\",\n \"Warr\": false,\n \"Sales\": false,\n \"Reg_No\": \"X66KEL\",\n \"Job_status\": \"WAITING RESTART\",\n \"Loan_car\": false,\n \"Parts\": \"0.00\",\n \"Part_paid\": false,\n \"Make\": \"JEEP\",\n \"Model\": \"GRAND\",\n \"Partial_Invoice\": true,\n \"Retail\": \"8.00\",\n \"Time_spent\": \"26.67\",\n \"Sub_contract\": \"0.00\",\n \"Warranty\": \"0.00\",\n \"Work_type\": \"Electrician\",\n \"Wip_Invoiced\": \"178.48\"\n }\n]\n\nAll monetary values are returned as strings
\nDates are in DD/MM/YY format
\nBoolean flags help quickly identify job characteristics
\nNegative balance indicates overpayment or credit
\nEmpty strings may appear for optional fields like Customer_name when data is not available
This endpoint generates comprehensive invoice reports for specified branches within a given date range. It retrieves detailed financial and operational data for all invoices processed during the specified period, providing insights into sales, costs, profit margins, and job details.
\nbranches (Array of Strings, Required)An array of branch IDs to include in the report. Each branch ID should be provided as a string.
\nExample: [\"1\", \"2\"]
dateFrom (String, Required)The start date for the report period. Must be provided in DD/MM/YY format.
\nExample: \"01/12/25\" (December 1, 2025)
dateTo (String, Required)The end date for the report period. Must be provided in DD/MM/YY format.
\nExample: \"31/12/25\" (December 31, 2025)
The endpoint returns an array of invoice objects. Each invoice object contains the following fields:
\nInv_No. - Invoice number (unique identifier for the invoice)
Date - Invoice date in DD/MM/YY format
Branch - Branch ID where the invoice was generated
Invoice_type - Type of invoice (e.g., \"Service (Customer)\")
Partial - Boolean indicating if this is a partial invoice
Name - Customer name
Acc_Rpt - Account report code
Rpt - Report code
SL_Account - Sales ledger account
Type - Customer type (e.g., \"(1) RETAIL\")
Make - Vehicle manufacturer (e.g., \"Alfa Romeo\", \"Audi\", \"Mercedes-Benz\")
VRM - Vehicle Registration Mark (license plate)
Mileage - Vehicle mileage at time of service
Job_No - Job number reference
Job_count - Count of jobs (positive for invoices, negative for credits)
Hours - Labour hours charged
Time_Taken - Actual time taken to complete the job
Work_type - categorisation of work from job card
Technician - Technician assigned to the job (this is the first technician - not all technicians on the job)
Labour - Labour charges (can be negative for credit notes)
Labour_Cost - Cost of labour
Recovery - Labour recovery per hour
Parts - Parts sales amount (can be negative for credit notes)
Parts_Profit - Profit from parts sales
Paint/Sundries - Paint and sundries charges
Other_Body - Other body work charges
Oil_sales - Oil sales amount
Oil_profit - Profit from oil sales
Non_Labour - Non-labour charges
Sub_Con_Sale - Subcontractor sales amount
Sub_Con_Profit - Profit from subcontractor work
Discount - Discount applied to the invoice
Vat_Total - Total VAT amount
Total_Profit - Total profit for the invoice
Financial Reporting - Generate comprehensive financial reports for specific branches and time periods to analyze revenue, costs, and profitability
\nBranch Performance Analysis - Compare performance across multiple branches by analyzing invoice data
\nPeriod-over-Period Comparison - Track business performance by generating reports for different date ranges
\nProfit Margin Analysis - Evaluate profit margins on labour, parts, and overall jobs
\nCustomer Analysis - Analyze customer spending patterns and service history
\nVAT Reporting - Extract VAT information for tax compliance and reporting
\nAll dates must be provided in DD/MM/YY format
\nEnsure the dateFrom is earlier than or equal to dateTo
Branch IDs must be provided as strings, not numbers
\nMultiple branches can be queried in a single request
\nCredit notes are represented with negative values in financial fields
\nThe Job_count field will be negative for credit notes
The response is an array that may contain multiple records per job (e.g., original invoice and credit note pairs)
\nEmpty string values indicate data not applicable or not recorded for that field
\nFinancial values are in the currency configured for the system (no currency symbol included)
\nLarge date ranges or multiple branches may result in larger response payloads
\nConsider breaking down large queries into smaller date ranges for better performance - the maximum allowed date range is 180 days
\nThis endpoint allows you to delete one or more webhook subscriptions from your account. When you no longer need to receive notifications for specific events, use this endpoint to remove those subscriptions.
\nThe request accepts a JSON payload with the following structure:
\n{\n \"subscriptions\": [\"event.type1\", \"event.type2\"]\n}\n\nCommon subscription types include:
\nvehicle.update - Notifications when vehicle records are updated
customer.update - Notifications when customer records are updated
{\n \"success\": true\n}\n\nYou can delete multiple subscriptions in a single request by including multiple event types in the subscriptions array
The endpoint will process all subscriptions provided in the array
\nEnsure you have the necessary authentication (API key) configured in your request headers
\nOnce deleted, you will no longer receive webhook notifications for the specified event types
\nIf you need to re-subscribe to these events later, you'll need to use the subscription creation endpoint
\nThis endpoint triggers a phone popup/webhook event for an incoming or outgoing phone call. It is used to notify the DMS Navigator system of a call event, associating the call with a specific user, PC, and phone extension.
\nThe request body must be sent as raw JSON (application/json):
Example Request Body:
\n{\n \"extension\": \"123\",\n \"userId\": \"1\",\n \"pcName\": \"PCNAME\",\n \"phoneNo\": \"01234567890\"\n}\n\nPlease note that one of extension, userId or pcName is required.
\nThis causes the Navigator process logged in either by that user or pcName to pop up a customer lookup on screen. If Navigator is not logged in for that user on on that PC then no popup will occur and won't occur when they log in.
\nIf an extension is supplied, then this is looked up on the server to find which user or pc is associated with that extension (this is configured in Navigator at Interfaces > Navigator Phone > Cti Setup).
\nThis only works if Navigator is licenced for CTI integration
\n","auth":{"type":"apikey","apikey":{"value":"{{apikey}}","key":"