Invoices Lesen

pixiReadInvoices

Liefert Rechnungsköpfe aus Pixi, gefiltert nach Rechnungsschlüssel oder -nummer, Erstell- und/oder Änderungsdatum oder als nach Schlüssel sortierte Seite.

Liest Rechnungsköpfe aus Invoices. Der Währungscode stammt aus pixi.Currency, die Mahndaten aus der Mahnung mit der höchsten Stufe pro Rechnung in Reminders. Alle Modi liefern dieselben Spalten, sortiert nach InvoiceKey aufsteigend.

Ist RowCount auf einen Wert ungleich 0 gesetzt, wird die Anzahl der gelieferten Zeilen darauf begrenzt. Ein fehlender InvoiceKey wird als 0 behandelt.

Verwendet wird der erste zutreffende Modus:

Erstell- oder Änderungsdatum: CreateAndUpdateDateFrom oder CreateAndUpdateDateTo ist gesetzt. Liefert Rechnungen mit InvoiceKey > InvoiceKey, deren CreateDate oder UpdateDate zwischen beiden Werten liegt. Beide Grenzen sind inklusive (BETWEEN).
Erstelldatum: CreateDateFrom oder CreateDateTo ist gesetzt. Liefert Rechnungen mit InvoiceKey > InvoiceKey und CreateDate >= Von und < Bis. Jede Grenze kann entfallen.
Änderungsdatum: UpdateDateFrom oder UpdateDateTo ist gesetzt. Gleiche Logik auf UpdateDate.
Schlüsselbereich / Paging: RowCount wird übergeben. Liefert Rechnungen mit InvoiceKey größer als der übergebene InvoiceKey. Für das Paging wird der zuletzt erhaltene Schlüssel als nächster InvoiceKey übergeben.
Einzelne Rechnung: Andernfalls werden die Rechnungen mit InvoiceKey = InvoiceKey oder InvoiceNr = InvoiceNr geliefert.

In den Modi 1–3 gilt zusätzlich die Schlüsselbedingung. Datumsfilter lassen sich daher mit InvoiceKey und RowCount für Keyset-Paging kombinieren. InvoiceNr wird nur in Modus 5 ausgewertet.

Die Spalte ReminderLevel liefert die höchste HighestReminderLevel aus Reminders zur Rechnung, ReminderCosts die Kosten dieser Mahnung. Gibt es keine solche Mahnung, werden die Werte aus der Rechnung selbst verwendet. VoucherSum_OrderCurr ist bei OrderType B2C die Brutto-Gutscheinsumme, sonst die Netto-Gutscheinsumme.

Hinweise

Alle Lesezugriffe verwenden NOLOCK, es können also nicht festgeschriebene Daten geliefert werden.
Rechnungen ohne passenden Datensatz in pixi.Currency (Inner Join über CurrencyId) werden nie geliefert.
Falle in Modus 1: Wird nur einer der Werte CreateAndUpdateDateFrom / CreateAndUpdateDateTo übergeben, ist die ODER-Bedingung immer erfüllt. Dann werden alle Rechnungen oberhalb von InvoiceKey geliefert. Daher immer beide Grenzen übergeben.
Falle in Modus 4: InvoiceKey zusammen mit RowCount liefert die Rechnungen nach diesem Schlüssel, nicht die Rechnung selbst. InvoiceNr wird ignoriert, sobald RowCount oder ein Datumsfilter übergeben wird.
RowCount = 0 wählt ebenfalls Modus 4, jedoch ohne Zeilenbegrenzung. Dadurch können alle Rechnungen geliefert werden.
Ohne Parameter sucht Modus 5 nach InvoiceKey = 0 und liefert normalerweise ein leeres Ergebnis. Der letzte Fallback-Zweig (WHERE 1 = 0) wird nie erreicht.
Die Zeilenbegrenzung erfolgt über SET ROWCOUNT.
Die Spalten Total_OrderCurr, Total_ShipCost_OrderCurr, VATBaseHigh_OrderCurr, VATBaseLow_OrderCurr, VATHigh_OrderCurr, VATLow_OrderCurr, VATBaseHigh_ShipCost_OrderCurr und VATBaseLow_ShipCost_OrderCurr sind nur Kopien anderer Spalten. Kommentare im Code markieren sie zur Entfernung, daher sollten sie nicht verwendet werden.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`InvoiceKey`	int	NULL	Rechnungsschlüssel. In Modus 5 wird diese Rechnung gewählt. In allen anderen Modi werden nur Rechnungen mit größerem Schlüssel geliefert (Paging-Start). NULL wird als 0 behandelt. Beispiel: `10500`
`InvoiceNr`	varchar(20) string	NULL	Zu suchende Rechnungsnummer. Wird nur in Modus 5 ausgewertet, also ohne Datumsfilter und ohne `RowCount`. Beispiel: `RE2024-001234`
`CreateDateFrom`	datetime dateTime	NULL	Untergrenze (inklusive) für `CreateDate`. Beispiel: `2024-05-01T00:00:00`
`CreateDateTo`	datetime dateTime	NULL	Obergrenze (exklusiv) für `CreateDate`. Beispiel: `2024-06-01T00:00:00`
`UpdateDateFrom`	datetime dateTime	NULL	Untergrenze (inklusive) für `UpdateDate`. Wird nur ohne Erstelldatumsfilter ausgewertet. Beispiel: `2024-05-01T00:00:00`
`UpdateDateTo`	datetime dateTime	NULL	Obergrenze (exklusiv) für `UpdateDate`. Beispiel: `2024-06-01T00:00:00`
`CreateAndUpdateDateFrom`	datetime dateTime	NULL	Untergrenze (inklusive) für Rechnungen, die im Zeitraum erstellt oder geändert wurden. Hat Vorrang vor allen anderen Filtern. Zusammen mit `CreateAndUpdateDateTo` übergeben. Beispiel: `2024-05-01T00:00:00`
`CreateAndUpdateDateTo`	datetime dateTime	NULL	Obergrenze (inklusive) für Rechnungen, die im Zeitraum erstellt oder geändert wurden. Beispiel: `2024-05-31T23:59:59`
`RowCount`	int	NULL	Maximale Anzahl Zeilen (0 oder NULL = keine Begrenzung). Wird der Wert übergeben, aktiviert er ohne Datumsfilter zusätzlich den Schlüsselbereichsmodus. Beispiel: `100`

Antwort

Result-Set 1 · Immer (kann leer sein)

Rechnungsköpfe zum gewählten Modus, sortiert nach InvoiceKey aufsteigend.

Spalte	Typ	Beschreibung
`InvoiceKey`	int	Rechnungsschlüssel.
`InvoiceNr` Kann leer sein	string	Rechnungsnummer.
`InvDate` Kann leer sein	dateTime	Rechnungsdatum.
`CustRef` Kann leer sein	int	Kundenreferenz.
`AddrRef` Kann leer sein	int	Referenz der Rechnungsadresse.
`Summary` Kann leer sein	decimal	Summenwert der Rechnung wie gespeichert.
`VATBaseHigh` Kann leer sein	decimal	Bemessungsgrundlage zum vollen MwSt-Satz.
`VATBaseLow` Kann leer sein	decimal	Bemessungsgrundlage zum ermäßigten MwSt-Satz.
`VATType` Kann leer sein	string	MwSt-Art.
`VATNo` Kann leer sein	string	USt-IdNr.
`total` Kann leer sein	decimal	Rechnungsbetrag.
`Payment` Kann leer sein	string	Zahlungsart.
`Printed` Kann leer sein	string	Gedruckt-Kennzeichen.
`PrintDate` Kann leer sein	dateTime	Druckdatum.
`PayDay` Kann leer sein	dateTime	Zahlungsdatum.
`Payed` Kann leer sein	string	Bezahlt-Kennzeichen.
`PayedSum` Kann leer sein	decimal	Bezahlter Betrag.
`SUGKTO` Kann leer sein	string	Kontofeld wie gespeichert (Buchhaltung).
`BuchuText` Kann leer sein	string	Buchungstext.
`AuszugNr` Kann leer sein	string	Kontoauszugsnummer.
`Account` Kann leer sein	string	Kontonummer.
`BLZ` Kann leer sein	string	Bankleitzahl.
`AccName` Kann leer sein	string	Kontoinhaber.
`LSDate` Kann leer sein	dateTime	Lastschriftdatum.
`LSNr` Kann leer sein	string	Lastschriftnummer.
`RLSDate` Kann leer sein	dateTime	Datum der Rücklastschrift.
`RLSCost` Kann leer sein	decimal	Kosten der Rücklastschrift.
`Reminder1Date` Kann leer sein	dateTime	Datum der ersten Mahnung.
`Reminder2Date` Kann leer sein	dateTime	Datum der zweiten Mahnung.
`Reminder3Date` Kann leer sein	dateTime	Datum der dritten Mahnung.
`Note` Kann leer sein	string	Notiz.
`ShipCode` Kann leer sein	string	Versandcode.
`CreateDate` Kann leer sein	dateTime	Erstellungszeitpunkt.
`CreateEmp` Kann leer sein	string	Erstellender Mitarbeiter.
`UpdateDate` Kann leer sein	dateTime	Zeitpunkt der letzten Änderung.
`UpdateEmp` Kann leer sein	string	Zuletzt ändernder Mitarbeiter.
`BoxNr` Kann leer sein	string	Kistennummer.
`Total_OrderCurr` Kann leer sein	decimal	Kopie von `Total` (zur Entfernung markiert).
`Total_ShipCost` Kann leer sein	decimal	Summe der Versandkosten.
`Total_ShipCost_OrderCurr` Kann leer sein	decimal	Kopie von `Total_ShipCost` (zur Entfernung markiert).
`ScanOutDate` Kann leer sein	dateTime	Ausscan-Datum (Versand).
`OrderCurrency` Kann leer sein	string	Währungscode (`CodeA` aus `pixi.Currency`).
`VATBaseHigh_OrderCurr` Kann leer sein	decimal	Kopie von `VATBaseHigh` (zur Entfernung markiert).
`VATBaseLow_OrderCurr` Kann leer sein	decimal	Kopie von `VATBaseLow` (zur Entfernung markiert).
`VATHighPerc` Kann leer sein	decimal	Voller MwSt-Satz in Prozent.
`VATLowPerc` Kann leer sein	decimal	Ermäßigter MwSt-Satz in Prozent.
`VATHigh` Kann leer sein	decimal	MwSt-Betrag zum vollen Satz.
`VATLow` Kann leer sein	decimal	MwSt-Betrag zum ermäßigten Satz.
`VATHigh_OrderCurr` Kann leer sein	decimal	Kopie von `VATHigh` (zur Entfernung markiert).
`VATLow_OrderCurr` Kann leer sein	decimal	Kopie von `VATLow` (zur Entfernung markiert).
`VATHText` Kann leer sein	string	Text zum vollen MwSt-Satz.
`VATLText` Kann leer sein	string	Text zum ermäßigten MwSt-Satz.
`RefToInvoiceNr` Kann leer sein	string	Nummer der referenzierten Rechnung (z. B. bei Gutschriften).
`RefToInvoiceKey` Kann leer sein	int	Schlüssel der referenzierten Rechnung.
`ChargeVAT` Kann leer sein	string	Ob MwSt berechnet wird.
`ShipVendor` Kann leer sein	string	Versanddienstleister.
`CCPPaymentDone` Kann leer sein	string	Kennzeichen Kreditkartenzahlung erfolgt.
`CCPAuthCode` Kann leer sein	string	Autorisierungscode der Kreditkartenzahlung.
`CCPNumOfTries` Kann leer sein	int	Anzahl der Belastungsversuche der Kreditkarte.
`CCPReCharge` Kann leer sein	string	Kennzeichen erneute Kreditkartenbelastung.
`ShipAdrRef` Kann leer sein	int	Referenz der Lieferadresse.
`InvLocationID` Kann leer sein	string	Standort (Lager) der Rechnung.
`InvShopID` Kann leer sein	string	Shop-ID.
`PackageNetWeight` Kann leer sein	decimal	Nettogewicht des Pakets.
`PackageGrossWeight` Kann leer sein	decimal	Bruttogewicht des Pakets.
`IsPackageLost` Kann leer sein	string	Kennzeichen Paket verloren.
`InvShipLock` Kann leer sein	string	Kennzeichen Versandsperre.
`InvTrackNumber` Kann leer sein	string	Sendungsnummer.
`VoucherSum_OrderCurr` Kann leer sein	decimal	Gutscheinsumme: brutto (`VoucherSum`) bei B2C, sonst netto (`VoucherSum_Net`).
`VoucherID` Kann leer sein	string	Gutschein-ID.
`VATinShipCost` Kann leer sein	decimal	In den Versandkosten enthaltene MwSt.
`ShippedByVendor` Kann leer sein	string	Kennzeichen Versand durch Lieferant (Streckengeschäft).
`VATBaseLow_ShipCost` Kann leer sein	decimal	Versandkostenanteil zum ermäßigten MwSt-Satz.
`VATBaseHigh_ShipCost` Kann leer sein	decimal	Versandkostenanteil zum vollen MwSt-Satz.
`ccpPayID` Kann leer sein	string	Zahlungs-ID des Zahlungsanbieters.
`ccpTransID` Kann leer sein	string	Transaktions-ID des Zahlungsanbieters.
`ReminderLevel` Kann leer sein	int	Höchste Mahnstufe aus `Reminders`, sonst die Mahnstufe der Rechnung.
`ReminderProcessed` Kann leer sein	string	Kennzeichen Mahnung verarbeitet.
`ReminderCosts` Kann leer sein	decimal	Kosten der Mahnung mit der höchsten Stufe, sonst die Mahnkosten der Rechnung.
`ReminderReason` Kann leer sein	string	Mahngrund.
`ShipmentTrackingID` Kann leer sein	string	Sendungsverfolgungs-ID.
`ReturnReason` Kann leer sein	string	Retourengrund.
`StockNote` Kann leer sein	string	Lagernotiz.
`ReturnSupplier` Kann leer sein	string	Rücksendung an Lieferant wie gespeichert.
`ReturnClosed` Kann leer sein	string	Kennzeichen Retoure abgeschlossen.
`Fulfillment` Kann leer sein	string	Fulfillment-Wert wie gespeichert.
`InvoiceMailSent` Kann leer sein	string	Kennzeichen Rechnungsmail versendet.
`TrackingIDsent` Kann leer sein	string	Kennzeichen Tracking-ID versendet.
`PaidByCustomer` Kann leer sein	decimal	Vom Kunden bezahlt, wie gespeichert.
`PLHref` Kann leer sein	string	Referenz auf die Pickliste/Packliste.
`Packages` Kann leer sein	int	Anzahl der Pakete.
`DiscountTotal` Kann leer sein	decimal	Rabattsumme.
`PaidAtCreation` Kann leer sein	string	Kennzeichen bei Erstellung bezahlt.
`TextIfNoInvlines` Kann leer sein	string	Text für Rechnungen ohne Positionen.
`retTrackID` Kann leer sein	string	Tracking-ID der Retoure.
`retTrackIDhist` Kann leer sein	string	Historie der Retouren-Tracking-IDs.
`1SS` Kann leer sein	string	Wert der Spalte `1SS` wie gespeichert.
`DueDate` Kann leer sein	dateTime	Fälligkeitsdatum.
`CreateDTAUS` Kann leer sein	string	Kennzeichen DTAUS-Erstellung.
`InvCreationMode` Kann leer sein	string	Erstellungsmodus der Rechnung.
`VATBaseHigh_ShipCost_OrderCurr` Kann leer sein	decimal	Kopie von `VATBaseHigh_ShipCost` (zur Entfernung markiert).
`VATBaseLow_ShipCost_OrderCurr` Kann leer sein	decimal	Kopie von `VATBaseLow_ShipCost` (zur Entfernung markiert).

Beispielantwort

<SqlRowSet1>
  <row>
    <InvoiceKey>10501</InvoiceKey>
    <InvoiceNr>RE2024-001235</InvoiceNr>
    <InvDate>2024-05-02T10:15:00</InvDate>
    <CustRef>4711</CustRef>
    <total>119.00</total>
    <VATBaseHigh>100.00</VATBaseHigh>
    <VATHigh>19.00</VATHigh>
    <VATHighPerc>19.00</VATHighPerc>
    <OrderCurrency>EUR</OrderCurrency>
    <CreateDate>2024-05-02T10:15:00</CreateDate>
    <UpdateDate>2024-05-03T08:00:00</UpdateDate>
    <ReminderLevel>0</ReminderLevel>
    <InvShopID>SHOP1</InvShopID>
  </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:pixiReadInvoices>
      <!-- <InvoiceKey>10500</InvoiceKey> -->
      <!-- <InvoiceNr>RE2024-001234</InvoiceNr> -->
      <!-- <CreateDateFrom>2024-05-01T00:00:00</CreateDateFrom> -->
      <!-- <CreateDateTo>2024-06-01T00:00:00</CreateDateTo> -->
      <!-- <UpdateDateFrom>2024-05-01T00:00:00</UpdateDateFrom> -->
      <!-- <UpdateDateTo>2024-06-01T00:00:00</UpdateDateTo> -->
      <!-- <CreateAndUpdateDateFrom>2024-05-01T00:00:00</CreateAndUpdateDateFrom> -->
      <!-- <CreateAndUpdateDateTo>2024-05-31T23:59:59</CreateAndUpdateDateTo> -->
      <!-- <RowCount>100</RowCount> -->
    </ns1:pixiReadInvoices>
  </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:pixiReadInvoices>
      <!-- <InvoiceKey>10500</InvoiceKey> -->
      <!-- <InvoiceNr>RE2024-001234</InvoiceNr> -->
      <!-- <CreateDateFrom>2024-05-01T00:00:00</CreateDateFrom> -->
      <!-- <CreateDateTo>2024-06-01T00:00:00</CreateDateTo> -->
      <!-- <UpdateDateFrom>2024-05-01T00:00:00</UpdateDateFrom> -->
      <!-- <UpdateDateTo>2024-06-01T00:00:00</UpdateDateTo> -->
      <!-- <CreateAndUpdateDateFrom>2024-05-01T00:00:00</CreateAndUpdateDateFrom> -->
      <!-- <CreateAndUpdateDateTo>2024-05-31T23:59:59</CreateAndUpdateDateTo> -->
      <!-- <RowCount>100</RowCount> -->
    </ns1:pixiReadInvoices>
  </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' => '10500',
    // 'InvoiceNr' => 'RE2024-001234',
    // 'CreateDateFrom' => '2024-05-01T00:00:00',
    // 'CreateDateTo' => '2024-06-01T00:00:00',
    // 'UpdateDateFrom' => '2024-05-01T00:00:00',
    // 'UpdateDateTo' => '2024-06-01T00:00:00',
    // 'CreateAndUpdateDateFrom' => '2024-05-01T00:00:00',
    // 'CreateAndUpdateDateTo' => '2024-05-31T23:59:59',
    // 'RowCount' => '100',
];

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

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

Verwendete Tabellen

Invoices · Lesen Currency · Lesen Reminders · Lesen

SQL-Objekt:: dbo.pipiReadInvoices