Jump to

• Request
• Response
• Examples

Update a Charge Attribute

patch

/rest/v19/pricingSetup/chargeAttributes/{attributeVariableName}

Use this endpoint to update the specified charge attribute.

Request

Supported Media Types

• application/json

Path Parameters

• attributeVariableName(required): string

Body ()

Root Schema : ChargeAttribute

Type: object

Show Source

• active: boolean()
  Title: Active

  Indicates whether Charge Attribute is active.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dataType: string()
  Title: Data Type

  Allowed Values: [ "Boolean", "Currency", "String", "Decimal", "Date", "Integer", "Text Area" ]

  Data Type of the Pricing Charge.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

  Creation date of the Pricing Charge.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last modified date of the Pricing Charge.
• defaultValue: string()
  Title: Default Value

  The default value of the Charge Attribute.
• defaultValueLabel: string()
  Title: Default Value Display Label

  Read Only: true

  The default value display label of the Charge Attribute.
• description: string()
  Title: Description

  Description of the Pricing Charge.
• ioType: string()
  Title: IO Type

  Allowed Values: [ "Input", "Output", "Internal", "External" ]

  Pricing Attribute IO Type.
• key: boolean()
  Title: Key

  Read Only: true

  Indicates whether the Charge Attribute is part of the user key.
• 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.
• lookupType: string()
  Title: Lookup Type

  The lookup type variable name for the Charge Attribute.
• lookupTypeLabel: string()
  Title: Lookup Type Display Label

  Read Only: true

  The lookup type display label for the Charge Attribute.
• name: string()
  Title: Name

  Name of the Pricing Charge.
• negotiable: boolean()
  Title: Negotiable

  Indicates whether the Charge Attribute is editable in runtime.
• orderNumber: integer()
  Title: Order Number

  The order of the Charge Attribute.
• productPriceEnabled: boolean()
  Title: Product Price Enabled

  Read Only: true

  Indicates whether the Charge Attribute is product price enabled.
• required: boolean()
  Title: Required

  Indicates whether Charge Attribute is required.
• templateVariableKey: string()
  Title: Template Variable Key

  Read Only: true

  Allowed Values: [ "Custom", "Quantity", "BomItemVariableName", "ChargeAttribute", "PriceAsOf", "RequestedRatePlanNumber", "ServiceDuration", "ServiceDurationPeriod", "RequestedAgreementNumber", "BuyingAccountID", "Currency Code", "PartNumber", "Customer ID", "Line Price As Of" ]

  Pricing Charge template variable key.
• valid: boolean()
  Title: Valid

  Read Only: true

  Indicates whether Pricing Charge is valid.
• variableName: string()
  Title: Variable Name

  Variable Name of the Pricing Charge.
• visibility: string()
  Title: Visibility

  Indicates whether the Charge Attribute is visible in Administration or Runtime.

{
    "properties":{
        "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"
                }
            ]
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"Name of the Pricing Charge.",
            "title":"Name"
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"Variable Name of the Pricing Charge.",
            "title":"Variable Name"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Description of the Pricing Charge.",
            "title":"Description"
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date of the Pricing Charge.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date of the Pricing Charge.",
            "title":"Date Added",
            "readOnly":true
        },
        "dataType":{
            "type":"string",
            "format":"",
            "description":"Data Type of the Pricing Charge.",
            "title":"Data Type",
            "enum":[
                "Boolean",
                "Currency",
                "String",
                "Decimal",
                "Date",
                "Integer",
                "Text Area"
            ]
        },
        "templateVariableKey":{
            "type":"string",
            "format":"",
            "description":"Pricing Charge template variable key.",
            "title":"Template Variable Key",
            "readOnly":true,
            "enum":[
                "Custom",
                "Quantity",
                "BomItemVariableName",
                "ChargeAttribute",
                "PriceAsOf",
                "RequestedRatePlanNumber",
                "ServiceDuration",
                "ServiceDurationPeriod",
                "RequestedAgreementNumber",
                "BuyingAccountID",
                "Currency Code",
                "PartNumber",
                "Customer ID",
                "Line Price As Of"
            ]
        },
        "valid":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether Pricing Charge is valid.",
            "title":"Valid",
            "readOnly":true
        },
        "orderNumber":{
            "type":"integer",
            "format":"",
            "description":"The order of the Charge Attribute.",
            "title":"Order Number"
        },
        "key":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the Charge Attribute is part of the user key.",
            "title":"Key",
            "readOnly":true
        },
        "lookupType":{
            "type":"string",
            "format":"",
            "description":"The lookup type variable name for the Charge Attribute.",
            "title":"Lookup Type"
        },
        "lookupTypeLabel":{
            "type":"string",
            "format":"",
            "description":"The lookup type display label for the Charge Attribute.",
            "title":"Lookup Type Display Label",
            "readOnly":true
        },
        "defaultValue":{
            "type":"string",
            "format":"",
            "description":"The default value of the Charge Attribute.",
            "title":"Default Value"
        },
        "defaultValueLabel":{
            "type":"string",
            "format":"",
            "description":"The default value display label of the Charge Attribute.",
            "title":"Default Value Display Label",
            "readOnly":true
        },
        "required":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether Charge Attribute is required.",
            "title":"Required"
        },
        "active":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether Charge Attribute is active.",
            "title":"Active"
        },
        "visibility":{
            "type":"string",
            "format":"",
            "description":"Indicates whether the Charge Attribute is visible in Administration or Runtime.",
            "title":"Visibility"
        },
        "negotiable":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the Charge Attribute is editable in runtime.",
            "title":"Negotiable"
        },
        "ioType":{
            "type":"string",
            "format":"",
            "description":"Pricing Attribute IO Type.",
            "title":"IO Type",
            "enum":[
                "Input",
                "Output",
                "Internal",
                "External"
            ]
        },
        "productPriceEnabled":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the Charge Attribute is product price enabled.",
            "title":"Product Price Enabled",
            "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 : 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

204 Response

Success

Back to Top

Examples

The following examples show how to update the specified Charge Attribute by submitting a PATCH request to the REST resource using cURL. For more information about cURL, see Use cURL.

curl - X PATCH -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/pricingSetup/chargeAttributes/globalMarkets_c

Request Body Sample

{
  "name": "Global Markets",
  "description": "Charge Attribute for Global Markets",
  "defaultValue": "northAmerica_c",
  "defaultValueLabel": "North America"
}

Back to Top