Get Charge Attributes

get

/rest/v16/pricingSetup/chargeAttributes

Use this endpoint to retrieve all pricing charge attributes.

Request

Query Parameters
  • This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.
  • Used as a predefined finder to search the collection.
    Format: ?finder=<finderName>;<VarName>=<variableValue>
    The following are the available finder names and corresponding finder variables:
    • findByKeyword: Find charge attributes using name and VarName.
      Finder Variable:
      • keyword;string: The search text. The character '%' if present will be treated as a wild card otherwise, the default is 'contains' search
  • 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.
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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.
  • Filter (a 'where' clause) to restrict the items returned in the collection. By default, no filtering is applied.
  • The resource collection representation will include the total row count when "?totalResults=true", otherwise the count is not included. The default value is "false".
Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : PricingResourceCollection_ChargeAttribute
Type: object
Show Source
  • Title: Count
    Read Only: true
    The number of resource instances returned in the current range.
  • Created By
    Title: Created By
    Read Only: true
    The details of the user who created the record.
  • 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
  • Last Modified By
    Title: Last Modified By
    Read Only: true
    The details of the user who modified the record.
  • Title: Limit
    Read Only: true
    The actual paging size used by the server.
  • Links
  • Title: OffSet
    Read Only: true
    The offset value used in the current page.
  • 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 : items
Type: array
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 : UserDetails
Type: object
Show Source
Nested Schema : ChargeAttribute
Type: object
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
Back to Top

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 -i -H "Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQg" -H "Accept: application/json"
https://sitename.oracle.com/rest/v16/pricingSetup/chargeAttributes

Endpoint Sample to retrieve only active Charge Attributes

https://sitename.oracle.com/rest/v16/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/v16/pricingSetup/chargeAttributes/chargeDefinition"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/pricingSetup/chargeAttributes/chargeDefinitionCode"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/pricingSetup/chargeAttributes/chargeDefIntegrationId"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/pricingSetup/chargeAttributes/priceType"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/pricingSetup/chargeAttributes/chargeType"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/pricingSetup/chargeAttributes/pricePeriod"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/pricingSetup/chargeAttributes/usageUOM"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/pricingSetup/chargeAttributes/dynamicPricingType"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/pricingSetup/chargeAttributes/rateCardName"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/pricingSetup/chargeAttributes/rateCardVariableName"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/pricingSetup/chargeAttributes/rateCardStructure"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/pricingSetup/chargeAttributes/rateCardInHTML"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/pricingSetup/chargeAttributes/unitPrice"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/pricingSetup/chargeAttributes/calculationInfo"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/pricingSetup/chargeAttributes/discountValue"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/pricingSetup/chargeAttributes/discountType"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/pricingSetup/chargeAttributes/discountAmount"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/pricingSetup/chargeAttributes/netPrice"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/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/v16/pricingSetup/chargeAttributes/netAmount"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v16/pricingSetup/chargeAttributes"
        }
      ]
    }
  ],
  "offset": 0,
  "limit": 1000,
  "count": 19,
  "hasMore": false,
  "links": [{
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v16/pricingSetup/chargeAttributes"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v16/pricingSetup/chargeAttributes?offset=0&limit=1000"
    }
  ]
}
Back to Top