Get an incentive formula
get
/fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}
Request
Path Parameters
-
IncentiveFormulaId(required): integer(int64)
The unique identifier for the incentive formula record. There can be only one incentive formula for one plan component.
-
planComponentsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- PlanComponentId and OrgId ---for the Plan Components resource and used to uniquely identify an instance of Plan Components. The client should not generate the hash key value. Instead, the client should query on the Plan Components collection resource with a filter on the primary key values in order to navigate to a specific instance of Plan Components.
For example: planComponents?q=PlanComponentId=<value1>;OrgId=<value2>
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 : planComponents-planComponentIncentiveFormulas-item-response
Type:
Show Source
object
-
CalculateEnddateParticipantFlag: boolean
Title:
Calculate end-dated participants
Indicates whether participants who have an end date before the current calculation period are considered for calculation. Possible values include FALSE and TRUE. A list of acceptable values is defined in the lookup CN_YES_NO. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. This is only applicable if Calculate Incentive field is Per interval ('BONUS'). -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
IncentiveFormulaExpressionDescription: string
Title:
Expression Description
Read Only:true
Maximum Length:1000
The additional details added by the user related to plan component incentive formulas. -
IncentiveFormulaExpressionId: integer
(int64)
Title:
Output Expression ID
The unique identifier of the expression record used in the incentive formula. This is the expression that is used to calculate the earnings. -
IncentiveFormulaExpressionName: string
Title:
Expression Name
Maximum Length:160
The name for the expression used in the incentive formula. This is the expression that is used to calculate the earnings. -
IncentiveFormulaId: integer
(int64)
The unique identifier for the incentive formula record. There can be only one incentive formula for one plan component.
-
IncludeIndirectCredits: string
Title:
Include Indirect Credits
Type of indirect credits to include in the calculation, for the plan component. Possible values include ALL for all indirect credits that are included for attainment or earnings calculation for this plan component, MGR for only rollup indirect credits that are included for attainment or earnings calculation for this plan component, NONE for no indirect credits that are included for attainment or earnings calculation for this plan component, and TEAM for only team indirect credits that are included for attainment or earnings calculation for this plan component. The default value is NONE. A list of acceptable values is defined in the lookup CN_PLAN_INDIRECT_CREDIT. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PayoutFrequency: string
Title:
Payout Frequency
Default Value:-1000
This is the interval value that determines how often the earning is calculated. Interval would represent a unit of time like month, quarter, year. The default value is '-1000'. -
PlanComponentId: integer
(int64)
Title:
Plan Component ID
Read Only:true
The unique identifier of the plan component record within a business unit. -
PlanComponentIncentiveFormulaId: integer
(int64)
Read Only:
true
The unique identifier of the incentive formula record for the plan component. -
PlanComponentIncentiveFormulasDeleteFlag: boolean
Read Only:
true
Default Value:false
Indicates whether a plan component incentive formula can be deleted. -
planComponentRateDimensionalInputs: array
Plan Component - Rate Dimensional Input Expressions
Title:
Plan Component - Rate Dimensional Input Expressions
The plan component - rate dimensional input expressions resource is used to update the association of a input expression with a plan component. It can also be used to display all the details of input expressions associated with a plan component. This record specifies the inputs of a rate dimension of a rate table and provides additional details at this level. A valid expression which also has a valid usage needs to exist before creating this record. You should assign the input expression only after the rate table is assigned. -
planComponentRateTables: array
Plan Component - Rate Tables
Title:
Plan Component - Rate Tables
The plan component - rate tables resource is used to create, update or delete the association of a rate table with a plan component. It can also be used to display all the details of rate table associated with a performance measure. This record links the rate table to a performance measure and provides additional details at this level. A rate table needs to exist before creating this record. The rate table association can be created only after an incentive formula is created. -
RenderedIncentiveFormulaExpression: string
(byte)
Title:
Rendered Expression
Read Only:true
The entire incentive formula expression with all the expression components like operators, attributes, functions, etc. This is primarily used to display the entire expression. -
ResetInterval: integer
(int64)
Title:
Reset Interval
It is the span of time for which the true up or cumulative earnings are calculated. Interval would represent a unit of time like month, quarter, year. This is applicable only if True Up is Y. -
TrueUpFlag: boolean
Title:
True up
Maximum Length:1
Indicates whether the earnings calculated for the current period includes the previously calculated or paid amount (Cumulative.) Calculation engine then automatically subtracts previous earnings from the current earning calculated. Possible values include FALSE and TRUE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Plan Component - Rate Dimensional Input Expressions
Type:
array
Title:
Plan Component - Rate Dimensional Input Expressions
The plan component - rate dimensional input expressions resource is used to update the association of a input expression with a plan component. It can also be used to display all the details of input expressions associated with a plan component. This record specifies the inputs of a rate dimension of a rate table and provides additional details at this level.
A valid expression which also has a valid usage needs to exist before creating this record. You should assign the input expression only after the rate table is assigned.
Show Source
Nested Schema : Plan Component - Rate Tables
Type:
array
Title:
Plan Component - Rate Tables
The plan component - rate tables resource is used to create, update or delete the association of a rate table with a plan component. It can also be used to display all the details of rate table associated with a performance measure. This record links the rate table to a performance measure and provides additional details at this level.
A rate table needs to exist before creating this record. The rate table association can be created only after an incentive formula is created.
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 : planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
IncentiveFormulaId: integer
(int64)
Title:
Incentive Formula ID
The unique identifier of the incentive formula record. There can be only one incentive formula for one plan component. -
InputExpressionDescription: string
Title:
Input Expression Description
Read Only:true
Maximum Length:1000
The description of the input expression entered while creating the expression. -
InputExpressionId: integer
(int64)
Title:
Input Expression ID
The unique identifier of the input expression for the rate dimension of a rate table. -
InputExpressionName: string
Title:
Input Expression Name
Maximum Length:160
The name of the input expression for the rate dimension of a rate table used in the plan component. The input expression drives a value to evaluate from the transaction and matches the results with the corresponding rate table dimension. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanComponentId: integer
Read Only:
true
The unique identifier of the plan component record within a business unit. -
PlanComponentInputExpressionId: integer
(int64)
Title:
Plan Component Input Expression Id
The unique identifier of the input expression record for the plan component. -
PlanComponentRateDimensionalInputsDeleteFlag: boolean
Read Only:
true
Default Value:false
Indicates whether the rate dimension input can be deleted. -
RateDimName: integer
Title:
Dimension Name
Read Only:true
The name of the rate dimension. A rate table can have one or more rate dimensions. -
RateDimSequence: integer
(int64)
Title:
Sequence
The order of the input expressions for the rate table. -
SplitFlag: boolean
Title:
Split
Maximum Length:1
Default Value:false
When splitting the rate across tiers, the split option can apply to only one rate dimension input expression. This specifies which rate dimension input expression (rate dimension) to use. Possible values are FALSE and TRUE. The default value is FALSE.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : planComponents-planComponentIncentiveFormulas-planComponentRateTables-item-response
Type:
Show Source
object
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the record was created. -
EndDate: string
(date)
Title:
End Date
The date when the rate table becomes inactive for the plan component. The format is yyyy-mm-dd. -
IncentiveFormulaId: integer
(int64)
Title:
Incentive Formula ID
The unique identifier for the incentive formula record. There can be only one incentive formula for one plan component. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The session login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PlanComponentId: integer
Read Only:
true
The unique identifier for the plan component record within a business unit. -
PlanComponentName: string
Title:
Plan Component Name
Read Only:true
The name of a plan component, which defines the earnings of a participant based on their performance. -
PlanComponentRateTableId: integer
(int64)
The unique identifier of the rate table associated to the plan component.
-
RateTableDescription: string
Title:
Description
Read Only:true
Maximum Length:1000
The description of the rate table. -
RateTableId: integer
(int64)
Title:
Rate Table ID
The unique identifier of the rate table. -
RateTableName: string
Title:
Rate Table Name
Maximum Length:80
The name of a rate table. A rate table is used to establish compensation percentage rates or fixed amounts for different performance levels. -
StartDate: string
(date)
Title:
Start Date
The date when the rate table becomes active for the plan component. The format is yyyy-mm-dd.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- IncludeIndirectCreditsVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_PLAN_INDIRECT_CREDIT
The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing. - finder:
- planComponentRateDimensionalInputs
-
Parameters:
- IncentiveFormulaId:
$request.path.IncentiveFormulaId
- planComponentsUniqID:
$request.path.planComponentsUniqID
The plan component - rate dimensional input expressions resource is used to update the association of a input expression with a plan component. It can also be used to display all the details of input expressions associated with a plan component. This record specifies the inputs of a rate dimension of a rate table and provides additional details at this level. A valid expression which also has a valid usage needs to exist before creating this record. You should assign the input expression only after the rate table is assigned. - IncentiveFormulaId:
- planComponentRateTables
-
Parameters:
- IncentiveFormulaId:
$request.path.IncentiveFormulaId
- planComponentsUniqID:
$request.path.planComponentsUniqID
The plan component - rate tables resource is used to create, update or delete the association of a rate table with a plan component. It can also be used to display all the details of rate table associated with a performance measure. This record links the rate table to a performance measure and provides additional details at this level. A rate table needs to exist before creating this record. The rate table association can be created only after an incentive formula is created. - IncentiveFormulaId: