Payments Lesen

pixiCAGetEvents

Liefert Kundenkonto-Ereignisse (Buchungen), gefiltert nach Ereignistyp, Datum, Betrag, Rechnung, Zahlungsart oder Kunde, optional inklusive gelöschter Ereignisse.

Liest Einträge aus dem Kundenkonto (CustomerAccount) zusammen mit dem Währungscode aus pixi.Currency.

Alle Filterparameter sind optional und werden mit AND verknüpft. Ein Filter wirkt nur, wenn der Parameter nicht NULL ist:

EventID: exakter Vergleich auf den Ereignistyp.
CreateDateFrom/CreateDateTo, UpdateDateFrom/UpdateDateTo, EventDateFrom/EventDateTo: inklusive Bereiche (>= / <=) auf CreateDate, UpdateDate und EventDate.
MinAmount/MaxAmount: inklusiver Bereich auf Amount.
MinMatchedAmount/MaxMatchedAmount: inklusiver Bereich auf Matched.
InvoiceRef: exakter Vergleich auf die verknüpfte Rechnung.
DoNotRefund: exakter Vergleich auf das Kennzeichen.
PaymentCode: verknüpft Invoices über InvoiceRef und liefert nur Ereignisse, deren Rechnung diese Zahlungsart (Payment) hat.
CustRef: wird nur angewendet, wenn der Wert größer als 0 ist.

Bei ShowDeleted = 1 werden zusätzlich gelöschte Ereignisse aus der Historientabelle CustomerAccountLog (Zeilen mit HistRemark = DELETE) mit denselben Filtern geliefert. Diese Zeilen haben IsDeleted = 1, aktive Zeilen IsDeleted = 0.

Ohne Filter werden alle Kundenkonto-Ereignisse geliefert. Die Ergebnismenge hat keine definierte Sortierung.

Hinweise

Die Abfrage wird als dynamisches SQL aufgebaut und mit sp_executesql ausgeführt; alle Werte werden als Parameter übergeben.
Alle Tabellen werden mit NOLOCK gelesen, nicht festgeschriebene Daten können daher erscheinen.
Aktive und gelöschte Zeilen werden mit UNION (nicht UNION ALL) zusammengeführt, vollständig identische Zeilen erscheinen daher nur einmal.
Obwohl Invoices per LEFT JOIN verknüpft wird, schließt der Filter PaymentCode alle Ereignisse ohne verknüpfte Rechnung aus.
Ereignisse, deren CurrencyId keinen Eintrag in pixi.Currency hat, werden nicht geliefert (Inner Join).
Ohne Filter kann der Aufruf sehr viele Zeilen liefern; eine Einschränkung nach Kunde oder Datum wird empfohlen.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`EventID`	varchar(3) string	NULL	Ereignistyp, nach dem gefiltert wird (exakter Vergleich). `NULL` = alle Ereignistypen. Beispiel: `PAY`
`CreateDateFrom`	datetime dateTime	NULL	Untergrenze (inklusive) für das Anlagedatum. Beispiel: `2024-01-01T00:00:00`
`CreateDateTo`	datetime dateTime	NULL	Obergrenze (inklusive) für das Anlagedatum. Beispiel: `2024-01-31T23:59:59`
`UpdateDateFrom`	datetime dateTime	NULL	Untergrenze (inklusive) für das Datum der letzten Änderung. Beispiel: `2024-01-01T00:00:00`
`UpdateDateTo`	datetime dateTime	NULL	Obergrenze (inklusive) für das Datum der letzten Änderung. Beispiel: `2024-01-31T23:59:59`
`EventDateFrom`	datetime dateTime	NULL	Untergrenze (inklusive) für das Ereignisdatum. Beispiel: `2024-01-01T00:00:00`
`EventDateTo`	datetime dateTime	NULL	Obergrenze (inklusive) für das Ereignisdatum. Beispiel: `2024-01-31T23:59:59`
`MinAmount`	money decimal	NULL	Mindestwert (inklusive) von `Amount`. Beispiel: `10.00`
`MaxAmount`	money decimal	NULL	Höchstwert (inklusive) von `Amount`. Beispiel: `500.00`
`MinMatchedAmount`	money decimal	NULL	Mindestwert (inklusive) des zugeordneten Betrags `Matched`. Beispiel: `0.00`
`MaxMatchedAmount`	money decimal	NULL	Höchstwert (inklusive) des zugeordneten Betrags `Matched`. Beispiel: `500.00`
`InvoiceRef`	int	NULL	Rechnungsschlüssel (`InvoiceKey`), mit dem das Ereignis verknüpft ist (exakter Vergleich). Beispiel: `123456`
`DoNotRefund`	bit boolean	NULL	Filter auf das Kennzeichen `DoNotRefund`. `NULL` = kein Filter. Erlaubte Werte `0` – Nur Ereignisse ohne Kennzeichen „nicht erstatten“ `1` – Nur Ereignisse mit Kennzeichen „nicht erstatten“ Beispiel: `0`
`PaymentCode`	char(1) string	NULL	Zahlungsartcode der verknüpften Rechnung (`Invoices.Payment`). Es werden nur Ereignisse mit verknüpfter Rechnung dieser Zahlungsart geliefert. Beispiel: `V`
`CustRef`	int	NULL	Kundenschlüssel. Wird nur angewendet, wenn größer als `0`. Beispiel: `4711`
`ShowDeleted`	bit boolean	0	Legt fest, ob gelöschte Ereignisse aus `CustomerAccountLog` mitgeliefert werden. Erlaubte Werte `0` – Nur aktive Ereignisse `1` – Aktive und gelöschte Ereignisse Beispiel: `0`

Antwort

Result-Set 1 · Immer

Eine Zeile pro Kundenkonto-Ereignis, das den Filtern entspricht.

Spalte	Typ	Beschreibung
`CustomerAccountKey`	int	Schlüssel des Kundenkontoeintrags.
`CustRef` Kann leer sein	int	Kundenschlüssel.
`EventID` Kann leer sein	varchar(3) string	Ereignistyp.
`EventDate` Kann leer sein	datetime dateTime	Datum des Ereignisses.
`Reference` Kann leer sein	string	Referenztext des Ereignisses.
`Amount` Kann leer sein	money decimal	Betrag des Ereignisses.
`Matched` Kann leer sein	money decimal	Zugeordneter Betrag.
`InvoiceRef` Kann leer sein	int	Schlüssel der verknüpften Rechnung.
`ManualBookingRef` Kann leer sein	int	Referenz auf eine manuelle Buchung.
`DoNotRefund` Kann leer sein	bit boolean	Kennzeichen: Betrag darf nicht erstattet werden.
`CreateEmp` Kann leer sein	string	Mitarbeiter, der den Eintrag angelegt hat.
`CreateDate` Kann leer sein	datetime dateTime	Anlagedatum.
`UpdateEmp` Kann leer sein	string	Mitarbeiter der letzten Änderung.
`UpdateDate` Kann leer sein	datetime dateTime	Datum der letzten Änderung.
`Comment` Kann leer sein	string	Kommentar.
`IsDeleted`	bit boolean	`0` = aktiver Eintrag aus `CustomerAccount`, `1` = gelöschter Eintrag aus `CustomerAccountLog`.
`OrderCurrency` Kann leer sein	string	Währungscode (`CodeA` aus `pixi.Currency`).

Beispielantwort

<SqlRowSet1>
  <row>
    <CustomerAccountKey>1025</CustomerAccountKey>
    <CustRef>4711</CustRef>
    <EventID>PAY</EventID>
    <EventDate>2024-01-15T10:32:00</EventDate>
    <Reference>Bank transfer 2024-0115</Reference>
    <Amount>149.9000</Amount>
    <Matched>149.9000</Matched>
    <InvoiceRef>123456</InvoiceRef>
    <ManualBookingRef>0</ManualBookingRef>
    <DoNotRefund>false</DoNotRefund>
    <CreateEmp>AD</CreateEmp>
    <CreateDate>2024-01-15T10:32:00</CreateDate>
    <UpdateEmp>AD</UpdateEmp>
    <UpdateDate>2024-01-15T10:35:00</UpdateDate>
    <Comment/>
    <IsDeleted>false</IsDeleted>
    <OrderCurrency>EUR</OrderCurrency>
  </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:pixiCAGetEvents>
      <!-- <EventID>PAY</EventID> -->
      <!-- <CreateDateFrom>2024-01-01T00:00:00</CreateDateFrom> -->
      <!-- <CreateDateTo>2024-01-31T23:59:59</CreateDateTo> -->
      <!-- <UpdateDateFrom>2024-01-01T00:00:00</UpdateDateFrom> -->
      <!-- <UpdateDateTo>2024-01-31T23:59:59</UpdateDateTo> -->
      <!-- <EventDateFrom>2024-01-01T00:00:00</EventDateFrom> -->
      <!-- <EventDateTo>2024-01-31T23:59:59</EventDateTo> -->
      <!-- <MinAmount>10.00</MinAmount> -->
      <!-- <MaxAmount>500.00</MaxAmount> -->
      <!-- <MinMatchedAmount>0.00</MinMatchedAmount> -->
      <!-- <MaxMatchedAmount>500.00</MaxMatchedAmount> -->
      <!-- <InvoiceRef>123456</InvoiceRef> -->
      <!-- <DoNotRefund>0</DoNotRefund> -->
      <!-- <PaymentCode>V</PaymentCode> -->
      <!-- <CustRef>4711</CustRef> -->
      <!-- <ShowDeleted>0</ShowDeleted> -->
    </ns1:pixiCAGetEvents>
  </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:pixiCAGetEvents>
      <!-- <EventID>PAY</EventID> -->
      <!-- <CreateDateFrom>2024-01-01T00:00:00</CreateDateFrom> -->
      <!-- <CreateDateTo>2024-01-31T23:59:59</CreateDateTo> -->
      <!-- <UpdateDateFrom>2024-01-01T00:00:00</UpdateDateFrom> -->
      <!-- <UpdateDateTo>2024-01-31T23:59:59</UpdateDateTo> -->
      <!-- <EventDateFrom>2024-01-01T00:00:00</EventDateFrom> -->
      <!-- <EventDateTo>2024-01-31T23:59:59</EventDateTo> -->
      <!-- <MinAmount>10.00</MinAmount> -->
      <!-- <MaxAmount>500.00</MaxAmount> -->
      <!-- <MinMatchedAmount>0.00</MinMatchedAmount> -->
      <!-- <MaxMatchedAmount>500.00</MaxMatchedAmount> -->
      <!-- <InvoiceRef>123456</InvoiceRef> -->
      <!-- <DoNotRefund>0</DoNotRefund> -->
      <!-- <PaymentCode>V</PaymentCode> -->
      <!-- <CustRef>4711</CustRef> -->
      <!-- <ShowDeleted>0</ShowDeleted> -->
    </ns1:pixiCAGetEvents>
  </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 = [
    // 'EventID' => 'PAY',
    // 'CreateDateFrom' => '2024-01-01T00:00:00',
    // 'CreateDateTo' => '2024-01-31T23:59:59',
    // 'UpdateDateFrom' => '2024-01-01T00:00:00',
    // 'UpdateDateTo' => '2024-01-31T23:59:59',
    // 'EventDateFrom' => '2024-01-01T00:00:00',
    // 'EventDateTo' => '2024-01-31T23:59:59',
    // 'MinAmount' => '10.00',
    // 'MaxAmount' => '500.00',
    // 'MinMatchedAmount' => '0.00',
    // 'MaxMatchedAmount' => '500.00',
    // 'InvoiceRef' => '123456',
    // 'DoNotRefund' => '0',
    // 'PaymentCode' => 'V',
    // 'CustRef' => '4711',
    // 'ShowDeleted' => '0',
];

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

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

Verwendete Tabellen

CustomerAccount · Lesen CustomerAccountLog · Lesen Currency · Lesen Invoices · Lesen

SQL-Objekt:: dbo.pipiCAGetEvents