Payments Lesen

pixiCAGetInvoiceMatch

Liefert die Debitorenkonto-Buchungen, die mit der Debitorenkonto-Buchung einer angegebenen Rechnung ausgeglichen wurden.

Ermittelt die Debitorenkonto-Buchung (CA-Eintrag) einer Rechnung und listet alle CA-Einträge auf, die mit ihr ausgeglichen wurden, z. B. Zahlungen oder Gutschriften, die die Rechnung begleichen.

Mindestens einer der Parameter InvoiceKey oder InvoiceNr muss gesetzt sein (der Wert 0 bzw. ein Leerstring gilt als nicht gesetzt). Andernfalls wird ein Fehler ausgelöst.
Ist InvoiceKey nicht gesetzt, wird der Schlüssel über InvoiceNr aus Invoices ermittelt.
Der CA-Eintrag, dessen InvoiceRef dem Rechnungsschlüssel entspricht, wird bestimmt.
Alle Ausgleichsdatensätze in CustomerAccountMatch, in denen dieser CA-Eintrag auf einer der beiden Seiten (CAref1 oder CAref2) steht, werden gelesen, und die jeweiligen Gegenbuchungen werden zurückgegeben. Ein Ausgleichsdatensatz, der den Rechnungseintrag auf beiden Seiten referenziert (Selbstausgleich), liefert den Rechnungseintrag selbst.
Der Währungscode stammt aus pixi.Currency über die Währungs-ID der Buchung.

Das Ergebnis hat keine definierte Sortierung.

Hinweise

Alle Lesezugriffe verwenden NOLOCK; es können nicht festgeschriebene Daten geliefert werden.
Die Spalte InvoiceNr gibt nur den Eingabeparameter zurück. Wird nur InvoiceKey übergeben, ist InvoiceNr im Ergebnis leer (NULL).
Werden beide Parameter übergeben, wird InvoiceKey verwendet; InvoiceNr wird nicht dagegen geprüft.
Wird keine Rechnung oder kein CA-Eintrag zur Rechnung gefunden, wird eine leere Ergebnismenge ohne Fehler geliefert.
Verweisen mehrere CA-Einträge auf dieselbe Rechnung, wird nur einer davon (nicht deterministisch) verwendet.
Der Kopfkommentar der Prozedur ("show all CA Events and Statistics for a selected customer") entspricht nicht dem tatsächlichen Verhalten.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`InvoiceKey`	int	NULL	Interner Schlüssel der Rechnung. Hat Vorrang vor `InvoiceNr`. `0` oder NULL bedeutet nicht gesetzt. Beispiel: `104523`
`InvoiceNr`	varchar(20) string	NULL	Rechnungsnummer. Wird zur Ermittlung des Rechnungsschlüssels verwendet, wenn `InvoiceKey` nicht gesetzt ist. Beispiel: `RE2024-001234`

Antwort

Result-Set 1 · Wenn `InvoiceKey` oder `InvoiceNr` gesetzt ist; kann leer sein, wenn kein CA-Eintrag oder Ausgleich existiert.

Eine Zeile pro Debitorenkonto-Buchung, die mit dem CA-Eintrag der Rechnung ausgeglichen wurde.

Spalte	Typ	Beschreibung
`InvoiceKey` Kann leer sein	int	Rechnungsschlüssel (übergeben oder aus der Rechnungsnummer ermittelt).
`InvoiceNr` Kann leer sein	varchar(20) string	Rechnungsnummer wie im Parameter übergeben; NULL, wenn nicht übergeben.
`EventID` Kann leer sein	string	Ereignis-ID der ausgeglichenen CA-Buchung.
`EventDate` Kann leer sein	smalldatetime dateTime	Datum der ausgeglichenen CA-Buchung, auf Minuten gerundet.
`Reference` Kann leer sein	string	Referenztext der ausgeglichenen CA-Buchung.
`Amount` Kann leer sein	decimal	Betrag der ausgeglichenen CA-Buchung.
`Matched` Kann leer sein	string	Ausgleichswert bzw. -status der CA-Buchung aus `CustomerAccount.Matched`.
`OrderCurrency`	string	Währungscode (`CodeA` aus `pixi.Currency`) der CA-Buchung.
`CreateDate` Kann leer sein	dateTime	Erstellungsdatum der CA-Buchung.

Beispielantwort

<SqlRowSet1>
  <row>
    <InvoiceKey>104523</InvoiceKey>
    <InvoiceNr>RE2024-001234</InvoiceNr>
    <EventID>2</EventID>
    <EventDate>2024-03-15T10:30:00</EventDate>
    <Reference>Payment PayPal 7XK12345</Reference>
    <Amount>-119.00</Amount>
    <Matched>-119.00</Matched>
    <OrderCurrency>EUR</OrderCurrency>
    <CreateDate>2024-03-15T10:31:12</CreateDate>
  </row>
</SqlRowSet1>

Fehlermeldungen

Status	Meldung	Ursache
RAISERROR	Input data not OK	Weder `InvoiceKey` (ungleich 0) noch `InvoiceNr` (nicht leer) wurde übergeben. Mindestens einen der beiden Parameter angeben.

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:pixiCAGetInvoiceMatch>
      <!-- <InvoiceKey>104523</InvoiceKey> -->
      <!-- <InvoiceNr>RE2024-001234</InvoiceNr> -->
    </ns1:pixiCAGetInvoiceMatch>
  </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:pixiCAGetInvoiceMatch>
      <!-- <InvoiceKey>104523</InvoiceKey> -->
      <!-- <InvoiceNr>RE2024-001234</InvoiceNr> -->
    </ns1:pixiCAGetInvoiceMatch>
  </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 = [
    // 'InvoiceKey' => '104523',
    // 'InvoiceNr' => 'RE2024-001234',
];

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

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

Verwendete Tabellen

Invoices · Lesen CustomerAccount · Lesen CustomerAccountMatch · Lesen Currency · Lesen

SQL-Objekt:: dbo.pipiCAGetInvoiceMatch