Import Exchange Rates

Export the Exchange Rates template in the Planning repository and change the rates if required. You can then import the rates into the application using the Import Exchange Rates settings specified in a Planning job of type import exchange rates. For more information, see Job Types.

You can also override some of the parameters of the job definition while executing this job from a REST API.

Using this REST API requires prerequisites, such as understanding how to use jobs. See Prerequisites. Be sure that you understand how to use jobs as described in Managing Jobs.


Supported Media Types: application/json


The following table summarizes the client request parameters specific to this job. For additional parameters that are common to all jobs, see Execute a Job.

Table 5-29 Import Exchange Rates

Name Description Required Default
jobType Import Exchange Rates or IMPORT_EXCHANGE_RATES (both parameters are supported) Yes None
jobName The name of the job to be used for this job execution.

Important: You must use the exact name of a job that is already defined in Planning as described in Managing Jobs.

Example: importNewExchangeRate

Yes None

Optionally, you can specify the name of the CSV file from which exchange rates are to be imported.

If you specify a file name, the Import Exchange Rate file name in the job is ignored.

No The source file of the job definition
includeMetaData You can override the option to include metadata. Allowed value is true or false. No Include Metadata parameter of the job definition

For a sample URL, see Sample URL and Payload in Execute a Job.

Sample Payload

Example 1: Executes the import exchange rates job MyExchangeRates and overrides the importFileName parameter.

{"jobType":"Import Exchange Rates","jobName":"MyExchangeRates",

Example 2: Executes the import exchange rates job MyExchangeRates and overrides the importFileName and includeMetaData parameters.

{"jobType":"Import Exchange Rates","jobName":"MyExchangeRates",