http://integratx.sourceforge.net
Web Services Support Module: Currency Exchange Rates
The Currency Exchange Rates support module is part of the functionality included
in IntegraTx. Click here to learn more about
Support Modules. This functionality is provided as Web Services that can
be called from IntegraTx's Client Applications and from the Core Transaction
Modules.
The Currency Exchange Rates support module provides functionality commonly needed in corporate transaction applications. For instance, a client current account can be affected with transactions executed in different currencies, or headquarters might require consolidated balance information from different countries.
IntegraTx base implementation comes with ISO 4217 currency codes, but other codes can be used as well. In addition, IntegraTx provides equivalency tables to map currency codes that might be different in the client applications.
If the company that implements IntegraTx already has a Currency Exchange Rate
management system and wishes to keep it, IntegraTx provides interfaces that
can access external information, both real-time and batch. This way, IntegraTx
can be implemented as a Web Services adapter.
The prefix used in this module Web Services is "Curr".
Use Cases provided by the Currency Exchange Rates module
Use Case 1: The local currency and country can be obtained (it depends
on the application code). Local Currency and Country is set by IntegraTx administrator,
and depends on the company: since IntegraTx manages information at the group
level (one group has many companies), and the companies can reside in different
countries, different companies can manage different local currencies.
The administrator sets the company's country from the administrator menu when
creates/updates companies, and the Web Service CurrGetLocalCurrency obtains
the local currency in that country.
The Exchange Rate at the Company level is a general Exchange Rate for all the
Client Applications managed in that Company. Therefore, an Exchange Rate should
exist at the Company level before it is created at the Client Application level.
When setting an Exchange Rate at the Client Application level, if it doesn't exist at the Company level, the Web Service will throw an error.
If a Client Application needs to obtain an Exchange Rate, if an Exchange Rate was assigned at the Client Application level, then that value will be returned. Otherwise, the value at the Company level will be returned (the Web Service CurrGetExchangeRate is resposible for this, but it is explained here to add clarity).
Web Service name: CurrGetLocalInfo
Name/Description |
Input/Output | XML/Soap Name |
Type |
| Company code | Input | company | String |
| Application Code (optional) | Input | application | String |
| Local Currency Code | Ouput | local_currency | String |
| Local Country Code | Output | local_country | String |
Use Case 2: Exchange Rates can be set, in relation to the Local Commpany
Local Currency. IntegraTx includes ISO Currency codes, but the use of these
is not mandatory. The application can be (optionally) using an equivalency map
if the currency codes are different. This mapping is set by IntegraTx administrator.
Web Service name: CurrSetExchangeRate
Name/Description |
Input/Output | XML/Soap Name |
Type |
| Company code | Input | company | String |
| Application Code (optional) | Input | application | String |
| Currency Code | Input | currency | String |
| Date and time (no more granularity than seconds) for the exchange rate. If left blank, the date and time from the server is used. | Input | date_time | Date/Time |
| Exchange rate (10 decimals are used) | Input | rate | Float |
| Override default units. If 0, Currency default units is used to interpret the Exchange Rate | Input | override_default_units | Integer |
Use Case 3: Exchange Rates (set by CurrSetExchangeRate) can be obtained, in relation to the Local Commpany Local Currency.
Web Service name: CurrGetExchangeRate
Name/Description |
Input/Output | XML/Soap Name |
Type |
| Company code | Input | company | String |
| Application Code (optional) | Input | application | String |
| Currency Code | Input | currency | String |
| Date and time (no more granularity than seconds) for the exchange rate. If left blank,the last currency is obtained. | Input | date_time | Date/Time |
| Exchange rate (10 decimals are used) | Output | rate | Float |
| Units used to interpret the Exchange Rate | Output | units | Integer |
Please send an email to integratx@gmail.com if you wish to contact us.
Also, visit the IntegraTx's SourceForge.net website at www.sourceforge.net/projects/integratx