TAG LINE
TAG LINE
SMALL TITLE
Rate plans contain rate groups and rate groups contain rates.
identity READ-ONLY | "identity": 1 Type: Number This is the unique numeric identifier for the RatePlan |
ownerId READ-ONLY | "ownerId": 16 Type: Number Unique identifier for the associated Owner object. |
ownerName READ-ONLY | "ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property. |
name | "name": "Gold Rate Plan" Type: String User defined name for the Rate Plan. |
displayName | "displayName": "Hello World" Type: String |
amountPrecision | "amountPrecision": 13 Type: Number |
updated READ-ONLY | "updated": "2021-04-26T15:25:27.587Z" Type: Date The date time stamp when this record was updated. Date and time values are specified in the ISO 8601 format. |
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. Below you will find the child objects that can be updated as part of PATCH operations for the RatePlan object.
Standard PATCH objects:
DataFlow PATCH objects:
| DELETE | RatePlan/{id} |
| Delete an instance of the RatePlan object. Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the RatePlan object. |
Delete an instance of the RatePlan object. DELETE RatePlan/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "ratePlan"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | RatePlan/ |
| Retrieve all of the RatePlan objects. | |
Retrieve all of the RatePlan objects. GET RatePlan/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 2,
"ownerName": "Sample Text Data",
"name": "Gold Rate Plan",
"displayName": "Sample Text Data",
"amountPrecision": 1,
"updated": "2021-04-26T15:25:27.587Z"
}
]
} | |
| GET | RatePlan/Paged |
| Retrieve all of the RatePlan 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 RatePlan objects in a paged fashion. GET RatePlan/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 18,
"ownerName": "Sample Text Data",
"name": "Gold Rate Plan",
"displayName": "Sample Text Data",
"amountPrecision": 24,
"updated": "2021-04-26T15:25:27.587Z"
}
]
}
} | |
| GET | RatePlan/Paged/Detail |
| Retrieve all of the RatePlan 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 RatePlan objects in a paged fashion with all object details. GET RatePlan/Paged/Detail HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 3,
"ownerName": "Sample Text Data",
"name": "Gold Rate Plan",
"displayName": "Sample Text Data",
"amountPrecision": 11,
"updated": "2021-04-26T15:25:27.587Z",
"details": {
"usageRateGroups": [
{
"identity": 67,
"name": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"useForCost": true,
"timePeriodId": 95,
"timePeriodName": "Sample Text Data",
"displayName": "Sample Text Data",
"currencyId": 74,
"currencyName": "Sample Text Data",
"currencyCode": "Sample Text Data",
"isAggregated": true,
"isPassThrough": true,
"amountPrecision": 16,
"roundingMethodTypeId": 18,
"roundingMethodTypeName": "Sample Text Data",
"usageRatePlanId": 84,
"usageRatePlanName": "Sample Text Data",
"priority": 99,
"generalLedgerId": 30,
"generalLedgerName": "Sample Text Data",
"isTaxInclusive": true,
"details": {
"rateGroupFilters": [
{
"identity": 10,
"usageRateGroupId": 62,
"usageRateGroupName": "Sample Text Data",
"field": "Sample Text Data",
"value": "Sample Text Data",
"operatorTypeId": 89,
"operatorTypeName": "Sample Text Data",
"sortOrder": 88
}
],
"rates": [
{
"identity": 20,
"usageRateGroupId": 29,
"usageRateGroupName": "Sample Text Data",
"usageClassId": 53,
"usageClassName": "Sample Text Data",
"amount": 2.27,
"geoTreeLocationId": 65,
"geoTreeLocationName": "Sample Text Data",
"additional": true,
"retired": true,
"usageRoundingId": 52,
"usageRoundingName": "Sample Text Data",
"displayName": "Sample Text Data",
"geoTreeLocationGroupId": 37,
"geoTreeLocationGroupName": "Sample Text Data",
"minimumCharge": 8.6,
"usageUnitId": 45,
"usageUnitName": "Sample Text Data",
"usageRateCalculationTypeId": 23,
"usageRateCalculationTypeName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z",
"generalLedgerId": 46,
"generalLedgerName": "Sample Text Data",
"serviceTaxCategoryId": 2,
"serviceTaxCategoryName": "Sample Text Data",
"usageBaseUnitId": 68,
"usageBaseUnitName": "Sample Text Data",
"isAggregated": true,
"details": {
"usageRateTierConfiguration": {
"identity": 15,
"usageRateId": 38,
"pricePlanTierTypeId": 58,
"pricePlanTierTypeName": "Sample Text Data",
"countingRuleId": 76,
"countingRuleName": "Sample Text Data",
"details": {
"usageRateTiers": [
{
"identity": 14,
"usageUnitId": 21,
"usageUnitName": "Sample Text Data",
"usageRateTierConfigurationId": 73,
"threshold": 16,
"amount": 47.15,
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z"
}
]
}
}
}
}
]
}
}
]
}
}
]
}
} | |
| GET | RatePlan/{id} |
| Retrieve an instance of the RatePlan object by its ID. | |
| {id} | Unique identifier for the RatePlan object. |
Retrieve an instance of the RatePlan object by its ID. GET RatePlan/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 25,
"ownerName": "Sample Text Data",
"name": "Gold Rate Plan",
"displayName": "Sample Text Data",
"amountPrecision": 25,
"updated": "2021-04-26T15:25:27.587Z"
}
} | |
| GET | RatePlan/{id}/Detail |
| Retrieve deep detail of the RatePlan 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 RatePlan object. |
Retrieve deep detail of the RatePlan object by its ID. GET RatePlan/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 2,
"ownerName": "Sample Text Data",
"name": "Gold Rate Plan",
"displayName": "Sample Text Data",
"amountPrecision": 21,
"updated": "2021-04-26T15:25:27.587Z",
"details": {
"usageRateGroups": [
{
"identity": 67,
"name": "Sample Text Data",
"start": "2021-04-26T15:25:27.587Z",
"end": "2021-04-26T15:25:27.587Z",
"useForCost": true,
"timePeriodId": 95,
"timePeriodName": "Sample Text Data",
"displayName": "Sample Text Data",
"currencyId": 74,
"currencyName": "Sample Text Data",
"currencyCode": "Sample Text Data",
"isAggregated": true,
"isPassThrough": true,
"amountPrecision": 16,
"roundingMethodTypeId": 18,
"roundingMethodTypeName": "Sample Text Data",
"usageRatePlanId": 84,
"usageRatePlanName": "Sample Text Data",
"priority": 99,
"generalLedgerId": 30,
"generalLedgerName": "Sample Text Data",
"isTaxInclusive": true,
"details": {
"rateGroupFilters": [
{
"identity": 10,
"usageRateGroupId": 62,
"usageRateGroupName": "Sample Text Data",
"field": "Sample Text Data",
"value": "Sample Text Data",
"operatorTypeId": 89,
"operatorTypeName": "Sample Text Data",
"sortOrder": 88
}
],
"rates": [
{
"identity": 20,
"usageRateGroupId": 29,
"usageRateGroupName": "Sample Text Data",
"usageClassId": 53,
"usageClassName": "Sample Text Data",
"amount": 2.27,
"geoTreeLocationId": 65,
"geoTreeLocationName": "Sample Text Data",
"additional": true,
"retired": true,
"usageRoundingId": 52,
"usageRoundingName": "Sample Text Data",
"displayName": "Sample Text Data",
"geoTreeLocationGroupId": 37,
"geoTreeLocationGroupName": "Sample Text Data",
"minimumCharge": 8.6,
"usageUnitId": 45,
"usageUnitName": "Sample Text Data",
"usageRateCalculationTypeId": 23,
"usageRateCalculationTypeName": "Sample Text Data",
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z",
"generalLedgerId": 46,
"generalLedgerName": "Sample Text Data",
"serviceTaxCategoryId": 2,
"serviceTaxCategoryName": "Sample Text Data",
"usageBaseUnitId": 68,
"usageBaseUnitName": "Sample Text Data",
"isAggregated": true,
"details": {
"usageRateTierConfiguration": {
"identity": 15,
"usageRateId": 38,
"pricePlanTierTypeId": 58,
"pricePlanTierTypeName": "Sample Text Data",
"countingRuleId": 76,
"countingRuleName": "Sample Text Data",
"details": {
"usageRateTiers": [
{
"identity": 14,
"usageUnitId": 21,
"usageUnitName": "Sample Text Data",
"usageRateTierConfigurationId": 73,
"threshold": 16,
"amount": 47.15,
"created": "2021-04-26T15:25:27.587Z",
"updated": "2021-04-26T15:25:27.587Z"
}
]
}
}
}
}
]
}
}
]
}
}
} | |
| PATCH | RatePlan/{id} |
| Update or Add the RatePlan 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 RatePlan object. |
Update or Add the RatePlan object and optionally make changes to any child objects. PATCH RatePlan/{id}
{
"details": {},
"ratePlans": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"name": "Gold Rate Plan",
"displayName": "Sample Text Data",
"amountPrecision": 21,
"updated": "2021-04-26T15:25:27.587Z"
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "patch",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"action": "created",
"dtoTypeKey": "ratePlan",
"instance": {
"identity": 1,
"ownerId": 14,
"ownerName": "Sample Text Data",
"name": "Gold Rate Plan",
"displayName": "Sample Text Data",
"amountPrecision": 18,
"updated": "2021-04-26T15:25:27.587Z"
}
}
]
}
} | |
| POST | RatePlan/ |
| Create a new instance of the RatePlan object. | |
Create a new instance of the RatePlan object. POST RatePlan/
{
"name": "Gold Rate Plan",
"displayName": "Sample Text Data",
"amountPrecision": 1,
"updated": "2021-04-26T15:25:27.587Z"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 4,
"ownerName": "Sample Text Data",
"name": "Gold Rate Plan",
"displayName": "Sample Text Data",
"amountPrecision": 26,
"updated": "2021-04-26T15:25:27.587Z"
}
]
}
} | |
| PUT | RatePlan/{id} |
| Update an existing instance of the RatePlan object. | |
Update an existing instance of the RatePlan object. PUT RatePlan/{id}
{
"identity": 1,
"name": "Gold Rate Plan",
"displayName": "Sample Text Data",
"amountPrecision": 14,
"updated": "2021-04-26T15:25:27.587Z"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 4,
"ownerName": "Sample Text Data",
"name": "Gold Rate Plan",
"displayName": "Sample Text Data",
"amountPrecision": 8,
"updated": "2021-04-26T15:25:27.587Z"
}
]
}
} | |