Get pricing terms
get
/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractLine/{LineId}/child/PricingTerm
Request
Path Parameters
-
LineId(required): integer(int64)
The unique identifier of the contract line.
-
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.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- AltKey: Finds a pricing term given a name of a pricing term.
Finder Variables:- Name; string; The name of the pricing term.
- ParentEntityKeyColumn1; string.
- ParentEntityKeyColumn2; string.
- ParentEntityKeyColumn3; string.
- ParentEntityKeyColumn4; string.
- ParentEntityKeyColumn5; string.
- ParentEntityTypeCode; string.
- AltKey: Finds a pricing term given a name of a pricing term.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AdjustmentAmount; number; The adjustment amount of the pricing term.
- AdjustmentBasis; string; The adjustment basis of the pricing term.
- AdjustmentBasisId; integer; The adjustment basis ID of the pricing term.
- AdjustmentTypeCode; string; The adjustment type code of the pricing term.
- AllowCustomAdjustmentsFlag; boolean; The indicatory of whether custom adjustments are allowed for the pricing term.
- AllowPricingDiscountsFlag; string; The indicatory of whether pricing discounts are allowed for the pricing term.
- ChargeSubtypeCode; string; The charge sub type code of the pricing term.
- ChargeTypeCode; string; The charge type code of the pricing term.
- EndDate; string; The end date of the pricing term.
- LastUpdateDate; string; The last update date of the pricing term.
- ListPrice; number; The list price of the pricing term.
- Name; string; The name of the pricing term.
- ParentEntityKeyColumn1; string; The parent entity key column 1 of the pricing term.
- ParentEntityKeyColumn2; string; The parent entity key column 2 of the pricing term.
- ParentEntityKeyColumn3; string; The parent entity key column 3 of the pricing term.
- ParentEntityKeyColumn4; string; The parent entity key column 4 of the pricing term.
- ParentEntityKeyColumn5; string; The parent entity key column 5 of the pricing term.
- ParentEntityTypeCode; string; The parent entity type code of the pricing term.
- PricePeriodicityCode; string; The price periodicity code of the pricing term.
- PriceTypeCode; string; The price type code of the pricing term.
- PricingRuleTypeCode; string; The pricing rule type code of the pricing term.
- PricingTermId; integer; The identifier of the pricing term.
- StartDate; string; The start date of the pricing term.
- TieredPricingHeaderId; integer; The tiered pricing header ID of the pricing term.
- UsageUomCode; string; The usage UOM code of the pricing term.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : contracts-ContractLine-PricingTerm
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
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
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : contracts-ContractLine-PricingTerm-item-response
Type:
Show Source
object
-
AdjustmentAmount: number
Title:
Adjustment Amount
The adjustment amount of the pricing term. -
AdjustmentBasis: string
The adjustment basis of the pricing term.
-
AdjustmentBasisId: integer
(int64)
Title:
Adjustment Basis
The adjustment basis ID of the pricing term. -
AdjustmentTypeCode: string
Title:
Adjustment Type
Maximum Length:30
Default Value:DISCOUNT_AMOUNT
The adjustment type code of the pricing term. -
AllowCustomAdjustmentsFlag: boolean
Title:
Allow Price Override on Order
Maximum Length:30
The indicatory of whether custom adjustments are allowed for the pricing term. -
AllowPricingDiscountsFlag: string
Maximum Length:
30
The indicatory of whether pricing discounts are allowed for the pricing term. -
ChargeSubtypeCode: string
Title:
Charge Subtype
Maximum Length:30
The charge sub type code of the pricing term. -
ChargeTypeCode: string
Title:
Charge Type
Maximum Length:30
The charge type code of the pricing term. -
DisplayPricingRuleType: string
The display pricing rule type of the pricing term.
-
DisplayPricingTermName: string
The display pricing term name of the pricing term.
-
EndDate: string
(date-time)
Title:
End Date
The end date of the pricing term. -
LastUpdateDate: string
(date-time)
Read Only:
true
The last update date of the pricing term. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ListPrice: number
Title:
List Price
The list price of the pricing term. -
Name: string
Title:
Name
Maximum Length:80
The name of the pricing term. -
ParentEntityKeyColumn1: string
Maximum Length:
30
The parent entity key column 1 of the pricing term. -
ParentEntityKeyColumn2: string
Maximum Length:
30
The parent entity key column 2 of the pricing term. -
ParentEntityKeyColumn3: string
Maximum Length:
30
The parent entity key column 3 of the pricing term. -
ParentEntityKeyColumn4: string
Maximum Length:
30
The parent entity key column 4 of the pricing term. -
ParentEntityKeyColumn5: string
Maximum Length:
30
The parent entity key column 5 of the pricing term. -
ParentEntityTypeCode: string
Maximum Length:
30
The parent entity type code of the pricing term. -
PricePeriodicityCode: string
Title:
Price Periodicity
Maximum Length:3
The price periodicity code of the pricing term. -
PriceTypeCode: string
Title:
Price Type
Maximum Length:30
The price type code of the pricing term. -
PricingRuleTypeCode: string
Title:
Pricing Rule Type
Maximum Length:30
Default Value:SIMPLE
The pricing rule type code of the pricing term. -
PricingTermId: integer
(int64)
The identifier of the pricing term.
-
PricingTermTierHeader: array
Pricing Term Tier Headers
Title:
Pricing Term Tier Headers
Pricing term tier headers is used to view, create, update and delete header attributes of a tiered pricing term of a sales agreement kind of contract. The pricing terms object includes tier basis type, adjustment type, aggregation method, application method pricing attributes. -
StartDate: string
(date-time)
Title:
Start Date
The start date of the pricing term. -
TieredPricingHeaderId: integer
(int64)
The tiered pricing header ID of the pricing term.
-
UsageUomCode: string
Title:
Usage UOM
Maximum Length:3
The usage UOM code of the pricing term.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Pricing Term Tier Headers
Type:
array
Title:
Pricing Term Tier Headers
Pricing term tier headers is used to view, create, update and delete header attributes of a tiered pricing term of a sales agreement kind of contract. The pricing terms object includes tier basis type, adjustment type, aggregation method, application method pricing attributes.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : contracts-ContractLine-PricingTerm-PricingTermTierHeader-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
Nested Schema : contracts-ContractLine-PricingTerm-PricingTermTierHeader-PricingTermTierLine-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source