pixiGetCAEventsAndReminders

Liefert Kundenkonto-Ereignisse (Rechnungen, Ausgleiche/Zahlungen, Mahnungen und virtuelle Vollzahlungs-Ereignisse) eines Shops in einem Zeitraum inkl. Saldo und Mahnstufen.

Sammelt alle Kundenkonto-Ereignisse der Kunden des Shops ShopId in einem Zeitraum und liefert sie als gemeinsame Ereignisliste. Mahnungsversand und vollständige Bezahlung von Rechnungen werden als zusätzliche Ereignisse behandelt.

Zeitraum

• Ist StartDate NULL, beginnt der Zeitraum am Ersten des aktuellen Monats. Andernfalls beginnt er um 00:00 Uhr von StartDate.
• Ist EndDate NULL, endet der Zeitraum am Ende des heutigen Tages. Andernfalls endet er um 23:59:59.997 von EndDate.

Erfasste Ereignisarten

1. Rechnungsereignisse: Einträge in CustomerAccount mit EventID = 'INV', deren EventDate im Zeitraum liegt. EventKey = CAE_<CustomerAccountKey>.
2. Mahnungsereignisse: Mahnungen (Reminders verknüpft mit ReminderLines), deren ReminderSentDate im Zeitraum liegt. Sie werden mit EventID = 'REM' geliefert. Der Betrag ist der negative Wert aus Mahnsumme minus Mahnkosten, ReminderLevel stammt aus der Mahnposition. EventKey = REM_<ReminderKey>.
3. Ausgleichsereignisse: Datensätze in CustomerAccountMatch, die im Zeitraum angelegt wurden und einen Rechnungseintrag (EventID = 'INV') mit einem anderen Kundenkontoeintrag verknüpfen. Beide Verknüpfungsrichtungen werden berücksichtigt. Die Zeile trägt EventID und EventDate des Gegeneintrags (z. B. einer Zahlung). Der Betrag ist der absolute Ausgleichsbetrag, EventUpdateDate das Anlagedatum des Ausgleichs. EventKey = CAM_<CustomerAccountMatchKey>.
4. Virtuelle Vollzahlungsereignisse: Für eine Rechnung eines gelieferten Kunden, deren Ausgleiche bis EndDate genau die Rechnungssumme ergeben, wird ein virtuelles Ereignis mit EventID = 'REM' und Betrag 0 erzeugt. Sein Datum ist das letzte Ausgleichsdatum plus 1 ms. Der Kunde muss zusätzlich mindestens ein Ausgleichsereignis im Zeitraum haben, und das Ereignis entfällt, wenn sein Datum vor dem Zeitraumbeginn liegt. EventKey = FPY_<CustomerAccountKey>.

Kundenfilter

• Es werden nur Kunden geliefert, deren CustomerOf gleich ShopId ist.
• Bei CustomerNumberIsNumeric = 1 werden nur Kunden geliefert, deren CustomerNrExternal ausschließlich aus Ziffern besteht. Bei 0 (Standard oder NULL) werden alle Kunden des Shops geliefert.

Mahnstufen

• Für jede Rechnung ohne virtuelles Vollzahlungsereignis wird der höchste HighestReminderLevel aller Mahnungen ermittelt, die die Rechnung enthalten (Rechnungsdatum vor EndDate).
• Dieser Wert wird in ReminderLevel aller Nicht-REM-Ereignisse der Rechnung geschrieben.
• CustomerReminderLevel ist das Maximum dieser Stufen über alle offenen Rechnungen des Kunden. Es wird bei allen Ereignissen des Kunden gesetzt.

Beträge und Währungen

• Balance_ShopCurr ist die Summe aller Kundenkontobeträge mit EventDate vor EndDate.
• Ist die Einstellung MultiCurrencyEnabled gleich 1, werden diese Beträge mit dem Wechselkurs des aktuellen Tages umgerechnet.
• Amount_ShopCurr ist der auf dieselbe Weise umgerechnete Ereignisbetrag. Ein fehlender Kurs zählt als 1.

Ausgabe

• Jede Ereigniszeile enthält die externe Kundennummer, die Rechnungsnummer und die externe Auftragsnummer.
• Geliefert werden nur Ereignisse, die einer Rechnung in Invoices zugeordnet werden können.
• Das Ergebnis ist DISTINCT und nach EventUpdateDate, dann EventDate sortiert.

Parameter

Antwort

Result-Set 1 · Wenn ShopId NULL oder leer ist

Fehler-Statuszeile; es folgt kein weiteres Ergebnis.

Result-Set 2 · Wenn ShopId angegeben ist

Liste der Kundenkonto-, Mahnungs- und virtuellen Vollzahlungsereignisse, sortiert nach EventUpdateDate, EventDate.

<SqlRowSet1>
  <row>
    <CustomerNrExternal>100234</CustomerNrExternal>
    <InvoiceNr>RE2024-00451</InvoiceNr>
    <OrderNrExternal>WEB-77812</OrderNrExternal>
    <EventID>INV</EventID>
    <Amount>119.0000</Amount>
    <EventCurr>EUR</EventCurr>
    <EventDate>2024-03-04T10:15:00</EventDate>
    <Amount_ShopCurr>119.0000</Amount_ShopCurr>
    <ShopCurr>EUR</ShopCurr>
    <Balance_ShopCurr>119.0000</Balance_ShopCurr>
    <ReminderLevel>1</ReminderLevel>
    <CustomerReminderLevel>1</CustomerReminderLevel>
    <EventKey>CAE_558812</EventKey>
    <EventUpdateDate>2024-03-04T10:15:00</EventUpdateDate>
  </row>
  <row>
    <CustomerNrExternal>100234</CustomerNrExternal>
    <InvoiceNr>RE2024-00451</InvoiceNr>
    <OrderNrExternal>WEB-77812</OrderNrExternal>
    <EventID>REM</EventID>
    <Amount>-119.0000</Amount>
    <EventCurr>EUR</EventCurr>
    <EventDate>2024-03-20T08:00:00</EventDate>
    <Amount_ShopCurr>-119.0000</Amount_ShopCurr>
    <ShopCurr>EUR</ShopCurr>
    <Balance_ShopCurr>119.0000</Balance_ShopCurr>
    <ReminderLevel>1</ReminderLevel>
    <CustomerReminderLevel>1</CustomerReminderLevel>
    <EventKey>REM_3311</EventKey>
    <EventUpdateDate>2024-03-20T08:00:00</EventUpdateDate>
  </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:pixiGetCAEventsAndReminders>
      <!-- <StartDate>2024-03-01T00:00:00</StartDate> -->
      <!-- <EndDate>2024-03-31T00:00:00</EndDate> -->
      <ShopId>SHP</ShopId>
      <!-- <CustomerNumberIsNumeric>0</CustomerNumberIsNumeric> -->
    </ns1:pixiGetCAEventsAndReminders>
  </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:pixiGetCAEventsAndReminders>
      <!-- <StartDate>2024-03-01T00:00:00</StartDate> -->
      <!-- <EndDate>2024-03-31T00:00:00</EndDate> -->
      <ShopId>SHP</ShopId>
      <!-- <CustomerNumberIsNumeric>0</CustomerNumberIsNumeric> -->
    </ns1:pixiGetCAEventsAndReminders>
  </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 = [
    // 'StartDate' => '2024-03-01T00:00:00',
    // 'EndDate' => '2024-03-31T00:00:00',
    'ShopId' => 'SHP',
    // 'CustomerNumberIsNumeric' => '0',
];

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

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

Verwendete Tabellen

SQL-Objekt:

dbo.pipiGetCAEventsAndReminders

Prozedur zuletzt geändert am 2026-10-05

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