Jump to

• Request
• Response

View Currency Of Record for a Workspace

get

/api/restapi/workspace/currencyOfRecord

Send a request to this endpoint to view the currency of record and the exchange rate for a specified workspace given by workspaceId or workspaceCode as a query parameter.

Request

Query Parameters

• workspaceCode: string
  The user-specified identifier of a workspace.
• workspaceId: integer(int64)
  The system-generated identifier of a workspace.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : ApiEntityCurrencyOfRecord

Type: object

Title: ApiEntityCurrencyOfRecord

Show Source

• 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.
• currencyOfRecord: string
  Maximum Length: 255

  This field represents the currency of record i.e. editable currency of a cost field for a given workspace.
• exchangeRate: number
  The conversion rate between this currency and base currency.

{
    "title":"ApiEntityCurrencyOfRecord",
    "type":"object",
    "properties":{
        "currencyOfRecord":{
            "maxLength":255,
            "type":"string",
            "description":"This field represents the currency of record i.e. editable currency of a cost field for a given workspace.",
            "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"
            ]
        },
        "currencyId":{
            "type":"integer",
            "description":"The unique identifier of a currency.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "exchangeRate":{
            "type":"number",
            "description":"The conversion rate between this currency and base currency.",
            "exampleSetFlag":false,
            "types":[
                "number"
            ]
        }
    },
    "exampleSetFlag":false
}

400 Response

Invalid input.

Back to Top