pixiGetCustomerInfo · Pixi API documentation

Looks up the customer with the internal key CustKey and joins its main address (Customers.AddrRef → Addresses.AddrKey).

Returns one row with:

the name from the address record,
the customer history note (CHisNote) as Comment,
the DATEV account number as text,
the lock flag (N if not set),
the number of the customer's invoices at reminder level 1, 2 and 3,
the external customer number.

If no customer with this key exists, or the customer has no matching address record, the result set is empty.

Notes

All reads use NOLOCK, so the values may include uncommitted data.
Invoices at reminder levels higher than 3 are not counted.
The DATEV account number is cast to varchar(10).
A comment in the code says that the column list is meant to be extended later.

Tables used

Customers · Read Addresses · Read Invoices · Read

Parameter	Type	Default	Description
`CustKey` Required	int	–	Internal key of the customer (`Customers.CustKey`). Example: `10234`

Result set 1 · Always; empty if the customer or its address does not exist.

Customer information, at most one row.

Column	Type	Description
`Name` Nullable	string	Name from the customer's address record.
`Comment` Nullable	string	Customer history note (`CHisNote`).
`DatevUserAccount` Nullable	varchar(10) string	DATEV account number of the customer as text.
`CustomerLocked`	string	Lock flag of the customer (`Slocked`); `N` if not set.
`InvoicesReminderLevel1`	int	Number of the customer's invoices at reminder level 1.
`InvoicesReminderLevel2`	int	Number of the customer's invoices at reminder level 2.
`InvoicesReminderLevel3`	int	Number of the customer's invoices at reminder level 3.
`CustomerNRExternal` Nullable	string	External customer number (e.g. from the shop).

Response example

<SqlRowSet1>
  <row>
    <Name>Mustermann GmbH</Name>
    <Comment>Pays by invoice only</Comment>
    <DatevUserAccount>10234</DatevUserAccount>
    <CustomerLocked>N</CustomerLocked>
    <InvoicesReminderLevel1>2</InvoicesReminderLevel1>
    <InvoicesReminderLevel2>1</InvoicesReminderLevel2>
    <InvoicesReminderLevel3>0</InvoicesReminderLevel3>
    <CustomerNRExternal>SHOP-4711</CustomerNRExternal>
  </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:pixiGetCustomerInfo>
      <CustKey>10234</CustKey>
    </ns1:pixiGetCustomerInfo>
  </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:pixiGetCustomerInfo>
      <CustKey>10234</CustKey>
    </ns1:pixiGetCustomerInfo>
  </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 = [
    'CustKey' => '10234',
];

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

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