pixiReport_GrossProfit

Liefert den Rohertragsbericht pro Artikel für einen Rechnungsdatumsbereich mit Verkaufs- und Retourenwerten, optional gefiltert nach Shop, Kategorie, Lieferant, Zahlungsart und Tags.

Stellt den Pixi-Bericht Rohertrag (Report_GrossProfit) als API-Call bereit. Es wird nur die Detailansicht geliefert; der Summenmodus des Berichts ist fest deaktiviert.

Ablauf

1. Die Parameter werden normalisiert: FromDate wird auf den Tagesbeginn, ToDate auf das Tagesende (23:59:59.997) gesetzt. Leere Zeichenketten gelten als NULL; ein TagKey von 0 gilt ebenfalls als nicht gesetzt.
2. Die Parameter werden geprüft. Liegt FromDate nach ToDate oder existiert ein angegebener Shop, eine Kategorie (TontrArten), ein Lieferant, eine Zahlungsart, eine auszuschließende Zahlungsart oder ein Tag nicht, wird eine einzelne Statuszeile mit Status = Error geliefert und der Aufruf beendet.
3. Der Bericht liest Rechnungspositionen, deren Rechnungsdatum zwischen FromDate und ToDate liegt, und wendet die optionalen Filter an:
   • ShopID: nur Positionen dieses Shops.
   • Category: Konfigurationsart des Artikels entspricht der Kategorie.
   • SupplNr: nur Artikel dieses Lieferanten.
   • PaymentType: nur Positionen mit dieser Zahlungsart; ExcludePaymentType: Positionen mit dieser Zahlungsart werden ausgeschlossen.
   • TagKey1–TagKey3: nur Artikel, die alle angegebenen Tags besitzen (UND-Verknüpfung).
4. Die Positionen werden pro Artikel gruppiert, getrennt nach verkauften und retournierten Mengen, und zu einer Zeile pro Artikel zusammengeführt.

Währung

• Ohne ShopID werden alle Beträge (bei aktivierter Mehrwährung) in die Datenbankwährung umgerechnet; Currency enthält den Code der Datenbankwährung.
• Mit ShopID werden die Beträge bei aktivierter Mehrwährung in der Basiswährung des Shops geliefert, sonst wird der Code der Datenbankwährung ausgegeben.

Werte pro Zeile

• Sales_* sind mengengewichtete durchschnittliche Stückwerte der verkauften Positionen (Brutto-Verkaufspreis, MwSt., Lieferantenpreis).
• Returns_* sind die entsprechenden Werte der retournierten Positionen.
• SingleGrossProfit = durchschnittlicher Brutto-VK − durchschnittliche MwSt. − durchschnittlicher EK der verkauften Positionen.
• TotalGrossProfit = Stück-Rohertrag der Verkäufe × verkaufte Menge − Stück-Rohertrag der Retouren × retournierte Menge.

Sonderpositionen wie Versandkosten oder Gutscheine (negative interne Artikelschlüssel) können als eigene Zeilen erscheinen.

Parameter

Antwort

Result-Set 1 · Wenn eine Parameterprüfung fehlschlägt (Datumsbereich oder unbekannter Shop, Kategorie, Lieferant, Zahlungsart oder Tag)

Einzelne Statuszeile mit dem Prüfungsfehler. Der Aufruf endet danach.

Result-Set 2 · Bei Erfolg

Eine Zeile pro Artikel (inklusive Sonderpositionen wie Versandkosten oder Gutscheine) mit Verkaufs-, Retouren- und Rohertragswerten.

<SqlRowSet1>
  <row>
    <ItemNrSupplier>HX-4410</ItemNrSupplier>
    <Barcode>4012345678901</Barcode>
    <ItemName>Trinkflasche Edelstahl 750 ml</ItemName>
    <Supplier>Hydro Supplies GmbH</Supplier>
    <Sales_Quantity>42</Sales_Quantity>
    <Sales_SellingPrice>19.9900</Sales_SellingPrice>
    <Sales_VAT>3.1900</Sales_VAT>
    <Sales_SupplierPrice>7.5000</Sales_SupplierPrice>
    <Returns_SellingPrice>19.9900</Returns_SellingPrice>
    <Returns_Quantity>2</Returns_Quantity>
    <Returns_VAT>3.1900</Returns_VAT>
    <Returns_SupplierPrice>7.5000</Returns_SupplierPrice>
    <SingleGrossProfit>9.3000</SingleGrossProfit>
    <TotalGrossProfit>372.0000</TotalGrossProfit>
    <Currency>EUR</Currency>
  </row>
</SqlRowSet1>

Fehlermeldungen

Beispiele

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://apigateway.descartes.com/tms/pixi/">
  <SOAP-ENV:Body>
    <ns1:pixiReport_GrossProfit>
      <FromDate>2024-01-01T00:00:00</FromDate>
      <ToDate>2024-01-31T00:00:00</ToDate>
      <!-- <ShopID>SHP</ShopID> -->
      <!-- <Category>STANDARD</Category> -->
      <!-- <SupplNr>L1001</SupplNr> -->
      <!-- <PaymentType>R</PaymentType> -->
      <!-- <ExcludePaymentType>V</ExcludePaymentType> -->
      <!-- <TagKey1>12</TagKey1> -->
      <!-- <TagKey2>15</TagKey2> -->
      <!-- <TagKey3>?</TagKey3> -->
    </ns1:pixiReport_GrossProfit>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="https://apigateway.descartes.com/tms/pixi/">
  <SOAP-ENV:Body>
    <ns1:pixiReport_GrossProfit>
      <FromDate>2024-01-01T00:00:00</FromDate>
      <ToDate>2024-01-31T00:00:00</ToDate>
      <!-- <ShopID>SHP</ShopID> -->
      <!-- <Category>STANDARD</Category> -->
      <!-- <SupplNr>L1001</SupplNr> -->
      <!-- <PaymentType>R</PaymentType> -->
      <!-- <ExcludePaymentType>V</ExcludePaymentType> -->
      <!-- <TagKey1>12</TagKey1> -->
      <!-- <TagKey2>15</TagKey2> -->
      <!-- <TagKey3>?</TagKey3> -->
    </ns1:pixiReport_GrossProfit>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
    'FromDate' => '2024-01-01T00:00:00',
    'ToDate' => '2024-01-31T00:00:00',
    // 'ShopID' => 'SHP',
    // 'Category' => 'STANDARD',
    // 'SupplNr' => 'L1001',
    // 'PaymentType' => 'R',
    // 'ExcludePaymentType' => 'V',
    // 'TagKey1' => '12',
    // 'TagKey2' => '15',
    // 'TagKey3' => '?',
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiReport_GrossProfit', $soapArguments);

Verwendete Tabellen

SQL-Objekt:

dbo.pipiReport_GrossProfit

Prozedur zuletzt geändert am 2026-10-05

Dokumentation von claude-opus-5-5 am 2026-10-30 geschrieben