Configuration and Content API Guide

Add Currencies

post

/config/sim/v1/setup/currencies

Add the Currency to the specified organization.

Request

Supported Media Types

application/json
multipart/form-data

Header Parameters

Simphony-AuditTrailRef: string(string)

Detail that Identifies that who made the change

A request body

Root Schema : CUDCurrencyRequestBody

Type: object

Model for Currency CUD Request

Show Source

abbreviation: object abbreviation

The abbreviation for the currency record. For a long abbreviation, you may add a space in the end for good print format.
hierUnitId(required): integer

Unique reference of the hierarchy unit where the print class is configured

Example: 3599
name(required): object CurrencyNameTranslatedString

A group of string objects representing the name of the currency in configured languages.
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 Print Class

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 print class is configured",
            "type":"integer",
            "example":3599
        },
        "name":{
            "$ref":"#/definitions/CurrencyNameTranslatedString"
        },
        "abbreviation":{
            "description":"The abbreviation for the currency record. For a long abbreviation, you may add a space in the end for good print format.",
            "type":"object",
            "example":{
                "en-US":"USD"
            }
        },
        "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 Print Class",
            "type":"string",
            "example":"11010101"
        }
    }
}

Nested Schema : abbreviation

Type: object

The abbreviation for the currency record. For a long abbreviation, you may add a space in the end for good print format.

Example:

{
    "en-US":"USD"
}

Nested Schema : CurrencyNameTranslatedString

Type: object

A group of string objects representing the name of the currency in configured languages.

Example:

{
    "en-US":"USD Dollar",
    "de-DE":"USD-Dollar"
}

Response

Supported Media Types

application/json

200 Response

Currency object of the organization.

Root Schema : DeleteRequestBody

Type: object

Show Source

hierUnitId(required): integer

Unique hierarchy unit value

Example: 1
objectNum(required): integer

Object number of the printer

Example: 1

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

400 Response

400 Bad Request

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

detail(required): string

A short, human-readable summary of the problem.

Example: Specified Data is invalid
errorDetails(required): string

A human-readable explanation specific to this occurrence of the problem.

Example: Entity Does Not Exist
o:errorCode(required): integer

Error code of the problem

Example: 55223
status(required): integer

HTTP status code.

Example: 400
title(required): string

A short, human-readable summary of the problem type.

Example: VALIDATION ERROR
type(required): string

A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}