mi_GetTaxRates [dstore]

Inhaltsverzeichnis

mi_GetTaxRates

mi_GetTaxRates

Gibt alle konfigurierten „TaxRates“ aus. „TaxRates“ repreäsentieren die Steuersätze die im Bezug auf Aufschläge/Rabatte genutzt werden können.

Hinweis : In einer späteren Version ist geplant, daß nur die definierten „TaxRates“ als vordefinierte Eigenschaften zum Artikel-Merkmal „Mehrwertsteuer“ (ID „1“) verwendet werden dürfen.

Anmerkungen zur Rückgabespalte „UseAsFallback“ :
1.) Durch die Prozedur zum Bearbeiten der „TaxRates“ (s. mi_ModifyTaxRates_Ad) ist sichergestellt, daß es nur genau EINEN Datensatz gibt, bei dem hier der Wert „1“ hinterlegt ist.
2.) Im Normalfall sollte der höchste Steuersatz hier den Wert „1“ besitzen.

HTTP-Method	GET
HTTP-Auth	Optional
Tags	[mi, Get, Tax, Rates]
Engine-Kategorie	miscellaneous
Engine-Typ	Daten-Ermittlung
Letzte Aktualisierung	6.0.2 (2011-06-08)

Parameter

Name ¹⁾	Standard-Wert	Beschreibung ²⁾	SQL-Datentyp³⁾	ab Version
TaxRateID	NULL	ID eines Steuersatzes. Angeben, um nur den entsprechenden Datensatz dieses Steuersatzes zu erhalten.	tinyint	6.0.2
OnlyActive	1	„1“ angeben, um nur die aktiven Steuersätze zu erhalten. Anmerkung : Der „Active“-Status hat Engineseitig KEINE Bedeutung und ist daher nur für „Client“-Anwendungen gedacht.	bit	6.0.2

Rückgabe

(parameterunabhängig)

Spaltenname	Beschreibung	SQL-Datentyp⁴⁾	ab Version
TaxRateID	Die ID eines Steuersatzes	tinyint	6.0.2
TaxRate	Der Steuersatz in Prozent	decimal(4,2)	6.0.2
TaxesMultiplier	Steuersatz als Multiplikator, d.h. im Falle von z.B. „TaxRate = 19“ (ergo 19 Prozent) steht hier „1.19“	decimal(16,6)	6.0.2
TaxRateDescription	Die Beschreibung des Steuersatzes (z.B. „Normalsteuersatz“)	varchar(100)	6.0.2
UseAsFallback	Gibt an, ob dieser Steuersatz in speziellen Fällen, wo kein Steuersatz konfiguriert ist und auch nicht „künstlich bestimmt“ werden kann, verwendet werden soll	bit	6.0.2
Active	Gibt an, ob der Steuersatz aktiv ist. Dies ist nur eine Information für „Client-Anwendungen“. Engineseitig gibt es zu dieser Information keine implementierte Funktionalität.	bit	6.0.2

Output-Parameter

Die Prozedur hat keine Output-Parameter.

Mögliche Return-Codes

Die Prozedur hat keine Fehlercodes.

XML-Schema

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

Historie

6.0.2

2011-06-08

Erstmalig 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:

mi_GetTaxRates im Engine Playground öffnen

cURL

Unformatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetTaxRates'

Mit xmllint ⁵⁾ formatierte Ausgabe:

curl -X GET  'http://<partner>-<project>.dstore.de/default/engine/mi_GetTaxRates' | 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'),
	'mi_GetTaxRates',
		array(
			// 'TaxRateID' => NULL,
			// 'OnlyActive' => 1
		)
);
 
$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="mi_GetTaxRates">
			<Parameters>
				<!-- <Parameter Name="TaxRateID">NULL</Parameter> -->
				<!-- <Parameter Name="OnlyActive">1</Parameter> -->
			</Parameters>
		</Procedure>
	</Batch>
</ListOfBatches>

¹⁾

Pflichtparameter sind unterstrichen

²⁾

siehe Parameter-Konventionen engine/<Prozedur-Name>

³⁾ , ⁴⁾

siehe Datentypen im Bereich "engine"

⁵⁾

I.d.R. auf Unix-artigen Systemen bereits installiert, Bestandteil der libxml2, siehe http://www.xmlsoft.org

Benutzer-Werkzeuge

Webseiten-Werkzeuge