TAG LINE
SMALL TITLE

Currency / Exchange

(API Version v4)


This entity represents the container that holds exchange rates for a particular Currency.


What can you do with CurrencyExchange?


Properties

Property Details
identity
READ-ONLY
"identity": 27
Type: Number
This is the unique numeric identifier for the CurrencyExchange
ownerId
READ-ONLY
"ownerId": 0
Type: Number
Unique identifier for the associated Owner object.
ownerName
READ-ONLY
"ownerName": "Sample Name"
Type: String
The name of the object associated with the ownerId property.
name
"name": "Canadian Rates"
Type: String
User defined name for the currency exchange.
effective
"effective": "2021-04-26T15:25:27.587Z"
Type: Date
When do these exchange rates come into effect.

Date and time values are specified in the ISO 8601 format.
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.
createdByUserId
"createdByUserId": 10
Type: Number
Unique identifier for the associated User object.
createdByUserName
"createdByUserName": "Sample Name"
Type: String
The name of the object associated with the createdByUserId property.


Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the CurrencyExchange object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v4/Currency/Exchange/{id}
Delete an instance of the CurrencyExchange 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 CurrencyExchange object.
Delete an instance of the CurrencyExchange object.
DELETE api/v4/Currency/Exchange/{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": "currencyExchange"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v4/Currency/Exchange/
Retrieve all of the CurrencyExchange objects.
Retrieve all of the CurrencyExchange objects.
GET api/v4/Currency/Exchange/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 2,
            "ownerName": "Sample Text Data",
            "name": "Canadian Rates",
            "effective": "2021-04-26T15:25:27.587Z",
            "created": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 26,
            "createdByUserName": "Sample Text Data"
        }
    ]
}
GETapi/v4/Currency/Exchange/Paged
Retrieve all of the CurrencyExchange 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 CurrencyExchange objects in a paged fashion.
GET api/v4/Currency/Exchange/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,
                "ownerId": 25,
                "ownerName": "Sample Text Data",
                "name": "Canadian Rates",
                "effective": "2021-04-26T15:25:27.587Z",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 19,
                "createdByUserName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/Currency/Exchange/Paged/Detail
Retrieve all of the CurrencyExchange objects in a paged fashion with all object details. 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.
Retrieve all of the CurrencyExchange objects in a paged fashion with all object details.
GET api/v4/Currency/Exchange/Paged/Detail
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,
                "ownerId": 27,
                "ownerName": "Sample Text Data",
                "name": "Canadian Rates",
                "effective": "2021-04-26T15:25:27.587Z",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 16,
                "createdByUserName": "Sample Text Data",
                "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
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v4/Currency/Exchange/{id}
Retrieve an instance of the CurrencyExchange object by its ID.
{id}Unique identifier for the CurrencyExchange object.
Retrieve an instance of the CurrencyExchange object by its ID.
GET api/v4/Currency/Exchange/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 17,
        "ownerName": "Sample Text Data",
        "name": "Canadian Rates",
        "effective": "2021-04-26T15:25:27.587Z",
        "created": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 2,
        "createdByUserName": "Sample Text Data"
    }
}
GETapi/v4/Currency/Exchange/{id}/Detail
Retrieve deep detail of the CurrencyExchange 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 CurrencyExchange object.
Retrieve deep detail of the CurrencyExchange object by its ID.
GET api/v4/Currency/Exchange/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 6,
        "ownerName": "Sample Text Data",
        "name": "Canadian Rates",
        "effective": "2021-04-26T15:25:27.587Z",
        "created": "2021-04-26T15:25:27.587Z",
        "createdByUserId": 6,
        "createdByUserName": "Sample Text Data",
        "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
                    }
                ]
            }
        }
    }
}
PATCHapi/v4/Currency/Exchange/{id}
Update or Add the CurrencyExchange object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the CurrencyExchange object.
Update or Add the CurrencyExchange object and optionally make changes to any child objects.
PATCH api/v4/Currency/Exchange/{id}

{
    "details": {},
    "currencyExchanges": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "name": "Canadian Rates",
                "effective": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 13
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "currencyExchange",
                "instance": {
                    "identity": 1,
                    "ownerId": 14,
                    "ownerName": "Sample Text Data",
                    "name": "Canadian Rates",
                    "effective": "2021-04-26T15:25:27.587Z",
                    "created": "2021-04-26T15:25:27.587Z",
                    "createdByUserId": 24,
                    "createdByUserName": "Sample Text Data"
                }
            }
        ]
    }
}
POSTapi/v4/Currency/Exchange/
Create a new instance of the CurrencyExchange object.
Create a new instance of the CurrencyExchange object.
POST api/v4/Currency/Exchange/

{
    "name": "Canadian Rates",
    "effective": "2021-04-26T15:25:27.587Z",
    "createdByUserId": 23
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 26,
                "ownerName": "Sample Text Data",
                "name": "Canadian Rates",
                "effective": "2021-04-26T15:25:27.587Z",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 12,
                "createdByUserName": "Sample Text Data"
            }
        ]
    }
}
POSTapi/v4/Currency/Exchange/Search
Retreive a list of CurrencyExchange 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 CurrencyExchange objects based on search criteria.
POST api/v4/Currency/Exchange/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,
            "ownerId": 12,
            "ownerName": "Sample Text Data",
            "name": "Canadian Rates",
            "effective": "2021-04-26T15:25:27.587Z",
            "created": "2021-04-26T15:25:27.587Z",
            "createdByUserId": 6,
            "createdByUserName": "Sample Text Data"
        }
    ]
}
PUTapi/v4/Currency/Exchange/{id}
Update an existing instance of the CurrencyExchange object.
Update an existing instance of the CurrencyExchange object.
PUT api/v4/Currency/Exchange/{id}

{
    "identity": 1,
    "name": "Canadian Rates",
    "effective": "2021-04-26T15:25:27.587Z",
    "createdByUserId": 14
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 11,
                "ownerName": "Sample Text Data",
                "name": "Canadian Rates",
                "effective": "2021-04-26T15:25:27.587Z",
                "created": "2021-04-26T15:25:27.587Z",
                "createdByUserId": 24,
                "createdByUserName": "Sample Text Data"
            }
        ]
    }
}