pixiGetVATRatesHistory · Pixi API documentation

Returns every row of the VAT rate history table VATsHist without any filter.

Each row contains the old and new text of a change (HText, LText), a remark, and the date and employee of the change.

The call has no parameters. No sort order is defined, so the row order is not guaranteed.

Notes

The table is read with NOLOCK, so uncommitted changes can appear.
The code does not show the meaning of HText and LText. By the column names they are probably a header text and a long text describing the change, but this cannot be confirmed from the code.
The result is not limited or paged. All history entries are returned.

Tables used

VATsHist · Read

This call has no parameters.

Result set 1 · Always

All entries of the VAT rate history.

Column	Type	Description
`HText` Nullable	string	Text of the history entry (probably a short or header text).
`LText` Nullable	string	Text of the history entry (probably a long text).
`HistRemark` Nullable	string	Remark of the history entry.
`UpdateDate` Nullable	dateTime	Date and time of the change.
`UpdateEmp` Nullable	string	Employee who made the change.

Response example

<SqlRowSet1>
  <row>
    <HText>VAT rate 1</HText>
    <LText>Rate changed from 16.00 to 19.00</LText>
    <HistRemark>Annual adjustment</HistRemark>
    <UpdateDate>2021-01-01T00:05:12.000+01:00</UpdateDate>
    <UpdateEmp>MP</UpdateEmp>
  </row>
</SqlRowSet1>

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
Authorization: Basic BASE64(USERNAME:PASSWORD)

<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiGetVATRatesHistory/>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

curl -X POST 'https://apigateway.descartes.com/tms/pixi/' \
  --user 'USERNAME:PASSWORD' \
  --header 'Content-Type: text/xml; charset=utf-8' \
  --data-binary @- <<'XML'
<?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/">
  <SOAP-ENV:Body>
    <ns1:pixiGetVATRatesHistory/>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
XML

<?php

$soapClient = new SoapClient(null, [
    'login' => 'USERNAME',
    'password' => 'PASSWORD',
    'location' => 'https://apigateway.descartes.com/tms/pixi/',
    'uri' => 'https://apigateway.descartes.com/tms/pixi/',
]);

$arguments = [
];

$soapArguments = [];
foreach ($arguments as $name => $value) {
    $soapArguments[] = new SoapVar($value, XSD_STRING, '', '', $name);
}

$response = $soapClient->__soapCall('pixiGetVATRatesHistory', $soapArguments);