Jump to

• Request
• Response

Update a Currency

put

/api/restapi/currency

Send a request to this endpoint to update a currency. An application object with an ID value that matches the ID value provided in the JSON object in the request body will be updated to reflect the JSON contents.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityCurrencyInput

Type: object

Title: ApiEntityCurrencyInput

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

• currencyId
• currencyCode,workspaceId
• currencyCode,workspaceCode

Show Source

• currencyCode(required): 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.
• currencyName(required): string
  Minimum Length: 1

  Maximum Length: 255

  The name of the currency.
• currencySymbol(required): string
  Minimum Length: 1

  Maximum Length: 6

  The symbol for the currency.
• decimalsToDisplay(required): integer (int32)
  Minimum Value: 0

  Maximum Value: 5

  Multiple Of: 0.000010

  The number of decimals to display.
• pushDownType: string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  The push down type of the workspace currency.
• systemCurrencyFlag: boolean
  The base currency is the default currency when new workspaces are created.
  Any currency conversions will be measured against this form of currency.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.
• workspaceId(required): integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityCurrencyInput",
    "required":[
        "currencyCode",
        "currencyName",
        "currencySymbol",
        "decimalsToDisplay",
        "workspaceId"
    ],
    "type":"object",
    "properties":{
        "currencyName":{
            "maxLength":255,
            "minLength":1,
            "type":"string",
            "description":"The name of the currency.",
            "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"
            ]
        },
        "currencySymbol":{
            "maxLength":6,
            "minLength":1,
            "type":"string",
            "description":"The symbol for the currency.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":60,
            "minLength":0,
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceId":{
            "type":"integer",
            "description":"The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "pushDownType":{
            "type":"string",
            "description":"The push down type of the workspace currency.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "currencyId":{
            "type":"integer",
            "description":"The unique identifier of a currency.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "decimalsToDisplay":{
            "multipleOf":"0.000010",
            "maximum":5,
            "minimum":0,
            "type":"integer",
            "description":"The number of decimals to display.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "systemCurrencyFlag":{
            "type":"boolean",
            "description":"The base currency is the default currency when new workspaces are created. <br />Any currency conversions will be measured against this form of currency.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        }
    },
    "description":"This entity represents a Currency object, a unique Currency object can be identified by the following combinations of the fields.<ul><li>currencyId</li><li>currencyCode,workspaceId</li><li>currencyCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Examples

Select an example Update a Currency Using Calendar ID

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

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

Back to Top