Benutzer-Werkzeuge

Webseiten-Werkzeuge


engine:procedures:om_getordersurcharges_pu

om_GetOrderSurcharges_Pu

Gibt Aufschläge bzw. Rabatte (z.B. Versandkosten oder Auftrags-Rabatte) für einen Auftrag zurück, falls der Auftraggeber identifiziert werden kann.

Hinweis :

Im Ergebnis ist eine „Kopf“- und eine „Summen“-Zeile enthalten, die an „PositionNo = 0“ bzw. „PositionNo = 255“ zu
erkennen ist. „SurchargeTypeID“ enthält den Wert „-1“, in der „SurchargeTypeDescription“ steht „INPUT DATA“ bzw. „SUM“ und die beiden „Absolute…Surcharge“-Spalten enthalten …

  • für die Kopfzeile den Warenwert (Netto und Brutto) des Auftrags, wobei nur Positionen berücksichtigt werden, die NICHT in

einem Status der Kategorie „Surcharge-Neuberechnung“ sind
… und …

  • für die Summenzeile eine Summe (Netto und Brutto), die aus dem Warenwert des Auftrags (Positionen, die NICHT im Status der Kategorie „Surcharge-Neuberechnung“ sind) plus sämtlichen „Surcharges“ besteht.

„CategoryDescription“ enthält in der Kopfzeile den Erläuterungs-Text „sum of order content“, in der Summenzeile steht
„sum of order content and surcharges“. Alle anderen Spalten enthalten „NULL“.

Anmerkung zum Parameter „SplitByTaxes“ :

Im Standard-Fall wird eine Aufschlüsselung nach Steuersätzen zurückgegeben, man kann aber auch „SplitByTaxes = 0“ angeben, dann erhält man pro „PositionNo“ genau EINEN Datensatz, wobei der „TaxesMultiplier“ dann „NULL“ ist und die „Absolute..Surcharge“-Spalten eine Summe enthalten (falls nur ein Steuersatz in einer Position vorhanden ist, kommt natürlich
derselbe Wert wie im Fall „SplitByTaxes = 1“ heraus).
Ist man sowohl an einer „Positions-Summe“ als auch einer Aufschlüsselung nach Steuersätzen interessiert, übergibt man „2“ für
„SplitByTaxes“ und erhält pro „PositionNo“ eine Zeile mit „NULL“ für „TaxesMultiplier“ (für die Summe) und soviel weitere
Datensätze wie es „TaxesMultiplier“ für die Position gibt.

HTTP-MethodGET
HTTP-AuthOptional
Tags
Engine-Kategorieorder management
Engine-TypDaten-Ermittlung
Letzte Aktualisierung7.0.7 (2015-01-29)

Parameter

Name 1) Standard-Wert Beschreibung 2) SQL-Datentyp3) ab Version
OrderID ID eines Auftrags im „dStore“, zu der die „Surcharges“ ermittelt werden sollen
integer6.0.2
PersonIdentificationValues Liste (durch '¶' getrennt) von Werten, die den Auftraggeber identifizieren. Diese Werte müssen Eigenschaften zu den Merkmal-IDs sein, die in „PersonTypeSettings“ zur „PersonTypeID“ zum Schlüssel „PersonIdentificationIDs“ hinterlegt sind.
varchar(255)6.0.2
PersonTypeID ID des Personen-Typs dem die zu identifizierende Person angehört. Dieser muß bei einer Identifizierung immer mit angegeben werden, da die Merkmale zur Identifizierung pro Personentyp variieren können.
tinyint6.0.2
GetAdditionalInfo0 Gibt man „1“ an, enthält das Ergebnis weitere Spalten die zusätzliche Informationen zum jeweiligen „Surcharge“ enthalten
bit6.0.2
SplitByTaxes0 Soll das Ergebnis nach Steuersätzen aufgeschlüsselt werden ?
- „0“ : Nein, nur eine Summe pro „Surcharge“-Position
- „1“ : Ja
- „2“ : Sowohl eine Summe als auch eine Aufschlüsselung
tinyint6.0.2

Rückgabe

wenn GetAdditionalInfo = 0

Spaltenname Beschreibung SQL-Datentyp4) ab Version
PositionNo(Eindeutige) Positions-Nummer eines „OrderSurcharges“. Gibt die Reihenfolge an, in der die „Surcharges“ errechnet wurden. Hinweis : Es gibt einen Datensatz mit „0“ für eine „Kopf“- und „255“ für eine „Summen“-Zeile.
tinyint6.0.2
SurchargeTypeIDDie ID einer Aufschlags- bzw. Rabattart wie z.B. „Versandkosten“, „Rabatt“, „Nachnahmegebühr“ o.ä.
smallint6.0.2
SurchargeTypeDescriptionBezeichnung der „SurchargeTypeID“
varchar(100)6.0.2
SurchargeTypeCategoryIDID einer Kategorie von „Surcharges“, der „SurchargeTypeID“ zugeordnet ist Anmerkung : Es ist eine 1:1-Zuordnung, d.h. die „SurchargeTypeID“ muß einer Kategorie zugeordnet sein, sie kann aber auch nicht mehreren Kategorien zugeordnet sein !
tinyint6.0.2
CategoryDescriptionBezeichnung von „SurchargeTypeCategoryID“
varchar(100)6.0.2
TaxesMultiplierMehrwertsteuer als „Multiplikator“ („AbsoluteNetSurcharge“ hiermit multipliziert ergibt „AbsoluteGrossSurcharge“). Hinweis : Wenn „0“ oder „2“ für „SplitByTaxes“ angegeben ist, kommt hier pro „PositionNo“ (auch) ein Datensatz mit „NULL“ zurück.
decimal(16,6)6.0.2
AbsoluteGrossSurchargeBRUTTO-Abschlag oder -Aufschlag in der Währung des Auftrags (→ „CurrencyID“)
money6.0.2
AbsoluteNetSurchargeNETTO-Abschlag oder -Aufschlag in der Währung des Auftrags (→ „CurrencyID“)
money6.0.2
CurrencyIDID der Währungs-Einheit des Auftrags „OrderID“
tinyint6.0.2
CurrencySymbolSymbol (im Regelfall der ISO-Code) der (Währungs-)Einheit „CurrencyID“
varchar(10)6.0.2
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • PositionNo (aufsteigend)
  • TaxesMultiplier (aufsteigend)

wenn GetAdditionalInfo = 1

Spaltenname Beschreibung SQL-Datentyp5) ab Version
PositionNo(Eindeutige) Positions-Nummer eines „OrderSurcharges“. Gibt die Reihenfolge an, in der die „Surcharges“ errechnet wurden. Hinweis : Es gibt einen Datensatz mit „0“ für eine „Kopf“- und „255“ für eine „Summen“-Zeile.
tinyint6.0.2
SurchargeTypeIDDie ID einer Aufschlags- bzw. Rabattart wie z.B. „Versandkosten“, „Rabatt“, „Nachnahmegebühr“ o.ä.
smallint6.0.2
SurchargeTypeDescriptionBezeichnung der „SurchargeTypeID“
varchar(100)6.0.2
SurchargeTypeCategoryIDID einer Kategorie von „Surcharges“, der „SurchargeTypeID“ zugeordnet ist Anmerkung : Es ist eine 1:1-Zuordnung, d.h. die „SurchargeTypeID“ muß einer Kategorie zugeordnet sein, sie kann aber auch nicht mehreren Kategorien zugeordnet sein !
tinyint6.0.2
CategoryDescriptionBezeichnung von „SurchargeTypeCategoryID“
varchar(100)6.0.2
TaxesMultiplierMehrwertsteuer als „Multiplikator“ („AbsoluteNetSurcharge“ hiermit multipliziert ergibt „AbsoluteGrossSurcharge“). Hinweis : Wenn „0“ oder „2“ für „SplitByTaxes“ angegeben ist, kommt hier pro „PositionNo“ (auch) ein Datensatz mit „NULL“ zurück.
decimal(16,6)6.0.2
AbsoluteGrossSurchargeBRUTTO-Abschlag oder -Aufschlag in der Währung des Auftrags (→ „CurrencyID“)
money6.0.2
AbsoluteNetSurchargeNETTO-Abschlag oder -Aufschlag in der Währung des Auftrags (→ „CurrencyID“)
money6.0.2
CurrencyIDID der Währungs-Einheit des Auftrags „OrderID“
tinyint6.0.2
CurrencySymbolSymbol (im Regelfall der ISO-Code) der (Währungs-)Einheit „CurrencyID“
varchar(10)6.0.2
OriginalSurchargeValueInformation zur Informations-Art „AppliedSurchargeValue“ (ID „-1“), gibt also den konfigurierten „Surcharge“-Wert an (kann ja z.B. ein Prozent-Wert sein), der angewandt wurde. Anmerkung : Bei Aufträgen VOR 6.0.2 (Mai/Juni 2011) immer „NULL“.
decimal(16,6)6.0.2
OrigSurchValIsAbsoluteGibt an, wie „OriginalSurchargeValue“ zu verstehen ist :
„0“ : Es ist eine relative Angabe
„1“ : Es ist eine absolute Währungs-Angabe in der Einheit „OrigSurchValUnitID“, und zwar ein NETTO-Wert
„2“ : Wie „1“ nur als BRUTTO-Wert zu verstehen
tinyint6.0.2
OrigSurchValUnitIDID der Einheit, in der „OriginalSurchargeValue“ angegeben ist. Im Fall „OrigSurchValIsAbsolute = 0“ ist dies immer die „Prozent“-Einheit, ansonsten eine Währungs-Einheit (die aber nicht unbedingt mit „CurrencyID“, der Währung des Auftrags, übereinstimmt).
tinyint6.0.2
OrigSurchValUnitSymbolSymbol der Einheit „OrigSurchValUnitID“ (z.B. „%“ oder „EUR“)
varchar(10)6.0.2
AppliedOnGrossSumInformation zur Informations-Art „SurchargeAppliedOnGrossSum“ (ID „-2“). Gibt an, auf welchen Brutto-Betrag der „Surcharge“ angewandt wurde (insbesondere bei relativen „Surcharges“ relevant, um das Ergebnis nachvollziehen zu können).
money6.0.2
AppliedOnNetSumInformation zur Informations-Art „SurchargeAppliedOnGrossSum“ (ID „-2“). Gibt an, auf welchen Netto-Betrag der „Surcharge“ angewandt wurde (insbesondere bei relativen „Surcharges“ relevant, um das Ergebnis nachvollziehen zu können).
money6.0.2
Sortierung der Rückgabe

(parameterunabängige Sortierung)

  • PositionNo (aufsteigend)
  • TaxesMultiplier (aufsteigend)

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Code Beschreibung Quelle 6)
-660Identifikation fehlgeschlagennur indirekt
-621Fehlender oder falscher Eintrag in PersonTypeSettingsnur indirekt
-599Lizenz ist ungültig oder abgelaufennur indirekt
-569Der Benutzer hat kein Ausführungsrecht für die Prozedurnur indirekt
-567Die Prozedur darf z. Zt. nicht ausgeführt werdennur indirekt
-566Die Prozedur darf mit den übergebenen Parametern nicht ausgeführt werdennur indirekt
-535Das Datum liegt nicht in der Vergangenheitnur indirekt
-530Der Wert ist nicht konvertierbarnur indirekt
-510Der Benutzer ist nicht registriertnur indirekt
-504Es ist ein Problem aufgetreten, das nicht gelöst werden kann, Prozedur wird daher abgebrochennur indirekt
-502Die Parameter-Werte der Prozedur können nicht verarbeitet werden (kein passendes Trennzeichen)nur indirekt
-500Falsche Parameterdirekt und indirekt
-343Nicht öffentliche Informationen zum Auftrag können nur vom Auftraggeber/Administrator erfragt werdennur direkt
-283Der Benutzer hat keine Berechtigung, Eigenschaften zu diesem(n) Merkmal(en) zu ermittelnnur indirekt

XML-Schema

Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.

Historie

7.0.7 2015-01-29„Start-/Finish-Procedure“-Logik eingebaut, s. Ticket #3670
6.0.2 2011-06-08Erstmalig in dieser Version erstellt

Code-Snippets

Engine Playground

Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetOrderSurcharges_Pu?OrderID=<value>&PersonIdentificationValues=<value>&PersonTypeID=<value>'

Mit xmllint 7) formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/om_GetOrderSurcharges_Pu?OrderID=<value>&PersonIdentificationValues=<value>&PersonTypeID=<value>' | xmllint --format -
dStore_php
use dStore_php\WebService;
 
$service = new WebService\Service( WebService\Scheme::HTTP,'<partner>-<project>.dstore.de', 80);
 
$request = new WebService\Requests\Engine\Procedure\Request(
			new WebService\Requests\AccessData('default'),
	'om_GetOrderSurcharges_Pu',
		array(
			'OrderID' => <value>,
			'PersonIdentificationValues' => '<value>',
			'PersonTypeID' => <value>,
			// 'GetAdditionalInfo' => 0,
			// 'SplitByTaxes' => 0
		)
);
 
$service->execute($request);
 
			$xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument();
			$ResultSet = $xml_result->getRowsAsArray();
engine/execute

XML zur Ausführung mit der Methode engine/execute, z.B. per

curl --header 'Content-Type: application/xml' -X POST 'http://<partner>-<kunde>.dstore.de/default/engine/execute' -d '<xml-daten>'
<?xml version="1.0" encoding="UTF-8"?>
<ListOfBatches>
	<Batch No="0">
		<Procedure Name="om_GetOrderSurcharges_Pu">
			<Parameters>
				<Parameter Name="OrderID"><!-- integer value --></Parameter>
				<Parameter Name="PersonIdentificationValues"><!-- varchar value --></Parameter>
				<Parameter Name="PersonTypeID"><!-- tinyint value --></Parameter>
				<!-- <Parameter Name="GetAdditionalInfo">0</Parameter> -->
				<!-- <Parameter Name="SplitByTaxes">0</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>
1)
Pflichtparameter sind unterstrichen
6)
direkt meint „von der Prozedur selber“ und indirekt meint „von intern aufgerufenen Unterprozeduren“
7)
I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org
engine/procedures/om_getordersurcharges_pu.txt · Zuletzt geändert: 11.01.2016 (Externe Bearbeitung)