TAG LINE
SMALL TITLE

Usage / Rate / Group

(API Version v3)


What can you do with UsageRateGroup?


Properties

Property Details
id
"id": 8
Type: Number
This is the unique numeric identifier for the UsageRateGroup
ownerId
"ownerId": 18
Type: Number
Unique identifier for the associated Owner object.
name
"name": "Hello World"
Type: String
start
"start": "2005-04-11T14:56:24"
Type: Date
end
"end": "2005-04-11T14:56:24"
Type: Date
useForCost
"useForCost": true
Type: Boolean
timePeriodId
"timePeriodId": 4
Type: Number
Unique identifier for the associated TimePeriod object.
displayName
"displayName": "Hello World"
Type: String
currencyId
"currencyId": 24
Type: Number
Unique identifier for the associated Currency object.
isAggregated
"isAggregated": true
Type: Boolean
isPassThrough
"isPassThrough": true
Type: Boolean


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:

  • name
  • start
  • end
  • useForCost
  • timePeriodId
  • displayName
  • currencyId
  • isAggregated
  • isPassThrough
  • currencyCode

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

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v3/Usage/Rate/Group/{id:int}
Delete an instance of the UsageRateGroup object.
GETapi/v3/Usage/Rate/Group
Retrieve all of the UsageRateGroup objects.
GETapi/v3/Usage/Rate/Group/Paged
Retreive all of the UsageRateGroup objects in a paged fashion.
GETapi/v3/Usage/Rate/Group/Paged/Detail
Retreive all of the UsageRateGroup objects in a paged fashion with all object details.
GETapi/v3/Usage/Rate/Group/{id:int}
Retrieve an instance of the UsageRateGroup object by it's ID.
{id:int}Unique identifier for the UsageRateGroup object.
GETapi/v3/Usage/Rate/Group/{id:int}/Detail
Retreive all of the Detail objects for the specified UsageRateGroup.
{id:int}Unique identifier for the UsageRateGroup object.
PATCHapi/v3/Usage/Rate/Group/{id:int}
Update the UsageRateGroup object and optionally make changes to any child objects.
POSTapi/v3/Usage/Rate/Group
Create a new instance of the UsageRateGroup object.
PUTapi/v3/Usage/Rate/Group/{id:int}
Update an existing instance of the UsageRateGroup object.