Add Price Item To Charge Group
post
/rest/v16/pricingSetup/priceItems/actions/addItemToChargeGroup
Use this endpoint to associate a price item to a charge group.
Request
Supported Media Types
- application/json
Root Schema : LinkLaunchItemToChargeGroup
Type:
Show Source
object
-
bomItemVarName:
string()
Title:
BOM Item Variable Name
The BOM item variable name. -
chargeGroupId:
string()
Title:
Charge Group Id
The identifier of the Price Item Charge Group. -
partNumber:
string()
Title:
Part Display Number
The part display number. -
priceItemId:
string()
Title:
Price Item Id
Read Only:true
The identifier of the Price Item. -
serviceDuration:
integer()
Title:
Service Duration Period
The service duration period code of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types. -
serviceDurationPeriod:
string()
Title:
Service Duration
The service duration of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types.
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : PriceItem
Type:
Show Source
object
-
bomItemName:
string()
Title:
BOM Item Name
The BOM item name. -
bomItemVariableName:
string()
Title:
BOM Item Variable Name
The BOM item variable name. -
chargeGroups:
Charge Groups
Title:
Charge Groups
The collection of charge groups for this price item. Note this is a child resource. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
id:
string()
Title:
ID
The unique ID of the Price Item. -
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
partDisplayNumber:
string()
Title:
Part Display Number
The part display number. -
partNumber:
string()
Title:
Part Number
The part number. -
pricedChargeGroupCount:
integer()
Title:
Priced Charge Group Count
Read Only:true
The number of charge groups that have prices defined. -
serviceDuration:
string()
Title:
Service Duration
The service duration of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types. -
serviceDurationPeriod:
string()
Title:
Service Duration Period
The service duration period code of this price model item. This value is relevant only for parts with variable service duration type and is ignored for other types. -
serviceDurationType:
string()
Title:
Service Duration Type
Service duration type.
Nested Schema : Charge Groups
Title:
Charge Groups
The collection of charge groups for this price item. Note this is a child resource.
Match All
Show Source
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : PricingResourceCollection_PriceItemChargeGroup
Type:
Show Source
object
-
count:
integer()
Title:
Count
Read Only:true
The number of resource instances returned in the current range. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
hasMore:
boolean()
Title:
HasMore
Read Only:true
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items:
array items
-
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
limit:
integer()
Title:
Limit
Read Only:true
The actual paging size used by the server. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
offset:
integer()
Title:
OffSet
Read Only:true
The offset value used in the current page. -
totalResults:
integer()
Title:
Total Results
Read Only:true
Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : UserDetails
Type:
Show Source
object
-
emailId:
string()
Title:
Email Id
Email Id of the user -
firstName:
string()
Title:
First Name
First Name of the user -
lastName:
string()
Title:
Last Name
Last Name of the user
Nested Schema : PriceItemChargeGroup
Type:
Show Source
object
-
charges:
Charges
Title:
Charges
Read Only:true
The collection of charges for this charge group. Note this is a child resource. -
conditions:
Simple Conditions
Title:
Simple Conditions
A collection of conditions applied by the Pricing Charge Group. -
conditionType:
string()
Title:
Condition Type
Allowed Values:[ "alwaysTrue", "simple" ]
The condition type of charge groupthat will be evaluated. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
defaultGroup:
boolean()
Title:
Default Group
Indicates whether this is a default charge group. -
editRestriction:
string()
Title:
Edit Restriction
Read Only:true
Allowed Values:[ "UNRESTRICTED", "ONLY_REORDERABLE", "RESTRICTED" ]
Pricing Edit Restriction. -
endDate:
string(yyyy-MM-dd'T'HH:mm:ss'Z')
Title:
End Date
The date after which the Price Charge Group will no longer be applicable. -
hasRatePlanSupport:
boolean()
Title:
Has Rate Plan Support
Read Only:true
Indicates if the charge groups supports rate plans. -
id:
string()
Title:
Id
The identifier of the Price Item Charge Group. -
label:
string()
Title:
Label
The label of charge group. -
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
linked:
boolean()
Title:
Linked
Read Only:true
Indicates if the charge group is linked to the price item.This can be set or reset depending on whether the item needs to linked or de-linked from the charge group -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
matrixTemplateVariableName:
string()
Title:
Dynamic Matrix Template Variable Name
Read Only:true
The dynamic matrix template variable name of the charge group. -
priceModel:
object priceModel
-
priceModelItem:
object priceModelItem
-
ratePlans:
Associated Rate Plans
Title:
Associated Rate Plans
Read Only:true
The rate plans linked to this charge group. -
startDate:
string(yyyy-MM-dd'T'HH:mm:ss'Z')
Title:
Start Date
The date from which the Price Charge Group will be applicable.
Nested Schema : Charges
Title:
Charges
Read Only:
true
The collection of charges for this charge group. Note this is a child resource.
Match All
Show Source
Nested Schema : Simple Conditions
Title:
Simple Conditions
A collection of conditions applied by the Pricing Charge Group.
Match All
Show Source
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : priceModel
Type:
object
Nested Schema : priceModelItem
Type:
object
Nested Schema : Associated Rate Plans
Title:
Associated Rate Plans
Read Only:
true
The rate plans linked to this charge group.
Match All
Show Source
Nested Schema : PricingResourceCollection_PricingCharge
Type:
Show Source
object
-
count:
integer()
Title:
Count
Read Only:true
The number of resource instances returned in the current range. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
hasMore:
boolean()
Title:
HasMore
Read Only:true
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items:
array items
-
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
limit:
integer()
Title:
Limit
Read Only:true
The actual paging size used by the server. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
offset:
integer()
Title:
OffSet
Read Only:true
The offset value used in the current page. -
totalResults:
integer()
Title:
Total Results
Read Only:true
Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : PricingCharge
Type:
Show Source
object
-
blockPrices:
array Block Prices
Title:
Block Prices
The block price. -
blockSize:
number()
Title:
Block Size
The block size. -
chargeDefinition:
string()
Title:
Charge Definition
Read Only:true
Display Name of the Charge Definition. -
chargeDefinitionCode:
string()
Title:
Charge Definition Code
The unique code of the Charge Definition. -
chargeDefinitionId:
integer()
Title:
Charge Definition ID
Read Only:true
ID of the Charge Definition. -
chargeType:
string()
Title:
Charge Type
The category of charge. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation date. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last modified date. -
dynamicPricingType:
string()
Title:
Dynamic Pricing Type
Allowed Values:[ "static", "advanced", "volume", "tiered", "rateCard", "attributeBasedCharge" ]
The dynamic pricing type of the charge. -
endDate:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
End Date
The date at which the Charge will end. -
id:
integer()
Title:
Id
Read Only:true
The Unique Identifier of the Charge. -
integrationId:
string()
Title:
Integration Id
Read Only:true
Rate Plan Charge ID from SCM. -
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
pricePeriod:
string()
Title:
Price Period
The billing period. -
prices:
array Prices
Title:
Prices
The item prices. -
priceType:
string()
Title:
Price Type
The type of charge. -
pricingMatrixVariableName:
string()
Title:
Pricing Matrix Variable Name
Pricing Matrix variable name (Preview only. Not available for use.) -
primaryCharge:
boolean()
Title:
Primary Charge
Indicates whether this is the primary charge. -
rateCardName:
string()
Title:
Rate Card Name
Read Only:true
Rate Card name (Preview only. Not available for use.) -
rateCardVariableName:
string()
Title:
Rate Card Variable Name
Rate Card variable name (Preview only. Not available for use.) -
startDate:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Start Date
The date from which the Charge will be applicable. -
templateVariableName:
string()
Title:
Pricing Matrix Template Variable Name
The pricing matrix emplate variable name. -
tiers:
array Tiers
Title:
Tiers
The charge tiers. -
usageUOM:
string()
Title:
Usage UOM
The unit of measure for the charge.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : PricingCurrencyValues
Type:
Show Source
object
-
currencyCode:
string()
Title:
Currency Code
The currency code. -
value:
number()
Title:
Value
The currency value.
Nested Schema : ChargeTier
Type:
Show Source
object
-
blockPrices:
array Block Prices
Title:
Block Prices
The block price for the corresponding tier. -
blockSize:
number()
Title:
Block Size
The block size for the corresponding tier. -
prices:
array Prices
Title:
Prices
The prices. -
rangeFrom:
number()
Title:
Range From
The starting range of the Charge. -
rangeTo:
number()
Title:
Range To
Read Only:true
The ending range of the Charge.
Nested Schema : Block Prices
Type:
array
Title:
Block Prices
The block price for the corresponding tier.
Show Source
Nested Schema : SimpleConditions
Type:
Show Source
object
-
ruleExpression:
string()
Title:
Rule Expression
The rule expression that will be evaluated. -
simpleConditionRows:
array Simple Condition Rows
Title:
Simple Condition Rows
A list of Simple Condition Rows.
Nested Schema : Simple Condition Rows
Type:
array
Title:
Simple Condition Rows
A list of Simple Condition Rows.
Show Source
Nested Schema : SimpleConditionRow
Type:
Show Source
object
-
displayName:
string()
Title:
Display Name
The display name of the Simple Condition Row. -
index:
integer()
Title:
Index
The index (starting from 1) of the Simple Condition Row. -
operator:
string()
Title:
Operator
Allowed Values:[ "NONE", "EQUAL_TO", "NOT_EQUAL_TO", "GREATER_THAN", "GREATER_THAN_EQUAL_TO", "LESS_THAN", "LESS_THAN_EQUAL_TO", "CONTAINS", "NOT_CONTAINS", "STARTS_WITH", "NOT_STARTS_WITH", "ENDS_WITH", "NOT_ENDS_WITH" ]
The operation of the Simple Condition Row. -
value:
string()
Title:
Target Value
The value to match. -
variableName:
string()
Title:
Simple Condition Row
The variable name of the Simple Condition Row.
Nested Schema : PricingResourceCollection_PricingRatePlan
Type:
Show Source
object
-
count:
integer()
Title:
Count
Read Only:true
The number of resource instances returned in the current range. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
hasMore:
boolean()
Title:
HasMore
Read Only:true
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items:
array items
-
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
limit:
integer()
Title:
Limit
Read Only:true
The actual paging size used by the server. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
offset:
integer()
Title:
OffSet
Read Only:true
The offset value used in the current page. -
totalResults:
integer()
Title:
Total Results
Read Only:true
Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Nested Schema : PricingRatePlan
Type:
Show Source
object
-
chargeCount:
integer()
Title:
Associated Charges Count
Read Only:true
The count of charges directly associated with this price model item. -
charges:
Charges
Title:
Charges
Read Only:true
Rate Plan charges -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation Date of the Pricing Rate Plan. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last Modified date of the Pricing Rate Plan. -
description:
string()
Title:
Description
Description of the Pricing Rate Plan. -
endDate:
string()
Title:
End Date
The date after which the Pricing Rate Plan will no longer be applicable. -
integrationId:
string()
Title:
Integration ID
The integration ID of the Pricing rate plan. -
lastModifiedBy:
Last Modified By
Title:
Last Modified By
Read Only:true
The details of the user who modified the record. -
links:
array Links
Title:
Links
Read Only:true
The link relations associated with the resource instance. -
name:
string()
Title:
Name
Name of the Pricing Rate Plan. -
orderNumber:
integer()
Title:
Order Number
The position in a ordered list of Rate Plan. -
priceModelItemId:
integer()
Title:
Price ModelItem Id
Read Only:true
The Price ModelItem Id. -
ratePlanNumber:
string()
Title:
Rate Plan Number
Unique Variable Name of the Pricing Rate Plan. -
startDate:
string()
Title:
Start Date
The date from which the Pricing Rate Plan will be applicable.
Nested Schema : Created By
Title:
Created By
Read Only:
true
The details of the user who created the record.
Match All
Show Source
Nested Schema : Last Modified By
Title:
Last Modified By
Read Only:
true
The details of the user who modified the record.
Match All
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source