pixiGetPosJournal
The function returns all POS events within given period of time, for a given location and a given cash register. (Both these parameters can be empty meaning "all"). Return dataset is equivalent to the report "POS Journal" available in pixi* Reports.
Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:
Request
Request body
Name | Type | Required | Description |
---|---|---|---|
LocID | string | false | Location Id Type: varchar(3) Default value: NULL Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
ToDate | string | false | End date of the event range. Type: datetime Default value: When its not specified then end of the today is taken. Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
FromDate | string | false | Start date of the event range. Type: datetime Default value: When its not specified then start of the today is taken. Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
RegisterID | string | false | POS Register Id Type: varchar(30) Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
ResultCode | string | false | Type: char Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
ResultText | string | false | Type: varchar(1024) Default value: Example: Available from: LOU Official - Update 46 (6.9.46.27927) |
Request Example
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body xmlns="">
<pixiGetPosJournal>
<FromDate>string</FromDate>
<ToDate>string</ToDate>
<LocID>string</LocID>
<RegisterID>string</RegisterID>
<ResultCode>string</ResultCode>
<ResultText>string</ResultText>
</pixiGetPosJournal>
</Body>
</Envelope>
Response
1. POS events
Name | Type | Description |
---|---|---|
VatLow | number | Vat Low Type: money Available from: 25.06 (25.6.0.58802) |
VatHigh | number | Vat High Type: money Available from: 25.06 (25.6.0.58802) |
AmountIn | number | Amount In Type: money Available from: 25.06 (25.6.0.58802) |
AmountOut | number | Amount Out Type: money Available from: 25.06 (25.6.0.58802) |
CreatedBy | string | Created By Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
EventTime | string | Event Time Type: datetime Available from: 25.06 (25.6.0.58802) |
EventType | string | Event Type Type: char (1) Available from: 25.06 (25.6.0.58802) |
InvoiceNr | string | Invoice Nr Type: varchar (20) Available from: 25.06 (25.6.0.58802) |
UpdatedBy | string | Updated By Type: varchar (50) Available from: 25.06 (25.6.0.58802) |
RegisterID | string | POS Register Id Type: varchar (30) Available from: 25.06 (25.6.0.58802) |
EventComment | string | Event Comment Type: varchar (max) Available from: 25.06 (25.6.0.58802) |
InvoiceAmount | number | Invoice Amount Type: money Available from: 25.06 (25.6.0.58802) |
RegisterValue | number | Register Value Type: money Available from: 25.06 (25.6.0.58802) |
EventDescription | string | Event Description Type: varchar (100) Available from: 25.06 (25.6.0.58802) |
Response Example
<PixiGetPosJournalPost200TextXmlResponse>
<EventTime>string</EventTime>
<RegisterID>string</RegisterID>
<CreatedBy>string</CreatedBy>
<UpdatedBy>string</UpdatedBy>
<EventType>string</EventType>
<EventDescription>string</EventDescription>
<InvoiceNr>string</InvoiceNr>
<InvoiceAmount>0</InvoiceAmount>
<EventComment>string</EventComment>
<AmountOut>0</AmountOut>
<VatHigh>0</VatHigh>
<VatLow>0</VatLow>
<AmountIn>0</AmountIn>
<RegisterValue>0</RegisterValue>
</PixiGetPosJournalPost200TextXmlResponse>
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:pixiGetPosJournal>
<LocID xsi:type="xsd:string"></LocID>
<ToDate xsi:type="xsd:string"></ToDate>
<FromDate xsi:type="xsd:string"></FromDate>
<RegisterID xsi:type="xsd:string"></RegisterID>
<ResultCode xsi:type="xsd:string"></ResultCode>
<ResultText xsi:type="xsd:string"></ResultText>
</ns1:pixiGetPosJournal>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>
PHP Example
<?php
getPixiSoapClientResponse('pixiGetPosJournal', [
'LocID' => '', // string
'ToDate' => '', // string
'FromDate' => '', // string
'RegisterID' => '', // string
'ResultCode' => '', // string
'ResultText' => '', // 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);
}