pixiGetCurrency · Pixi API documentation

Reads the currency code table pixi.Currency and returns only entries marked as parent currency (ParentCurrency = 1).

Without parameters, all parent currencies are returned.
CurrencyCode filters by the alphabetic ISO code (CodeA), e.g. EUR.
CurrencyId filters by the internal currency ID.
Both filters can be combined; a row must then match both.
NULL values are treated like the defaults (empty string or 0), i.e. the filter is not applied.

Inactive currencies are included as well; the Active column shows their state. No explicit sort order is defined.

Notes

The table is read with NOLOCK, so uncommitted changes may be visible.
Currencies that are not parent currencies (ParentCurrency other than 1) are never returned, even when their code or ID is passed explicitly; the result is then empty.
The row order is not guaranteed because the query has no ORDER BY.

Tables used

Currency · Read

Parameter	Type	Default	Description
`CurrencyCode`	varchar(3) string	–	Alphabetic ISO currency code (`CodeA`) to filter by. Empty string or NULL returns all parent currencies. Example: `EUR`
`CurrencyId`	smallint int	0	Internal currency ID to filter by. `0` or NULL disables this filter. Example: `2`

Result set 1 · Always (may be empty if no parent currency matches the filters)

One row per matching parent currency.

Column	Type	Description
`Id`	smallint int	Internal currency ID.
`Code` Nullable	varchar(3) string	Alphabetic ISO currency code (`CodeA`).
`CodeNumber` Nullable	string	Numeric ISO currency code (`CodeN`).
`Active` Nullable	boolean	Indicates whether the currency is active.
`LocaleId` Nullable	int	Windows locale ID (`LCID`) associated with the currency.

Response example

<SqlRowSet1>
  <row>
    <Id>2</Id>
    <Code>EUR</Code>
    <CodeNumber>978</CodeNumber>
    <Active>1</Active>
    <LocaleId>1031</LocaleId>
  </row>
  <row>
    <Id>3</Id>
    <Code>CHF</Code>
    <CodeNumber>756</CodeNumber>
    <Active>1</Active>
    <LocaleId>2055</LocaleId>
  </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:pixiGetCurrency>
      <!-- <CurrencyCode>EUR</CurrencyCode> -->
      <!-- <CurrencyId>2</CurrencyId> -->
    </ns1:pixiGetCurrency>
  </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:pixiGetCurrency>
      <!-- <CurrencyCode>EUR</CurrencyCode> -->
      <!-- <CurrencyId>2</CurrencyId> -->
    </ns1:pixiGetCurrency>
  </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 = [
    // 'CurrencyCode' => 'EUR',
    // 'CurrencyId' => '2',
];

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

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