1 Table of Contents
2 Overview
Price elements display monetary information, including sale- and purchase prices.
2.1 Elements
| Name | Type | Datatype | Example | Default | Description |
|---|
| Amount
| optional
| int
| 1
| 1
| Price entry multiplier.
|
| Type
| required
| string
| BasePrice|Premium
| -
| Identifies the price entry.
|
| VatPercentage
| required
| float
| 17.5
| -
| VAT factor in percent.
|
| Purchase
| required
| element
| -
| -
| Purchase price of the current price entry. Element definition is explained below.
|
| Sale
| required
| element
| -
| -
| Sale price of the current price entry. Element definition is explained below.
|
| MinDate
| optional
| element
| -
| -
| Time frame "from" value. Returned if the price entry features a certain time frame i.e. production profile prices.
|
| MaxDate
| optional
| element
| -
| -
| Time frame "to" value. Returned if the price entry features a certain time frame i.e. production profile prices.
|
2.2 Purchase/Sale element
| Name | Type | Datatype | Example | Default | Description |
|---|
| Currency
| required
| string(3)
| USD
| -
| Three letter ISO currency code. See here.
|
| Net
| required
| float
| 6.54
| -
| Net value, excluding VAT.
|
| Vat
| required
| float
| 1.14
| -
| Calculated VAT.
|
| Gross
| required
| float
| 7.68
| -
| Gross value, including VAT.
|
|
2.3 Example
XML:
<Price xsi:type="TimeFramedPrice">
<Amount>1</Amount>
<Type>BasePrice|Premium</Type>
<VatPercentage>17.5</VatPercentage>
<Purchase>
<Currency>USD</Currency>
<Net>4.67057286</Net>
<Vat>0.82</Vat>
<Gross>5.49057286</Gross>
</Purchase>
<Sale>
<Currency>USD</Currency>
<Net>6.54</Net>
<Vat>1.14</Vat>
<Gross>7.68</Gross>
</Sale>
<MinDate>2010-09-15T00:00:00</MinDate>
<MaxDate>2010-09-15T00:00:00</MaxDate>
</Price>
JSON:
{
"Amount": 1,
"Type": "BasePrice|Premium",
"VatPercentage": 17.5,
"Purchase": {
"Currency": "USD",
"Net": 4.67,
"Vat": 0.82,
"Gross": 5.49
},
"Sale": {
"Currency": "USD",
"Net": 6.54,
"Vat": 1.14,
"Gross": 7.68
},
"MinDate": "2010-09-05T00:00:00",
"MaxDate": "2010-09-15T00:00:00"
}