Jump to

• Request
• Response

View a Currency Seed

get

/api/restapi/currency/currencySeed

This endpoint returns currency seed data.

Request

There are no request parameters for this operation.

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<ApiEntityCurrencySeed>

Type: array

Title: List<ApiEntityCurrencySeed>

Show Source

• Array of: object ApiEntityCurrencySeed
  Title: ApiEntityCurrencySeed

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

Nested Schema : ApiEntityCurrencySeed

Type: object

Title: ApiEntityCurrencySeed

Show Source

• currencyCode: string
  Maximum Length: 3

  The unique identifier for the currency. The currency code is 3 characters.
• currencyName: string
  Maximum Length: 255

  The name of the currency.
• currencySeedId: integer (int64)
  The unique identifier of a seeded currency.
• currencySymbol: string
  Maximum Length: 20

  The symbol for the currency.
• decimalsToDisplay: integer (int32)
  The number of decimals to display.
• link: string (url)
  Read Only: true

  Deprecated. As of 24.4.
  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 24.4.
  Date when the record was last updated.

{
    "title":"ApiEntityCurrencySeed",
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</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"
            ]
        },
        "currencyName":{
            "maxLength":"255",
            "type":"string",
            "description":"The name of the currency.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "currencyCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The unique identifier for the currency. The currency code is 3 characters.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "currencySymbol":{
            "maxLength":"20",
            "type":"string",
            "description":"The symbol for the currency.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>24.4</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "decimalsToDisplay":{
            "type":"integer",
            "description":"The number of decimals to display.",
            "format":"int32",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "currencySeedId":{
            "type":"integer",
            "description":"The unique identifier of a seeded currency.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        }
    },
    "exampleSetFlag":false
}

204 Response

Successful operation with no content.

Back to Top