Jump to

• Request
• Response

Update Currencies

post

/config/sim/v2/setup/updateCurrencies

Updates the currency.

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

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

Body ()

A request body

Root Schema : schema

Type: object

Model for Currency CUD Request

Show Source

• abbreviation: object abbreviation
  Abbreviation
• dataExtensions: array dataExtensions
  An array of data extensions
• hierUnitId(required): integer
  Unique reference of the hierarchy unit where the Currency is configured

  Example: 3599
• name(required): object name
  Currency Name
• numberOfDigits: integer
  The number of digits after the decimal point that each currency allows. Default value is 2.Values between 1-3.

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

  Example: 1
• options: string
  A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the currency

  Example: 11010101
• symbol: string
  The record symbol of the currency.

  Example: $

{
    "description":"Model for Currency CUD Request",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "properties":{
        "objectNum":{
            "description":"Object number of the currency.",
            "type":"integer",
            "example":1
        },
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit where the Currency is configured",
            "type":"integer",
            "example":3599
        },
        "name":{
            "type":"object",
            "description":"Currency Name",
            "example":{
                "1":"Enterprise",
                "2":"Unternehmen",
                "3":"Empresa"
            }
        },
        "abbreviation":{
            "type":"object",
            "description":"Abbreviation",
            "example":{
                "1":"USD",
                "2":"INR",
                "3":"IND"
            }
        },
        "symbol":{
            "description":"The record symbol of the currency.",
            "type":"string",
            "example":"$"
        },
        "numberOfDigits":{
            "description":"The number of digits after the decimal point that each currency allows. Default value is 2.Values between 1-3.",
            "type":"integer",
            "example":2
        },
        "options":{
            "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the currency",
            "type":"string",
            "example":"11010101"
        },
        "dataExtensions":{
            "description":"An array of data extensions",
            "type":"array",
            "items":{
                "properties":{
                    "columnName":{
                        "description":"Name of the extension field",
                        "type":"string",
                        "example":"extension column 1"
                    },
                    "value":{
                        "description":"Value of the extension field",
                        "type":"string",
                        "example":"Value1"
                    }
                }
            }
        }
    }
}

Nested Schema : abbreviation

Type: object

Abbreviation

Example:

{
    "1":"USD",
    "2":"INR",
    "3":"IND"
}

Nested Schema : dataExtensions

Type: array

An array of data extensions

Show Source

• Array of: object items

{
    "description":"An array of data extensions",
    "type":"array",
    "items":{
        "properties":{
            "columnName":{
                "description":"Name of the extension field",
                "type":"string",
                "example":"extension column 1"
            },
            "value":{
                "description":"Value of the extension field",
                "type":"string",
                "example":"Value1"
            }
        }
    }
}

Nested Schema : name

Type: object

Currency Name

Example:

{
    "1":"Enterprise",
    "2":"Unternehmen",
    "3":"Empresa"
}

Nested Schema : items

Type: object

Show Source

• columnName: string
  Name of the extension field

  Example: extension column 1
• value: string
  Value of the extension field

  Example: Value1

{
    "properties":{
        "columnName":{
            "description":"Name of the extension field",
            "type":"string",
            "example":"extension column 1"
        },
        "value":{
            "description":"Value of the extension field",
            "type":"string",
            "example":"Value1"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Currency Updated.

Body ()

Root Schema : schema

Type: object

Show Source

• hierUnitId: integer
  Unique hierarchy unit value

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

  Example: 1

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

Back to Top