Create one transfer pricing rule
post
/fscmRestApi/resources/11.13.18.05/financialOrchestrationTransferPricingRules
Request
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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.
-
Upsert-Mode:
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
Root Schema : schema
Type:
Show Source
object
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Value that identifies the effective end date of the transfer pricing rule. -
EffectiveEndDateDisplay: string
(date)
Title:
Effective End Date
Value that identifies the effective end date of the transfer pricing rule in the display format. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Value that identifies the effective start date of the transfer pricing rule. -
EffectiveStartDateDisplay: string
(date)
Title:
Effective Start Date
Value that identifies the effective start date of the transfer pricing rule in the display format. -
MarkupValue: number
Value that identifies the markup value of the transfer pricing rule.
-
ObjectVersionNumber: integer
(int32)
Value that uniquely identifies the object version number.
-
Operation: string
Maximum Length:
255
Indicates that the user has performed the insert action as part of the transaction. -
PricingId: integer
(int64)
Value that uniquely identifies the transfer pricing rule.
-
PricingOptionDescription: string
Title:
Description
Maximum Length:200
Value that identifies the description of the transfer pricing option. -
PricingOptionName: string
Title:
Name
Maximum Length:100
Value that identifies the name of the transfer pricing option. -
SelectedTransferPriceBasis: string
Maximum Length:
255
Value that identifies the price basis that's selected for the transfer pricing option. -
TpItemCostBasisFlag: boolean
Title:
Item Cost Basis
Maximum Length:1
Default Value:false
Value that identifies the pricing option as item cost basis for the transfer pricing rule. -
TpItemCostMarkupValue: number
Title:
Markup Percentage
Value that identifies the markup percentage on the item cost if item cost is selected as the markup type. -
TransferPriceCostBasisMarkupType: string
Title:
Cost Basis Markup Type
Maximum Length:30
Value that identifies the markup type selected by the user on the transaction cost. -
TransferPriceCostBasisMarkupValue: number
Title:
Markup Percentage
Value that identifies the markup percentage on the transaction cost if transaction cost is selected as the markup type. -
TransferPriceMultipleOptionsCriteria: string
Title:
Multiple Options Criteria
Maximum Length:1
Default Value:H
Value that indicates more than one pricing rule basis is selected. -
TransferPricePricingStrategyBasisFlag: boolean
Title:
Pricing Strategy Basis
Maximum Length:1
Default Value:false
Value that identifies if the pricing strategy is selected as the price basis for the transfer pricing rule. -
TransferPriceSourceDocumentMarkupType: string
Title:
Document Price Basis Markup Type
Maximum Length:30
Value that identifies the markup type selected by the user on the source document price. -
TransferPriceSourceDocumentMarkupValue: number
Title:
Markup Percentage
Value that identifies the markup percentage on the source document if the source document is selected as the markup type. -
TransferPriceSourceDocumentPriceBasisFlag: boolean
Title:
Source Document Price Basis
Maximum Length:1
Default Value:false
Value that identifies the pricing option as source document basis for the transfer pricing rule. -
TransferPriceTransactionCostBasisFlag: boolean
Title:
Transaction Cost Basis
Maximum Length:1
Default Value:false
Value that identifies the transaction cost is the pricing basis for the transfer pricing rule. -
TransferPriceUseSalesOrderpriceDropshipFlag: boolean
Title:
Use Sales Order Price for Drop Ship
Maximum Length:1
Default Value:false
Value that identifies to use the sales order price as document basis for drop ship transactions.
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.
Root Schema : financialOrchestrationTransferPricingRules-item-response
Type:
Show Source
object
-
EffectiveEndDate: string
(date)
Title:
Effective End Date
Value that identifies the effective end date of the transfer pricing rule. -
EffectiveEndDateDisplay: string
(date)
Title:
Effective End Date
Value that identifies the effective end date of the transfer pricing rule in the display format. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
Value that identifies the effective start date of the transfer pricing rule. -
EffectiveStartDateDisplay: string
(date)
Title:
Effective Start Date
Value that identifies the effective start date of the transfer pricing rule in the display format. -
InitialEffectiveEndDate: string
(date)
Read Only:
true
Value that identifies the initial effective end date of the transfer pricing rule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MarkupValue: number
Value that identifies the markup value of the transfer pricing rule.
-
ObjectVersionNumber: integer
(int32)
Value that uniquely identifies the object version number.
-
Operation: string
Maximum Length:
255
Indicates that the user has performed the insert action as part of the transaction. -
PricingId: integer
(int64)
Value that uniquely identifies the transfer pricing rule.
-
PricingOptionDescription: string
Title:
Description
Maximum Length:200
Value that identifies the description of the transfer pricing option. -
PricingOptionName: string
Title:
Name
Maximum Length:100
Value that identifies the name of the transfer pricing option. -
SelectedTransferPriceBasis: string
Maximum Length:
255
Value that identifies the price basis that's selected for the transfer pricing option. -
TpItemCostBasisFlag: boolean
Title:
Item Cost Basis
Maximum Length:1
Default Value:false
Value that identifies the pricing option as item cost basis for the transfer pricing rule. -
TpItemCostMarkupValue: number
Title:
Markup Percentage
Value that identifies the markup percentage on the item cost if item cost is selected as the markup type. -
TransferPriceCostBasisMarkupType: string
Title:
Cost Basis Markup Type
Maximum Length:30
Value that identifies the markup type selected by the user on the transaction cost. -
TransferPriceCostBasisMarkupValue: number
Title:
Markup Percentage
Value that identifies the markup percentage on the transaction cost if transaction cost is selected as the markup type. -
TransferPriceMultipleOptionsCriteria: string
Title:
Multiple Options Criteria
Maximum Length:1
Default Value:H
Value that indicates more than one pricing rule basis is selected. -
TransferPricePricingStrategyBasisFlag: boolean
Title:
Pricing Strategy Basis
Maximum Length:1
Default Value:false
Value that identifies if the pricing strategy is selected as the price basis for the transfer pricing rule. -
TransferPriceSourceDocumentMarkupType: string
Title:
Document Price Basis Markup Type
Maximum Length:30
Value that identifies the markup type selected by the user on the source document price. -
TransferPriceSourceDocumentMarkupValue: number
Title:
Markup Percentage
Value that identifies the markup percentage on the source document if the source document is selected as the markup type. -
TransferPriceSourceDocumentPriceBasisFlag: boolean
Title:
Source Document Price Basis
Maximum Length:1
Default Value:false
Value that identifies the pricing option as source document basis for the transfer pricing rule. -
TransferPriceTransactionCostBasisFlag: boolean
Title:
Transaction Cost Basis
Maximum Length:1
Default Value:false
Value that identifies the transaction cost is the pricing basis for the transfer pricing rule. -
TransferPriceUseSalesOrderpriceDropshipFlag: boolean
Title:
Use Sales Order Price for Drop Ship
Maximum Length:1
Default Value:false
Value that identifies to use the sales order price as document basis for drop ship transactions.
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.