pixiGetInvoiceShippingReport · Pixi API documentation

Lists invoices together with the customer's DATEV account number and the shipping address of the invoice. According to the header comment, the call was created for one specific customer ("Customer LLL").

Steps:

An empty ShopID is treated like NULL, which means all shops.
If DateFrom is not passed, it is set to the start of the day 30 days ago (00:00:00).
If DateTo is not passed, it is set to the end of the current day (23:59:59.997).
The invoices come from the view or table PV_Rechnungen. Only invoices with Rechnungsdatum >= DateFrom and Rechnungsdatum < DateTo are returned. The upper bound is exclusive.
Each invoice is joined via its invoice number to Invoices. From there the customer (Customers, for the DATEV account number) and the shipping address (Addresses via ShipAdrRef) are read. The country name comes from Countries.
If ShopID is set, only invoices whose InvShopID matches are returned.

The result has no defined sort order and no paging.

Notes

All tables are read with NOLOCK. The result can contain uncommitted data.
DateTo is compared with <. If a pure date such as 2024-03-31T00:00:00 is passed, invoices from that day are not included. To include them, pass the following day or a time at the end of the day.
The joins are LEFT JOINs. Without a shop filter, invoices that have no matching entry in Invoices, Customers, Addresses or Countries are still returned, with NULL values in the missing columns. With a shop filter, invoices without a matching Invoices row are excluded.
Firma is filled from the CareOf field of the address.
PV_Rechnungen is not attached. Whether it is a view and how it selects invoices cannot be seen from the code.

Tables used

PV_Rechnungen · Read Invoices · Read Customers · Read Addresses · Read Countries · Read

Parameter	Type	Default	Description
`ShopID`	varchar(3) string	NULL	Shop ID to filter by (`InvShopID` of the invoice). `NULL` or empty returns invoices of all shops. Example: `SHP`
`DateFrom`	datetime dateTime	NULL	Start of the period (inclusive), compared with the invoice date. If `NULL`, the start of the day 30 days ago is used. Example: `2024-03-01T00:00:00`
`DateTo`	datetime dateTime	NULL	End of the period (exclusive), compared with the invoice date. If `NULL`, the end of the current day (23:59:59.997) is used. Example: `2024-04-01T00:00:00`

Result set 1 · Always (can be empty)

One row per invoice in the period, with the customer's DATEV account number and the shipping address.

Column	Type	Description
`Datevnummer` Nullable	varchar(10) string	DATEV account number of the customer (`Customers.DatevAccNr`).
`Rechnungsnummer`	string	Invoice number from `PV_Rechnungen`.
`Vorname` Nullable	string	First name in the shipping address.
`Nachname` Nullable	string	Last name in the shipping address.
`Firma` Nullable	string	Company or c/o line of the shipping address (`CareOf`).
`Strasse` Nullable	string	Street of the shipping address.
`PLZ` Nullable	string	Postal code of the shipping address.
`Stadt` Nullable	string	City of the shipping address.
`Land` Nullable	string	Country name of the shipping address (`Countries.CntName`).
`eMail` Nullable	string	E-mail address stored in the shipping address.

Response example

<SqlRowSet1>
  <row>
    <Datevnummer>10045</Datevnummer>
    <Rechnungsnummer>RE2024001234</Rechnungsnummer>
    <Vorname>Anna</Vorname>
    <Nachname>Müller</Nachname>
    <Firma>Müller GmbH</Firma>
    <Strasse>Hauptstraße 12</Strasse>
    <PLZ>80331</PLZ>
    <Stadt>München</Stadt>
    <Land>Deutschland</Land>
    <eMail>anna.mueller@example.com</eMail>
  </row>
</SqlRowSet1>

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:pixiGetInvoiceShippingReport>
      <!-- <ShopID>SHP</ShopID> -->
      <!-- <DateFrom>2024-03-01T00:00:00</DateFrom> -->
      <!-- <DateTo>2024-04-01T00:00:00</DateTo> -->
    </ns1:pixiGetInvoiceShippingReport>
  </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:pixiGetInvoiceShippingReport>
      <!-- <ShopID>SHP</ShopID> -->
      <!-- <DateFrom>2024-03-01T00:00:00</DateFrom> -->
      <!-- <DateTo>2024-04-01T00:00:00</DateTo> -->
    </ns1:pixiGetInvoiceShippingReport>
  </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' => 'SHP',
    // 'DateFrom' => '2024-03-01T00:00:00',
    // 'DateTo' => '2024-04-01T00:00:00',
];

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

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