Mit diesem Request können Sie die aktuell gepflegten Basispreislisten abholen. |
<request method="fetchPricelist" version="1.0.0"> <filter> <mandator_id filter_method="=" filter_value="1"/> <identifier filter_method="=" filter_value="Standard"/> <external_id filter_method="=" filter_value="PL-0064"/> <iso_currency filter_method="=" filter_value="EUR"/> <rounding_id filter_method="=" filter_value="2"/> <gross filter_method="=" filter_value="1"/> </filter> </request> |
Name |
Beschreibung |
Anz. |
Typ |
Sonstiges |
request |
Root-Element der Anfrage |
1 |
Element |
|
method |
Attribut von request. Name der Webservice-Methode. |
1 |
string |
Fester Wert: „fetchPricelist“ |
version |
Attribut von request. Legt die Version der Anfrage fest. |
1 |
integer |
Fester Wert: „1.0.0“ |
filter |
Legt Parameter fest nach denen die Ergebnismenge eingeschränkt wird. Mehrere Filter werden als ODER-Verknüpfung, Elemente innerhalb des Filters als UND-Verknüpfung behandelt. |
1..N |
Element |
|
mandator_id |
Schränkt die Ergebnismenge der Abfrage auf Preislisten eines bestimmten Mandanten ein. |
1 |
Element |
|
filter_method |
Attribut von mandator_id. Legt das Verhalten des Mandanten-Filters fest. |
1 |
string |
Fester Wert: „=“ |
filter_value |
Attribut von mandator_id. Legt den Filterwert des Mandanten-Filters fest. |
1 |
integer |
|
identifier |
Schränkt die Ergebnismenge der Abfrage auf Preislisten mit der angegebenen Bezeichnung ein. |
0..1 |
Element |
|
filter_method |
Attribut von identifier. Legt das Verhalten des Filters fest. |
1 |
string |
Fester Wert: „=“ |
filter_value |
Attribut von identifier. Legt den Filterwert fest. |
1 |
string |
|
external_id |
Schränkt die Ergebnismenge der Abfrage auf die Preisliste mit der angegebenen externen Id ein. |
0..1 |
Element |
|
filter_method |
Attribut von external_id. Legt das Verhalten des Filters fest. |
1 |
string |
Fester Wert: „=“ |
filter_value |
Attribut von external_id. Legt den Filterwert fest. |
1 |
string |
|
iso_currency |
Schränkt die Ergebnismenge der Abfrage von Preislisten auf eine bestimmte Währung ein. |
0..1 |
Element |
|
filter_method |
Attribut von iso_currency. Legt das Verhalten des Filters fest. |
1 |
string |
Fester Wert: „=“ |
filter_value |
Attribut von iso_currency. Legt den Filterwert fest. |
1 |
string |
|
rounding_id |
Schränkt die Ergebnismenge der Abfrage von Preislisten auf einen bestimmten Rundungsmodus ein. |
0..1 |
Element |
Feste Werte. |
filter_method |
Attribut von rounding_id. Legt das Verhalten des Filters fest. |
1 |
string |
Fester Wert: „=“ |
filter_value |
Attribut von rounding_id. Legt den Filterwert fest. |
1 |
integer |
|
gross |
Schränkt die Ergebnismenge der Abfrage von Preislisten auf Brutto- oder Nettopreislisten ein. |
0..1 |
Element |
|
filter_method |
Attribut von gross. Legt das Verhalten des Filters fest. |
1 |
string |
Fester Wert: „=“ |
filter_value |
Attribut von gross. Legt den Filterwert fest. |
1 |
boolean |
<response method="fetchPricelist" version="1.0.0"> <report return_code="0"/> <pricelist> <mandator_id>1</mandator_id> <identifier>Preislistenbezeichnung</identifier> <external_id>Externe ID der Preisliste</external_id> <iso_currency>EUR</iso_currency> <rounding_id>1</rounding_id> <gross>true</gross> <validities> <validity> <identifier>Standard / Aktionspreise</identifier> <valid_from>2017-01-28T00:00:00.000+01:00</valid_from> <!-- Standard hat keinen Gültigkeitszeitraum --> <valid_to>2017-01-29T23:59:59.000+01:00</valid_to> <!-- Standard hat keinen Gültigkeitszeitraum --> <prices> <entry item_nr="ART_87234" price="87.99"/> </prices> </validity> </validities> </pricelist> </response> |
Name |
Beschreibung |
Anz. |
Typ |
Sonstiges |
response |
Root-Element der Antwort |
1 |
Element |
|
method |
Attribut von response. Name der Webservice-Methode. |
1 |
string |
Fester Wert: „fetchPricelist“ |
version |
Attribut von response. Legt die Version der Anfrage fest. |
1 |
string |
Fester Wert: „1.0.0“ |
report |
Information über die ausgeführte Operation. |
1 |
Element |
|
return_code |
Attribut von report. Gibt an, ob in der durchgeführten Operation Fehler aufgetreten sind. |
1 |
integer |
0 = OK. < 0 = Fehler |
error_description |
Falls bei der Durchführung der Operation Fehler aufgetreten sind, wird in error_description eine Fehlerbeschreibung zurück geliefert |
1 |
string |
|
pricelist |
Wrapper-Element, das die Daten einer Preisliste beinhaltet. |
0..N |
Element |
|
mandator_id |
ID des Mandanten. |
1 |
integer |
|
identifier |
Bezeichnung der Preisliste. |
1 |
string |
|
external_id |
Externe ID der Preisliste. |
0..1 |
string |
|
iso_currency |
Währung |
1 |
string |
|
rounding_id |
Rundungsmodus |
1 |
integer |
Feste Werte. |
gross |
Gibt an ob es sich um eine Brutto- oder Nettopreisliste handelt. |
1 |
boolean |
|
validities |
Wrapper-Element, das die Gültigkeitszeiträume der Preisliste zusammenfasst. |
1 |
Element |
|
validity |
Wrapper-Element, das die Informationen zu einem Gültigkeitszeitraum beinhaltet. |
1..N |
Element |
|
identifier |
Bezeichnung des Gültigkeitszeitraumes. |
1 |
integer |
|
valid_from |
Ab diesem Datum ist die Preisliste gültig. |
0..1 |
datetime |
|
valid_to |
Bis zu diesem Datum ist die Preisliste gültig. |
0..1 |
datetime |
|
prices |
Wrapper-Element, das die Artikelpreise zu diesem Gültigkeitszeitraum zusammenfasst. |
1 |
Element |
|
entry |
Element, das einen Artikelpreis beinhaltet. |
1..N |
Element |
|
item_nr |
Attribut von entry. Interne Artikelnummer des Artikels. |
1 |
string |
|
price |
Attribut von entry. Preis des Artikels. |
1 |
decimal |
Value Table - for Field: rounding_id. |
Value |
Description |
---|---|
1 |
"rounded to 2 decimal figures": Commercial rounding (Default) |
2 |
"rounding to 0,99": (Sample: 18,49 € => 17,99 €; 18,50 € => 18,99 €.) |
Version |
Änderungsbeschreibung |
4.6.46 |
Integration des Calls fetchPricelist. |