Jump to

• Request
• Response

Create an Exchange Rate

post

/api/restapi/exchangeRate

Send a request to this endpoint to create an exchange rate. An application object will be created using the JSON data provided in the request body.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityExchangeRateInput

Type: object

Title: ApiEntityExchangeRateInput

This entity represents a ExchangeRate object, a unique ExchangeRate object can be identified by the following combinations of the fields.

• exchangeRateId

Show Source

• baseExchangeRate(required): 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(required): integer (int64)
  The unique identifier of a currency.
• effectiveEndDate: string (date-time)
  The date the exchange rate ends.
• effectiveStartDate(required): string (date-time)
  The date the exchange rate goes into effect.
• exchangeRateId: integer (int64)
  The unique identifier for the exchange rate.
• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityExchangeRateInput",
    "required":[
        "baseExchangeRate",
        "currencyId",
        "effectiveStartDate"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "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":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ExchangeRate object, a unique ExchangeRate object can be identified by the following combinations of the fields.<ul><li>exchangeRateId</li>",
    "exampleSetFlag":false
}

Examples

Select an example Create an Exchange Rate

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

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
}

400 Response

Invalid input for the Exchange Rate service. Verify the request contains valid data, then resubmit the request.

Back to Top