The report exports sales data for accepted shifts for the previous day. For each day, a separate XML file is generated.
In case there are several shift on the same day, several XML files are generated, one per shift.
XML File Name
The XML file name has the following name structure:
<CStoreOffice®StationID>.<Date>.xml
- CStoreOffice®StationID: The identifier of the station in CStoreOffice® for which the report is generated.
- Date: The transaction date. Date format is YYYYMMDD.
XML File Structure
The report exports the sales data in XML file grouped into several sections. Each section in XML file contains CStoreOffice® data from a certain business area. Each data is enclosed into tags indicating the data parameters.
The XML file with a complete set of data consists of the following sections.
| XML File Section | Related Business Area in CStoreOffice® |
| Header | General Information |
| FuelSales | Fuel Sales |
| FuelInventory | Fuel Inventory |
| Lottery | Lottery |
| MiscellaneousPayout | Miscellaneous Payout |
| Inventory | Inventory |
| StorePurchases | Store Purchases |
| StoreSales | Store Sales |
| DepartmentSales | Department Sales |
| MethodOfPayment | Cash Reconciliation |
| PLUSales | PLU Sales |
| UPCSales | UPC Sales |
| CreditCards | Credit Cards |
| salesTax | Taxation |
The number of sections and data parameters in each XML file may vary depending on the report criteria and real business data on the selected report stations.
XML File Sections' Structure Description
This section contains the detailed description of each parameter in each section of the XML file.
General Information (Header) Section Tags Description
| Tag | Description |
|---|---|
| StationName | Name of the station or store in CStoreOffice® |
| StationId | Unique ID of the station or store in CStoreOffice® |
| SiteCode | The GL.#1 field value from the station setup form in CStoreOffice® |
| SiteBrand | The Brand field value from the station setup form in CStoreOffice® |
| HigherSiteCode | The GL.#2 field value from the station setup form in CStoreOffice® |
| State | The State field value from the station setup form in CStoreOffice® |
| CountryCode | The code value for the station country. |
| Country | The Country field value from the station setup form in CStoreOffice® |
| Coordinates | CStoreOffice® station longitude and latitude values. |
| RegionalManager | The "Regional Manager" location tag value inside the "Regional Manager" root tag selected in the report for this station. |
| Region | The "Region" location tag value inside the "Region" root tag value selected in the report for this station. |
| Division | The Division field value from the station setup form in CStoreOffice® |
| Date | Shift acceptance date |
| OpenDate | Shift start date and time |
| CloseDate | Shift end date and time |
| ShiftId | Shift ID |
| ShiftNumber | Shift number during the day |
| SeqNbr | Shift cash register number |
Fuel Sales (FuelSales) Section Tags Description
| Tag | Description |
|---|---|
| Product | Subarray enclosing information about fuel products |
| ProductID | Unique ID of the fuel product |
| Name | Name of the fuel product |
| Gallons | Total sales volume of the fuel product |
| Amount | Total sales amount of the fuel product |
| Price | Retail price |
| customerCount | Fixed value = 0 |
| LAmount | Total loyalty discount amount for the fuel product |
| ppgDiscount | Fixed value = 0 |
Fuel Inventory (FuelInventory) Section Tags Description
| Tag | Description |
|---|---|
| Product | Subarray enclosing information about fuel products |
| ProductID | Unique ID of the fuel product |
| Name | Name of the fuel product |
| TankId | Unique ID of the tank |
| EndingStickReading | Today’s ending stick reading |
Lottery (Lottery) Section Tags Description
| Tag | Description |
|---|---|
| Online | Online tickets sales (amount) |
| Instant | Instant tickets sales (amount) |
| Paidout | Paid out tickets sales (amount) |
| InstantByTicketValue | Subarray enclosing information about tickets |
| TicketValue | Subarray enclosing information about ticket values |
| Value | Number of instant tickets sold per ticket |
| Amount | Amount of instant tickets sold per ticket |
Miscellaneous Payout (MiscellaneousPayout) Section Tags Description
| Tag | Description |
|---|---|
| MiscellaneousPayout | Subarray enclosing information about payouts |
| CompanyName | Company name according to the received information (expenses) |
| Purpose | Purpose description for each transaction |
| Amount | Total amount for each transaction |
| GLAcctNumber | GL account number for each company inside each transaction |
Inventory (Inventory) Section Tags Description
| Tag | Description |
|---|---|
| Breakage | Total amount of breached items per shift |
| Spoilage | Total amount of spoiled items per shift |
| Markups | Total amount of markups |
| Markdowns | Total amount of markdowns |
| OtherAdjustments | Total for all other adjustments |
| EndingInventory | Total inventory amount |
| OtherAdjustmentsbyCategory | Total amount of non-itemized adjustments for each category |
| CategoryID | Unique ID of the category for which other adjustments are specified |
| CategoryName | Name of the category for which other adjustments are specified |
| Amount | Total amount for other adjustments by category |
Store Purchases (StorePurchases) Section Tags Description
| Tag | Description |
|---|---|
| Invoice | Subarray enclosing information about invoices |
| InvoiceDate | Date of the invoice: - Itemized invoice type: The Invoice Date field value from the Manual Invoice Entry form in CStoreOffice® - Fuel invoice type: The date field value from the Fuel Invoice form in CStoreOffice® - Non-Itemized invoice type: the date fields value from the Non-Itemized Invoice Entry form in CStoreOffice® |
| InvoiceTotal | Total amount for the invoice: - Itemized invoice type: The Total field value from the Manual Invoice Entry form in CStoreOffice® - Fuel invoice type: The Total invoice field value from the Fuel Invoice form in CStoreOffice® - Non-itemzied invoice type: The Today COST field value from the Non-Itemized Invoice Entry form in CStoreOffice® |
| InvoiceMOP | MOP for the invoice |
| InvoiceType | Invoice type. Possible values: - S (Store, or Itemized) - NI (Non-Itemized) - F (Fuel) |
| InvoiceDetail | Subarray enclosing information about invoice details |
| Invoice Number | The Invoice # field value from the invoice form in CStoreOffice® |
| VendorNumber | Vendor account number |
| VendorName | Vendor name: - Supplier (for Fuel invoice type) - Vendor (for other invoice types) |
| LineType | Line type. Possible values: - Product (in this case the quantity of packs for other LineType should be empty) - Charge - Tax |
| Quantity | Quantity. Possible values: - Case QTY (if InvoiceType = Store) - 1 (if InvoiceType = Non-Itemized) - Gross Gallons Delivered (if InvoiceType = Fuel) |
| UnitsInCase | Units in Case. Possible values: - Unit in Case (if InvoiceType = Store) - 1 (if InvoiceType = Non-Itemized or Fuel) |
| CatNO | Category number |
| CategoryDescription | Category description |
| Cost | Cost |
| Retail | Retail. Possible values: - Empty (if LineType is not equal to Product) If LineType equals to Product: - Total Retail (if InvoiceType = Store) - Retail (if InvoiceType = Non-Itemized) - Empty (if InvoiceType = Fuel) |
| GLnumber | GL account number |
| ItemName | Name of invoice position. Possible values: 1) If LineType = Product: - Receipt CR Description (if InvoiceType = Store) - Empty (if InvoiceType = Non-Itemized) - Fuel name (if InvoiceType = Fuel) 2) If LineType = Charge: - Charge name is exported from the Other charges section (if InvoiceType = Store or Fuel) - Empty (if InvoiceType = Non-Itemized) 3) If LineType = Tax: - Product is exported from the Taxes&Services section (if InvoiceType = Fuel) - Empty (if InvoiceType = Store or Non-Itemized) |
| ProductID | Internal CStoreOffice® Product ID |
| TaxService | Tax Service. Possible values: - Empty (if LineType = Product or Charge) |
Store Sales (StoreSales) Section Tags Description
| Tag | Description |
|---|---|
| TotalStore | Total store sales amount |
| DeliSales | Fixed value = 0 |
Department Sales (DepartmentSales) Section Tags Description
| Tag | Description |
|---|---|
| Department | Subarray enclosing information about departments |
| DepartmentId | Unique ID of the department |
| DepartmentName | Department name |
| DepartmentGL | The GL# field value for the department in CStoreOffice® at Price Book > CR Departments > CR Department setup form |
| customerCount | Fixed value = 0 |
| Quantity | Total number of sold items for each department |
| Amount | Total sales amount for each department |
Cash Reconciliation (MethodOfPayment) Section Tags Description
| Tag | Description |
|---|---|
| MethodOfPayment | Subarray enclosing information about MOPs |
| MOPId | Unique ID of the MOP |
| MOPName | Name of the MOP |
| customerCount | Fixed value = 0 |
| Amount | Total amount for the MOP |
PLU Sales (PLUSales) Section Tags Description
| Tag | Description |
|---|---|
| PLU | Subarray enclosing information about PLUs |
| PLUNbr | PLU product code |
| PLUName | Product name (item description) |
| customerCount | Fixed value = 0 |
| Quantity | Sales quantity |
| Amount | Sales amount |
UPC Sales (UPCSales) Section Tags Description
| Tag | Description |
|---|---|
| UPC | Subarray enclosing information about UPCs |
| UPCNbr | UPC product code |
| UPCName | Product name |
| customerCount | Fixed value = 0 |
| Quantity | Sales quantity |
| Amount | Sales amount |
Credit Cards (CreditCards) Section Tags Description
| Tag | Description |
|---|---|
| CreditCard | Subarray enclosing information about credit cards |
| CardId | Unique ID of the credit card |
| CardName | Credit card type name |
| customerName | Quantity |
| Amount | Total amount paid by the credit card |
Taxation (salesTax) Section Tags Description
| Tag | Description |
|---|---|
| tax | Subarray enclosing information about taxes |
| taxID | Unique ID of the tax |
| taxName | Tax name |
| taxRate | Fixed value = 0 |
| taxableAmount | Total taxable sales amount |
| nonTaxableAmount | Total non-taxable sales amount |
| netSalesTax | Fixed value = 0 |
