Description
This API call returns various customer events, depending on the given parameters. Be aware, that all parameters are combined with an AND condition. Although the event date and the create date a very similar there can be a difference up to a few seconds.
Request Parameters
# |
Name |
Type |
Required |
Example |
Description |
1 |
EventID |
string |
0 |
Sample text |
Returns one specific event by the given ID |
2 |
CreateDateFrom |
string |
0 |
YYYY-MM-DD hh:mm:ss |
[yyyy-mm-dd hh:ii:ss / 1970-01-01 15:00:00] Returns events from that given date on |
3 |
CreateDateTo |
string |
0 |
YYYY-MM-DD hh:mm:ss |
[yyyy-mm-dd hh:ii:ss / 1970-01-01 15:00:00] Returns events to that given date |
4 |
UpdateDateFrom |
string |
0 |
YYYY-MM-DD hh:mm:ss |
[yyyy-mm-dd hh:ii:ss / 1970-01-01 15:00:00] Returns events from that given date on |
5 |
UpdateDateTo |
string |
0 |
YYYY-MM-DD hh:mm:ss |
[yyyy-mm-dd hh:ii:ss / 1970-01-01 15:00:00] Returns events to that given date |
6 |
EventDateFrom |
string |
0 |
YYYY-MM-DD hh:mm:ss |
EventDateFrom |
7 |
EventDateTo |
string |
0 |
YYYY-MM-DD hh:mm:ss |
[yyyy-mm-dd hh:ii:ss / 1970-01-01 15:00:00] Returns events to that given date. |
8 |
MinAmount |
number |
0 |
19.90 |
Show only events with the given minimum amount |
9 |
MaxAmount |
number |
0 |
19.90 |
Show only events with the given maximum amount |
10 |
MinMatchedAmount |
number |
0 |
19.90 |
Show only events with the given minimum amount that has been matched |
11 |
MaxMatchedAmount |
number |
0 |
19.90 |
Show only events with the given maximum amount that has been matched |
12 |
InvoiceRef |
integer |
0 |
123 |
Show only events that are related to a certain invoice |
13 |
DoNotRefund |
boolean |
0 |
0/1 |
Filters events that should not be refund |
14 |
PaymentCode |
string |
0 |
A |
Show only events that have a specific payment code |
15 |
CustRef |
integer |
0 |
123 |
Show only events that are related to a specific customer |
16 |
ShowDeleted |
boolean |
0 |
0/1 |
Show also deleted events |
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:pixiCAGetEvents>
<dem:EventID>Sample text</dem:EventID>
<dem:CreateDateFrom>YYYY-MM-DD hh:mm:ss</dem:CreateDateFrom>
<dem:CreateDateTo>YYYY-MM-DD hh:mm:ss</dem:CreateDateTo>
<dem:UpdateDateFrom>YYYY-MM-DD hh:mm:ss</dem:UpdateDateFrom>
<dem:UpdateDateTo>YYYY-MM-DD hh:mm:ss</dem:UpdateDateTo>
<dem:EventDateFrom>YYYY-MM-DD hh:mm:ss</dem:EventDateFrom>
<dem:EventDateTo>YYYY-MM-DD hh:mm:ss</dem:EventDateTo>
<dem:MinAmount>19.90</dem:MinAmount>
<dem:MaxAmount>19.90</dem:MaxAmount>
<dem:MinMatchedAmount>19.90</dem:MinMatchedAmount>
<dem:MaxMatchedAmount>19.90</dem:MaxMatchedAmount>
<dem:InvoiceRef>123</dem:InvoiceRef>
<dem:DoNotRefund>0/1</dem:DoNotRefund>
<dem:PaymentCode>A</dem:PaymentCode>
<dem:CustRef>123</dem:CustRef>
<dem:ShowDeleted>0/1</dem:ShowDeleted>
</dem:pixiCAGetEvents>
</soapenv:Body>
</soapenv:Envelope>Response
Body 1: Result set
# |
Name |
Type |
Description |
1 |
CustomerAccountKey |
integer |
Customer Account ID. |
2 |
CustRef |
integer |
CustKey from table dbo.Customers. |
3 |
EventID |
string |
Event ID |
4 |
EventDate |
string |
Event Date |
5 |
Reference |
string |
Reference |
6 |
Amount |
number |
Amount |
7 |
Matched |
number |
Matched |
8 |
InvoiceRef |
integer |
Reference to Invoice |
9 |
ManualBookingRef |
integer |
Reference to Manual Booking |
10 |
DoNotRefund |
boolean |
Do Not Refund |
11 |
CreateEmp |
string |
User who created Customer Account |
12 |
CreateDate |
string |
Record create date |
13 |
UpdateEmp |
string |
User who updated Customer Account |
14 |
UpdateDate |
string |
Record updated date |
15 |
Comment |
string |
DoNotRefund |
16 |
IsDeleted |
boolean |
IsDeleted |
17 |
OrderCurrency |
string |
OrderCurrency |
Additional Notes