Jump to

• Request
• Response
• Examples

Add a Pricing Attribute

post

/rest/v19/pricingSetup/attributes

Use this endpoint to add a pricing attribute.

Request

Supported Media Types

• application/json

Body ()

Root Schema : PricingAttribute

Type: object

Show Source

• active: boolean()
  Title: Active

  Indicates whether Pricing Attribute is active.
• arrayType: boolean()
  Title: Array Type

  Indicates whether Pricing Attribute is an array type.
• attributeLevel: string()
  Title: Attribute Level

  Allowed Values: [ "Header", "Line", "Charge" ]

  Pricing Attribute Level.
• 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 Attribute.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

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

  Read Only: true

  Last modified date of the Pricing Attribute.
• 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 Attribute.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• 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 Pricing Attribute.
• lookupTypeLabel: string()
  Title: Lookup Type Display Label

  Read Only: true

  The lookup type display label for the Pricing Attribute.
• mappings: Attribute Mappings
  Title: Attribute Mappings

  Read Only: true

  List of mappings for the Pricing Attribute.
• name: string()
  Title: Name

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

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

  The order of the Charge Attribute.
• required: boolean()
  Title: Required

  Indicates whether Charge Attribute is required.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• 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", "Header Number", "Business Unit ID", "Header Contract Start Date", "Header Contract End Date", "Line Contract Start Date", "Line Contract End Date", "Covered Line ID", "Coverage Header Number" ]

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

  Read Only: true

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

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

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

{
    "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"
                }
            ]
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"Name of the Pricing Attribute.",
            "title":"Name"
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"Variable Name of the Pricing Attribute.",
            "title":"Variable Name"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Description of the Pricing Attribute.",
            "title":"Description"
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date of the Pricing Attribute.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date of the Pricing Attribute.",
            "title":"Date Added",
            "readOnly":true
        },
        "dataType":{
            "type":"string",
            "format":"",
            "description":"Data Type of the Pricing Attribute.",
            "title":"Data Type",
            "enum":[
                "Boolean",
                "Currency",
                "String",
                "Decimal",
                "Date",
                "Integer",
                "Text Area"
            ]
        },
        "attributeLevel":{
            "type":"string",
            "format":"",
            "description":"Pricing Attribute Level.",
            "title":"Attribute Level",
            "enum":[
                "Header",
                "Line",
                "Charge"
            ]
        },
        "templateVariableKey":{
            "type":"string",
            "format":"",
            "description":"Pricing Attribute 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",
                "Header Number",
                "Business Unit ID",
                "Header Contract Start Date",
                "Header Contract End Date",
                "Line Contract Start Date",
                "Line Contract End Date",
                "Covered Line ID",
                "Coverage Header Number"
            ]
        },
        "valid":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether Pricing Attribute is valid.",
            "title":"Valid",
            "readOnly":true
        },
        "arrayType":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether Pricing Attribute is an array type.",
            "title":"Array Type"
        },
        "mappings":{
            "format":"",
            "description":"List of mappings for the Pricing Attribute.",
            "title":"Attribute Mappings",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingResourceCollection_PricingMappedDataSourceAttribute"
                }
            ]
        },
        "lookupType":{
            "type":"string",
            "format":"",
            "description":"The lookup type variable name for the Pricing Attribute.",
            "title":"Lookup Type"
        },
        "lookupTypeLabel":{
            "type":"string",
            "format":"",
            "description":"The lookup type display label for the Pricing Attribute.",
            "title":"Lookup Type Display Label",
            "readOnly":true
        },
        "active":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether Pricing Attribute is active.",
            "title":"Active"
        },
        "ioType":{
            "type":"string",
            "format":"",
            "description":"Pricing Attribute IO Type.",
            "title":"IO Type",
            "enum":[
                "Input",
                "Output",
                "Internal",
                "External"
            ]
        },
        "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
        },
        "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"
        },
        "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"
        },
        "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 : Attribute Mappings

Title: Attribute Mappings

Read Only: true

List of mappings for the Pricing Attribute.

Match All

List of mappings for the Pricing Attribute.

Show Source

• object PricingResourceCollection_PricingMappedDataSourceAttribute

{
    "format":"",
    "description":"List of mappings for the Pricing Attribute.",
    "title":"Attribute Mappings",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingResourceCollection_PricingMappedDataSourceAttribute"
        }
    ]
}

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"
        }
    }
}

Nested Schema : PricingResourceCollection_PricingMappedDataSourceAttribute

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/PricingMappedDataSourceAttribute"
            }
        },
        "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 PricingMappedDataSourceAttribute

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

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

Type: object

Show Source

• attributeLabel: string()
  Title: Attribute Label

  Read Only: true

  The label of the Pricing Data Source Attribute.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dataSourceAttribute: string()
  Title: Data Source Attribute.

  Read Only: true

  The mapped data source attribute.
• dataSourceLabel: string()
  Title: Data Source Label

  Read Only: true

  The mapped label of the data source.
• dataSourceProviderVariableName: string()
  Title: Data Source Provider Variable Name

  Read Only: true

  The variable name of the data source provider.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

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

  Read Only: true

  Last modified date of the Pricing Rule.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• id: integer()
  Title: Id

  Read Only: true

  The Unique Identifier of the Pricing Data Source Attribute.
• 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.
• orderNumber: integer()
  Title: Order Number

  The position(starting from 1) of the Pricing Data Source Attribute in the ordered list.
• readOnly: boolean()
  Title: Read Only

  Read Only: true

  Indicates if the attribute has any restrictions for edits.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• sourceEntity: string()
  Title: Source Entity

  Read Only: true

  The name of the Pricing Data Source Entity
• validMapping: boolean()
  Title: Has Valid Mapping

  Read Only: true

  Indicates whether the Pricing Data Source Attribute has a valid mapping
• variableName: string()
  Title: Variable Name

  Read Only: true

  The variable name of the Pricing Data Source Attribute.

{
    "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"
                }
            ]
        },
        "orderNumber":{
            "type":"integer",
            "format":"",
            "description":"The position(starting from 1) of the Pricing Data Source Attribute in the ordered list.",
            "title":"Order Number"
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"The Unique Identifier of the Pricing Data Source Attribute.",
            "title":"Id",
            "readOnly":true
        },
        "dataSourceAttribute":{
            "type":"string",
            "format":"",
            "description":"The mapped data source attribute.",
            "title":"Data Source Attribute.",
            "readOnly":true
        },
        "dataSourceLabel":{
            "type":"string",
            "format":"",
            "description":"The mapped label of the data source.",
            "title":"Data Source Label",
            "readOnly":true
        },
        "dataSourceProviderVariableName":{
            "type":"string",
            "format":"",
            "description":"The variable name of the data source provider.",
            "title":"Data Source Provider Variable Name",
            "readOnly":true
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"The variable name of the Pricing Data Source Attribute.",
            "title":"Variable Name",
            "readOnly":true
        },
        "attributeLabel":{
            "type":"string",
            "format":"",
            "description":"The label of the Pricing Data Source Attribute.",
            "title":"Attribute Label",
            "readOnly":true
        },
        "validMapping":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the Pricing Data Source Attribute has a valid mapping",
            "title":"Has Valid Mapping",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date of the Pricing Rule.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date of the Pricing Rule.",
            "title":"Date Added",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "readOnly":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the attribute has any restrictions for edits.",
            "title":"Read Only",
            "readOnly":true
        },
        "sourceEntity":{
            "type":"string",
            "format":"",
            "description":"The name of the Pricing Data Source Entity",
            "title":"Source Entity",
            "readOnly":true
        }
    }
}

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"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PricingAttribute

Type: object

Show Source

• active: boolean()
  Title: Active

  Indicates whether Pricing Attribute is active.
• arrayType: boolean()
  Title: Array Type

  Indicates whether Pricing Attribute is an array type.
• attributeLevel: string()
  Title: Attribute Level

  Allowed Values: [ "Header", "Line", "Charge" ]

  Pricing Attribute Level.
• 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 Attribute.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

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

  Read Only: true

  Last modified date of the Pricing Attribute.
• 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 Attribute.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• 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 Pricing Attribute.
• lookupTypeLabel: string()
  Title: Lookup Type Display Label

  Read Only: true

  The lookup type display label for the Pricing Attribute.
• mappings: Attribute Mappings
  Title: Attribute Mappings

  Read Only: true

  List of mappings for the Pricing Attribute.
• name: string()
  Title: Name

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

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

  The order of the Charge Attribute.
• required: boolean()
  Title: Required

  Indicates whether Charge Attribute is required.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• 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", "Header Number", "Business Unit ID", "Header Contract Start Date", "Header Contract End Date", "Line Contract Start Date", "Line Contract End Date", "Covered Line ID", "Coverage Header Number" ]

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

  Read Only: true

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

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

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

{
    "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"
                }
            ]
        },
        "name":{
            "type":"string",
            "format":"",
            "description":"Name of the Pricing Attribute.",
            "title":"Name"
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"Variable Name of the Pricing Attribute.",
            "title":"Variable Name"
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"Description of the Pricing Attribute.",
            "title":"Description"
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date of the Pricing Attribute.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date of the Pricing Attribute.",
            "title":"Date Added",
            "readOnly":true
        },
        "dataType":{
            "type":"string",
            "format":"",
            "description":"Data Type of the Pricing Attribute.",
            "title":"Data Type",
            "enum":[
                "Boolean",
                "Currency",
                "String",
                "Decimal",
                "Date",
                "Integer",
                "Text Area"
            ]
        },
        "attributeLevel":{
            "type":"string",
            "format":"",
            "description":"Pricing Attribute Level.",
            "title":"Attribute Level",
            "enum":[
                "Header",
                "Line",
                "Charge"
            ]
        },
        "templateVariableKey":{
            "type":"string",
            "format":"",
            "description":"Pricing Attribute 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",
                "Header Number",
                "Business Unit ID",
                "Header Contract Start Date",
                "Header Contract End Date",
                "Line Contract Start Date",
                "Line Contract End Date",
                "Covered Line ID",
                "Coverage Header Number"
            ]
        },
        "valid":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether Pricing Attribute is valid.",
            "title":"Valid",
            "readOnly":true
        },
        "arrayType":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether Pricing Attribute is an array type.",
            "title":"Array Type"
        },
        "mappings":{
            "format":"",
            "description":"List of mappings for the Pricing Attribute.",
            "title":"Attribute Mappings",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/PricingResourceCollection_PricingMappedDataSourceAttribute"
                }
            ]
        },
        "lookupType":{
            "type":"string",
            "format":"",
            "description":"The lookup type variable name for the Pricing Attribute.",
            "title":"Lookup Type"
        },
        "lookupTypeLabel":{
            "type":"string",
            "format":"",
            "description":"The lookup type display label for the Pricing Attribute.",
            "title":"Lookup Type Display Label",
            "readOnly":true
        },
        "active":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether Pricing Attribute is active.",
            "title":"Active"
        },
        "ioType":{
            "type":"string",
            "format":"",
            "description":"Pricing Attribute IO Type.",
            "title":"IO Type",
            "enum":[
                "Input",
                "Output",
                "Internal",
                "External"
            ]
        },
        "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
        },
        "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"
        },
        "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"
        },
        "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 : Attribute Mappings

Title: Attribute Mappings

Read Only: true

List of mappings for the Pricing Attribute.

Match All

List of mappings for the Pricing Attribute.

Show Source

• object PricingResourceCollection_PricingMappedDataSourceAttribute

{
    "format":"",
    "description":"List of mappings for the Pricing Attribute.",
    "title":"Attribute Mappings",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/PricingResourceCollection_PricingMappedDataSourceAttribute"
        }
    ]
}

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"
        }
    }
}

Nested Schema : PricingResourceCollection_PricingMappedDataSourceAttribute

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/PricingMappedDataSourceAttribute"
            }
        },
        "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 PricingMappedDataSourceAttribute

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

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

Type: object

Show Source

• attributeLabel: string()
  Title: Attribute Label

  Read Only: true

  The label of the Pricing Data Source Attribute.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dataSourceAttribute: string()
  Title: Data Source Attribute.

  Read Only: true

  The mapped data source attribute.
• dataSourceLabel: string()
  Title: Data Source Label

  Read Only: true

  The mapped label of the data source.
• dataSourceProviderVariableName: string()
  Title: Data Source Provider Variable Name

  Read Only: true

  The variable name of the data source provider.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

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

  Read Only: true

  Last modified date of the Pricing Rule.
• groupAccessEnabled: boolean()
  Title: Group Access Enabled

  Read Only: true

  Indicates whether the user has access to the groups segment
• id: integer()
  Title: Id

  Read Only: true

  The Unique Identifier of the Pricing Data Source Attribute.
• 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.
• orderNumber: integer()
  Title: Order Number

  The position(starting from 1) of the Pricing Data Source Attribute in the ordered list.
• readOnly: boolean()
  Title: Read Only

  Read Only: true

  Indicates if the attribute has any restrictions for edits.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• sourceEntity: string()
  Title: Source Entity

  Read Only: true

  The name of the Pricing Data Source Entity
• validMapping: boolean()
  Title: Has Valid Mapping

  Read Only: true

  Indicates whether the Pricing Data Source Attribute has a valid mapping
• variableName: string()
  Title: Variable Name

  Read Only: true

  The variable name of the Pricing Data Source Attribute.

{
    "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"
                }
            ]
        },
        "orderNumber":{
            "type":"integer",
            "format":"",
            "description":"The position(starting from 1) of the Pricing Data Source Attribute in the ordered list.",
            "title":"Order Number"
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"The Unique Identifier of the Pricing Data Source Attribute.",
            "title":"Id",
            "readOnly":true
        },
        "dataSourceAttribute":{
            "type":"string",
            "format":"",
            "description":"The mapped data source attribute.",
            "title":"Data Source Attribute.",
            "readOnly":true
        },
        "dataSourceLabel":{
            "type":"string",
            "format":"",
            "description":"The mapped label of the data source.",
            "title":"Data Source Label",
            "readOnly":true
        },
        "dataSourceProviderVariableName":{
            "type":"string",
            "format":"",
            "description":"The variable name of the data source provider.",
            "title":"Data Source Provider Variable Name",
            "readOnly":true
        },
        "variableName":{
            "type":"string",
            "format":"",
            "description":"The variable name of the Pricing Data Source Attribute.",
            "title":"Variable Name",
            "readOnly":true
        },
        "attributeLabel":{
            "type":"string",
            "format":"",
            "description":"The label of the Pricing Data Source Attribute.",
            "title":"Attribute Label",
            "readOnly":true
        },
        "validMapping":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether the Pricing Data Source Attribute has a valid mapping",
            "title":"Has Valid Mapping",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date of the Pricing Rule.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date of the Pricing Rule.",
            "title":"Date Added",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "readOnly":{
            "type":"boolean",
            "format":"",
            "description":"Indicates if the attribute has any restrictions for edits.",
            "title":"Read Only",
            "readOnly":true
        },
        "sourceEntity":{
            "type":"string",
            "format":"",
            "description":"The name of the Pricing Data Source Entity",
            "title":"Source Entity",
            "readOnly":true
        }
    }
}

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"
    }
}

Back to Top

Examples

The following example shows how to add a pricing attribute in Pricing Engine 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/attributes

Request Body Sample

{
  "name": "test",
  "variableName": "testAttribute",
  "dataType": "String",
  "attributeLevel": "Line"
}

Response Body Sample

{
  "name": "test",
  "variableName": "testAttribute",
  "dateModified": "2022-11-28T19:53:01Z",
  "dateAdded": "2022-11-28T19:53:01Z",
  "dataType": "String",
  "attributeLevel": "Line",
  "templateVariableKey": "Custom",
  "arrayType": false
}

Back to Top