Jump to

• Request
• Response

Create a tiered pricing term header

post

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/PricingTerm/{PricingTermUniqID}/child/PricingTermTierHeader

Request

Path Parameters

• LineId(required): integer(int64)
  The unique identifier of the contract line.
• PricingTermUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Pricing Terms resource and used to uniquely identify an instance of Pricing Terms. The client should not generate the hash key value. Instead, the client should query on the Pricing Terms collection resource in order to navigate to a specific instance of Pricing Terms to get the hash key.
• contractsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource in order to navigate to a specific instance of Contracts to get the hash key.

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AdjustmentBasisId: integer (int64)
  Title: Adjustment Basis

  The adjustment basis ID of the pricing term header.
• AdjustmentTypeCode: string
  Title: Adjustment Type

  Maximum Length: 30

  The adjustment type code of the pricing term header.
• AggregationMethodCode: string
  Title: Aggregation Method

  Maximum Length: 30

  Default Value: ORA_ON_DOCUMENT

  The aggregation method code of the pricing term header.
• ApplicationMethodCode: string
  Title: Application Method

  Maximum Length: 30

  Default Value: PER_UNIT

  The application method code of the pricing term header.
• GraduatedCode: string
  Title: Apply To

  Maximum Length: 30

  Default Value: HIGHEST_TIER

  The graduated code of the pricing term header.
• PricingTermTierLine: array Pricing Term Tier Lines
  Title: Pricing Term Tier Lines

  Pricing term tier lines is used to view, create, update and delete line attributes of a tiered pricing term of a sales agreement kind of contract. The pricing terms object includes tier tier minimum, tier maximum, application method, increment value, adjustment type, adjustment amount, adjustment basis attributes.
• TierBasisId: integer (int64)
  Title: Tier Basis

  The tier basis ID of the pricing term header.
• TierBasisTypeCode(required): string
  Title: Tier Basis Type

  Maximum Length: 30

  The tier basis type code of the pricing term header.
• TieredPricingHeaderId: integer (int64)
  The unique identifier of the pricing term header.

{
    "required":[
        "TierBasisTypeCode"
    ],
    "type":"object",
    "properties":{
        "AdjustmentTypeCode":{
            "title":"Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment type code of the pricing term header.",
            "nullable":true
        },
        "TierBasisId":{
            "title":"Tier Basis",
            "type":"integer",
            "description":"The tier basis ID of the pricing term header.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AdjustmentBasisId":{
            "title":"Adjustment Basis",
            "type":"integer",
            "description":"The adjustment basis ID of the pricing term header.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ApplicationMethodCode":{
            "title":"Application Method",
            "maxLength":30,
            "type":"string",
            "description":"The application method code of the pricing term header.",
            "nullable":false,
            "default":"PER_UNIT"
        },
        "GraduatedCode":{
            "title":"Apply To",
            "maxLength":30,
            "type":"string",
            "description":"The graduated code of the pricing term header.",
            "nullable":true,
            "default":"HIGHEST_TIER"
        },
        "TieredPricingHeaderId":{
            "type":"integer",
            "description":"The unique identifier of the pricing term header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "PricingTermTierLine":{
            "title":"Pricing Term Tier Lines",
            "type":"array",
            "description":"Pricing term tier lines is used to view, create, update and delete line attributes of a tiered pricing term of a sales agreement kind of contract. The pricing terms object includes tier tier minimum, tier maximum, application method, increment value, adjustment type, adjustment amount, adjustment basis attributes.",
            "items":{
                "$ref":"#/components/schemas/contracts-ContractLine-PricingTerm-PricingTermTierHeader-PricingTermTierLine-item-post-request"
            }
        },
        "AggregationMethodCode":{
            "title":"Aggregation Method",
            "maxLength":30,
            "type":"string",
            "description":"The aggregation method code of the pricing term header.",
            "nullable":false,
            "default":"ORA_ON_DOCUMENT"
        },
        "TierBasisTypeCode":{
            "title":"Tier Basis Type",
            "maxLength":30,
            "type":"string",
            "description":"The tier basis type code of the pricing term header.",
            "nullable":false
        }
    }
}

Nested Schema : Pricing Term Tier Lines

Type: array

Title: Pricing Term Tier Lines

Pricing term tier lines is used to view, create, update and delete line attributes of a tiered pricing term of a sales agreement kind of contract. The pricing terms object includes tier tier minimum, tier maximum, application method, increment value, adjustment type, adjustment amount, adjustment basis attributes.

Show Source

• Array of: object contracts-ContractLine-PricingTerm-PricingTermTierHeader-PricingTermTierLine-item-post-request

{
    "title":"Pricing Term Tier Lines",
    "type":"array",
    "description":"Pricing term tier lines is used to view, create, update and delete line attributes of a tiered pricing term of a sales agreement kind of contract. The pricing terms object includes tier tier minimum, tier maximum, application method, increment value, adjustment type, adjustment amount, adjustment basis attributes.",
    "items":{
        "$ref":"#/components/schemas/contracts-ContractLine-PricingTerm-PricingTermTierHeader-PricingTermTierLine-item-post-request"
    }
}

Nested Schema : contracts-ContractLine-PricingTerm-PricingTermTierHeader-PricingTermTierLine-item-post-request

Type: object

Show Source

• Adjustment: number
  Title: Adjustment Amount

  The adjustment amount of the pricing term tier.
• AdjustmentBasisId: integer (int64)
  Title: Adjustment Basis

  The adjustment basis ID of the pricing term tier.
• AdjustmentTypeCode: string
  Title: Adjustment Type

  Maximum Length: 30

  The adjustment type code of the pricing term tier.
• ApplicationMethodCode: string
  Title: Application Method

  Maximum Length: 30

  The application method code of the pricing term tier.
• IncrementValue: integer
  Title: Increment Value

  The increment value of the pricing term tier.
• MaximumValue: number
  Title: Maximum

  The maximum value of the pricing term tier.
• MinimumValue: number
  Title: Minimum

  The minimum value of the pricing term tier.
• TieredPricingHeaderId: integer (int64)
  The tier pricing header ID of the pricing term tier.
• TieredPricingLineId: integer (int64)
  The identifier of the pricing term tier.
• TierLineNumber: integer (int32)
  The number of the pricing term tier.

{
    "type":"object",
    "properties":{
        "AdjustmentTypeCode":{
            "title":"Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment type code of the pricing term tier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "IncrementValue":{
            "title":"Increment Value",
            "type":"integer",
            "description":"The increment value of the pricing term tier.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ApplicationMethodCode"
                ]
            }
        },
        "AdjustmentBasisId":{
            "title":"Adjustment Basis",
            "type":"integer",
            "description":"The adjustment basis ID of the pricing term tier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ApplicationMethodCode":{
            "title":"Application Method",
            "maxLength":30,
            "type":"string",
            "description":"The application method code of the pricing term tier.",
            "nullable":true
        },
        "Adjustment":{
            "title":"Adjustment Amount",
            "type":"number",
            "description":"The adjustment amount of the pricing term tier.",
            "nullable":false
        },
        "TieredPricingHeaderId":{
            "type":"integer",
            "description":"The tier pricing header ID of the pricing term tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TieredPricingLineId":{
            "type":"integer",
            "description":"The identifier of the pricing term tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "MaximumValue":{
            "title":"Maximum",
            "type":"number",
            "description":"The maximum value of the pricing term tier.",
            "nullable":true
        },
        "TierLineNumber":{
            "type":"integer",
            "description":"The number of the pricing term tier.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "MinimumValue":{
            "title":"Minimum",
            "type":"number",
            "description":"The minimum value of the pricing term tier.",
            "nullable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : contracts-ContractLine-PricingTerm-PricingTermTierHeader-item-response

Type: object

Show Source

• AdjustmentBasisId: integer (int64)
  Title: Adjustment Basis

  The adjustment basis ID of the pricing term header.
• AdjustmentTypeCode: string
  Title: Adjustment Type

  Maximum Length: 30

  The adjustment type code of the pricing term header.
• AggregationMethodCode: string
  Title: Aggregation Method

  Maximum Length: 30

  Default Value: ORA_ON_DOCUMENT

  The aggregation method code of the pricing term header.
• ApplicationMethodCode: string
  Title: Application Method

  Maximum Length: 30

  Default Value: PER_UNIT

  The application method code of the pricing term header.
• GraduatedCode: string
  Title: Apply To

  Maximum Length: 30

  Default Value: HIGHEST_TIER

  The graduated code of the pricing term header.
• LastUpdateDate: string (date-time)
  Read Only: true

  The last update date of the pricing term header.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PricingTermTierLine: array Pricing Term Tier Lines
  Title: Pricing Term Tier Lines

  Pricing term tier lines is used to view, create, update and delete line attributes of a tiered pricing term of a sales agreement kind of contract. The pricing terms object includes tier tier minimum, tier maximum, application method, increment value, adjustment type, adjustment amount, adjustment basis attributes.
• TierBasisId: integer (int64)
  Title: Tier Basis

  The tier basis ID of the pricing term header.
• TierBasisTypeCode: string
  Title: Tier Basis Type

  Maximum Length: 30

  The tier basis type code of the pricing term header.
• TieredPricingHeaderId: integer (int64)
  The unique identifier of the pricing term header.

{
    "type":"object",
    "properties":{
        "AdjustmentTypeCode":{
            "title":"Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment type code of the pricing term header.",
            "nullable":true,
            "x-queryable":true
        },
        "TierBasisId":{
            "title":"Tier Basis",
            "type":"integer",
            "description":"The tier basis ID of the pricing term header.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AdjustmentBasisId":{
            "title":"Adjustment Basis",
            "type":"integer",
            "description":"The adjustment basis ID of the pricing term header.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ApplicationMethodCode":{
            "title":"Application Method",
            "maxLength":30,
            "type":"string",
            "description":"The application method code of the pricing term header.",
            "nullable":false,
            "default":"PER_UNIT",
            "x-queryable":true
        },
        "GraduatedCode":{
            "title":"Apply To",
            "maxLength":30,
            "type":"string",
            "description":"The graduated code of the pricing term header.",
            "nullable":true,
            "default":"HIGHEST_TIER",
            "x-queryable":true
        },
        "TieredPricingHeaderId":{
            "type":"integer",
            "description":"The unique identifier of the pricing term header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PricingTermTierLine":{
            "title":"Pricing Term Tier Lines",
            "type":"array",
            "description":"Pricing term tier lines is used to view, create, update and delete line attributes of a tiered pricing term of a sales agreement kind of contract. The pricing terms object includes tier tier minimum, tier maximum, application method, increment value, adjustment type, adjustment amount, adjustment basis attributes.",
            "items":{
                "$ref":"#/components/schemas/contracts-ContractLine-PricingTerm-PricingTermTierHeader-PricingTermTierLine-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AggregationMethodCode":{
            "title":"Aggregation Method",
            "maxLength":30,
            "type":"string",
            "description":"The aggregation method code of the pricing term header.",
            "nullable":false,
            "default":"ORA_ON_DOCUMENT",
            "x-queryable":true
        },
        "TierBasisTypeCode":{
            "title":"Tier Basis Type",
            "maxLength":30,
            "type":"string",
            "description":"The tier basis type code of the pricing term header.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date of the pricing term header.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Pricing Term Tier Lines

Type: array

Title: Pricing Term Tier Lines

Pricing term tier lines is used to view, create, update and delete line attributes of a tiered pricing term of a sales agreement kind of contract. The pricing terms object includes tier tier minimum, tier maximum, application method, increment value, adjustment type, adjustment amount, adjustment basis attributes.

Show Source

• Array of: object contracts-ContractLine-PricingTerm-PricingTermTierHeader-PricingTermTierLine-item-response

{
    "title":"Pricing Term Tier Lines",
    "type":"array",
    "description":"Pricing term tier lines is used to view, create, update and delete line attributes of a tiered pricing term of a sales agreement kind of contract. The pricing terms object includes tier tier minimum, tier maximum, application method, increment value, adjustment type, adjustment amount, adjustment basis attributes.",
    "items":{
        "$ref":"#/components/schemas/contracts-ContractLine-PricingTerm-PricingTermTierHeader-PricingTermTierLine-item-response"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : contracts-ContractLine-PricingTerm-PricingTermTierHeader-PricingTermTierLine-item-response

Type: object

Show Source

• Adjustment: number
  Title: Adjustment Amount

  The adjustment amount of the pricing term tier.
• AdjustmentBasisId: integer (int64)
  Title: Adjustment Basis

  The adjustment basis ID of the pricing term tier.
• AdjustmentTypeCode: string
  Title: Adjustment Type

  Maximum Length: 30

  The adjustment type code of the pricing term tier.
• ApplicationMethodCode: string
  Title: Application Method

  Maximum Length: 30

  The application method code of the pricing term tier.
• IncrementValue: integer
  Title: Increment Value

  The increment value of the pricing term tier.
• LastUpdateDate: string (date-time)
  Read Only: true

  The last update date of the pricing term tier.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumValue: number
  Title: Maximum

  The maximum value of the pricing term tier.
• MinimumValue: number
  Title: Minimum

  The minimum value of the pricing term tier.
• TieredPricingHeaderId: integer (int64)
  The tier pricing header ID of the pricing term tier.
• TieredPricingLineId: integer (int64)
  The identifier of the pricing term tier.
• TierLineNumber: integer (int32)
  The number of the pricing term tier.

{
    "type":"object",
    "properties":{
        "AdjustmentTypeCode":{
            "title":"Adjustment Type",
            "maxLength":30,
            "type":"string",
            "description":"The adjustment type code of the pricing term tier.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "IncrementValue":{
            "title":"Increment Value",
            "type":"integer",
            "description":"The increment value of the pricing term tier.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "ApplicationMethodCode"
                ]
            },
            "x-queryable":true
        },
        "AdjustmentBasisId":{
            "title":"Adjustment Basis",
            "type":"integer",
            "description":"The adjustment basis ID of the pricing term tier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ApplicationMethodCode":{
            "title":"Application Method",
            "maxLength":30,
            "type":"string",
            "description":"The application method code of the pricing term tier.",
            "nullable":true,
            "x-queryable":true
        },
        "Adjustment":{
            "title":"Adjustment Amount",
            "type":"number",
            "description":"The adjustment amount of the pricing term tier.",
            "nullable":false,
            "x-queryable":true
        },
        "TieredPricingHeaderId":{
            "type":"integer",
            "description":"The tier pricing header ID of the pricing term tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TieredPricingLineId":{
            "type":"integer",
            "description":"The identifier of the pricing term tier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MaximumValue":{
            "title":"Maximum",
            "type":"number",
            "description":"The maximum value of the pricing term tier.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TierLineNumber":{
            "type":"integer",
            "description":"The number of the pricing term tier.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "MinimumValue":{
            "title":"Minimum",
            "type":"number",
            "description":"The minimum value of the pricing term tier.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date of the pricing term tier.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

PricingTermTierLine

Operation: /fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/PricingTerm/{PricingTermUniqID}/child/PricingTermTierHeader/{TieredPricingHeaderId}/child/PricingTermTierLine

Parameters:

• LineId: $request.path.LineId
• PricingTermUniqID: $request.path.PricingTermUniqID
• TieredPricingHeaderId: $request.path.TieredPricingHeaderId
• contractsUniqID: $request.path.contractsUniqID

Pricing term tier lines is used to view, create, update and delete line attributes of a tiered pricing term of a sales agreement kind of contract. The pricing terms object includes tier tier minimum, tier maximum, application method, increment value, adjustment type, adjustment amount, adjustment basis attributes.

Back to Top