Jump to

• Request
• Response

Create a Currency

post

/api/restapi/currency

Send a request to this endpoint to create a currency. 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 : 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

• associationType: string
  Read Only: true

  Allowed Values: [ "OWNED", "INHERITED" ]

  Deprecated. As of 24.4.
  The type of association in the relationship between the currency and the workspace. Possible values are Owned and Inherited.
• 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.
• 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.
• 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)
  Read Only: true

  Deprecated. As of 24.4.
  Date when the record was last updated.
• 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":{
        "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"
            ]
        },
        "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":"<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"
            ]
        },
        "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":"<b>Deprecated.</b> As of <i>24.4</i>.</br>The type of association in the relationship between the currency and the workspace. Possible values are Owned and Inherited.",
            "readOnly":true,
            "deprecated":true,
            "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"
            ]
        }
    },
    "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 Create a Currency

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root 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
}

400 Response

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

Back to Top