Jump to

• Request
• Response

View a Currency by Name

get

/api/restapi/currency/name/{currencyName}

This endpoint returns a currency that meet the following requirements:

• The object has a name that matches the value of the {currencyName} path parameter.

Request

Path Parameters

• currencyName(required): string
  Name of the currency 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 : List<ApiEntityCurrency>

Type: array

Title: List<ApiEntityCurrency>

Show Source

• Array of: object ApiEntityCurrency
  Title: ApiEntityCurrency

{
    "title":"List<ApiEntityCurrency>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityCurrency",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityCurrency

Type: object

Title: ApiEntityCurrency

Show Source

• associationType: string
  Allowed Values: [ "OWNED", "INHERITED" ]

  The type of association in the relationship between the currency and the workspace. Possible values are Owned and Inherited.
• 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.
• currencyName: string
  Minimum Length: 1

  Maximum Length: 255

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

  Maximum Length: 6

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

  Maximum Value: 5

  Multiple Of: 0.000010

  The number of decimals to display.
• link: string (url)
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• 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.
• 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.
• workspaceId: integer (int64)
  The unique identifier for the workspace.The workspace object can also be identified by its unique criteria.

{
    "title":"ApiEntityCurrency",
    "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"
            ]
        },
        "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"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "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"
            ]
        },
        "associationType":{
            "type":"string",
            "description":"The type of association in the relationship between the currency and the workspace. Possible values are Owned and Inherited.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "OWNED",
                "INHERITED"
            ]
        },
        "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"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

404 Response

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

Back to Top