Usage / Rate

What can you do with UsageRate?


Properties

Property Details
id
"id": 811
Type: Number
This is the unique numeric identifier for the UsageRate
usageRateGroupId
"usageRateGroupId": 415
Type: Number
Unique identifier for the associated UsageRateGroup object.
usageClassId
"usageClassId": 595
Type: Number
Unique identifier for the associated UsageClass object.
invoicingCategory
"invoicingCategory": "Hello World"
Type: String
amount
"amount": "Hello World"
Type: String
geoTreeLocationId
"geoTreeLocationId": 56
Type: Number
Unique identifier for the associated GeoTreeLocation object.
additional
"additional": true
Type: Boolean
retired
"retired": true
Type: Boolean
ownerId
"ownerId": 36
Type: Number
Unique identifier for the associated Owner object.
usageRoundingId
"usageRoundingId": 975
Type: Number
Unique identifier for the associated UsageRounding object.
displayName
"displayName": "Hello World"
Type: String
geoTreeLocationGroupId
"geoTreeLocationGroupId": 800
Type: Number
Unique identifier for the associated GeoTreeLocationGroup object.
minimumCharge
"minimumCharge": "Hello World"
Type: String
usageUnitId
"usageUnitId": 440
Type: Number
Unique identifier for the associated UsageUnit object.
usageRateCalculationTypeId
"usageRateCalculationTypeId": 989
Type: Number
Unique identifier for the associated UsageRateCalculationType object.


Update Request Filters

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:

  • usageRateGroupId
  • usageClassId
  • invoicingCategory
  • amount
  • geoTreeLocationId
  • additional
  • retired
  • usageRoundingId
  • displayName
  • geoTreeLocationGroupId
  • minimumCharge
  • usageUnitId
  • usageRateCalculationTypeId

DataFlow PATCH objects:


End Points

DELETEapi/v1/Usage/Rate/{id:int}
Delete an instance of the UsageRate object.
GETapi/v1/Usage/Rate
Retrieve all of the UsageRate objects.
GETapi/v1/Usage/Rate/Metadata
Retrieve all of the meta data details of the UsageRate object.
GETapi/v1/Usage/Rate/Metadata/{option}
Retrieve all the meta data details of the UsageRate object based on provided options.
{option}Metadata options for the UsageRate object.
GETapi/v1/Usage/Rate/Paged
Retreive all of the UsageRate objects in a paged fashion.
GETapi/v1/Usage/Rate/{id:int}
Retrieve an instance of the UsageRate object by it's ID.
{id:int}Unique identifier for the UsageRate object.
POSTapi/v1/Usage/Rate
Create a new instance of the UsageRate object.
PUTapi/v1/Usage/Rate/{id:int}
Update an existing instance of the UsageRate object.