pixiCAGetEvents
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.
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
CustRef | integer | false | Show only events that are related to a specific customer Type: int Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
EventID | string | false | Returns one specific event by the given ID Type: varchar(3) Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
MaxAmount | number | false | Show only events with the given maximum amount Type: money Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
MinAmount | number | false | Show only events with the given minimum amount Type: money Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
InvoiceRef | integer | false | Show only events that are related to a certain invoice Type: int Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
DoNotRefund | boolean | false | Filters events that should not be refund Type: bit Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
EventDateTo | string | false | [yyyy-mm-dd hh:ii:ss / 1970-01-01 15:00:00] Returns events to that given date. Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
PaymentCode | string | false | Show only events that have a specific payment code Type: char Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
ShowDeleted | boolean | false | Show also deleted events Type: bit Default value: 0 Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
CreateDateTo | string | false | [yyyy-mm-dd hh:ii:ss / 1970-01-01 15:00:00] Returns events to that given date Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
UpdateDateTo | string | false | [yyyy-mm-dd hh:ii:ss / 1970-01-01 15:00:00] Returns events to that given date Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
EventDateFrom | string | false | EventDateFrom Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
CreateDateFrom | string | false | [yyyy-mm-dd hh:ii:ss / 1970-01-01 15:00:00] Returns events from that given date on Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
UpdateDateFrom | string | false | [yyyy-mm-dd hh:ii:ss / 1970-01-01 15:00:00] Returns events from that given date on Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
MaxMatchedAmount | number | false | Show only events with the given maximum amount that has been matched Type: money Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
MinMatchedAmount | number | false | Show only events with the given minimum amount that has been matched Type: money Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiCAGetEvents>
<EventID>string</EventID>
<CreateDateFrom>string</CreateDateFrom>
<CreateDateTo>string</CreateDateTo>
<UpdateDateFrom>string</UpdateDateFrom>
<UpdateDateTo>string</UpdateDateTo>
<EventDateFrom>string</EventDateFrom>
<EventDateTo>string</EventDateTo>
<MinAmount>0</MinAmount>
<MaxAmount>0</MaxAmount>
<MinMatchedAmount>0</MinMatchedAmount>
<MaxMatchedAmount>0</MaxMatchedAmount>
<InvoiceRef>0</InvoiceRef>
<DoNotRefund>true</DoNotRefund>
<PaymentCode>string</PaymentCode>
<CustRef>0</CustRef>
<ShowDeleted>true</ShowDeleted>
</pixiCAGetEvents>
</Body>
</Envelope>
Response
1. Result set
Name | Type | Description |
---|---|---|
Amount | number | Amount Type: money Available from: / (25.7.0.59144) |
Comment | string | DoNotRefund Type: varchar Available from: / (25.7.0.59144) |
CustRef | integer | CustKey from table dbo.Customers. Type: int Available from: / (25.7.0.59144) |
EventID | string | Event ID Type: varchar Available from: / (25.7.0.59144) |
Matched | number | Matched Type: money Available from: / (25.7.0.59144) |
CreateEmp | string | User who created Customer Account Type: varchar Available from: / (25.7.0.59144) |
EventDate | string | Event Date Type: datetime Available from: / (25.7.0.59144) |
IsDeleted | boolean | IsDeleted Type: bit Available from: / (25.7.0.59144) |
Reference | string | Reference Type: varchar Available from: / (25.7.0.59144) |
UpdateEmp | string | User who updated Customer Account Type: varchar Available from: / (25.7.0.59144) |
CreateDate | string | Record create date Type: datetime Available from: / (25.7.0.59144) |
InvoiceRef | integer | Reference to Invoice Type: int Available from: / (25.7.0.59144) |
UpdateDate | string | Record updated date Type: datetime Available from: / (25.7.0.59144) |
DoNotRefund | boolean | Do Not Refund Type: bit Available from: / (25.7.0.59144) |
OrderCurrency | string | OrderCurrency Type: varchar Available from: / (25.7.0.59144) |
ManualBookingRef | integer | Reference to Manual Booking Type: int Available from: / (25.7.0.59144) |
CustomerAccountKey | integer | Customer Account ID. Type: int Available from: / (25.7.0.59144) |
Response Example
<PixiCAGetEventsPost200TextXmlResponse>
<CustomerAccountKey>0</CustomerAccountKey>
<CustRef>0</CustRef>
<EventID>string</EventID>
<EventDate>string</EventDate>
<Reference>string</Reference>
<Amount>0</Amount>
<Matched>0</Matched>
<InvoiceRef>0</InvoiceRef>
<ManualBookingRef>0</ManualBookingRef>
<DoNotRefund>true</DoNotRefund>
<CreateEmp>string</CreateEmp>
<CreateDate>string</CreateDate>
<UpdateEmp>string</UpdateEmp>
<UpdateDate>string</UpdateDate>
<Comment>string</Comment>
<IsDeleted>true</IsDeleted>
<OrderCurrency>string</OrderCurrency>
</PixiCAGetEventsPost200TextXmlResponse>
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:pixiCAGetEvents>
<CustRef xsi:type="xsd:integer"></CustRef>
<EventID xsi:type="xsd:string"></EventID>
<MaxAmount xsi:type="xsd:number"></MaxAmount>
<MinAmount xsi:type="xsd:number"></MinAmount>
<InvoiceRef xsi:type="xsd:integer"></InvoiceRef>
<DoNotRefund xsi:type="xsd:boolean"></DoNotRefund>
<EventDateTo xsi:type="xsd:string"></EventDateTo>
<PaymentCode xsi:type="xsd:string"></PaymentCode>
<ShowDeleted xsi:type="xsd:boolean"></ShowDeleted>
<CreateDateTo xsi:type="xsd:string"></CreateDateTo>
<UpdateDateTo xsi:type="xsd:string"></UpdateDateTo>
<EventDateFrom xsi:type="xsd:string"></EventDateFrom>
<CreateDateFrom xsi:type="xsd:string"></CreateDateFrom>
<UpdateDateFrom xsi:type="xsd:string"></UpdateDateFrom>
<MaxMatchedAmount xsi:type="xsd:number"></MaxMatchedAmount>
<MinMatchedAmount xsi:type="xsd:number"></MinMatchedAmount>
</ns1:pixiCAGetEvents>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiCAGetEvents', [
'CustRef' => '', // integer
'EventID' => '', // string
'MaxAmount' => '', // number
'MinAmount' => '', // number
'InvoiceRef' => '', // integer
'DoNotRefund' => '', // boolean
'EventDateTo' => '', // string
'PaymentCode' => '', // string
'ShowDeleted' => '', // boolean
'CreateDateTo' => '', // string
'UpdateDateTo' => '', // string
'EventDateFrom' => '', // string
'CreateDateFrom' => '', // string
'UpdateDateFrom' => '', // string
'MaxMatchedAmount' => '', // number
'MinMatchedAmount' => '', // number
]);
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);
}