Miscellaneous Summary Movement (MSM) Report
In this section, the following information about the MSM (Miscellaneous Summary Movement) report's data is presented:
- MSM Settings in CStoreOffice®
- MSM Data Mapping Table
- XML Example with MSM Data
- MSM Data Export via the Business Documents API
This information becomes accessible through the Business Documents API after shifts are accepted in CStoreOffice®.
MSM Settings in CStoreOffice®
MSM data contains shift summaries by MOPs and events. MSM data can be found in the following forms:
- Shift Totals
- Shift Header
- Shift Summaries by Events and MOPs
- Shift Miscellaneous Summaries, Shorts, Refunds, Voids, and NRGT
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.
MSM Data Mapping Table
MSM data from the above forms is converted to XML data according to the MSM Data Mapping Table which is presented below.
XML Path |
Description |
---|---|
msm:NAXML-MovementReport/ msm:TransmissionHeader/ msm:StoreLocationID |
CSO Location ID. |
msm:NAXML-MovementReport/ msm:TransmissionHeader/ msm:VendorName |
Name of employee who accepted or rejected shift report. |
msm:NAXML-MovementReport/ msm:TransmissionHeader/ msm:VendorModelVersion |
XML version NXML3.4.5. |
msm:MiscellaneousSummaryMovement/ msm:MovementHeader/ msm:ReportSequenceNumber |
Unique ShiftId as shown in CSO form. |
msm:MiscellaneousSummaryMovement/ msm:MovementHeader/ msm:PrimaryReportPeriod |
Primary report period ordinary number, always passed as zero. |
msm:MiscellaneousSummaryMovement/ msm:MovementHeader/msm: SecondaryReportPeriod |
Secondary report period ordinary number, always passed as zero. |
msm:MiscellaneousSummaryMovement/ msm:MovementHeader/ msm:BusinessDate |
The Shift Date field's value. |
msm:MiscellaneousSummaryMovement/ msm:MovementHeader/ msm:BeginDate |
The Date part of the Date From field's value from the Shift form. Indicates beginning of shift as reported by POS. |
msm:MiscellaneousSummaryMovement/ msm:MovementHeader/ msm:BeginTime |
The Time part of the Date From field's value from the Shift form. Indicates beginning of shift as reported by POS. |
msm:MiscellaneousSummaryMovement/ msm:MovementHeader/ msm:EndDate |
The Date part of the Date To field's value from the Shift form. Indicates end of shift as reported by POS. |
msm:MiscellaneousSummaryMovement/ msm:MovementHeader/ msm:EndTime |
The Time part of the Date To field's value from the Shift form. Indicates end of shift as reported by POS. |
msm:MiscellaneousSummaryMovement/ msm:MovementHeader/ msm:Extension/ msm:RecordAction/@type |
Type of action:
|
msm:NAXML-MovementReport/ MiscellaneousSummaryMovement/ msm:MSMDetail |
Block containing MSM report details. |
SUMMARIES SECTION Contains summarized shift data divided by type. All possible codes and their mapping |
|
Fuel Deposit |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, when passing fuel deposit it will have value of summaryTotals. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, when reporting fuel deposid will contain fuelDeposit. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total money amount collected for passed code, for fuel deposit equals to the Fuel Deposit field's value in the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total quantity for passed total, for fuel deposit will be 0. |
Total Sales |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, when passing total sales it will have value of summaryTotals. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, when reporting total sales will contain sales. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total money amount collected for passed code, for fuel deposit equals to the Total Sales field's value in the Shift report. |
MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total quantity for passed total, for total sales will be 0. |
Taxable Sales |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, when passing taxable sales it will have value of totalizers. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, when reporting taxable sales will contain tax. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummary SubCodeModifier |
Additional type of subcode, when reporting taxable sales will contain taxSales. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
The Taxable Sales value received from POS and shown in the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total quantity for passed total, for taxable sales will be 0. |
Tax Collected |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, when passing tax collected it will have value of totalizers. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, when reporting tax collected will contain tax. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummary SubCodeModifier |
Additional type of subcode, when reporting taxable sales will contain taxColl. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
The Tax Collected On value received from POS and shown in the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total quantity for passed total, for taxes collected will be 0. |
Cash Sales |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, when passing cash sales it will have value of summaryTotals. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, when reporting cash sales will contain sales. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummary SubCodeModifier |
Additional type of subcode, when reporting cash sales will contain cash. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total amount of cash sales, contains field with name Value from the Cash Sales form of the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total number of cash sales, value if field Count from the Cash Sales form of the Shift report. |
Paid In |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, when passing Paid In totals it will have value of payins. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, when reporting Paid In totals will contain total. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total amount of Paid In’s, contains value of the Paid In field in the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total quantity for passed total, for Paid In totals will be 0. |
Paid In: Vendor Pay (as comes from CR) |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, when passing Vendor Paid In totals it will have value of payins. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, when reporting Vendor Paid In totals will contain vendorPay. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummary SubCodeModifier |
Empty for Vendor Paid In totals. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Empty for Vendor Paid In totals. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Empty for Vendor Paid In totals. |
Paid In: House Account |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, when passing House Account Paid In totals it will have value of payins. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, when reporting House Account Paid In totals will contain houseAccount. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummary SubCodeModifier |
Name of house accounts. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total income payment from house account in this shift. Amount value from CSO. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Empty for House Account Paid In totals. |
Cash Out (Pay Out) |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, when passing Cash Out totals it will have value of payouts. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, when reporting Cash Out totals will contain total. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Empty for Cash Out totals. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Empty for Cash Out totals. |
Pay Out: Vendor Pay (take from POS) |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, when passing Vendor Pay Out totals it will have value of payouts. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, when reporting Vendor Pay Out will contain vendorPay. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummary SubCodeModifier |
Empty for Vendor Pay Out. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Empty for Vendor Pay Out. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Empty for Vendor Pay Out. |
Cash Paid Out |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, when passing Cash Paid Out it will have value of payouts. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, when reporting Cash Paid Out will contain cash. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total Cash Paid out amount during shift, contains value of field Value from the Cash Paid Out section in the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total numve or Cash Paid Out’s, contains value of Count field from the Cash Paid Out section in the Shift report. |
Department Refunds |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, in this case it will have value of payouts. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, in this case it will have value of deptRefunds. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total amount of Dept Refunds, contains value of field Value from the Dept refunds section in the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total count of Dept Refunds, contains value of field Count from the Dept refunds section in the Shift report. |
Change on Checks |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, in this case it will have value of payouts. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, in this case it will have value of changeOnChecks. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total amount of changes on checks, contains value of field Value from the Change on Checks section in the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total count of changes on checks, contains value of field Count from the Change on Checks section in the Shift report. |
Cash Backs |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, in this case it will have value of payouts. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, in this case it will have value of cashBacks. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total amount of changes on checks, contains value of field Value from the Cash Backs section in the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total count of changes on checks, contains value of field Count from the Cash Backs section in the Shift report. |
Refunds To Prepaids |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, in this case it will have value of payouts. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, in this case it will have value of refundsToPrepaids. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total amount of changes on checks, contains value of field Value from the Refunds To Prepaids section in the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total count of changes on checks, contains value of field Count from the Refunds To Prepaids section in the Shift report. |
Fuel Adjustment |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, in this case it will have value of fuelSalesByGrade. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, in this case it will have value of correction. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total amount fuel adjustments, contains value of the Fuel Adjustment field in the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total quantity for passed total, for fuel adjustments will be 0. |
Total Cash |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, in this case it will have value of balanceOnHand, data about cash in cash drawer. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, in this case it will have value of cash. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total amount of changes on checks, contains value of field Value from the Total Cash section in the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total count of changes on checks, contains value of field Count from the Total Cash section in the Shift report. |
Short/Over |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, in this case it will have value of summaryTotals. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, in this case it will have value of overShort. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total amount of short or over as calculated by CSO and shown in the Short/Over field in the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total quantity for passed total, for short/over will be 0. |
NRGT |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, in this case it will have value of totalizers. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, in this case it will have value of endingGrand to identify NRGT being passed. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
NRGT value received from POS and indicated as the NRGT field in the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total quantity for passed total, for NRGT will be 0. |
Refunds |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, in this case it will have value of refunds. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, in this case it will have value of total to identify refunds total being passed. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total summary of values from Value column of Refunds group from the PLU Sales Report section in the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total summary of values from the Count column of the Refunds group from the PLU Sales Report section in the Shift report. |
No Sales |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, in this case it will have value of statistics. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, in this case it will have value of noSales to identify no sales total being passed. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total amount of no sale transactions, value from Value column of the No Sales record from the Miscellaneous Summary section. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total count of no sale transactions, value from Count column of No Sales record from the Miscellaneous Summary section. |
Transactions |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, in this case it will have value of statistics. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, in this case it will have value of transactions to identify that transaction total being passed. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Amount of transactions is not passed ans equals to 0. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total number of transactions during shift. Count column value for transactions record in the Miscellaneous Summary section in the Shift report |
Voids |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, in this case it will have value of statistics. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, in this case it will have value of voidTransactions to identify that void transaction total being passed. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total amount of Void Transactions. Value column value for Voids record in the Miscellaneous Summary section in the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total number of void transactions during shift. Count column value for Voids record in the Miscellaneous Summary section in the Shift report. |
Cancels (Error Corrections) |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, in this case it will have value of statistics. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, in this case it will have value of correction to identify that error corrections being passed. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total amount of corrections and cancels. Value column for the Cancels record in the Miscellaneous Summary section in the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total amount of corrections and cancels. Count column for Cancels record in the Miscellaneous Summary section in the Shift report. |
Safe Drops |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, in this case it will have value of safeDrop, indication that information belongs to safe drop totals. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, in this case it will have value of total to identify that total for safe drops being passed. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total amount of safe drops made during shift. Value column for the Safe Drops record in the Miscellaneous Summary section in the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total count of safe drops made during shift. Count column for the Safe Drops record in the Miscellaneous Summary section in the Shift report. |
Safe Loans |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, in this case it will have value of safeLoan, indicating that information belongs to safe loan totals. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, in this case it will have value of total to identify that total for safe loan being passed. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total amount of safe loans made during shift. Value column for Safe Loan record in the Miscellaneous Summary section in the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total count of safe loans made during shift. Count column for Safe Loan record in the Miscellaneous Summary section in the Shift report. |
SHIFT TOTALS BY METHOD OF PAYMENT |
|
House Accounts |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, in this case it will have value of methodOfPaymentTotals, indicating that information passed is about MOP totals, used only for house accounts MOP. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, in this case it will have value of houseAccount to identify that sales total being passed for specific MOP. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummary SubCodeModifier |
Empty for this MOP total. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total amount of transactions with house accounts MOP. Value column for the House Accounts section in the Shift report. |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total count of transactions with house accounts MOP (not shown in CSO). |
Other MOPs |
|
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummaryCode |
Code of totals, in this case it will have value of sales, indicating that information passed is about sales totals. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummarySubCode |
Summary subcode for additional summary identification, in this case it will have value of MOP to identify that sales total being passed for specific MOP. |
msm:MSMDetail/ msm:MiscellaneousSummaryCodes/ msm:MiscellaneousSummary SubCodeModifier |
Summary subcode modifier, here used to pass MOP name as configured in the system. Possible values (just as example, full list might be bigger):
|
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryAmount |
Total amount of transactions with MOP passed in the MiscellaneousSummarySubCodeModifier field. Value column for MOP from its section. E.G, for cash MOP: |
msm:MSMDetail/msm:MSMSalesTotals/ msm:MiscellaneousSummaryCount |
Total count of transactions with MOP passed in the MiscellaneousSummarySubCodeModifier field . Count column for MOP from its section. |
To learn more about CStoreOffice® forms and entities mentioned in the Description column, use the MSM Settings in CStoreOffice® section or Petrosoft University Portal.
XML Example with MSM 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 version="1.0"?>
<NAXML-MovementReport version="3.5">
<TransmissionHeader>
<StoreLocationID>2213</StoreLocationID>
<VendorName>Ashley F.</VendorName>
<VendorModelVersion>NXML3.4.5</VendorModelVersion>
</TransmissionHeader>
<MiscellaneousSummaryMovement>
<MovementHeader>
<ReportSequenceNumber>3000029</ReportSequenceNumber>
<PrimaryReportPeriod>1</PrimaryReportPeriod>
<SecondaryReportPeriod>0</SecondaryReportPeriod>
<BusinessDate>2021-08-13</BusinessDate>
<BeginDate>2021-08-13</BeginDate>
<BeginTime>05:48:52</BeginTime>
<EndDate>2021-08-13</EndDate>
<EndTime>13:50:45</EndTime>
<Extension>
<RecordAction type="create"/>
</Extension>
</MovementHeader>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>summaryTotals</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>sales</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>14563.76</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>summaryTotals</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>fuelDeposit</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>0</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>totalizers</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>tax</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier>taxSales</MiscellaneousSummarySubCodeModifier>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>3749.8</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>totalizers</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>tax</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier>taxColl</MiscellaneousSummarySubCodeModifier>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>124.43</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>summaryTotals</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>sales</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier>cash</MiscellaneousSummarySubCodeModifier>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>4284.57</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>276</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>payins</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>vendorPay</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>0</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>payins</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>total</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>0</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>payouts</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>cash</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>0</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>payouts</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>changeOnChecks</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>0</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>payouts</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>cashBacks</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>0</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>payouts</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>refundsToPrepaid</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>30.27</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>2</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>payouts</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>deptRefunds</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>0</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>payouts</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>vendorPay</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>0</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>payouts</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>total</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>0</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>fuelSalesByGrade</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>correction</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>0</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>balanceOnHand</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>cash</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>4254.3</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>274</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>summaryTotals</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>overShort</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>18.3</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>totalizers</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>endingGrand</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>2939612.77</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>refunds</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>total</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>30.27</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>statistics</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>noSales</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>0</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>8</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>statistics</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>transactions</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>0</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>589</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>statistics</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>voidTransactions</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>109</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>7</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>statistics</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>correction</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>55.7</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>8</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>safeDrop</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>total</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>4227</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>55</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>safeLoan</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>total</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>0</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>sales</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>MOP</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier>Debit</MiscellaneousSummarySubCodeModifier>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>4204.78</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>195</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>sales</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>MOP</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier>Cash</MiscellaneousSummarySubCodeModifier>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>3610.8</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>sales</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>MOP</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier>FS</MiscellaneousSummarySubCodeModifier>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>0</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>sales</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>MOP</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier>Credit Card</MiscellaneousSummarySubCodeModifier>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>6245.5</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>126</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>sales</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>MOP</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier>Other Card</MiscellaneousSummarySubCodeModifier>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>1081.55</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>sales</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>MOP</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier>COUPONS</MiscellaneousSummarySubCodeModifier>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>0</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>sales</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>MOP</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier>No Pos</MiscellaneousSummarySubCodeModifier>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>0</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>sales</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>MOP</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier>Lottery Cash</MiscellaneousSummarySubCodeModifier>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>643.5</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>sales</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>MOP</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier>ATM</MiscellaneousSummarySubCodeModifier>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>0</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
<MSMDetail>
<MiscellaneousSummaryCodes>
<MiscellaneousSummaryCode>methodOfPaymentTotals</MiscellaneousSummaryCode>
<MiscellaneousSummarySubCode>houseAccount</MiscellaneousSummarySubCode>
<MiscellaneousSummarySubCodeModifier/>
</MiscellaneousSummaryCodes>
<MSMSalesTotals>
<MiscellaneousSummaryAmount>0</MiscellaneousSummaryAmount>
<MiscellaneousSummaryCount>0</MiscellaneousSummaryCount>
</MSMSalesTotals>
</MSMDetail>
</MiscellaneousSummaryMovement>
</NAXML-MovementReport>
To download the XML Example with MSM Data XML file, click here.
MSM Data Export via the Business Documents API
To export the XML files with the Miscellaneous Summary Movement (MSM) report 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_miscellaneous-summary-movement as the Document type identifier value.
For more information, see Calling the Business Documents API at the Business Unit Level.