API

<< Click to Display Table of Contents >>

Navigation:  Import  Export Module >

API

Before using the import/export API the customer must first subscribe to this module, this can be done though the business portal.  There are two important pieces of information that need to be used to execute the API.  They must be copied  from the ImportExport setup.  

 

1. The import export GUID

2. The import export password

 

To set this up first go the the organization screen and select the import export button  This is only available from the dealer management screen.  

 

 Generic Import screen4

 

Pressing the'Import/Export' button will present a screen with the 'login ID' and 'Password'. These must be used in the API function call.  If necessary a new key can be generated by pressing the 'Generate' button.

 

Generic Import screen5

 

 

The link below takes you to the Web services description page.

 

http://cbmssandbox.co.uk/iewebservice/ImportExportWebServiceModern.asmx

 

Web Services

 

The Export Report RawSalesByDateAsJson will export all the transactional data in JSON format.  You can test the export by filling in the parameters shown below and pressing the 'INVOKE' button.  

1. You must use the GUID and password from the previous section.

2. Enter the FromDate in the UK format

3. Enter the ToDate in the UK format

4. UseDateTo must be set to 'True'  this will allow the from and to dates to be active

 

Export API