TAG LINE
TAG LINE
SMALL TITLE

Usage / Rate

(API Version v7)


Defines properties for an individual Usage Rate within the system.


What can you do with UsageRate?


Properties

Property Details
identity
READ-ONLY
"identity": 1
Type: Number
This is the unique numeric identifier for the UsageRate
usageRateGroupId
"usageRateGroupId": 24
Type: Number
Unique identifier for the associated UsageRateGroup object.
usageRateGroupName
"usageRateGroupName": "Sample Name"
Type: String
The name of the object associated with the usageRateGroupId property.
usageClassId
"usageClassId": 25
Type: Number
Unique identifier for the associated UsageClass object.
usageClassName
"usageClassName": "Sample Name"
Type: String
The name of the object associated with the usageClassId property.
amount
"amount": 2.52
Type: Number
The amount to charge for this rate
geoTreeLocationId
"geoTreeLocationId": 2
Type: Number
Unique identifier for the associated GeoTreeLocation object.
geoTreeLocationName
"geoTreeLocationName": "Sample Name"
Type: String
The name of the object associated with the geoTreeLocationId property.
additional
"additional": true
Type: Boolean
Unused
retired
READ-ONLY
"retired": true
Type: Boolean
System generated when a rate group is retired
ownerId
READ-ONLY
"ownerId": 6
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.
usageRoundingId
"usageRoundingId": 8
Type: Number
Unique identifier for the associated UsageRounding object.
usageRoundingName
"usageRoundingName": "Sample Name"
Type: String
The name of the object associated with the usageRoundingId property.
displayName
"displayName": "My Rate"
Type: String
The optional user defined display name for the Usage Rate
geoTreeLocationGroupId
"geoTreeLocationGroupId": 17
Type: Number
Unique identifier for the associated GeoTreeLocationGroup object.
geoTreeLocationGroupName
"geoTreeLocationGroupName": "Sample Name"
Type: String
The name of the object associated with the geoTreeLocationGroupId property.
minimumCharge
"minimumCharge": 5.34
Type: Number
Minimum amount to charge for the record
usageUnitId
"usageUnitId": 5
Type: Number
Unique identifier for the associated UsageUnit object.
usageUnitName
"usageUnitName": "Sample Name"
Type: String
The name of the object associated with the usageUnitId property.
usageRateCalculationTypeId
"usageRateCalculationTypeId": 11
Type: Number
Unique identifier for the associated UsageRateCalculationType object.
usageRateCalculationTypeName
"usageRateCalculationTypeName": "Sample Name"
Type: String
The name of the object associated with the usageRateCalculationTypeId property.
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.
updated
"updated": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.


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 UsageRate object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEUsage/Rate/{id}
Delete an instance of the UsageRate 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 UsageRate object.
Delete an instance of the UsageRate object.
DELETE Usage/Rate/{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": "usageRate"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
DELETEUsage/Rate/{id}
Delete an instance of the UsageRate 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 UsageRate object.
Delete an instance of the UsageRate object.
DELETE Usage/Rate/{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": "usageRate"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
DELETEUsage/Rate/{id}
Delete an instance of the UsageRate 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 UsageRate object.
Delete an instance of the UsageRate object.
DELETE Usage/Rate/{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": "usageRate"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
DELETEUsage/Rate/{id}
Delete an instance of the UsageRate 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 UsageRate object.
Delete an instance of the UsageRate object.
DELETE Usage/Rate/{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": "usageRate"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
DELETEUsage/Rate/{id}
Delete an instance of the UsageRate 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 UsageRate object.
Delete an instance of the UsageRate object.
DELETE Usage/Rate/{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": "usageRate"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETUsage/Rate/
Retrieve all of the UsageRate objects.
Retrieve all of the UsageRate objects.
GET Usage/Rate/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "usageRateGroupId": 0,
            "usageRateGroupName": "Sample Text Data",
            "usageClassId": 1,
            "usageClassName": "Sample Text Data",
            "amount": 2.52,
            "geoTreeLocationId": 24,
            "geoTreeLocationName": "Sample Text Data",
            "additional": true,
            "retired": true,
            "ownerId": 17,
            "ownerName": "Sample Text Data",
            "usageRoundingId": 3,
            "usageRoundingName": "Sample Text Data",
            "displayName": "My Rate",
            "geoTreeLocationGroupId": 15,
            "geoTreeLocationGroupName": "Sample Text Data",
            "minimumCharge": 5.34,
            "usageUnitId": 16,
            "usageUnitName": "Sample Text Data",
            "usageRateCalculationTypeId": 9,
            "usageRateCalculationTypeName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "updated": "2021-04-26T15:25:27.587Z"
        }
    ]
}
GETUsage/Rate/
Retrieve all of the UsageRate objects.
Retrieve all of the UsageRate objects.
GET Usage/Rate/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "usageRateGroupId": 0,
            "usageRateGroupName": "Sample Text Data",
            "usageClassId": 16,
            "usageClassName": "Sample Text Data",
            "amount": 2.52,
            "geoTreeLocationId": 6,
            "geoTreeLocationName": "Sample Text Data",
            "additional": true,
            "retired": true,
            "ownerId": 23,
            "ownerName": "Sample Text Data",
            "usageRoundingId": 10,
            "usageRoundingName": "Sample Text Data",
            "displayName": "My Rate",
            "geoTreeLocationGroupId": 2,
            "geoTreeLocationGroupName": "Sample Text Data",
            "minimumCharge": 5.34,
            "usageUnitId": 19,
            "usageUnitName": "Sample Text Data",
            "usageRateCalculationTypeId": 2,
            "usageRateCalculationTypeName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "updated": "2021-04-26T15:25:27.587Z"
        }
    ]
}
GETUsage/Rate/
Retrieve all of the UsageRate objects.
Retrieve all of the UsageRate objects.
GET Usage/Rate/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "usageRateGroupId": 0,
            "usageRateGroupName": "Sample Text Data",
            "usageClassId": 8,
            "usageClassName": "Sample Text Data",
            "amount": 2.52,
            "geoTreeLocationId": 19,
            "geoTreeLocationName": "Sample Text Data",
            "additional": true,
            "retired": true,
            "ownerId": 24,
            "ownerName": "Sample Text Data",
            "usageRoundingId": 10,
            "usageRoundingName": "Sample Text Data",
            "displayName": "My Rate",
            "geoTreeLocationGroupId": 18,
            "geoTreeLocationGroupName": "Sample Text Data",
            "minimumCharge": 5.34,
            "usageUnitId": 4,
            "usageUnitName": "Sample Text Data",
            "usageRateCalculationTypeId": 17,
            "usageRateCalculationTypeName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "updated": "2021-04-26T15:25:27.587Z"
        }
    ]
}
GETUsage/Rate/
Retrieve all of the UsageRate objects.
Retrieve all of the UsageRate objects.
GET Usage/Rate/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "usageRateGroupId": 27,
            "usageRateGroupName": "Sample Text Data",
            "usageClassId": 5,
            "usageClassName": "Sample Text Data",
            "amount": 2.52,
            "geoTreeLocationId": 24,
            "geoTreeLocationName": "Sample Text Data",
            "additional": true,
            "retired": true,
            "ownerId": 10,
            "ownerName": "Sample Text Data",
            "usageRoundingId": 8,
            "usageRoundingName": "Sample Text Data",
            "displayName": "My Rate",
            "geoTreeLocationGroupId": 7,
            "geoTreeLocationGroupName": "Sample Text Data",
            "minimumCharge": 5.34,
            "usageUnitId": 17,
            "usageUnitName": "Sample Text Data",
            "usageRateCalculationTypeId": 1,
            "usageRateCalculationTypeName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "updated": "2021-04-26T15:25:27.587Z"
        }
    ]
}
GETUsage/Rate/
Retrieve all of the UsageRate objects.
Retrieve all of the UsageRate objects.
GET Usage/Rate/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "usageRateGroupId": 23,
            "usageRateGroupName": "Sample Text Data",
            "usageClassId": 1,
            "usageClassName": "Sample Text Data",
            "amount": 2.52,
            "geoTreeLocationId": 27,
            "geoTreeLocationName": "Sample Text Data",
            "additional": true,
            "retired": true,
            "ownerId": 18,
            "ownerName": "Sample Text Data",
            "usageRoundingId": 3,
            "usageRoundingName": "Sample Text Data",
            "displayName": "My Rate",
            "geoTreeLocationGroupId": 20,
            "geoTreeLocationGroupName": "Sample Text Data",
            "minimumCharge": 5.34,
            "usageUnitId": 7,
            "usageUnitName": "Sample Text Data",
            "usageRateCalculationTypeId": 6,
            "usageRateCalculationTypeName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "updated": "2021-04-26T15:25:27.587Z"
        }
    ]
}
GETUsage/Rate/Metadata
Retrieve all of the UsageRate objects.
Retrieve all of the UsageRate objects.
GET Usage/Rate/Metadata
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "usageRateGroupId": 17,
            "usageRateGroupName": "Sample Text Data",
            "usageClassId": 17,
            "usageClassName": "Sample Text Data",
            "amount": 2.52,
            "geoTreeLocationId": 24,
            "geoTreeLocationName": "Sample Text Data",
            "additional": true,
            "retired": true,
            "ownerId": 6,
            "ownerName": "Sample Text Data",
            "usageRoundingId": 5,
            "usageRoundingName": "Sample Text Data",
            "displayName": "My Rate",
            "geoTreeLocationGroupId": 22,
            "geoTreeLocationGroupName": "Sample Text Data",
            "minimumCharge": 5.34,
            "usageUnitId": 26,
            "usageUnitName": "Sample Text Data",
            "usageRateCalculationTypeId": 4,
            "usageRateCalculationTypeName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "updated": "2021-04-26T15:25:27.587Z"
        }
    ]
}
GETUsage/Rate/Metadata/sql
Retrieve all of the UsageRate objects.
Retrieve all of the UsageRate objects.
GET Usage/Rate/Metadata/sql
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "usageRateGroupId": 25,
            "usageRateGroupName": "Sample Text Data",
            "usageClassId": 19,
            "usageClassName": "Sample Text Data",
            "amount": 2.52,
            "geoTreeLocationId": 0,
            "geoTreeLocationName": "Sample Text Data",
            "additional": true,
            "retired": true,
            "ownerId": 15,
            "ownerName": "Sample Text Data",
            "usageRoundingId": 25,
            "usageRoundingName": "Sample Text Data",
            "displayName": "My Rate",
            "geoTreeLocationGroupId": 27,
            "geoTreeLocationGroupName": "Sample Text Data",
            "minimumCharge": 5.34,
            "usageUnitId": 10,
            "usageUnitName": "Sample Text Data",
            "usageRateCalculationTypeId": 20,
            "usageRateCalculationTypeName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "updated": "2021-04-26T15:25:27.587Z"
        }
    ]
}
GETUsage/Rate/Paged
Retrieve all of the UsageRate 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 UsageRate objects in a paged fashion.
GET Usage/Rate/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,
                "usageRateGroupId": 3,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 27,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 20,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 5,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 16,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 4,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 21,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 20,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
GETUsage/Rate/Paged
Retrieve all of the UsageRate 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 UsageRate objects in a paged fashion.
GET Usage/Rate/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,
                "usageRateGroupId": 0,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 13,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 13,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 5,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 7,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 26,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 1,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 5,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
GETUsage/Rate/Paged
Retrieve all of the UsageRate 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 UsageRate objects in a paged fashion.
GET Usage/Rate/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,
                "usageRateGroupId": 12,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 8,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 23,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 16,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 25,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 11,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 14,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 2,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
GETUsage/Rate/Paged
Retrieve all of the UsageRate 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 UsageRate objects in a paged fashion.
GET Usage/Rate/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,
                "usageRateGroupId": 21,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 23,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 11,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 22,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 4,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 1,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 2,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 11,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
GETUsage/Rate/Paged
Retrieve all of the UsageRate 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 UsageRate objects in a paged fashion.
GET Usage/Rate/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,
                "usageRateGroupId": 22,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 9,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 24,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 9,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 19,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 17,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 23,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 17,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
GETUsage/Rate/Paged/Detail
Retrieve all of the UsageRate 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 UsageRate objects in a paged fashion with all object details.
GET Usage/Rate/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,
                "usageRateGroupId": 12,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 20,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 13,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 9,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 25,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 5,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 11,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 11,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "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
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETUsage/Rate/Paged/Detail
Retrieve all of the UsageRate 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 UsageRate objects in a paged fashion with all object details.
GET Usage/Rate/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,
                "usageRateGroupId": 9,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 1,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 8,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 9,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 5,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 0,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 11,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 9,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "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
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETUsage/Rate/Paged/Detail
Retrieve all of the UsageRate 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 UsageRate objects in a paged fashion with all object details.
GET Usage/Rate/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,
                "usageRateGroupId": 27,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 9,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 26,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 25,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 22,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 23,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 12,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 15,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "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
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETUsage/Rate/Paged/Detail
Retrieve all of the UsageRate 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 UsageRate objects in a paged fashion with all object details.
GET Usage/Rate/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,
                "usageRateGroupId": 3,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 2,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 13,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 22,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 1,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 20,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 19,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 22,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "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
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETUsage/Rate/Paged/Detail
Retrieve all of the UsageRate 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 UsageRate objects in a paged fashion with all object details.
GET Usage/Rate/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,
                "usageRateGroupId": 26,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 10,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 3,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 24,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 10,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 5,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 12,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 2,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "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
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETUsage/Rate/{id}
Retrieve an instance of the UsageRate object by its ID.
{id}Unique identifier for the UsageRate object.
Retrieve an instance of the UsageRate object by its ID.
GET Usage/Rate/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageRateGroupId": 17,
        "usageRateGroupName": "Sample Text Data",
        "usageClassId": 26,
        "usageClassName": "Sample Text Data",
        "amount": 2.52,
        "geoTreeLocationId": 22,
        "geoTreeLocationName": "Sample Text Data",
        "additional": true,
        "retired": true,
        "ownerId": 18,
        "ownerName": "Sample Text Data",
        "usageRoundingId": 5,
        "usageRoundingName": "Sample Text Data",
        "displayName": "My Rate",
        "geoTreeLocationGroupId": 15,
        "geoTreeLocationGroupName": "Sample Text Data",
        "minimumCharge": 5.34,
        "usageUnitId": 11,
        "usageUnitName": "Sample Text Data",
        "usageRateCalculationTypeId": 12,
        "usageRateCalculationTypeName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "updated": "2021-04-26T15:25:27.587Z"
    }
}
GETUsage/Rate/{id}
Retrieve an instance of the UsageRate object by its ID.
{id}Unique identifier for the UsageRate object.
Retrieve an instance of the UsageRate object by its ID.
GET Usage/Rate/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageRateGroupId": 23,
        "usageRateGroupName": "Sample Text Data",
        "usageClassId": 7,
        "usageClassName": "Sample Text Data",
        "amount": 2.52,
        "geoTreeLocationId": 2,
        "geoTreeLocationName": "Sample Text Data",
        "additional": true,
        "retired": true,
        "ownerId": 8,
        "ownerName": "Sample Text Data",
        "usageRoundingId": 8,
        "usageRoundingName": "Sample Text Data",
        "displayName": "My Rate",
        "geoTreeLocationGroupId": 9,
        "geoTreeLocationGroupName": "Sample Text Data",
        "minimumCharge": 5.34,
        "usageUnitId": 17,
        "usageUnitName": "Sample Text Data",
        "usageRateCalculationTypeId": 25,
        "usageRateCalculationTypeName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "updated": "2021-04-26T15:25:27.587Z"
    }
}
GETUsage/Rate/{id}
Retrieve an instance of the UsageRate object by its ID.
{id}Unique identifier for the UsageRate object.
Retrieve an instance of the UsageRate object by its ID.
GET Usage/Rate/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageRateGroupId": 1,
        "usageRateGroupName": "Sample Text Data",
        "usageClassId": 5,
        "usageClassName": "Sample Text Data",
        "amount": 2.52,
        "geoTreeLocationId": 5,
        "geoTreeLocationName": "Sample Text Data",
        "additional": true,
        "retired": true,
        "ownerId": 23,
        "ownerName": "Sample Text Data",
        "usageRoundingId": 23,
        "usageRoundingName": "Sample Text Data",
        "displayName": "My Rate",
        "geoTreeLocationGroupId": 9,
        "geoTreeLocationGroupName": "Sample Text Data",
        "minimumCharge": 5.34,
        "usageUnitId": 2,
        "usageUnitName": "Sample Text Data",
        "usageRateCalculationTypeId": 6,
        "usageRateCalculationTypeName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "updated": "2021-04-26T15:25:27.587Z"
    }
}
GETUsage/Rate/{id}
Retrieve an instance of the UsageRate object by its ID.
{id}Unique identifier for the UsageRate object.
Retrieve an instance of the UsageRate object by its ID.
GET Usage/Rate/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageRateGroupId": 22,
        "usageRateGroupName": "Sample Text Data",
        "usageClassId": 9,
        "usageClassName": "Sample Text Data",
        "amount": 2.52,
        "geoTreeLocationId": 21,
        "geoTreeLocationName": "Sample Text Data",
        "additional": true,
        "retired": true,
        "ownerId": 2,
        "ownerName": "Sample Text Data",
        "usageRoundingId": 4,
        "usageRoundingName": "Sample Text Data",
        "displayName": "My Rate",
        "geoTreeLocationGroupId": 19,
        "geoTreeLocationGroupName": "Sample Text Data",
        "minimumCharge": 5.34,
        "usageUnitId": 6,
        "usageUnitName": "Sample Text Data",
        "usageRateCalculationTypeId": 8,
        "usageRateCalculationTypeName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "updated": "2021-04-26T15:25:27.587Z"
    }
}
GETUsage/Rate/{id}
Retrieve an instance of the UsageRate object by its ID.
{id}Unique identifier for the UsageRate object.
Retrieve an instance of the UsageRate object by its ID.
GET Usage/Rate/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageRateGroupId": 17,
        "usageRateGroupName": "Sample Text Data",
        "usageClassId": 21,
        "usageClassName": "Sample Text Data",
        "amount": 2.52,
        "geoTreeLocationId": 17,
        "geoTreeLocationName": "Sample Text Data",
        "additional": true,
        "retired": true,
        "ownerId": 10,
        "ownerName": "Sample Text Data",
        "usageRoundingId": 15,
        "usageRoundingName": "Sample Text Data",
        "displayName": "My Rate",
        "geoTreeLocationGroupId": 25,
        "geoTreeLocationGroupName": "Sample Text Data",
        "minimumCharge": 5.34,
        "usageUnitId": 24,
        "usageUnitName": "Sample Text Data",
        "usageRateCalculationTypeId": 17,
        "usageRateCalculationTypeName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "updated": "2021-04-26T15:25:27.587Z"
    }
}
GETUsage/Rate/{id}/Detail
Retrieve deep detail of the UsageRate 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 UsageRate object.
Retrieve deep detail of the UsageRate object by its ID.
GET Usage/Rate/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageRateGroupId": 16,
        "usageRateGroupName": "Sample Text Data",
        "usageClassId": 9,
        "usageClassName": "Sample Text Data",
        "amount": 2.52,
        "geoTreeLocationId": 24,
        "geoTreeLocationName": "Sample Text Data",
        "additional": true,
        "retired": true,
        "ownerId": 13,
        "ownerName": "Sample Text Data",
        "usageRoundingId": 26,
        "usageRoundingName": "Sample Text Data",
        "displayName": "My Rate",
        "geoTreeLocationGroupId": 5,
        "geoTreeLocationGroupName": "Sample Text Data",
        "minimumCharge": 5.34,
        "usageUnitId": 7,
        "usageUnitName": "Sample Text Data",
        "usageRateCalculationTypeId": 27,
        "usageRateCalculationTypeName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "updated": "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
                    }
                ]
            }
        }
    }
}
GETUsage/Rate/{id}/Detail
Retrieve deep detail of the UsageRate 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 UsageRate object.
Retrieve deep detail of the UsageRate object by its ID.
GET Usage/Rate/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageRateGroupId": 20,
        "usageRateGroupName": "Sample Text Data",
        "usageClassId": 4,
        "usageClassName": "Sample Text Data",
        "amount": 2.52,
        "geoTreeLocationId": 18,
        "geoTreeLocationName": "Sample Text Data",
        "additional": true,
        "retired": true,
        "ownerId": 1,
        "ownerName": "Sample Text Data",
        "usageRoundingId": 27,
        "usageRoundingName": "Sample Text Data",
        "displayName": "My Rate",
        "geoTreeLocationGroupId": 24,
        "geoTreeLocationGroupName": "Sample Text Data",
        "minimumCharge": 5.34,
        "usageUnitId": 22,
        "usageUnitName": "Sample Text Data",
        "usageRateCalculationTypeId": 13,
        "usageRateCalculationTypeName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "updated": "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
                    }
                ]
            }
        }
    }
}
GETUsage/Rate/{id}/Detail
Retrieve deep detail of the UsageRate 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 UsageRate object.
Retrieve deep detail of the UsageRate object by its ID.
GET Usage/Rate/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageRateGroupId": 18,
        "usageRateGroupName": "Sample Text Data",
        "usageClassId": 21,
        "usageClassName": "Sample Text Data",
        "amount": 2.52,
        "geoTreeLocationId": 19,
        "geoTreeLocationName": "Sample Text Data",
        "additional": true,
        "retired": true,
        "ownerId": 22,
        "ownerName": "Sample Text Data",
        "usageRoundingId": 22,
        "usageRoundingName": "Sample Text Data",
        "displayName": "My Rate",
        "geoTreeLocationGroupId": 7,
        "geoTreeLocationGroupName": "Sample Text Data",
        "minimumCharge": 5.34,
        "usageUnitId": 0,
        "usageUnitName": "Sample Text Data",
        "usageRateCalculationTypeId": 18,
        "usageRateCalculationTypeName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "updated": "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
                    }
                ]
            }
        }
    }
}
GETUsage/Rate/{id}/Detail
Retrieve deep detail of the UsageRate 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 UsageRate object.
Retrieve deep detail of the UsageRate object by its ID.
GET Usage/Rate/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageRateGroupId": 15,
        "usageRateGroupName": "Sample Text Data",
        "usageClassId": 11,
        "usageClassName": "Sample Text Data",
        "amount": 2.52,
        "geoTreeLocationId": 7,
        "geoTreeLocationName": "Sample Text Data",
        "additional": true,
        "retired": true,
        "ownerId": 11,
        "ownerName": "Sample Text Data",
        "usageRoundingId": 10,
        "usageRoundingName": "Sample Text Data",
        "displayName": "My Rate",
        "geoTreeLocationGroupId": 23,
        "geoTreeLocationGroupName": "Sample Text Data",
        "minimumCharge": 5.34,
        "usageUnitId": 18,
        "usageUnitName": "Sample Text Data",
        "usageRateCalculationTypeId": 20,
        "usageRateCalculationTypeName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "updated": "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
                    }
                ]
            }
        }
    }
}
GETUsage/Rate/{id}/Detail
Retrieve deep detail of the UsageRate 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 UsageRate object.
Retrieve deep detail of the UsageRate object by its ID.
GET Usage/Rate/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageRateGroupId": 21,
        "usageRateGroupName": "Sample Text Data",
        "usageClassId": 18,
        "usageClassName": "Sample Text Data",
        "amount": 2.52,
        "geoTreeLocationId": 22,
        "geoTreeLocationName": "Sample Text Data",
        "additional": true,
        "retired": true,
        "ownerId": 5,
        "ownerName": "Sample Text Data",
        "usageRoundingId": 16,
        "usageRoundingName": "Sample Text Data",
        "displayName": "My Rate",
        "geoTreeLocationGroupId": 9,
        "geoTreeLocationGroupName": "Sample Text Data",
        "minimumCharge": 5.34,
        "usageUnitId": 0,
        "usageUnitName": "Sample Text Data",
        "usageRateCalculationTypeId": 8,
        "usageRateCalculationTypeName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "updated": "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
                    }
                ]
            }
        }
    }
}
PATCHUsage/Rate/{id}
Update or Add the UsageRate 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 UsageRate object.
Update or Add the UsageRate object and optionally make changes to any child objects.
PATCH Usage/Rate/{id}

{
    "details": {},
    "usageRates": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "usageRateGroupId": 16,
                "usageClassId": 0,
                "amount": 2.52,
                "geoTreeLocationId": 17,
                "additional": true,
                "usageRoundingId": 17,
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 22,
                "minimumCharge": 5.34,
                "usageUnitId": 27,
                "usageRateCalculationTypeId": 14,
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
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": "usageRate",
                "instance": {
                    "identity": 1,
                    "usageRateGroupId": 6,
                    "usageRateGroupName": "Sample Text Data",
                    "usageClassId": 10,
                    "usageClassName": "Sample Text Data",
                    "amount": 2.52,
                    "geoTreeLocationId": 4,
                    "geoTreeLocationName": "Sample Text Data",
                    "additional": true,
                    "retired": true,
                    "ownerId": 16,
                    "ownerName": "Sample Text Data",
                    "usageRoundingId": 27,
                    "usageRoundingName": "Sample Text Data",
                    "displayName": "My Rate",
                    "geoTreeLocationGroupId": 9,
                    "geoTreeLocationGroupName": "Sample Text Data",
                    "minimumCharge": 5.34,
                    "usageUnitId": 26,
                    "usageUnitName": "Sample Text Data",
                    "usageRateCalculationTypeId": 16,
                    "usageRateCalculationTypeName": "Sample Text Data",
                    "created": "2021-04-26T15:25:27.587Z",
                    "updated": "2021-04-26T15:25:27.587Z"
                }
            }
        ]
    }
}
PATCHUsage/Rate/{id}
Update or Add the UsageRate 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 UsageRate object.
Update or Add the UsageRate object and optionally make changes to any child objects.
PATCH Usage/Rate/{id}

{
    "details": {},
    "usageRates": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "usageRateGroupId": 12,
                "usageClassId": 8,
                "amount": 2.52,
                "geoTreeLocationId": 9,
                "additional": true,
                "usageRoundingId": 0,
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 14,
                "minimumCharge": 5.34,
                "usageUnitId": 13,
                "usageRateCalculationTypeId": 8,
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
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": "usageRate",
                "instance": {
                    "identity": 1,
                    "usageRateGroupId": 15,
                    "usageRateGroupName": "Sample Text Data",
                    "usageClassId": 1,
                    "usageClassName": "Sample Text Data",
                    "amount": 2.52,
                    "geoTreeLocationId": 12,
                    "geoTreeLocationName": "Sample Text Data",
                    "additional": true,
                    "retired": true,
                    "ownerId": 14,
                    "ownerName": "Sample Text Data",
                    "usageRoundingId": 10,
                    "usageRoundingName": "Sample Text Data",
                    "displayName": "My Rate",
                    "geoTreeLocationGroupId": 3,
                    "geoTreeLocationGroupName": "Sample Text Data",
                    "minimumCharge": 5.34,
                    "usageUnitId": 26,
                    "usageUnitName": "Sample Text Data",
                    "usageRateCalculationTypeId": 26,
                    "usageRateCalculationTypeName": "Sample Text Data",
                    "created": "2021-04-26T15:25:27.587Z",
                    "updated": "2021-04-26T15:25:27.587Z"
                }
            }
        ]
    }
}
PATCHUsage/Rate/{id}
Update or Add the UsageRate 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 UsageRate object.
Update or Add the UsageRate object and optionally make changes to any child objects.
PATCH Usage/Rate/{id}

{
    "details": {},
    "usageRates": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "usageRateGroupId": 17,
                "usageClassId": 9,
                "amount": 2.52,
                "geoTreeLocationId": 20,
                "additional": true,
                "usageRoundingId": 19,
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 8,
                "minimumCharge": 5.34,
                "usageUnitId": 2,
                "usageRateCalculationTypeId": 4,
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
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": "usageRate",
                "instance": {
                    "identity": 1,
                    "usageRateGroupId": 21,
                    "usageRateGroupName": "Sample Text Data",
                    "usageClassId": 11,
                    "usageClassName": "Sample Text Data",
                    "amount": 2.52,
                    "geoTreeLocationId": 11,
                    "geoTreeLocationName": "Sample Text Data",
                    "additional": true,
                    "retired": true,
                    "ownerId": 4,
                    "ownerName": "Sample Text Data",
                    "usageRoundingId": 11,
                    "usageRoundingName": "Sample Text Data",
                    "displayName": "My Rate",
                    "geoTreeLocationGroupId": 12,
                    "geoTreeLocationGroupName": "Sample Text Data",
                    "minimumCharge": 5.34,
                    "usageUnitId": 12,
                    "usageUnitName": "Sample Text Data",
                    "usageRateCalculationTypeId": 16,
                    "usageRateCalculationTypeName": "Sample Text Data",
                    "created": "2021-04-26T15:25:27.587Z",
                    "updated": "2021-04-26T15:25:27.587Z"
                }
            }
        ]
    }
}
PATCHUsage/Rate/{id}
Update or Add the UsageRate 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 UsageRate object.
Update or Add the UsageRate object and optionally make changes to any child objects.
PATCH Usage/Rate/{id}

{
    "details": {},
    "usageRates": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "usageRateGroupId": 4,
                "usageClassId": 13,
                "amount": 2.52,
                "geoTreeLocationId": 12,
                "additional": true,
                "usageRoundingId": 23,
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 15,
                "minimumCharge": 5.34,
                "usageUnitId": 21,
                "usageRateCalculationTypeId": 16,
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
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": "usageRate",
                "instance": {
                    "identity": 1,
                    "usageRateGroupId": 15,
                    "usageRateGroupName": "Sample Text Data",
                    "usageClassId": 12,
                    "usageClassName": "Sample Text Data",
                    "amount": 2.52,
                    "geoTreeLocationId": 27,
                    "geoTreeLocationName": "Sample Text Data",
                    "additional": true,
                    "retired": true,
                    "ownerId": 8,
                    "ownerName": "Sample Text Data",
                    "usageRoundingId": 17,
                    "usageRoundingName": "Sample Text Data",
                    "displayName": "My Rate",
                    "geoTreeLocationGroupId": 24,
                    "geoTreeLocationGroupName": "Sample Text Data",
                    "minimumCharge": 5.34,
                    "usageUnitId": 4,
                    "usageUnitName": "Sample Text Data",
                    "usageRateCalculationTypeId": 13,
                    "usageRateCalculationTypeName": "Sample Text Data",
                    "created": "2021-04-26T15:25:27.587Z",
                    "updated": "2021-04-26T15:25:27.587Z"
                }
            }
        ]
    }
}
PATCHUsage/Rate/{id}
Update or Add the UsageRate 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 UsageRate object.
Update or Add the UsageRate object and optionally make changes to any child objects.
PATCH Usage/Rate/{id}

{
    "details": {},
    "usageRates": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "usageRateGroupId": 22,
                "usageClassId": 5,
                "amount": 2.52,
                "geoTreeLocationId": 22,
                "additional": true,
                "usageRoundingId": 7,
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 17,
                "minimumCharge": 5.34,
                "usageUnitId": 19,
                "usageRateCalculationTypeId": 9,
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
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": "usageRate",
                "instance": {
                    "identity": 1,
                    "usageRateGroupId": 27,
                    "usageRateGroupName": "Sample Text Data",
                    "usageClassId": 12,
                    "usageClassName": "Sample Text Data",
                    "amount": 2.52,
                    "geoTreeLocationId": 8,
                    "geoTreeLocationName": "Sample Text Data",
                    "additional": true,
                    "retired": true,
                    "ownerId": 15,
                    "ownerName": "Sample Text Data",
                    "usageRoundingId": 11,
                    "usageRoundingName": "Sample Text Data",
                    "displayName": "My Rate",
                    "geoTreeLocationGroupId": 23,
                    "geoTreeLocationGroupName": "Sample Text Data",
                    "minimumCharge": 5.34,
                    "usageUnitId": 6,
                    "usageUnitName": "Sample Text Data",
                    "usageRateCalculationTypeId": 27,
                    "usageRateCalculationTypeName": "Sample Text Data",
                    "created": "2021-04-26T15:25:27.587Z",
                    "updated": "2021-04-26T15:25:27.587Z"
                }
            }
        ]
    }
}
POSTUsage/Rate/
Create a new instance of the UsageRate object.
Create a new instance of the UsageRate object.
POST Usage/Rate/

{
    "usageRateGroupId": 10,
    "usageClassId": 23,
    "amount": 2.52,
    "geoTreeLocationId": 5,
    "additional": true,
    "usageRoundingId": 21,
    "displayName": "My Rate",
    "geoTreeLocationGroupId": 13,
    "minimumCharge": 5.34,
    "usageUnitId": 21,
    "usageRateCalculationTypeId": 20,
    "updated": "2021-04-26T15:25:27.587Z"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageRateGroupId": 4,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 20,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 27,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 7,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 10,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 21,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 15,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 24,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
POSTUsage/Rate/
Create a new instance of the UsageRate object.
Create a new instance of the UsageRate object.
POST Usage/Rate/

{
    "usageRateGroupId": 13,
    "usageClassId": 12,
    "amount": 2.52,
    "geoTreeLocationId": 24,
    "additional": true,
    "usageRoundingId": 1,
    "displayName": "My Rate",
    "geoTreeLocationGroupId": 25,
    "minimumCharge": 5.34,
    "usageUnitId": 18,
    "usageRateCalculationTypeId": 2,
    "updated": "2021-04-26T15:25:27.587Z"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageRateGroupId": 11,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 24,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 8,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 24,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 9,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 16,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 8,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 16,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
POSTUsage/Rate/
Create a new instance of the UsageRate object.
Create a new instance of the UsageRate object.
POST Usage/Rate/

{
    "usageRateGroupId": 15,
    "usageClassId": 15,
    "amount": 2.52,
    "geoTreeLocationId": 20,
    "additional": true,
    "usageRoundingId": 5,
    "displayName": "My Rate",
    "geoTreeLocationGroupId": 22,
    "minimumCharge": 5.34,
    "usageUnitId": 17,
    "usageRateCalculationTypeId": 1,
    "updated": "2021-04-26T15:25:27.587Z"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageRateGroupId": 8,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 26,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 23,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 7,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 5,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 1,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 3,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 9,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
POSTUsage/Rate/
Create a new instance of the UsageRate object.
Create a new instance of the UsageRate object.
POST Usage/Rate/

{
    "usageRateGroupId": 14,
    "usageClassId": 21,
    "amount": 2.52,
    "geoTreeLocationId": 5,
    "additional": true,
    "usageRoundingId": 22,
    "displayName": "My Rate",
    "geoTreeLocationGroupId": 24,
    "minimumCharge": 5.34,
    "usageUnitId": 10,
    "usageRateCalculationTypeId": 16,
    "updated": "2021-04-26T15:25:27.587Z"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageRateGroupId": 1,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 6,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 6,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 6,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 21,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 25,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 5,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 5,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
POSTUsage/Rate/
Create a new instance of the UsageRate object.
Create a new instance of the UsageRate object.
POST Usage/Rate/

{
    "usageRateGroupId": 18,
    "usageClassId": 3,
    "amount": 2.52,
    "geoTreeLocationId": 10,
    "additional": true,
    "usageRoundingId": 10,
    "displayName": "My Rate",
    "geoTreeLocationGroupId": 14,
    "minimumCharge": 5.34,
    "usageUnitId": 6,
    "usageRateCalculationTypeId": 9,
    "updated": "2021-04-26T15:25:27.587Z"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageRateGroupId": 2,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 9,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 14,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 7,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 1,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 16,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 26,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 27,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
PUTUsage/Rate/{id}
Update an existing instance of the UsageRate object.
Update an existing instance of the UsageRate object.
PUT Usage/Rate/{id}

{
    "identity": 1,
    "usageRateGroupId": 10,
    "usageClassId": 1,
    "amount": 2.52,
    "geoTreeLocationId": 14,
    "additional": true,
    "usageRoundingId": 22,
    "displayName": "My Rate",
    "geoTreeLocationGroupId": 2,
    "minimumCharge": 5.34,
    "usageUnitId": 25,
    "usageRateCalculationTypeId": 7,
    "updated": "2021-04-26T15:25:27.587Z"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageRateGroupId": 3,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 23,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 6,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 19,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 2,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 0,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 25,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 23,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
PUTUsage/Rate/{id}
Update an existing instance of the UsageRate object.
Update an existing instance of the UsageRate object.
PUT Usage/Rate/{id}

{
    "identity": 1,
    "usageRateGroupId": 23,
    "usageClassId": 21,
    "amount": 2.52,
    "geoTreeLocationId": 12,
    "additional": true,
    "usageRoundingId": 0,
    "displayName": "My Rate",
    "geoTreeLocationGroupId": 9,
    "minimumCharge": 5.34,
    "usageUnitId": 7,
    "usageRateCalculationTypeId": 8,
    "updated": "2021-04-26T15:25:27.587Z"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageRateGroupId": 25,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 20,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 0,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 21,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 6,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 15,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 18,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 0,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
PUTUsage/Rate/{id}
Update an existing instance of the UsageRate object.
Update an existing instance of the UsageRate object.
PUT Usage/Rate/{id}

{
    "identity": 1,
    "usageRateGroupId": 14,
    "usageClassId": 27,
    "amount": 2.52,
    "geoTreeLocationId": 13,
    "additional": true,
    "usageRoundingId": 27,
    "displayName": "My Rate",
    "geoTreeLocationGroupId": 7,
    "minimumCharge": 5.34,
    "usageUnitId": 8,
    "usageRateCalculationTypeId": 13,
    "updated": "2021-04-26T15:25:27.587Z"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageRateGroupId": 14,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 13,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 9,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 19,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 18,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 3,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 15,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 21,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
PUTUsage/Rate/{id}
Update an existing instance of the UsageRate object.
Update an existing instance of the UsageRate object.
PUT Usage/Rate/{id}

{
    "identity": 1,
    "usageRateGroupId": 20,
    "usageClassId": 26,
    "amount": 2.52,
    "geoTreeLocationId": 23,
    "additional": true,
    "usageRoundingId": 3,
    "displayName": "My Rate",
    "geoTreeLocationGroupId": 9,
    "minimumCharge": 5.34,
    "usageUnitId": 3,
    "usageRateCalculationTypeId": 14,
    "updated": "2021-04-26T15:25:27.587Z"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageRateGroupId": 5,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 23,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 6,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 23,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 20,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 21,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 20,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 25,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}
PUTUsage/Rate/{id}
Update an existing instance of the UsageRate object.
Update an existing instance of the UsageRate object.
PUT Usage/Rate/{id}

{
    "identity": 1,
    "usageRateGroupId": 1,
    "usageClassId": 21,
    "amount": 2.52,
    "geoTreeLocationId": 17,
    "additional": true,
    "usageRoundingId": 1,
    "displayName": "My Rate",
    "geoTreeLocationGroupId": 10,
    "minimumCharge": 5.34,
    "usageUnitId": 20,
    "usageRateCalculationTypeId": 6,
    "updated": "2021-04-26T15:25:27.587Z"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "usageRateGroupId": 10,
                "usageRateGroupName": "Sample Text Data",
                "usageClassId": 9,
                "usageClassName": "Sample Text Data",
                "amount": 2.52,
                "geoTreeLocationId": 15,
                "geoTreeLocationName": "Sample Text Data",
                "additional": true,
                "retired": true,
                "ownerId": 20,
                "ownerName": "Sample Text Data",
                "usageRoundingId": 14,
                "usageRoundingName": "Sample Text Data",
                "displayName": "My Rate",
                "geoTreeLocationGroupId": 6,
                "geoTreeLocationGroupName": "Sample Text Data",
                "minimumCharge": 5.34,
                "usageUnitId": 1,
                "usageUnitName": "Sample Text Data",
                "usageRateCalculationTypeId": 10,
                "usageRateCalculationTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "updated": "2021-04-26T15:25:27.587Z"
            }
        ]
    }
}