Exchange Rate Type

URL Endpoint

HTTPS://api.adaptiveplanning.com/api/rest/modeling/<version>/<tenant>/exchangeRateTypes

Version: v1

Category	Metadata Modification
Description	Get / create / update exchange rate types in Adaptive Planning
Permissions Required to Invoke	Currencies (CURRENCIES)
Parameters Required on Request	N/A

Supported HTTP Verb(s)

HTTP Verb	Description
GET	Retrieves all the available exchange rate types in the system
GET	Retrieves the exchange rate type for a given code in the system for the tenant
POST	Based on the exchange rate type available in system, it inserts / updates the exchange rate type.
DELETE	Deletes the exchange rate type based on the exchange rate type code provided

GET

Request URI: /exchangeRateTypes
:
Fetch the exchange rate types.

Fetches all the exchange rate types available in the system for the tenant.

Sample Request URI:

HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/greenco/exchangeRateTypes/A1

POST

Request: /exchangeRateTypes
:
Inserts or updates the exchange rate types.

Inserts or updates the exchange rate types in planning based on the exchange rate type code:
Insert exchange rate type if the code is not present in the system.
Updates if the exchange rate type code is already present in the system.

Sample Request URI:

HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/greenco/exchangeRateTypes

Response

204 No Content

Successful response is blank with status code 204.

400 Bad Request

The request could not be understood by the server.

Example

{
    "error": "Errors occurred while processing the request",
    "errors": [
            {
                 "error": "ABCD1 is a duplicate exchange rate type code in the request body. Exchange rate type code must be unique.",
                 "code": "PLN310002"
            },
            {
                 "error": "Abcd name is a duplicate exchange rate type name in the request body. Exchange rate type name must be unique.",
                 "code": "PLN310002"
            },
           {
                 "error": "Test Name is a duplicate exchange rate type name in the request body. Exchange rate type name must be unique.",
                 "code": "PLN310002"
           }
    ]
}

401 Unauthorized

User is not authorized.

Example:

{ "message": "Invalid credential", "status": 401 }

DELETE

Request: /exchangeRateType/{code}
:
Deletes the exchange rate type.

Deletes the existing exchange rate type user defined. It will also delete the external exchange rate type mapping if present.
The two reserved exchange rate types cannot be deleted. Those are 'Monthly Average' and 'End of Month' exchange rate types.

Sample Request URI:

HTTPS://api.adaptiveplanning.com/api/rest/modeling/v1/greenco/exchangeRateType/Xrate