TAG LINE
SMALL TITLE

Currency / Exchange / Detail

(API Version v4)


This entity represents the individual exhange rates for a particular Currency.


What can you do with CurrencyExchangeDetail?


Properties

Property Details
identity
READ-ONLY
"identity": 4
Type: Number
This is the unique numeric identifier for the CurrencyExchangeDetail
currencyId
"currencyId": 21
Type: Number
Unique identifier for the associated Currency object.
currencyName
"currencyName": "Sample Name"
Type: String
The name of the object associated with the currencyId property.
currencyExchangeId
"currencyExchangeId": 15
Type: Number
Unique identifier for the associated CurrencyExchange object.
currencyExchangeName
"currencyExchangeName": "Sample Name"
Type: String
The name of the object associated with the currencyExchangeId property.
rate
"rate": 26
Type: Number
The multiplier of your default base currency for this rate.
created
READ-ONLY
"created": "2021-04-26T15:25:27.587Z"
Type: Date
This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.


End Points

DELETEapi/v4/Currency/Exchange/Detail/{id}
Delete an instance of the CurrencyExchangeDetail object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}Unique identifier for the CurrencyExchangeDetail object.
Delete an instance of the CurrencyExchangeDetail object.
DELETE api/v4/Currency/Exchange/Detail/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "delete",
    "results": {
        "totalCount": 4,
        "items": [
            {
                "identity": 1,
                "action": "deleted",
                "dtoTypeKey": "currencyExchangeDetail"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v4/Currency/Exchange/Detail/
Retrieve all of the CurrencyExchangeDetail objects.
Retrieve all of the CurrencyExchangeDetail objects.
GET api/v4/Currency/Exchange/Detail/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "currencyId": 0,
            "currencyName": "Sample Text Data",
            "currencyExchangeId": 12,
            "currencyExchangeName": "Sample Text Data",
            "rate": 24,
            "created": "2021-04-26T15:25:27.587Z"
        }
    ]
}
GETapi/v4/Currency/Exchange/Detail/Paged
Retrieve all of the CurrencyExchangeDetail objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.
Retrieve all of the CurrencyExchangeDetail objects in a paged fashion.
GET api/v4/Currency/Exchange/Detail/Paged
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "currencyId": 11,
                "currencyName": "Sample Text Data",
                "currencyExchangeId": 11,
                "currencyExchangeName": "Sample Text Data",
                "rate": 21,
                "created": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
GETapi/v4/Currency/Exchange/Detail/{id}
Retrieve deep detail of the CurrencyExchangeDetail object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the CurrencyExchangeDetail object.
Retrieve deep detail of the CurrencyExchangeDetail object by its ID.
GET api/v4/Currency/Exchange/Detail/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "currencyId": 12,
        "currencyName": "Sample Text Data",
        "currencyExchangeId": 15,
        "currencyExchangeName": "Sample Text Data",
        "rate": 7,
        "created": "2021-04-26T15:25:27.587Z",
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
POSTapi/v4/Currency/Exchange/Detail/
Create a new instance of the CurrencyExchangeDetail object.
Create a new instance of the CurrencyExchangeDetail object.
POST api/v4/Currency/Exchange/Detail/

{
    "currencyId": 11,
    "currencyExchangeId": 5,
    "rate": 13
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "currencyId": 25,
                "currencyName": "Sample Text Data",
                "currencyExchangeId": 14,
                "currencyExchangeName": "Sample Text Data",
                "rate": 0,
                "created": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
POSTapi/v4/Currency/Exchange/Detail/Search
Retreive a list of CurrencyExchangeDetail objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of CurrencyExchangeDetail objects based on search criteria.
POST api/v4/Currency/Exchange/Detail/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "currencyId": 1,
            "currencyName": "Sample Text Data",
            "currencyExchangeId": 7,
            "currencyExchangeName": "Sample Text Data",
            "rate": 21,
            "created": "2021-04-26T15:25:27.587Z"
        }
    ]
}
PUTapi/v4/Currency/Exchange/Detail/{id}
Update an existing instance of the CurrencyExchangeDetail object.
Update an existing instance of the CurrencyExchangeDetail object.
PUT api/v4/Currency/Exchange/Detail/{id}

{
    "identity": 1,
    "currencyId": 10,
    "currencyExchangeId": 6,
    "rate": 3
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "currencyId": 18,
                "currencyName": "Sample Text Data",
                "currencyExchangeId": 8,
                "currencyExchangeName": "Sample Text Data",
                "rate": 20,
                "created": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}