Jump to

• Request
• Response

Add Currency Conversion

post

/config/sim/v1/setup/currencyconversion

Add the Currency Conversion to the specified organization.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string
  Detail that identifies, who made the change.

Body ()

A CUD request body

Root Schema : schema

Type: object

Model for Currency Conversion CUD Request

Show Source

• conversionCurrencyObjectNum: integer
  Object number of the conversion currency.

  Example: 31
• currencyObjectNum: integer
  Object number of the currency.

  Example: 31
• hierUnitId(required): integer
  Unique reference of the hierarchy unit where the Currency Conversion is configured

  Example: 3599
• objectNum(required): integer
  Object number of the currency conversion.

  Example: 1
• rate: number
  Rate of conversion between currency and conversion currency

  Example: 1.3

{
    "description":"Model for Currency Conversion CUD Request",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "properties":{
        "objectNum":{
            "description":"Object number of the currency conversion.",
            "type":"integer",
            "example":1
        },
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit where the Currency Conversion is configured",
            "type":"integer",
            "example":3599
        },
        "currencyObjectNum":{
            "description":"Object number of the currency.",
            "type":"integer",
            "example":31
        },
        "conversionCurrencyObjectNum":{
            "description":"Object number of the conversion currency.",
            "type":"integer",
            "example":31
        },
        "rate":{
            "description":"Rate of conversion between currency and conversion currency",
            "type":"number",
            "example":1.3
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Currency Conversion object Added.

Body ()

Root Schema : DeleteRequestBody

Type: object

Show Source

• hierUnitId: integer
  Unique hierarchy unit value

  Example: 1
• objectNum: integer
  Object number of the Currency Conversion

  Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "description":"Unique hierarchy unit value",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the Currency Conversion",
            "type":"integer",
            "example":1
        }
    }
}

Back to Top