Invoices Lesen

pixiEmillInvoicesList

Liefert alle Rechnungen eines Datumsbereichs, optional auf einen Shop beschränkt, mit Kundendaten und zugehörigem Auftrag für die eMill-Anbindung.

Listet Rechnungen für die eMill-Anbindung auf.

ShopID: Ist der Wert leer oder fehlt er, werden Rechnungen aller Shops geliefert; andernfalls nur Rechnungen, deren InvShopID gleich ShopID ist.
DateFrom: Fehlt der Wert oder liegt er vor dem 01.01.1990, wird der Beginn des aktuellen Tages (00:00:00) verwendet.
DateTo: Fehlt der Wert oder liegt er vor dem 01.01.1990, wird das Ende des aktuellen Tages (23:59:59.997) verwendet.
Eine Rechnung wird geliefert, wenn ihr InvDate zwischen DateFrom und DateTo liegt (jeweils einschließlich).

Zu jeder Rechnung werden ergänzt:

Kundendaten (externe Kundennummer, Anrede, Namen, E-Mail) des in der Rechnung referenzierten Kunden; diese Spalten sind leer, wenn kein Kunde gefunden wird;
Auftragsdaten (OrderNr, OrderNrExternal, OrdShopID, OrderDate) der Auftragsposition mit dem höchsten Schlüssel unter den Rechnungspositionen der Rechnung.

Das Ergebnis hat keine definierte Sortierung.

Hinweise

Alle Tabellen werden WITH (NOLOCK) gelesen; nicht festgeschriebene Daten können erscheinen.
Rechnungen ohne Rechnungspositionen oder deren höchste referenzierte Auftragsposition nicht existiert, werden nicht geliefert (Inner Join auf die Auftragsposition).
Wird nur ein Datum übergeben, wird das andere auf heute gesetzt: Nur ein DateTo in der Vergangenheit ergibt DateFrom = heute und damit ein leeres Ergebnis.
DateTo ohne Uhrzeit bedeutet Mitternacht, spätere Rechnungen dieses Tages werden ausgeschlossen; das Tagesende sollte explizit übergeben werden.
Pro Rechnung wird nur ein Auftrag ausgegeben, auch wenn die Rechnung Positionen mehrerer Aufträge enthält.

Parameter

Parameter	Typ	Standardwert	Beschreibung
`ShopID`	varchar(3) string	NULL	Shop-ID zur Filterung der Rechnungen (`InvShopID`). Leer oder nicht angegeben liefert Rechnungen aller Shops. Beispiel: `SH1`
`DateFrom`	datetime dateTime	NULL	Beginn des Rechnungsdatumsbereichs (einschließlich). Fehlend oder vor dem 01.01.1990: Beginn des aktuellen Tages. Beispiel: `2024-05-01T00:00:00`
`DateTo`	datetime dateTime	NULL	Ende des Rechnungsdatumsbereichs (einschließlich). Fehlend oder vor dem 01.01.1990: Ende des aktuellen Tages (23:59:59.997). Beispiel: `2024-05-31T23:59:59`

Antwort

Result-Set 1 · Immer (ggf. leer)

Eine Zeile je Rechnung im Datumsbereich (und Shop, falls angegeben), die mindestens eine existierende Auftragsposition hat.

Spalte	Typ	Beschreibung
`InvoiceNr`	string	Rechnungsnummer.
`InvoiceKey`	int	Interner Schlüssel der Rechnung.
`CustomerNrExternal` Kann leer sein	string	Externe Kundennummer; leer, wenn kein Kunde verknüpft ist.
`SAnrede` Kann leer sein	string	Anrede des Kunden.
`SName` Kann leer sein	string	Name des Kunden.
`SName2` Kann leer sein	string	Zweite Namenszeile des Kunden.
`Email` Kann leer sein	string	E-Mail-Adresse des Kunden (`CeMail`).
`InvDate`	dateTime	Rechnungsdatum.
`OrderNr` Kann leer sein	int	Pixi-Auftragsnummer der Auftragsposition mit dem höchsten Schlüssel auf der Rechnung.
`OrderNrExternal` Kann leer sein	string	Externe (Shop-)Auftragsnummer.
`OrdShopID` Kann leer sein	string	Shop-ID des Auftrags.
`OrderDate` Kann leer sein	dateTime	Auftragsdatum.

Beispielantwort

<SqlRowSet1>
  <row>
    <InvoiceNr>RE240512</InvoiceNr>
    <InvoiceKey>48213</InvoiceKey>
    <CustomerNrExternal>K10023</CustomerNrExternal>
    <SAnrede>Frau</SAnrede>
    <SName>Anna Müller</SName>
    <SName2/>
    <Email>anna.mueller@example.com</Email>
    <InvDate>2024-05-14T10:22:31</InvDate>
    <OrderNr>153344</OrderNr>
    <OrderNrExternal>100004711</OrderNrExternal>
    <OrdShopID>SH1</OrdShopID>
    <OrderDate>2024-05-12T18:05:00</OrderDate>
  </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:pixiEmillInvoicesList>
      <!-- <ShopID>SH1</ShopID> -->
      <!-- <DateFrom>2024-05-01T00:00:00</DateFrom> -->
      <!-- <DateTo>2024-05-31T23:59:59</DateTo> -->
    </ns1:pixiEmillInvoicesList>
  </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:pixiEmillInvoicesList>
      <!-- <ShopID>SH1</ShopID> -->
      <!-- <DateFrom>2024-05-01T00:00:00</DateFrom> -->
      <!-- <DateTo>2024-05-31T23:59:59</DateTo> -->
    </ns1:pixiEmillInvoicesList>
  </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 = [
    // 'ShopID' => 'SH1',
    // 'DateFrom' => '2024-05-01T00:00:00',
    // 'DateTo' => '2024-05-31T23:59:59',
];

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

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

Verwendete Tabellen

Invoices · Lesen Customers · Lesen Orderlines · Lesen Invlines · Lesen

SQL-Objekt:: dbo.pipiEmillInvoicesList