pixiGetRemindersCA
Returns list of Reminders including Customer account data for given parameters - Reminder level, Payment type, Shop, Reminder days, Dates and some financial parameters.
Since pixi version: LOU Official (6.3.0.4452) Additional notes: Customers data is taken from Billing Address
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
ShopID | string | false | Allows to filter results by Shop. Type: char Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
InvoiceTo | string | false | Invoice date to. If not set, current date minus reminder days is used. Type: datetime Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
InvoiceFrom | string | false | Invoice date from. Type: datetime Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
PaymentType | string | false | Allows to filter results by Invoice Payment type. Type: char Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
ReminderDays | integer | false | Allows to filter results by Invoice age (in days). Type: int Default value: 1 Example: Available from: LOU Official (6.3.0.4452) |
OnlyUnmatched | boolean | false | Show only Invoices that are not completely paid. Type: bit Default value: 0 Example: Available from: LOU Official (6.3.0.4452) |
ReminderLevel | integer | false | Allows to filter results by Reminder level. Type: int Default value: NULL Example: Available from: LOU Official (6.3.0.4452) |
OnlyWhenCAUnbalanced | boolean | false | Show only Invoices from not balanced Customer accounts. Type: bit Default value: 0 Example: Available from: LOU Official (6.3.0.4452) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetRemindersCA>
<ReminderLevel>0</ReminderLevel>
<PaymentType>string</PaymentType>
<ShopID>string</ShopID>
<ReminderDays>0</ReminderDays>
<InvoiceFrom>string</InvoiceFrom>
<InvoiceTo>string</InvoiceTo>
<OnlyUnmatched>true</OnlyUnmatched>
<OnlyWhenCAUnbalanced>true</OnlyWhenCAUnbalanced>
</pixiGetRemindersCA>
</Body>
</Envelope>
Response
1. Returns list of Reminders with Customer account data
Name | Type | Description |
---|---|---|
ZIP | string | ZIP from address of customer Type: VARCHAR Available from: / (25.7.0.59144) |
fax | string | Fax number from address of customer Type: VARCHAR Available from: / (25.7.0.59144) |
City | string | City from address of customer Type: VARCHAR Available from: / (25.7.0.59144) |
string | Email address from address of customer Type: VARCHAR Available from: / (25.7.0.59144) |
|
Phone | string | Phone number from address of customer Type: VARCHAR Available from: / (25.7.0.59144) |
State | string | State from address of customer Type: VARCHAR Available from: / (25.7.0.59144) |
ShopID | string | pixi Shop Id Type: VARCHAR Available from: / (25.7.0.59144) |
Street | string | Street from address of customer Type: VARCHAR Available from: / (25.7.0.59144) |
AddrKey | integer | Billing address Id - internal Type: INT Available from: / (25.7.0.59144) |
Company | string | Company of customer - optional Type: VARCHAR Available from: / (25.7.0.59144) |
Country | string | Country code from address of customer Type: VARCHAR Available from: / (25.7.0.59144) |
CustKey | integer | Customer Id - internal Type: INT Available from: / (25.7.0.59144) |
HouseNr | string | House number from address of customer Type: VARCHAR Available from: / (25.7.0.59144) |
FullName | string | Full name of customer Type: VARCHAR Available from: / (25.7.0.59144) |
LastName | string | Last name of customer Type: VARCHAR Available from: / (25.7.0.59144) |
CAMatched | boolean | Flag if Customer account is matched for Customer Type: BIT Available from: / (25.7.0.59144) |
FirstName | string | First name of customer Type: VARCHAR Available from: / (25.7.0.59144) |
InvoiceNr | string | Invoice number Type: VARCHAR Available from: / (25.7.0.59144) |
InvoiceKey | integer | Invoice Id - internal Type: INT Available from: / (25.7.0.59144) |
AddressLine | string | Full street address of customer Type: VARCHAR Available from: / (25.7.0.59144) |
InvoiceDate | string | Invoice creation date Type: DATETIME Available from: / (25.7.0.59144) |
LastOrderNr | integer | Last pixi Order number for Invoice Type: INT Available from: / (25.7.0.59144) |
InvoiceTotal | number | Invoice total amount Type: MONEY Available from: / (25.7.0.59144) |
ReminderDate1 | string | Date of Reminder level 1 for the Invoice Type: DATETIME Available from: / (25.7.0.59144) |
ReminderDate2 | string | Date of Reminder level 2 for the Invoice Type: DATETIME Available from: / (25.7.0.59144) |
ReminderDate3 | string | Date of Reminder level 3 for the Invoice Type: DATETIME Available from: / (25.7.0.59144) |
ReminderDate4 | string | Date of Reminder level 4 for the Invoice Type: DATETIME Available from: / (25.7.0.59144) |
ReminderDate5 | string | Date of Reminder level 5 for the Invoice Type: DATETIME Available from: / (25.7.0.59144) |
ReminderDate6 | string | Date of Reminder level 6 for the Invoice Type: DATETIME Available from: / (25.7.0.59144) |
AllReminderCosts | number | Costs of all reminders for the Invoice Type: MONEY Available from: / (25.7.0.59144) |
LastReminderCosts | number | Costs of last reminder for the Invoice Type: MONEY Available from: / (25.7.0.59144) |
OpenInvoiceAmount | number | Open amount for the Invoice Type: MONEY Available from: / (25.7.0.59144) |
CAFinancialBalance | number | Customer account financial balance Type: MONEY Available from: / (25.7.0.59144) |
CustomerNrExternal | string | External Customer number Type: VARCHAR Available from: / (25.7.0.59144) |
LastOrderNrExternal | string | Last external (shop) Order number for Invoice Type: VARCHAR Available from: / (25.7.0.59144) |
CurrentReminderLevel | integer | Maximum reminder level for Invoice Type: INT Available from: / (25.7.0.59144) |
Response Example
<PixiGetRemindersCAPost200TextXmlResponse>
<InvoiceKey>0</InvoiceKey>
<InvoiceNr>string</InvoiceNr>
<CustKey>0</CustKey>
<AddrKey>0</AddrKey>
<ShopID>string</ShopID>
<LastOrderNr>0</LastOrderNr>
<LastOrderNrExternal>string</LastOrderNrExternal>
<InvoiceDate>string</InvoiceDate>
<InvoiceTotal>0</InvoiceTotal>
<CurrentReminderLevel>0</CurrentReminderLevel>
<ReminderDate1>string</ReminderDate1>
<ReminderDate2>string</ReminderDate2>
<ReminderDate3>string</ReminderDate3>
<ReminderDate4>string</ReminderDate4>
<ReminderDate5>string</ReminderDate5>
<ReminderDate6>string</ReminderDate6>
<LastReminderCosts>0</LastReminderCosts>
<AllReminderCosts>0</AllReminderCosts>
<OpenInvoiceAmount>0</OpenInvoiceAmount>
<CAMatched>true</CAMatched>
<CAFinancialBalance>0</CAFinancialBalance>
<CustomerNrExternal>string</CustomerNrExternal>
<Company>string</Company>
<FirstName>string</FirstName>
<LastName>string</LastName>
<FullName>string</FullName>
<Street>string</Street>
<HouseNr>string</HouseNr>
<AddressLine>string</AddressLine>
<ZIP>string</ZIP>
<City>string</City>
<State>string</State>
<Country>string</Country>
<Phone>string</Phone>
<fax>string</fax>
<Email>string</Email>
</PixiGetRemindersCAPost200TextXmlResponse>
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:pixiGetRemindersCA>
<ShopID xsi:type="xsd:string"></ShopID>
<InvoiceTo xsi:type="xsd:string"></InvoiceTo>
<InvoiceFrom xsi:type="xsd:string"></InvoiceFrom>
<PaymentType xsi:type="xsd:string"></PaymentType>
<ReminderDays xsi:type="xsd:integer"></ReminderDays>
<OnlyUnmatched xsi:type="xsd:boolean"></OnlyUnmatched>
<ReminderLevel xsi:type="xsd:integer"></ReminderLevel>
<OnlyWhenCAUnbalanced xsi:type="xsd:boolean"></OnlyWhenCAUnbalanced>
</ns1:pixiGetRemindersCA>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetRemindersCA', [
'ShopID' => '', // string
'InvoiceTo' => '', // string
'InvoiceFrom' => '', // string
'PaymentType' => '', // string
'ReminderDays' => '', // integer
'OnlyUnmatched' => '', // boolean
'ReminderLevel' => '', // integer
'OnlyWhenCAUnbalanced' => '', // boolean
]);
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);
}