Jump to

• Request
• Response

Create a rule hierarchy

post

/fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 1000

  The description of the rule.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Indicates whether the rule is enabled.
• EndDate: string (date)
  Title: End Date

  The date and time when the rule becomes inactive. The acceptable format is yyyy-mm-dd.
• Name(required): string
  Title: Name

  Maximum Length: 160

  The name of the rule.
• NumberOfWinners: integer (int32)
  Title: Number of Winners

  Default Value: 1

  The number of rules that can win based on the matching criteria and rank. This value is applicable for Credit and Participant Assignments rule types.
• OrganizationId: integer (int64)
  Title: Business Unit

  The unique identifier of the business unit.
• ParentRuleId: integer (int64)
  Title: Parent

  The unique identifier of the parent rule. This value is defaulted to the rule identifier of the parent rule.
• QualifyingCriteria: array Qualifying Criteria
  Title: Qualifying Criteria

  The qualifying criteria resource is used create and view how the transactions are matched for classification and credit processing. Use the Configure Tables and Columns task in the Setup and Maintenance work area to enable application table columns for use as qualifying criteria attributes in classification, direct credit, and participant assignment rules. You can also define your own qualifiers based on a descriptive flex field.
• Rank: integer (int64)
  Title: Rank

  The preference of a rule. This value is useful for breaking ties between other winning rules during the assignment. The rule with the lowest rank number is preferred against other winning rules in the same hierarchy level. This value is applicable for Classification, Credit, and Participant Assignments rule types.
• RuleAssignments: array Rule Assignments
  Title: Rule Assignments

  The rule assignments resource is used create, view, update, or delete the receiver of the credits, for a matching transaction, when a rule wins. Classification adds credit categories to matching transactions, and Participant role assignment rules assign eligible roles to matching participants. The rule assignments for Rollup and Team rules are used to create indirect credits.
• RuleNumber: string
  Title: Rule Number

  Maximum Length: 30

  The unique identifier for the rule. This value can be system-generated or user-provided during a create action.
• Rules: array Rules
  Title: Rules

  The rules resource is used to create, view, update, or delete the child nodes for the rule hierarchy. The rules form the building blocks of a rule hierarchy and are date effective.
• RuleTypeId(required): integer (int64)
  Title: Rule Type

  The unique identifier of the rule type.
• StartDate: string (date)
  Title: Start Date

  The date and time when the rule becomes active. The acceptable format is yyyy-mm-dd.

{
    "required":[
        "Name",
        "RuleTypeId"
    ],
    "type":"object",
    "properties":{
        "NumberOfWinners":{
            "title":"Number of Winners",
            "type":"integer",
            "description":"The number of rules that can win based on the matching criteria and rank. This value is applicable for Credit and Participant Assignments rule types.",
            "format":"int32",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "precision":"9"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the rule.",
            "nullable":true
        },
        "RuleTypeId":{
            "title":"Rule Type",
            "type":"integer",
            "description":"The unique identifier of the rule type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "ParentRuleId":{
            "title":"Parent",
            "type":"integer",
            "description":"The unique identifier of the parent rule. This value is defaulted to the rule identifier of the parent rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "QualifyingCriteria":{
            "title":"Qualifying Criteria",
            "type":"array",
            "description":"The qualifying criteria resource is used create and view how the transactions are matched for classification and credit processing. Use the Configure Tables and Columns task in the Setup and Maintenance work area to enable application table columns for use as qualifying criteria attributes in classification, direct credit, and participant assignment rules. You can also define your own qualifiers based on a descriptive flex field.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationRuleHierarchies-QualifyingCriteria-item-post-request"
            }
        },
        "Rank":{
            "title":"Rank",
            "type":"integer",
            "description":"The preference of a rule. This value is useful for breaking ties between other winning rules during the assignment. The rule with the lowest rank number is preferred against other winning rules in the same hierarchy level. This value is applicable for Classification, Credit, and Participant Assignments rule types.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrganizationId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time when the rule becomes inactive. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false
        },
        "Rules":{
            "title":"Rules",
            "type":"array",
            "description":"The rules resource is used to create, view, update, or delete the child nodes for the rule hierarchy. The rules form the building blocks of a rule hierarchy and are date effective.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationRuleHierarchies-Rules-item-post-request"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"160",
            "type":"string",
            "description":"The name of the rule.",
            "nullable":false
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when the rule becomes active. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false
        },
        "RuleNumber":{
            "title":"Rule Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the rule. This value can be system-generated or user-provided during a create action.",
            "nullable":true
        },
        "RuleAssignments":{
            "title":"Rule Assignments",
            "type":"array",
            "description":"The rule assignments resource is used create, view, update, or delete the receiver of the credits, for a matching transaction, when a rule wins. Classification adds credit categories to matching transactions, and Participant role assignment rules assign eligible roles to matching participants. The rule assignments for Rollup and Team rules are used to create indirect credits.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationRuleHierarchies-RuleAssignments-item-post-request"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the rule is enabled.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : Qualifying Criteria

Type: array

Title: Qualifying Criteria

The qualifying criteria resource is used create and view how the transactions are matched for classification and credit processing. Use the Configure Tables and Columns task in the Setup and Maintenance work area to enable application table columns for use as qualifying criteria attributes in classification, direct credit, and participant assignment rules. You can also define your own qualifiers based on a descriptive flex field.

Show Source

• Array of: object schema

{
    "title":"Qualifying Criteria",
    "type":"array",
    "description":"The qualifying criteria resource is used create and view how the transactions are matched for classification and credit processing. Use the Configure Tables and Columns task in the Setup and Maintenance work area to enable application table columns for use as qualifying criteria attributes in classification, direct credit, and participant assignment rules. You can also define your own qualifiers based on a descriptive flex field.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationRuleHierarchies-QualifyingCriteria-item-post-request"
    }
}

Nested Schema : Rule Assignments

Type: array

Title: Rule Assignments

The rule assignments resource is used create, view, update, or delete the receiver of the credits, for a matching transaction, when a rule wins. Classification adds credit categories to matching transactions, and Participant role assignment rules assign eligible roles to matching participants. The rule assignments for Rollup and Team rules are used to create indirect credits.

Show Source

• Array of: object incentiveCompensationRuleHierarchies-RuleAssignments-item-post-request

{
    "title":"Rule Assignments",
    "type":"array",
    "description":"The rule assignments resource is used create, view, update, or delete the receiver of the credits, for a matching transaction, when a rule wins. Classification adds credit categories to matching transactions, and Participant role assignment rules assign eligible roles to matching participants. The rule assignments for Rollup and Team rules are used to create indirect credits.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationRuleHierarchies-RuleAssignments-item-post-request"
    }
}

Nested Schema : Rules

Type: array

Title: Rules

The rules resource is used to create, view, update, or delete the child nodes for the rule hierarchy. The rules form the building blocks of a rule hierarchy and are date effective.

Show Source

• Array of: object schema

{
    "title":"Rules",
    "type":"array",
    "description":"The rules resource is used to create, view, update, or delete the child nodes for the rule hierarchy. The rules form the building blocks of a rule hierarchy and are date effective.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationRuleHierarchies-Rules-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AttributeUsageId(required): integer (int64)
  Title: Attribute Usage Identifier

  The unique identifier of the rule attribute usage. This value specifies the applicability of the qualifier for a rule type.
• OrganizationId(required): integer (int64)
  The unique identifier of the business unit.
• QualifyingAttributeValues: array Qualifying Attribute Values
  Title: Qualifying Attribute Values

  The attribute values resource, along with the operators such as Equal to, Like etc., is used create, view, update, or delete the qualifying criterion for a rule.
• RuleId(required): integer (int64)
  The unique identifier of the rule.

{
    "required":[
        "AttributeUsageId",
        "OrganizationId",
        "RuleId"
    ],
    "type":"object",
    "properties":{
        "QualifyingAttributeValues":{
            "title":"Qualifying Attribute Values",
            "type":"array",
            "description":"The attribute values resource, along with the operators such as Equal to, Like etc., is used create, view, update, or delete the qualifying criterion for a rule.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationRuleHierarchies-QualifyingCriteria-QualifyingAttributeValues-item-post-request"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AttributeUsageId":{
            "title":"Attribute Usage Identifier",
            "type":"integer",
            "description":"The unique identifier of the rule attribute usage. This value specifies the applicability of the qualifier for a rule type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "RuleId":{
            "type":"integer",
            "description":"The unique identifier of the rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : Qualifying Attribute Values

Type: array

Title: Qualifying Attribute Values

The attribute values resource, along with the operators such as Equal to, Like etc., is used create, view, update, or delete the qualifying criterion for a rule.

Show Source

• Array of: object schema

{
    "title":"Qualifying Attribute Values",
    "type":"array",
    "description":"The attribute values resource, along with the operators such as Equal to, Like etc., is used create, view, update, or delete the qualifying criterion for a rule.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationRuleHierarchies-QualifyingCriteria-QualifyingAttributeValues-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• ComparisonOperator: string
  Title: Operator

  Maximum Length: 30

  Default Value: EQUAL_TO

  The comparison operators such as equal to, like, and between. A list of accepted values is defined in the lookup type CN_RS_COMPARISON_OPERATORS. Review the values for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• HighValueCharacter: string
  Title: Character High Value

  Maximum Length: 360

  The high value of a character attribute. This value is applicable if the qualifying criteria is a free text and the operator is between.
• HighValueNumber: integer
  Title: High Value Number

  The high value of a number attribute. This value is applicable if the qualifying criteria is a number and the operator is between.
• LowValueCharacter: string
  Title: Character Low Value

  Maximum Length: 360

  The low value of a character attribute. This value is applicable if the qualifying criteria is a free text.
• LowValueCharacterCode: string
  Maximum Length: 360

  The lookup code for the qualifying criteria value. This value is applicable if the qualifying criteria is based on a lookup value set, such as transaction type.
• LowValueCharacterId: integer (int64)
  The unique identifier of the attribute value. Applicable if the qualifying criteria is based on user defined object value set such as credit category.
• LowValueNumber: integer
  Title: Low Value Number

  The low value of a number attribute. This value is applicable if the qualifying criteria is a number and the operator is between.
• OrganizationId: integer (int64)
  The unique identifier of the business unit.
• RuleAttributeId: integer (int64)
  The unique identifier of the rule attribute.

{
    "type":"object",
    "properties":{
        "ComparisonOperator":{
            "title":"Operator",
            "maxLength":"30",
            "type":"string",
            "description":"The comparison operators such as equal to, like, and between. A list of accepted values is defined in the lookup type CN_RS_COMPARISON_OPERATORS. Review the values for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "default":"EQUAL_TO",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "HighValueCharacter":{
            "title":"Character High Value",
            "maxLength":"360",
            "type":"string",
            "description":"The high value of a character attribute. This value is applicable if the qualifying criteria is a free text and the operator is between.",
            "nullable":true
        },
        "LowValueNumber":{
            "title":"Low Value Number",
            "type":"integer",
            "description":"The low value of a number attribute. This value is applicable if the qualifying criteria is a number and the operator is between.",
            "nullable":true
        },
        "RuleAttributeId":{
            "type":"integer",
            "description":"The unique identifier of the rule attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LowValueCharacterCode":{
            "maxLength":"360",
            "type":"string",
            "description":"The lookup code for the qualifying criteria value. This value is applicable if the qualifying criteria is based on a lookup value set, such as transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "HighValueNumber":{
            "title":"High Value Number",
            "type":"integer",
            "description":"The high value of a number attribute. This value is applicable if the qualifying criteria is a number and the operator is between.",
            "nullable":true
        },
        "LowValueCharacterId":{
            "type":"integer",
            "description":"The unique identifier of the attribute value. Applicable if the qualifying criteria is based on user defined object value set such as credit category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LowValueCharacter":{
            "title":"Character Low Value",
            "maxLength":"360",
            "type":"string",
            "description":"The low value of a character attribute. This value is applicable if the qualifying criteria is a free text.",
            "nullable":true
        }
    }
}

Nested Schema : incentiveCompensationRuleHierarchies-RuleAssignments-item-post-request

Type: object

Show Source

• AssignedObjectId: integer (int64)
  Title: Name

  The unique identifier of the assigned object.
• AssignedObjectType: string
  Title: Type

  Maximum Length: 30

  The type of assignment, such as participant, role, team, group, or eligible category.
• EndDate: string (date)
  Title: End Date

  The date and time when the rule assignment becomes inactive. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types.
• GroupMemberCreditFlag: boolean
  Title: Receive direct credit

  Maximum Length: 1

  Default Value: false

  Indicates whether a member of the group will get credit for other group member direct credits. This value is applicable for Rollup and Analyst Hierarchy rule types.
• OrganizationId: integer (int64)
  The unique identifier of the business unit.
• RevenueType: string
  Title: Revenue Type

  Maximum Length: 30

  Default Value: REVENUE

  The type of the generated credit, such as revenue or non-revenue. This value is applicable for Credit and Rollup rule types. A list of accepted values is defined in the lookup type CN_RS_REVENUE_TYPE. Review the values for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• RoleId: integer (int64)
  Title: Role

  The unique identifier of a role associated with a participant. This value is applicable if the assigned object type is participant.
• RollupFlag: boolean
  Title: Roll Up to Parents

  Maximum Length: 1

  Default Value: false

  Indicates whether rollup credits will be generated for the credit receiver. This value is applicable for Credit rule type.
• RuleId: integer (int64)
  Title: Parent

  The unique identifier of the rule.
• SplitPercent: number
  Title: Split Percent

  Default Value: 100

  The percentage number applied against the transaction amount to calculate the credit amount. This value is applicable for the Credit rule type.
• StartDate: string (date)
  Title: Start Date

  The date and time when the rule assignment becomes active. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types.
• SummaryFlag: boolean
  Title: Summarize rollups

  Maximum Length: 1

  Default Value: false

  Indicates whether participant will receive summarized direct credit or individual direct credit as indirect credits. This value is applicable for Credit and Rollup rule types.

{
    "type":"object",
    "properties":{
        "RollupFlag":{
            "title":"Roll Up to Parents",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether rollup credits will be generated for the credit receiver. This value is applicable for Credit rule type.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AssignedObjectId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of the assigned object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"default",
                "precision":"18"
            }
        },
        "GroupMemberCreditFlag":{
            "title":"Receive direct credit",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a member of the group will get credit for other group member direct credits. This value is applicable for Rollup and Analyst Hierarchy rule types.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RuleId":{
            "title":"Parent",
            "type":"integer",
            "description":"The unique identifier of the rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time when the rule assignment becomes inactive. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types.",
            "format":"date",
            "nullable":false
        },
        "RoleId":{
            "title":"Role",
            "type":"integer",
            "description":"The unique identifier of a role associated with a participant. This value is applicable if the assigned object type is participant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when the rule assignment becomes active. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types.",
            "format":"date",
            "nullable":false
        },
        "SplitPercent":{
            "title":"Split Percent",
            "type":"number",
            "description":"The percentage number applied against the transaction amount to calculate the credit amount. This value is applicable for the Credit rule type.",
            "nullable":true,
            "default":"100"
        },
        "AssignedObjectType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of assignment, such as participant, role, team, group, or eligible category.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SummaryFlag":{
            "title":"Summarize rollups",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether participant will receive summarized direct credit or individual direct credit as indirect credits. This value is applicable for Credit and Rollup rule types.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RevenueType":{
            "title":"Revenue Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the generated credit, such as revenue or non-revenue. This value is applicable for Credit and Rollup rule types. A list of accepted values is defined in the lookup type CN_RS_REVENUE_TYPE. Review the values for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "default":"REVENUE",
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• Description: string
  Title: Description

  Maximum Length: 1000

  The description of the rule.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Indicates whether the rule is enabled.
• EndDate: string (date)
  Title: End Date

  The date and time when the rule becomes inactive. The acceptable format is yyyy-mm-dd.
• Name: string
  Title: Name

  Maximum Length: 160

  The name of the rule.
• NumberOfWinners: integer (int32)
  Title: Number of Winners

  Default Value: 1

  The number of rules that can win based on the matching criteria and rank. This value is applicable for Credit and Participant Assignments rule types.
• OrganizationId: integer (int64)
  Title: Business Unit

  The unique identifier of the business unit.
• ParentRuleId: integer (int64)
  Title: Parent

  The unique identifier of the parent rule. This value is defaulted to the rule identifier of the parent rule.
• Rank: integer (int64)
  Title: Rank

  The preference of a rule. This value is useful for breaking ties between other winning rules during the assignment. The rule with the lowest rank number is preferred against other winning rules in the same hierarchy level. This value is applicable for Classification, Credit, and Participant Assignments rule types.
• RuleNumber: string
  Title: Rule Number

  Maximum Length: 30

  The unique identifier for the rule. This value can be system-generated or user-provided during a create action.
• RuleTypeId: integer (int64)
  Title: Rule Type

  The unique identifier of the rule type.
• StartDate: string (date)
  Title: Start Date

  The date and time when the rule becomes active. The acceptable format is yyyy-mm-dd.

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when the rule becomes active. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false
        },
        "NumberOfWinners":{
            "title":"Number of Winners",
            "type":"integer",
            "description":"The number of rules that can win based on the matching criteria and rank. This value is applicable for Credit and Participant Assignments rule types.",
            "format":"int32",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "precision":"9"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the rule.",
            "nullable":true
        },
        "RuleTypeId":{
            "title":"Rule Type",
            "type":"integer",
            "description":"The unique identifier of the rule type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "ParentRuleId":{
            "title":"Parent",
            "type":"integer",
            "description":"The unique identifier of the parent rule. This value is defaulted to the rule identifier of the parent rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "RuleNumber":{
            "title":"Rule Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the rule. This value can be system-generated or user-provided during a create action.",
            "nullable":true
        },
        "Rank":{
            "title":"Rank",
            "type":"integer",
            "description":"The preference of a rule. This value is useful for breaking ties between other winning rules during the assignment. The rule with the lowest rank number is preferred against other winning rules in the same hierarchy level. This value is applicable for Classification, Credit, and Participant Assignments rule types.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrganizationId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the rule is enabled.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time when the rule becomes inactive. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false
        },
        "Name":{
            "title":"Name",
            "maxLength":"160",
            "type":"string",
            "description":"The name of the rule.",
            "nullable":false
        }
    }
}

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 : incentiveCompensationRuleHierarchies-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the rule hierarchy.
• CreationDate: string (date-time)
  Read Only: true

  The date when the hierarchy was created.
• Description: string
  Title: Description

  Maximum Length: 1000

  The description of the rule.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Indicates whether the rule is enabled.
• EndDate: string (date)
  Title: End Date

  The date and time when the rule becomes inactive. The acceptable format is yyyy-mm-dd.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the hierarchy was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the hierarchy.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the hierarchy.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 160

  The name of the rule.
• NumberOfWinners: integer (int32)
  Title: Number of Winners

  Default Value: 1

  The number of rules that can win based on the matching criteria and rank. This value is applicable for Credit and Participant Assignments rule types.
• OrganizationId: integer (int64)
  Title: Business Unit

  The unique identifier of the business unit.
• ParentRuleId: integer (int64)
  Title: Parent

  The unique identifier of the parent rule. This value is defaulted to the rule identifier of the parent rule.
• ParentRuleName: string
  Title: Name

  Read Only: true

  Maximum Length: 160

  The name of the parent rule.
• ParentRuleNumber: string
  Title: Rule Number

  Read Only: true

  Maximum Length: 30

  The unique identifier of the parent rule.
• QualifyingCriteria: array Qualifying Criteria
  Title: Qualifying Criteria

  The qualifying criteria resource is used create and view how the transactions are matched for classification and credit processing. Use the Configure Tables and Columns task in the Setup and Maintenance work area to enable application table columns for use as qualifying criteria attributes in classification, direct credit, and participant assignment rules. You can also define your own qualifiers based on a descriptive flex field.
• Rank: integer (int64)
  Title: Rank

  The preference of a rule. This value is useful for breaking ties between other winning rules during the assignment. The rule with the lowest rank number is preferred against other winning rules in the same hierarchy level. This value is applicable for Classification, Credit, and Participant Assignments rule types.
• RuleAssignments: array Rule Assignments
  Title: Rule Assignments

  The rule assignments resource is used create, view, update, or delete the receiver of the credits, for a matching transaction, when a rule wins. Classification adds credit categories to matching transactions, and Participant role assignment rules assign eligible roles to matching participants. The rule assignments for Rollup and Team rules are used to create indirect credits.
• RuleId: integer (int64)
  Read Only: true

  The unique identifier of a rule. This values is generated during a create action.
• RuleNumber: string
  Title: Rule Number

  Maximum Length: 30

  The unique identifier for the rule. This value can be system-generated or user-provided during a create action.
• Rules: array Rules
  Title: Rules

  The rules resource is used to create, view, update, or delete the child nodes for the rule hierarchy. The rules form the building blocks of a rule hierarchy and are date effective.
• RuleTypeId: integer (int64)
  Title: Rule Type

  The unique identifier of the rule type.
• StartDate: string (date)
  Title: Start Date

  The date and time when the rule becomes active. The acceptable format is yyyy-mm-dd.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the hierarchy.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "NumberOfWinners":{
            "title":"Number of Winners",
            "type":"integer",
            "description":"The number of rules that can win based on the matching criteria and rank. This value is applicable for Credit and Participant Assignments rule types.",
            "format":"int32",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the hierarchy was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the rule hierarchy.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the rule.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleTypeId":{
            "title":"Rule Type",
            "type":"integer",
            "description":"The unique identifier of the rule type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentRuleName":{
            "title":"Name",
            "maxLength":"160",
            "type":"string",
            "description":"The name of the parent rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentRuleId":{
            "title":"Parent",
            "type":"integer",
            "description":"The unique identifier of the parent rule. This value is defaulted to the rule identifier of the parent rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "RuleId":{
            "type":"integer",
            "description":"The unique identifier of a rule. This values is generated during a create action.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QualifyingCriteria":{
            "title":"Qualifying Criteria",
            "type":"array",
            "description":"The qualifying criteria resource is used create and view how the transactions are matched for classification and credit processing. Use the Configure Tables and Columns task in the Setup and Maintenance work area to enable application table columns for use as qualifying criteria attributes in classification, direct credit, and participant assignment rules. You can also define your own qualifiers based on a descriptive flex field.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationRuleHierarchies-QualifyingCriteria-item-response"
            }
        },
        "Rank":{
            "title":"Rank",
            "type":"integer",
            "description":"The preference of a rule. This value is useful for breaking ties between other winning rules during the assignment. The rule with the lowest rank number is preferred against other winning rules in the same hierarchy level. This value is applicable for Classification, Credit, and Participant Assignments rule types.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentRuleNumber":{
            "title":"Rule Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the parent rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time when the rule becomes inactive. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "Rules":{
            "title":"Rules",
            "type":"array",
            "description":"The rules resource is used to create, view, update, or delete the child nodes for the rule hierarchy. The rules form the building blocks of a rule hierarchy and are date effective.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationRuleHierarchies-Rules-item-response"
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":"160",
            "type":"string",
            "description":"The name of the rule.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when the rule becomes active. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleNumber":{
            "title":"Rule Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the rule. This value can be system-generated or user-provided during a create action.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleAssignments":{
            "title":"Rule Assignments",
            "type":"array",
            "description":"The rule assignments resource is used create, view, update, or delete the receiver of the credits, for a matching transaction, when a rule wins. Classification adds credit categories to matching transactions, and Participant role assignment rules assign eligible roles to matching participants. The rule assignments for Rollup and Team rules are used to create indirect credits.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationRuleHierarchies-RuleAssignments-item-response"
            }
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the rule is enabled.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the hierarchy was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "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 : Qualifying Criteria

Type: array

Title: Qualifying Criteria

The qualifying criteria resource is used create and view how the transactions are matched for classification and credit processing. Use the Configure Tables and Columns task in the Setup and Maintenance work area to enable application table columns for use as qualifying criteria attributes in classification, direct credit, and participant assignment rules. You can also define your own qualifiers based on a descriptive flex field.

Show Source

• Array of: object incentiveCompensationRuleHierarchies-QualifyingCriteria-item-response

{
    "title":"Qualifying Criteria",
    "type":"array",
    "description":"The qualifying criteria resource is used create and view how the transactions are matched for classification and credit processing. Use the Configure Tables and Columns task in the Setup and Maintenance work area to enable application table columns for use as qualifying criteria attributes in classification, direct credit, and participant assignment rules. You can also define your own qualifiers based on a descriptive flex field.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationRuleHierarchies-QualifyingCriteria-item-response"
    }
}

Nested Schema : Rule Assignments

Type: array

Title: Rule Assignments

The rule assignments resource is used create, view, update, or delete the receiver of the credits, for a matching transaction, when a rule wins. Classification adds credit categories to matching transactions, and Participant role assignment rules assign eligible roles to matching participants. The rule assignments for Rollup and Team rules are used to create indirect credits.

Show Source

• Array of: object incentiveCompensationRuleHierarchies-RuleAssignments-item-response

{
    "title":"Rule Assignments",
    "type":"array",
    "description":"The rule assignments resource is used create, view, update, or delete the receiver of the credits, for a matching transaction, when a rule wins. Classification adds credit categories to matching transactions, and Participant role assignment rules assign eligible roles to matching participants. The rule assignments for Rollup and Team rules are used to create indirect credits.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationRuleHierarchies-RuleAssignments-item-response"
    }
}

Nested Schema : Rules

Type: array

Title: Rules

The rules resource is used to create, view, update, or delete the child nodes for the rule hierarchy. The rules form the building blocks of a rule hierarchy and are date effective.

Show Source

• Array of: object incentiveCompensationRuleHierarchies-Rules-item-response

{
    "title":"Rules",
    "type":"array",
    "description":"The rules resource is used to create, view, update, or delete the child nodes for the rule hierarchy. The rules form the building blocks of a rule hierarchy and are date effective.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationRuleHierarchies-Rules-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 : incentiveCompensationRuleHierarchies-QualifyingCriteria-item-response

Type: object

Show Source

• AttributeUsageId: integer (int64)
  Title: Attribute Usage Identifier

  The unique identifier of the rule attribute usage. This value specifies the applicability of the qualifier for a rule type.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the qualifying criterion.
• CreationDate: string (date-time)
  Read Only: true

  The date when the qualifying criterion was created.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of the qualifying criterion.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the qualifying criterion was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the qualifying criterion.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the qualifying criterion.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Attribute Name

  Read Only: true

  Maximum Length: 160

  The name of the qualifying criterion.
• OrganizationId: integer (int64)
  The unique identifier of the business unit.
• QualifyingAttributeValues: array Qualifying Attribute Values
  Title: Qualifying Attribute Values

  The attribute values resource, along with the operators such as Equal to, Like etc., is used create, view, update, or delete the qualifying criterion for a rule.
• RuleAttributeId: integer (int64)
  Read Only: true

  The unique identifier of the rule attribute. This value is generated during a create action.
• RuleId: integer (int64)
  The unique identifier of the rule.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the qualifying criterion.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the qualifying criterion was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the qualifying criterion.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the qualifying criterion.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RuleId":{
            "type":"integer",
            "description":"The unique identifier of the rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RuleAttributeId":{
            "type":"integer",
            "description":"The unique identifier of the rule attribute. This value is generated during a create action.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "QualifyingAttributeValues":{
            "title":"Qualifying Attribute Values",
            "type":"array",
            "description":"The attribute values resource, along with the operators such as Equal to, Like etc., is used create, view, update, or delete the qualifying criterion for a rule.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationRuleHierarchies-QualifyingCriteria-QualifyingAttributeValues-item-response"
            }
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Attribute Name",
            "maxLength":"160",
            "type":"string",
            "description":"The name of the qualifying criterion.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeUsageId":{
            "title":"Attribute Usage Identifier",
            "type":"integer",
            "description":"The unique identifier of the rule attribute usage. This value specifies the applicability of the qualifier for a rule type.",
            "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"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the qualifying criterion was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the qualifying criterion.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "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 : Qualifying Attribute Values

Type: array

Title: Qualifying Attribute Values

The attribute values resource, along with the operators such as Equal to, Like etc., is used create, view, update, or delete the qualifying criterion for a rule.

Show Source

• Array of: object incentiveCompensationRuleHierarchies-QualifyingCriteria-QualifyingAttributeValues-item-response

{
    "title":"Qualifying Attribute Values",
    "type":"array",
    "description":"The attribute values resource, along with the operators such as Equal to, Like etc., is used create, view, update, or delete the qualifying criterion for a rule.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationRuleHierarchies-QualifyingCriteria-QualifyingAttributeValues-item-response"
    }
}

Nested Schema : incentiveCompensationRuleHierarchies-QualifyingCriteria-QualifyingAttributeValues-item-response

Type: object

Show Source

• ComparisonOperator: string
  Title: Operator

  Maximum Length: 30

  Default Value: EQUAL_TO

  The comparison operators such as equal to, like, and between. A list of accepted values is defined in the lookup type CN_RS_COMPARISON_OPERATORS. Review the values for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the qualifying attribute value.
• CreationDate: string (date-time)
  Read Only: true

  The date when the qualifying attribute value was created.
• HighValueCharacter: string
  Title: Character High Value

  Maximum Length: 360

  The high value of a character attribute. This value is applicable if the qualifying criteria is a free text and the operator is between.
• HighValueNumber: integer
  Title: High Value Number

  The high value of a number attribute. This value is applicable if the qualifying criteria is a number and the operator is between.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the qualifying attribute value was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the qualifying attribute value.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the qualifying attribute value.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LowValueCharacter: string
  Title: Character Low Value

  Maximum Length: 360

  The low value of a character attribute. This value is applicable if the qualifying criteria is a free text.
• LowValueCharacterCode: string
  Maximum Length: 360

  The lookup code for the qualifying criteria value. This value is applicable if the qualifying criteria is based on a lookup value set, such as transaction type.
• LowValueCharacterId: integer (int64)
  The unique identifier of the attribute value. Applicable if the qualifying criteria is based on user defined object value set such as credit category.
• LowValueNumber: integer
  Title: Low Value Number

  The low value of a number attribute. This value is applicable if the qualifying criteria is a number and the operator is between.
• OrganizationId: integer (int64)
  The unique identifier of the business unit.
• RuleAttributeId: integer (int64)
  The unique identifier of the rule attribute.
• RuleAttributeValueId: integer (int64)
  Read Only: true

  The unique identifier of the rule attribute value.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the qualifying attribute value.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RuleAttributeValueId":{
            "type":"integer",
            "description":"The unique identifier of the rule attribute value.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the qualifying attribute value was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "ComparisonOperator":{
            "title":"Operator",
            "maxLength":"30",
            "type":"string",
            "description":"The comparison operators such as equal to, like, and between. A list of accepted values is defined in the lookup type CN_RS_COMPARISON_OPERATORS. Review the values for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "default":"EQUAL_TO",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the qualifying attribute value.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "RuleAttributeId":{
            "type":"integer",
            "description":"The unique identifier of the rule attribute.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "HighValueNumber":{
            "title":"High Value Number",
            "type":"integer",
            "description":"The high value of a number attribute. This value is applicable if the qualifying criteria is a number and the operator is between.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "HighValueCharacter":{
            "title":"Character High Value",
            "maxLength":"360",
            "type":"string",
            "description":"The high value of a character attribute. This value is applicable if the qualifying criteria is a free text and the operator is between.",
            "nullable":true,
            "x-queryable":true
        },
        "LowValueNumber":{
            "title":"Low Value Number",
            "type":"integer",
            "description":"The low value of a number attribute. This value is applicable if the qualifying criteria is a number and the operator is between.",
            "nullable":true,
            "x-queryable":true
        },
        "LowValueCharacterCode":{
            "maxLength":"360",
            "type":"string",
            "description":"The lookup code for the qualifying criteria value. This value is applicable if the qualifying criteria is based on a lookup value set, such as transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LowValueCharacterId":{
            "type":"integer",
            "description":"The unique identifier of the attribute value. Applicable if the qualifying criteria is based on user defined object value set such as credit category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "LowValueCharacter":{
            "title":"Character Low Value",
            "maxLength":"360",
            "type":"string",
            "description":"The low value of a character attribute. This value is applicable if the qualifying criteria is a free text.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the qualifying attribute value was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the qualifying attribute value.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "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 : incentiveCompensationRuleHierarchies-RuleAssignments-item-response

Type: object

Show Source

• AssignedObjectId: integer (int64)
  Title: Name

  The unique identifier of the assigned object.
• AssignedObjectName: string
  Read Only: true

  The name of the assigned object.
• AssignedObjectType: string
  Title: Type

  Maximum Length: 30

  The type of assignment, such as participant, role, team, group, or eligible category.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the rule assignment.
• CreationDate: string (date-time)
  Read Only: true

  The date when the rule assignment was created.
• EndDate: string (date)
  Title: End Date

  The date and time when the rule assignment becomes inactive. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types.
• GroupMemberCreditFlag: boolean
  Title: Receive direct credit

  Maximum Length: 1

  Default Value: false

  Indicates whether a member of the group will get credit for other group member direct credits. This value is applicable for Rollup and Analyst Hierarchy rule types.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the rule assignment was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the rule assignment.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the rule assignment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  The unique identifier of the business unit.
• RevenueType: string
  Title: Revenue Type

  Maximum Length: 30

  Default Value: REVENUE

  The type of the generated credit, such as revenue or non-revenue. This value is applicable for Credit and Rollup rule types. A list of accepted values is defined in the lookup type CN_RS_REVENUE_TYPE. Review the values for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• RoleId: integer (int64)
  Title: Role

  The unique identifier of a role associated with a participant. This value is applicable if the assigned object type is participant.
• RoleName: string
  Title: Name

  Read Only: true

  Maximum Length: 60

  The name of the role associated with the participant assigned to the rule.
• RollupFlag: boolean
  Title: Roll Up to Parents

  Maximum Length: 1

  Default Value: false

  Indicates whether rollup credits will be generated for the credit receiver. This value is applicable for Credit rule type.
• RuleAssignmentId: integer (int64)
  Read Only: true

  The unique identifier of rule assignment. This value is generated during a create action.
• RuleId: integer (int64)
  Title: Parent

  The unique identifier of the rule.
• SplitPercent: number
  Title: Split Percent

  Default Value: 100

  The percentage number applied against the transaction amount to calculate the credit amount. This value is applicable for the Credit rule type.
• StartDate: string (date)
  Title: Start Date

  The date and time when the rule assignment becomes active. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types.
• SummaryFlag: boolean
  Title: Summarize rollups

  Maximum Length: 1

  Default Value: false

  Indicates whether participant will receive summarized direct credit or individual direct credit as indirect credits. This value is applicable for Credit and Rollup rule types.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the rule assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedObjectName":{
            "type":"string",
            "description":"The name of the assigned object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the rule assignment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RollupFlag":{
            "title":"Roll Up to Parents",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether rollup credits will be generated for the credit receiver. This value is applicable for Credit rule type.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the rule assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignedObjectId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of the assigned object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"default",
                "precision":"18"
            },
            "x-queryable":true
        },
        "GroupMemberCreditFlag":{
            "title":"Receive direct credit",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a member of the group will get credit for other group member direct credits. This value is applicable for Rollup and Analyst Hierarchy rule types.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RuleId":{
            "title":"Parent",
            "type":"integer",
            "description":"The unique identifier of the rule.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time when the rule assignment becomes inactive. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "RoleId":{
            "title":"Role",
            "type":"integer",
            "description":"The unique identifier of a role associated with a participant. This value is applicable if the assigned object type is participant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when the rule assignment becomes active. The acceptable format is yyyy-mm-dd. This value is applicable for Credit, Rollup, Team, Analyst Hierarchy, and Participant Assignments rule types.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the role associated with the participant assigned to the rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SplitPercent":{
            "title":"Split Percent",
            "type":"number",
            "description":"The percentage number applied against the transaction amount to calculate the credit amount. This value is applicable for the Credit rule type.",
            "nullable":true,
            "default":"100",
            "x-queryable":true
        },
        "RuleAssignmentId":{
            "type":"integer",
            "description":"The unique identifier of rule assignment. This value is generated during a create action.",
            "format":"int64",
            "nullable":false,
            "readOnly":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"
            }
        },
        "AssignedObjectType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of assignment, such as participant, role, team, group, or eligible category.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SummaryFlag":{
            "title":"Summarize rollups",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether participant will receive summarized direct credit or individual direct credit as indirect credits. This value is applicable for Credit and Rollup rule types.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RevenueType":{
            "title":"Revenue Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the generated credit, such as revenue or non-revenue. This value is applicable for Credit and Rollup rule types. A list of accepted values is defined in the lookup type CN_RS_REVENUE_TYPE. Review the values for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "default":"REVENUE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the rule assignment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the rule assignment.",
            "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 : incentiveCompensationRuleHierarchies-Rules-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the rule hierarchy.
• CreationDate: string (date-time)
  Read Only: true

  The date when the hierarchy was created.
• Description: string
  Title: Description

  Maximum Length: 1000

  The description of the rule.
• EnabledFlag: boolean
  Title: Enabled

  Maximum Length: 1

  Default Value: true

  Indicates whether the rule is enabled.
• EndDate: string (date)
  Title: End Date

  The date and time when the rule becomes inactive. The acceptable format is yyyy-mm-dd.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the hierarchy was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the hierarchy.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the hierarchy.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Title: Name

  Maximum Length: 160

  The name of the rule.
• NumberOfWinners: integer (int32)
  Title: Number of Winners

  Default Value: 1

  The number of rules that can win based on the matching criteria and rank. This value is applicable for Credit and Participant Assignments rule types.
• OrganizationId: integer (int64)
  Title: Business Unit

  The unique identifier of the business unit.
• ParentRuleId: integer (int64)
  Title: Parent

  The unique identifier of the parent rule. This value is defaulted to the rule identifier of the parent rule.
• ParentRuleName: string
  Title: Name

  Read Only: true

  Maximum Length: 160

  The name of the parent rule.
• ParentRuleNumber: string
  Title: Rule Number

  Read Only: true

  Maximum Length: 30

  The unique identifier of the parent rule.
• Rank: integer (int64)
  Title: Rank

  The preference of a rule. This value is useful for breaking ties between other winning rules during the assignment. The rule with the lowest rank number is preferred against other winning rules in the same hierarchy level. This value is applicable for Classification, Credit, and Participant Assignments rule types.
• RuleId: integer (int64)
  Read Only: true

  The unique identifier of a rule. This values is generated during a create action.
• RuleNumber: string
  Title: Rule Number

  Maximum Length: 30

  The unique identifier for the rule. This value can be system-generated or user-provided during a create action.
• RuleTypeId: integer (int64)
  Title: Rule Type

  The unique identifier of the rule type.
• StartDate: string (date)
  Title: Start Date

  The date and time when the rule becomes active. The acceptable format is yyyy-mm-dd.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the hierarchy.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "NumberOfWinners":{
            "title":"Number of Winners",
            "type":"integer",
            "description":"The number of rules that can win based on the matching criteria and rank. This value is applicable for Credit and Participant Assignments rule types.",
            "format":"int32",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the hierarchy was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the rule hierarchy.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the rule.",
            "nullable":true,
            "x-queryable":true
        },
        "RuleTypeId":{
            "title":"Rule Type",
            "type":"integer",
            "description":"The unique identifier of the rule type.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentRuleName":{
            "title":"Name",
            "maxLength":"160",
            "type":"string",
            "description":"The name of the parent rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentRuleId":{
            "title":"Parent",
            "type":"integer",
            "description":"The unique identifier of the parent rule. This value is defaulted to the rule identifier of the parent rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "RuleId":{
            "type":"integer",
            "description":"The unique identifier of a rule. This values is generated during a create action.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Rank":{
            "title":"Rank",
            "type":"integer",
            "description":"The preference of a rule. This value is useful for breaking ties between other winning rules during the assignment. The rule with the lowest rank number is preferred against other winning rules in the same hierarchy level. This value is applicable for Classification, Credit, and Participant Assignments rule types.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentRuleNumber":{
            "title":"Rule Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the parent rule.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time when the rule becomes inactive. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":"160",
            "type":"string",
            "description":"The name of the rule.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when the rule becomes active. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleNumber":{
            "title":"Rule Number",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the rule. This value can be system-generated or user-provided during a create action.",
            "nullable":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the rule is enabled.",
            "nullable":true,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the hierarchy was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "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

BusinessUnitLovViewAccessor

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationBusinessUnitsLOV

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

EnabledFlagLovViewAccessor

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_YES_NO

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

ParentRuleViewAccessor

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies

The rule hierarchies resource is used for direct crediting, classification, rollup crediting, team crediting, participant role assignment, and analyst approvals. Rule hierarchies are set of rules arranged in hierarchical fashion, where a child rule inherits the criterion of the parent rule. Rule hierarchies are created and managed for each rule type such as crediting, classification, or rollup.

QualifyingCriteria

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/QualifyingCriteria

Parameters:

• RuleId: $request.path.RuleId

The qualifying criteria resource is used create and view how the transactions are matched for classification and credit processing. Use the Configure Tables and Columns task in the Setup and Maintenance work area to enable application table columns for use as qualifying criteria attributes in classification, direct credit, and participant assignment rules. You can also define your own qualifiers based on a descriptive flex field.

RuleAssignments

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/RuleAssignments

Parameters:

• RuleId: $request.path.RuleId

The rule assignments resource is used create, view, update, or delete the receiver of the credits, for a matching transaction, when a rule wins. Classification adds credit categories to matching transactions, and Participant role assignment rules assign eligible roles to matching participants. The rule assignments for Rollup and Team rules are used to create indirect credits.

RuleTypeLovViewAccessor

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleTypesLOV

Parameters:

• finder: BuIdFinder

The rule types list of values resource is used to view the list of rule types. It indicates the specific usage of the rule such as classification, crediting and other usages.

Rules

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies/{RuleId}/child/Rules

Parameters:

• RuleId: $request.path.RuleId

The rules resource is used to create, view, update, or delete the child nodes for the rule hierarchy. The rules form the building blocks of a rule hierarchy and are date effective.

Back to Top