Currency

(API Version v10)

This entity represents the Currencies in which you perform business.

What can you do with Currency?

DELETE Currency/{id}
Delete an instance of the Currency object.
GET Currency/
Retrieve all of the Currency objects.
GET Currency/Paged
Retrieve all of the Currency objects in a paged fashion.
GET Currency/{id}
Retrieve an instance of the Currency object by its ID.
POST Currency/
Create a new instance of the Currency object.
PUT Currency/{id}
Update an existing instance of the Currency object.

Properties

Property Details

identity READ-ONLY	"identity": 5 Type: Number This is the unique numeric identifier for the Currency
name	"name": "US Dollars" Type: String User defined name for the currency.
code	"code": "USD" Type: String ISO code for the currency
ownerId READ-ONLY	"ownerId": 16 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.
symbol	"symbol": "$" Type: String User defined currency symbol to be used.
isDefault	"isDefault": true Type: Boolean Whether or not this Currency is the default Owner currency for the system. The base currency to report on.

End Points

DELETE	Currency/{id}
Delete an instance of the Currency object. Upon successful delete, this API will return a record of all of the related 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 Currency object.
Delete an instance of the Currency object. DELETE Currency/{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": "currency" }, { "lhsId": 2, "rhsId": 2, "action": "detached", "dtoTypeKey": "sampleObjectConnector" }, { "foreignKeyIdentity": 2, "action": "deleted", "dtoTypeKey": "sampleObject" } ] } }

Retrieve all of the Currency objects.

GET Currency/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "US Dollars",
            "code": "USD",
            "ownerId": 5,
            "ownerName": "Sample Text Data",
            "symbol": "$",
            "isDefault": true
        }
    ]
}

GET	Currency/Paged
Retrieve all of the Currency 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 Currency objects in a paged fashion. GET Currency/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, "name": "US Dollars", "code": "USD", "ownerId": 19, "ownerName": "Sample Text Data", "symbol": "$", "isDefault": true } ] } }

GET	Currency/{id}
Retrieve an instance of the Currency object by its ID.
{id}	Unique identifier for the Currency object.
Retrieve an instance of the Currency object by its ID. GET Currency/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "name": "US Dollars", "code": "USD", "ownerId": 23, "ownerName": "Sample Text Data", "symbol": "$", "isDefault": true } }

Create a new instance of the Currency object.

POST Currency/

{
    "name": "US Dollars",
    "code": "USD",
    "symbol": "$",
    "isDefault": true
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "US Dollars",
                "code": "USD",
                "ownerId": 12,
                "ownerName": "Sample Text Data",
                "symbol": "$",
                "isDefault": true
            }
        ]
    }
}

Update an existing instance of the Currency object.

PUT Currency/{id}

{
    "identity": 1,
    "name": "US Dollars",
    "code": "USD",
    "symbol": "$",
    "isDefault": true
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "US Dollars",
                "code": "USD",
                "ownerId": 19,
                "ownerName": "Sample Text Data",
                "symbol": "$",
                "isDefault": true
            }
        ]
    }
}