Get all financial orchestration transfer pricing rules
get
/fscmRestApi/resources/11.13.18.05/financialOrchestrationTransferPricingRules
Request
Query Parameters
-
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- AsofDateRows Finds all the transfer pricing rules that are effective based on the AsofDate.
Finder Variables- bSearchAsofDate; string; Finds the transfer pricing rule that's effective based on the AsofDate.
- PrimaryKey Finds a financial orchestration transfer pricing rule with the specified primary key.
Finder Variables- EffectiveEndDate; string; Value that identifies the effective end date of the transfer pricing rule
- EffectiveStartDate; string; Value that identifies the effective start date of the transfer pricing rule
- PricingId; integer; Unique identifier of the financial orchestration transfer pricing rule.
- AsofDateRows Finds all the transfer pricing rules that are effective based on the AsofDate.
-
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:- AccountingTransferPriceBasis; string; Value that identifies the accounting transfer price basis of the transfer pricing rule.
- EffectiveEndDate; string; Date Effective Entity: indicates the date at the end of the date range within which the row is effective.
- EffectiveEndDateDisplay; string; Indicates the display date at the end of the date range within which the row is effective.
- EffectiveStartDate; string; Date Effective Entity: indicates the date at the beginning of the date range within which the row is effective.
- PricingOptionDescription; string; Brief description of the transfer pricing option.
- PricingOptionName; string; Value that uniquely identifies the name of the pricing option.
- PricingOptionSearchAsOfDate; string; Value that identifies the effective date selected by the user.
- TpItemCostBasisFlag; boolean; 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; Indicates the markup value on the item cost.
- TransferPriceCostBasisMarkupValue; number; Identifies the standard markup value on the transaction cost for the accounting transfer price.
- TransferPriceSourceDocumentMarkupValue; number; Indicates the standard markup value on the source document price.
- TransferPriceSourceDocumentPriceBasisFlag; boolean; 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; 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.
-
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:
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
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 : 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.