TAG LINE
SMALL TITLE

Currency

(API Version v2)


This entity represents the Currencies in which you perform business.


What can you do with Currency?


Properties

Property Details
identity
READ-ONLY
"identity": 27
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": 18
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.


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • code
  • symbol
  • isDefault

End Points

DELETEapi/v2/Currency/{id}
Delete an instance of the Currency 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 Currency object.
Delete an instance of the Currency object.
DELETE api/v2/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"
            }
        ]
    }
}
GETapi/v2/Currency/
Retrieve all of the Currency objects.
Retrieve all of the Currency objects.
GET api/v2/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": 1,
            "ownerName": "Sample Text Data",
            "symbol": "$",
            "isDefault": true
        }
    ]
}
GETapi/v2/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 api/v2/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": 10,
                "ownerName": "Sample Text Data",
                "symbol": "$",
                "isDefault": true
            }
        ]
    }
}
GETapi/v2/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 api/v2/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": 2,
        "ownerName": "Sample Text Data",
        "symbol": "$",
        "isDefault": true
    }
}
POSTapi/v2/Currency/
Create a new instance of the Currency object.
Create a new instance of the Currency object.
POST api/v2/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": 21,
                "ownerName": "Sample Text Data",
                "symbol": "$",
                "isDefault": true
            }
        ]
    }
}
PUTapi/v2/Currency/{id}
Update an existing instance of the Currency object.
Update an existing instance of the Currency object.
PUT api/v2/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": 21,
                "ownerName": "Sample Text Data",
                "symbol": "$",
                "isDefault": true
            }
        ]
    }
}