ACHTUNG : Diese Prozedur NICHT MEHR VERWENDEN. Die Funktionalität der „Taxes“ ist entfallen. Diese dienten bis einschl. Version 6.0.1 im Zusammenspiel mit „TaxTypes“ (gleichnamige Tabelle) dazu, für Versandkosten und Zahlungskosten feste Steuersätze hinterlegen zu können. Stattdessen werden seit Version 6.0.2 Steuersätze zu einzelnen „Surcharges“ hinterlegt, s. om_GetSurchargeTypeTaxes.
Um die Abwärtskompatibilität zu wahren, wurde diese Prozedur folgendermaßen angepasst :
Wird für „TaxTypeID“ der Wert „1“ angegeben, wird davon ausgegangen, daß es sich um die ehemalige „PaymentTax“ handelt.
Dementsprechend werden die Steuersätze zu den „SurchargeTypeIDs“ zurück gegeben, die der „SurchargeTypeCategorieID = 4“
(„Zahlungskosten“) zugeordnet sind. Analog wird „TaxTypeID = 2“ auf die Kategorie „Versandkosten“ (ID „3“) ge„map“t.
Es kann also ab sofort auch bei „Date = NULL“ mehr als nur einen Datensatz zu einer „TaxTypeID“ geben. Um sie unterscheiden zu können, wurde das Ergebnis dieser Prozedur um die Spalten „SurchargeTypeCategoryID“ und „SurchargeTypeID“ erweitert.
HTTP-Method | GET |
HTTP-Auth | Optional |
Tags | |
Engine-Kategorie | order management |
Engine-Typ | Daten-Ermittlung |
Letzte Aktualisierung | 6.0.2 (2011-06-08) |
Name 1) | Standard-Wert | Beschreibung 2) | SQL-Datentyp3) | ab Version |
---|---|---|---|---|
TaxTypeID | NULL | Wenn nicht „NULL“ angegeben ist, werden diese Werte noch (wg. Abwärtskompatibilität) unterstützt : - „1“ : Steuersätze für „Surcharges“ der Kategorie „Zahlungskosten“ ermitteln - „2“ : Steuersätze für „Surcharges“ der Kategorie „Versandkosten“ ermitteln | tinyint | 3.5.20 |
Date | Ein Zeitpunkt. Die Steuersätze gelten immer für einen bestimmten Zeitraum, und die Prozedur gibt nur die Steuersätze aus, die zu diesem Zeitpunkt gültig sind. | datetime | 3.5.20 |
Spaltenname | Beschreibung | SQL-Datentyp4) | ab Version |
---|---|---|---|
TaxTypeID | Fest codierte Werte : „1“ für Steuern für Zahlungskosten, „2“ für Versandkosten | tinyint | 3.5.20 |
TaxType | Fest codierte Werte : „PaymentTax“ („TaxTypeID = 1“), „ShippingTax“ („TaxTypeID = 2“) | varchar(100) | 3.5.20 |
TaxRate | Der Steuersatz zur Steuerart „TaxTypeID“, der im Zeitraum „ValidFrom“ bis „ValidTo“ für die Aufschlagsart „SurchargeTypeID“ gültig ist - es handelt sich immer um eine Prozent-Angabe | decimal(5,2) | 3.5.20 |
ValidFrom | Der Steuersatz „TaxRate“ gilt AB diesem Zeitpunkt („⇐ Date“ falls angegeben) | datetime | 3.5.20 |
ValidTo | Der Steuersatz „TaxRate“ gilt BIS zu diesem Zeitpunkt („> Date“ falls angegeben) | datetime | 3.5.20 |
SurchargeTypeID | ID einer Aufschlagsart, zu dem der Steuersatz „TaxRate“ im Zeitraum „ValidFrom“ bis „ValidTo“ hinterlegt ist/war | smallint | 6.0.2 |
SurchargeTypeCategoryID | ID einer Kategorie für Aufschlagsarten („4“ für „Zahlungskosten“ wenn „TaxTypeID = 1“, „3“ für „Versandkosten“ wenn „TaxTypeID = 2“) | tinyint | 6.0.2 |
Die Prozedur hat keine Output-Parameter.
Die Prozedur hat keine Fehlercodes.
Die Rückgabe erfolgt als XML-Dokument welches gegen das Schema Response/EngineProcedure_v1_0.xsd validiert.
6.0.2 | 2011-06-08 | 1. Durch das Entfernen der Tabellen „Taxes“ und „TaxTypes“ ist diese Prozedur aus Abwärtskompatibilitätsgründen angepasst und als „deprecated“ markiert worden. 2. Neue Rückgabespalten „SurchargeTypeCategoryID“ und „SurchargeTypeID“ |
3.5.20 | 2002-07-22 | Erstmalig in dieser Version erstellt |
Der folgende Link öffnet in einem separaten Fenster den Engine Playground der fest mit dem dbap-demo System verbunden ist:
Unformatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetTaxes?Date=<value>'
Mit xmllint 5) formatierte Ausgabe:
curl -X GET 'http://<partner>-<project>.dstore.de/default/engine/om_GetTaxes?Date=<value>' | xmllint --format -
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_GetTaxes', array( 'Date' => <value>, // 'TaxTypeID' => NULL ) ); $service->execute($request); $xml_result = $request->getResponse()->getBody()->toSimpleXmlDocument(); $ResultSet = $xml_result->getRowsAsArray();
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_GetTaxes"> <Parameters> <Parameter Name="Date"><!-- datetime value --></Parameter> <!-- <Parameter Name="TaxTypeID">NULL</Parameter> --> </Parameters> </Procedure> </Batch> </ListOfBatches>