Indicater Export Overview
This document will contain information specific to the Indicater 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 ZReports. Only sales data belonging to ZReports in the specified DBGen range will considered during a jobrun.
Parameter Definitions
| Parameter | Type | Description |
|---|---|---|
| DBGenFrom | Number (required) | The (inclusive) start of the DBGen range which will be used to filter ZReports and their sales data. |
| DBGenTo | Number (optional) | The (inclusive) end of the DBGen range which will be used to filter ZReports and their sales data. If unspecified the current latest DBGen from the server will be used. |
| TradingDate | DateTime (optional) | The specific trading date to rexport historical data |
TradingDate Usage
TradingDate is designed to be used independent of DBGen range filtering. Specify EITHER a DBGen range OR a TradingDate.
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 |
|---|---|---|
| sales.csv | CSV | Encoded itemised sales data uploaded to the designated FTP storage location using the file name OutletID_DateTime.csv. Example: b9a69497-4911-4753-9c36-9b39a70be5bf_2023-03-27-09-33-47.csv |
Overview
This export template primarily interacts with the Indicater API and will create a send sales and stock usage data corresponding to every finalised ZReport found in the DBGen range. The following fields are included:
| Field | Description | Example |
|---|---|---|
| ID | The Unique identifier for this record. | 122a0af8-7dd8-4f5f-9839-99924a56be2b |
| OutletRef | The Unique identifier for outlet that generated this sale. | b9a69497-4911-4753-9c36-9b39a70be5bf |
| Outlet Name | The name of the outlet that generated this sale | My Outlet |
| Incomecategory Code | The Unique identifier for the main group that this sale belongs to | b68ba144-5301-43a7-a98e-f00d2106b154 |
| Incomecategory | The name of the main group that this sale belongs to | Bev |
| Date | The trading date for this sale dd/MM/yyyy | 25/10/2022 |
| TransID | The unique ID of the sales transaction that this sale belongs to | 34c9942c-0434-46e0-b72e-fa508b49002d |
| Recipe Reference | A unique ID for this sale item using the format [SalesModifierPrefix]_[PLUID] | PINT_ec48002b-21dc-42e7-82ac-47bd6cde2123 |
| Dish Name | The SalesTransactionItem's ModifierPrefix and ItemDescription | PINT Coopers Ale |
| QuantityConsumed | The integer based quantity of product to consume | 2 |
| GrossSales | The gross sales amount for this line item | 12.00 |
| Discount | The amount of discount or surcharge applied to this sale item | 0.00 |
| VAT | The total amount of inclusive tax (VAT) applied to this sale item | 2.00 |
| NetSales | The net sales amount for this line item (gross - tax) | 10.00 |