# Price Lists

## Short description

The ERP Cache PriceList interface allows the import of price lists into the ERP Cache. The import can contain multiple price lists.\
\
Prices can be defined in multiple currencies. If no currency is specified then the price will be imported in Euro.

## Delivery method

**Update Frequency**: Batch at least once a day\
**Incremental or complete set:** Incremental

**Filetype:** Zipped XML

**Filename: \[SHOPNAME]\_ErpCache\_PriceLists**\_**\[INDEXNUMBER]**.xml\
**Transport:** over FTPS, FTPS Vendisto server hosted by INTEGRACE, file will be placed on FTPS server by ERP party.

**Location within FTP root:** \ErpCache\\

## Structure XML

### Changes from ErpCache\_**PriceLists** XML 1.0 to 1.1

* An optional currency attribute was added to NettoPricePerItemExclVat and DiscountAmountPerItemExclVat. 
* Added optional PartialImport importsetting

### Changes from ErpCache\_**PriceLists** XML 1.1 to 1.2

* The VatCode field was replaced by VatPercentage

```markup
<?xml version="1.0" encoding="utf-8"?>
<Import>
    <ImportSettings>
        <Importer>ErpCache_PriceLists</Importer>
        <Version>1.2</Version>
        <PartialImport>N</PartialImport>
    </ImportSettings>
    <PriceLists>
        <PriceList>
            <PriceListName></PriceListName>
            <ProductNumber></ProductNumber>
            <VatPercentage></VatPercentage>
            <BaseUnit></BaseUnit>
            <PriceUnit></PriceUnit>
            <QuantityDiscountPrices>
                <QuantityDiscountPrice>
                    <FromQuantity></FromQuantity>
                    <ToQuantity></ToQuantity>
                    <NettoPricePerItemExclVat Currency=""></NettoPricePerItemExclVat>
                    <DiscountAmountPerItemExclVat Currency=""></DiscountAmountPerItemExclVat>
                    <DiscountPercentagePerItem></DiscountPercentagePerItem>
                </QuantityDiscountPrice>
            </QuantityDiscountPrices>
        </PriceList>
    </PriceLists>
</Import>

```

## Fields XML

**Import element:**

<table data-header-hidden><thead><tr><th width="176">Name</th><th width="186">Description</th><th width="150">Type</th><th>Required/Optional</th></tr></thead><tbody><tr><td>Name</td><td>Description</td><td>Type</td><td>Required/Optional</td></tr><tr><td>ImportSettings</td><td>Container element for importsettings</td><td>Element</td><td>Required</td></tr><tr><td>PriceLists</td><td>Container element for PriceList data</td><td>Element</td><td>Required</td></tr></tbody></table>

**ImportSettings element:**

<table data-header-hidden><thead><tr><th width="186">Name</th><th>Description</th><th width="155">Type</th><th>Required/Optional</th></tr></thead><tbody><tr><td>Name</td><td>Description</td><td>Type</td><td>Required/Optional</td></tr><tr><td>Importer</td><td>Name of the importer.<br>Must be ErpCache_PriceLists.</td><td>Text</td><td>Required</td></tr><tr><td>Version</td><td>Version of the import xml. To be used for backward compatibility issues.</td><td>Text,<br>must be 1.2</td><td>Required</td></tr><tr><td>PartialImport</td><td>Defines if the priceslists in the file contain prices for all the articlenumbers in the pricelist or if the prices represent a partial update of the pricelist.</td><td>Boolean,<br>Default N</td><td>Optional</td></tr></tbody></table>

**PriceList element:**

<table data-header-hidden><thead><tr><th width="196">Name</th><th width="189">Description</th><th width="154">Type</th><th>Required/Optional</th></tr></thead><tbody><tr><td>Name</td><td>Description</td><td>Type</td><td>Required/Optional</td></tr><tr><td>PriceListName</td><td>Name of price list</td><td>Text</td><td>Required</td></tr><tr><td>ProductNumber</td><td>The identifier of a product</td><td>Text</td><td>Required</td></tr><tr><td>VatPercentage</td><td>VAT Percentage<br>(%)</td><td>Decimal</td><td>Required</td></tr><tr><td>BaseUnit</td><td>The base unit of the product, eg pce or meter.</td><td>Text</td><td>Required</td></tr><tr><td>PriceUnit</td><td>The quantity on which price is based</td><td>Positive integer</td><td>Required</td></tr><tr><td>QuantityDiscountPrices</td><td>Container element for QuantityDiscountPrice data</td><td>Element</td><td>Required</td></tr></tbody></table>

**QuantityDiscountPrice element:**\
\
Prices can optionally be defined in multiple currencies. The NettoPricePerItemExclVat and DiscountAmountPerItemExclVat elements may therefore occur more then once within a QuantityDiscountPrice element.

<table data-header-hidden><thead><tr><th width="201.0185480575293">Name</th><th width="190">Description</th><th width="155">Type</th><th>Required/Optional</th></tr></thead><tbody><tr><td>Name</td><td>Description</td><td>Type</td><td>Required/Optional</td></tr><tr><td>FromQuantity</td><td>The from quantity where the discount price is valid from</td><td>Positive integer</td><td>Required</td></tr><tr><td>ToQuantity</td><td>The to quantity where the discount price is valid to</td><td>Positive integer</td><td>Optional</td></tr><tr><td>NettoPricePerItemExclVat</td><td>The calculated net price per item.  This is the price including discounts.</td><td>Decimal</td><td>Required</td></tr><tr><td>DiscountAmountPerItemExclVat</td><td>Discount amount on the default net price. This field can be used to give the calculated Discount Amount using a discount percentage. Or just give a discount amount when no discount percentage is used for the calculation.</td><td>Decimal</td><td>Optional</td></tr><tr><td>DiscountPercentagePerItem</td><td>A percentage of the give discount on the default net price per item excluding VAT. When this field is set, the field DiscountAmountPerItemExclVat is required.</td><td>Decimal</td><td>Optional</td></tr><tr><td>Currency</td><td>Attribute on NettoPricePerItemExclVat or DiscountAmountPerItemExclVat. Must contain the ISO 4217 3-letter currency code. Default is EUR.</td><td>Char[3]</td><td>Optional</td></tr></tbody></table>

| Type    | Values                                                                                  |
| ------- | --------------------------------------------------------------------------------------- |
| Boolean | Y, N                                                                                    |
| Decimal | Number with point (.) as decimal separator character. Other separators are not allowed. |