Jump to

• Request
• Response
• Examples

Get All Charge Definitions

get

/rest/v19/pricingSetup/chargeDefinitions

Use this endpoint to retrieve all pricing charge definitions.

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 definitions using name and code.
    Finder Variable:
    • keyword;string:The search text. The character '%' if present will be treated as a wild card otherwise, the default is 'contains' search
• 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".

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PricingResourceCollection_PricingChargeDefinition

Type: object

Show Source

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

  Read Only: true

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

  Read Only: true

  Segment-level Access Type
• 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.

{
    "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"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/PricingChargeDefinition"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"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.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"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.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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 : items

Type: array

Show Source

• Array of: object PricingChargeDefinition

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/PricingChargeDefinition"
    }
}

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 : 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 : 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 retrieve all pricing Charge Definitions 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/chargeDefinitions?limit=3

Response Body Sample

{
  "items": [{
      "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/v19/pricingSetup/chargeDefinitions/usage_callCharge_c"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeDefinitions"
        }
      ],
      "active": true
    }, {
      "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/v19/pricingSetup/chargeDefinitions/recurring_oRASALE_c"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeDefinitions"
        }
      ],
      "active": true
    }, {
      "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/v19/pricingSetup/chargeDefinitions/usage_dataCharge_c"
        }, {
          "rel": "parent",
          "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeDefinitions"
        }
      ],
      "active": true
    }
  ],
  "offset": 0,
  "limit": 3,
  "count": 3,
  "hasMore": true,
  "links": [{
      "rel": "canonical",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeDefinitions"
    }, {
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeDefinitions?offset=0&limit=3"
    }, {
      "rel": "next",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/chargeDefinitions?offset=3&limit=3"
    }
  ]
}

Back to Top