Description
Returns list of Reminders including Customer account data for given parameters - Reminder level, Payment type, Shop, Reminder days, Dates and some financial parameters.
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
ReminderLevel |
integer |
0 |
123 |
Allows to filter results by Reminder level. |
2 |
PaymentType |
string |
0 |
A |
Allows to filter results by Invoice Payment type. |
3 |
ShopID |
string |
0 |
A |
Allows to filter results by Shop. |
4 |
ReminderDays |
integer |
0 |
123 |
Allows to filter results by Invoice age (in days). |
5 |
InvoiceFrom |
string |
0 |
YYYY-MM-DD hh:mm:ss |
Invoice date from. |
6 |
InvoiceTo |
string |
0 |
YYYY-MM-DD hh:mm:ss |
Invoice date to. If not set, current date minus reminder days is used. |
7 |
OnlyUnmatched |
boolean |
0 |
0/1 |
Show only Invoices that are not completely paid. |
8 |
OnlyWhenCAUnbalanced |
boolean |
0 |
0/1 |
Show only Invoices from not balanced Customer accounts. |
Request body
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:dem="https://api.pixi.eu/soap/demosandbox/">
<soapenv:Header/>
<soapenv:Body>
<dem:pixiGetRemindersCA>
<dem:ReminderLevel>123</dem:ReminderLevel>
<dem:PaymentType>A</dem:PaymentType>
<dem:ShopID>A</dem:ShopID>
<dem:ReminderDays>123</dem:ReminderDays>
<dem:InvoiceFrom>YYYY-MM-DD hh:mm:ss</dem:InvoiceFrom>
<dem:InvoiceTo>YYYY-MM-DD hh:mm:ss</dem:InvoiceTo>
<dem:OnlyUnmatched>0/1</dem:OnlyUnmatched>
<dem:OnlyWhenCAUnbalanced>0/1</dem:OnlyWhenCAUnbalanced>
</dem:pixiGetRemindersCA>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Returns list of Reminders with Customer account data
# |
Name |
Type |
Description |
1 |
InvoiceKey |
integer |
Invoice Id - internal |
2 |
InvoiceNr |
string |
Invoice number |
3 |
CustKey |
integer |
Customer Id - internal |
4 |
AddrKey |
integer |
Billing address Id - internal |
5 |
ShopID |
string |
pixi Shop Id |
6 |
LastOrderNr |
integer |
Last pixi Order number for Invoice |
7 |
LastOrderNrExternal |
string |
Last external (shop) Order number for Invoice |
8 |
InvoiceDate |
string |
Invoice creation date |
9 |
InvoiceTotal |
number |
Invoice total amount |
10 |
CurrentReminderLevel |
integer |
Maximum reminder level for Invoice |
11 |
ReminderDate1 |
string |
Date of Reminder level 1 for the Invoice |
12 |
ReminderDate2 |
string |
Date of Reminder level 2 for the Invoice |
13 |
ReminderDate3 |
string |
Date of Reminder level 3 for the Invoice |
14 |
ReminderDate4 |
string |
Date of Reminder level 4 for the Invoice |
15 |
ReminderDate5 |
string |
Date of Reminder level 5 for the Invoice |
16 |
ReminderDate6 |
string |
Date of Reminder level 6 for the Invoice |
17 |
LastReminderCosts |
number |
Costs of last reminder for the Invoice |
18 |
AllReminderCosts |
number |
Costs of all reminders for the Invoice |
19 |
OpenInvoiceAmount |
number |
Open amount for the Invoice |
20 |
CAMatched |
boolean |
Flag if Customer account is matched for Customer |
21 |
CAFinancialBalance |
number |
Customer account financial balance |
22 |
CustomerNrExternal |
string |
External Customer number |
23 |
Company |
string |
Company of customer - optional |
24 |
FirstName |
string |
First name of customer |
25 |
LastName |
string |
Last name of customer |
26 |
FullName |
string |
Full name of customer |
27 |
Street |
string |
Street from address of customer |
28 |
HouseNr |
string |
House number from address of customer |
29 |
AddressLine |
string |
Full street address of customer |
30 |
ZIP |
string |
ZIP from address of customer |
31 |
City |
string |
City from address of customer |
32 |
State |
string |
State from address of customer |
33 |
Country |
string |
Country code from address of customer |
34 |
Phone |
string |
Phone number from address of customer |
35 |
fax |
string |
Fax number from address of customer |
36 |
string |
Email address from address of customer |
Additional Notes
Customers data is taken from Billing Address