Configuration and Content API Guide

Get Currency Availability

post

/config/sim/v2/setup/getCurrencyAvailability

Gets all the currency availability.

Request

Supported Media Types

application/json
multipart/form-data

The input Body model that needs to be given.

Root Schema : schema

Type: object

Show Source

include: string

If specified, limits the data returned to these fields.

Example: hierUnitId, objectNum, name
includeAll: string

If this value is specified, the include parameter is ignored.

Value Description

basic Forces the response to include all fields except option string details

detailed Forces the response to include all fields including option string details

Example: detailed
langIds: string

If specified, limits translated strings returned

Example: 1,2,3
limit: integer

If using paging, number of results returned in this page.

Example: 100
offset: integer

Starting resource record index. Not required if paging parameters are not supported

Example: 0
orderBy: string

Sorts the response by the specified field name and sort order.

Example: hierUnitId:asc
searchCriteria: string

If specified, returns records that match the criteria.

Example: where equals(hierUnitId, 7)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(hierUnitId, 7)",
            "description":"If specified, returns records that match the criteria."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId, objectNum, name",
            "description":"If specified, limits the data returned to these fields."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"If this value is specified, the include parameter is ignored.\n<table>\n<tr>\n  <td><b>Value</b></td>\n  <td><b>Description</b></td>\n</tr>\n<tr>\n  <td>basic</td>\n  <td>Forces the response to include all fields except option string details</td>\n</tr>\n<tr>\n  <td>detailed</td>\n  <td>Forces the response to include all fields including option string details</td>\n</tr>\n</table>\n"
        },
        "langIds":{
            "type":"string",
            "description":"If specified, limits translated strings returned",
            "example":"1,2,3"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported",
            "example":0
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page.",
            "example":100
        },
        "orderBy":{
            "type":"string",
            "description":"Sorts the response by the specified field name and sort order.",
            "example":"hierUnitId:asc"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A collection of Currency Availability objects.

Root Schema : schema

Type: object

Show Source

count: integer

Current response record count.

Example: 1
hasMore: boolean

Flag indicating if there are more objects to fetch.

Example: true
items: array items

Array of Currency Availability objects of the organization.
limit: integer

Server page size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of rows (excluding the paging parameters)

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":1,
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Currency Availability objects of the organization.",
            "items":{
                "$ref":"#/definitions/CurrencyAvailabilityv2"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of Currency Availability objects of the organization.

Show Source

Array of: object CurrencyAvailabilityv2

Model for Currency Availability Object

{
    "type":"array",
    "description":"Array of Currency Availability objects of the organization.",
    "items":{
        "$ref":"#/definitions/CurrencyAvailabilityv2"
    }
}

Nested Schema : CurrencyAvailabilityv2

Type: object

Model for Currency Availability Object

Show Source

currencyObjectNum: integer

Object number of the currency.

Example: 1
hierUnitId: integer

Unique reference of the hierarchy unit

Example: 3599
hierUnitObjNum: integer

Object number of the hierarchy unit

Example: 26
objectNum: integer

Object number of the currency availability.

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 availability

Example: 11010101
optionsExt: object CurrencyAvailabilityOptionsExt

An object containing the descriptive options list associated with the currency availability.

{
    "description":"Model for Currency Availability Object",
    "type":"object",
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit",
            "type":"integer",
            "example":3599
        },
        "hierUnitObjNum":{
            "description":"Object number of the hierarchy unit",
            "type":"integer",
            "example":26
        },
        "objectNum":{
            "description":"Object number of the currency availability.",
            "type":"integer",
            "example":1
        },
        "options":{
            "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the currency availability",
            "type":"string",
            "example":"11010101"
        },
        "currencyObjectNum":{
            "description":"Object number of the currency.",
            "type":"integer",
            "example":1
        },
        "optionsExt":{
            "$ref":"#/definitions/CurrencyAvailabilityOptionsExt"
        }
    }
}

Nested Schema : CurrencyAvailabilityOptionsExt

Type: object

An object containing the descriptive options list associated with the currency availability.

Show Source

issueChangeInOtherCurrency: boolean

Select to issue change in any other currency

Example: false
promptForIssuingChange: boolean

Select if change in other currency is needed

Example: false
roundCurrency: boolean

Select to round value in currency

Example: false
roundToNearestZero: boolean

Select if value is to be rounded off to nearest zero

Example: false
roundToSecondLeastSignificantDigit: boolean

Select if value is to be rounded off to second least significant digit

Example: false

{
    "description":"An object containing the descriptive options list associated with the currency availability.",
    "type":"object",
    "properties":{
        "issueChangeInOtherCurrency":{
            "type":"boolean",
            "example":false,
            "description":"Select to issue change in any other currency"
        },
        "promptForIssuingChange":{
            "type":"boolean",
            "example":false,
            "description":"Select if change in other currency is needed"
        },
        "roundCurrency":{
            "type":"boolean",
            "example":false,
            "description":"Select to round value in currency"
        },
        "roundToNearestZero":{
            "type":"boolean",
            "example":false,
            "description":"Select if value is to be rounded off to nearest zero"
        },
        "roundToSecondLeastSignificantDigit":{
            "type":"boolean",
            "example":false,
            "description":"Select if value is to be rounded off to second least significant digit"
        }
    }
}

Value	Description
basic	Forces the response to include all fields except option string details
detailed	Forces the response to include all fields including option string details