Store Purchases (Invoice) Conexxus Data Mapping
Data in this section is described in accordance with the Conexxus Standard: https://www.conexxus.org/.
In this section, the following information about the Store Purchases data is presented:
- Store Purchases (Invoice) Settings in CStoreOffice®
- Store Purchases (Invoice) Data Mapping Table
- XML Example with Store Purchases (Invoice) Data
- Store Purchases (Invoice) Data Export via the Business Documents API
Store Purchases (Invoice) Settings in CStoreOffice®
Invoices become available through API after acceptance in CStoreOffice®. Invoice XML contains data populated from invoice record in the system, that is available for review in the Invoices Report shown below.
For more information about how to work with the report, go to Invoices Report.
For better understanding, the example with an invoice entry from the image is also added for reference. If some fields provided in XML, such as UPC, do not appear in the Invoices Report , use the Invoice form displayed in the image below for additional clarity.
Store Purchases (Invoice) Data Mapping Table
Data set uses Conexxus 1.5.23 NAXML-BusDocInvoice XSD schema of Retail Merchandise Interface.
Mapping between CStoreOffice® Invoices Report for particular and resulting XML is shown below:
XML Path |
Description |
Invoice Parties |
|
Contains information about invoice parties: Supplier, Buyer and Destination (ShipTo). Supplier here is Vendor, Buyer is a company configured for CStoreOffice® account and ShipTo is CStoreOffice® location. Each party has its own section in resulting XML. |
|
Supplier (Vendor information) |
|
/NAXML-BusDoc/Parties/Supplier/ Name |
Vendor’s Name that invoice was received from. |
/NAXML-BusDoc/Parties/Supplier/ Address |
Vendor’s Address if any, populated from vendor settings. |
/NAXML-BusDoc/Parties/Supplier/ City |
Vendor’s City if any, populated from vendor settings. |
/NAXML-BusDoc/Parties/Supplier/ County |
Vendors County if any, populated from vendor settings. |
/NAXML-BusDoc/Parties/Supplier/ State |
Vendor’s State if any, populated from vendor settings. |
/NAXML-BusDoc/Parties/Supplier/ PostalCode |
Vendor’s Postal Code if any, populated from vendor settings. |
/NAXML-BusDoc/Parties/Supplier/ PostalCodeExt |
Not provided, always empty. |
/NAXML-BusDoc/Parties/Supplier/ CountryCode |
Not provided, always empty. |
/NAXML-BusDoc/Parties/Supplier/Fax |
Vendor’s Fax number if any, populated from vendor settings. |
/NAXML-BusDoc/Parties/Supplier/ Email |
Vendor’s Email address if any, populated from vendor settings. |
/NAXML-BusDoc/Parties/Supplier/ Phone |
Vendor’s Phone number if any, populated from vendor settings. |
/NAXML-BusDoc/Parties/Supplier/ Contact |
Section containing vendor contact details. |
/NAXML-BusDoc/Parties/Supplier/ Contact/ContactType/@role |
Not provided, always empty. |
/NAXML-BusDoc/Parties/Supplier/ Contact/Name |
Vendor contact’s name if any, populated from vendor settings. |
/NAXML-BusDoc/Parties/Supplier/ OrganizationId@ident |
Internal CStoreOffice® Vendor's ID. |
Buyer (company information) |
|
/NAXML-BusDoc/Parties/Buyer/Name |
Buyer company Name as configured for destination location in CStoreOffice®. |
/NAXML-BusDoc/Parties/Buyer/ Address |
Buyer company Address if any configured. |
/NAXML-BusDoc/Parties/Buyer/City |
Buyer company City if any configured. |
/NAXML-BusDoc/Parties/Buyer/ County |
Not provided, always empty. |
/NAXML-BusDoc/Parties/Buyer/State |
Passed only if buyer company State is configured for company otherwise not passed. |
/NAXML-BusDoc/Parties/Buyer/ PostalCode |
Buyer company ZIP code if any configured. |
/NAXML-BusDoc/Parties/Buyer/ PostalCodeExt |
Not provided, always empty. |
/NAXML-BusDoc/Parties/Buyer/ CountryCode |
Not provided, always empty. |
/NAXML-BusDoc/Parties/Buyer/Fax |
Buyer company Fax number if any configured. |
/NAXML-BusDoc/Parties/Buyer/Email |
Not provided, always empty. |
/NAXML-BusDoc/Parties/Buyer/Phone |
Buyer Company Phone number if any configured. |
/NAXML-BusDoc/Parties/Buyer/ Contact |
Not provided, always empty. |
/NAXML-BusDoc/Parties/Buyer/ OrganizationId@ident |
Internal CStoreOffice® buyer company ID. |
ShipTo (destination location information) |
|
/NAXML-BusDoc/Parties/ShipTo/ @ident |
CStoreOffice® Station identifier. Refers to a Location (station) indicated as invoice recipient. |
/NAXML-BusDoc/Parties/ShipTo/ @identType |
Location type as configured in CStoreOffice®, if any. |
/NAXML-BusDoc/Parties/ShipTo/ Name |
Station Name as configured for location in CStoreOffice®. |
/NAXML-BusDoc/Parties/ShipTo/ Address |
Station’s Address as configured for location in CStoreOffice®. |
/NAXML-BusDoc/Parties/ShipTo/City |
City where location address located, as configured for location in CStoreOffice®. |
/NAXML-BusDoc/Parties/ShipTo/ County |
County where location address located, as configured for location in CStoreOffice®. |
/NAXML-BusDoc/Parties/ShipTo/State |
Two letters State where location address located, as configured for location in CStoreOffice®. |
/NAXML-BusDoc/Parties/ShipTo/ PostalCode |
Station’s Zip Code as configured for location in CStoreOffice®. |
/NAXML-BusDoc/Parties/ShipTo/ PostalCodeExt |
Not provided, always empty. |
/NAXML-BusDoc/Parties/ShipTo/ CountryCode |
Not provided, always empty. |
/NAXML-BusDoc/Parties/ShipTo/Fax |
Station’s Fax number as configured for location in CStoreOffice®. |
/NAXML-BusDoc/Parties/ShipTo/Email |
Not provided, always empty. |
/NAXML-BusDoc/Parties/ShipTo/ Phone |
Station’s Phone number as configured for location in CStoreOffice®. |
/NAXML-BusDoc/Parties/ShipTo/ Contact |
Contains details about employee who had accepted invoice. |
/NAXML-BusDoc/Parties/ShipTo/ Contact/ContactType |
The role of employee who had accepted the invoice. Not provided, always empty. |
/NAXML-BusDoc/Parties/ShipTo/ Contact/Name |
The name of employee who had accepted the invoice, contains value of the Accepted By field saved for invoice in CStoreOffice®. |
/NAXML-BusDoc/Parties/ShipTo/ OrganizationId |
Location Id as saved in CStoreOffice®, already provided before. Here is not provided, always empty. |
Invoice data section |
|
Contains all invoice data like line items, totals and payment terms. |
|
General invoice information |
|
NAXML-BusDoc/Invoice/Location/ Name@ident |
CStoreOffice® Station identifier. Refers to a Location (station) indicated as invoice recipient. |
NAXML-BusDoc/Invoice/Location/ Name |
CStoreOffice® Station name. Refers to a Location (station) indicated as invoice recipient. |
NAXML-BusDoc/Invoice/ InvoiceNumber |
The Invoice ID as received from vendor and stored in CStoreOffice®. Contains unique Vendor’s invoice number. |
NAXML-BusDoc/Invoice/InvoiceDate |
Original Invoice Date as stored in CStoreOffice®. |
NAXML-BusDoc/Invoice/ Currency@code |
The Currency of the Invoice. This is the currency configured as account currency in CStoreOffice®. By default, the USD value is used. |
Invoice Details |
|
NAXML-BusDoc/Invoice/InvoiceDetail |
Indicate beginning of invoice details section. |
Line item |
|
NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem |
Indicate beginning of line item section. Separate line item section being added to resulted XML document for each item received with invoice. All line item sections are added to XML in order as they appear in initial invoice. |
NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/@count |
Ordinal number for item line in initial invoice entered in CStoreOffice®. |
Line item cost details |
|
NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/InvoiceUnit |
Indicate beginning of invoice item line details, section contains invoice related details like cost and pack size. |
NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/InvoiceUnit/InvoiceUnitId |
Item's GTIN code created from item code indicated in invoice. Is created based on value of the UPC field of item in invoice. |
NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/InvoiceUnit/InvoiceUnitId/ @identType |
Type of item code provided, always equals to GTIN. |
NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/InvoiceUnit/ InvoiceUnitDescription |
Invoice item name. Contains value of the Description column indicated on Invoices report. That is the same as Item Name indicated on invoice entry form. |
NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/InvoiceUnit/InvoiceUnitQty |
The Total Item Units Quantity in invoice. Calculated as Case Qty*UnitInCase. Contains value of the QTY column on Invoices Report. |
NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/InvoiceUnit/InvoiceUnitQty/ @cstoreUOMBasis |
storeinvoiceitems. measure_unit. |
NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/InvoiceUnit/InvoiceUnitCost |
Cost per unit as indicated for item in invoice, contains value of the Unit Cost column of Invoices Report. Same value indicated on invoice entry form in Unit Cost column. |
NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/InvoiceUnit/InvoiceUnitCost/ @currency |
Same as the Currency of the Invoice in NAXML-BusDoc/Invoice/Currency@code By default, the USD value is used. |
NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/InvoiceUnit/ LineItemGrossAmt |
Calculated Gross Amount for the item by system, equals Total Item Units Quantity * Unit Cost populated from the Extended Cost column in Invoices Report. Same value shown on invoice entry form as Total Cost. |
NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/InvoiceUnit/ LineItemGrossAmt/@currency |
Same as the Currency of the Invoice in NAXML-BusDoc/Invoice/Currency@code By default, the USD value is used. |
NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/InvoiceUnit/LineItemNetAmt |
Net Amount for purchased item, not provided for merchandise invoice items, always 0. |
NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/InvoiceUnit/LineItemNetAmt/ @currency |
Net Amount Currency for purchased item, not provided for merchandise invoice items, always empty. |
Line item retail details |
|
/NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/RetailUnitPricing |
Section contains retail related data for purchased item. |
/NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/RetailUnitPricing/ RetailUnitId/@identType |
Type of item code provided, always equals to GTIN. |
/NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/RetailUnitPricing/ RetailUnitId |
Item GTIN-code created from item code indicated in invoice. Is created based on value of the UPC field of item in invoice |
/NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/RetailUnitPricing/ RetailUnitQty/@identType |
Type of item code provided, always equals to GTIN, always the same as in /NAXML-BusDoc/Invoice/InvoiceDetail/LineItem/ RetailUnitPricing/RetailUnitId/@identType |
/NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/RetailUnitPricing/ RetailUnitQty |
Value indicating how many salable units was purchased in invoice. Equals Case Qty*UnitInCase. Contains value of the QTY column on Invoices Report. |
/NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/RetailUnitPricing/ RetailPrice/@currency |
Same as the Currency of the Invoice in NAXML-BusDoc/ Invoice/Currency@code By default, the USD value is used. |
/NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/RetailUnitPricing/ RetailPrice |
Unit retail price as saved in the system on invoice date. Equals to value in the Retail Price column of Invoices Report. |
Invoice summaries |
|
NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary |
Indicates invoice summaries section beginning. Section contains all invoice totals like merchandise cost, shipping costs, taxes, charges, etc. |
NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceSubTotals |
Indicates subtotals section start. Contains invoice subtotals by CStoreOffice® categories. |
NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceSubTotals/ InvoiceTradeItemClassification |
Section containing subtotals for each item category mentioned in invoice. |
NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceSubTotals/ InvoiceTradeItemClassification/ TradeItemClassificationSystem |
Classification system identifier. In most cases CStoreOffice® classification passed and it has value of “CStoreOffice®”, but also may have the NACS value, if NACS category classification used. |
NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceSubTotals/ InvoiceTradeItemClassification/ TradeItemClassificationId |
Category code or Id in declared classification system. If CStoreOffice® classification used then Category ID will be used. Equals to the Cat No column shown in Invoices Report. |
NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceSubTotals/ InvoiceTradeItemClassification/ TradeItemClassificationId/@identType |
Type of passed value. Always equals to Category. |
NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceSubTotals/ InvoiceTradeItemClassification/ LineItems/@count |
Total number of line items matched with category in invoice (not an items quantity!). |
NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceSubTotals/ InvoiceTradeItemClassification/ CostValue/@currency |
Currency of cost value. Same as the Currency of the Invoice in NAXML-BusDoc/Invoice/ Currency@code By default, the USD value is used. |
NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceSubTotals/ InvoiceTradeItemClassification/ CostValue/@taxIncluded |
Attribute showing if taxes are included into cost or not. |
NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceSubTotals/ InvoiceTradeItemClassification/ RetailInventoryValue/@currency |
Retail Currency Same as the Currency of the Invoice in NAXML-BusDoc/Invoice/ Currency@code By default, the USD value is used. |
NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceSubTotals/ InvoiceTradeItemClassification/ RetailInventoryValue/ |
Total retail of line items in category. Equals to the Retail column value for categories subtotal in Invoices Report. |
Invoice Totals |
|
NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceTotals |
Indicate start of invoice totals section. |
NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceTotals/ TotalInvoiceUnits/@count |
Total units quantity in Invoice. Equals total Quantity for invoice. |
NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceTotals/ TotalLineItemNetAmt |
Total invoice cost without any additional charges, sum of all lite items costs reported in NAXML-BusDoc/Invoice/InvoiceDetail/ LineItem/InvoiceUnit/InvoiceUnitCost, equals invoice total cost shown in Invoices Report. |
NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceTotals/ TotalLineItemNetAmt/@currency |
Same as the Currency of the Invoice in NAXML-BusDoc/Invoice/ Currency@code By default, the USD value is used. |
NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceTotals/ TotalLineItemNetAmt/@identType |
Always reported as “Credit”. |
/NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceTotals/ AllowanceOrCharge |
Indicate beginning of charges and allowances section. Contains data from “Other Charges” section of CStoreOffice® invoice. In case of multiple charges applied, each charge reported as separate section. |
/NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceTotals/ AllowanceOrCharge/ AllowanceOrChargeReason |
The reason of charges. Equals value of the Description field specified for charge in CStoreOffice®. |
/NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceTotals/ AllowanceOrCharge/ AllowanceOrChargeReason/@ident |
Identifier of the reason of charges. Always provided as Other. |
/NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceTotals/ AllowanceOrCharge/ChargeAmt |
Charge Amount added to invoice. Default is “0” All charges summary indicated in accepted invoice: |
/NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceTotals/ AllowanceOrCharge/ ChargeAmt/@currency |
Same as the Currency of the Invoice in NAXML-BusDoc/ Invoice/Currency@code By default, the USD value is used. |
/NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceTotals/ TotalTaxes |
Additional Taxes applied to invoice, equals corresponding field of invoice form. |
NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceTotals/ TotalInvoiceDueAmt |
Total invoice amount calculated as Total Line Items Amounts + Taxes + Charge Amount. |
NAXML-BusDoc/Invoice/InvoiceDetail/ InvoiceSummary/InvoiceTotals/ TotalInvoiceDueAmt/@identType |
Always reported as “Credit”. |
Invoice Terms |
|
NAXML-BusDoc/Invoice/InvoiceDetail/ Terms |
Indicate terms section start. Section contains information about payment terms and method of payment. |
NAXML-BusDoc/Invoice/InvoiceDetail/ Terms/TermsType |
Contains invoice terms of type provided in @ident. CStoreOffice® always report invoice method of payment as value of this field. |
NAXML-BusDoc/Invoice/InvoiceDetail/ Terms/TermsType/@ident |
Terms type ident, always reported as “mop”. |
NAXML-BusDoc/Invoice/InvoiceDetail/ Terms/InvoiceDueDate |
Invoice payment due date if any configured in the terms field. |
NAXML-BusDoc/Invoice/InvoiceDetail/ Terms/Discount |
Contains discounts if any were applied to invoice. Currently reported empty. |
NAXML-BusDoc/Invoice/InvoiceDetail/ Terms/ Discount/@applies |
Indicate if discounts were applied or not, always reported as No. |
NAXML-BusDoc/Invoice/InvoiceDetail/ Terms/Discount/DiscountDueDate |
Not provided, always empty. |
NAXML-BusDoc/Invoice/InvoiceDetail/ Terms/Discount/DiscountAmt |
Not provided, always empty. |
NAXML-BusDoc/Invoice/InvoiceDetail/ Terms/Discount/ InvoiceAfterDiscountNetDueAmt |
Not provided, always empty. |
XML Example with Store Purchases (Invoice) Data
The XML example below contains only one line items. Other items are omitted to save space.
<?xml version="1.0"?>
<NAXML-BusDoc xmlns="http://www.naxml.org/Retail-EDI/Vocabulary/2003-10-16" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="new" xsi:schemaLocation="http://www.naxml.org/Retail-EDI/Vocabulary/2003-10-16 file:///F:/Petrosoft/conexxus/retail-merchandise-interface-V1.5.23-a406d61f7f928daa6fdfe516c41a68a859ad159c/Schemas/NAXML-BusDocInvoice15.xsd">
<TransmissionHeader>
<TransmissionId>0068041407</TransmissionId>
<TransmissionDate>2021-08-15</TransmissionDate>
<TransmissionTime>23:00:00</TransmissionTime>
<TransmissionStatus>original</TransmissionStatus>
</TransmissionHeader>
<Parties>
<Supplier>
<Name>Frito Lay</Name>
<Address>POB 100418</Address>
<City>ATLANTA</City>
<County/>
<State>GA</State>
<PostalCode/>
<PostalCodeExt/>
<Fax/>
<Email/>
<Phone>800-827-0650</Phone>
<Contact>
<ContactType role=""/>
<Name>JOHN JOHNSON</Name>
</Contact>
<OrganizationId ident="749"/>
</Supplier>
<Buyer>
<Name>Buyer1</Name>
<Address/>
<City/>
<State>GA</State>
<PostalCode/>
<PostalCodeExt/>
<Fax/>
<Email/>
<Phone/>
<Contact>
<ContactType role=""/>
<Name/>
</Contact>
</Buyer>
<ShipTo ident="10280" identType="">
<Address/>
<City>WILSON</City>
<County/>
<State>NC</State>
<PostalCode>27896</PostalCode>
<PostalCodeExt/>
<Fax>+1</Fax>
<Email/>
<Phone>2522370480</Phone>
<Contact>
<ContactType role=""/>
<Name/>
</Contact>
</ShipTo>
</Parties>
<Invoice>
<Location>
<Name ident="10280">Location1</Name>
</Location>
<InvoiceNumber>0068041394</InvoiceNumber>
<InvoiceDate>2021-08-15</InvoiceDate>
<Currency code="USD"/>
<InvoiceDetail>
<LineItem count="1">
<InvoiceUnit>
<InvoiceUnitId identType="GTIN">00028400516914</InvoiceUnitId>
<InvoiceUnitDescription>F-L RUFFLES CLASSIC</InvoiceUnitDescription>
<InvoiceUnitQty cstoreUOMBasis="each">1</InvoiceUnitQty>
<InvoiceUnitCost currency="USD">3.1600000</InvoiceUnitCost>
<LineItemGrossAmt currency="USD" identType="Credit">3.16</LineItemGrossAmt>
<LineItemNetAmt>0</LineItemNetAmt>
</InvoiceUnit>
<RetailUnitPricing>
<RetailUnitId identType="GTIN">00028400516914</RetailUnitId>
<RetailUnitQty identType="GTIN">1</RetailUnitQty>
<RetailPrice currency="USD">4.29</RetailPrice>
</RetailUnitPricing>
</LineItem>
<InvoiceSummary>
<InvoiceSubTotals>
<InvoiceTradeItemClassification>
<TradeItemClassificationSystem>CStoreOffice</TradeItemClassificationSystem>
<TradeItemClassificationId identType="Category">1500</TradeItemClassificationId>
<LineItems count="16"/>
<CostValue currency="USD" taxIncluded="Yes"/>
<RetailInventoryValue currency="USD">178.55</RetailInventoryValue>
</InvoiceTradeItemClassification>
</InvoiceSubTotals>
<InvoiceTotals>
<TotalInvoiceUnits count="100"/>
<TotalLineItemNetAmt currency="USD" identType="Credit">120.58</TotalLineItemNetAmt>
<AllowanceOrCharge>
<AllowanceOrChargeReason ident=""/>
<ChargeAmt currency="USD">0</ChargeAmt>
</AllowanceOrCharge>
<TotalTaxes>0</TotalTaxes>
<TotalInvoiceDueAmt identType="Credit">120.58</TotalInvoiceDueAmt>
</InvoiceTotals>
</InvoiceSummary>
<Terms>
<TermsType ident="mop">Credit</TermsType>
<Discount applies="No"/>
</Terms>
</InvoiceDetail>
</Invoice>
</NAXML-BusDoc>
To download the XML Example with Store Purchases (Invoice) Data XML file, click here.
Store Purchases (Invoice) Data Export via the Business Documents API
To export the XML files with the Store Purchases (Invoice) 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 invoice as the Document type identifier value.
For more information, see Calling the Business Documents API at the Business Unit Level.