Fuel Grade Movement (FGM) report

In this section, the following information about the FGM (Fuel Grade Movement) report's data is presented:

FGM Settings in CStoreOffice®
FGM Data Mapping Tables
XML Example with FGM Data
FGM Data Export via the Business Documents API

This information becomes accessible through the Business Documents API after shifts are accepted in CStoreOffice®.

FGM Settings in CStoreOffice®

FGM (Fuel Grade Movement) report's data contains fuel grade sales, discounts, residuals, book inventory and stick reading for every fuel product. In CStoreOffice®, FGM data can be found in the following forms:

Shift Header
Fuel Sales
Fuel Inventory

These forms can be opened from the CStoreOffice® main page > select a location > Pending shifts > select a shift. For more information, see Understanding Shift Reports.

FGM Data Mapping Table

FGM data from the above forms is converted to XML data according to the FGM Data Mapping Tables which are presented below.

FGM Data Mapping Tables

Report Header

XML Path	Description
NAXML-MovementReport/TransmissionHeader/ StoreLocationID	CSO Location ID.
NAXML-MovementReport/TransmissionHeader/ VendorName	Name of employee who accepted or rejected shift report.
NAXML-MovementReport/TransmissionHeader/ VendorModelVersion	XML version NXML3.4.5.
NAXML-MovementReport/FuelGradeMovement/ MovementHeader/ReportSequenceNumber	Unique ShiftId as shown in CSO form.
NAXML-MovementReport/FuelGradeMovement/ MovementHeader/PrimaryReportPeriod	Primary report period ordinary number, always passed as zero.
NAXML-MovementReport/FuelGradeMovement/ MovementHeader/SecondaryReportPeriod	Secondary report period ordinary number, always passed as zero.
NAXML-MovementReport/FuelGradeMovement/ MovementHeader/BusinessDate	This Shift Date field's value.
NAXML-MovementReport/FuelGradeMovement/ MovementHeader/BeginDate	The Date part of the Date From field value from the Shift form. Indicates the beginning of shift as reported by POS.
NAXML-MovementReport/FuelGradeMovement/ MovementHeader/BeginTime	The Time part of the Date From field value from the Shift form. Indicates the beginning of shift as reported by POS
NAXML-MovementReport/FuelGradeMovement/ MovementHeader/EndDate	The Date part of the Date To field value from the Shift form. Indicates end of shift as reported by POS.
NAXML-MovementReport/FuelGradeMovement/ MovementHeader/EndTime	The Time part of the Date To field value from the Shift form. Indicates end of shift as reported by POS.
NAXML-MovementReport/FuelGradeMovement/ MovementHeader/Extension/RecordAction/@type	Type of action: create: When passed shift is accepted. update: When shift is updated (for example, manually changed or reparsed). delete: When shift is returned to pending.
NAXML-MovementReport/FuelGradeMovement/ FGMDetail	Block represents each fuel grade line of source report, represents single fuel grade.

Report Data

XML Path	CSO Source
/NAXML-MovementReport/FuelGradeMovement/ FGMDetail/FuelGradeID	FuelGradeID for the fuel grade, fuel product identificator in CSO.
/NAXML-MovementReport/FuelGradeMovement/ FGMDetail/FGMNonResettableTotal/ FuelGradeNonResettableTotalVolume	The volume of the fuel grade sold during the time period specified as computed by the non-resettable totalizer for that fuel grade.
/NAXML-MovementReport/FuelGradeMovement/ FGMDetail/FGMNonResettableTotal/ FuelGradeNonResettableTotalAmount	The sum of the value of the fuel grade sold during the time period specified as computed by the non-resettable totalizer for that fuel grade.
/NAXML-MovementReport/FuelGradeMovement/ FGMDetail/FGMSalesTotals/FuelGradeSalesVolume	The quantity of fuel sales associated with the Fuel Sales Movement Report. The Volume column in CSO Shift Report > Sales Summary section.
/NAXML-MovementReport/FuelGradeMovement/ FGMDetail/FGMSalesTotals/FuelGradeSalesAmount	The currency amount of fuel sales associated with the Fuel Sales Movement Report. The Sales column in CSO Shift Report > Sales Summary section.
/NAXML-MovementReport/FuelGradeMovement/ FGMDetail/FGMSalesTotals/PumpTestTotals/ PumpTestAmount	Sum of the value of "pump for test" fuel grade in the reporting period.
/NAXML-MovementReport/FuelGradeMovement/ FGMDetail/FGMSalesTotals/PumpTestTotals/ PumpTestVolume	Volume of "pump for test" fuel grade in the reporting period.
/NAXML-MovementReport/FuelGradeMovement/ FGMDetail/FGMSalesTotals/PumpTestTotals/ ReturnTankID	ID of the tank where the contents of a pump test are put.
/NAXML-MovementReport/FuelGradeMovement/ FGMDetail/FGMSalesTotals/TaxExemptSalesVolume	Always filled with "0".
/NAXML-MovementReport/FuelGradeMovement/ FGMDetail/FGMSalesTotals/DiscountAmount	Fuel grade discount sum, not reflected in FuelGradeSalesAmount, The Shop&Save column in CSO Shift Report > Sales Summary section.
/NAXML-MovementReport/FuelGradeMovement/ FGMDetail/FGMSalesTotals/DiscountCount	Total number of discount transactions associated with the DiscountAmount for the fuel grade being reported. The Shop&Save Volume column in CSO Shift Report > Sales Summary section.
/NAXML-MovementReport/FuelGradeMovement/ FGMDetail/FGMSalesTotals/DispenserDiscountAmount	Fuel manual adjustments for shift.
/NAXML-MovementReport/FuelGradeMovement/ FGMDetail/FGMOutsideSalesSummary/OutsideSalesFlag	Always empty.
/NAXML-MovementReport/FuelGradeMovement/ FGMDetail/FGMOutsideSalesSummary/FGMSalesTotals/ FuelGradeSalesVolume	Fuel grade shift book inventory. The Today's ending book inventory column in the Fuel Inventory form.
/NAXML-MovementReport/FuelGradeMovement/ FGMDetail/FGMOutsideSalesSummary/FGMSalesTotals/ FuelGradeSalesAmount	Always filled with "0".
/NAXML-MovementReport/FuelGradeMovement/ FGMDetail/FGMOutsideSalesSummary/FGMSalesTotals/ PumpTestTotals/PumpTestVolume	Shift ending stick reading. The Today's ending stick reading column in the Fuel Inventory form.

To learn more about CStoreOffice® forms and entities mentioned in the Description and CSO Source columns, use the FGM Settings in CStoreOffice® section or Petrosoft University Portal.

XML Example with FGM Data

The example below is taken from the testing environment with testing data. No association with any real company, product, event, or data is intended or should be inferred.

XML Example with FGM Data


<?xml version="1.0"?>
<NAXML-MovementReport version="3.5">
  <TransmissionHeader>
    <StoreLocationID>10280</StoreLocationID>
    <VendorName>Jessica H.</VendorName>
    <VendorModelVersion>NXML3.4.5</VendorModelVersion>
  </TransmissionHeader>
  <FuelGradeMovement><MovementHeader><ReportSequenceNumber>3000512</ReportSequenceNumber><PrimaryReportPeriod>1</PrimaryReportPeriod><SecondaryReportPeriod>0</SecondaryReportPeriod><BusinessDate>2021-08-15</BusinessDate><BeginDate>2021-08-15</BeginDate><BeginTime>05:35:36</BeginTime><EndDate>2021-08-15</EndDate><EndTime>14:00:46</EndTime><Extension><RecordAction type="create"/></Extension></MovementHeader><FGMDetail><FuelGradeID>1</FuelGradeID><FGMNonResettableTotal><FuelGradeNonResettableTotalVolume>66830.314</FuelGradeNonResettableTotalVolume><FuelGradeNonResettableTotalAmount>166049.23</FuelGradeNonResettableTotalAmount></FGMNonResettableTotal><FGMSalesTotals><FuelGradeSalesVolume>1956.875</FuelGradeSalesVolume><FuelGradeSalesAmount>5550.39</FuelGradeSalesAmount><PumpTestTotals><PumpTestAmount>0.000</PumpTestAmount><PumpTestVolume>0.000</PumpTestVolume><ReturnTankID/></PumpTestTotals><TaxExemptSalesVolume>0</TaxExemptSalesVolume><DiscountAmount>29.17</DiscountAmount><DiscountCount>1</DiscountCount><DispenserDiscountAmount>0</DispenserDiscountAmount><DispenserDiscountCount>0</DispenserDiscountCount></FGMSalesTotals><FGMOutsideSalesSummary><OutsideSalesFlag/><FGMSalesTotals><FuelGradeSalesVolume>8536</FuelGradeSalesVolume><FuelGradeSalesAmount>0</FuelGradeSalesAmount><PumpTestTotals><PumpTestVolume>8577</PumpTestVolume></PumpTestTotals></FGMSalesTotals></FGMOutsideSalesSummary></FGMDetail>
&#x2026;
</FuelGradeMovement>
</NAXML-MovementReport>

To download the XML Example with FGM Data XML file, click here.

FGM Data Export via the Business Documents API

To export the XML files with the Fuel Grade Movement (FGM) report data via the Business Documents API:

Prepare the location (station) or company identifier as the input data.
Start calling the API from the /business-unit-level-resources endpoint.
Use shift_fuel-grade-movement as the Document type identifier value.

For more information, see Calling the Business Documents API at the Business Unit Level.