Get one financial orchestration transfer pricing rule
get
/fscmRestApi/resources/11.13.18.05/financialOrchestrationTransferPricingRules/{financialOrchestrationTransferPricingRulesUniqID}
Request
Path Parameters
-
financialOrchestrationTransferPricingRulesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- EffectiveEndDate, EffectiveStartDate and PricingId ---for the Transfer Pricing Rules resource and used to uniquely identify an instance of Transfer Pricing Rules. The client should not generate the hash key value. Instead, the client should query on the Transfer Pricing Rules collection resource with a filter on the primary key values in order to navigate to a specific instance of Transfer Pricing Rules.
For example: financialOrchestrationTransferPricingRules?q=EffectiveEndDate=<value1>;EffectiveStartDate=<value2>;PricingId=<value3>
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
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.
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 : financialOrchestrationTransferPricingRules-item-response
Type:
Show Source
object
-
AccountingTransferPriceBasis: string
Value that identifies the accounting transfer price basis of the transfer pricing rule.
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Date Effective Entity: indicates the date at the end of the date range within which the row is effective. -
EffectiveEndDateDisplay: string
(date)
Read Only:
true
Indicates the display date at the end of the date range within which the row is effective. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Date Effective Entity: indicates the date at the beginning of the date range within which the row is effective. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Number of times the transfer pricing rule has been updated.
-
PricingId: integer
(int64)
Primary key identifier of the transfer pricing rules attribute.
-
PricingOptionDescription: string
Title:
Description
Maximum Length:200
Brief description of the transfer pricing option. -
PricingOptionName: string
Title:
Name
Maximum Length:100
Value that uniquely identifies the name of the pricing option. -
PricingOptionSearchAsOfDate: string
(date)
Value that identifies the effective date selected by the user.
-
TpItemCostBasisFlag: boolean
Title:
Item Cost Basis
Maximum Length:1
Default Value:false
Contains one of the following values: Y or N. If Y, then item cost basis is selected and item cost is chosen for calculating the transfer price. The default value is N. -
TpItemCostMarkupValue: number
Title:
Markup Percentage
Indicates the markup value on the item cost. -
TransferPriceCostBasisMarkupValue: number
Title:
Markup Percentage
Identifies the standard markup value on the transaction cost for the accounting transfer price. -
TransferPricePricingStrategyBasisFlag: boolean
Title:
Pricing Strategy Basis
Maximum Length:1
Default Value:false
Contains one of the following values: Y or N. If Y, then the pricing strategy is selected as the basis for calculating the transfer price. The default value is N. -
TransferPriceSourceDocumentMarkupValue: number
Title:
Markup Percentage
Indicates the standard markup value on the source document price. -
TransferPriceSourceDocumentPriceBasisFlag: boolean
Title:
Source Document Price Basis
Maximum Length:1
Default Value:false
Contains one of the following values: Y or N. If Y, then the source document price basis is selected for calculating the transfer price. The default value is N. -
TransferPriceTransactionCostBasisFlag: boolean
Title:
Transaction Cost Basis
Maximum Length:1
Default Value:false
Contains one of the following values: Y or N. If Y, then the sales order is used to calculate the transfer price for the accounting transfer price. The default value is N.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.