Deputy Sales Export Overview
This document will contain information specific to the Deputy sales export template. For general information about the Data Extraction Service and it's API please see the general purpose documentation
Job Run Parameters
This template supports filtering against the DBGen range of finalised sales.
Parameter Definitions
| Parameter | Type | Description |
|---|---|---|
| DBGenFrom | Number (required) | The (inclusive) start of the DBGen range which will be used to filter sales data. |
| DBGenTo | Number (optional) | The (inclusive) end of the DBGen range which will be used to filter sales data. If unspecified the current latest DBGen from the server will be used. |
| TradingDateFrom | DateTime (optional) | The specific trading date to export historical data from if using a manual date range |
| TradingDateTo | DateTime (optional) | The specific trading date to export historical data to if using a manual date range |
TradingDate Usage
TradingDate is designed to be used independent of DBGen range filtering. Specify EITHER a DBGen range OR a TradingDateFrom/To range.
Auto Value Considerations
DBGenFrom supports auto values which (when executing an auto value job run) will update to the value supplied at DBGenTo (or the latest DBGen from the sales data). When DBGenFrom is set to use an auto value it will use the value of the auto value + 1 to ensure that repeated executions will never export already exported sales data.
Output Files
| File | Format | Description |
|---|---|---|
| deputysummary.json | JSON | Encoded summary of the sales processed and metrics uploaded to Deputy |
Overview
This export template primarily interacts with the Deputy API and will upload sales metrics corresponding to every finalised sale found in the DBGen range. Once you have created and connected your DES job to Deputy, these metrics will be configurable to beakdown and map to areas, employees and locations within Deputy. You will have the option of configuring default Deputy mappings as well as individual overrides for specific main group and employee if required.