You are on page 1of 59

Data Warehouse Web Service Developer Guide

Table of Contents
Summary............................................................................................................................. 2
Service Description ............................................................................................................ 3
Data Types .......................................................................................................................... 4
Dealer – Dealer Information ............................................................................................... 5
Fields ................................................................................................................................ 5
Example URL .................................................................................................................... 5
Example XML Result ......................................................................................................... 6
License – Dealership Licensing Information........................................................................ 6
License List(GET) .............................................................................................................. 6
Example URL .................................................................................................................... 6
Example JSON Result ....................................................................................................... 7
Example XML Result ......................................................................................................... 7
License Edit (POST/DELETE)............................................................................................ 7
Example URLs .................................................................................................................. 8
Fields – Parts Inventory ..................................................................................................... 8
Example URL .................................................................................................................... 8
Example JSON Result ....................................................................................................... 9
Example XML Result ......................................................................................................... 9
Unit – Major Unit Inventory................................................................................................10
Fields - Unit ......................................................................................................................10
Fields – Unit.Parts.Part .....................................................................................................14
Fields – Unit.Options.Option .............................................................................................14
Fields – Unit.Labor............................................................................................................14
Example URL ...................................................................................................................15
Example JSON Result ......................................................................................................15
Example XML Result ........................................................................................................18
Deal – Sales Deals Summary ...........................................................................................24
Fields ...............................................................................................................................24
Example URL ...................................................................................................................25
Example JSON Result ......................................................................................................25
Example XML Result ........................................................................................................25
DealDetail – Sales Deals Detail.........................................................................................26
Example URL ...................................................................................................................26
Fields ...............................................................................................................................26
Example JSON Result ......................................................................................................29
Customer – Customer Information.....................................................................................35
Fields ...............................................................................................................................35
Example URL ...................................................................................................................35
Example JSON Result ......................................................................................................36
Example XML Result ........................................................................................................36
ServiceSum – Service Summary.......................................................................................37

 2019 CDK Global


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

Fields ...............................................................................................................................37
Example URL ...................................................................................................................37
Example JSON Result ......................................................................................................37
Example XML Result ........................................................................................................38
ServiceDet – Service Detail...............................................................................................38
Fields ...............................................................................................................................39
Example URL ...................................................................................................................40
Example JSON Result ......................................................................................................40
Example XML Result ........................................................................................................41
InvoiceSum – Invoicing Summary .....................................................................................43
Fields ...............................................................................................................................44
Example URL ...................................................................................................................44
Example JSON Result ......................................................................................................44
Example XML Result ........................................................................................................44
InvoiceDet – Invoicing Detail .............................................................................................44
Fields ...............................................................................................................................45
Example URL ...................................................................................................................45
Example JSON Result ......................................................................................................45
Example XML Result ........................................................................................................46
OpenDealDetail – Open Sales Deals Detail.......................................................................46
Notes: Because of the volatility of the open deal data set we suggest you treat the data as a
snapshot and consume it as a whole instead of looking for changes in IDs or dates. ..........46
Example URL ...................................................................................................................46
Fields ...............................................................................................................................46
Example JSON Result ......................................................................................................48
DeletedPart – (EVO-only) Parts deleted from Inventory .....................................................52
Example URL ...................................................................................................................52
InactivePart – (EVO-only) Parts inactivated from Inventory ................................................53
Example URL ...................................................................................................................53
AcctBalance – (EVO-only) Account Balances by Year .......................................................54
Example URL ...................................................................................................................54
OpenRepairOrderJob – (EVO-only) Open RO Jobs ...........................................................55
Example URL ...................................................................................................................55
OpenRepairOrderPart – (EVO-only) Open RO Parts .........................................................58
Example URL ...................................................................................................................58

Summary
This document describes the web service used to retrieve dealership data from the CDK Global
Lightspeed Data Warehouse Web Service (hereafter referred to as ‘Gateway’).

 2019 CDK Global Page 2


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

Service Description
Protocol
The Gateway web service uses a RESTful web service protocol. The Gateway communicates
exclusively using SSL over HTTP. All URLs should specify HTTPS. Almost all Gateway
methods described here that retrieve data should use the HTTP GET method. Exceptions to the
GET method are noted where applicable.
URL Handling

The base URL for all requests is int.LightspeedADP.com/lsapi. Most requests will take the form
of int.LightspeedADP.com/lsapi/DataType/CustomerNo.
Date Form ats

Any date passed on the url should be in ODBC format (yyyy-mm-dd). Dates delivered by the
web service are in the ODBC format yyyy-mm-ddThh:mm:ss.nn and either represent the time
zone on the dealer’s server or in the case of DateGathered, the time on the Gateway servers.
Authentication
The web service uses a Basic authentication scheme. Username and password will be assigned
when your account is setup. Basic authentication info must be included in every request. If it is
missing, the service will not respond with an authentication challenge the way an interactive
website would, it will simply return a 401 unauthorized error. For testing purposes you may use
user name ‘Sample’ with password ‘ L1ght$p33d$amP1e’.
Content Types

By default, the Gateway returns JSON. If you prefer to consume XML, you can set the content
type to text/xml and the Gateway will return XML.
Accept: text/xml
Exception Handling, Return Codes
All methods return a string. If the result is an exception on the server, the exception message is
returned.
Successful responses for GET methods will always include an HTTP 200 return code. Other
error codes typically returned will be 401 for authentication issues, 403 for authorization issues,
404 for resources that are not found, and 500 for other errors with accompanying error text.
Filtering Results / Query Parameters

Most of the datasets support filtering on many of the fields. This is implemented using the Open
Data Protocol (OData) spec. For complete documentation, see section 4. Query String
Options in the OData documentation on the OData spec site.
OData Features Supported
 Filter – Ability to filter results by specifying a 'where clause'.
 Top - Ability to limit maximum number of records returned. Note that there will be limits to
how large this value can be. (Todo: document top limits)
 Skip – Ability to return 'pages' of information by specifying top n rows while skipping the first m
rows so you can view a 'page' of the data.
 OrderBy – Ability to sort results.
 Logical Operators (And, Or, Not, Equal, etc)
OData Features Not Supported

 Select – Ability to specify which fields are returned.

 2019 CDK Global Page 3


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

 Expand – Ability to include or not include child records.


 InlineCount – Ability to return the total count of records matching a filter, even though a subset
of those records are returned via top and skip.
 Format – Specify media format (json or xml). Although we do not support this via a query
parameter, we already support it via the 'Accepts' header.
 Arithmetic operators (add, subtract, etc)
 Functions (StartsWith, EndsWith, SubString, etc)
OData Logical Operators

The following logical operators are valid in an OData Filter.


Operator Example
Or $filter=Price le 3.5 or Price gt
200
And $filter=Price le 200 and Price gt
3.5
Equal $filter=Address/City eq
‘Redmond’
NotEqual $filter=Address/City ne
‘London’
GreaterThan $filter=Price gt 20
GreaterThanOrEqual $filter=Price ge 10
LessThan $filter=Price lt 20
LessThanOrEqual $filter=Price le 100
Not $filter=not Price eq 20
Query Exam ples

Part/76024859?$top=3&$filter=PartNumber eq '10-106' and Avail gt 0


Part/76024859?$top=3&$filter=LastReceivedDate gt datetime'2014-01-01'
Part/76024859?$top=3&$filter=Retail gt 100.00m
Customer/76024859?$top=10&$filter=LastName eq 'simmons'
ServiceDet/76024859?$top=3&$filter=datein ge datetime'2014-01-28T00:00:00'
InvoiceSum/76024859?$top=3&$filter=Sales gt 600.00m
InvoiceDet/76024859?$top=3&$filter=price gt 600.00m&$orderby=InvoiceNo
ServiceSum/76024859?$top=3&$filter=WarrantyJob eq 0 and InternalJob eq 0
Deal/76024859?$top=3&$filter=FinanceDate eq datetime'2014-05-16T00:00:00'
Query Parameter Field Support
Most fields are supported for querying, but there are some that will not be supported – especially
if the data is coming directly from the dealer's system database rather than the data warehouse.
Notably under this DirectConnect circumstance, DateLastGathered may not be used in a query as
it is always set to the current time. DealerId or Cmf are never allowed in the query as they are
always specified in their own segment of the URL.

Data Types
Several different data types are supported by the web service. All data types are simply a string
and are case sensitive. The only data types currently described in this document are
Dealer Dealership Information
License Dealership Licensing Information

 2019 CDK Global Page 4


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

Part Parts Inventory


Unit Major Unit Inventory
Deal Sales Deal Summary
DealDetail Sales Deal Detail
Customer Customers
ServiceSum Service Summary
ServiceDet Service Detail
InvoiceSum Parts Invoicing Summary
InvoiceDet Parts Invoicing Detail
OpenDealDetail Open Sales Deal Detail
DeletedPart (EVO-only) Parts Deleted from Inventory

Dealer – Dealer Information


This data type does not require you to pass a dealer number. It returns a list of dealer numbers
that you are authorized to access.

Fields
Field Name Data Type Description, Example
Cmf varchar(20) CDK Global Dealer Identifier
DealershipName varchar(100) Dealership Name
DealerNumber varchar(50) Third Party Dealer Identifier
DirectConnect int Flag if dealer’s database is directly connected
to the web service, providing real-time data
for some datasets. 1 = True; 0 = False
DirectConnectDate date If populated = Date when the dealer began
using EVO, Else NULL

Example URL
https:// int.LightspeedADP.com/lsapi/Dealer
Example JSON Result
[
{
"Cmf": "76147580",
"DealershipName": "Sample Dealer",
"DealerNumber": "",
“DirectConnect”: “1”,
“DirectConnectDate”: “2010-01-02T00:00:00”
},
{
"Cmf": "76014682",
"DealershipName": "Lightspeed Powersports",
"DealerNumber": "",
“DirectConnect”: “1”,
“DirectConnectDate”: “2010-01-02T00:00:00”

 2019 CDK Global Page 5


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

Example XML Result


<ArrayOfDealer>
<Dealer>
<Cmf>76147580</Cmf>
<DealershipName>Sample Dealer</DealershipName>
<DealerNumber/>
<DirectConnect>1</DirectConnect>
<DirectConnectDate>2010-01-02T00:00:00</DirectConnectDate>
</Dealer>
<Dealer>
<Cmf>76014682</Cmf>
<DealershipName>Lightspeed Powersports</DealershipName>
<DealerNumber/>
<DirectConnect>1</DirectConnect>
<DirectConnectDate>2010-01-02T00:00:00</DirectConnectDate>

</Dealer>
</ArrayOfDealer>

License – Dealership Licensing Information


This data type supports multiple methods for those partners who are authorized to edit their own
dealer list.

License List(GET)
Using the http GET method, this method returns a list of licenses either from one dealer or one
license type. Note that the same method can be used to get a list of licenses for one dealer or a
list of dealers who are licensed for one product/service.
Fields
Field Name Data Type Description, Example
LicenseKey varchar(20) Key indicating license type
Cmf varchar(10) CDK Global Dealer Identifier
DealershipName varchar(50) Dealership Name
InstallDate DateTime Date license was issued

Example URL
https:// int.LightspeedADP.com/lsapi/License/Cmf/7601000
https:// int.LightspeedADP.com/lsapi/License/Key/Locator

 2019 CDK Global Page 6


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

Example JSON Result


[
{
"LicenseKey": "Locator",
"Cmf": "76147580",
"DealershipName": "Sample Dealer",
"InstallDate": "2010-01-02T00:00:00"
},
{
"LicenseKey": "Locator",
"Cmf": "76014682",
"DealershipName": "Lightspeed Powersports",
"InstallDate": "2010-01-02T00:00:00"
}
]

Example XML Result


<ArrayOfDealer>
<Dealer>
<LicenseKey>Locator</LicenseKey>
<Cmf>76147580</Cmf>
<DealershipName>Sample Dealer</DealershipName>
<InstallDate>2010-01-02T00:00:00</InstallDate>
</Dealer>
<Dealer>
<Cmf>76014682</Cmf>
<DealershipName>Lightspeed Powersports</DealershipName>
<InstallDate>2010-01-02T00:00:00</InstallDate>
</Dealer>
</ArrayOfDealer>

License Edit (POST/DELETE)


Using the http POST method allows an authorized partner to add a dealer to the list of dealers
authorized for your product/service.
Using the http DELETE method allows an authorized partner to remove a dealer from the list of
dealers authorized for your product/service.
There are no results for either of these methods. On success, they return an http 204 (No
Content). On errors other than authentication errors, the POST may return a 302 (Found) if the
dealer is already in the list and the DELETE may return a 404 (Not Found) if the dealer record
cannot be found.
Fields
Field Name Data Type Description, Example
LicenseKey varchar(20) Key indicating license type. Partners must be
licensed to view their own license keys.
Cmf varchar(10) CDK Global Dealer Identifier. Dealers are usually
familiar with this number and can provide it to
you as a Lightspeed partner.

 2019 CDK Global Page 7


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

Example URLs
https:// int.LightspeedADP.com/lsapi/License?LicenseKey=XXX&Cmf=76010000

Part – Parts Inventory

Fields – Parts Inventory


Field Name Data Type Description, Example
DealerId varchar(20) Internal Dealer Identifier
Cmf varchar(20) CDK Global Dealer Identifier
PartNumber varchar(25) Identifier of the item
SupplierCode varchar(3) Abbreviation of the maker – usually conforms to
price book source codes
DateGathered datetime Time that record was updated from dealer
Description varchar(30) Description of the part
OnHand Int Amount of the part in the store
Avail Int Amount of the part available to sell
OnOrder Int Amount of the part on order
OnOrderAvail Int Amount of the part on order that is sellable
LastSoldDate date Date when last sold – could be NULL or 1/1/1900
to denote no sales
LastReceivedDate date Date part was last received
LastAdjustmentDate date Date part was last adjusted
ReOrderMethod varchar(1) C = Sales Curve,
F = Force
M = Min/Max
N = Never Order (Force to 0)
F = Force to 1
MinimumQty int Lowest allowable quantity to have in stock
MaximumQty int Highest allowable quantity to have in stock
Cost money Part cost
CurrentActivePrice money Price that is currently active
Retail money Price that the part usually sells for - MSRP
OrderUnit varchar(3) Free form field – how is the part packaged
OrderUnitQty int How many come in that package?
LastCountDate date Date the part was last counted
SupersededTo varchar(25) Most current part number for this part
UPC varchar(30) UPC code of the part
Bin1 varchar(30) Free form field for part location
Bin2 varchar(30) Free form field for part location
Bin3 varchar(30) Free form field for part location
Category varchar(30) DMS assigned group for part

Example URL
https://int.LightspeedADP.com/lsapi/Part/76010000

Best Practice: We suggest you use DateGathered as your field to determine changes.

 2019 CDK Global Page 8


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

Example JSON Result


[
{
"Cmf":"76147580",
"DealerId":"3165",
"PartNumber":"00-1500",
"SupplierCode":"NW",
"DateGathered":"2012-05-18T04:00:39.313",
"Description":"ECLIPSE ARMS ADJ PITCH WH",
"OnHand":0,
"Avail":0,
"OnOrder":0,
"OnOrderAvail":0,
"LastSoldDate":"1900-01-01T00:00:00",
"LastReceivedDate":"1900-01-01T00:00:00",
"LastAdjustmentDate":"1900-01-01T00:00:00",
"ReOrderMethod":"C",
"MinimumQty":0,
"MaximumQty":0,
"Cost":857.7500,
"CurrentActivePrice":1159.4900,
"OrderUnit":"",
"OrderUnitQty":0,
"Retail":1159.4900,
"LastCountDate":"1900-01-01T00:00:00",
"SupersededTo":"00-1600",
"UPC":"123456789",
"Bin1":"NW",
"Bin2":"",
"Bin3":"",
“Category”: "ABC"
}
]

Example XML Result


<ArrayOfPart>
<Part>
<Cmf>76147580</Cmf>
<Avail>0</Avail>
<Cost>857.7500</Cost>
<CurrentActivePrice>1159.4900</CurrentActivePrice>
<DateGathered>2012-05-18T04:00:39.313</DateGathered>
<DealerId>3165</DealerId>
<Description>ECLIPSE ARMS ADJ PITCH WH</Description>
<LastAdjustmentDate>1900-01-01T00:00:00</LastAdjustmentDate>
<LastReceivedDate>1900-01-01T00:00:00</LastReceivedDate>
<LastSoldDate>1900-01-01T00:00:00</LastSoldDate>
<MaximumQty>0</MaximumQty>
<MinimumQty>0</MinimumQty>
<OnHand>0</OnHand>
<OnOrder>0</OnOrder>
<OnOrderAvail>0</OnOrderAvail>

 2019 CDK Global Page 9


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

<OrderUnit></OrderUnit>
<OrderUnitQty>0</OrderUnitQty>
<PartNumber>00-1500</PartNumber>
<ReOrderMethod>C</ReOrderMethod>
<Retail>1159.4900</Retail>
<SupplierCode>NW</SupplierCode>
<LastCountDate>1900-01-01T00:00:00</LastCountDate>
<SupersededTo>00-1600</SupersededTo>
<UPC>123456789</UPC>
<Bin1>NW</Bin1>
<Bin2></Bin2>
<Bin3></Bin3>
<Category>ABC</Category>
</Part>
</ArrayOfPart>

Unit and SoldUnit – Major Unit Inventory


Note: ‘Unit’ displays all current available units in the DMS. ‘SoldUnit’ displays previously sold
units that are no longer available to be sold. ‘SoldUnit’ is EVO only.

Fields - Unit
Field Name Data Type Description, Example
DealerId varchar(20) Internal Dealer Identifier
CMF varchar(20) CDK Global Dealer Id
MajorUnitHeaderId bigint
DateGathered datetime Time that record was updated from dealer
UnitStatus varchar(1) ACTIVE = ''

REQUESTED = 'R'

ORDERED = 'O'
StockNumber varchar(30) Internal working unit identifier
NewUsed varchar(1) Unit is new N or used U
ModelYear int Year of the unit – 4 characters – free form
Make varchar(30) Make of the unit – free form
Model varchar(30) Model of the unit – free form
VIN varchar(30) VIN of the unit – free form
Location varchar(30) Location of the unit – free form
Odometer varchar(30) Mileage of the unit – Mi of Km
Cylinders int Cylinder count of the unit
HP decimal Horsepower of the unit
BodyStyle varchar(30) Body style of the unit
Color varchar(30) Color of the unit
Condition varchar(30) Unit condition – free form
Class varchar(2) Dealer specified class code for this unit
CodeName varchar(30) Code name or popular identifier for this
unit
InvoiceDate datetime Date of invoice when the unit arrived at
dealership
InvoiceAmt money Cost of invoice when unit arrived at

 2019 CDK Global Page 10


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

dealership
TotalCost money InvoiceAmt + FreightCost + PartsCost
DSRP money Dealer Suggested Retail Price
MSRP money Manufacturer Suggested Retail Price
OnHold varchar(40) Deal Number or reason on hold – empty
string if not on hold
PackageID varchar(20) Internal Package Identifier
DateReceived datetime Date when the unit arrived at dealership
Length decimal Length of unit
Height decimal Height of unit
Width decimal Width of unit
Draft decimal Distance between waterline and bottom of
keel
Beam decimal Width at unit’s widest point
GVWR int Gross Vehicle Weight Rating
GDW Int Gross Domestic Weight
InteriorColor varchar(50) Inside color of unit
ExteriorColor varchar(50) Outside color of unit
Manufacturer varchar(50) Maker of the unit
UnitType varchar(50) Free form unit class
FloorLayout varchar(50) Free form layout ID
FreightCost money How much it cost to ship
FuelType varchar(50) Type of fuel unit takes
UnitName varchar(50) Free form description of unit
HullConstruction varchar(50) Free form type of hull
Comments varchar(100) Free form text field
WebUnit tinyint 1 – unit can be shown on website 0 – can’t
be shown
WebTitle varchar(250) Short description to be displayed on
website
WebDescription varchar(5000) Long description to be displayed on
website
WebPrice money Price of unit to be displayed on website
WebPriceHidden tinyint Flag to indicate dealer should be called for
price
Parts Container for an array of Part objects
Options Container for an array of Option objects
UserDefined1 varchar(50) Dealer configurable additional field on unit
UserDefined2 varchar(50) Dealer configurable additional field on unit
UserDefined3 varchar(50) Dealer configurable additional field on unit
UserDefined4 varchar(50) Dealer configurable additional field on unit
UserDefined5 varchar(50) Dealer configurable additional field on unit
UserDefined6 varchar(50) Dealer configurable additional field on unit
UserDefined7 varchar(50) Dealer configurable additional field on unit
UserDefined8 varchar(50) Dealer configurable additional field on unit
UserDefined9 varchar(50) Dealer configurable additional field on unit
UserDefined10 varchar(50) Dealer configurable additional field on unit
UserDefined11 money Dealer configurable additional field on unit
UserDefined12 money Dealer configurable additional field on unit
UserDefined13 money Dealer configurable additional field on unit

 2019 CDK Global Page 11


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

UserDefined14 money Dealer configurable additional field on unit


UserDefined15 money Dealer configurable additional field on unit
UserDefined16 int Dealer configurable additional field on unit
UserDefined17 int Dealer configurable additional field on unit
UserDefined18 int Dealer configurable additional field on unit
UserDefined19 int Dealer configurable additional field on unit
UserDefined20 int Dealer configurable additional field on unit
UserDefined1desc varchar(50) Description of Dealer configurable
additional field on unit
UserDefined2desc varchar(50) Description of Dealer configurable
additional field on unit
UserDefined3desc varchar(50) Description of Dealer configurable
additional field on unit
UserDefined4desc varchar(50) Description of Dealer configurable
additional field on unit
UserDefined5desc varchar(50) Description of Dealer configurable
additional field on unit
UserDefined6desc varchar(50) Description of Dealer configurable
additional field on unit
UserDefined7desc varchar(50) Description of Dealer configurable
additional field on unit
UserDefined8desc varchar(50) Description of Dealer configurable
additional field on unit
UserDefined9desc varchar(50) Description of Dealer configurable
additional field on unit
UserDefined10desc varchar(50) Description of Dealer configurable
additional field on unit
UserDefined11desc varchar(50) Description of Dealer configurable
additional field on unit
UserDefined12desc varchar(50) Description of Dealer configurable
additional field on unit
UserDefined13desc varchar(50) Description of Dealer configurable
additional field on unit
UserDefined14desc varchar(50) Description of Dealer configurable
additional field on unit
UserDefined15desc varchar(50) Description of Dealer configurable
additional field on unit
UserDefined16desc varchar(50) Description of Dealer configurable
additional field on unit
UserDefined17desc varchar(50) Description of Dealer configurable
additional field on unit
UserDefined18desc varchar(50) Description of Dealer configurable
additional field on unit
Titlestatus varchar(50) Status of unit title
Trimcolor varchar(50) Color of unit trim
Unitcondition varchar(50) Condition of unit
Carbcompliance varchar(50) Is the carburetor compliant – free form
Drivetype varchar(50) Type of drive on unit – free form
Enginecycles varchar(50) Number of cycles in engine
Powertype varchar(50) Type of power for engine
Starttype varchar(50) Type of start for unit

 2019 CDK Global Page 12


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

Numacunits int Number of AC units


Sleepcapacity int How many does the unit sleep
Barlength int Bar length
Bladelength int Blade length
Cuttingwidth int Cutting width
Videourl varchar(200) URL of video set in DMS
Numslideouts int Number of slideouts
Turningradius varchar(50) Turning radius
UserDefined19desc varchar(50) Description of Dealer configurable
additional field on unit
UserDefined20desc varchar(50) Description of Dealer configurable
additional field on unit
flooredby varchar(100) Who floored this unit
floorplan varchar(100) What plan does this flooring have
planstartingdate date Date of plan start
planendingdate date Date of plan end
originalamt money How much unit was floored for
originaldate date When the unit was floored
curtailmentamt money How much has been curtailed
curtailmentdate date When the unit was curtailed
flooredbalance money Amount left on unit flooring
Greywatertankcapacity int Grey water tank capacity (EVO Only)
Blackwatertankcapacity int Black water tank capacity (EVO Only)
Freshwatertankcapacity int Fresh water tank capacity (EVO Only)
Packamt money Amount for unit pack (EVO Only)
Holdbackamt money Amount on unit hold back (EVO Only)
Freight money Price of freight (EVO Only)
Ordernumber varchar Order number of unit (EVO Only)
Ordereta datetime ETA of unit order (EVO Only)
Estimatedsetupamt money Estimated unit setup amount (EVO Only)
partsprepamount money Price of parts prep (EVO Only)
Partsprepcost money Cost of parts prep (EVO Only)
Discountpercentagefromdsrp money (EVO Only)
Priceprotectionrebate money (EVO Only)
Manufacturertocustomerrebate money (EVO Only)
Manufacturertodealerrebate money (EVO Only)
Optionsamount money Price of options on unit (EVO Only)
Optionscost money Cost of options on unit (EVO Only)
Hitchtype varchar Type of hitch (EVO Only)
Axlenumber money (EVO Only)
Axlecapacity money (EVO Only)
Fueltype varchar (EVO Only)
Cylinders2 int Number of cylinders in second engine
(EVO Only)
Cylinders3 int Number of cylinders in third engine (EVO
Only)
Propulsion varchar Type of engine propulsion (EVO Only)
Hitchdryweight money (EVO Only)
Numberofwheels int (EVO Only)
Wheelsize varchar (EVO Only)

 2019 CDK Global Page 13


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

Fuelcapacity money (EVO Only)


Maxcarrycapacity money (EVO Only)
Engine1displacement varchar (EVO Only)
Engine2displacement varchar (EVO Only)
Engine3displacement varchar (EVO Only)
HP2 int (EVO Only)
HP3 int (EVO Only)
Marginprotectionamount money (EVO Only)

Fields – Unit.Parts.Part
Field Name Data Type Description, Example
DealerId varchar(20)
Description varchar(50) Description of part
SetupInstall varchar(1) S-Setup, I-Install, N-No Labor Attached
Qty int How many of the part was added
Cost decimal Dealer cost of the part after being sold from the
parts department
Price decimal Dealer price of the part

Fields – Unit.Options.Option
Field Name Data Type Description, Example
Description varchar(50) Option description

Fields – Unit.Labor
Field Name Data Type Description, Example
DealerId varchar(20)
MajorUnitHeaderId long ID of unit on the deal
MajorUnitLaborId long ID of labor work on the deal
Description varchar(50) Short description of the work
SetupInstall varchar(1) S-Setup, I-Install – what kind of work was done
Cost decimal Cost of the labor to dealership
Price decimal Price of the labor
Subletcost decimal Cost of the sublet labor
SubletPrice decimal Sold price of the sublet labor

Fields – Unit.Images (EVO only)


Field Name Data Type Description, Example
MajorUnitHeaderId long ID of unit on the deal (EVO Only)
ImageId long ID of the image (EVO Only)
PrimaryImage tinyint Denotes if the image is considered the main
image (EVO Only)
ImageUrl varchar(100) URL of image (EVO Only)

 2019 CDK Global Page 14


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

Example URL
https://int.LightspeedADP.com/lsapi/Unit/76024859

Best Practice: Unit is to be considered a snapshot and should always be consumed as a whole.
SoldUnit can be utilized to determine what happened to a unit if it falls out of Unit.

Example JSON Result


[

{
"TotalCost":2250.4200,
"Cmf":"76024859",
"DealerId":"I013",
"MajorUnitHeaderId":265,
"DateGathered":"2014-03-10T11:48:04.787",
"StockNumber":"11012013",
"NewUsed":"N",
"ModelYear":2013,
"Make":"HONDA",
"Model":"modelxyz",
"VIN":"vin1234567",
"Class":"M",
"CodeName":"modelnam",
"Location":"location",
"Odometer":"1001",
"Cylinders":95,
"HP":10.5000,
"BodyStyle":"body type",
"Color":"Blue",
"Condition":"1009",
"InvoiceDate":"2013-11-01T00:00:00",
"InvoiceAmt":1000.0100,
"FreightCost":100.0100,
"DSRP":2001.0000,
"MSRP":2010.0000,
"OnHold":"",
"PackageId":0,
"DateReceived":"2013-01-02T00:00:00",
"Length":0.0000,
"Height":0.0000,
"Width":0.0000,
"Draft":0.0000,
"Beam":0.0000,
"GVWR":0,
"GDW":0,
"InteriorColor":"",
"ExteriorColor":"",
"Manufacturer":"",
"UnitType":"body type",

 2019 CDK Global Page 15


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

"UserDefined1": "",
"UserDefined2": "",
"UserDefined3": "",
"UserDefined4": "",
"UserDefined5": "",
"UserDefined6": "",
"UserDefined7": "",
"UserDefined8": "",
"UserDefined9": "",
"UserDefined10": "",
"UserDefined11": "",
"UserDefined12": "",
"UserDefined13": "",
"UserDefined14": "",
"UserDefined15": "",
"UserDefined16": "",
"UserDefined17": "",
"UserDefined18": "",
"UserDefined19": "",
"UserDefined20": "",
"UserDefined1desc": "",
"UserDefined2desc": "",
"UserDefined3desc": "",
"UserDefined4desc": "",
"UserDefined5desc": "",
"UserDefined6desc": "",
"UserDefined7desc": "",
"UserDefined8desc": "",
"UserDefined9desc": "",
"UserDefined10desc": "",
"UserDefined11desc": "",
"UserDefined12desc": "",
"UserDefined13desc": "",
"UserDefined14desc": "",
"UserDefined15desc": "",
"UserDefined16desc": "",
"UserDefined17desc": "",
"UserDefined18desc": "",
"UserDefined19desc": "",
"UserDefined20desc": "",
“titlestatus”: “clean”,
“trimcolor”: “”,
“unitcondition” : “excellent”,
“carbcompliance” : “”;
“drivetype” : “”;
“enginecycles” : “”;
“powertype” : “”;
“starttype” : “”;
“numacunits” : “”;
“sleepcapacity” : “”;
“barlength” : “”;
“bladelength” : “”;

 2019 CDK Global Page 16


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

“cuttingwidth” : “”;
“videourl” : “”;
“numslideouts” : “”;
“turningradius” : “”;
"FloorLayout":"",
"FuelType":"",
"UnitName":"",
"HullConstruction":"",
"Comments":"these are the comments",
"UnitStatus":"",
"WebUnit":1,
"WebTitle":"2013 HONDA modelnam",
"WebDescription":"2013 HONDA modelnam (modelxyz)",
"WebPrice":2001.0000,
"WebPriceHidden":0,
“Greywatertankcapacity”:100,
“Blackwatertankcapacity”:100,
“Freshwatertankcapacity:100,
“Packamt”:200.00,
“Holdbackamt”:200.00,
“Freight”:100.00,
“Ordernumber”:”12345”,
“Ordereta”:”2013-01-02T00:00:00”,
“Estimatedsetupamt”:100.00,
“Partsprepamount”:50.00,
“Partsprepcost”:20.00,
“Discountpercentagefromdsrp”:5,
“Priceprotectionrebate”:0.00,
“Manufacturertocustomerrebate”:0.00,
“Manufacturertodealerrebate”:0.00,
“Optionsamount”:200.00,
“Optionscost”:120.00,
“Hitchtype”:”Ball”,
“Axlenumber”:2,
“Axlecapacity”:10000,
“Cylinders2”:6,
“Cylinders3:0,
“Propulsion”:””,
“Hitchdryweight”:1000,
“Numberofwheels”:4,
“Wheelsize”:””,
“Fuelcapacity”:50,
“Maxcarrycapacity”:2000,
“Engine1displacement”:””,
“Engine2displacement”:””,
“Engine3displacement”:””,
“HP2”:200,
“HP3”:0,
“Marginprotectionamount”:0.00,
"Parts":
[
{"Description":"Misc part"},

 2019 CDK Global Page 17


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

{"Description":"B1 15X42X13 BEA"},


{"Description":"CLAMP"},
{"Description":"Joes Jacket - Standard Black L"},
{"Description":"B1 17X35X10 BEA"},
{"Description":"C110 LG SIDE BAG"},
{"Description":"B1 15X42X13 BEA"},
{"Description":"B1 15X42X13 BEA"},
{"Description":"STUD"},
{"Description":"O-RING"},
{"Description":"FOG LAMP LG"},
{"Description":"CARB REPAIR KITS"},
{"Description":"FOG LAMP LG"},
{"Description":"B1 9X32X15 BEAR"}
],
"Options":
[
{"Description":"1100 SPORT PRO EXHAUST KIT","OptionType":"D"},
{"Description":"HIGH PERFORMANCE FUEL SYS", "Opt ionType":"D"}
],
"Labor":
[
{
“DealerId”:””,
“MajorUnitHeaderId”:”12345678”,
“MajorUnitLaborId”:”12345678”,
“Description”:”Description”,
“SetupInstall”:”S”,
“Cost”:”40.00”,
“Price”:”60:00”,
“SubletCost”:”0.00”,
“SubletPrice”:”0.00”
}
],
“Images”:
[
{
“MajorUnitHeaderId” : “123456”,
“ImageId” : “12345”,
“PrimaryImage : “1”,
“ImageUrl” : “https://host.image.com/?ID=12345567”
}
]

},
]

Example XML Result


<ArrayOfUnit>
<Unit>
<Cmf>76024859</Cmf>
<Beam>0.0000</Beam>

 2019 CDK Global Page 18


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

<BodyStyle></BodyStyle>
<Class>D</Class>
<CodeName></CodeName>
<Color>RED</Color>
<Comments></Comments>
<Condition></Condition>
<Cylinders>0</Cylinders>
<DSRP>3489.0000</DSRP>
<DateGathered>2014-03-10T11:48:04.327</DateGathered>
<DateReceived>2010-05-31T00:00:00</DateReceived>
<DealerId>I013</DealerId>
<Draft>0.0000</Draft>
<ExteriorColor></ExteriorColor>
<FloorLayout></FloorLayout>
<FreightCost>0.0000</FreightCost>
<FuelType></FuelType>
<GDW>0</GDW>
<GVWR>0</GVWR>
<HP>0.0000</HP>
<Height>0.0000</Height>
<HullConstruction></HullConstruction>
<InteriorColor></InteriorColor>
<InvoiceAmt>1187.0000</InvoiceAmt>
<InvoiceDate>2010-05-31T00:00:00</InvoiceDate>
<Length>0.0000</Length>
<Location></Location>
<MSRP>3649.0000</MSRP>
<MajorUnitHeaderId>70</MajorUnitHeaderId>
<Make>HONDA</Make>
<Manufacturer></Manufacturer>
<Model>CRF230F8</Model>
<ModelYear>2009</ModelYear>
<NewUsed>N</NewUsed>
<Odometer></Odometer>
<OnHold>Deal: 57</OnHold>
<Options />
<PackageId>0</PackageId>
<Parts>
<Part><Description>Joes Jacket - Standard Black L
</Description></Part>
<Part><Description>CARB REPAIR
KITS</Description></Part>
<Part><Description>BEARING AY</Description></Part>
<SetupInstall>N</SetupInstall>
<Qty>1</Qty>
<Cost>50</Cost>

 2019 CDK Global Page 19


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

<Price>50</Price>
</Part>
</Parts>
<StockNumber>H001910</StockNumber>
<TotalCost>1728.6500</TotalCost>
<UnitName></UnitName>
<UnitStatus></UnitStatus>
<UnitType></UnitType>
<VIN>9C2ME090X8R001910</VIN>
<WebDescription>2009 HONDA CRF230F8</WebDescription>
<WebPrice>3489.0000</WebPrice>
<WebPriceHidden>0</WebPriceHidden>
<WebTitle>2009 HONDA CRF230F8</WebTitle>
<WebUnit>0</WebUnit>
<Width>0.0000</Width>
</Unit>
<Unit>
<Cmf>76024859</Cmf>
<Beam>0.0000</Beam>
<BodyStyle>body type</BodyStyle>
<Class>M</Class>
<CodeName>modelnam</CodeName>
<Color>Blue</Color>
<Comments>these are the comments</Comments>
<Condition>1009</Condition>
<Cylinders>95</Cylinders>
<DSRP>2001.0000</DSRP>
<DateGathered>2014-03-10T11:48:04.787</DateGathered>
<DateReceived>2013-01-02T00:00:00</DateReceived>
<DealerId>I013</DealerId>
<Draft>0.0000</Draft>
<ExteriorColor></ExteriorColor>
<FloorLayout></FloorLayout>
<FreightCost>100.0100</FreightCost>
<FuelType></FuelType>
<GDW>0</GDW>
<GVWR>0</GVWR>
<HP>10.5000</HP>
<Height>0.0000</Height>
<HullConstruction></HullConstruction>
<InteriorColor></InteriorColor>
<InvoiceAmt>1000.0100</InvoiceAmt>
<InvoiceDate>2013-11-01T00:00:00</InvoiceDate>
<Length>0.0000</Length>
<Location>location</Location>
<MSRP>2010.0000</MSRP>

 2019 CDK Global Page 20


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

<MajorUnitHeaderId>265</MajorUnitHeaderId>
<Make>HONDA</Make>
<Manufacturer></Manufacturer>
<Model>modelxyz</Model>
<ModelYear>2013</ModelYear>
<NewUsed>N</NewUsed>
<Odometer>1001</Odometer>
<OnHold></OnHold>
<Options>
<Option><Description>1100 SPORT PRO EXHAUST KIT
</Description><OptionType>D</OptionType></Option>
<Option><Description>HIGH PERFORMANCE FUEL SYS
</Description><OptionType>D</OptionType></Option>
</Options>
<PackageId>0</PackageId>
<Parts>
<Part><Description>Misc part</Description></Part>
<Part><Description>B1 15X42X13
BEA</Description></Part>
<Part><Description>CLAMP</Description></Part>
<Part><Description>Joes Jacket - Standard Black L
</Description></Part>
<Part><Description>B1 17X35X10
BEA</Description></Part>
<Part><Description>C110 LG SIDE
BAG</Description></Part>
<Part><Description>B1 15X42X13
BEA</Description></Part>
<Part><Description>B1 15X42X13
BEA</Description></Part>
<Part><Description>STUD</Description></Part>
<Part><Description>O-RING</Description></Part>
<Part><Description>FOG LAMP LG</Description></Part>
<Part><Description>CARB REPAIR
KITS</Description></Part>
<Part><Description>FOG LAMP LG</Description></Part>
<Part><Description>B1 9X32X15
BEAR</Description></Part>
</Parts>
<Labor>
<MajorUnitHeaderId>12345678</MajorUnitHeaderId>
<MajorUnitLaborId>12345678</MajorUnitLaborId>
<Description>This is Labor</Description>
<SetupInstall>S</SetupInstall>
<Cost>40.00</Cost>
<Price>60.00</Price>
 2019 CDK Global Page 21
Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

<SubletCost>0.00</SubletCost>
<SubletPrice>0.00</SubletPrice>
</Labor>
<Images>
<MajorUnitHeaderId>12345678</MajorUnitHeaderId>
<ImageId>12345678</ ImageId >
<PrimaryImage>1</PrimaryImage>
<ImageUrl>https://host.image.com/?ID=12345</ImageUrl>
</Images>
<StockNumber>11012013</StockNumber>
<TotalCost>2250.4200</TotalCost>
<UnitName></UnitName>
<UnitStatus></UnitStatus>
<UnitType>body type</UnitType>
<UserDefined1></UserDefined1>
<UserDefined2></UserDefined2>
<UserDefined3></UserDefined3>
<UserDefined4></UserDefined4>
<UserDefined5></UserDefined5>
<UserDefined6></UserDefined6>
<UserDefined7></UserDefined7>
<UserDefined8></UserDefined8>
<UserDefined9></UserDefined9>
<UserDefined10></UserDefined10>
<UserDefined11></UserDefined11>
<UserDefined12></UserDefined12>
<UserDefined13></UserDefined13>
<UserDefined14></UserDefined14>
<UserDefined15></UserDefined15>
<UserDefined16></UserDefined16>
<UserDefined17></UserDefined17>
<UserDefined18></UserDefined18>
<UserDefined19></UserDefined19>
<UserDefined20></UserDefined20>
<UserDefined1desc></UserDefined1desc>
<UserDefined2desc></UserDefined2desc>
<UserDefined3desc></UserDefined3desc>
<UserDefined4desc></UserDefined4desc>
<UserDefined5desc></UserDefined5desc>
<UserDefined6desc></UserDefined6desc>
<UserDefined7desc></UserDefined7desc>
<UserDefined8desc></UserDefined8desc>
<UserDefined9desc></UserDefined9desc>
<UserDefined10desc></UserDefined10desc>
<UserDefined11desc></UserDefined11desc>
<UserDefined12desc></UserDefined12desc>
 2019 CDK Global Page 22
Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

<UserDefined13desc></UserDefined13desc>
<UserDefined14desc></UserDefined14desc>
<UserDefined15desc></UserDefined15desc>
<UserDefined16desc></UserDefined16desc>
<UserDefined17desc></UserDefined17desc>
<UserDefined18desc></UserDefined18desc>
<UserDefined19desc></UserDefined19desc>
<UserDefined20desc></UserDefined20desc>
<titlestatus>Clean</titlestatus>
<trimcolor></trimcolor>
<unitcondition></unitcondition>
<carbcompliance></carbcompliance>
<drivetype></drivetype>
<enginecycles></enginecycles>
<powertype></powertype>
<starttype></starttype>
<numacunits></numacunits>
<sleepcapacity></sleepcapacity>
<barlength></barlength>
<bladelength></bladelength>
<cuttingwidth></cuttingwidth>
<videourl></videourl>
<numslideouts></numslideouts>
<turningradius></turningradius>
<VIN>vin1234567</VIN>
<WebDescription>2013 HONDA modelnam
(modelxyz)</WebDescription>
<WebPrice>2001.0000</WebPrice>
<WebPriceHidden>0</WebPriceHidden>
<WebTitle>2013 HONDA modelnam</WebTitle>
<WebUnit>1</WebUnit>
<Width>0.0000</Width>
<Greywatertankcapacity>100</Greywatertankcapacity>
<Blackwatertankcapacity>100</Blackwatertankcapacity>
<Freshwatertankcapacity>100</Freshwatertankcapacity>
<Packamt>100</Packamt>
<Holdbackamt>100</Holdbackamt>
<Freight>100</Freight>
<Ordernumber>12345</Ordernumber>
<Ordereta>2010-05-31T00:00:00</Ordereta>
<Estimatedsetupamt>100</Estimatedsetupamt>
<Partsprepamt>100</Partsprepamt>
<Partsprepcost>50</Partsprepcost>
<Discountperecentagefromdsrp>0</Discountpercentagefromdsrp>
<Priceprotectionrebate>0</Priceprotectionrebate>

 2019 CDK Global Page 23


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

<Manufacturertocustomerrebate>0</Manufacturertocustomerrebate>
<Manufacturertodealerrebate>0</Manufacturertodealerrebate>
<Optionsamt>0</Optionsamt>
<Optionscost>0</Optionscost>
<Hitchtype>Ball</Hitchtype>
<Axlenumber>2</Axlenumber>
<Axlecapacity>1000</Axlecapacity>
<Cylinders2>6</Cylinders2>
<Cylinders3>0</Cylinders3>
<Propulsion>Jet</Propulsion>
<Hitchdryweight>0</Hitchdryweight>
<Numberofwheels>4</Numberofwheels>
<Wheelsize></Wheelsize>
<Fuelcapacity>100</Fuelcapacity>
<Maxcarrycapacity>100</Maxcarrycapacity>
<Engine1displacement>100</Engine1displacement>
<Engine2displacement>100</Engine2displacement>
<Engine3displacement/>
<HP2>100</HP2>
<HP3/>
<Marginprotectionamount>0.00</Marginprotectionamount>
</Unit>
</ArrayOfUnit>

Deal – Sales Deals Summary

Fields
Field Name Data Type Description, Example
DealerId varchar(20) Internal Dealer Identifier
Cmf varchar(20) CDK Global Dealer Identifier
DealNo varchar(20) Deal (Worksheet) Number
DeliveryDate datetime Date unit was delivered to customer
FinanceDate datetime Date deal was finalized
FinInvoiceId int Internal ID – increments after refinalization
OriginatingDate datetime Date deal was initially made
TotalPartsAmount money Sum of all parts on deal
Class Varchar(2) Dealer specific class of unit
DealUnitId int Unit identifier on the deal
Make Varchar(20) Maker of the unit
Model Varchar(20) Model of the unit
Year Varchar(4) Model year of the unit
Newused varchar(1) N = new

U = used
UnitPrice money Price of the unit
UnitSoldPrice money Unitprice + freight + handling – tradeall +

 2019 CDK Global Page 24


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

tradeacv + totaccy + totinstall


VIN Varchar(25) VIN of the unit
Custid varchar(12) DMS identifier of the main customer on the deal

Example URL
https://int.LightspeedADP.com/lsapi/Deal/76010000

Best Practice: Use FinanceDate or FinInvoiceId to determine changes

Example JSON Result


[
{"Cmf":"76014540",
"DealerId":"3531",
"DealNo":"1012198",
"FinInvoiceId":10448470,
"FinanceDate":"2013-08-23T00:00:00",
"OriginatingDate":"2013-06-25T00:00:00",
"DeliveryDate":"2013-06-25T00:00:00",
“custid” : “1”,
"Units":
[
{"DealUnitId":5161499,
"Newused":"N",
"Year":"2013",
"Make":"HONDA",
"Model":"CRF450RD",
"VIN":"JH2PE0539DK203540",
"Class":"G",
"Unitprice":6653.0000,
"UnitSoldPrice":6653.0000,
"TotalPartsAmount":0.0}
]
}
]

Example XML Result


<ArrayOfDeal xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Deal>
<Cmf>76014540</Cmf>
<DealNo>1012198</DealNo>
<DealerId>3531</DealerId>
<DeliveryDate>2013-06-25T00:00:00</DeliveryDate>
<FinInvoiceId>10448470</FinInvoiceId>
<FinanceDate>2013-08-23T00:00:00</FinanceDate>
<OriginatingDate>2013-06-25T00:00:00</OriginatingDate>
<custid>1</custid>
<Units>
 2019 CDK Global Page 25
Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

<Unit>
<Class>G</Class>
<DealUnitId>5161499</DealUnitId>
<Make>HONDA</Make>
<Model>CRF450RD</Model>
<Newused>N</Newused>
<TotalPartsAmount>0</TotalPartsAmount>
<UnitSoldPrice>6653.0000</UnitSoldPrice>
<Unitprice>6653.0000</Unitprice>
<VIN>JH2PE0539DK203540</VIN>
<Year>2013</Year>
</Unit>
</Units>
</Deal>

DealDetail – Sales Deals Detail

Example URL
https://int.LightspeedADP.com/lsapi/DealDetail/76010000

Fields
Field Name Data Type Description, Example
DealerId varchar(20) Internal Dealer Identifier
Cmf varchar(20) CDK Global Dealer Identifier
Dealno varchar(20) DMS assigned number of the deal
FinInvoiceID int DMS assigned ID of the deal
FinanceDate date Date deal was finalized
OriginatingDate date Date deal was created
DeliveryDate date Internal ID – increments after refinalization
Salesmanid varchar(15) ID of the salesman
Clpremium money Sum of all parts on deal
Clcost money Dealer specific class of unit
Ahpremium money Price of AH
Ahcost money Cost of AH
CustID varchar(12) DMS identifier of the customer
Lienholder varchar(90) Name of lienholder
DealUnitID long Deal ID of the unit
Newused varchar(2) New or Used
Year varchar(4) Unit model year
Make varchar(20) Maker of the unit
Model varchar(20) Model of the unit
VIN varchar(25) VIN of the unit
Class varchar(2) Dealer assigned unit class
Unitprice money Price of the unit
Mucost money Calculated cost of the unit
Freight money Price of freight

 2019 CDK Global Page 26


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

Freightcost money Cost of freight


Handling money Price of handling
Handlingcost money Cost of handling
Licfees money Price of license fees
LicFeesCost money Cost of license fees
Totaccy money Sum price of accessories on the deal
Accycost money Sum cost of accessories on the deal
Totinstall money Sum price of labor on the deal
Installcost money Sum cost of labor on the deal
Tradeall money Trade allowance amount (unit level rollup)
Tradeacv money Trade ACV (unit level rollup)
DateReceived date Date unit was received
Servcont money Price of service contract
Sccost money Cost of service contrace
Probliab money Price of P&L
Plcost money Cost of P&L
SalesType varchar(1) R=Retail, W=Wholesale
UnitSoldPrice money Unitprice+freight+handling-
Tradeall+Traceacv+Totaccy+totinstall
UnitSoldCost money Mucost + freightcost +handlingcost + accycost
+installcost
TotalPartsAmount money Sum(qty*price)
DaysInStore int (CurrentTime) – DateReceived displayed in
days
UnitLine1 money Amount from user configurable field
UnitLine2 money Amount from user configurable field
UnitLine3 money Amount from user configurable field
UnitLine4 money Amount from user configurable field
UnitLine5 money Amount from user configurable field
UnitLine6 money Amount from user configurable field
UnitLine7 money Amount from user configurable field
UnitLine8 money Amount from user configurable field
UnitLine9 money Amount from user configurable field
UnitLine10 money Amount from user configurable field
UnitLine12 money Amount from user configurable field
PartNumber varchar(20) Part identifier
Suppliercode varchar(3) Maker of part
Qty int Amount sold of part
Cost money Cost of part on the deal after being sold from
the parts department
Price money Price of the part on the deal
Retail money Standard price of the part
SetupInstall varchar(1) S – setup, I - Installed
VIN varchar Trade VIN
StdMake varchar Trade Standardized Make
StdModel varchar Trade Standardized Model
StdYear varchar Trade Standardized Year
StdCategory varchar Trade Standardized Category
Allowance money Trade allowance
ACV money Trade ACV (actual cash value)

 2019 CDK Global Page 27


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

Payoff money Amount required for dealer to payoff current


loan on trade
AmtFinanced money Amount of the deal that was financed
Term int Length in months of financing
Rate money Rate of financing
Payment money Monthly payments of financing
Downpayment money Amount put down on the unit
SalesmanName varchar Name of the salesman on the deal
Odometer varchar Mileage of the unit at time of deal
Color varchar Color of the unit
DaysToFirst int How many days until the first payment is due
Description varchar Part description in ‘Parts’ child element
Stocknumber varchar In store identifier of the unit
Deposit money How much money was put down on the deal
lienaddressfirstline varchar Address of lien holder
lienaddresssecondline varchar Additional address of lien holder
liencity varchar City of lien holder
lienzip varchar Zipcode of lien holder
lienstate varchar State/Province of lien holder
cobuyercustid varchar In store identifier of co-buyer
cobuyername varchar Name of co-buyer
cobuyeraddr varchar Address of co-buyer
cobuyeraddr2 varchar Additional address of co-buyer
cobuyercity varchar City of co-buyer
cobuyerstate varchar State of co-buyer
cobuyerzip varchar Zipcode of co-buyer
cobuyercounty varchar County of co-buyer
cobuyerhomephone varchar Home phone of co-buyer
cobuyerworkphone varchar Work phone of co-buyer
cobuyercellphone varchar Cell phone of co-buyer
cobuyeremail varchar Email of co-buyer
cobuyerbirthdate varchar Birthdate of co-buyer
bodytype varchar Body type of unit
enginenumber varchar Engine number of unit
cylinders varchar Cylinder count of unit engine
gvwr varchar Gross vehicle weight rating
fueltype varchar Type of fuel used by unit engine
actualcost money Raw unit cost
docfees money Fee for documentation
fincharge money Price for financing
fincost money Cost for financing
linename varchar Extra line description (EVO Only)
extralinenumber varchar Number of extra line in deal (EVO Only)
linetype varchar Specifies front end FE or back end BE (EVO
Only)
amount money Amount on the extra line (EVO Only)
cost money Cost of the extra line (EVO Only)
term int Term of the extra line (EVO Only)
Packamt money Pack Amount (EVO Only)
Holdbackamt money Hold Back Amount (EVO Only)

 2019 CDK Global Page 28


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

Salesman2name varchar Name of second salesman (EVO Only)


Salesman2id varchar ID of second salesman (EVO Only)
Salesmanfi1id varchar ID of first FI salesman (EVO Only)
Salesmanfi1name varchar Name of first FI salesman (EVO Only)
Salesmanfi2id varchar ID of second FI salesman (EVO Only)
Salesmanfi2name varchar Name of second FI salesman (EVO Only)
Fincostoverride money Finance Cost Override (EVO Only)

Notes: Use FinanceDate or FinInvoiceId to determine changes

Example JSON Result


[
{
"Cmf":"76010000",
"DealerId":"0001",
"DealNo":"1011499",
"FinInvoiceId":10816444,
"FinanceDate":"2013-09-24T00:00:00",
"OriginatingDate":"2013-09-23T00:00:00",
"DeliveryDate":"2013-09-23T00:00:00",
"salesmanid":"LH",
"clpremium":0.0000,
"clcost":0.0000,
"ahpremium":0.0000,
"ahcost":0.0000,
“fincharge”:0.0000,
“fincost”:0.0000,
"CustID":"10799428",
"lienholder":"NONE",
"SalesmanName":"Joe King",
"AmtFinanced":0,
"Term":120,
"Rate":5.999,
"DaysToFirst":30,
"Payment":0,
“lienaddressfirstline”:”1234 Any Street”,
“lienaddresssecondline”:”Ste 123”,
“liencity”:”NYC”,
“lienzip”:”12345”,
“lienstate”:”NY”,
“cobuyerid”:”123”,
“cobuyername”:”Rick James”,
“cobuyeraddr”:”123 Any Street”,
“cobuyeraddr2”:””,

 2019 CDK Global Page 29


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

“cobuyercity”:”NYC”,
“cobuyerstate”:”NY”,
“cobuyerzip”:”12345”,
“cobuyercounty”:”New York”,
“cobuyerhomephone”:”5555555555”,
“cobuyerworkphone”:”5555555555”,
“cobuyercellphone”:”5555555555”,
“cobuyeremail”:”test@test.com”,
“cobuyerbirthdate”:” 2013-09-24T00:00:00”,
“cobuyerage”:”40”,
“salesman2name”:””,
“salesman2id”:””,
“salesmanfi1id”:””,
“salesmanfi1name”:””,
“salesmanfi2id”:””,
“salesmanfi2name”:””,
“fincostoverride”:”0”
"Units":[{
"DealerId": "",
"DealUnitId":10799439,
"Newused":"N",
"Year":"2013",
"Make":"KAWASAKI",
"Model":"JT1500JDF",
"VIN":"US-KAW40474K213",
"Class":"W",
"Unitprice":13965.5200,
"mucost":13524.0000,
“actualcost”:13000.0000,
"Freight":348.0000,
"Freightcost":0.0000,
"Handling":399.4700,
"Handlingcost":291.9000,
"LicFees":21.0000,
"LicFeesCost":21.0000,
“docfees”:0.0000,
"Totaccy":0.0000,
"Totinstall":0.0000,
"Tradeall":500.0000,
"Tradeacv":100.0000,
"DateReceived":"2013-02-07T00:00:00",
"servcont":0.0000,
"sccost":0.0000,
"propliab":0.0000,
"plcost":0.0000,
"SalesType":"W",

 2019 CDK Global Page 30


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

"UnitSoldPrice":14312.9900,
"TotalPartsAmount":0.0000,
"DaysInStore":272,
"Odometer":1000,
"Color":"Black",
"UnitLine1":0.0000,
"UnitLine2":1.5000,
"UnitLine3":294.0000,
"UnitLine4":0.0000,
"UnitLine5":0.0000,
"UnitLine6":0.0000,
"UnitLine7":0.0000,
"UnitLine8":0.0000,
"UnitLine9":0.0000,
"UnitLine10":0.0000,
"UnitLine11":0.0000,
"UnitLine12":0.0000,
“stocknumber”:”ABC123”,
“deposit”:100.00,
“bodytype”:””,
“enginenumber”:”12345”,
“cylinders”:”4”,
“gvwr”:”1500”,
“fueltype”:”gas”,
“packamt”:”100.00”,
“holdbackamt”:”100:00”,
“unittype”:”Motorcycle"
"Parts":[{
"DealerId": "",
"PartNumber":"GAS",
"SupplierCode":"AC",
"Qty":10,
"Cost":4.3500,
"Price":0.0000,
"Retail":4.3500,
"SetupInstall":"S",
“Description”:”Fuel”
}]
}],
"Trade":[{
"DealerId": "",
"VIN":"KAW45752B494",
"StdMake":"NA",
"StdModel":"NA",
"StdYear":"NA",
"StdCategory":"NA"

 2019 CDK Global Page 31


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

}],
“DealExtraLines”:[{
“linename”:”Misc”,
“extralinenumber”:1,
“linetype”:”BE2”,
“amount”:200.0000,
“cost”:100.0000,
“term”:36

}]
}
]

Example XML Result


<ArrayOfDealDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<DealDetail>
<Cmf>76010000</Cmf>
<DealNo>1011487</DealNo>
<DealerId>0001</DealerId>
<DeliveryDate>2013-09-19T00:00:00</DeliveryDate>
<FinInvoiceId>10848385</FinInvoiceId>
<FinanceDate>2013-09-27T00:00:00</FinanceDate>
<OriginatingDate>2013-09-19T00:00:00</OriginatingDate>
<Trade>
<DealerId></DealerId>
<VIN>JS1NJ4CAXD2100433</VIN>
<StdMake>SUZUKI</StdMake>
<StdModel>TU250</StdModel>
<StdYear>2013</StdYear>
<StdCategory></StdCategory>
</Trade>
<Units>
<Unit>
<DealerId></DealerId>
<Class>S</Class>
<DateReceived>2013-09-19T00:00:00</DateReceived>
<DaysInStore>48</DaysInStore>
<DealUnitId>10760257</DealUnitId>
<Freight>0.0000</Freight>
<Freightcost>0.0000</Freightcost>
<Handling>96.0000</Handling>
<Handlingcost>96.0000</Handlingcost>
<LicFees>0.0000</LicFees>
<LicFeesCost>0.0000</LicFeesCost>
<Make>KAWASAKI</Make>

 2019 CDK Global Page 32


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

<Model>VN900BCFA</Model>
<Newused>N</Newused>
<Parts>
<Part>
<DealerId></DealerId>
<Cost>39.9500</Cost>
<PartNumber>410695</PartNumber>
<Price>39.9500</Price>
<Qty>1</Qty>
<Retail>39.9500</Retail>
<SetupInstall>S</SetupInstall>
<SupplierCode>TR</SupplierCode>
<Description>Sprocket</Description>
</Part>
</Parts>
<SalesType>W</SalesType>
<Totaccy>0.0000</Totaccy>
<TotalPartsAmount>0</TotalPartsAmount>
<Totinstall>0.0000</Totinstall>
<Tradeacv>0.0000</Tradeacv>
<Tradeall>0.0000</Tradeall>
<UnitLine1>0.0000</UnitLine1>
<UnitLine10>0.0000</UnitLine10>
<UnitLine11>0.0000</UnitLine11>
<UnitLine12>0.0000</UnitLine12>
<UnitLine2>0.0000</UnitLine2>
<UnitLine3>0.0000</UnitLine3>
<UnitLine4>0.0000</UnitLine4>
<UnitLine5>0.0000</UnitLine5>
<UnitLine6>0.0000</UnitLine6>
<UnitLine7>0.0000</UnitLine7>
<UnitLine8>0.0000</UnitLine8>
<UnitLine9>0.0000</UnitLine9>
<UnitSoldPrice>96.0000</UnitSoldPrice>
<Unitprice>0.0000</Unitprice>
<VIN>JKAVN2B16CA071401</VIN>
<Year>2012</Year>
<mucost>0.0000</mucost>
<actualcost>13000.0000</actualcost>
<docfees>0.0000</docfees>
<plcost>0.0000</plcost>
<propliab>0.0000</propliab>
<sccost>0.0000</sccost>
<servcont>0.0000</servcont>
<Odometer>1000</Odometer>
<Color>Black</Color>

 2019 CDK Global Page 33


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

<stocknumber>ABC123</stocknumber>
<deposit>100.00</deposit>
<packamt>100.00</packamt>
<holdbackamt>100.00</holdbackamt>
<unittype>Motorcycle</unittype>
</Unit>
</Units>
<ahcost>0.0000</ahcost>
<ahpremium>0.0000</ahpremium>
<clcost>0.0000</clcost>
<fincharge>0.0000</fincharge>
<fincost>0.0000</fincost>
<clpremium>0.0000</clpremium>
<CustID>6323256</CustID>
<lienholder>NONE</lienholder>
<salesmanid>TR</salesmanid>
<AmtFinanced>0</AmtFinanced>
<DaysToFirst>30</DaysToFirst>
<Term>120</Term>
<Rate>5.999</Rate>
<Payment>0</Payment>
<SalesmanName>Joe King</SalesmanName>
<salesman2name/>
<salesman2id/>
<salesmanfi1id/>
<salesmanfi1name/>
<salesmanfi2id/>
<salesmanfi2name/>
<fincostoverride>0</fincostoverride>
<lienaddressfirstline>123 Any Street</lienaddressfirstline>
<lienaddresssecondline></lienaddresssecondline>
<liencity>New York City</liencity>
<lienzip>12345</lienzip>
<lienstate>NT</lienstate>
<cobuyercustid>1234</cobuyercustid>
<cobuyername>Tom Riddle</cobuyername>
<cobuyeraddr>123 Any Street</cobuyeraddr>
<cobuyeraddr2></cobuyeraddr2>
<cobuyercity>New York</cobuyercity>
<cobuyerstate>NY</cobuyerstate>
<cobuyerzip>12345</cobuyerzip>
<cobuyercounty>New York</cobuyercounty>
<cobuyerhomephone>5555555555</cobuyerhomephone>
<cobuyerworkphone>5555555555</cobuyerworkphone>
<cobuyercellphone>5555555555</cobuyercellphone>
<cobuyeremail>test@net.net</cobuyeremail>

 2019 CDK Global Page 34


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

<cobuyerbirthdate>2013-09-19T00:00:00</cobuyerbirthdate>
<cobuyerage>40</cobuyerage>
<DealExtraLines>
<linename>Misc</linename>
<extralinenumber>1</extralinenumber>
<linetype>BE2</linetype>
<amount>200.0000</amount>
<cost>100.0000</cost>
<term>36</term>
</DealExtraLines>
</DealDetail>

Customer – Customer Information

Fields
Field Name Data Type Description, Example
DealerId varchar(20) Internal Dealer Identifier
Cmf varchar(20) CDK Global Dealer Identifier
Address1 varchar(50) Address of customer
Address2 varchar(50) Additional address of customer
Birthdate date Birthdate of customer
City varchar(50) City of customer location
Country varchar(30) Country of customer location
County varchar(30) County of customer location
CustFullName varchar(50) Full name of customer
CustomerId bigint Internal ID of customer
Email varchar(255) Must match ‘something@something.domain’ or
a blank will be returned
FirstName varchar(50) First name of customer
HasDriversLicenseNumber tinyint 1 – Yes, 0 - No
HomePhone varchar(20) Home phone of customer
LastName varchar(50) Last name of customer
MiddleName varchar(50) Middle name of customer
State varchar(50) State/Province of customer location
WorkPhone varchar(20) Work phone of customer
CellPhone varchar(20) Cell phone of customer
Zip varchar(10) Zipcode of customer
DateGathered datetime Date when customer record was last updated
CustomerType varchar(50) Dealer assigned customer type
LoyaltyCustomer tinyint 0 – Not on Loyalty 1 – Has Loyalty
Companyname varchar Company Name on record (EVO Only)

Example URL
https://int.LightspeedADP.com/lsapi/Customer/76010000

Notes: Use DateGathered to determine changes

 2019 CDK Global Page 35


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

Example JSON Result


[
{"Cmf":"76014100",
"DealerId":"3531",
"CustomerId":3997192,
"DateGathered":"2013-08-23T12:07:59.767",
"CustFullName":"DOUG M JONES",
"FirstName":"DOUG",
"MIddleName":"M",
"LastName":"JONES",
"Address1":"123 ANY LANE",
"Address2":"",
"City":"SANDY",
"State":"UT",
"Zip":"84084",
"County":"",
"Country":"USA",
"HomePhone":"(801) 555-7659",
"WorkPhone":"(801) 555-4289",
"CellPhone":"",
"EMail":"",
"Birthdate":"1910-01-01T00:00:00",
"HasDriversLicenseNumber":null,
"CustomerType":null,
“LoyaltyCustomer”:1,
“Companyname”:”DealershipExtreme”
}
]

Example XML Result


<ArrayOfCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<Customer>
<Cmf>76014540</Cmf>
<Address1>1423 CHASE LANE</Address1>
<Address2></Address2>
<Birthdate>1910-01-01T00:00:00</Birthdate>
<CellPhone></CellPhone>
<City>SANDY</City>
<Country>USA</Country>
<County></County>
<CustFullName>DOUG M FREELY</CustFullName>
<CustomerId>3137192</CustomerId>
<CustomerType i:nil="true" />
<DateGathered>2013-08-23T12:07:59.767</DateGathered>
<DealerId>3531</DealerId>
<EMail></EMail>

 2019 CDK Global Page 36


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

<FirstName>DOUG</FirstName>
<HasDriversLicenseNumber i:nil="true" />
<HomePhone>(801) 554-7659</HomePhone>
<LastName>FREELY</LastName>
<MIddleName>M</MIddleName>
<State>UT</State>
<WorkPhone>(801) 263-4289</WorkPhone>
<Zip>84084</Zip>
<LoyaltyCustomer>1</LoyaltyCustomer>
<Companyname>DealershipExtreme</Companyname>
</Customer>
</ArrayOfCustomer>

ServiceSum – Service Summary

Fields
Field Name Data Type Description, Example
DealerId varchar(20) Internal Dealer Identifier
Cmf varchar(20) CDK Global Dealer Identifier
ROHeaderID int DMS internal identifier of RO
ROUnitID int Unit identifier on the RO
ROJobID int Job identifier on the RO
rono varchar(20) DMS external (customer facing) RO identifier
JobDescription varchar(2000) Free form description of RO job
JobTitle varchar(75) Free form title of RO job
InternalJob byte 1 – Internal, 0 – Not internal
WarrantyJob byte 1 – Warranty, 0 – Not warranty
VIN varchar(26) VIN of unit
Make varchar(20) Maker of the unit
Model varchar(20) Model of the unit
Year varchar(4) Model year of the unit
CashieredDate date Date RO was paid
PartsPrice money Price of all parts on the RO
LaborPrice money Price of all labor on the RO
Shopsupply money Price of shop supplies on the RO
MiscPrice money Sum of all misc charges on the RO
Custid varchar(12) DMS customer identifier

Example URL
https://int.LightspeedADP.com/lsapi/ServiceSum/76010000
Notes: Use ROHeaderId or CashieredDate to determine changes

Example JSON Result


[
{"Cmf":"76010001",
"DealerId":"0001",
"ROHeaderID":9158372,
"ROUnitID":9158427,

 2019 CDK Global Page 37


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

"ROJobID":9158497,
“rono:” 12345,
"JobDescription":"WRONG GEAR POSITION",
"JobTitle":"WRONG GEAR POSITION",
"InternalJob":0,
"WarrantyJob":1,
"VIN":"JKBZGNC10CA014229",
"Make":"KAWASAKI",
"Model":"ZG1400CCF",
"Year":"2012",
"CashieredDate":"2013-10-31T00:00:00",
"PartsPrice":98.0000,
"LaborPrice":49.0000,
"shopsupply":0.0000,
"MiscPrice":0.0000,
“custid” : “1”
}
}
]

Example XML Result


<ArrayOfServiceHeadSum xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<ServiceHeadSum>
<Cmf>76010000</Cmf>
<CashieredDate>2013-10-31T00:00:00</CashieredDate>
<DealerId>0001</DealerId>
<InternalJob>0</InternalJob>
<JobDescription>WRONG GEAR POSITION</JobDescription>
<JobTitle>WRONG GEAR POSITION</JobTitle>
<LaborPrice>49.0000</LaborPrice>
<Make>KAWASAKI</Make>
<MiscPrice>0.0000</MiscPrice>
<Model>ZG1400CCF</Model>
<PartsPrice>98.0000</PartsPrice>
<ROHeaderID>9158372</ROHeaderID>
<ROJobID>9158497</ROJobID>
<ROUnitID>9158427</ROUnitID>
<rono>12345</rono>
<VIN>JKBZGNC10CA014229</VIN>
<WarrantyJob>1</WarrantyJob>
<Year>2012</Year>
<shopsupply>0.0000</shopsupply>
<custid>1</custid>
</ServiceHeadSum>

ServiceDet – Service Detail

 2019 CDK Global Page 38


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

Fields
Field Name Data Type Description, Example
DealerId varchar(20) Internal Dealer Identifier
Cmf varchar(20) CDK Global Dealer Identifier
ROHeaderID int DMS internal identifier of RO
rono varchar(20) DMS external (customer facing) RO identifier
Datein date Date unit was brought in
Closedate date Date RO work was finished
Pudate date Date RO was paid
CustID bigint DMS customer identifier
Shopsupply money Header level set to 0 – use Job
MiscCharge1 money Header level set to 0 – use Job
MiscCharge2 money Header level set to 0 – use Job
MiscCharge3 money Header level set to 0 – use Job
MiscCharge4 money Header level set to 0 – use Job
ServiceWriterName varchar(50) Name of service writer
TotsubCost money Total cost of sublet work
TotsubSales money Total price of sublet work
ROUnitID int Unit identifier on the RO
VIN varchar(26) VIN of unit
Make varchar(20) Maker of the unit
Model varchar(20) Model of the unit
Year varchar(4) Model year of the unit
Engineno varchar(21) Number of unit engine
Class varchar(5) Dealer assigned unit class
Odometer int Mileage of unit
StockNumber varchar(30) Internal dealer unit identifier
ROJobID int Job identifier on the RO
JobDescription varchar(2000) Free form description of RO job
JobTitle varchar(75) Free form title of RO job
InternalJob byte 1 – Internal, 0 – Not internal
WarrantyJob byte 1 – Warranty, 0 – Not warranty
ROPartID int Part identifier on RO
PartNumber varchar(20) Part identifier
PartDescription varchar(30) Description of part
SourceCode varchar(3) Abbreviated maker of part
Qty int Amount of part sold on RO
Cost money Cost of the part after being sold from parts dept
Price money Price of the part
ExtPrice money Extended Price of the part
ROLaborID int Labor identifier on part
JobDescription varchar(20) Description of labor item
Hours decimal Hours billed for the labor
Rate decimal Hourly rate of the labor
Total decimal Hours * Rate
ActualHours decimal Actual amount of hours needed to complete
labor
TechnicianName varchar(50) Name of service technician doing the labor
DiscountTotalCharge money Price of the labor after discounts
TotalCharge money Price of the labor

 2019 CDK Global Page 39


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

misccharge 1 varchar(10) Separate misc charge on job lvl


misccharge 2 varchar(10) Separate misc charge on job lvl
misccharge 3 varchar(10) Separate misc charge on job lvl
misccharge 4 varchar(10) Separate misc charge on job lvl
DiscountPrice money Price of labor after discout

Example URL
https://int.LightspeedADP.com/lsapi/ServiceDet/76010000

Notes: Use ROHeaderId or Pudate to determine changes

Example JSON Result


[
{"Cmf":"76010000",
"DealerId":"I013",
"ROHeaderID":285,
“rono”: 12345,
"CustID":0,
"datein":"2013-04-10T14:58:34",
"closedate":"2014-04-18T00:00:00",
"pudate":"2014-04-18T00:00:00",
"shopsupply":0.0000,
"MiscCharge1":0.0000,
"MiscCharge2":0.0000,
"MiscCharge3":0.0000,
"MiscCharge4":0.0000,
"ServiceWriterName":"",
"TotsubCost":0.0000,
"TotsubSales":0.0000,
"Unit":[
{"ROUnitID":2,
"VIN":"",
"Make":"HONDA",
"Model":"blue",
"Year":"2013",
"Engineno":"",
"Class":"M",
"Odometer":0,
"StockNumber":"3272013",
"Job":[
{"ROJobID":1,
"JobDescription":"",
"JobTitle":"major unit",
"InternalJob":1,
"WarrantyJob":0,
"Parts":[
{"ROPartID":5,

 2019 CDK Global Page 40


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

"PartNumber":"00000-00008",
"PartDescription":"O-RING",
"SourceCode":"HO",
"Qty":1,
"Cost":2.7000,
"Price":5.4900,
“DiscountPrice”:5.4900
"ExtPrice":5.4900}],
"Labor":[
{"ROLaborID":1,
"JobDescription":"",
"Hours":1.0000,
"Rate":95.0000,
"Total":85.5000,
"Actualhours":1.0000,
"TechnicianName":"Adam Kellam",
"DiscountTotalCharge":85.5000,
"TotalCharge":95.0000}]},
{"ROJobID":2,
"JobDescription":"",
"JobTitle":"Install Bumper",
"InternalJob":1,
"WarrantyJob":0,
“misccharge1”:0.00,
“misccharge2”:0.00,
“misccharge3”:0.00,
“misccharge4”:0.00,
"Parts":[],
"Labor":[
{"ROLaborID":1,
"JobDescription":"",
"Hours":1.0000,
"Rate":95.0000,
"Total":85.5000,
"Actualhours":11.0000,
"TechnicianName":"Adam Kellam",
"DiscountTotalCharge":85.5000,
"TotalCharge":95.0000}]}]}]}]

Example XML Result


<ArrayOfServiceDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<ServiceDetail>
<Cmf>7601000</Cmf>
<CustID>0</CustID>
<DealerId>I013</DealerId>
<MiscCharge1>0.0000</MiscCharge1>

 2019 CDK Global Page 41


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

<MiscCharge2>0.0000</MiscCharge2>
<MiscCharge3>0.0000</MiscCharge3>
<MiscCharge4>0.0000</MiscCharge4>
<ROHeaderID>285</ROHeaderID>
<rono>12345</rono>
<ServiceWriterName></ServiceWriterName>
<TotsubCost>0.0000</TotsubCost>
<TotsubSales>0.0000</TotsubSales>
<Unit>
<ServiceUnit>
<Class>M</Class>
<Engineno></Engineno>
<Job>
<ServiceJob>
<InternalJob>1</InternalJob>
<JobDescription></JobDescription>
<JobTitle>major unit</JobTitle>
<Labor>
<ServiceLabor>
<Actualhours>1.0000</Actualhours>

<DiscountTotalCharge>85.5000</DiscountTotalCharge>
<Hours>1.0000</Hours>
<JobDescription></JobDescription>
<ROLaborID>1</ROLaborID>
<Rate>95.0000</Rate>
<TechnicianName>Adam
Kellam</TechnicianName>
<Total>85.5000</Total>
<TotalCharge>95.0000</TotalCharge>
</ServiceLabor>
</Labor>
<Parts>
<ServiceParts>
<Cost>2.7000</Cost>
<ExtPrice>5.4900</ExtPrice>
<PartDescription>O-
RING</PartDescription>
<PartNumber>00000-00008</PartNumber>
<Price>5.4900</Price>
<DiscountPrice>5.4900</DiscountPrice>
<Qty>1</Qty>
<ROPartID>5</ROPartID>
<SourceCode>HO</SourceCode>
</ServiceParts>
</Parts>

 2019 CDK Global Page 42


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

<ROJobID>1</ROJobID>
<WarrantyJob>0</WarrantyJob>
<misccharge1>0.00</misccharge1>
<misccharge2>0.00</misccharge2>
<misccharge3>0.00</misccharge3>
<misccharge4>0.00</misccharge4>
</ServiceJob>
<ServiceJob>
<InternalJob>1</InternalJob>
<JobDescription></JobDescription>
<JobTitle>Install Bumper</JobTitle>
<Labor>
<ServiceLabor>
<Actualhours>11.0000</Actualhours>

<DiscountTotalCharge>85.5000</DiscountTotalCharge>
<Hours>1.0000</Hours>
<JobDescription></JobDescription>
<ROLaborID>1</ROLaborID>
<Rate>95.0000</Rate>
<TechnicianName>Adam
Kellam</TechnicianName>
<Total>85.5000</Total>
<TotalCharge>95.0000</TotalCharge>
</ServiceLabor>
</Labor>
<Parts />
</ServiceJob>
</Job>
<Make>HONDA</Make>
<Model>blue</Model>
<Odometer>0</Odometer>
<ROUnitID>2</ROUnitID>
<StockNumber>3272013</StockNumber>
<VIN></VIN>
<Year>2013</Year>
</ServiceUnit>
</Unit>
<closedate>2014-04-18T00:00:00</closedate>
<datein>2013-04-10T14:58:34</datein>
<pudate>2014-04-18T00:00:00</pudate>
<shopsupply>0.0000</shopsupply>
</ServiceDetail>

InvoiceSum – Invoicing Summary

 2019 CDK Global Page 43


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

Fields
Field Name Data Type Description, Example
DealerId varchar(20) Internal Dealer Identifier
Cmf varchar(20) CDK Global Dealer Identifier
InvoiceID int Internal DMS invoice identifier
InvoiceNo varchar(9) External DMS invoice identifier
InvoiceDate date Date of invoice
salesmanId varchar(5) DMS Id of salesman (cashier)
Sales money Total price of the invoice
Salestype varchar(1) M – Major Unit; R – RO; C - Customer
Custid varchar(12) DMS customer identifier

Example URL
https://int.LightspeedADP.com/lsapi/InvoiceSum/76010000

Notes: Use InvoiceID or InvoiceDate to determine changes

Example JSON Result


[
{"Cmf":"76010000",
"dealerId":"0001",
"invoiceId":10798384,
"InvoiceNo":"5004662",
"InvoiceDate":"2013-09-23T00:00:00",
"salesmanId":"DK",
"Sales":1.9300,
"SalesType":"C",
“custid: “1”}
]

Example XML Result


<ArrayOfInvoiceSum xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<InvoiceSum>
<Cmf>76010000</Cmf>
<InvoiceDate>2013-09-23T00:00:00</InvoiceDate>
<InvoiceNo>5004662</InvoiceNo>
<Sales>1.9300</Sales>
<SalesType>C</SalesType>
<dealerId>0001</dealerId>
<invoiceId>10798384</invoiceId>
<salesmanId>DK</salesmanId>
<custid>1</custid>
</InvoiceSum>

InvoiceDet – Invoicing Detail

 2019 CDK Global Page 44


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

Fields
Field Name Data Type Description, Example
DealerId varchar(20) Internal Dealer Identifier
Cmf varchar(20) CDK Global Dealer Identifier
InvoiceID int Internal DMS invoice identifier
InvoiceNo varchar(9) External DMS invoice identifier
InvoiceDate date Date of invoice
Invoicelineno int Line ID of the invoice
Salesmanid varchar(5) DMS id of the salesman (cashier)
CustID varchar(10) DMS customer identifier
Price money Price of the invoice
Partno varchar(20) Part identifier
Source varchar(3) Abbreviated maker of the part
Partdesc varchar(30) Description of the part
Qty int Amount sold of the part
Pu int Amount of the part picked up from a special
order
So int Amount of the part that was special ordered
Lay int Amount of the part that was put on layaway
Lost int Amount of the part that was considered a lost
sale due to lack of inventory
Stdprice money Standard price of the part
Category varchar(10) Dealer assigned part category

Example URL
https://int.LightspeedADP.com/lsapi/InvoiceDet/76010000

Notes: Use InvoiceId or InvoiceDate to determine changes.

Example JSON Result


[
{"Cmf":"76010000",
"dealerId":"0001",
"invoiceId":10798384,
"InvoiceNo":5004662,
"InvoiceDate":"2013-09-23T00:00:00",
“CustID”:”76456”,
"invoicelineno":10798385,
"salesmanId":"DK",
"price":1.9300,
"cost":1.0000,
"partno":"COFFEE",
"source":"AC",
"partdesc":"MONSTER COFFEE",
"qty":1,
"pu":0,
"so":0,
"lay":0,

 2019 CDK Global Page 45


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

"lost":0,
"stdprice":2.9900}
]

Example XML Result


<ArrayOfInvoiceDet xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<InvoiceDet>
<Cmf>76010000</Cmf>
<InvoiceDate>2013-09-23T00:00:00</InvoiceDate>
<InvoiceNo>5004662</InvoiceNo>
<dealerId>0001</dealerId>
<invoiceId>10798384</invoiceId>
<invoicelineno>10798385</invoicelineno>
<CustID>76456</CustID>
<lay>0</lay>
<lost>0</lost>
<partdesc>MONSTER COFFEE</partdesc>
<partno>COFFEE</partno>
<price>1.0000</price>
<price>1.9300</price>
<pu>0</pu>
<qty>1</qty>
<salesmanId>DK</salesmanId>
<so>0</so>
<source>AC</source>
<stdprice>2.9900</stdprice>
</InvoiceDet>

OpenDealDetail – Open Sales Deals Detail (EVO Only)

Notes: Because of the volatility of the open deal data set we suggest you treat the data as a snapshot
and consume it as a whole instead of looking for changes in IDs or dates.

Example URL
https://int.LightspeedADP.com/lsapi/OpenDealDetail/76010000

Fields
Field Name Data Type Description, Example
DealerId varchar(20) Internal Dealer Identifier
Cmf varchar(20) CDK Global Dealer Identifier
Dealno varchar(20) External DMS deal identifier
FinInvoiceID int Internal DMS deal identifier
FinanceDate date Date deal was finalized
OriginatingDate date Date deal was created

 2019 CDK Global Page 46


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

DeliveryDate date Date unit was delivered to customer


Salesmanid varchar(15) DMS Id of salesperson
Clpremium money Price of CL on deal
Clcost money Cost of CL on deal
Ahpremium money Price of AH on deal
Ahcost money Cost of AH on deal
CustID varchar(12) DMS customer identifier
Lienholder varchar(90) Lien holder on the deal
DealUnitID long Unit id on the deal
Newused varchar(2) N – New, U - Used
Year varchar(4) Model year of unit
Make varchar(20) Maker of unit
Model varchar(20) Model of unit
VIN varchar(25) VIN of unit
Class varchar(2) Dealer assigned class for unit
Unitprice money Price of the unit
Mucost money Cost of the unit
Freight money Price of freight
Freightcost money Cost of freight
Handling money Price of handling
Handlingcost money Cost of handling
Licfees money Price of licensing fees
LicFeesCost money Cost of licensing fees
Totaccy money Price of all accessories on deal
Totinstall money Price of installation
Tradeall money Trade allowance on deal
Tradeacv money Trade ACV
DateReceived date Date trade was received
Servcont money Price of service contract
Sccost money Cost of service contract
Probliab money Price of PL
Plcost money Cost of PL
SalesType varchar(1) R=Retail, W=Wholesale
UnitSoldPrice money Unitprice+freight+handling-
Tradeall+Traceacv+Totaccy+totinstall
TotalPartsAmount money Sum(qty*price)
DaysInStore int (CurrentTime) – DateReceived displayed in
days
UnitLine1 money Amount from user configurable field
UnitLine2 money Amount from user configurable field
UnitLine3 money Amount from user configurable field
UnitLine4 money Amount from user configurable field
UnitLine5 money Amount from user configurable field
UnitLine6 money Amount from user configurable field
UnitLine7 money Amount from user configurable field
UnitLine8 money Amount from user configurable field
UnitLine9 money Amount from user configurable field
UnitLine10 money Amount from user configurable field
UnitLine12 money Amount from user configurable field
PartNumber varchar(20) Part identifier

 2019 CDK Global Page 47


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

Suppliercode varchar(3) Abbreviated name of maker


Qty int Amount of part sold
Cost money Cost of the part after being sold from parts dept
Price money Price of the part
Retail money Standard price of the part
SetupInstall varchar(1) S – Setup, I - Installed
VIN varchar Trade VIN
StdMake varchar Trade Standardized Make
StdModel varchar Trade Standardized Model
StdYear varchar Trade Standardized Year
StdCategory varchar Trade Standardized Category
AmtFinanced money Amount financed on deal
Term int Term of financing
Rate money Rate of financing
Payment money Monthly payment of financing
SalesmanName varchar Name of salesperson
Odometer varchar Mileage of unit
Color varchar Color of unit
DaysToFirst int How many days until first payment
Description varchar Description of part
Stocknumber varchar Dealer made identifier of unit
Deposit money Deposit put on deal
Dealstate varchar Where dealer is quote, deal, or lead

Example JSON Result


[
{
"Cmf":"76010000",
"DealerId":"0001",
"DealNo":"1011499",
"FinInvoiceId":10816444,
"FinanceDate":"2013-09-24T00:00:00",
"OriginatingDate":"2013-09-23T00:00:00",
"DeliveryDate":"2013-09-23T00:00:00",
"salesmanid":"LH",
“dealstate”:”Deal”,
"clpremium":0.0000,
"clcost":0.0000,
"ahpremium":0.0000,
"ahcost":0.0000,
"CustID":"10799428",
"lienholder":"NONE",
"SalesmanName":"Joe King",
"AmtFinanced":0,
"Term":120,
"Rate":5.999,
"DaysToFirst":30,
"Payment":0,

 2019 CDK Global Page 48


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

"Units":[{
"DealerId": "",
"DealUnitId":10799439,
"Newused":"N",
"Year":"2013",
"Make":"KAWASAKI",
"Model":"JT1500JDF",
"VIN":"US-KAW40474K213",
"Class":"W",
"Unitprice":13965.5200,
"mucost":13524.0000,
"Freight":348.0000,
"Freightcost":0.0000,
"Handling":399.4700,
"Handlingcost":291.9000,
"LicFees":21.0000,
"LicFeesCost":21.0000,
"Totaccy":0.0000,
"Totinstall":0.0000,
"Tradeall":500.0000,
"Tradeacv":100.0000,
"DateReceived":"2013-02-07T00:00:00",
"servcont":0.0000,
"sccost":0.0000,
"propliab":0.0000,
"plcost":0.0000,
"SalesType":"W",
"UnitSoldPrice":14312.9900,
"TotalPartsAmount":0.0000,
"DaysInStore":272,
"Odometer":1000,
"Color":"Black",
"UnitLine1":0.0000,
"UnitLine2":1.5000,
"UnitLine3":294.0000,
"UnitLine4":0.0000,
"UnitLine5":0.0000,
"UnitLine6":0.0000,
"UnitLine7":0.0000,
"UnitLine8":0.0000,
"UnitLine9":0.0000,
"UnitLine10":0.0000,
"UnitLine11":0.0000,
"UnitLine12":0.0000,
“stocknumber”:”ABC123”,
“deposit”:100.00

 2019 CDK Global Page 49


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

"Parts":[{
"DealerId": "",
"PartNumber":"GAS",
"SupplierCode":"AC",
"Qty":10,
"Cost":4.3500,
"Price":0.0000,
"Retail":4.3500,
"SetupInstall":"S",
“Description”:”Fuel”
}]
}],
"Trade":[{
"DealerId": "",
"VIN":"KAW45752B494",
"StdMake":"NA",
"StdModel":"NA",
"StdYear":"NA",
"StdCategory":"NA"
}]
}
]

Example XML Result


<ArrayOfOpenDealDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<OpenDealDetail>
<Cmf>76010000</Cmf>
<DealNo>1011487</DealNo>
<DealerId>0001</DealerId>
<DeliveryDate>2013-09-19T00:00:00</DeliveryDate>
<FinInvoiceId>10848385</FinInvoiceId>
<FinanceDate>2013-09-27T00:00:00</FinanceDate>
<OriginatingDate>2013-09-19T00:00:00</OriginatingDate>
<Trade>
<DealerId></DealerId>
<VIN>JS1NJ4CAXD2100433</VIN>
<StdMake>SUZUKI</StdMake>
<StdModel>TU250</StdModel>
<StdYear>2013</StdYear>
<StdCategory></StdCategory>
</Trade>
<Units>
<Unit>
<DealerId></DealerId>
<Class>S</Class>

 2019 CDK Global Page 50


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

<DateReceived>2013-09-19T00:00:00</DateReceived>
<DaysInStore>48</DaysInStore>
<DealUnitId>10760257</DealUnitId>
<Freight>0.0000</Freight>
<Freightcost>0.0000</Freightcost>
<Handling>96.0000</Handling>
<Handlingcost>96.0000</Handlingcost>
<LicFees>0.0000</LicFees>
<LicFeesCost>0.0000</LicFeesCost>
<Make>KAWASAKI</Make>
<Model>VN900BCFA</Model>
<Newused>N</Newused>
<Parts>
<Part>
<DealerId></DealerId>
<Cost>39.9500</Cost>
<PartNumber>410695</PartNumber>
<Price>39.9500</Price>
<Qty>1</Qty>
<Retail>39.9500</Retail>
<SetupInstall>S</SetupInstall>
<SupplierCode>TR</SupplierCode>
<Description>Sprocket</Description>
</Part>
</Parts>
<SalesType>W</SalesType>
<Totaccy>0.0000</Totaccy>
<TotalPartsAmount>0</TotalPartsAmount>
<Totinstall>0.0000</Totinstall>
<Tradeacv>0.0000</Tradeacv>
<Tradeall>0.0000</Tradeall>
<UnitLine1>0.0000</UnitLine1>
<UnitLine10>0.0000</UnitLine10>
<UnitLine11>0.0000</UnitLine11>
<UnitLine12>0.0000</UnitLine12>
<UnitLine2>0.0000</UnitLine2>
<UnitLine3>0.0000</UnitLine3>
<UnitLine4>0.0000</UnitLine4>
<UnitLine5>0.0000</UnitLine5>
<UnitLine6>0.0000</UnitLine6>
<UnitLine7>0.0000</UnitLine7>
<UnitLine8>0.0000</UnitLine8>
<UnitLine9>0.0000</UnitLine9>
<UnitSoldPrice>96.0000</UnitSoldPrice>
<Unitprice>0.0000</Unitprice>
<VIN>JKAVN2B16CA071401</VIN>

 2019 CDK Global Page 51


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

<Year>2012</Year>
<mucost>0.0000</mucost>
<plcost>0.0000</plcost>
<propliab>0.0000</propliab>
<sccost>0.0000</sccost>
<servcont>0.0000</servcont>
<Odometer>1000</Odometer>
<Color>Black</Color>
<stocknumber>ABC123</stocknumber>
<deposit>100.00</deposit>
</Unit>
</Units>
<ahcost>0.0000</ahcost>
<ahpremium>0.0000</ahpremium>
<clcost>0.0000</clcost>
<clpremium>0.0000</clpremium>
<CustID>6323256</CustID>
<lienholder>NONE</lienholder>
<salesmanid>TR</salesmanid>
<dealstate>Deal</dealstate>
<AmtFinanced>0</AmtFinanced>
<DaysToFirst>30</DaysToFirst>
<Term>120</Term>
<Rate>5.999</Rate>
<Payment>0</Payment>
<SalesmanName>Joe King</SalesmanName>
</OpenDealDetail>

DeletedPart – (EVO-only) Parts deleted from Inventory

Example URL
https://int.LightspeedADP.com/lsapi/DeletedPart/76010000
Field Name Data Type Description, Example
DealerId varchar(20) Internal Dealer Identifier
partnumber varchar Part identifier
suppliercode varchar Abbreviated name of maker
dtstamp datetime Date when the part was deleted

Example JSON:
[
{
"Cmf": "76010000",
"DealerId": "",
"partnumber": "032-15-8251",
"suppliercode": "MN",

 2019 CDK Global Page 52


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

"dtstamp": "2017-01-23T15:46:29.818"
}
]

Example XML:
<ArrayOfDeletedPart xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<DeletedPart>
<DealerId/>
<Cmf>76010000</Cmf>
<dtstamp>2017-01-23T15:46:29.818</dtstamp>
<partnumber>032-15-8251</partnumber>
<suppliercode>MN</suppliercode>
</DeletedPart>
</ArrayOfDeletedPart>

InactivePart – (EVO-only) Parts inactivated from Inventory

Example URL
https://int.LightspeedADP.com/lsapi/DeletedPart/76010000
Field Name Data Type Description, Example
DealerId varchar(20) Internal Dealer Identifier
partnumber varchar Part identifier
suppliercode varchar Abbreviated name of maker
dtstamp datetime Date when the part was deleted

Example JSON:
[
{
"Cmf": "76010000",
"DealerId": "",
"partnumber": "032-15-8251",
"suppliercode": "MN"
}
]

Example XML:
<ArrayOfInactivePart xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<InactivePart>
<DealerId/>
<Cmf>76010000</Cmf>
<partnumber>032-15-8251</partnumber>
<suppliercode>MN</suppliercode>
</ InactivePart >
</ ArrayOfInactivePart >

 2019 CDK Global Page 53


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

AcctBalance – (EVO-only) Account Balances by Year

Example URL
https://int.LightspeedADP.com/lsapi/AcctBalance/76201234?$filter=FiscalYear%20eq%
202018
Field Name Data Type Description, Example
DealerId varchar Internal Dealer Identifier
Cmf varchar CDK dealer number
AcctCode varchar Account Code
DeptCode varchar Department Code
FiscalYear short Year record is report on
BeginningBalance decimal Account balance at beginning of fiscal year
Month1 decimal Ending balance at end of month 1 of fiscal year
Month2 decimal Ending balance at end of month 2 of fiscal year
Month3 decimal Ending balance at end of month 3 of fiscal year
Month4 decimal Ending balance at end of month 4 of fiscal year
Month5 decimal Ending balance at end of month 5 of fiscal year
Month6 decimal Ending balance at end of month 6 of fiscal year
Month7 decimal Ending balance at end of month 7 of fiscal year
Month8 decimal Ending balance at end of month 8 of fiscal year
Month9 decimal Ending balance at end of month 9 of fiscal year
Month10 decimal Ending balance at end of month 10 of fiscal
year
Month11 decimal Ending balance at end of month 11 of fiscal
year
Month12 decimal Ending balance at end of month 12 of fiscal
year

It is suggested to utilize a filter against FiscalYear.

Example JSON:
[
{
"Cmf": "7601XXXX",
"DealerId": "",
"AcctCode": "GESMRF2",
"DeptCode": "",
"FiscalYear": 2018,
"BeginningBalance": 0.0,
"Month1": 40194.0,
"Month2": 52439.0,
"Month3": 86998.0,
"Month4": 92588.0,
"Month5": 22291.0,
"Month6": 0.0,
"Month7": 0.0,
"Month8": 0.0,
"Month9": 0.0,

 2019 CDK Global Page 54


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

"Month10": 0.0,
"Month11": 0.0,
"Month12": 0.0
}
]
Example XML:
<ArrayOfAcctBalance xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<AcctBalance>
<DealerId/>
<Cmf>7601XXXX </Cmf>
<AcctCode> GESMRF2</AcctCode>
<BeginningBalance>0</BeginningBalance>
<DeptCode/>
<FiscalYear>2018</FiscalYear>
<Month1>40194</Month1>
<Month10>0</Month10>
<Month11>0</Month11>
<Month12>0</Month12>
<Month2>52439</Month2>
<Month3>86998</Month3>
<Month4>92588</Month4>
<Month5>22291</Month5>
<Month6>0</Month6>
<Month7>0</Month7>
<Month8>0</Month8>
<Month9>0</Month9>
</AcctBalance>
</ArrayOfAcctBalance>

OpenRepairOrderJob – (EVO-only) Open RO Jobs

Example URL
https://int.LightspeedADP.com/lsapi/OpenRepairOrderJob/76201234
Field Name Data Type Description, Example
DealerId varchar Internal Dealer Identifier
Cmf varchar CDK dealer number
RepairOrderId int DMS internal Id
RepairOrderUnitId int DMS unit id for the RO
RepairOrderNumber int DMS customer facing RO identifier
InDateTime datetime When the unit came in
PromisedDateTime datetime When unit was promised for completion
ClosedDateTime datetime When service was finished on unit
CancelDateTime datetime When the RO was cancelled
ROStatus int Status of RO (see below)
CustomerId bigint DMS customer Id

 2019 CDK Global Page 55


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

Year int Year of the unit


Make varchar Make of the unit
ModelId varchar Id of the unit model
ModelName varchar Model name of the unit
Vin varchar VIN of the unit
Hours int Hours assigned to the job
Odometer int Odometer reading of the unit
WarrantyJob int Is the job warranty
InternalJob int Is the job internal
JobTitle varchar Title of job
JobDescription varchar Description of job
ChargedHours decimal Total hours charged for job
ActualHours decimal Actual amount of hours to complete job
ServiceWriterId bigint DMS Id of the writer
ServiceWriterName varchar Name of writer
ServiceWriterEmail varchar Email of writer
TechnicianName varchar Name of tech

RO Status
State Description
0 Estimate
1 New repair order
3 Cancelled repair order
4 Outstanding parts requests
5 Outstanding parts special orders
6 In process - parts assigned, but no labor
7 In Process - labor assigned, but no parts
8 In process - parts and labor assigned
9 Partially completed
10 Completed missing warranty information
11 Completed (ready for cashiering)

Sample JSON result:


[
{
"Cmf": "76011234",
"DealerId": "",
"RepairOrderId": 3562480,
"RepairOrderUnitId": 3563066,
"RepairOrderJobId": 3563198,
"RepairOrderNumber": 990023707,
"InDateTime": "2012-07-17T00:00:00",
"PromisedDateTime": "2012-07-17T00:00:00",
"ClosedDateTime": "1000-01-01T00:00:00",
"CancelDateTime": "1000-01-01T00:00:00",
"ROStatus": 3,
 2019 CDK Global Page 56
Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

"CustomerId": 1123452,
"Year": 2005,
"Make": "YAMAHA",
"ModelId": "YZ250F",
"ModelName": "",
"Vin": "JYAACG21CX5A009296",
"Hours": 0,
"Odometer": 0,
"WarrantyJob": 0,
"InternalJob": 0,
"JobTitle": "FULL SERVICE WITH VALVES",
"JobDescription": "BIKE RUNS ROUGH, IDLES POOR, HARD TO START.",
"ChargeHours": 0.0,
"ActualHours": 0.0,
"ServiceWriterId": 0,
"ServiceWriterName": null,
"ServiceWriterEmail": null,
"TechnicianName": null
}
]

Sample XML Result:


<ArrayOfOpenRepairOrderJob xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<OpenRepairOrderJob>
<DealerId/>
<Cmf>76011234</Cmf>
<ActualHours>0</ActualHours>
<CancelDateTime>1000-01-01T00:00:00</CancelDateTime>
<ChargeHours>0</ChargeHours>
<ClosedDateTime>1000-01-01T00:00:00</ClosedDateTime>
<CustomerId>19123452</CustomerId>
<Hours>0</Hours>
<InDateTime>2012-07-17T00:00:00</InDateTime>
<InternalJob>0</InternalJob>
<JobDescription>BIKE RUNS ROUGH, IDLES POOR, HARD TO START.</JobDescription>
<JobTitle>FULL SERVICE WITH VALVES</JobTitle>
<Make>YAMAHA</Make>
<ModelId>YZ250F</ModelId>
<ModelName/>
<Odometer>0</Odometer>
<PromisedDateTime>2012-07-17T00:00:00</PromisedDateTime>
<ROStatus>3</ROStatus>
<RepairOrderId>3562480</RepairOrderId>
<RepairOrderJobId>3563198</RepairOrderJobId>

 2019 CDK Global Page 57


Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

<RepairOrderNumber>990023707</RepairOrderNumber>
<RepairOrderUnitId>3563066</RepairOrderUnitId>
<ServiceWriterEmail i:nil="true"/>
<ServiceWriterId>0</ServiceWriterId>
<ServiceWriterName i:nil="true"/>
<TechnicianName i:nil="true"/>
<Vin>JYAACG21CX5A009296</Vin>
<WarrantyJob>0</WarrantyJob>
<Year>2005</Year>
</OpenRepairOrderJob>
</ArrayOfOpenRepairOrderJob>

OpenRepairOrderPart – (EVO-only) Open RO Parts

Example URL
https://int.LightspeedADP.com/lsapi/OpenRepairOrderPart/76201234
Field Name Data Type Description, Example
DealerId varchar Internal Dealer Identifier
Cmf varchar CDK dealer number
RepairOrderId int DMS internal Id
RepairOrderUnitId int DMS unit id for the RO
RepairOrderJobId int DMS job Id for the RO
SupplierCode varchar Code for part’s maker
PartNumber varchar Part inventory Id
Description varchar Description of the part
RequestedQty bigint How many of the part sold
SpecialOrderQty bigint How many of the part special ordered
ReceivedQty bigint How many of the part received

Sample JSON Result:


[
{
"Cmf": "76011234",
"DealerId": "",
"RepairOrderId": 3562504,
"RepairOrderUnitId": 3563070,
"RepairOrderJobId": 3563216,
"SupplierCode": "PU",
"PartNumber": "0614-0315",
"Description": "BRAKE LVR DAGGER LNG BK",
"RequestedQty": 0,
"SpecialOrderQty": 0,
"ReceivedQty": 1
 2019 CDK Global Page 58
Revised 9/19/2018
Data Warehouse Web Se rvice Developer Guide

}
]

Sample XML Result:


<ArrayOfOpenRepairOrderPart xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<OpenRepairOrderPart>
<DealerId/>
<Cmf>76011234</Cmf>
<Description>BRAKE LVR DAGGER LNG BK</Description>
<PartNumber>0614-0315</PartNumber>
<ReceivedQty>1</ReceivedQty>
<RepairOrderId>3562504</RepairOrderId>
<RepairOrderJobId>3563216</RepairOrderJobId>
<RepairOrderUnitId>3563070</RepairOrderUnitId>
<RequestedQty>0</RequestedQty>
<SpecialOrderQty>0</SpecialOrderQty>
<SupplierCode>PU</SupplierCode>
</OpenRepairOrderPart>
</ArrayOfOpenRepairOrderPart>

 2019 CDK Global Page 59


Revised 9/19/2018

You might also like