Add Charge Definition
post
/rest/v16/pricingSetup/chargeDefinitions
Use this endpoint to add a pricing charge definition.
Request
Supported Media Types
- application/json
Root Schema : PricingChargeDefinition
Type:
Show Source
object
-
active:
boolean()
Title:
Active
Indicates if the Charge Definition is active. -
chargeType:
string()
Title:
Charge Type
Read Only:true
Display label of Charge Type -
chargeTypeCode:
string()
Title:
Charge Type Code
Charge Type lookup code. -
code:
string()
Title:
Code
Variable Name of the Charge Definition. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation Date of the Charge Definition. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last Modified date of the Charge Definition. -
description:
string()
Title:
Description
Description of the Charge Definition. -
integrationId:
string()
Title:
Integration ID
Integration ID -
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. -
name:
string()
Title:
Name
Display Name of the Charge Definition. -
priceType:
string()
Title:
Price Type
Read Only:true
Display label of Price Type -
priceTypeCode:
string()
Title:
Price Type Code
Price Type lookup code. -
type:
string()
Title:
Type
Read Only:true
Indicates whether a Charge Definition is Standard or Custom
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 : PricingChargeDefinition
Type:
Show Source
object
-
active:
boolean()
Title:
Active
Indicates if the Charge Definition is active. -
chargeType:
string()
Title:
Charge Type
Read Only:true
Display label of Charge Type -
chargeTypeCode:
string()
Title:
Charge Type Code
Charge Type lookup code. -
code:
string()
Title:
Code
Variable Name of the Charge Definition. -
createdBy:
Created By
Title:
Created By
Read Only:true
The details of the user who created the record. -
dateAdded:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Added
Read Only:true
Creation Date of the Charge Definition. -
dateModified:
string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
Title:
Date Modified
Read Only:true
Last Modified date of the Charge Definition. -
description:
string()
Title:
Description
Description of the Charge Definition. -
integrationId:
string()
Title:
Integration ID
Integration ID -
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. -
name:
string()
Title:
Name
Display Name of the Charge Definition. -
priceType:
string()
Title:
Price Type
Read Only:true
Display label of Price Type -
priceTypeCode:
string()
Title:
Price Type Code
Price Type lookup code. -
type:
string()
Title:
Type
Read Only:true
Indicates whether a Charge Definition is Standard or Custom
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 Definition 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/chargeDefinitions
Request Body Sample
{ "code": "newChargeDefinition_c", "name": "New Charge Definition", "integrationId": "QP_NEW_CHARGE_DEFINITION", "chargeTypeCode": "ORA_SALE", "priceTypeCode": "newCharge_c" }
Response Body Sample
{ "code": "newChargeDefinition_c", "name": "New Charge Definition", "integrationId": "QP_NEW_CHARGE_DEFINITION", "chargeType": "Sales Price", "chargeTypeCode": "ORA_SALE", "priceType": "New Charge", "priceTypeCode": "newCharge_c", "dateAdded": "2023-09-21T23:12:23Z", "dateModified": "2023-09-21T23:12:23Z", "type": "Custom Definition", "active": false }