1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Plan Components
  4. Plan Component - Incentive Formulas

Get all incentive formulas

get

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

Request

Path Parameters
  • 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
  • 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>
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Finds a resource with the specified primary key.
      Finder Variables:
      • IncentiveFormulaId; integer; The unique identifier for the incentive formula record.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • CalculateEnddateParticipantFlag; boolean; 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; The user who created the record.
    • CreationDate; string; The date and time when the record was created.
    • IncentiveFormulaExpressionDescription; string; The additional details added by the user related to plan component incentive formulas.
    • IncentiveFormulaExpressionName; string; The name for the expression used in the incentive formula. This is the expression that is used to calculate the earnings.
    • IncentiveFormulaId; integer; The unique identifier for the incentive formula record. There can be only one incentive formula for one plan component.
    • LastUpdateDate; string; The date and time when the record was last updated.
    • LastUpdateLogin; string; The session login of the user who last updated the record.
    • LastUpdatedBy; string; The user who last updated the record.
    • PayoutFrequency; string; 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; The unique identifier of the plan component record within a business unit.
    • PlanComponentIncentiveFormulaId; integer; The unique identifier of the incentive formula record for the plan component.
    • ResetInterval; integer; 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; 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.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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-planComponentIncentiveFormulas
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : planComponents-planComponentIncentiveFormulas-item-response
Type: object
Show Source
  • 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').
  • Title: Created By
    Read Only: true
    Maximum Length: 255
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • Title: Expression Description
    Read Only: true
    Maximum Length: 1000
    The additional details added by the user related to plan component incentive formulas.
  • 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.
  • 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.
  • The unique identifier for the incentive formula record. There can be only one incentive formula for one plan component.
  • 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.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 255
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login of the user who last updated the record.
  • Links
  • 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'.
  • Title: Plan Component ID
    Read Only: true
    The unique identifier of the plan component record within a business unit.
  • Read Only: true
    The unique identifier of the incentive formula record for the plan component.
  • Read Only: true
    Default Value: false
    Indicates whether a plan component incentive formula can be deleted.
  • 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.
  • 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.
  • 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.
  • 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.
  • Title: True up
    Maximum Length: 1
    Indicates whether the earnings calculated for the current period includes the previously calculated or paid amount (Cumulative.) Calculation engine then automatically subtracts previous earnings from the current earning calculated. Possible values include FALSE and TRUE.
Nested Schema : Plan Component - Rate Dimensional Input Expressions
Type: array
Title: Plan Component - Rate Dimensional Input Expressions
The plan component - rate dimensional input expressions resource is used to update the association of a input expression with a plan component. It can also be used to display all the details of input expressions associated with a plan component. This record specifies the inputs of a rate dimension of a rate table and provides additional details at this level. A valid expression which also has a valid usage needs to exist before creating this record. You should assign the input expression only after the rate table is assigned.
Show Source
Nested Schema : Plan Component - Rate Tables
Type: array
Title: Plan Component - Rate Tables
The plan component - rate tables resource is used to create, update or delete the association of a rate table with a plan component. It can also be used to display all the details of rate table associated with a performance measure. This record links the rate table to a performance measure and provides additional details at this level. A rate table needs to exist before creating this record. The rate table association can be created only after an incentive formula is created.
Show Source
Nested Schema : planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-response
Type: object
Show Source
  • Title: Created By
    Read Only: true
    Maximum Length: 255
    The user who created the record.
  • Title: Creation Date
    Read Only: true
    The date and time when the record was created.
  • Title: Incentive Formula ID
    The unique identifier of the incentive formula record. There can be only one incentive formula for one plan component.
  • Title: Input Expression Description
    Read Only: true
    Maximum Length: 1000
    The description of the input expression entered while creating the expression.
  • Title: Input Expression ID
    The unique identifier of the input expression for the rate dimension of a rate table.
  • 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.
  • Title: Last Updated Date
    Read Only: true
    The date and time when the record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 255
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login of the user who last updated the record.
  • Links
  • Read Only: true
    The unique identifier of the plan component record within a business unit.
  • Title: Plan Component Input Expression Id
    The unique identifier of the input expression record for the plan component.
  • Read Only: true
    Default Value: false
    Indicates whether the rate dimension input can be deleted.
  • Title: Dimension Name
    Read Only: true
    The name of the rate dimension. A rate table can have one or more rate dimensions.
  • Title: Sequence
    The order of the input expressions for the rate table.
  • Title: Split
    Maximum Length: 1
    Default Value: false
    When splitting the rate across tiers, the split option can apply to only one rate dimension input expression. This specifies which rate dimension input expression (rate dimension) to use. Possible values are FALSE and TRUE. The default value is FALSE.
Nested Schema : planComponents-planComponentIncentiveFormulas-planComponentRateTables-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all incentive formulas 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/ child/planComponentIncentiveFormulas

Example of Response Body

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

{
  "items": [
    {
      "IncentiveFormulaId": 300100090511052,
      "TrueUpFlag": true,
      "IncentiveFormulaExpressionId": 300100090511058,
      "IncentiveFormulaExpressionName": null,
      "PayoutFrequency": "-1000",
      "ResetInterval": -1000,
      "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
      "CreationDate": "2017-06-08T12:32:10.109-07:00",
      "LastUpdateDate": "2017-06-09T10:14:40.354-07:00",
      "LastUpdateLogin": "5182A4E294CD57DBE0532DD6F00A0C82",
      "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
      "IncentiveFormulaExpressionDescription": null,
      "IncludeIndirectCredits": "NONE",
      "CalculateEnddateParticipantFlag": true,
      "PlanComponentId": 300100090511050,
      "PlanComponentIncentiveFormulaId": 300100090511051,
      "PlanComponentIncentiveFormulasDeleteFlag": false,
      "links": [
        ...
      ]
    }
  ,
 ...
  ]
}
Back to Top