Jump to

• Request
• Response
• Examples

Add a Charge Definition

post

/rest/v19/pricingSetup/chargeDefinitions

Use this endpoint to add a pricing charge definition.

Request

Supported Media Types

• application/json

Body ()

Root Schema : PricingChargeDefinition

Type: object

Show Source

• 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.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• 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.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• type: string()
  Title: Type

  Read Only: true

  Indicates whether a Charge Definition is Standard or Custom

{
    "properties":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "code":{
            "type":"string",
            "format":"",
            "description":"Variable Name of the Charge Definition.",
            "title":"Code"
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"Display Name of the Charge Definition.",
            "title":"Name"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Description of the Charge Definition.",
            "title":"Description"
        },
        "integrationId":{
            "type":"string",
            "format":"",
            "description":"Integration ID",
            "title":"Integration ID"
        },
        "chargeType":{
            "type":"string",
            "format":"",
            "description":"Display label of Charge Type",
            "title":"Charge Type",
            "readOnly":true
        },
        "chargeTypeCode":{
            "type":"string",
            "format":"",
            "description":"Charge Type lookup code.",
            "title":"Charge Type Code"
        },
        "priceType":{
            "type":"string",
            "format":"",
            "description":"Display label of Price Type",
            "title":"Price Type",
            "readOnly":true
        },
        "priceTypeCode":{
            "type":"string",
            "format":"",
            "description":"Price Type lookup code.",
            "title":"Price Type Code"
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Charge Definition.",
            "title":"Date Added",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last Modified date of the Charge Definition.",
            "title":"Date Modified",
            "readOnly":true
        },
        "type":{
            "type":"string",
            "format":"",
            "description":"Indicates whether a Charge Definition is Standard or Custom",
            "title":"Type",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "active":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the Charge Definition is active.",
            "title":"Active"
        }
    }
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• 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

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PricingChargeDefinition

Type: object

Show Source

• 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.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• 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.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• type: string()
  Title: Type

  Read Only: true

  Indicates whether a Charge Definition is Standard or Custom

{
    "properties":{
        "segmentLevelAccessType":{
            "type":"string",
            "format":"",
            "description":"Segment-level Access Type",
            "title":"Segment-level Access Type",
            "readOnly":true
        },
        "groupAccessEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the user has access to the groups segment",
            "title":"Group Access Enabled",
            "readOnly":true
        },
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "code":{
            "type":"string",
            "format":"",
            "description":"Variable Name of the Charge Definition.",
            "title":"Code"
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"Display Name of the Charge Definition.",
            "title":"Name"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Description of the Charge Definition.",
            "title":"Description"
        },
        "integrationId":{
            "type":"string",
            "format":"",
            "description":"Integration ID",
            "title":"Integration ID"
        },
        "chargeType":{
            "type":"string",
            "format":"",
            "description":"Display label of Charge Type",
            "title":"Charge Type",
            "readOnly":true
        },
        "chargeTypeCode":{
            "type":"string",
            "format":"",
            "description":"Charge Type lookup code.",
            "title":"Charge Type Code"
        },
        "priceType":{
            "type":"string",
            "format":"",
            "description":"Display label of Price Type",
            "title":"Price Type",
            "readOnly":true
        },
        "priceTypeCode":{
            "type":"string",
            "format":"",
            "description":"Price Type lookup code.",
            "title":"Price Type Code"
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Charge Definition.",
            "title":"Date Added",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last Modified date of the Charge Definition.",
            "title":"Date Modified",
            "readOnly":true
        },
        "type":{
            "type":"string",
            "format":"",
            "description":"Indicates whether a Charge Definition is Standard or Custom",
            "title":"Type",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "active":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the Charge Definition is active.",
            "title":"Active"
        }
    }
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

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

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• 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

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Back to Top

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 -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/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
}

Back to Top