Xero Sales Export Overview
This document will contain information specific to the Xero 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 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 export 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 |
|---|---|---|
| xerosummary.json | JSON | Encoded summary of the XeroInvoices uploaded to Xero |
Overview
This export template primarily interacts with the Xero API and will upload a draft invoice corresponding to every ZReport found in the DBGen range. These invoices will be configurable to include account mapped line items for:
- Sales data, broken down by main group or group either inclusive or exclusive of adjustments.
- Payment data, broken down by payment type.
- Adjustment data, broken down by adjustment names.
You will have the option of configuring Xero account mappings for the entire breakdown with individual overrides for specific groups/payments/adjustments if required.