Overview
These endpoints enable administration of Pricing Portal charge definitions using REST API services.
Administration
Add Charge Definition|
Description |
Use this endpoint to add a charge definition. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/chargeDefinitions |
|
|
Endpoint Parameters |
None |
|
|
HTTP Method |
POST |
|
| Request Body Parameters |
active |
Indicates if the charge definition is active. |
|
chargeType |
Display label of Charge Type |
|
|
chargeTypeCode |
Charge Type lookup code. |
|
|
code |
Variable Name of the charge definition. |
|
|
integrationId |
Integration ID |
|
|
name |
Display Name of the charge definition. |
|
|
priceType |
Display label of Price Type |
|
|
priceTypeCode |
Price Type lookup code. |
|
|
type |
Indicates whether a charge definition is Standard or Custom |
|
| Response Body Parameters | JSON data for the newly added charge definition. | |
https://sitename.oracle.com/rest/v17/pricingSetup/chargeDefinitions
{ "code": "newChargeDefinition_c", "name": "New Charge Definition", "integrationId": "QP_NEW_CHARGE_DEFINITION", "chargeTypeCode": "ORA_SALE", "priceTypeCode": "Usage" }
{ "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "code": "newChargeDefinition_c", "name": "New Charge Definition", "integrationId": "QP_NEW_CHARGE_DEFINITION", "chargeType": "Sales Price", "chargeTypeCode": "ORA_SALE", "priceType": "Usage", "priceTypeCode": "Usage", "dateAdded": "2023-09-21T23:12:23Z", "dateModified": "2023-09-21T23:12:23Z", "type": "Custom Definition", "active": false }
|
Description |
Use this endpoint to delete the specified charge definition. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/chargeDefinitions/{code} |
|
|
Endpoint Parameters |
code |
Variable Name of the charge definition. |
|
HTTP Method |
DELETE |
|
|
Request Body Parameters |
None |
|
|
Success Response |
204 |
|
|
Description |
Use this endpoint to retrieve the specified charge definition. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/chargeDefinitions/{code} |
|
|
Endpoint Parameters |
code |
Variable Name of the charge definition. |
|
(Optional) This endpoint supports the |
||
|
HTTP Method |
GET |
|
| Request Body Parameters | None | |
| Response Body Parameters |
active |
Indicates if the charge definition is active. |
|
chargeType |
Display label of Charge Type |
|
|
chargeTypeCode |
Charge Type lookup code. |
|
|
code |
Variable Name of the charge definition. |
|
|
createdBy |
The details of the user who created the record. | |
|
dateAdded |
Creation Date of the charge definition. |
|
|
dateModified |
Last Modified date of the charge definition. |
|
|
description |
Description of the charge definition. |
|
|
integrationId |
Integration ID |
|
|
lastModifiedBy |
The details of the user who modified the record. | |
|
name |
Display Name of the charge definition. |
|
|
priceType |
Display label of Price Type |
|
|
priceTypeCode |
Price Type lookup code. |
|
|
type |
Indicates whether a charge definition is Standard or Custom |
|
https://sitename.oracle.com/rest/v17/pricingSetup/chargeDefinitions/usage_callCharge_c
{ "code": "usage_callCharge_c", "name": "Usage Call Charge", "description": "Generated Charge Definition", "chargeType": "Call Charge", "chargeTypeCode": "callCharge_c", "priceType": "Usage", "priceTypeCode": "Usage", "dateAdded": "2023-08-29T19:35:18Z", "dateModified": "2023-08-29T19:35:18Z", "type": "Custom Definition", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeDefinitions/usage_callCharge_c" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeDefinitions" } ], "active": true }
|
Description |
Use this endpoint to retrieve all charge definitions. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17pricingSetup/chargeDefinitions |
|
|
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 definitions. |
|
|
active |
Indicates if the charge definition is active. |
|
|
chargeType |
Display label of Charge Type |
|
|
chargeTypeCode |
Charge Type lookup code. |
|
|
code |
Variable Name of the charge definition. |
|
|
createdBy |
The details of the user who created the record. | |
|
dateAdded |
Creation Date of the charge definition. |
|
|
dateModified |
Last Modified date of the charge definition. |
|
|
description |
Description of the charge definition. |
|
|
integrationId |
Integration ID |
|
|
lastModifiedBy |
The details of the user who modified the record. | |
|
name |
Display Name of the charge definition. |
|
|
priceType |
Display label of Price Type |
|
|
priceTypeCode |
Price Type lookup code. |
|
|
type |
Indicates whether a charge definition is Standard or Custom |
|
https://sitename.oracle.com/rest/v17/pricingSetup/chargeDefinitions?limit=3
{ "items": [{ "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "code": "usage_callCharge_c", "name": "Usage Call Charge", "description": "Generated Charge Definition", "chargeType": "Call Charge", "chargeTypeCode": "callCharge_c", "priceType": "Usage", "priceTypeCode": "Usage", "dateAdded": "2023-08-29T19:35:18Z", "dateModified": "2023-08-29T19:35:18Z", "type": "Custom Definition", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeDefinitions/usage_callCharge_c" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeDefinitions" } ], "active": true }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "code": "recurring_oRASALE_c", "name": "Recurring Sales Price", "description": "Generated Charge Definition", "chargeType": "Sales Price", "chargeTypeCode": "ORA_SALE", "priceType": "Recurring", "priceTypeCode": "Recurring", "dateAdded": "2023-08-29T19:35:18Z", "dateModified": "2023-08-29T19:35:18Z", "type": "Custom Definition", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeDefinitions/recurring_oRASALE_c" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeDefinitions" } ], "active": true }, { "createdBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "lastModifiedBy": { "firstName": "John", "lastName": "Smith", emailId": "john.smith@companyname.com" }, "code": "usage_dataCharge_c", "name": "Usage Data Charge", "description": "Generated Charge Definition", "chargeType": "Data Charge", "chargeTypeCode": "dataCharge_c", "priceType": "Usage", "priceTypeCode": "Usage", "dateAdded": "2023-08-29T19:35:18Z", "dateModified": "2023-08-29T19:35:18Z", "type": "Custom Definition", "links": [{ "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeDefinitions/usage_dataCharge_c" }, { "rel": "parent", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeDefinitions" } ], "active": true } ], "offset": 0, "limit": 3, "count": 3, "hasMore": true, "links": [{ "rel": "canonical", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeDefinitions" }, { "rel": "self", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeDefinitions?offset=0&limit=3" }, { "rel": "next", "href": "https://sitename.oracle.com/rest/v17/pricingSetup/chargeDefinitions?offset=3&limit=3" } ] }
|
Description |
Use this endpoint to update the specified charge definition. |
|
|---|---|---|
|
URI Endpoint |
/rest/v17/pricingSetup/chargeDefinitions/{code} |
|
|
Endpoint Parameters |
code |
Variable Name of the charge definition. |
|
HTTP Method |
PATCH |
|
| Request Body Parameters |
active |
Indicates if the charge definition is active. |
|
code |
Variable Name of the charge definition. |
|
|
integrationId |
Integration ID |
|
|
name |
Display Name of the charge definition. |
|
|
Success Response |
204 |
|
https://sitename.oracle.com/rest/v17/pricingSetup/chargeDefinitions/newChargeDefinition_c
{ "name": "New Charge Definition", "description": "Charge Definition for New Charge", "active": false, "integrationId": "QP_NEW_CHARGE_DEFINITION" }
