Create a plan component
post
/fscmRestApi/resources/11.13.18.05/planComponents
Request
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.
-
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
-
CalculateIncentive(required): string
Title:
Calculate Incentive
Maximum Length:30
The nature of plan component earning calculation, per event or per interval. Per event indicates that an earning will be generated each time there is an eligible credit. Per interval indicates that all eligible credits for the interval will be aggregated to generate one earning for the interval. Possible values include COMMISSION for per event, and BONUS for per interval. A list of acceptable values is defined in the lookup CN_PLAN_INCENTIVE_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
CalculationPhase: integer
(int32)
Title:
Calculation Phase
Default Value:1
The phase in which the application considers plan component for calculation. Two supported phases: Phase 1 and Phase 2. Possible values include 1 and 2.The default value is 1. A list of acceptable values is defined in the lookup CN_CALCULATION_PHASE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
Description: string
Title:
Description
Maximum Length:1000
The additional details added by the user related to a plan component. -
DisplayName: string
Title:
Display Name
Maximum Length:80
The optional name of the plan component that is shown to the sales representatives user interface screens to represent this plan component. -
EarningType: number
Title:
Earning Type
Default Value:-1000
The attribute used to classify earnings into monetary and nonmonetary categories. Possible values represent Monetary earnings, Points, Air miles. This value is dependent on the OrgId so it should be passed after the OrgId value. The default value is Monetary Earnings ('-1000'). -
EndDate(required): string
(date)
Title:
End Date
The date when the plan component becomes inactive. The format is yyyy-mm-dd. -
IncentiveType(required): string
Title:
Incentive Type
Maximum Length:30
The attribute representing the incentive type, such as bonus or commission. Possible values include BONUS, COMMISSION, and STANDARD. A list of acceptable values is defined in the lookup CN_REPORT_GROUP. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
Name(required): string
Title:
Plan Component Name
Maximum Length:80
The name of a plan component, which defines the earnings of a participant based on their performance. -
OrgId(required): integer
(int64)
Title:
Business Unit
The unique identifier of the business unit. -
PaymentMadeThroughThirdPartyFlag: boolean
Title:
Payment Made Through Third Party
Maximum Length:1
Default Value:false
Indicates whether the payment for this plan component can be made through other resources. Possible values include N or FALSE and Y or TRUE. The default value is FALSE. 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. -
PaymentPlanCategory: string
Title:
Payment Plan Category
Maximum Length:30
Default Value:STANDARD
The payment plan category which is used to allocate payment adjustments from a participant's payment plan among plan components. Possible values include BONUS for remuneration for services rendered, products sold, or for extra performance, COMMISSION for remuneration for services rendered or products sold, a common way to reward sales people, GUARANTEE for the minimum amount that a commission sales person is guaranteed to receive for a given period of time, and STANDARD which is a generic term applied to any plan component used for determining payment plan adjustments. The default value is STANDARD. A list of acceptable values is defined in the lookup CN_PAYMENT_PLAN_CATEGORY . Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
PlanComponentId: integer
(int64)
Title:
Plan Component ID
The unique identifier of the plan component record within a business unit. -
planComponentIncentiveFormulas: array
Plan Component - Incentive Formulas
Title:
Plan Component - Incentive Formulas
The plan component - incentive formulas resource is used to update the association of an incentive formula to the plan component. It can also be used to display all the details of a incentive formula associated to a plan component. This record specifies the formula used to calculate the earnings and provides additional details at this level. This is created automatically, without any values, when a plan component is created and has to be updated later. -
planComponentPerformanceMeasures: array
Plan Component - Performance Measures
Title:
Plan Component - Performance Measures
The plan component - performance measures resource is used to create, update or delete the association of a performance measure with a plan component. It can also be used to display all the details of performance measures under a plan component. A plan component - performance measure record links the performance measure to a plan component and provides additional details at this level. A performance measure needs to exist before creating this record. -
planComponentsDFF: array
Plan Component Descriptive Flex Fields
Title:
Plan Component Descriptive Flex Fields
The plan component - descriptive flex fields resource is used to store user defined values for the plan component. A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task. -
SplitOption: string
Title:
Split Option
Indicates how to split the input number to a rate table dimension. Possible values include NONE to apply a single rate for the entire attainment, NON PROPORTIONAL to apply multiple rates, which are fixed for an attainment within a tier, and PROPORTIONAL to apply multiple rates, which are proportional for an attainment within a tier. The default value is NONE. A list of acceptable values is defined in the lookup CN_SPLIT_TYPE_OPTION. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
StartDate(required): string
(date)
Title:
Start Date
The date when the plan component becomes active. The format is yyyy-mm-dd. -
ValidForCalculation: string
Title:
Valid for Calculation
Maximum Length:30
Default Value:INCOMPLETE
Indicates whether the plan component is ready for calculation. Possible values include COMPLETE for valid and ready for calculation and INCOMPLETE for not valid and not ready for calculation. The default value is INCOMPLETE. A list of acceptable values is defined in the lookup CN_FORMULA_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
Nested Schema : Plan Component - Incentive Formulas
Type:
array
Title:
Plan Component - Incentive Formulas
The plan component - incentive formulas resource is used to update the association of an incentive formula to the plan component. It can also be used to display all the details of a incentive formula associated to a plan component. This record specifies the formula used to calculate the earnings and provides additional details at this level.
This is created automatically, without any values, when a plan component is created and has to be updated later.
Show Source
Nested Schema : Plan Component - Performance Measures
Type:
array
Title:
Plan Component - Performance Measures
The plan component - performance measures resource is used to create, update or delete the association of a performance measure with a plan component. It can also be used to display all the details of performance measures under a plan component. A plan component - performance measure record links the performance measure to a plan component and provides additional details at this level.
A performance measure needs to exist before creating this record.
Show Source
Nested Schema : Plan Component Descriptive Flex Fields
Type:
array
Title:
Plan Component Descriptive Flex Fields
The plan component - descriptive flex fields resource is used to store user defined values for the plan component. A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.
Show Source
Nested Schema : planComponents-planComponentIncentiveFormulas-item-post-request
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'). -
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. -
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'. -
planComponentRateDimensionalInputs: array
planComponentRateDimensionalInputs
-
planComponentRateTables: array
planComponentRateTables
-
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 : planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-post-request
Type:
Show Source
object
-
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. -
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. -
PlanComponentInputExpressionId: integer
(int64)
Title:
Plan Component Input Expression Id
The unique identifier of the input expression record for the plan component. -
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 : schema
Type:
Show Source
object
-
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. -
PlanComponentRateTableId: integer
(int64)
The unique identifier of the rate table associated to the plan component.
-
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 : schema
Type:
Show Source
object
-
CalculationSequence: integer
(int32)
Title:
Calculation Sequence
Default Value:1
The order in which the calculation engine considers a performance measure within a plan component. This is set when dependent measures refer to the calculated results of other base measures. Dependent measures must have a higher calculation sequence than base measures. -
EarningBasis: string
Title:
Earning Basis
Maximum Length:1
Default Value:Y
Specifies whether attainment and earnings calculations use the same credit categories and whether the incentive formula uses the measure attainment in calculations. Possible values include Y, N. Keep it Y, references the performance measure attainment in the incentive formula expression of the plan component. Earning basis must be Y when a performance measure that processes transactions individually is associated with plan components that calculate incentive per event. 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. -
PerformanceMeasureId: integer
(int64)
Title:
Performance Measure ID
The unique identifier of a performance measure record. -
PerformanceMeasureWeight: integer
(int64)
Title:
Weight
Default Value:100
The percentage of influence a performance measure has on the plan component. -
PlanComponentId: integer
(int64)
Title:
Plan Component ID
The unique identifier of the plan component record within a business unit. -
PlanComponentPerformanceMeasureId: integer
(int64)
The unique identifier for the performance measure record associated with the plan component.
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
This field represents the flex context segment code for the plan component. It determines which context-sensitive segments are displayed. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
This field represents the flex context segment display name for the plan component. It determines which context-sensitive segments are displayed. -
OrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit organisation. -
PlanComponentId: integer
(int64)
The unique identifier for the plan component record within a business unit.
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 : planComponents-item-response
Type:
Show Source
object
-
CalculateIncentive: string
Title:
Calculate Incentive
Maximum Length:30
The nature of plan component earning calculation, per event or per interval. Per event indicates that an earning will be generated each time there is an eligible credit. Per interval indicates that all eligible credits for the interval will be aggregated to generate one earning for the interval. Possible values include COMMISSION for per event, and BONUS for per interval. A list of acceptable values is defined in the lookup CN_PLAN_INCENTIVE_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
CalculationPhase: integer
(int32)
Title:
Calculation Phase
Default Value:1
The phase in which the application considers plan component for calculation. Two supported phases: Phase 1 and Phase 2. Possible values include 1 and 2.The default value is 1. A list of acceptable values is defined in the lookup CN_CALCULATION_PHASE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
Description: string
Title:
Description
Maximum Length:1000
The additional details added by the user related to a plan component. -
DisplayName: string
Title:
Display Name
Maximum Length:80
The optional name of the plan component that is shown to the sales representatives user interface screens to represent this plan component. -
EarningType: number
Title:
Earning Type
Default Value:-1000
The attribute used to classify earnings into monetary and nonmonetary categories. Possible values represent Monetary earnings, Points, Air miles. This value is dependent on the OrgId so it should be passed after the OrgId value. The default value is Monetary Earnings ('-1000'). -
EndDate: string
(date)
Title:
End Date
The date when the plan component becomes inactive. The format is yyyy-mm-dd. -
IncentiveType: string
Title:
Incentive Type
Maximum Length:30
The attribute representing the incentive type, such as bonus or commission. Possible values include BONUS, COMMISSION, and STANDARD. A list of acceptable values is defined in the lookup CN_REPORT_GROUP. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
InvalidReason: string
Title:
Reason
Read Only:true
The reason explaining why the plan component is invalid. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
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. -
Name: string
Title:
Plan Component Name
Maximum Length:80
The name of a plan component, which defines the earnings of a participant based on their performance. -
NumberOfDimensions: integer
Title:
Number of Dimensions
Read Only:true
The number of dimensions of the rate table used in the plan component. -
OrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit. -
PaymentMadeThroughThirdPartyFlag: boolean
Title:
Payment Made Through Third Party
Maximum Length:1
Default Value:false
Indicates whether the payment for this plan component can be made through other resources. Possible values include N or FALSE and Y or TRUE. The default value is FALSE. 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. -
PaymentPlanCategory: string
Title:
Payment Plan Category
Maximum Length:30
Default Value:STANDARD
The payment plan category which is used to allocate payment adjustments from a participant's payment plan among plan components. Possible values include BONUS for remuneration for services rendered, products sold, or for extra performance, COMMISSION for remuneration for services rendered or products sold, a common way to reward sales people, GUARANTEE for the minimum amount that a commission sales person is guaranteed to receive for a given period of time, and STANDARD which is a generic term applied to any plan component used for determining payment plan adjustments. The default value is STANDARD. A list of acceptable values is defined in the lookup CN_PAYMENT_PLAN_CATEGORY . Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
PlanComponentId: integer
(int64)
Title:
Plan Component ID
The unique identifier of the plan component record within a business unit. -
planComponentIncentiveFormulas: array
Plan Component - Incentive Formulas
Title:
Plan Component - Incentive Formulas
The plan component - incentive formulas resource is used to update the association of an incentive formula to the plan component. It can also be used to display all the details of a incentive formula associated to a plan component. This record specifies the formula used to calculate the earnings and provides additional details at this level. This is created automatically, without any values, when a plan component is created and has to be updated later. -
planComponentPerformanceMeasures: array
Plan Component - Performance Measures
Title:
Plan Component - Performance Measures
The plan component - performance measures resource is used to create, update or delete the association of a performance measure with a plan component. It can also be used to display all the details of performance measures under a plan component. A plan component - performance measure record links the performance measure to a plan component and provides additional details at this level. A performance measure needs to exist before creating this record. -
planComponentsDFF: array
Plan Component Descriptive Flex Fields
Title:
Plan Component Descriptive Flex Fields
The plan component - descriptive flex fields resource is used to store user defined values for the plan component. A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task. -
SplitOption: string
Title:
Split Option
Indicates how to split the input number to a rate table dimension. Possible values include NONE to apply a single rate for the entire attainment, NON PROPORTIONAL to apply multiple rates, which are fixed for an attainment within a tier, and PROPORTIONAL to apply multiple rates, which are proportional for an attainment within a tier. The default value is NONE. A list of acceptable values is defined in the lookup CN_SPLIT_TYPE_OPTION. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
StartDate: string
(date)
Title:
Start Date
The date when the plan component becomes active. The format is yyyy-mm-dd. -
ValidForCalculation: string
Title:
Valid for Calculation
Maximum Length:30
Default Value:INCOMPLETE
Indicates whether the plan component is ready for calculation. Possible values include COMPLETE for valid and ready for calculation and INCOMPLETE for not valid and not ready for calculation. The default value is INCOMPLETE. A list of acceptable values is defined in the lookup CN_FORMULA_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Plan Component - Incentive Formulas
Type:
array
Title:
Plan Component - Incentive Formulas
The plan component - incentive formulas resource is used to update the association of an incentive formula to the plan component. It can also be used to display all the details of a incentive formula associated to a plan component. This record specifies the formula used to calculate the earnings and provides additional details at this level.
This is created automatically, without any values, when a plan component is created and has to be updated later.
Show Source
Nested Schema : Plan Component - Performance Measures
Type:
array
Title:
Plan Component - Performance Measures
The plan component - performance measures resource is used to create, update or delete the association of a performance measure with a plan component. It can also be used to display all the details of performance measures under a plan component. A plan component - performance measure record links the performance measure to a plan component and provides additional details at this level.
A performance measure needs to exist before creating this record.
Show Source
Nested Schema : Plan Component Descriptive Flex Fields
Type:
array
Title:
Plan Component Descriptive Flex Fields
The plan component - descriptive flex fields resource is used to store user defined values for the plan component. A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.
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-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 : 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
Nested Schema : planComponents-planComponentPerformanceMeasures-item-response
Type:
Show Source
object
-
CalculationSequence: integer
(int32)
Title:
Calculation Sequence
Default Value:1
The order in which the calculation engine considers a performance measure within a plan component. This is set when dependent measures refer to the calculated results of other base measures. Dependent measures must have a higher calculation sequence than base measures. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
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. -
EarningBasis: string
Title:
Earning Basis
Maximum Length:1
Default Value:Y
Specifies whether attainment and earnings calculations use the same credit categories and whether the incentive formula uses the measure attainment in calculations. Possible values include Y, N. Keep it Y, references the performance measure attainment in the incentive formula expression of the plan component. Earning basis must be Y when a performance measure that processes transactions individually is associated with plan components that calculate incentive per event. 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. -
EndDate: string
(date)
Title:
End Date
Read Only:true
The date when the performance measure associated with the performance measure becomes inactive. This is a read only field. The performance measure takes the date of the plan component. The format is yyyy-mm-dd. -
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:64
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. -
PerformanceInterval: string
Title:
Performance Interval
Read Only:true
Default Value:-1000
This is the interval value for the performance measurement. Where running total is considered, the accumulated value is reset based on this interval value. Interval would represent a unit of time like month, quarter, year. The default value is '-1000'. -
PerformanceMeasureId: integer
(int64)
Title:
Performance Measure ID
The unique identifier of a performance measure record. -
PerformanceMeasureName: string
Title:
Performance Measure Name
Read Only:true
Maximum Length:80
The name of a performance measure, which is an indicator used to measure the progress toward a specified outcome or goal. -
PerformanceMeasureWeight: integer
(int64)
Title:
Weight
Default Value:100
The percentage of influence a performance measure has on the plan component. -
PlanComponentId: integer
(int64)
Title:
Plan Component ID
The unique identifier of the plan component record within a business unit. -
PlanComponentName: string
Title:
Plan Component Name
Read Only:true
Maximum Length:80
The name of a plan component, which defines the earnings of a participant based on their performance. -
PlanComponentPerformanceMeasureId: integer
(int64)
The unique identifier for the performance measure record associated with the plan component.
-
ProcessTransactions: string
Title:
Process Transactions
Read Only:true
Maximum Length:30
Indicates how the application processes transactions in a measure. The possible values include GROUP for Group transactions for the specified interval, for attainment calculation and INDIVIDUAL for evaluating each transaction independently, for attainment calculation. A list of acceptable values is defined in the lookup CN_PROCESS_TXN. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
StartDate: string
(date)
Title:
Start Date
Read Only:true
The date when the performance measure associated with the performance measure becomes active. This is a read only field. The performance measure takes the date of the plan component. The format is yyyy-mm-dd. -
UnitOfMeasure: string
Title:
Unit of Measure
Read Only:true
Maximum Length:30
Default Value:AMOUNT
The standardized quantity used as a factor to express occurring quantities of the performance measure property. Possible values include AMOUNT for measure attainment is based on an amount, PERCENT for measure attainment is based on a percent, QUANTITY for measure attainment is based on a quantity, and SCORE for measure attainment is based on a score. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_MEASURE_UOM. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. -
ValidForCalculation: string
Title:
Valid for Calculation
Read Only:true
Maximum Length:30
Default Value:INCOMPLETE
Indicates whether the performance measure is ready for calculation. Possible values include COMPLETE for valid and ready for calculation and INCOMPLETE for invalid and not ready for calculation. The default value is INCOMPLETE. A list of acceptable values is defined in the lookup CN_COMP_PLAN_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : planComponents-planComponentsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
This field represents the flex context segment code for the plan component. It determines which context-sensitive segments are displayed. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
This field represents the flex context segment display name for the plan component. It determines which context-sensitive segments are displayed. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrgId: integer
(int64)
Title:
Business Unit
The unique identifier of the business unit organisation. -
PlanComponentId: integer
(int64)
The unique identifier for the plan component record within a business unit.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- ApplySplitLookup
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_SPLIT_TYPE_OPTION
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:
- BusinessUnitPVO
-
The business units list of values resource is used to view the list of defined business units.
- CnLookupCalculateIncentiveVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_PLAN_INCENTIVE_TYPE
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:
- CnLookupCalculationPhaseVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_CALCULATION_PHASE
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:
- CnLookupIncentiveTypeVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_REPORT_GROUP
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:
- CnLookupPaymentPlanCategory
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_PAYMENT_PLAN_CATEGORY
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:
- CnLookupValidForCalculationVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_COMP_PLAN_STATUS
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:
- CnLookupYesNoVO
-
Parameters:
- finder:
LookupTypeFinder%3BLookupType%3DCN_YES_NO
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:
- EarningTypesVO
-
Parameters:
- finder:
LookupTypeFinder
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:
- planComponentIncentiveFormulas
-
Parameters:
- planComponentsUniqID:
$request.path.planComponentsUniqID
The plan component - incentive formulas resource is used to update the association of an incentive formula to the plan component. It can also be used to display all the details of a incentive formula associated to a plan component. This record specifies the formula used to calculate the earnings and provides additional details at this level. This is created automatically, without any values, when a plan component is created and has to be updated later. - planComponentsUniqID:
- planComponentPerformanceMeasures
-
Parameters:
- planComponentsUniqID:
$request.path.planComponentsUniqID
The plan component - performance measures resource is used to create, update or delete the association of a performance measure with a plan component. It can also be used to display all the details of performance measures under a plan component. A plan component - performance measure record links the performance measure to a plan component and provides additional details at this level. A performance measure needs to exist before creating this record. - planComponentsUniqID:
- planComponentsDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentsDFFParameters:
- planComponentsUniqID:
$request.path.planComponentsUniqID
The plan component - descriptive flex fields resource is used to store user defined values for the plan component. A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task. - planComponentsUniqID:
Examples
The following example shows how to create a plan component by submitting a POST request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X POST -d
@example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/planComponents
Example of Request Body
The following example shows the contents of the request body in JSON format.
{ "Name": "Sales Plan Bonus", "Description": "dd", "CalculateIncentive": "BONUS", "OrgId": 204, "EarningType": -1000, "StartDate": "2016-01-01", "EndDate": "2016-12-31", "CalculationPhase": 1, "IncentiveType": "BONUS", "PaymentPlanCategory": "STANDARD", "PaymentMadeThroughThirdPartyFlag": false, "DisplayName": "Sales Plan Bonus" }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "PlanComponentId": 300100090511050, "Name": "Sales Plan Bonus", "Description": "dd", "CalculateIncentive": "BONUS", "OrgId": 204, "EarningType": -1000, "StartDate": "2016-01-01", "EndDate": "2016-12-31", "CalculationPhase": 1, "IncentiveType": "BONUS", "PaymentPlanCategory": "STANDARD", "PaymentMadeThroughThirdPartyFlag": false, "LastUpdateDate": "2017-06-08T12:32:10.253-07:00", "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "CreationDate": "2017-06-08T12:32:10.001-07:00", "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS", "LastUpdateLogin": "516E508C5BC4377FE0532DD6F00A0214", "DisplayName": "Sales Plan Bonus", "ValidForCalculation": "INCOMPLETE", "InvalidReason": "This plan component is not valid for calculation. Add at least one valid performance measure to make it valid. (CN-1575358)", "SplitOption": "NONE", "NumberOfDimensions": null, "links": [ ... ] }