pixiGetCustomersToRefund

Liefert Kunden mit positivem Rückerstattungsvorschlag aus dem Kundenkonto inklusive Saldo, offenen Aufträgen und Abgleichstatus, optional gefiltert nach Shop und Betrag.

Ermittelt, welche Kunden eine Rückerstattung aus ihrem Kundenkonto (CustomerAccount) erhalten sollten.

1. Ein leerer ShopId wird als NULL behandelt. NULL für AmountFrom / AmountTo wird durch 0 / 1000000 ersetzt.
2. Als Kandidaten werden alle Kunden gewählt, deren Kundenkontobuchungen in Summe positiv sind.
3. Für diese Kandidaten berechnet die interne Prozedur Pixi_CA_GetSummaryList je Kunde:
   • FinancialBalance: Summe aller Kundenkontobeträge.
   • OpenOrders: Wert der Auftragspositionen in offenem Status (OrderStates.CA_IsOpenOrder = 1), die noch nicht in einer Rechnung stehen, abzüglich nicht eingelöster Gutscheine und zuzüglich Versandkosten. Berücksichtigt werden nur Aufträge, deren Zahlungsart CA_SubstractFromopenOrdersWhenRefund = 0 hat; negative Werte je Währung werden auf 0 gesetzt.
   • SuggestedRefund: erstattungsfähiger Kontobetrag (Buchungen ohne DoNotRefund sowie der abgeglichene Teil von Buchungen mit DoNotRefund) abzüglich OpenOrders.
   • OpenToMatch: noch nicht abgeglichener Betrag.
   • IsMatched: Abgleichkennzeichen, abgeleitet aus den offenen Abgleichsummen je Währung.
   • CurrencyId: Währung der Werte.
4. Zurückgegeben werden nur Kunden mit SuggestedRefund > 0 und SuggestedRefund zwischen AmountFrom und AmountTo (inklusive). Ist ShopId angegeben, nur Kunden dieses Shops (Customers.CustomerOf); ist IsAccountMatched angegeben, nur Kunden mit passendem IsMatched-Wert.

Eine Sortierung ist nicht definiert; Paging gibt es nicht.

Parameter

Antwort

Result-Set 1 · Immer (kann leer sein).

Eine Zeile je Kunde mit positivem Rückerstattungsvorschlag, der den Filtern entspricht.

<SqlRowSet1>
  <row>
    <CustKey>10452</CustKey>
    <ShopId>SHP</ShopId>
    <IsMatched>true</IsMatched>
    <SuggestedRefund>49.9000</SuggestedRefund>
    <FinancialBalance>49.9000</FinancialBalance>
    <OpenOrders>0.0000</OpenOrders>
    <OpenToMatch>49.9000</OpenToMatch>
    <CurrencyId>1</CurrencyId>
  </row>
  <row>
    <CustKey>10988</CustKey>
    <ShopId>SHP</ShopId>
    <IsMatched>false</IsMatched>
    <SuggestedRefund>15.0000</SuggestedRefund>
    <FinancialBalance>40.0000</FinancialBalance>
    <OpenOrders>25.0000</OpenOrders>
    <OpenToMatch>40.0000</OpenToMatch>
    <CurrencyId>1</CurrencyId>
  </row>
</SqlRowSet1>

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:pixiGetCustomersToRefund>
      <!-- <ShopId>SHP</ShopId> -->
      <!-- <AmountFrom>10.00</AmountFrom> -->
      <!-- <AmountTo>500.00</AmountTo> -->
      <!-- <IsAccountMatched>1</IsAccountMatched> -->
    </ns1:pixiGetCustomersToRefund>
  </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:pixiGetCustomersToRefund>
      <!-- <ShopId>SHP</ShopId> -->
      <!-- <AmountFrom>10.00</AmountFrom> -->
      <!-- <AmountTo>500.00</AmountTo> -->
      <!-- <IsAccountMatched>1</IsAccountMatched> -->
    </ns1:pixiGetCustomersToRefund>
  </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 = [
    // 'ShopId' => 'SHP',
    // 'AmountFrom' => '10.00',
    // 'AmountTo' => '500.00',
    // 'IsAccountMatched' => '1',
];

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

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

Verwendete Tabellen

SQL-Objekt:

dbo.pipiGetCustomersToRefund

Prozedur zuletzt geändert am 2026-10-05

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