1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Performance Measures

Update a performance measure

patch

/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/{PerformanceMeasureId}

Request

Path Parameters
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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Description
    Maximum Length: 1000
    The description of the performance measure entered while creating the performance measure.
  • Title: Display Name
    Maximum Length: 80
    The name of the performance measure displayed on the user interface to represent the performance measure.
  • Title: End Date
    The date when the performance measure becomes inactive. The format is yyyy-mm-dd.
  • Title: Formula Name
    Maximum Length: 30
    The name of the external formula. This should be passed only if the UseExternalFormulaFlag is true.
  • Title: Include in participant reports
    Maximum Length: 1
    Default Value: true
    Indicates whether to display the measure attainment in all views and reports. It is useful if the measure results are intermediate calculations which need not be shown in reports. Possible values include FALSE and TRUE.
  • Title: Output Expression ID
    The unique identifier for the measure formula expression for this performance measure. The measure formula expression is used to calculate attainment of the performance measure.
  • Title: Expression Name
    Maximum Length: 160
    The name of the expression used in measure formula to calculate attainment of the performance measure.
  • Title: Performance Measure Name
    Maximum Length: 80
    The name of the performance measure.
  • Title: Number of Dimensions
    The number of dimensions of the scorecard used in the performance measure.
  • Title: Performance Interval
    Default Value: -1000
    The interval value that the performance is measured for. Also for running total, 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'. To get this value, describe the resource and use the finder listed to get all possible values.
  • Credit Categories
    Title: Credit Categories
    The credit categories resource is used to view, create, and delete the association of a credit category with a performance measure. It can also be used to display all the details of the credit categories under a performance measure. A credit category is used to define which transaction is eligible for crediting by the Incentive Compensation system. A performance measure credit category record links the credit category to a performance measure and provides additional details at this level. A credit category needs to exist before creating this record.
  • Descriptive Flex fields
    Title: Descriptive Flex fields
    The Descriptive Flex Field resource is used to create, view, and update user defined values for the performance measure. A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.
  • Goals
    Title: Goals
    The goals resource is used to view and update a goal. It can also be used to display all the details of a goal. A goal under a performance measure defines the target applicable to a participant and could be assigned across a timeline. This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.
  • Rate Dimensional Input Expressions
    Title: Rate Dimensional Input Expressions
    The Rate Dimensional Input Expressions resource is used to view and update the association of an input expression with a performance measure. It can also be used to display all the details of the input expressions under a performance measure. This record specifies the inputs of a rate dimension of a scorecard and provides additional details at this level. A valid expression which also has a valid usage needs to exist before creating this record. This should be assigned only after the scorecard has been assigned.
  • Scorecards
    Title: Scorecards
    The scorecards resource is used to view, create, update, and delete the association of a scorecard with a performance measure. It can also be used to display all the details of a scorecard associated with a performance measure. This resource links the scorecard to a performance measure and provides additional details at this level. A scorecard needs to exist before creating this record.
  • Title: Running total
    Maximum Length: 1
    Default Value: false
    Indicates whether to accumulate a calculation input, such as credit amount or credit quantity, over a period. The default value is N so you need to explicitly pass Y if processing transaction is set as GROUP. Possible values include FALSE and TRUE. The default value is FALSE. This attribute is not applicable if ProcessTransactions is GROUP.
  • Title: Split Option
    Maximum Length: 30
    Default Value: NONE
    Specifies how to split the input number to a scorecard 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.
  • Title: Start Date
    The date when the performance measure becomes active. The format is yyyy-mm-dd.
  • Title: Unit of Measure
    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 to measure attainment based on an amount, PERCENT to measure attainment is based on a percent, QUANTITY to measure attainment is based on a quantity, and SCORE to 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.
  • Title: Use external formula
    Maximum Length: 1
    Default Value: false
    IIndicates whether the performance measure uses an external formula from an external package. Possible values include FALSE and 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.
Nested Schema : Credit Categories
Type: array
Title: Credit Categories
The credit categories resource is used to view, create, and delete the association of a credit category with a performance measure. It can also be used to display all the details of the credit categories under a performance measure. A credit category is used to define which transaction is eligible for crediting by the Incentive Compensation system. A performance measure credit category record links the credit category to a performance measure and provides additional details at this level. A credit category needs to exist before creating this record.
Show Source
Nested Schema : Descriptive Flex fields
Type: array
Title: Descriptive Flex fields
The Descriptive Flex Field resource is used to create, view, and update user defined values for the performance measure. A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.
Show Source
Nested Schema : Goals
Type: array
Title: Goals
The goals resource is used to view and update a goal. It can also be used to display all the details of a goal. A goal under a performance measure defines the target applicable to a participant and could be assigned across a timeline. This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.
Show Source
Nested Schema : Rate Dimensional Input Expressions
Type: array
Title: Rate Dimensional Input Expressions
The Rate Dimensional Input Expressions resource is used to view and update the association of an input expression with a performance measure. It can also be used to display all the details of the input expressions under a performance measure. This record specifies the inputs of a rate dimension of a scorecard and provides additional details at this level. A valid expression which also has a valid usage needs to exist before creating this record. This should be assigned only after the scorecard has been assigned.
Show Source
Nested Schema : Scorecards
Type: array
Title: Scorecards
The scorecards resource is used to view, create, update, and delete the association of a scorecard with a performance measure. It can also be used to display all the details of a scorecard associated with a performance measure. This resource links the scorecard to a performance measure and provides additional details at this level. A scorecard needs to exist before creating this record.
Show Source
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-item-patch-request
Type: object
Show Source
Nested Schema : performanceMeasureCreditFactors
Type: array
Show Source
Nested Schema : performanceMeasureTransactionFactors
Type: array
Show Source
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureCreditFactors-item-patch-request
Type: object
Show Source
  • Title: Credit Factor
    Default Value: 100
    The percentage of uplift applied to transaction credits that is specified at the credit category level, for a period of time. Helps to boost the attainment for a period of time, for certain credit categories. The default value is 100.
  • Title: Earning Factor
    Default Value: 100
    The percentage of uplift applied to earnings that is specified at the credit category level, for a period of time. Helps to boost the earnings for a period of time, for certain credit categories. Default value is 100.
  • Title: End Date
    The date when the credit factor and earning factor provided for a credit category within a performance measure become inactive. The format is yyyy-mm-dd.
  • The unique identifier of the credit category for the performance measure.
  • Title: Start Date
    The date when the credit factor and earning factor provided for a credit category within a performance measure become active. The format is yyyy-mm-dd.
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureTransactionFactors-item-patch-request
Type: object
Show Source
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureDFF-item-patch-request
Type: object
Show Source
  • Title: Context Segment
    Maximum Length: 30
    The flex context segment code for the performance measure. It determines which context-sensitive segments are displayed.
  • Title: Context Segment
    The flex context segment display name for the performance measure. It determines which context-sensitive segments are displayed.
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureGoals-item-patch-request
Type: object
Show Source
  • Indicates if the target amount evenly to the interval targets and period targets, the possible values are TRUE and FALSE.
  • Title: Distribute By
    The goal target or alternate goal targets are distributed by amount or percent. Although only distribute by Amount is allowed for now, it has two possible values which are AMOUNT to distribute the goal in numbers for each interval and period, and PERCENT to distribute the goal as a percentage of the annual number for each interval and period. A list of acceptable values is defined in the lookup CN_GOAL_DISTRIBUTE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • Title: Target
    The expected level of attainment assigned to a participant for each measure for the year, which may be divided into different intervals.
  • Interval Goals
    Title: Interval Goals
    The Interval Goals resource is used to view and update the target or the goal values at each interval. It can also be used to display all details of the goals across intervals. This is created when creating a Performance Measure with a default value of 0.
  • Indicates if all period values to the respective interval and interval to date (ITD) are summed up and if all interval values to the respective total target goal values are summed up. This replaces any interval, ITD and total target goal values. Also this cannot be TRUE if the goal distribution type value is Percentage. This also applies to all alternate goals.
  • Title: Unit of Measure
    Maximum Length: 30
    Default Value: AMOUNT
    The standardized quantity used as a factor to express occurring quantities of the goal property. Possible values include AMOUNT for Revenue-based goal and QUANTITY for Quantity-based goal. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_GOAL_UOM. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
Nested Schema : Interval Goals
Type: array
Title: Interval Goals
The Interval Goals resource is used to view and update the target or the goal values at each interval. It can also be used to display all details of the goals across intervals. This is created when creating a Performance Measure with a default value of 0.
Show Source
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-item-patch-request
Type: object
Show Source
  • Title: Alternate Interval Target 1
    Default Value: 0
    The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.
  • Title: Alternate Interval Target 1
    The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.
  • Title: Alternate Interval Target 2
    Default Value: 0
    The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.
  • Title: Alternate Interval Target 2
    The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.
  • Title: Alternate Interval Target 3
    Default Value: 0
    The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.
  • Title: Alternate Interval Target 3
    The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.
  • Title: Alternate Interval Target 4
    Default Value: 0
    The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.
  • Title: Alternate Interval Target 4
    The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.
  • Title: Alternate Interval Target 5
    Default Value: 0
    The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.
  • Title: Alternate Interval Target 5
    The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.
  • The unique identifier for a goal record.
  • Title: Period
    Maximum Length: 80
    The display value of the interval.
  • Period Goals
    Title: Period Goals
    The Period Goals resource is used to view and update the target or the goal values at each period. It can also be used to display all details of the goals across periods. This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.
Nested Schema : Period Goals
Type: array
Title: Period Goals
The Period Goals resource is used to view and update the target or the goal values at each period. It can also be used to display all details of the goals across periods. This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.
Show Source
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-performanceMeasurePeriodGoals-item-patch-request
Type: object
Show Source
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureRateDimensionalInputs-item-patch-request
Type: object
Show Source
  • Title: Accumulate
    Maximum Length: 1
    Default Value: false
    Indicates which rate dimension input expression (rate dimension) does running total apply to, when using running total for a scorecard with multiple dimensions. Possible values include FALSE and TRUE. The default value is FALSE.
  • Title: Input Expression ID
    The unique identifier for the input expression record for a business unit. This represents the input expression to the rate dimension of the scorecard used in the performance measure.
  • Title: Input Expression Name
    Maximum Length: 160
    The name for the input expression to the rate dimension of the scorecard used in the performance measure.
  • Title: Performance Measure ID
    The unique identifier for a performance measure record.
  • Title: Rate Dimension Sequence
    The order of a rate dimension within a scorecard.
  • Title: Apply split
    Maximum Length: 1
    Default Value: false
    Indicates whether the split option can apply to only one rate dimension input expression when splitting the rate across tiers. This informs which rate dimension input expression (rate dimension) to use. Possible values include FALSE and TRUE. The default value is FALSE.
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureScorecards-item-patch-request
Type: object
Show Source
  • Title: End Date
    The date when the scorecard becomes inactive for the performance measure. The format is yyyy-mm-dd.
  • Title: Start Date
    The date when the scorecard becomes active for the performance measure. The format is yyyy-mm-dd.
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 : incentiveCompensationPerformanceMeasures-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: Description
    Maximum Length: 1000
    The description of the performance measure entered while creating the performance measure.
  • Title: Display Name
    Maximum Length: 80
    The name of the performance measure displayed on the user interface to represent the performance measure.
  • Title: End Date
    The date when the performance measure becomes inactive. The format is yyyy-mm-dd.
  • Title: Formula Name
    Maximum Length: 30
    The name of the external formula. This should be passed only if the UseExternalFormulaFlag is true.
  • Title: Include in participant reports
    Maximum Length: 1
    Default Value: true
    Indicates whether to display the measure attainment in all views and reports. It is useful if the measure results are intermediate calculations which need not be shown in reports. Possible values include FALSE and TRUE.
  • Title: Reason
    Read Only: true
    The reason explaining why the performance measure is invalid.
  • 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: Output Expression Description
    Read Only: true
    Maximum Length: 1000
    The description of the measure formula expression entered while creating the expression.
  • Title: Output Expression ID
    The unique identifier for the measure formula expression for this performance measure. The measure formula expression is used to calculate attainment of the performance measure.
  • Title: Expression Name
    Maximum Length: 160
    The name of the expression used in measure formula to calculate attainment of the performance measure.
  • Title: Performance Measure Name
    Maximum Length: 80
    The name of the performance measure.
  • Title: Number of Dimensions
    The number of dimensions of the scorecard used in the performance measure.
  • Title: Business Unit
    The unique identifier of the business unit.
  • Title: Performance Interval
    Default Value: -1000
    The interval value that the performance is measured for. Also for running total, 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'. To get this value, describe the resource and use the finder listed to get all possible values.
  • Credit Categories
    Title: Credit Categories
    The credit categories resource is used to view, create, and delete the association of a credit category with a performance measure. It can also be used to display all the details of the credit categories under a performance measure. A credit category is used to define which transaction is eligible for crediting by the Incentive Compensation system. A performance measure credit category record links the credit category to a performance measure and provides additional details at this level. A credit category needs to exist before creating this record.
  • Descriptive Flex fields
    Title: Descriptive Flex fields
    The Descriptive Flex Field resource is used to create, view, and update user defined values for the performance measure. A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.
  • Goals
    Title: Goals
    The goals resource is used to view and update a goal. It can also be used to display all the details of a goal. A goal under a performance measure defines the target applicable to a participant and could be assigned across a timeline. This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.
  • The unique identifier for the performance measure.
  • Rate Dimensional Input Expressions
    Title: Rate Dimensional Input Expressions
    The Rate Dimensional Input Expressions resource is used to view and update the association of an input expression with a performance measure. It can also be used to display all the details of the input expressions under a performance measure. This record specifies the inputs of a rate dimension of a scorecard and provides additional details at this level. A valid expression which also has a valid usage needs to exist before creating this record. This should be assigned only after the scorecard has been assigned.
  • Scorecards
    Title: Scorecards
    The scorecards resource is used to view, create, update, and delete the association of a scorecard with a performance measure. It can also be used to display all the details of a scorecard associated with a performance measure. This resource links the scorecard to a performance measure and provides additional details at this level. A scorecard needs to exist before creating this record.
  • Title: Process Transactions
    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 (when selecting GROUP, pass Accumulation Flag as Y), and INDIVIDUAL to evaluate each transaction independently, for attainment calculation. So each transaction is considered independently. This cannot be updated once performance measure has been created. 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.
  • Title: Rendered Expression
    Read Only: true
    The entire measure formula expression with all the expression components like operators, attributes, functions, etc. This attribute is used to display the entire expression on the user interface.
  • Title: Running total
    Maximum Length: 1
    Default Value: false
    Indicates whether to accumulate a calculation input, such as credit amount or credit quantity, over a period. The default value is N so you need to explicitly pass Y if processing transaction is set as GROUP. Possible values include FALSE and TRUE. The default value is FALSE. This attribute is not applicable if ProcessTransactions is GROUP.
  • Title: Split Option
    Maximum Length: 30
    Default Value: NONE
    Specifies how to split the input number to a scorecard 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.
  • Title: Start Date
    The date when the performance measure becomes active. The format is yyyy-mm-dd.
  • Title: Unit of Measure
    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 to measure attainment based on an amount, PERCENT to measure attainment is based on a percent, QUANTITY to measure attainment is based on a quantity, and SCORE to 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.
  • Title: Use external formula
    Maximum Length: 1
    Default Value: false
    IIndicates whether the performance measure uses an external formula from an external package. Possible values include FALSE and 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.
  • Title: Valid for Calculation
    Read Only: true
    Maximum Length: 30
    Default Value: INCOMPLETE
    Indicates whether a performance measure is ready for calculation. Possible values include COMPLETE for valid and ready for calculation, INCOMPLETE for invalid and not ready for calculation. The default value is INCOMPLETE. A list of acceptable values is defined in the lookup CN_FORMULA_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
Nested Schema : Credit Categories
Type: array
Title: Credit Categories
The credit categories resource is used to view, create, and delete the association of a credit category with a performance measure. It can also be used to display all the details of the credit categories under a performance measure. A credit category is used to define which transaction is eligible for crediting by the Incentive Compensation system. A performance measure credit category record links the credit category to a performance measure and provides additional details at this level. A credit category needs to exist before creating this record.
Show Source
Nested Schema : Descriptive Flex fields
Type: array
Title: Descriptive Flex fields
The Descriptive Flex Field resource is used to create, view, and update user defined values for the performance measure. A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.
Show Source
Nested Schema : Goals
Type: array
Title: Goals
The goals resource is used to view and update a goal. It can also be used to display all the details of a goal. A goal under a performance measure defines the target applicable to a participant and could be assigned across a timeline. This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.
Show Source
Nested Schema : Rate Dimensional Input Expressions
Type: array
Title: Rate Dimensional Input Expressions
The Rate Dimensional Input Expressions resource is used to view and update the association of an input expression with a performance measure. It can also be used to display all the details of the input expressions under a performance measure. This record specifies the inputs of a rate dimension of a scorecard and provides additional details at this level. A valid expression which also has a valid usage needs to exist before creating this record. This should be assigned only after the scorecard has been assigned.
Show Source
Nested Schema : Scorecards
Type: array
Title: Scorecards
The scorecards resource is used to view, create, update, and delete the association of a scorecard with a performance measure. It can also be used to display all the details of a scorecard associated with a performance measure. This resource links the scorecard to a performance measure and provides additional details at this level. A scorecard needs to exist before creating this record.
Show Source
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-item-response
Type: object
Show Source
Nested Schema : Credit Factors
Type: array
Title: Credit Factors
The credit factors resource is used to view, create, update, and delete the credit factor or earning factor within a credit category associated to a performance measure. The credit factor is used to apply an uplift to the sales credits at the credit category level for a period of time. The earning factor is used to apply an uplift to the sales earning at the credit category level for a period of time.
Show Source
Nested Schema : Transaction Factors
Type: array
Title: Transaction Factors
The transaction factors resource is used to view, create, update, and delete the transaction factor associated with a performance measure credit category. A transaction factor is used to decide the influence of the sales stage (Invoicing, PO stage, etc.) on the sales credit.
Show Source
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureCreditFactors-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: Credit Factor
    Default Value: 100
    The percentage of uplift applied to transaction credits that is specified at the credit category level, for a period of time. Helps to boost the attainment for a period of time, for certain credit categories. The default value is 100.
  • Title: Earning Factor
    Default Value: 100
    The percentage of uplift applied to earnings that is specified at the credit category level, for a period of time. Helps to boost the earnings for a period of time, for certain credit categories. Default value is 100.
  • Title: End Date
    The date when the credit factor and earning factor provided for a credit category within a performance measure become inactive. The format is yyyy-mm-dd.
  • 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
  • The unique identifier of the credit category for the performance measure.
  • The unique identifier of the credit factors for the performance measure.
  • Title: Start Date
    The date when the credit factor and earning factor provided for a credit category within a performance measure become active. The format is yyyy-mm-dd.
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureCreditCategories-performanceMeasureTransactionFactors-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.
  • The unique identifier for the credit category record.
  • 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
  • The unique identifier of the credit category for the performance measure.
  • The unique identifier for the performance measure record.
  • The unique identifier for the transaction factor records for the performance measure.
  • Title: Factor
    Default Value: 100
    A percentage of transaction amount considered for calculation. It helps to stage sales credit over the life of a sale, assigning percentages to important events in the sales process such as order, invoice, and payment. The default value is 100.
  • Title: Transaction Type
    Maximum Length: 30
    The type of transaction. Possible values include CLAWBACK for claw back transaction type, CUSTOMER_SATISFACTION for customer satisfaction transaction type, GRP where the application creates a group by record during the calculation process, INVOICE for invoice transaction type, MANUAL for manual transaction type, ORDER for order transaction type, PAYMENT for payment transaction type, RAM_ADJUSTMENT for accounts receivable revenue adjustment transaction type, and ITD, where the application creates an Interval-to-date record during the calculation process. A list of acceptable values is defined in the lookup CN_TP_TRANSACTION_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureDFF-item-response
Type: object
Show Source
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureGoals-item-response
Type: object
Show Source
  • Title: Alternate Target 1
    Read Only: true
    The alternate target number for a measure, for example, stretch goal.
  • Title: Alternate Target 2
    Read Only: true
    The alternate target number for a measure, for example, stretch goal.
  • Title: Alternate Target 3
    Read Only: true
    The alternate target number for a measure, for example, stretch goal.
  • Title: Alternate Target 4
    Read Only: true
    The alternate target number for a measure, for example, stretch goal.
  • Title: Alternate Target 5
    Read Only: true
    The alternate target number for a measure, for example, stretch goal.
  • 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.
  • Indicates if the target amount evenly to the interval targets and period targets, the possible values are TRUE and FALSE.
  • Title: Distribute By
    The goal target or alternate goal targets are distributed by amount or percent. Although only distribute by Amount is allowed for now, it has two possible values which are AMOUNT to distribute the goal in numbers for each interval and period, and PERCENT to distribute the goal as a percentage of the annual number for each interval and period. A list of acceptable values is defined in the lookup CN_GOAL_DISTRIBUTE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • The unique identifier for a goal record.
  • Title: Goal Interval
    Read Only: true
    The span of time to specify the goal information. This interval is same as the corresponding performance (measure) interval. To get this value, describe the resource and use the finder listed to get all possible values.
  • Title: Target
    The expected level of attainment assigned to a participant for each measure for the year, which may be divided into different intervals.
  • Read Only: true
    The display value for the goal number distributed across the intervals.
  • 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
    Default Value: false
    Indicates whether a goal can be deleted.
  • Interval Goals
    Title: Interval Goals
    The Interval Goals resource is used to view and update the target or the goal values at each interval. It can also be used to display all details of the goals across intervals. This is created when creating a Performance Measure with a default value of 0.
  • Indicates if all period values to the respective interval and interval to date (ITD) are summed up and if all interval values to the respective total target goal values are summed up. This replaces any interval, ITD and total target goal values. Also this cannot be TRUE if the goal distribution type value is Percentage. This also applies to all alternate goals.
  • Title: Unit of Measure
    Maximum Length: 30
    Default Value: AMOUNT
    The standardized quantity used as a factor to express occurring quantities of the goal property. Possible values include AMOUNT for Revenue-based goal and QUANTITY for Quantity-based goal. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_GOAL_UOM. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
Nested Schema : Interval Goals
Type: array
Title: Interval Goals
The Interval Goals resource is used to view and update the target or the goal values at each interval. It can also be used to display all details of the goals across intervals. This is created when creating a Performance Measure with a default value of 0.
Show Source
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-item-response
Type: object
Show Source
  • Title: Alternate Interval Target 1
    Default Value: 0
    The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.
  • Title: Alternate Interval Target 1
    The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.
  • Title: Alternate Interval Target 2
    Default Value: 0
    The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.
  • Title: Alternate Interval Target 2
    The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.
  • Title: Alternate Interval Target 3
    Default Value: 0
    The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.
  • Title: Alternate Interval Target 3
    The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.
  • Title: Alternate Interval Target 4
    Default Value: 0
    The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.
  • Title: Alternate Interval Target 4
    The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.
  • Title: Alternate Interval Target 5
    Default Value: 0
    The alternate interval target number for a measure, for example, stretch goal for an interval. The default value is 0.
  • Title: Alternate Interval Target 5
    The alternate interval target percentage for a measure, for example, stretch goal for an interval. This is calculated on the respective alternate target.
  • 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.
  • The unique identifier for a goal record.
  • The unique identifier for the interval goal details.
  • Title: Period
    Maximum Length: 80
    The display value of the interval.
  • Title: Interval Target
    Read Only: true
    Default Value: 0
    The target number specified for the goal interval. The default value is 0.
  • Title: Interval Target
    Read Only: true
    The target percentage specified for the goal interval.
  • 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
    Default Value: false
    Indicates whether a performance measure interval goal can be deleted.
  • Period Goals
    Title: Period Goals
    The Period Goals resource is used to view and update the target or the goal values at each period. It can also be used to display all details of the goals across periods. This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.
Nested Schema : Period Goals
Type: array
Title: Period Goals
The Period Goals resource is used to view and update the target or the goal values at each period. It can also be used to display all details of the goals across periods. This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.
Show Source
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureGoals-performanceMeasureIntervalGoals-performanceMeasurePeriodGoals-item-response
Type: object
Show Source
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureRateDimensionalInputs-item-response
Type: object
Show Source
  • Title: Accumulate
    Maximum Length: 1
    Default Value: false
    Indicates which rate dimension input expression (rate dimension) does running total apply to, when using running total for a scorecard with multiple dimensions. Possible values include FALSE and TRUE. The default value is FALSE.
  • 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: Description
    Read Only: true
    Maximum Length: 1000
    The rate dimensional input expression description entered while creating the expression.
  • Title: Input Expression ID
    The unique identifier for the input expression record for a business unit. This represents the input expression to the rate dimension of the scorecard used in the performance measure.
  • Title: Input Expression Name
    Maximum Length: 160
    The name for the input expression to the rate dimension of the scorecard used in the performance measure.
  • 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 this record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The session login of the user who last updated the record.
  • Links
  • Title: Performance Measure ID
    The unique identifier for a performance measure record.
  • Title: Performance Measure Input Expression Id
    The unique identifier for the input expression to the rate dimension of the scorecard used in the performance measure.
  • Read Only: true
    Default Value: false
    Inidcates whether a rate dimensional input can be deleted.
  • Title: Dimension Name
    Read Only: true
    The name of the rate dimension. A scorecard can have one or more rate dimensions.
  • Title: Rate Dimension Sequence
    The order of a rate dimension within a scorecard.
  • Title: Apply split
    Maximum Length: 1
    Default Value: false
    Indicates whether the split option can apply to only one rate dimension input expression when splitting the rate across tiers. This informs which rate dimension input expression (rate dimension) to use. Possible values include FALSE and TRUE. The default value is FALSE.
Nested Schema : incentiveCompensationPerformanceMeasures-performanceMeasureScorecards-item-response
Type: object
Show Source
Links
ApplySplitLookup
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DCN_SPLIT_TYPE_OPTION
The list of values indicating how to split the input number to a scorecard 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.

The following properties are defined on the LOV link relation:
  • Source Attribute: SplitOption; Target Attribute: LookupCode
  • Display Attribute: Meaning
BusinessUnit
The unique identifier of the business unit.

The following properties are defined on the LOV link relation:
  • Source Attribute: OrgId; Target Attribute: OrganizationId
  • Display Attribute: Name
MesureFormulaExpressionVO
Parameters:
  • finder: UsageCodeFinder%3BBindExpressionType%3DCALCULATION%2CBindOrgId%3D{OrgId}
The list of values containing the names for the expressions used in the measure formula to calculate the attainment of the performance measure.

The following properties are defined on the LOV link relation:
  • Source Attribute: MeasureFormulaExpressionName; Target Attribute: ExpressionName
  • Display Attribute: ExpressionName
PerformanceIntervalVO
Parameters:
  • finder: BusinessUnitFinder%3BPorgId%3D{OrgId}
The list of internal values that the performance is measured for. When running total is considered, the accumulated value is reset based on this interval value. The interval represents a unit of time like month, quarter, year. The default value is '-1000'.

The following properties are defined on the LOV link relation:
  • Source Attribute: PerformanceInterval; Target Attribute: IntervalTypeId
  • Display Attribute: IntervalName
ProcessTxnLookup
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DCN_PROCESS_TXN
The list of values indicating 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 to evaluate each transaction independently for attainment calculation. You must also set the Accumulation flag as Y if you select Group.

The following properties are defined on the LOV link relation:
  • Source Attribute: ProcessTransactions; Target Attribute: LookupCode
  • Display Attribute: Meaning
UnitOfMeasureLookup
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DCN_MEASURE_UOM
The list of values containing the standardized quantities used as a factor to express occurring quantities of the performance measure property. Possible values include AMOUNT to measure attainment based on an amount, PERCENT to measure attainment based on a percent, QUANTITY to measure attainment based on a quantity, and SCORE to measure attainment based on a score. The default value is AMOUNT.

The following properties are defined on the LOV link relation:
  • Source Attribute: UnitOfMeasure; Target Attribute: LookupCode
  • Display Attribute: Meaning
UseExternalFormulaLookup
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DCN_YES_NO
The list of values indicating whether the performance measure uses an external formula from an external package. Possible values include FALSE and TRUE. The default value is FALSE.

The following properties are defined on the LOV link relation:
  • Source Attribute: UseExternalFormulaFlag; Target Attribute: LookupCode
  • Display Attribute: Meaning
ValidForCalculationVO
Parameters:
  • finder: LookupTypeFinder%3BLookupType%3DCN_COMP_PLAN_STATUS
The list of values indicating whether a 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.

The following properties are defined on the LOV link relation:
  • Source Attribute: ValidForCalculation; Target Attribute: LookupCode
  • Display Attribute: Meaning
performanceMeasureCreditCategories
Parameters:
  • PerformanceMeasureId: $request.path.PerformanceMeasureId
The credit categories resource is used to view, create, and delete the association of a credit category with a performance measure. It can also be used to display all the details of the credit categories under a performance measure. A credit category is used to define which transaction is eligible for crediting by the Incentive Compensation system. A performance measure credit category record links the credit category to a performance measure and provides additional details at this level. A credit category needs to exist before creating this record.
performanceMeasureDFF
Parameters:
  • PerformanceMeasureId: $request.path.PerformanceMeasureId
The Descriptive Flex Field resource is used to create, view, and update user defined values for the performance measure. A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.
performanceMeasureGoals
Parameters:
  • PerformanceMeasureId: $request.path.PerformanceMeasureId
The goals resource is used to view and update a goal. It can also be used to display all the details of a goal. A goal under a performance measure defines the target applicable to a participant and could be assigned across a timeline. This is created when creating a Performance Measure with a default value of 0. This needs to be updated later if needed.
performanceMeasureRateDimensionalInputs
Parameters:
  • PerformanceMeasureId: $request.path.PerformanceMeasureId
The Rate Dimensional Input Expressions resource is used to view and update the association of an input expression with a performance measure. It can also be used to display all the details of the input expressions under a performance measure. This record specifies the inputs of a rate dimension of a scorecard and provides additional details at this level. A valid expression which also has a valid usage needs to exist before creating this record. This should be assigned only after the scorecard has been assigned.
performanceMeasureScorecards
Parameters:
  • PerformanceMeasureId: $request.path.PerformanceMeasureId
The scorecards resource is used to view, create, update, and delete the association of a scorecard with a performance measure. It can also be used to display all the details of a scorecard associated with a performance measure. This resource links the scorecard to a performance measure and provides additional details at this level. A scorecard needs to exist before creating this record.
Back to Top

Examples

The following example shows how to update a performance measure record by submitting a PATCH request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/incentiveCompensationPerformanceMeasures/300100090511017

Example of Request Body

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

{
"Name": "Sales Attainment 2016",
"Description": "Sales Attainment for 2016"
}

Example of Response Body

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

{
  "PerformanceMeasureId": 300100090511017,
  "Name": "Sales Attainment 2016",
  "Description": "Sales Attainment for 2016",
  "UnitOfMeasure": "AMOUNT",
  "ValidForCalculation": "INCOMPLETE",
  "OrgId": 204,
  "StartDate": "2016-01-01",
  "EndDate": "2016-12-31",
  "NumberOfDimensions": null,
  "UseExternalFormulaFlag": false,
  "ExternalFormulaName": null,
  "IncludeInParticipantReportsFlag": true,
  "MeasureFormulaExpressionId": 300100089641740,
  "RunningTotalFlag": false,
  "SplitOption": "PROPORTIONAL",
  "MeasureFormulaExpressionName": "Test",
  "ProcessTransactions": "INDIVIDUAL",
  "PerformanceInterval": "-1000",
  "DisplayName": "Sales Attainment",
  "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "CreationDate": "2017-06-08T11:28:10-07:00",
  "LastUpdateDate": "2017-06-08T11:32:32.165-07:00",
  "LastUpdateLogin": "516E508C5BC4377FE0532DD6F00A0214",
  "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "MeasureFormulaExpressionDescription": null,
  "InvalidReason": "The performance measure is not valid for calculation. (CN-1575563) Cause: The expression Test does not refer to any attribute from the credit group. Action: You must enter an expression that refers to an attribute from the credit group.",
  "links": [
	...
    ]
}
Back to Top