Jump to

• Request
• Response
• Examples

Get a plan component

get

/fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}

Request

Path Parameters

• 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: string
  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: string
  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 Top

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.

Body ()

Root Schema : planComponents-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CalculateIncentive":{
            "title":"Calculate Incentive",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CalculationPhase":{
            "title":"Calculation Phase",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "controlType":"choice",
                "precision":9
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The additional details added by the user related to a plan component.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":80,
            "type":"string",
            "description":"The optional name of the plan component that is shown to the sales representatives user interface screens to represent this plan component.",
            "nullable":true,
            "x-queryable":true
        },
        "EarningType":{
            "title":"Earning Type",
            "type":"number",
            "description":"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').",
            "nullable":false,
            "default":-1000,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "OrgId"
                ]
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the plan component becomes inactive. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "IncentiveType":{
            "title":"Incentive Type",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InvalidReason":{
            "title":"Reason",
            "type":"string",
            "description":"The reason explaining why the plan component is invalid.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Plan Component Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of a plan component, which defines the earnings of a participant based on their performance.",
            "nullable":false,
            "x-queryable":true
        },
        "NumberOfDimensions":{
            "title":"Number of Dimensions",
            "type":"integer",
            "description":"The number of dimensions of the rate table used in the plan component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "PaymentMadeThroughThirdPartyFlag":{
            "title":"Payment Made Through Third Party",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"radio"
            },
            "x-queryable":true
        },
        "PaymentPlanCategory":{
            "title":"Payment Plan Category",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"STANDARD",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PlanComponentId":{
            "title":"Plan Component ID",
            "type":"integer",
            "description":"The unique identifier of the plan component record within a business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SplitOption":{
            "title":"Split Option",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the plan component becomes active. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ValidForCalculation":{
            "title":"Valid for Calculation",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "default":"INCOMPLETE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "planComponentIncentiveFormulas":{
            "title":"Plan Component - Incentive Formulas",
            "type":"array",
            "description":"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.\nThis is created automatically, without any values, when a plan component is created and has to be updated later.",
            "items":{
                "$ref":"#/components/schemas/planComponents-planComponentIncentiveFormulas-item-response"
            }
        },
        "planComponentPerformanceMeasures":{
            "title":"Plan Component - Performance Measures",
            "type":"array",
            "description":"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.\nA performance measure needs to exist before creating this record.",
            "items":{
                "$ref":"#/components/schemas/planComponents-planComponentPerformanceMeasures-item-response"
            }
        },
        "planComponentsDFF":{
            "title":"Plan Component Descriptive Flex Fields",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/planComponents-planComponentsDFF-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object planComponents-planComponentIncentiveFormulas-item-response

{
    "title":"Plan Component - Incentive Formulas",
    "type":"array",
    "description":"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.\nThis is created automatically, without any values, when a plan component is created and has to be updated later.",
    "items":{
        "$ref":"#/components/schemas/planComponents-planComponentIncentiveFormulas-item-response"
    }
}

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

• Array of: object planComponents-planComponentPerformanceMeasures-item-response

{
    "title":"Plan Component - Performance Measures",
    "type":"array",
    "description":"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.\nA performance measure needs to exist before creating this record.",
    "items":{
        "$ref":"#/components/schemas/planComponents-planComponentPerformanceMeasures-item-response"
    }
}

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

• Array of: object planComponents-planComponentsDFF-item-response

{
    "title":"Plan Component Descriptive Flex Fields",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/planComponents-planComponentsDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : planComponents-planComponentIncentiveFormulas-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CalculateEnddateParticipantFlag":{
            "title":"Calculate end-dated participants",
            "type":"boolean",
            "description":"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').",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IncentiveFormulaExpressionDescription":{
            "title":"Expression Description",
            "maxLength":1000,
            "type":"string",
            "description":"The additional details added by the user related to plan component incentive formulas.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncentiveFormulaExpressionId":{
            "title":"Output Expression ID",
            "type":"integer",
            "description":"The unique identifier of the expression record used in the incentive formula. This is the expression that is used to calculate the earnings.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "IncentiveFormulaExpressionName":{
            "title":"Expression Name",
            "maxLength":160,
            "type":"string",
            "description":"The name for the expression used in the incentive formula. This is the expression that is used to calculate the earnings.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov",
                "dependencies":[
                    "ProcessTransactions"
                ]
            },
            "x-queryable":true
        },
        "IncentiveFormulaId":{
            "type":"integer",
            "description":"The unique identifier for the incentive formula record. There can be only one incentive formula for one plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "IncludeIndirectCredits":{
            "title":"Include Indirect Credits",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PayoutFrequency":{
            "title":"Payout Frequency",
            "type":"string",
            "description":"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'.",
            "nullable":true,
            "default":"-1000",
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "OrgId"
                ]
            },
            "x-queryable":true
        },
        "PlanComponentId":{
            "title":"Plan Component ID",
            "type":"integer",
            "description":"The unique identifier of the plan component record within a business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanComponentIncentiveFormulaId":{
            "type":"integer",
            "description":"The unique identifier of the incentive formula record for the plan component.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanComponentIncentiveFormulasDeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether a plan component incentive formula can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "RenderedIncentiveFormulaExpression":{
            "title":"Rendered Expression",
            "type":"string",
            "description":"The entire incentive formula expression with all the expression components like operators, attributes, functions, etc. This is primarily used to display the entire expression.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "ResetInterval":{
            "title":"Reset Interval",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "TrueUpFlag":{
            "title":"True up",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "planComponentRateDimensionalInputs":{
            "title":"Plan Component - Rate Dimensional Input Expressions",
            "type":"array",
            "description":"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.\nA 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.",
            "items":{
                "$ref":"#/components/schemas/planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-response"
            }
        },
        "planComponentRateTables":{
            "title":"Plan Component - Rate Tables",
            "type":"array",
            "description":"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.\nA rate table needs to exist before creating this record. The rate table association can be created only after an incentive formula is created.",
            "items":{
                "$ref":"#/components/schemas/planComponents-planComponentIncentiveFormulas-planComponentRateTables-item-response"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

• Array of: object planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-response

{
    "title":"Plan Component - Rate Dimensional Input Expressions",
    "type":"array",
    "description":"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.\nA 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.",
    "items":{
        "$ref":"#/components/schemas/planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-response"
    }
}

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

• Array of: object planComponents-planComponentIncentiveFormulas-planComponentRateTables-item-response

{
    "title":"Plan Component - Rate Tables",
    "type":"array",
    "description":"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.\nA rate table needs to exist before creating this record. The rate table association can be created only after an incentive formula is created.",
    "items":{
        "$ref":"#/components/schemas/planComponents-planComponentIncentiveFormulas-planComponentRateTables-item-response"
    }
}

Nested Schema : planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IncentiveFormulaId":{
            "title":"Incentive Formula ID",
            "type":"integer",
            "description":"The unique identifier of the incentive formula record. There can be only one incentive formula for one plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InputExpressionDescription":{
            "title":"Input Expression Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the input expression entered while creating the expression.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InputExpressionId":{
            "title":"Input Expression ID",
            "type":"integer",
            "description":"The unique identifier of the input expression for the rate dimension of a rate table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InputExpressionName":{
            "title":"Input Expression Name",
            "maxLength":160,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the plan component record within a business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentInputExpressionId":{
            "title":"Plan Component Input Expression Id",
            "type":"integer",
            "description":"The unique identifier of the input expression record for the plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanComponentRateDimensionalInputsDeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the rate dimension input can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "RateDimName":{
            "title":"Dimension Name",
            "type":"integer",
            "description":"The name of the rate dimension. A rate table can have one or more rate dimensions.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RateDimSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order of the input expressions for the rate table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SplitFlag":{
            "title":"Split",
            "maxLength":1,
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : planComponents-planComponentIncentiveFormulas-planComponentRateTables-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the rate table becomes inactive for the plan component. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "IncentiveFormulaId":{
            "title":"Incentive Formula ID",
            "type":"integer",
            "description":"The unique identifier for the incentive formula record. There can be only one incentive formula for one plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier for the plan component record within a business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentName":{
            "title":"Plan Component Name",
            "type":"string",
            "description":"The name of a plan component, which defines the earnings of a participant based on their performance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentRateTableId":{
            "type":"integer",
            "description":"The unique identifier of the rate table associated to the plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RateTableDescription":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the rate table.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableId":{
            "title":"Rate Table ID",
            "type":"integer",
            "description":"The unique identifier of the rate table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RateTableName":{
            "title":"Rate Table Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of a rate table. A rate table is used to establish compensation percentage rates or fixed amounts for different performance levels.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the rate table becomes active for the plan component. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : planComponents-planComponentPerformanceMeasures-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CalculationSequence":{
            "title":"Calculation Sequence",
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningBasis":{
            "title":"Earning Basis",
            "maxLength":1,
            "type":"string",
            "description":"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. \nKeep it Y, references the performance measure attainment in the incentive formula expression of the plan component. \nEarning 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.",
            "nullable":true,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceInterval":{
            "title":"Performance Interval",
            "type":"string",
            "description":"This is the interval value  for the performance measurement. Where running total is considered, the accumulated value is reset based on this interval value. \nInterval would represent a unit of time like month, quarter, year. The default value is '-1000'.",
            "nullable":true,
            "readOnly":true,
            "default":"-1000",
            "x-queryable":true
        },
        "PerformanceMeasureId":{
            "title":"Performance Measure ID",
            "type":"integer",
            "description":"The unique identifier of a performance measure record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "PerformanceMeasureName":{
            "title":"Performance Measure Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of a performance measure, which is an indicator used to measure the progress toward a specified outcome or goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceMeasureWeight":{
            "title":"Weight",
            "type":"integer",
            "description":"The percentage of influence a performance measure has on the plan component.",
            "format":"int64",
            "nullable":true,
            "default":100,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanComponentId":{
            "title":"Plan Component ID",
            "type":"integer",
            "description":"The unique identifier of the plan component record within a business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanComponentName":{
            "title":"Plan Component Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of a plan component, which defines the earnings of a participant based on their performance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentPerformanceMeasureId":{
            "type":"integer",
            "description":"The unique identifier for the performance measure record associated with the plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProcessTransactions":{
            "title":"Process Transactions",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "default":"AMOUNT",
            "x-queryable":true
        },
        "ValidForCalculation":{
            "title":"Valid for Calculation",
            "maxLength":30,
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "default":"INCOMPLETE",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : planComponents-planComponentsDFF-item-response

Type: object

Show Source

• __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.

{
    "type":"object",
    "properties":{
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit organisation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier for the plan component record within a business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"This field represents the flex context segment code for the plan component. It determines which context-sensitive segments are displayed.",
            "nullable":true,
            "x-hints":{
                "help":{
                    "instruction":"Context Segment"
                },
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"This field represents the flex context segment display name for the  plan component. It determines which context-sensitive segments are displayed.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "help":{
                    "instruction":"Context Segment"
                },
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Links

ApplySplitLookup

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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.

BusinessUnitPVO

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationBusinessUnitsLOV

The business units list of values resource is used to view the list of defined business units.

CnLookupCalculateIncentiveVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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.

CnLookupCalculationPhaseVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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.

CnLookupIncentiveTypeVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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.

CnLookupPaymentPlanCategory

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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.

CnLookupValidForCalculationVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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.

CnLookupYesNoVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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.

EarningTypesVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

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.

planComponentIncentiveFormulas

Operation: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/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.

planComponentPerformanceMeasures

Operation: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/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.

planComponentsDFF

Operation: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentsDFF

Parameters:

• 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.

Back to Top

Examples

The following example shows how to get a plan component by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/planComponents/00020000000EACED00057708000110F07F4ABECA0000000EACED0005770800000000000000CC

Example of Response Body

The following example shows the contents of the response body in JSON format.

{
"PlanComponentId": 300100090511050,
"Name": "Sales Plan Bonus",
"Description": "Sales Plan Bonus Plan Component",
"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-09T10:14:40.398-07:00",
"LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
"CreationDate": "2017-06-08T12:32:10.001-07:00",
"CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
"LastUpdateLogin": "5182A4E294CD57DBE0532DD6F00A0C82",
"DisplayName": "Sales Plan Bonus",
"ValidForCalculation": "INCOMPLETE",
"InvalidReason": "The plan component is not valid for calculation. (CN-1575371) Details: For the plan component to be valid for calculation, you must enter a rate table that is valid between the start date 2016-01-01 and end date 2016-12-31, to cover the duration of the plan component.",
"SplitOption": "NONE",
"NumberOfDimensions": 2,
"links": [
  ...
],
}

Back to Top