Get All Charge Attributes
get
/rest/v19/pricingSetup/chargeAttributes
Use this endpoint to retrieve all pricing charge attributes.
Request
Query Parameters
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.
-
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>
The following are the available finder names and corresponding finder variables:
- findByKeyword: Find charge attributes using name and variableName.
Finder Variable:- keyword;string: The search text. The character '%' if present will be treated as a wild card otherwise, the default is 'contains' search
- findByKeyword: Find charge attributes using name and variableName.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderby: string
This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "ASC" or "DESC". Specify "ASC" for ascending and "DESC" for descending. The default value is "ASC". For example, ?orderby=field1:ASC,field2:DESC.
-
q: string
Filter (a 'where' clause) to restrict the items returned in the collection. By default, no filtering is applied.
-
totalResults: boolean
The resource collection representation will include the total row count when "?totalResults=true", otherwise the count is not included. The default value is "false".
Response
Supported Media Types
- application/json
200 Response
Success
Root Schema : PricingResourceCollection_ChargeAttribute
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
The details of the user who created the record.
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
The details of the user who modified the record.
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 : 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. -
ioType:
string()
Title:
IO Type
Allowed Values:[ "Input", "Output", "Internal", "External" ]
Pricing Attribute IO Type. -
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. -
productPriceEnabled:
boolean()
Title:
Product Price Enabled
Read Only:true
Indicates whether the Charge Attribute is product price enabled. -
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
The details of the user who created the record.
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
The details of the user who modified the record.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
Read Only:
true
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to retrieve all pricing Charge Attributes by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.
curl -X GET -H "Authorization: Bearer <token>" -H "Accept: application/json" https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes
Endpoint Sample to retrieve only active Charge Attributes
https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes?q={active:true}
Response Body Sample
{ "items": [{ "name": "Charge Definition", "variableName": "chargeDefinition", "description": "The display label of the charge definition.", "dateModified": "2023-08-08T19:24:59Z", "dateAdded": "2023-08-08T19:24:59Z", "dataType": "String", "templateVariableKey": "ChargeAttribute", "orderNumber": 4, "key": false, "required": false, "active": true, "visibility": "Administration,Runtime", "negotiable": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes/chargeDefinition" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" } ] }, { "name": "Charge Definition Code", "variableName": "chargeDefinitionCode", "description": "The code of the charge definition.", "dateModified": "2023-08-08T19:24:59Z", "dateAdded": "2023-08-08T19:24:59Z", "dataType": "String", "templateVariableKey": "ChargeAttribute", "orderNumber": 5, "key": false, "required": false, "active": true, "visibility": "Runtime", "negotiable": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes/chargeDefinitionCode" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" } ] }, { "name": "Charge Definition Integration ID", "variableName": "chargeDefIntegrationId", "description": "The charge definition code in the integrated order management system.", "dateModified": "2023-08-08T19:24:59Z", "dateAdded": "2023-08-08T19:24:59Z", "dataType": "String", "templateVariableKey": "ChargeAttribute", "orderNumber": 6, "key": false, "required": false, "active": true, "visibility": "Runtime", "negotiable": false, "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes/chargeDefIntegrationId" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" } ] }, { "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-08-08T18:35:28Z", "dateAdded": "2023-08-08T18:35:28Z", "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/v19/pricingSetup/chargeAttributes/priceType" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" } ] }, { "name": "Charge Type", "variableName": "chargeType", "description": "The element of the product or service which carries a price for the customer.", "dateModified": "2023-08-08T18:35:29Z", "dateAdded": "2023-08-08T18:35:29Z", "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/v19/pricingSetup/chargeAttributes/chargeType" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" } ] }, { "name": "Price Period", "variableName": "pricePeriod", "description": "The time period, frequency or recurrence with which the price or charge is levied.", "dateModified": "2023-08-08T18:35:29Z", "dateAdded": "2023-08-08T18:35:29Z", "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/v19/pricingSetup/chargeAttributes/pricePeriod" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" } ] }, { "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-08-08T18:35:29Z", "dateAdded": "2023-08-08T18:35:29Z", "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/v19/pricingSetup/chargeAttributes/usageUOM" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" } ] }, { "name": "Dynamic Pricing Type", "variableName": "dynamicPricingType", "description": "The type of dynamic pricing used to define this charge: static, tiered, volume, rateCard, advanced.", "dateModified": "2023-08-08T19:24:59Z", "dateAdded": "2023-08-08T19:24:59Z", "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/v19/pricingSetup/chargeAttributes/dynamicPricingType" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" } ] }, { "name": "Rate Card", "variableName": "rateCardName", "description": "Display label for the Rate Card applied in calculating this charge's price.", "dateModified": "2023-08-08T18:35:29Z", "dateAdded": "2023-08-08T18:35:29Z", "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/v19/pricingSetup/chargeAttributes/rateCardName" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" } ] }, { "name": "Rate Card Variable Name", "variableName": "rateCardVariableName", "description": "Variable Name for the Rate Card applied in calculating this charge's price.", "dateModified": "2023-08-08T18:35:30Z", "dateAdded": "2023-08-08T18:35:30Z", "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/v19/pricingSetup/chargeAttributes/rateCardVariableName" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" } ] }, { "name": "Rate Card Structure", "variableName": "rateCardStructure", "description": "The rate card used to calculate this charge's price.", "dateModified": "2023-08-08T18:35:30Z", "dateAdded": "2023-08-08T18:35:30Z", "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/v19/pricingSetup/chargeAttributes/rateCardStructure" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" } ] }, { "name": "Rate Card In HTML", "variableName": "rateCardInHTML", "description": "The HTML-formatted rate card data", "dateModified": "2023-08-08T19:24:59Z", "dateAdded": "2023-08-08T19:24:59Z", "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/v19/pricingSetup/chargeAttributes/rateCardInHTML" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" } ] }, { "name": "Unit Price", "variableName": "unitPrice", "description": "The unit price to be paid by the customer for this charge.", "dateModified": "2023-08-08T18:35:30Z", "dateAdded": "2023-08-08T18:35:30Z", "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/v19/pricingSetup/chargeAttributes/unitPrice" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" } ] }, { "name": "Calculation Information", "variableName": "calculationInfo", "description": "A JSON array of the Price Models used in calculating this charge's price.", "dateModified": "2023-08-08T18:35:30Z", "dateAdded": "2023-08-08T18:35:30Z", "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/v19/pricingSetup/chargeAttributes/calculationInfo" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" } ] }, { "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-08-08T18:35:30Z", "dateAdded": "2023-08-08T18:35:30Z", "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/v19/pricingSetup/chargeAttributes/discountValue" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" } ] }, { "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-08-08T18:35:30Z", "dateAdded": "2023-08-08T18:35:30Z", "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/v19/pricingSetup/chargeAttributes/discountType" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" } ] }, { "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-08-08T18:35:30Z", "dateAdded": "2023-08-08T18:35:30Z", "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/v19/pricingSetup/chargeAttributes/discountAmount" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" } ] }, { "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-08-08T18:35:30Z", "dateAdded": "2023-08-08T18:35:30Z", "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/v19/pricingSetup/chargeAttributes/netPrice" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" } ] }, { "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-08-08T18:35:30Z", "dateAdded": "2023-08-08T18:35:30Z", "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/v19/pricingSetup/chargeAttributes/netAmount" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" } ] } ], "offset": 0, "limit": 1000, "count": 19, "hasMore": false, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes?offset=0&limit=1000" } ] }