Add Charge Attribute
post
/rest/v16/pricingSetup/chargeAttributes
Use this endpoint to add a pricing charge attribute.
Request
Supported Media Types
- application/json
Root Schema : ChargeAttribute
Type:
Show Source
object
-
active:
boolean()
Title:
Active
Indicates whether Charge Attribute is active. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
dataType:
string()
Title:
Data Type
Allowed Values:[ "Boolean", "Currency", "String", "Decimal", "Date", "Integer", "Text Area" ]
Data Type of the Pricing Charge. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation date of the Pricing Charge. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last modified date of the Pricing Charge. -
defaultValue:
string()
Title:
Default Value
The default value of the Charge Attribute. -
defaultValueLabel:
string()
Title:
Default Value Display Label
Read Only:true
The default value display label of the Charge Attribute. -
description:
string()
Title:
Description
Description of the Pricing Charge. -
key:
boolean()
Title:
Key
Read Only:true
Indicates whether the Charge Attribute is part of the user key. -
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. -
lookupType:
string()
Title:
Lookup Type
The lookup type variable name for the Charge Attribute. -
lookupTypeLabel:
string()
Title:
Lookup Type Display Label
Read Only:true
The lookup type display label for the Charge Attribute. -
name:
string()
Title:
Name
Name of the Pricing Charge. -
negotiable:
boolean()
Title:
Negotiable
Indicates whether the Charge Attribute is editable in runtime. -
orderNumber:
integer()
Title:
Order Number
The order of the Charge Attribute. -
required:
boolean()
Title:
Required
Indicates whether Charge Attribute is required. -
templateVariableKey:
string()
Title:
Template Variable Key
Read Only:true
Allowed Values:[ "Custom", "Quantity", "BomItemVariableName", "ChargeAttribute", "PriceAsOf", "RequestedRatePlanNumber", "ServiceDuration", "ServiceDurationPeriod", "RequestedAgreementNumber", "BuyingAccountID", "Currency Code", "PartNumber", "Customer ID", "Line Price As Of" ]
Pricing Charge template variable key. -
valid:
boolean()
Title:
Valid
Read Only:true
Indicates whether Pricing Charge is valid. -
variableName:
string()
Title:
Variable Name
Variable Name of the Pricing Charge. -
visibility:
string()
Title:
Visibility
Indicates whether the Charge Attribute is visible in Administration or Runtime.
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
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : ChargeAttribute
Type:
Show Source
object
-
active:
boolean()
Title:
Active
Indicates whether Charge Attribute is active. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
dataType:
string()
Title:
Data Type
Allowed Values:[ "Boolean", "Currency", "String", "Decimal", "Date", "Integer", "Text Area" ]
Data Type of the Pricing Charge. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation date of the Pricing Charge. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last modified date of the Pricing Charge. -
defaultValue:
string()
Title:
Default Value
The default value of the Charge Attribute. -
defaultValueLabel:
string()
Title:
Default Value Display Label
Read Only:true
The default value display label of the Charge Attribute. -
description:
string()
Title:
Description
Description of the Pricing Charge. -
key:
boolean()
Title:
Key
Read Only:true
Indicates whether the Charge Attribute is part of the user key. -
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. -
lookupType:
string()
Title:
Lookup Type
The lookup type variable name for the Charge Attribute. -
lookupTypeLabel:
string()
Title:
Lookup Type Display Label
Read Only:true
The lookup type display label for the Charge Attribute. -
name:
string()
Title:
Name
Name of the Pricing Charge. -
negotiable:
boolean()
Title:
Negotiable
Indicates whether the Charge Attribute is editable in runtime. -
orderNumber:
integer()
Title:
Order Number
The order of the Charge Attribute. -
required:
boolean()
Title:
Required
Indicates whether Charge Attribute is required. -
templateVariableKey:
string()
Title:
Template Variable Key
Read Only:true
Allowed Values:[ "Custom", "Quantity", "BomItemVariableName", "ChargeAttribute", "PriceAsOf", "RequestedRatePlanNumber", "ServiceDuration", "ServiceDurationPeriod", "RequestedAgreementNumber", "BuyingAccountID", "Currency Code", "PartNumber", "Customer ID", "Line Price As Of" ]
Pricing Charge template variable key. -
valid:
boolean()
Title:
Valid
Read Only:true
Indicates whether Pricing Charge is valid. -
variableName:
string()
Title:
Variable Name
Variable Name of the Pricing Charge. -
visibility:
string()
Title:
Visibility
Indicates whether the Charge Attribute is visible in Administration or Runtime.
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
Examples
The following example shows how to add a Charge Attribute by submitting a POST request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl - X POST - i - H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" - H "Content-type: application/json" https://sitename.oracle.com/rest/v16/pricingSetup/chargeAttributes
Request Body Sample
{ "name": "New Charge Attribute", "variableName": "newChargeAttribute_c", "dataType": "String", "required": false, "active": true, "visibility": "Runtime", "negotiable": false }
Response Body Sample
{ "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 }