TyroConnect Sales Export Overview
This document will contain information specific to the tyro connect 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 SalesTransactions.
Parameter Definitions
| Parameter | Type | Description |
|---|---|---|
| DBGenFrom | Number (required) | The (inclusive) start of the DBGen range which will be used to filter SalesTransaction data. |
| DBGenTo | Number (optional) | The (inclusive) end of the DBGen range which will be used to filter SalesTransaction data. If unspecified the current latest DBGen from the server will be used. |
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 |
|---|---|---|
| uploadresults.json | JSON | A simple summary of the uploaded transaction IDs and the total number of pages uploaded to the TyroConnect API. It will NOT cache the uploaded information |
Overview
This export is designed for generating a regular stream of SalesTransactionExport for upload to the TyroConnect sales API.
When this job is run all matching SalesTransaction data will be broken up into multiple pages of SalesTransactionExport (containing a maximum of 50 SalesTransactions) which will be POST individually to the TyroConnect sales API. Each uploaded SalesTransaction can be potentially reuploaded in the event that further modifications are made to the record after it has been closed.