pixiCustomersOpenCases
Return customers with open invoices.
Since pixi version: LOU Official (6.3.0.4452) Additional notes:
Request
POST
https://apigateway.descartes.com/tms/pixi/pixiCustomersOpenCases
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| CustKey | integer | true | Customer ID, references table customers. Type: int Default value: Example: Available from: LOU Official (6.3.0.4452) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiCustomersOpenCases>
<CustKey>0</CustKey>
</pixiCustomersOpenCases>
</Body>
</Envelope>Response
1. Result set
| Name | Type | Description |
|---|---|---|
| Locked | integer | 1 = Ship lock is applied 0 = No lock Type: int Available from: 25.06 (25.6.0.58802) |
| OpenOrders | integer | Number of orders that contain order lines which are not on a "final state" Type: int Available from: 25.06 (25.6.0.58802) |
| BaseCurrency | string | BaseCurrency Type: varchar Available from: 25.06 (25.6.0.58802) |
| DebtByInvoices | integer | Unpaid amount, by invoices Type: int Available from: 25.06 (25.6.0.58802) |
| UnpaidInvoices | integer | Number of unpaid invoices for this customer Type: int Available from: 25.06 (25.6.0.58802) |
| OpenOrderAmount | integer | Summary amount of all open orderlines Type: int Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiCustomersOpenCasesPost200TextXmlResponse>
<Locked>0</Locked>
<OpenOrders>0</OpenOrders>
<UnpaidInvoices>0</UnpaidInvoices>
<DebtByInvoices>0</DebtByInvoices>
<OpenOrderAmount>0</OpenOrderAmount>
<BaseCurrency>string</BaseCurrency>
</PixiCustomersOpenCasesPost200TextXmlResponse>HTTP Example
POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
# echo -n '{{username}}:{{password}}' | base64 | pbcopy
Authorization: Basic {{token}}
<?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/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<SOAP-ENV:Body>
<ns1:pixiCustomersOpenCases>
<CustKey xsi:type="xsd:integer"></CustKey> <!-- required -->
</ns1:pixiCustomersOpenCases>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>PHP Example
<?php
getPixiSoapClientResponse('pixiCustomersOpenCases', [
'CustKey' => '', // integer (required)
]);
function getPixiSoapClientResponse(string $method, array $arguments = [])
{
$soapArguments = [];
foreach ($arguments as $key => $value) {
$soapArguments[] = new SoapVar($value, null, '', '', $key);
}
$soapClient = new SoapClient(null, [
'login' => '...',
'password' => '...',
'uri' => 'https://apigateway.descartes.com/tms/pixi/',
'location' => 'https://apigateway.descartes.com/tms/pixi/',
]);
return $soapClient->__call($method, $soapArguments);
}