Configuration and Content API Guide

Get currency conversions.

post

/config/sim/v1/setup/getcurrencyconversion

Gets all the currency conversions for the specified organization.

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

Objects included in the response.

Example: hierUnitId
includeAll: string

This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.

Example: detailed
languages: string

If specified, limits the translated strings returned.

Example: en-US, es-ES, es-MX
limit: integer

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

Example: 10
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: objectNum:asc
searchCriteria: string

Search criteria to filter results based on field value.

Example: where equals(objectNum,1)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(objectNum,1)",
            "description":"Search criteria to filter results based on field value."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId",
            "description":"Objects included in the response."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object. \n"
        },
        "languages":{
            "type":"string",
            "example":"en-US, es-ES, es-MX",
            "description":"If specified, limits the translated strings returned."
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index. Not required if paging parameters are not supported."
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"string",
            "example":"objectNum:asc",
            "description":"Sorts the response by the specified field name and sort order."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A collection of Currency Conversion objects

Root Schema : CurrencyConversionGetResponsev1

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 Conversion 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 Conversion objects of the organization.",
            "items":{
                "$ref":"#/definitions/CurrencyConversionResponsev1"
            }
        },
        "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 Conversion objects of the organization.

Show Source

Array of: object CurrencyConversionResponsev1

Model for Currency Conversion Object

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

Nested Schema : CurrencyConversionResponsev1

Type: object

Model for Currency Conversion Object

Show Source

conversionCurrencyName: object conversionCurrencyName

Conversion Currency Name
conversionCurrencyObjectNum: integer

Object number of the conversion currency.

Example: 31
currencyName: object currencyName

Currency Name
currencyObjectNum: integer

Object number of the currency.

Example: 31
hierUnitId: integer

Unique reference of the hierarchy unit where the Currency Conversion is configured

Example: 3599
hierUnitName: object hierUnitName

Hier Unit Name
hierUnitObjNum: integer

Object number of the hierarchy unit where the Currency Conversion is configured

Example: 26
objectNum: 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 Object",
    "type":"object",
    "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
        },
        "hierUnitObjNum":{
            "description":"Object number of the hierarchy unit where the Currency Conversion is configured",
            "type":"integer",
            "example":26
        },
        "hierUnitName":{
            "type":"object",
            "description":"Hier Unit Name",
            "example":{
                "en-US":"Property",
                "de-DE":"Eigentum",
                "es-MX":"Propiedad"
            }
        },
        "currencyObjectNum":{
            "description":"Object number of the currency.",
            "type":"integer",
            "example":31
        },
        "currencyName":{
            "type":"object",
            "description":"Currency Name",
            "example":{
                "en-US":"USD Dollar",
                "de-DE":"USD-Dollar"
            }
        },
        "conversionCurrencyObjectNum":{
            "description":"Object number of the conversion currency.",
            "type":"integer",
            "example":31
        },
        "conversionCurrencyName":{
            "type":"object",
            "description":"Conversion Currency Name",
            "example":{
                "en-US":"USD Dollar",
                "de-DE":"USD-Dollar"
            }
        },
        "rate":{
            "description":"Rate of conversion between currency and conversion currency",
            "type":"number",
            "example":1.3
        }
    }
}

Nested Schema : conversionCurrencyName

Type: object

Conversion Currency Name

Example:

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

Nested Schema : currencyName

Type: object

Currency Name

Example:

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

Nested Schema : hierUnitName

Type: object

Hier Unit Name

Example:

{
    "en-US":"Property",
    "de-DE":"Eigentum",
    "es-MX":"Propiedad"
}