pixiReadCustomerAccount
API Call to retrieve all customer account lines
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
RowCount | integer | false | Number of rows returned maximum Type: int Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
CreateDateTo | string | false | Create Date to (excluding) Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
UpdateDateTo | string | false | Update Date To (excluding) Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
CreateDateFrom | string | false | Create Date from (including) Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
UpdateDateFrom | string | false | Update Date from (including) Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
CustomerAccountKey | integer | false | pixi* Customer Account Key Type: int Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
CreateAndUpdateDateTo | string | false | Create or Update Date to (excluding) Type: datetime Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
CreateAndUpdateDateFrom | string | false | Create or Update Date from (including) Type: datetime 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="">
<pixiReadCustomerAccount>
<CustomerAccountKey>0</CustomerAccountKey>
<CreateDateFrom>string</CreateDateFrom>
<CreateDateTo>string</CreateDateTo>
<UpdateDateFrom>string</UpdateDateFrom>
<UpdateDateTo>string</UpdateDateTo>
<CreateAndUpdateDateFrom>string</CreateAndUpdateDateFrom>
<CreateAndUpdateDateTo>string</CreateAndUpdateDateTo>
<RowCount>0</RowCount>
</pixiReadCustomerAccount>
</Body>
</Envelope>
Response
1. Result set
Name | Type | Description |
---|---|---|
Amount | string | Amount Type: varchar Available from: 25.06 (25.6.0.58802) |
CATKey | integer | CATKey Type: int Available from: 25.06 (25.6.0.58802) |
Comment | string | Comment Type: varchar Available from: 25.06 (25.6.0.58802) |
CustRef | integer | CustRef Type: int Available from: 25.06 (25.6.0.58802) |
EventID | string | EventID Type: varchar Available from: 25.06 (25.6.0.58802) |
Matched | string | Matched Type: varchar Available from: 25.06 (25.6.0.58802) |
DTAUSref | integer | DTAUSref Type: int Available from: 25.06 (25.6.0.58802) |
CreateEmp | string | CreateEmp Type: varchar Available from: 25.06 (25.6.0.58802) |
EventDate | string | EventDate Type: datetime Available from: 25.06 (25.6.0.58802) |
Reference | string | Reference Type: varchar Available from: 25.06 (25.6.0.58802) |
UpdateEmp | string | UpdateEmp Type: varchar Available from: 25.06 (25.6.0.58802) |
CreateDate | string | CreateDate Type: datetime Available from: 25.06 (25.6.0.58802) |
CurrencyId | integer | CurrencyId Type: int Available from: 25.06 (25.6.0.58802) |
ExchRateId | integer | ExchRateId Type: int Available from: 25.06 (25.6.0.58802) |
InvoiceRef | integer | InvoiceRef Type: int Available from: 25.06 (25.6.0.58802) |
UpdateDate | string | UpdateDate Type: datetime Available from: 25.06 (25.6.0.58802) |
BanklineRef | integer | BanklineRef Type: int Available from: 25.06 (25.6.0.58802) |
DoNotRefund | boolean | DoNotRefund Type: bit Available from: 25.06 (25.6.0.58802) |
ManualBookingRef | integer | ManualBookingRef Type: int Available from: 25.06 (25.6.0.58802) |
CustomerAccountKey | integer | CustomerAccountKey Type: int Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiReadCustomerAccountPost200TextXmlResponse>
<CustomerAccountKey>0</CustomerAccountKey>
<CustRef>0</CustRef>
<EventID>string</EventID>
<EventDate>string</EventDate>
<Reference>string</Reference>
<Amount>string</Amount>
<Matched>string</Matched>
<InvoiceRef>0</InvoiceRef>
<BanklineRef>0</BanklineRef>
<DTAUSref>0</DTAUSref>
<ManualBookingRef>0</ManualBookingRef>
<DoNotRefund>true</DoNotRefund>
<CreateEmp>string</CreateEmp>
<CreateDate>string</CreateDate>
<UpdateEmp>string</UpdateEmp>
<UpdateDate>string</UpdateDate>
<Comment>string</Comment>
<CATKey>0</CATKey>
<ExchRateId>0</ExchRateId>
<CurrencyId>0</CurrencyId>
</PixiReadCustomerAccountPost200TextXmlResponse>
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:pixiReadCustomerAccount>
<RowCount xsi:type="xsd:integer"></RowCount>
<CreateDateTo xsi:type="xsd:string"></CreateDateTo>
<UpdateDateTo xsi:type="xsd:string"></UpdateDateTo>
<CreateDateFrom xsi:type="xsd:string"></CreateDateFrom>
<UpdateDateFrom xsi:type="xsd:string"></UpdateDateFrom>
<CustomerAccountKey xsi:type="xsd:integer"></CustomerAccountKey>
<CreateAndUpdateDateTo xsi:type="xsd:string"></CreateAndUpdateDateTo>
<CreateAndUpdateDateFrom xsi:type="xsd:string"></CreateAndUpdateDateFrom>
</ns1:pixiReadCustomerAccount>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiReadCustomerAccount', [
'RowCount' => '', // integer
'CreateDateTo' => '', // string
'UpdateDateTo' => '', // string
'CreateDateFrom' => '', // string
'UpdateDateFrom' => '', // string
'CustomerAccountKey' => '', // integer
'CreateAndUpdateDateTo' => '', // string
'CreateAndUpdateDateFrom' => '', // string
]);
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);
}