0% found this document useful (0 votes)
2K views

Lightspeed Web Service Developer Guide

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’).

Uploaded by

jaredfinnegan
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
2K views

Lightspeed Web Service Developer Guide

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’).

Uploaded by

jaredfinnegan
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 41

Data Warehouse Web Service Developer Guide

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).

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 Formats
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 dealers 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

2017 CDK Global


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

Select Ability to specify which fields are returned.


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 Examples
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.

2017 CDK Global Page 2


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

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
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

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 dealers database is directly connected to the


web service, providing real-time data for some datasets.
1 = True; 0 = False

Example URL
https:// int.LightspeedADP.com/lsapi/Dealer

2017 CDK Global Page 3


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

Example JSON Result


[
{
"Cmf": "76147580",
"DealershipName": "Sample Dealer",
"DealerNumber": ""
},
{
"Cmf": "76014682",
"DealershipName": "Lightspeed Powersports",
"DealerNumber": ""
}
]

Example XML Result


<ArrayOfDealer>
<Dealer>
<Cmf>76147580</Cmf>
<DealershipName>Sample Dealer</DealershipName>
<DealerNumber/>
</Dealer>
<Dealer>
<Cmf>76014682</Cmf>
<DealershipName>Lightspeed Powersports</DealershipName>
<DealerNumber/>
</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

2017 CDK Global Page 4


Revised 9/23/2015
Data Warehouse Web Service 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.

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

2017 CDK Global Page 5


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

Fields
Field Name Data Type Description, Example
DealerId varchar(20) Internal Dealer Identifier
Cmf varchar(20) CDK Global Dealer Identifier
PartNumber varchar(25)
SupplierCode varchar(3)
DateGathered datetime Time that record was updated from dealer
Description varchar(30)
OnHand Int
Avail Int
OnOrder Int
OnOrderAvail Int
LastSoldDate date
LastReceivedDate date
LastAdjustmentDate date
ReOrderMethod varchar(1) C = Sales Curve,
F = Force
M = Min/Max
N = Never Order (Force to 0)
F = Force to 1
MinimumQty int
MaximumQty int
Cost money
CurrentActivePrice money
Retail money
OrderUnit varchar(3)
OrderUnitQty int
LastCountDate date
SupersededTo varchar(25)
UPC varchar(30)
Bin1 varchar(30)
Bin2 varchar(30)
Bin3 varchar(30)

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

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,

2017 CDK Global Page 6


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

"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":"",
}
]

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>
<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>
</Part>
</ArrayOfPart>

2017 CDK Global Page 7


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

Unit Major Unit Inventory

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)
NewUsed varchar(1)
ModelYear int 4 digits
Make varchar(30)
Model varchar(30)
VIN varchar(30)
Location varchar(30)
Odometer varchar(30)
Cylinders int
HP decimal
BodyStyle varchar(30)
Color varchar(30)
Condition varchar(30)
Class varchar(2) Dealer specified class code for this unit
CodeName varchar(30) Code name or popular identifier for this unit
InvoiceDate datetime
InvoiceAmt money
TotalCost money InvoiceAmt + FreightCost + PartsCost +
LaborCost
DSRP money
MSRP money
OnHold varchar(40) Deal Number or reason on hold empty string if
not on hold
PackageID varchar(20) Internal Package Identifier
DateReceived datetime
Length decimal
Height decimal
Width decimal
Draft decimal
Beam decimal
GVWR int
GDW Int
InteriorColor varchar(50)
ExteriorColor varchar(50)
Manufacturer varchar(50)
UnitType varchar(50)
FloorLayout varchar(50)

2017 CDK Global Page 8


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

FreightCost money
FuelType varchar(50)
UnitName varchar(50)
HullConstruction varchar(50)
Comments varchar(100)
WebUnit tinyint
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)
UserDefined2 varchar(50)
UserDefined3 varchar(50)
UserDefined4 varchar(50)
UserDefined5 varchar(50)
UserDefined6 varchar(50)
UserDefined7 varchar(50)
UserDefined8 varchar(50)
UserDefined9 varchar(50)
UserDefined10 varchar(50)
UserDefined11 money
UserDefined12 money
UserDefined13 money
UserDefined14 money
UserDefined15 money
UserDefined16 int
UserDefined17 int
UserDefined18 int
UserDefined19 int
UserDefined20 int
UserDefined1desc varchar(50)
UserDefined2desc varchar(50)
UserDefined3desc varchar(50)
UserDefined4desc varchar(50)
UserDefined5desc varchar(50)
UserDefined6desc varchar(50)
UserDefined7desc varchar(50)
UserDefined8desc varchar(50)
UserDefined9desc varchar(50)
UserDefined10desc varchar(50)
UserDefined11desc varchar(50)
UserDefined12desc varchar(50)
UserDefined13desc varchar(50)
UserDefined14desc varchar(50)
UserDefined15desc varchar(50)
UserDefined16desc varchar(50)
UserDefined17desc varchar(50)
UserDefined18desc varchar(50)

2017 CDK Global Page 9


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

Titlestatus varchar(50)
Trimcolor varchar(50)
Unitcondition varchar(50)
Carbcompliance varchar(50)
Drivetype varchar(50)
Enginecycles varchar(50)
Powertype varchar(50)
Starttype varchar(50)
Numacunits int
Sleepcapacity int
Barlength int
Bladelength int
Cuttingwidth int
Videourl varchar(200)
Numslideouts int
Turningradius varchar(50)
UserDefined19desc varchar(50)
UserDefined20desc varchar(50)

Fields Unit.Parts.Part
Field Name Data Type Description, Example
DealerId varchar(20)
Description varchar(50)
SetupInstall varchar(1) S-Setup, I-Install, N-No Labor Attached
Qty int
Cost decimal
Price decimal

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

Fields Unit.Labor
Field Name Data Type Description, Example
DealerId varchar(20)
MajorUnitHeaderId long
MajorUnitLaborId long
Description varchar(50)
SetupInstall varchar(1)
Cost decimal
Price decimal
Subletcost decimal
SubletPrice decimal

2017 CDK Global Page 10


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

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

Example JSON Result


[
{
"TotalCost":1728.6500,
"Cmf":"76024859",
"DealerId":"I013",
"MajorUnitHeaderId":70,
"DateGathered":"2014-03-10T11:48:04.327",
"StockNumber":"H001910",
"NewUsed":"N",
"ModelYear":2009,
"Make":"HONDA",
"Model":"CRF230F8",
"VIN":"9C2ME090X8R001910",
"Class":"D",
"CodeName":"",
"Location":"",
"Odometer":"",
"Cylinders":0,
"HP":0.0000,
"BodyStyle":"",
"Color":"RED",
"Condition":"",
"InvoiceDate":"2010-05-31T00:00:00",
"InvoiceAmt":1187.0000,
"FreightCost":0.0000,
"DSRP":3489.0000,
"MSRP":3649.0000,
"OnHold":"Deal: 57",
"PackageId":0,
"DateReceived":"2010-05-31T00: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":"",
"FloorLayout":"",
"FuelType":"",
"UnitName":"",
"HullConstruction":"",

2017 CDK Global Page 11


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

"Comments":"",
"UnitStatus":"",
"WebUnit":0,
"WebTitle":"2009 HONDA CRF230F8",
"WebDescription":"2009 HONDA CRF230F8",
"WebPrice":3489.0000,
"WebPriceHidden":0,
"Parts":
[
{"Description":"Joes Jacket - Standard Black L"},BATTERY (Y50-
N18L-A)",
{"Description":"CARB REPAIR KITS"},
{"Description":"BEARING AY"}
"SetupInstall":"N",
"Qty":0,
"Cost":65.0000,
"Price":65.0000}
],
"Options":[]
},
{
"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,

2017 CDK Global Page 12


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

"Draft":0.0000,
"Beam":0.0000,
"GVWR":0,
"GDW":0,
"InteriorColor":"",
"ExteriorColor":"",
"Manufacturer":"",
"UnitType":"body type",
"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 : ;

2017 CDK Global Page 13


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

drivetype : ;
enginecycles : ;
powertype : ;
starttype : ;
numacunits : ;
sleepcapacity : ;
barlength : ;
bladelength : ;
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,
"Parts":
[
{"Description":"Misc part"},
{"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", "OptionType":"D"}
],
"Labor":
[
{
DealerId:,
MajorUnitHeaderId:12345678,
MajorUnitLaborId:12345678,
Description:Description,

2017 CDK Global Page 14


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

SetupInstall:S,
Cost:40.00,
Price:60:00,
SubletCost:0.00,
SubletPrice:0.00
}
]

},
]

Example XML Result


<ArrayOfUnit>
<Unit>
<Cmf>76024859</Cmf>
<Beam>0.0000</Beam>
<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>

2017 CDK Global Page 15


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

<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>
<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>

2017 CDK Global Page 16


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

<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>
<MajorUnitHeaderId>265</MajorUnitHeaderId>
<Make>HONDA</Make>
<Manufacturer></Manufacturer>
<Model>modelxyz</Model>
<ModelYear>2013</ModelYear>
<NewUsed>N</NewUsed>
<Odometer>1001</Odometer>
<OnHold></OnHold>

2017 CDK Global Page 17


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

<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>
<SubletCost>0.00</SubletCost>
<SubletPrice>0.00</SubletPrice>
</Labor>
<StockNumber>11012013</StockNumber>
<TotalCost>2250.4200</TotalCost>
<UnitName></UnitName>

2017 CDK Global Page 18


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

<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>
<UserDefined13desc></UserDefined13desc>
<UserDefined14desc></UserDefined14desc>
<UserDefined15desc></UserDefined15desc>

2017 CDK Global Page 19


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

<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>
</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

2017 CDK Global Page 20


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

FinanceDate datetime
FinInvoiceId int Internal ID increments after refinalization
OriginatingDate datetime
TotalPartsAmount money Sum of all parts on deal
Class Varchar(2) Dealer specific class of unit
DealUnitId int
Make Varchar(20)
Model Varchar(20)
Year Varchar(4)
Newused varchar(1) N = new

U = used
UnitPrice money
UnitSoldPrice money Unitprice + freight + handling tradeall +
tradeacv + totaccy + totinstall
VIN Varchar(25)

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

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",
"Units":
[
{"DealUnitId":5161499,
"Newused":"N",
"Year":"2013",
"Make":"HONDA",
"Model":"CRF450RD",
"VIN":"JH2PE0539DK203540",
"Class":"G",
"Unitprice":6653.0000,
"UnitSoldPrice":6653.0000,
"TotalPartsAmount":0.0}
]

2017 CDK Global Page 21


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

}
]

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>
<Units>
<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)
FinInvoiceID int
FinanceDate date

2017 CDK Global Page 22


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

OriginatingDate date
DeliveryDate date Internal ID increments after refinalization
Salesmanid varchar(15)
Clpremium money Sum of all parts on deal
Clcost money Dealer specific class of unit
Ahpremium money
Ahcost money
CustID varchar(12)
Lienholder varchar(90)
DealUnitID long
Newused varchar(2)
Year varchar(4)
Make varchar(20)
Model varchar(20)
VIN varchar(25)
Class varchar(2)
Unitprice money
Mucost money
Freight money
Freightcost money
Handling money
Handlingcost money
Licfees money
LicFeesCost money
Totaccy money
Totinstall money
Tradeall money
Tradeacv money
DateReceived date
Servcont money
Sccost money
Probliab money
Plcost money
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
UnitLine2 money
UnitLine3 money
UnitLine4 money
UnitLine5 money
UnitLine6 money
UnitLine7 money
UnitLine8 money
UnitLine9 money
UnitLine10 money
UnitLine12 money

2017 CDK Global Page 23


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

PartNumber varchar(20)
Suppliercode varchar(3)
Qty int
Cost money
Price money
Retail money
SetupInstall varchar(1)
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
Term int
Rate money
Payment money
SalesmanName varchar
Odometer varchar
Color varchar
DaysToFirst int
Description varchar Part description in Parts child element

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,
"CustID":"10799428",
"lienholder":"NONE",
"SalesmanName":"Joe King",
"AmtFinanced":0,
"Term":120,
"Rate":5.999,

2017 CDK Global Page 24


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

"DaysToFirst":30,
"Payment":0,
"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,

2017 CDK Global Page 25


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

"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,
"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


<ArrayOfDealDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<DealDetail>
<Cmf>76010000</Cmf>

2017 CDK Global Page 26


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

<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>
<Model>VN900BCFA</Model>
<Newused>N</Newused>
<Parts>
<Part>
<DealerId></DealerId>
<Cost>39.9500</Cost>
<PartNumber>410695</PartNumber>
<Price>39.9500</Price>
<Qty>1</Qty>

2017 CDK Global Page 27


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

<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>
<plcost>0.0000</plcost>
<propliab>0.0000</propliab>
<sccost>0.0000</sccost>
<servcont>0.0000</servcont>
<Odometer>1000</Odometer>
<Color>Black</Color>
</Unit>
</Units>

2017 CDK Global Page 28


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

<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>
<AmtFinanced>0</AmtFinanced>
<DaysToFirst>30</DaysToFirst>
<Term>120</Term>
<Rate>5.999</Rate>
<Payment>0</Payment>
<SalesmanName>Joe King</SalesmanName>
</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)
Address2 varchar(50)
Birthdate date
City varchar(50) Internal ID increments after refinalization
Country varchar(30)
County varchar(30) Sum of all parts on deal
CustFullName varchar(50) Dealer specific class of unit
CustomerId bigint
Email varchar(255) Must match [email protected] or
a blank will be returned
FirstName varchar(50)
HasDriversLicenseNumber tinyint
HomePhone varchar(20)
LastName varchar(50)
MiddleName varchar(50)
State varchar(50)
WorkPhone varchar(20)
CellPhone varchar(20)
Zip varchar(10)
DateGathered datetime
CustomerType varchar(50)
LoyaltyCustomer tinyint 0 Not on Loyalty 1 Has Loyalty

2017 CDK Global Page 29


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

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

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
}
]

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>

2017 CDK Global Page 30


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

<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>
<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>
</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
ROUnitID int
ROJobID int
rono varchar(20) RO Number
JobDescription varchar(2000)
JobTitle varchar(75)
InternalJob byte
WarrantyJob byte
VIN varchar(26)
Make varchar(20)
Model varchar(20)
Year varchar(4)
CashieredDate date
PartsPrice money
LaborPrice money

2017 CDK Global Page 31


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

Shopsupply money
MiscPrice money

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

Example JSON Result


[
{"Cmf":"76010001",
"DealerId":"0001",
"ROHeaderID":9158372,
"ROUnitID":9158427,
"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}
}
]

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>

2017 CDK Global Page 32


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

<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>
</ServiceHeadSum>

ServiceDet Service Detail

Fields
Field Name Data Type Description, Example
DealerId varchar(20) Internal Dealer Identifier
Cmf varchar(20) CDK Global Dealer Identifier
ROHeaderID int
rono varchar(20) RO Number
Datein date
Closedate date
Pudate date
CustID bigint
Shopsupply money
MiscCharge1 money
MiscCharge2 money
MiscCharge3 money
MiscCharge4 money
ServiceWriterName varchar(50)
TotsubCost money
TotsubSales money
ROUnitID int
VIN varchar(26)
Make varchar(20)
Model varchar(20)
Year varchar(4)
Engineno varchar(21)
Class varchar(5)
Odometer int
StockNumber varchar(30)
ROJobID int

2017 CDK Global Page 33


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

JobDescription varchar(2000)
JobTitle varchar(75)
InternalJob byte
WarrantyJob byte
ROPartID int
PartNumber varchar(20)
PartDescription varchar(30)
SourceCode varchar(3)
Qty int
Cost money
Price money
ExtPrice money
ROLaborID int
JobDescription varchar(20)
Hours decimal
Rate decimal
Total decimal
ActualHours decimal
TechnicianName varchar(50)
DiscountTotalCharge money
TotalCharge money
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

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

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,

2017 CDK Global Page 34


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

"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,
"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",

2017 CDK Global Page 35


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

"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>
<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>

2017 CDK Global Page 36


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

<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>
<ROJobID>1</ROJobID>
<WarrantyJob>0</WarrantyJob>

2017 CDK Global Page 37


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

<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>

2017 CDK Global Page 38


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

<shopsupply>0.0000</shopsupply>
</ServiceDetail>

InvoiceSum Invoicing Summary

Fields
Field Name Data Type Description, Example
DealerId varchar(20) Internal Dealer Identifier
Cmf varchar(20) CDK Global Dealer Identifier
InvoiceID int
InvoiceNo varchar(9)
InvoiceDate date
salesmanId varchar(5)
Sales money
Salestype varchar(1) M Major Unit; R RO; C - Customer

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

Example JSON Result


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

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>

2017 CDK Global Page 39


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

</InvoiceSum>

InvoiceDet Invoicing Detail

Fields
Field Name Data Type Description, Example
DealerId varchar(20) Internal Dealer Identifier
Cmf varchar(20) CDK Global Dealer Identifier
InvoiceID int
InvoiceNo varchar(9)
InvoiceDate date
Invoicelineno int
Salesmanid varchar(5)
CustID varchar(10)
Price money
Partno varchar(20)
Source varchar(3)
Partdesc varchar(30)
Qty int
Pu int
So int
Lay int
Lost int
Stdprice money

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

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,

2017 CDK Global Page 40


Revised 9/23/2015
Data Warehouse Web Service Developer Guide

"pu":0,
"so":0,
"lay":0,
"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>

2017 CDK Global Page 41


Revised 9/23/2015

You might also like