Overview
These endpoints enable administration of CPQ Pricing Portal charge attributes using REST API services.
Administration
Add Charge Attribute|
Description |
Use this endpoint to add a Charge Attribute |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/chargeAttributes |
|
|
Endpoint Parameters |
None |
|
|
HTTP Method |
POST |
|
| Request Body Parameters |
active |
Indicates whether charge attribute is active. |
|
dataType |
Data Type of the charge attribute. |
|
|
dateAdded |
The date the charge attribute was created. | |
|
defaultValueLabel |
The default value display label of the charge attribute. | |
|
description |
Description of the charge attribute. | |
|
ioType |
The charge attribute IO type. Allowed values: "Input", "Output", "Internal", "External" |
|
|
key |
Indicates whether the charge attribute is part of the user key. | |
|
lookupType |
The lookup type variable name for the charge attribute. | |
|
lookupTypeLabel |
The lookup type display label for the charge attribute. | |
|
name |
Name of the charge attribute. | |
|
negotiable |
Indicates whether the charge attribute is editable in runtime. | |
|
orderNumber |
The order of the charge attribute. |
|
|
required |
Indicates whether charge attribute is required. |
|
|
templateVariableKey |
Pricing Charge template variable key. Allowed values:"Custom", "Quantity", "BomItemVariableName", "ChargeAttribute", "PriceAsOf", "RequestedRatePlanNumber", "ServiceDuration", "ServiceDurationPeriod", "RequestedAgreementNumber", "BuyingAccountID", "Currency Code", "PartNumber", "Customer ID", "Line Price As Of" |
|
|
valid |
Indicates whether the pricing charge is valid. | |
|
variableName |
Variable Name of the charge attribute. |
|
|
visibility |
Indicates whether the charge attribute is visible in Administration or Runtime. | |
| Response Body Parameters | JSON data for the newly added charge attribute. | |
https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes
{ "name": "New Charge Attribute", "variableName": "newChargeAttribute_c", "dataType": "String", "required": false, "active": true, "visibility": "Runtime", "negotiable": false }
{ "name": "New Charge Attribute", "variableName": "newChargeAttribute_c", "dateModified": "2023-09-21T19:45:22Z", "dateAdded": "2023-09-21T19:45:22Z", "dataType": "String", "templateVariableKey": "Custom", "orderNumber": 261, "key": false, "required": false, "active": true, "visibility": "Runtime", "negotiable": false }
|
Description |
Use this endpoint to delete the specified charge attribute. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/chargeAttributes/{attributeVariableName} |
|
|
Endpoint Parameters |
attributeVariableName |
The variable name of the charge attribute. |
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint to retrieve the specified charge attribute. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/chargeAttributes/{attributeVariableName} |
|
|
Endpoint Parameters |
attributeVariableName |
The variable name of the charge attribute. |
|
(Optional) This endpoint supports the |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
active |
Indicates whether charge attribute is active. |
|
createdBy |
The details of the user who created the record. | |
|
dataType |
Data Type of the charge attribute. |
|
|
dateAdded |
The date the charge attribute was created. | |
|
dateModified |
The date the charge attribute was last modified. | |
|
defaultValue |
The default value of the charge attribute. | |
|
defaultValueLabel |
The default value display label of the charge attribute. | |
|
description |
Description of the charge attribute. | |
|
ioType |
The charge attribute IO type. Allowed values: "Input", "Output", "Internal", "External" |
|
|
key |
Indicates whether the charge attribute is part of the user key. | |
|
lastModifiedBy |
The details of the user who modified the record. | |
|
lookupType |
The lookup type variable name for the charge attribute. | |
|
lookupTypeLabel |
The lookup type display label for the charge attribute. | |
|
name |
Name of the charge attribute. | |
|
negotiable |
Indicates whether the charge attribute is editable in runtime. | |
|
orderNumber |
The order of the charge attribute. |
|
|
required |
Indicates whether charge attribute is required. |
|
|
templateVariableKey |
Pricing Charge template variable key. Allowed values:"Custom", "Quantity", "BomItemVariableName", "ChargeAttribute", "PriceAsOf", "RequestedRatePlanNumber", "ServiceDuration", "ServiceDurationPeriod", "RequestedAgreementNumber", "BuyingAccountID", "Currency Code", "PartNumber", "Customer ID", "Line Price As Of" |
|
|
valid |
Indicates whether the pricing charge is valid. | |
|
variableName |
Variable Name of the charge attribute. |
|
|
visibility |
Indicates whether the charge attribute is visible in Administration or Runtime. | |
https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes/newChargeAttribute_c
{ "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "New Charge Attribute", "variableName": "newChargeAttribute_c", "description": "", "dateModified": "2024-04-29T17:59:51Z", "dateAdded": "2024-04-29T17:59:51Z", "dataType": "String", "templateVariableKey": "Custom", "orderNumber": 261, "key": false, "required": false, "active": true, "visibility": "Runtime", "negotiable": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes/newChargeAttribute_c" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes" } ] }
|
Description |
Use this endpoint to retrieve all pricing Charge Attributes. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/chargeAttributes |
|
|
Endpoint Parameters |
None |
|
|
(Optional) This endpoint supports the following query specifications: For more information, see Manage Collections. |
||
|
HTTP Method |
GET |
|
|
Request Body Parameters |
None |
|
|
Response Body Parameters |
A collection of Charge Attributes. |
|
|
active |
Indicates whether charge attribute is active. | |
|
createdBy |
The details of the user who created the record. | |
|
dataType |
Data Type of the charge attribute. |
|
|
dateAdded |
The date the charge attribute was created. | |
|
dateModified |
The date the charge attribute was last modified. | |
|
defaultValue |
The default value of the charge attribute. | |
|
defaultValueLabel |
The default value display label of the charge attribute. | |
|
description |
Description of the charge attribute. | |
|
ioType |
The charge attribute IO type. Allowed values: "Input", "Output", "Internal", "External" |
|
|
key |
Indicates whether the charge attribute is part of the user key. | |
|
lastModifiedBy |
The details of the user who modified the record. | |
|
lookupType |
The lookup type variable name for the charge attribute. | |
|
lookupTypeLabel |
The lookup type display label for the charge attribute. | |
|
name |
Name of the charge attribute. | |
|
negotiable |
Indicates whether the charge attribute is editable in runtime. | |
|
orderNumber |
The order of the charge attribute. |
|
|
required |
Indicates whether charge attribute is required. |
|
|
templateVariableKey |
Pricing Charge template variable key. Allowed values:"Custom", "Quantity", "BomItemVariableName", "ChargeAttribute", "PriceAsOf", "RequestedRatePlanNumber", "ServiceDuration", "ServiceDurationPeriod", "RequestedAgreementNumber", "BuyingAccountID", "Currency Code", "PartNumber", "Customer ID", "Line Price As Of" |
|
|
valid |
Indicates whether the pricing charge is valid. | |
|
variableName |
Variable Name of the charge attribute. |
|
|
visibility |
Indicates whether the charge attribute is visible in Administration or Runtime. | |
https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes
URI Endpoint Sample to retrieve only active Charge Attributes
https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes?q={active:true}
{ "items": [{ "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "Price Type", "variableName": "priceType", "description": "The basis on which a price or charge is levied, whether one time, on a periodic basis or based on usage.", "dateModified": "2023-07-21T20:19:15Z", "dateAdded": "2023-07-21T20:19:15Z", "dataType": "String", "templateVariableKey": "ChargeAttribute", "orderNumber": 10, "key": true, "lookupType": "priceTypes", "lookupTypeLabel": "Price Types", "defaultValue": "One Time", "defaultValueLabel": "One Time", "required": false, "active": true, "visibility": "Administration,Runtime", "negotiable": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes/priceType" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "Charge Type", "variableName": "chargeType", "description": "The element of the product or service which carries a price for the customer.", "dateModified": "2023-07-21T20:19:16Z", "dateAdded": "2023-07-21T20:19:16Z", "dataType": "String", "templateVariableKey": "ChargeAttribute", "orderNumber": 20, "key": true, "lookupType": "chargeTypes", "lookupTypeLabel": "Charge Types", "defaultValue": "ORA_SALE", "defaultValueLabel": "Sales Price", "required": false, "active": true, "visibility": "Administration,Runtime", "negotiable": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes/chargeType" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "Price Period", "variableName": "pricePeriod", "description": "The time period, frequency or recurrence with which the price or charge is levied.", "dateModified": "2023-07-21T20:19:16Z", "dateAdded": "2023-07-21T20:19:16Z", "dataType": "String", "templateVariableKey": "ChargeAttribute", "orderNumber": 30, "key": true, "lookupType": "pricePeriods", "lookupTypeLabel": "Price Periods", "defaultValue": "Per Month", "defaultValueLabel": "Per Month", "required": false, "active": true, "visibility": "Administration,Runtime", "negotiable": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes/pricePeriod" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "Usage UOM", "variableName": "usageUOM", "description": "The unit of measure of usage for usage charges, which generally differs from the unit of measure used for the parent product.", "dateModified": "2023-07-21T20:19:16Z", "dateAdded": "2023-07-21T20:19:16Z", "dataType": "String", "templateVariableKey": "ChargeAttribute", "orderNumber": 50, "key": false, "lookupType": "usageUOMs", "lookupTypeLabel": "Usage Units of Measure", "required": false, "active": true, "visibility": "Administration,Runtime", "negotiable": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes/usageUOM" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "Dynamic Pricing Type", "variableName": "dynamicPricingType", "description": "The type of dynamic pricing used to define this charge: static, tiered, volume, rateCard, advanced.", "dateModified": "2023-10-06T21:22:46Z", "dateAdded": "2023-10-06T21:22:46Z", "dataType": "String", "templateVariableKey": "ChargeAttribute", "orderNumber": 120, "key": false, "required": false, "active": true, "visibility": "Runtime", "negotiable": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes/dynamicPricingType" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "Rate Card", "variableName": "rateCardName", "description": "Display label for the Rate Card applied in calculating this charge's price.", "dateModified": "2023-07-21T20:19:16Z", "dateAdded": "2023-07-21T20:19:16Z", "dataType": "String", "templateVariableKey": "ChargeAttribute", "orderNumber": 150, "key": false, "required": false, "active": true, "visibility": "Runtime", "negotiable": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes/rateCardName" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "Rate Card Variable Name", "variableName": "rateCardVariableName", "description": "Variable Name for the Rate Card applied in calculating this charge's price.", "dateModified": "2023-07-21T20:19:17Z", "dateAdded": "2023-07-21T20:19:17Z", "dataType": "String", "templateVariableKey": "ChargeAttribute", "orderNumber": 160, "key": false, "required": false, "active": true, "visibility": "Runtime", "negotiable": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes/rateCardVariableName" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "Rate Card Structure", "variableName": "rateCardStructure", "description": "The rate card used to calculate this charge's price.", "dateModified": "2023-07-21T20:19:17Z", "dateAdded": "2023-07-21T20:19:17Z", "dataType": "Text Area", "templateVariableKey": "ChargeAttribute", "orderNumber": 170, "key": false, "required": false, "active": true, "visibility": "Runtime", "negotiable": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes/rateCardStructure" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "Rate Card In HTML", "variableName": "rateCardInHTML", "description": "The HTML-formatted rate card data", "dateModified": "2023-10-06T21:22:46Z", "dateAdded": "2023-10-06T21:22:46Z", "dataType": "Text Area", "templateVariableKey": "ChargeAttribute", "orderNumber": 175, "key": false, "required": false, "active": true, "visibility": "Runtime", "negotiable": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes/rateCardInHTML" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "Unit Price", "variableName": "unitPrice", "description": "The unit price to be paid by the customer for this charge.", "dateModified": "2023-07-21T20:19:17Z", "dateAdded": "2023-07-21T20:19:17Z", "dataType": "Currency", "templateVariableKey": "ChargeAttribute", "orderNumber": 200, "key": false, "required": false, "active": true, "visibility": "Runtime", "negotiable": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes/unitPrice" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "Calculation Information", "variableName": "calculationInfo", "description": "A JSON array of the Price Models used in calculating this charge's price.", "dateModified": "2023-07-21T20:19:17Z", "dateAdded": "2023-07-21T20:19:17Z", "dataType": "Text Area", "templateVariableKey": "ChargeAttribute", "orderNumber": 210, "key": false, "required": false, "active": true, "visibility": "Runtime", "negotiable": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes/calculationInfo" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "Discount Value", "variableName": "discountValue", "description": "The numeric value for a custom discount associated with the discount type for this charge. For example, if the Discount Type is Override, this value with be the override unit price for this charge.", "dateModified": "2023-07-21T20:19:17Z", "dateAdded": "2023-07-21T20:19:17Z", "dataType": "Decimal", "templateVariableKey": "ChargeAttribute", "orderNumber": 220, "key": false, "required": false, "active": true, "visibility": "Runtime", "negotiable": true, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes/discountValue" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "Discount Type", "variableName": "discountType", "description": "The type of custom discount applied to this charge. Typically this may be an override price, a discount value or a discount percentage.", "dateModified": "2023-07-21T20:19:17Z", "dateAdded": "2023-07-21T20:19:17Z", "dataType": "String", "templateVariableKey": "ChargeAttribute", "orderNumber": 230, "key": false, "lookupType": "discountTypes", "lookupTypeLabel": "Discount Types", "required": false, "active": true, "visibility": "Runtime", "negotiable": true, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes/discountType" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "Discount Amount", "variableName": "discountAmount", "description": "The extended custom discount amount per period for this charge. Typically this represents the unit discount x quantity.", "dateModified": "2023-07-21T20:19:17Z", "dateAdded": "2023-07-21T20:19:17Z", "dataType": "Currency", "templateVariableKey": "ChargeAttribute", "orderNumber": 240, "key": false, "required": false, "active": true, "visibility": "Runtime", "negotiable": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes/discountAmount" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "Net Price", "variableName": "netPrice", "description": "The unit price net of all discounts for this charge. The Net Price is the unit price that the customer will be invoiced.", "dateModified": "2023-07-21T20:19:17Z", "dateAdded": "2023-07-21T20:19:17Z", "dataType": "Currency", "templateVariableKey": "ChargeAttribute", "orderNumber": 250, "key": false, "required": false, "active": true, "visibility": "Runtime", "negotiable": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes/netPrice" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes" } ] }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "name": "Net Amount", "variableName": "netAmount", "description": "The extended net price or amount per period that will be paid for this charge. Typically this represents the unit price x quantity.", "dateModified": "2023-07-21T20:19:17Z", "dateAdded": "2023-07-21T20:19:17Z", "dataType": "Currency", "templateVariableKey": "ChargeAttribute", "orderNumber": 260, "key": false, "required": false, "active": true, "visibility": "Runtime", "negotiable": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes/netAmount" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes" } ] } ], "offset": 0, "limit": 1000, "count": 16, "hasMore": false, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes?offset=0&limit=1000" } ] }
|
Description |
Use this endpoint to update the specified charge attribute. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/chargeAttributes/{attributeVariableName} |
|
|
Endpoint Parameters |
attributeVariableName |
The variable name of the charge attribute. |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
active |
Indicates whether charge attribute is active. |
|
defaultValue |
The default value of the charge attribute. | |
|
description |
Description of the charge attribute. | |
|
name |
Name of the charge attribute. | |
|
orderNumber |
The order of the charge attribute. |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes/globalMarkets_c
{ "name": "Global Markets", "description": "Charge Attribute for Global Markets", "defaultValue": "northAmerica_c", "defaultValueLabel": "North America" }
|
Description |
Use this endpoint to create, delete, and update Charge Attributes. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/chargeAttributes |
|
|
Endpoint Parameters |
None |
|
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
The array of pricing patch operations. |
|
|
op |
The operation to be performed. Allowed values: "add", "remove", "replace". You can only delete inactive Charge Attributes. |
|
|
path |
The JSON pointer string for "path" property. | |
|
value |
The target value.
|
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/chargeAttributes
[ { "op": "add", "path": "/", "value": { "name": "New Boolean Charge", "variableName": "newBooleanCharge_c", "dataType": "Boolean", "key": true, "defaultValue": "true", "required": true, "active": true, "visibility": "Runtime", "negotiable": true } }, { "op": "remove", "path": "/newChargeAttribute2_c" }, { "op": "replace", "path": "/newChargeAttribute_c", "value": { "description": "Updated New Charge Attribute Description" } } ]
