Postman-Collection
Customers Lesen

pixiGetCustomerEvents

Liefert die Kundenkontobuchungen (Rechnungen, Zahlungen, Lastschriften, manuelle Buchungen), gefiltert nach Kunde, Ereignistyp und Zeitraum.

Liest Einträge aus dem Kundenkonto (CustomerAccount) und ergänzt sie um Anzeige- und Statusinformationen.

Filter (alle optional, UND-verknüpft; ein weggelassener oder NULL-Parameter filtert nicht):

  • CustKey: nur Einträge, deren CustRef diesem Kundenschlüssel entspricht.
  • EventID: nur Einträge dieses Ereignistyps.
  • DateFrom / DateTo: nur Einträge mit EventDate im Zeitraum (beide Grenzen inklusive).

Ohne Parameter werden alle Kundenkontoeinträge geliefert.

Ergänzungen je Eintrag:

  • EventName: Bezeichnung des Ereignistyps aus CustomerAccountEvents, übersetzt über die Übersetzungstabelle (Sprach-ID 2, Rückfall auf den unübersetzten Text). Bei Einträgen mit Bezug auf eine Lastschrift (DTAUSref gesetzt) wird der übersetzte Lastschriftstatus in eckigen Klammern angehängt, z. B. Lastschrift [Exportiert].
  • Number: lesbare Referenz je nach verknüpftem Objekt, in dieser Reihenfolge geprüft: Rechnungsnummer (InvoiceRef), Bankzeilentext BankText01 (BanklineRef), Kontonummer der Lastschrift (DTAUSref), Referenz der manuellen Buchung (ManualBookingRef), sonst eine leere Zeichenkette.
  • OpenTOMatch: Amount abzüglich des bereits ausgeglichenen Betrags (NULL zählt als 0).
  • AllowToDelete: 1, wenn der Eintrag gelöscht werden darf, sonst 0. Löschbar ist ein Eintrag nur, wenn er mit keinem anderen Eintrag ausgeglichen ist und entweder Ereignistyp und Lastschriftstatus das Löschen erlauben oder er zu einer Rechnung gehört, die nicht bezahlt ist, nicht per Kreditkarte bezahlt wurde (CCPPaymentDone ungleich Y), keine Mahnzeilen hat und deren Positionen alle im Status EIN oder alle im Status RET sind (oder keine Positionen hat).
  • CCPTranLogKey: ein Kreditkarten-Transaktionsprotokolleintrag desselben Kunden, dessen Rechnungsnummer der Rechnungsnummer oder der Bezugsrechnungsnummer der verknüpften Rechnung entspricht.
  • OrderCurrency: Währungscode (CodeA) des Eintrags.
  • IsDeleted: immer 0.

Das Ergebnis hat keine definierte Sortierung.

Hinweise

  • Alle Lesezugriffe verwenden NOLOCK, daher können nicht festgeschriebene Daten erscheinen.
  • Die Einstellung CaEnabled ändert die Prüfung auf "bezahlt" für AllowToDelete: Ist sie 0 oder nicht vorhanden, wird Invoices.Payed verwendet, sonst das jüngste Anlagedatum in CustomerAccountMatch für den Eintrag.
  • Die Löschregel ist eine Inline-Kopie von fPixi_CA_canIdeleteEvent, jedoch ohne die zusätzliche Prüfung des Scan-Out-Datums der Rechnung (ScanOutDate). Ergebnisse können daher von der Funktion abweichen.
  • Einträge, deren CurrencyId keinen Datensatz in pixi.Currency hat, werden nicht geliefert (Inner Join).
  • Hat der Ereignistyp keinen Datensatz in CustomerAccountEvents, sind EventName und AllowToDelete NULL.
  • DateTo wird mit <= verglichen; ein reines Datum wie 2024-03-31 bedeutet Mitternacht, spätere Einträge dieses Tages fehlen.
  • Verweisen mehrere gelieferte Einträge auf dieselbe Lastschrift (DTAUSref), kann das Anlegen eines eindeutigen Index auf einer internen temporären Tabelle mit einem SQL-Fehler scheitern; ein Filter auf den Kunden vermeidet dies in der Regel.
  • Die View PV_CustomerAccountMatchGroup basiert auf PV_CustomerAccountBond, deren Definition nicht vorliegt.

Parameter

Parameter Typ Standardwert Beschreibung
CustKey
int NULL

Kundenschlüssel (CustRef). Nur Einträge dieses Kunden werden geliefert. NULL = alle Kunden.

Beispiel: 10452

EventID
varchar(3)
string
NULL

Ereignistyp-ID aus CustomerAccountEvents. NULL = alle Ereignistypen.

Beispiel: INV

DateFrom
datetime
dateTime
NULL

Untergrenze für EventDate (inklusive). NULL = keine Untergrenze.

Beispiel: 2024-01-01T00:00:00

DateTo
datetime
dateTime
NULL

Obergrenze für EventDate (inklusive). NULL = keine Obergrenze.

Beispiel: 2024-03-31T23:59:59

Antwort

Result-Set 1 · Immer (kann leer sein)

Eine Zeile je passendem Kundenkontoeintrag.

Spalte Typ Beschreibung
CustomerAccountKey int

Schlüssel des Kundenkontoeintrags.

CustRef
Kann leer sein
int

Kundenschlüssel.

EventDate
Kann leer sein
dateTime

Datum des Ereignisses.

EventID
Kann leer sein
string

Ereignistyp-ID.

EventName
Kann leer sein
varchar(200)
string

Übersetzte Bezeichnung des Ereignistyps; bei Lastschrifteinträgen gefolgt vom übersetzten Lastschriftstatus in eckigen Klammern.

Number
Kann leer sein
string

Rechnungsnummer, Bankzeilentext, Kontonummer der Lastschrift oder Referenz der manuellen Buchung, je nach verknüpftem Objekt; leere Zeichenkette, wenn keines.

Reference
Kann leer sein
string

Referenztext des Eintrags.

Amount
Kann leer sein
decimal

Betrag des Eintrags.

OpenTOMatch
Kann leer sein
decimal

Noch auszugleichender Betrag (Amount abzüglich Matched).

DoNotRefund
Kann leer sein
boolean

Kennzeichen, dass der Betrag nicht erstattet werden darf.

InvoiceRef
Kann leer sein
int

Schlüssel der verknüpften Rechnung.

BanklineRef
Kann leer sein
int

Schlüssel der verknüpften Bankzeile.

DTAUSref
Kann leer sein
int

Schlüssel der verknüpften Lastschrift (DTAUS).

ManualBookingRef
Kann leer sein
int

Schlüssel der verknüpften manuellen Buchung.

AllowToDelete
Kann leer sein
int

1 = Eintrag darf gelöscht werden, 0 = nicht; NULL bei unbekanntem Ereignistyp.

IsDeleted bit
boolean

Immer 0.

CCPTranLogKey
Kann leer sein
int

Schlüssel eines passenden Kreditkarten-Transaktionsprotokolleintrags, falls vorhanden.

OrderCurrency
Kann leer sein
string

Währungscode (CodeA aus pixi.Currency).

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:pixiGetCustomerEvents>
      <!-- <CustKey>10452</CustKey> -->
      <!-- <EventID>INV</EventID> -->
      <!-- <DateFrom>2024-01-01T00:00:00</DateFrom> -->
      <!-- <DateTo>2024-03-31T23:59:59</DateTo> -->
    </ns1:pixiGetCustomerEvents>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Verwendete Tabellen

CustomerAccount · Lesen CustomerAccountEvents · Lesen CustomerAccountMatch · Lesen CustomerAccountManualBookings · Lesen DTAUS · Lesen DTAUSstates · Lesen Invoices · Lesen InvLines · Lesen OrderLines · Lesen ReminderLines · Lesen CCPTranLog · Lesen BankLines · Lesen Currency · Lesen Settings · Lesen Translation · Lesen
SQL-Objekt:
dbo.pipiGetCustomerEvents
Prozedur zuletzt geändert am 2026-10-05
Dokumentation von claude-opus-5-5 am 2026-10-30 geschrieben