Jump to

• Request
• Response

View an Exchange Rate

get

/api/restapi/exchangeRate/{exchangeRateId}

This endpoint returns an exchange rate. that meet the following requirements:

• The object has an ID that matches the value of the {exchangeRateId} path parameter.

Request

Path Parameters

• exchangeRateId(required): integer(int64)
  ID of the exchangeRate to be found.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityExchangeRate

Type: object

Title: ApiEntityExchangeRate

Show Source

• baseExchangeRate: number
  Minimum Value: 0

  Maximum Value: 1000000000

  The rate used to convert the value of a record to the base currency.
• currencyCode: string
  Minimum Length: 1

  Maximum Length: 3

  The unique identifier for the currency. The currency code is 3 characters.
• currencyId: integer (int64)
  The unique identifier of a currency.
• effectiveEndDate: string (date-time)
  The date the exchange rate ends.
• effectiveStartDate: string (date-time)
  The date the exchange rate goes into effect.
• exchangeRateId: integer (int64)
  The unique identifier for the exchange rate.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityExchangeRate",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "currencyCode":{
            "maxLength":"3",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the currency. The currency code is 3 characters.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "effectiveStartDate":{
            "type":"string",
            "description":"The date the exchange rate goes into effect.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "effectiveEndDate":{
            "type":"string",
            "description":"The date the exchange rate ends.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "currencyId":{
            "type":"integer",
            "description":"The unique identifier of a currency.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "exchangeRateId":{
            "type":"integer",
            "description":"The unique identifier for the exchange rate.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "baseExchangeRate":{
            "maximum":"1000000000",
            "minimum":"0",
            "type":"number",
            "description":"The rate used to convert the value of a record to the base currency.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "exampleSetFlag":false
}

404 Response

The requested exchange rate does not exist, or you do not have access to it.

Back to Top