Jump to

• Request
• Response
• Examples

Get a Price Agreement Pricing Data Item

get

/rest/v19/pricingSetup/agreements/{agreementVariableName}/data/{id}

Use this endpoint to retrieve the specified price agreement pricing data item.

Request

Path Parameters

• agreementVariableName(required): string
• id(required): integer(int64)

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PricingModelData

Type: object

Show Source

• blockPrices: array Block Prices
  Title: Block Prices

  The block price.
• blockSize: number()
  Title: Block Size

  The block size.
• bomItemName: string()
  Title: BOM Item Name

  Read Only: true

  The BOM item's display name. When clients sets field bomItemVariableName, this field should also be explicitly set in the request.
• bomItemVariableName: string()
  Title: BOM Item Variable Name

  Read Only: true

  The BOM Item's variable name.
• chargeDefinition: string()
  Title: Charge Definition

  Read Only: true

  Display Name of the Charge Definition.
• chargeDefinitionCode: string()
  Title: Charge Definition Code

  Read Only: true

  The unique code of the Charge Definition.
• chargeDefinitionId: integer()
  Title: Charge Definition ID

  Read Only: true

  ID of the Charge Definition.
• chargeType: string()
  Title: Charge Type

  Read Only: true

  The category of charge.
• 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 Price Model Data.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last modified date of the Price Model Data.
• description: string()
  Title: Description

  Read Only: true

  The description of the Price Model Data
• dynamicPricingType: string()
  Title: Dynamic Pricing Type

  Read Only: true

  Allowed Values: [ "static", "advanced", "volume", "tiered", "rateCard", "attributeBasedCharge" ]

  The dynamic pricing type of the charge.
• endDate: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: End Date

  Read Only: true

  The date at which the Charge will end.
• 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 Price Model Data.
• 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.
• partNumber: string()
  Title: Part Number

  Read Only: true

  The part Number of the Price Model Data.This should match the Part Lookup's lookupCode.
• pricePeriod: string()
  Title: Price Period

  Read Only: true

  The billing period.
• prices: array Prices
  Title: Prices

  The item prices.
• priceType: string()
  Title: Price Type

  Read Only: true

  The type of charge.
• primaryCharge: boolean()
  Title: Primary Charge

  Read Only: true

  Indicates whether this is the primary charge.
• quantityAggregation: boolean()
  Title: Quantity Aggregation

  Indicates whether to use aggregated quantity when calculating unit price for tiered-pricing.
• rangeFrom: number()
  Title: Range From

  Read Only: true

  The starting range of the Price Model Data.
• rangeTo: number()
  Title: Range To

  Read Only: true

  The ending range of the Price Model Data.
• rateCardName: string()
  Title: Rate Card Name

  Read Only: true

  Rate Card name (Preview only. Not available for use.)
• rateCardVariableName: string()
  Title: Rate Card Variable Name

  Read Only: true

  Rate Card variable name (Preview only. Not available for use.)
• ratePlanName: string()
  Title: Rate Plan Name

  Read Only: true

  Rate Plan name.
• rootBomItemName: string()
  Title: Root BOM Item Name

  Read Only: true

  The root BOM item's display name.
• rootBomItemVariableName: string()
  Title: Root BOM Item Variable Name

  Read Only: true

  The root BOM item's variable name.
• segmentLevelAccessType: string()
  Title: Segment-level Access Type

  Read Only: true

  Segment-level Access Type
• serviceDuration: integer()
  Title: Service Duration

  Read Only: true

  Service duration.
• serviceDurationPeriod: string()
  Title: Service Duration Period

  Read Only: true

  Service duration period code.
• serviceDurationType: string()
  Title: Service Duration Type

  Read Only: true

  Service duration type.
• startDate: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Start Date

  Read Only: true

  The date from which the Charge will be applicable.
• usageUOM: string()
  Title: Usage UOM

  Read Only: true

  The unit of measure for the charge.

{
    "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"
                }
            ]
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"The Unique Identifier of the Price Model Data.",
            "title":"Id",
            "readOnly":true
        },
        "partNumber":{
            "type":"string",
            "format":"",
            "description":"The part Number of the Price Model Data.This should match the Part Lookup's lookupCode.",
            "title":"Part Number",
            "readOnly":true
        },
        "description":{
            "type":"string",
            "format":"",
            "description":"The description of the Price Model Data",
            "title":"Description",
            "readOnly":true
        },
        "rangeFrom":{
            "type":"number",
            "format":"",
            "description":"The starting range of the Price Model Data.",
            "title":"Range From",
            "readOnly":true
        },
        "rangeTo":{
            "type":"number",
            "format":"",
            "description":"The ending range of the Price Model Data.",
            "title":"Range To",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last modified date of the Price Model Data.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation date of the Price Model Data.",
            "title":"Date Added",
            "readOnly":true
        },
        "prices":{
            "type":"array",
            "format":"",
            "description":"The item prices.",
            "title":"Prices",
            "items":{
                "$ref":"#/definitions/PricingCurrencyValues"
            }
        },
        "bomItemName":{
            "type":"string",
            "format":"",
            "description":"The BOM item's display name. When clients sets field bomItemVariableName, this field should also be explicitly set in the request.",
            "title":"BOM Item Name",
            "readOnly":true
        },
        "rootBomItemName":{
            "type":"string",
            "format":"",
            "description":"The root BOM item's display name.",
            "title":"Root BOM Item Name",
            "readOnly":true
        },
        "startDate":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"The date from which the Charge will be applicable.",
            "title":"Start Date",
            "readOnly":true
        },
        "endDate":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"The date at which the Charge will end.",
            "title":"End Date",
            "readOnly":true
        },
        "chargeDefinition":{
            "type":"string",
            "format":"",
            "description":"Display Name of the Charge Definition.",
            "title":"Charge Definition",
            "readOnly":true
        },
        "chargeDefinitionCode":{
            "type":"string",
            "format":"",
            "description":"The unique code of the Charge Definition.",
            "title":"Charge Definition Code",
            "readOnly":true
        },
        "chargeDefinitionId":{
            "type":"integer",
            "format":"",
            "description":"ID of the Charge Definition.",
            "title":"Charge Definition ID",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "bomItemVariableName":{
            "type":"string",
            "format":"",
            "description":"The BOM Item's variable name.",
            "title":"BOM Item Variable Name",
            "readOnly":true
        },
        "rootBomItemVariableName":{
            "type":"string",
            "format":"",
            "description":"The root BOM item's variable name.",
            "title":"Root BOM Item Variable Name",
            "readOnly":true
        },
        "chargeType":{
            "type":"string",
            "format":"",
            "description":"The category of charge.",
            "title":"Charge Type",
            "readOnly":true
        },
        "priceType":{
            "type":"string",
            "format":"",
            "description":"The type of charge.",
            "title":"Price Type",
            "readOnly":true
        },
        "pricePeriod":{
            "type":"string",
            "format":"",
            "description":"The billing period.",
            "title":"Price Period",
            "readOnly":true
        },
        "usageUOM":{
            "type":"string",
            "format":"",
            "description":"The unit of measure for the charge.",
            "title":"Usage UOM",
            "readOnly":true
        },
        "primaryCharge":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether this is the primary charge.",
            "title":"Primary Charge",
            "readOnly":true
        },
        "rateCardVariableName":{
            "type":"string",
            "format":"",
            "description":"Rate Card variable name (Preview only. Not available for use.)",
            "title":"Rate Card Variable Name",
            "readOnly":true
        },
        "rateCardName":{
            "type":"string",
            "format":"",
            "description":"Rate Card name (Preview only. Not available for use.)",
            "title":"Rate Card Name",
            "readOnly":true
        },
        "dynamicPricingType":{
            "type":"string",
            "format":"",
            "description":"The dynamic pricing type of the charge.",
            "title":"Dynamic Pricing Type",
            "readOnly":true,
            "enum":[
                "static",
                "advanced",
                "volume",
                "tiered",
                "rateCard",
                "attributeBasedCharge"
            ]
        },
        "ratePlanName":{
            "type":"string",
            "format":"",
            "description":"Rate Plan name.",
            "title":"Rate Plan Name",
            "readOnly":true
        },
        "serviceDuration":{
            "type":"integer",
            "format":"",
            "description":"Service duration.",
            "title":"Service Duration",
            "readOnly":true
        },
        "serviceDurationPeriod":{
            "type":"string",
            "format":"",
            "description":"Service duration period code.",
            "title":"Service Duration Period",
            "readOnly":true
        },
        "serviceDurationType":{
            "type":"string",
            "format":"",
            "description":"Service duration type.",
            "title":"Service Duration Type",
            "readOnly":true
        },
        "blockSize":{
            "type":"number",
            "format":"",
            "description":"The block size.",
            "title":"Block Size"
        },
        "blockPrices":{
            "type":"array",
            "format":"",
            "description":"The block price.",
            "title":"Block Prices",
            "items":{
                "$ref":"#/definitions/PricingCurrencyValues"
            }
        },
        "quantityAggregation":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether to use aggregated quantity when calculating unit price for tiered-pricing.",
            "title":"Quantity Aggregation"
        }
    }
}

Nested Schema : Block Prices

Type: array

Title: Block Prices

The block price.

Show Source

• Array of: object PricingCurrencyValues

{
    "type":"array",
    "format":"",
    "description":"The block price.",
    "title":"Block Prices",
    "items":{
        "$ref":"#/definitions/PricingCurrencyValues"
    }
}

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

Type: array

Title: Prices

The item prices.

Show Source

• Array of: object PricingCurrencyValues

{
    "type":"array",
    "format":"",
    "description":"The item prices.",
    "title":"Prices",
    "items":{
        "$ref":"#/definitions/PricingCurrencyValues"
    }
}

Nested Schema : PricingCurrencyValues

Type: object

Show Source

• currencyCode: string()
  Title: Currency Code

  The currency code.
• value: number()
  Title: Value

  The currency value.

{
    "properties":{
        "currencyCode":{
            "type":"string",
            "format":"",
            "description":"The currency code.",
            "title":"Currency Code"
        },
        "value":{
            "type":"number",
            "format":"",
            "description":"The currency value.",
            "title":"Value"
        }
    }
}

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 retrieve the specified price agreement data item 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/agreements/agreementAPIaccount112/data/3023202282

Response Body Sample

{
  "id": 3023202282,
  "partNumber": "Floor Mats",
  "dateModified": "2024-01-26T20:40:40Z",
  "dateAdded": "2024-01-26T20:40:40Z",
  "prices": [{
      "currencyCode": "USD",
      "value": 300
    }
  ],
  "chargeDefinitionId": -1,
  "links": [{
      "rel": "self",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/agreements/agreementAPIaccount112/data/3023202282"
    }, {
      "rel": "parent",
      "href": "https://sitename.oracle.com/rest/v19/pricingSetup/agreements/agreementAPIaccount112/data"
    }
  ],
  "chargeType": "ORA_SALE",
  "priceType": "One Time",
  "primaryCharge": true,
  "dynamicPricingType": "static",
  "serviceDuration": -1,
  "blockSize": 1
}

Back to Top