Jump to

• Request
• Response

Update an incentive formula

patch

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

Request

Path Parameters

• IncentiveFormulaId(required): integer(int64)
  The unique identifier for the incentive formula record. There can be only one incentive formula for one plan component.
• planComponentsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- PlanComponentId and OrgId ---for the Plan Components resource and used to uniquely identify an instance of Plan Components. The client should not generate the hash key value. Instead, the client should query on the Plan Components collection resource with a filter on the primary key values in order to navigate to a specific instance of Plan Components.
  
  For example: planComponents?q=PlanComponentId=<value1>;OrgId=<value2>

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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').
• 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.
• IncludeIndirectCredits: string
  Title: Include Indirect Credits

  Type of indirect credits to include in the calculation, for the plan component. Possible values include ALL for all indirect credits that are included for attainment or earnings calculation for this plan component, MGR for only rollup indirect credits that are included for attainment or earnings calculation for this plan component, NONE for no indirect credits that are included for attainment or earnings calculation for this plan component, and TEAM for only team indirect credits that are included for attainment or earnings calculation for this plan component. The default value is NONE. A list of acceptable values is defined in the lookup CN_PLAN_INDIRECT_CREDIT. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• PayoutFrequency: string
  Title: Payout Frequency

  Default Value: -1000

  This is the interval value that determines how often the earning is calculated. Interval would represent a unit of time like month, quarter, year. The default value is '-1000'.
• planComponentRateDimensionalInputs: array 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.
• 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":{
        "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-patch-request"
            }
        },
        "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"
            }
        },
        "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
        },
        "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-patch-request"
            }
        },
        "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"
                ]
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
                ]
            }
        }
    }
}

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-patch-request

{
    "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-patch-request"
    }
}

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 schema

{
    "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-patch-request"
    }
}

Nested Schema : planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-patch-request

Type: object

Show Source

• IncentiveFormulaId: integer (int64)
  Title: Incentive Formula ID

  The unique identifier of the incentive formula record. There can be only one incentive formula for one plan component.
• InputExpressionId: integer (int64)
  Title: Input Expression ID

  The unique identifier of the input expression for the rate dimension of a rate table.
• InputExpressionName: string
  Title: Input Expression Name

  Maximum Length: 160

  The name of the input expression for the rate dimension of a rate table used in the plan component. The input expression drives a value to evaluate from the transaction and matches the results with the corresponding rate table dimension.
• 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":{
        "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"
            }
        },
        "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"
            }
        },
        "RateDimSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order of the input expressions for the rate table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "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
        },
        "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"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• EndDate: string (date)
  Title: End Date

  The date when the rate table becomes inactive for the plan component. The format is yyyy-mm-dd.
• 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":{
        "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
        },
        "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
        }
    }
}

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-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":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated 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
        },
        "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"
            }
        },
        "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"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "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
        },
        "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
        },
        "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
        },
        "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"
            }
        },
        "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
        },
        "PlanComponentIncentiveFormulasDeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether a plan component incentive formula can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "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"
            }
        },
        "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"
            }
        },
        "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        },
        "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
        }
    }
}

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 : 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-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":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "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
        },
        "PlanComponentRateDimensionalInputsDeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the rate dimension input can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        }
    }
}

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":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated 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
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the rate table.",
            "nullable":true,
            "readOnly":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
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier for the plan component record within a business unit.",
            "nullable":true,
            "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
        },
        "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
        },
        "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
        },
        "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "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
        },
        "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
        },
        "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
        }
    }
}

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

IncludeIndirectCreditsVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_PLAN_INDIRECT_CREDIT

The standard lookups list of values resource is used to query the list of values of standard lookups, which list the available codes and translated meanings. Standard lookups are defined in the standard lookups view and store lookup codes that support reference data sharing.

planComponentRateDimensionalInputs

Operation: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateDimensionalInputs

Parameters:

• IncentiveFormulaId: $request.path.IncentiveFormulaId
• planComponentsUniqID: $request.path.planComponentsUniqID

The plan component - rate dimensional input expressions resource is used to update the association of a input expression with a plan component. It can also be used to display all the details of input expressions associated with a plan component. This record specifies the inputs of a rate dimension of a rate table and provides additional details at this level. A valid expression which also has a valid usage needs to exist before creating this record. You should assign the input expression only after the rate table is assigned.

planComponentRateTables

Operation: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas/{IncentiveFormulaId}/child/planComponentRateTables

Parameters:

• IncentiveFormulaId: $request.path.IncentiveFormulaId
• planComponentsUniqID: $request.path.planComponentsUniqID

The plan component - rate tables resource is used to create, update or delete the association of a rate table with a plan component. It can also be used to display all the details of rate table associated with a performance measure. This record links the rate table to a performance measure and provides additional details at this level. A rate table needs to exist before creating this record. The rate table association can be created only after an incentive formula is created.

Back to Top