Jump to

• Request
• Response

Get all participant compensation plans

get

/fscmRestApi/resources/11.13.18.05/participantCompensationPlans

Request

Query Parameters

• effectiveDate: string
  This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • ParticipantPlanNumberAltKey: Finds a participant compensation plan with the specified alternate key.
    Finder Variables:
    • ParticipantPlanNumber; string; The alternate key identifier of the participant plan.
  • PrimaryKey: Finds a participant compensation plan with the specified primary key.
    Finder Variables:
    • SrpCompPlanId; integer; The unique identifier of the participant compensation plan.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AcceptanceStatus; string; The code indicating the participant plan acceptance status, such as accepted or ready to publish. A list of acceptable values is defined for the lookup CN_SRP_APPR_STATUS. Review the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. The acceptance status is updatable when the Enable Plan Approval and Acceptance Workflow attribute is set to the value No for the business unit. Review and update the attribute value using the Setup and Maintenance, Manage Parameters task.
  • AllowCreditCategoryOverlapFlag; boolean; The code indicating whether a credit category can exist in multiple plan components within the compensation plan.
  • BusinessUnitName; string; The name of the business unit to which the participant plan belongs.
  • CompensationPlanId; integer; The unique identifier of the base compensation plan.
  • CompensationPlanName; string; The name of the incentive compensation plan.
  • CreatedBy; string; The user who created the participant compensation plan.
  • CreationDate; string; The date and time when the participant compensation plan is created.
  • Description; string; The description of the compensation plan.
  • EndDate; string; The date when the participant compensation plan becomes inactive.
  • IndividualizeTargetIncentive; string; Indicates if you want to enable individualization of the participant plan target incentive. Possible values include N, or False, and Y, or True.
  • LastUpdateDate; string; The date and time when the participant compensation plan was last updated.
  • LastUpdatedBy; string; The user who last updated the participant compensation plan.
  • OrganizationId; integer; The unique identifier of the business unit to which the participant plan belongs.
  • ParticipantId; integer; The unique identifier of the participant.
  • ParticipantName; string; The name of the participant.
  • ParticipantPlanNumber; string; The alternate key identifier of the participant plan.
  • SrpCompPlanId; integer; The unique identifier of the participant compensation plan.
  • StartDate; string; The date when the participant compensation plan becomes active.
  • TargetIncentive; number; The expected earnings of the participant when all the objectives or goals in a plan are met. The target incentive is updatable when the individualize target incentive is enabled (true).
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : participantCompensationPlans

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/participantCompensationPlans-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object participantCompensationPlans-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/participantCompensationPlans-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : participantCompensationPlans-item-response

Type: object

Show Source

• AcceptanceStatus: string
  Title: Acceptance Status

  Maximum Length: 30

  Default Value: ACCEPTED

  The code indicating the participant plan acceptance status, such as accepted or ready to publish. A list of acceptable values is defined for the lookup CN_SRP_APPR_STATUS. Review the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. The acceptance status is updatable when the Enable Plan Approval and Acceptance Workflow attribute is set to the value No for the business unit. Review and update the attribute value using the Setup and Maintenance, Manage Parameters task.
• AllowCreditCategoryOverlapFlag: boolean
  Title: Allow Credit Category Overlap

  Read Only: true

  Maximum Length: 1

  The code indicating whether a credit category can exist in multiple plan components within the compensation plan.
• BusinessUnitName: string
  Title: Organization

  Read Only: true

  Maximum Length: 240

  The name of the business unit to which the participant plan belongs.
• CompensationPlanId: integer (int64)
  Title: Compensation Plan

  Read Only: true

  The unique identifier of the base compensation plan.
• CompensationPlanName: string
  Title: Compensation Plan

  Read Only: true

  Maximum Length: 80

  The name of the incentive compensation plan.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the participant compensation plan.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the participant compensation plan is created.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of the compensation plan.
• EndDate: string (date)
  Title: End Date

  Read Only: true

  The date when the participant compensation plan becomes inactive.
• IndividualizeTargetIncentive: string
  Title: Individualize target incentive

  Maximum Length: 1

  Indicates if you want to enable individualization of the participant plan target incentive. Possible values include N, or False, and Y, or True.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the participant compensation plan was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the participant compensation plan.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationId: integer (int64)
  Read Only: true

  The unique identifier of the business unit to which the participant plan belongs.
• ParticipantCompensationPlansDFFs: array Descriptive Flex Fields
  Title: Descriptive Flex Fields

  The participant compensation plan descriptive flex fields resource is used to view and update custom attributes for a participant compensation plan. You can configure and deploy participant plan flex fields using the Setup and Maintenance, Manage Incentive Compensation Descriptive Flexfields task.
• ParticipantId: integer (int64)
  Title: Participant

  Read Only: true

  The unique identifier of the participant.
• ParticipantName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the participant.
• ParticipantPlanComponents: array Plan Components
  Title: Plan Components

  The participant compensation plan components resource is used to view and update the plan components for a participant compensation plan. It can also be used to update the plan component target percentage and enable or disable further individualization of goals and rates.
• ParticipantPlanNumber: string
  Title: Participant Plan Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the participant plan.
• SrpCompPlanId: integer (int64)
  Read Only: true

  The unique identifier of the participant compensation plan.
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  The date when the participant compensation plan becomes active.
• TargetIncentive: number
  Title: Target Incentive

  The expected earnings of the participant when all the objectives or goals in a plan are met. The target incentive is updatable when the individualize target incentive is enabled (true).

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the participant compensation plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the participant compensation plan is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcceptanceStatus":{
            "title":"Acceptance Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the participant plan acceptance status, such as accepted or ready to publish. A list of acceptable values is defined for the lookup CN_SRP_APPR_STATUS. Review the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. The acceptance status is updatable when the Enable Plan Approval and Acceptance Workflow attribute is set to the value No for the business unit. Review and update the attribute value using the Setup and Maintenance, Manage Parameters task.",
            "nullable":false,
            "default":"ACCEPTED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SrpCompPlanId":{
            "type":"integer",
            "description":"The unique identifier of the participant compensation plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CompensationPlanId":{
            "title":"Compensation Plan",
            "type":"integer",
            "description":"The unique identifier of the base compensation plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the compensation plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the participant compensation plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompensationPlanName":{
            "title":"Compensation Plan",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the incentive compensation plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the participant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"The unique identifier of the business unit to which the participant plan belongs.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the participant compensation plan becomes inactive.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "title":"Participant",
            "type":"integer",
            "description":"The unique identifier of the participant.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the participant compensation plan becomes active.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetIncentive":{
            "title":"Target Incentive",
            "type":"number",
            "description":"The expected earnings of the participant when all the objectives or goals in a plan are met. The target incentive is updatable when the individualize target incentive is enabled (true).",
            "nullable":false,
            "x-queryable":true
        },
        "IndividualizeTargetIncentive":{
            "title":"Individualize target incentive",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if you want to enable individualization of the participant plan target incentive. Possible values include N, or False, and Y, or True.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ParticipantCompensationPlansDFFs":{
            "title":"Descriptive Flex Fields",
            "type":"array",
            "description":"The participant compensation plan descriptive flex fields resource is used to view and update custom attributes for a participant compensation plan. You can configure and deploy participant plan flex fields using the Setup and Maintenance, Manage Incentive Compensation Descriptive Flexfields task.",
            "items":{
                "$ref":"#/components/schemas/participantCompensationPlans-ParticipantCompensationPlansDFFs-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParticipantPlanNumber":{
            "title":"Participant Plan Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the participant plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowCreditCategoryOverlapFlag":{
            "title":"Allow Credit Category Overlap",
            "maxLength":"1",
            "type":"boolean",
            "description":"The code indicating whether a credit category can exist in multiple plan components within the compensation plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BusinessUnitName":{
            "title":"Organization",
            "maxLength":"240",
            "type":"string",
            "description":"The name of the business unit to which the participant plan belongs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantPlanComponents":{
            "title":"Plan Components",
            "type":"array",
            "description":"The participant compensation plan components resource is used to view and update the plan components for a participant compensation plan. It can also be used to update the plan component target percentage and enable or disable further individualization of goals and rates.",
            "items":{
                "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the participant compensation plan was last updated.",
            "format":"date-time",
            "nullable":false,
            "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 : Descriptive Flex Fields

Type: array

Title: Descriptive Flex Fields

The participant compensation plan descriptive flex fields resource is used to view and update custom attributes for a participant compensation plan. You can configure and deploy participant plan flex fields using the Setup and Maintenance, Manage Incentive Compensation Descriptive Flexfields task.

Show Source

• Array of: object participantCompensationPlans-ParticipantCompensationPlansDFFs-item-response

{
    "title":"Descriptive Flex Fields",
    "type":"array",
    "description":"The participant compensation plan descriptive flex fields resource is used to view and update custom attributes for a participant compensation plan. You can configure and deploy participant plan flex fields using the Setup and Maintenance, Manage Incentive Compensation Descriptive Flexfields task.",
    "items":{
        "$ref":"#/components/schemas/participantCompensationPlans-ParticipantCompensationPlansDFFs-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Plan Components

Type: array

Title: Plan Components

The participant compensation plan components resource is used to view and update the plan components for a participant compensation plan. It can also be used to update the plan component target percentage and enable or disable further individualization of goals and rates.

Show Source

• Array of: object participantCompensationPlans-ParticipantPlanComponents-item-response

{
    "title":"Plan Components",
    "type":"array",
    "description":"The participant compensation plan components resource is used to view and update the plan components for a participant compensation plan. It can also be used to update the plan component target percentage and enable or disable further individualization of goals and rates.",
    "items":{
        "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-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 : participantCompensationPlans-ParticipantCompensationPlansDFFs-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30

  The flex context segment code for the compensation plan. It determines which context-sensitive segments are displayed.
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SrpCompPlanId: integer (int64)
  The unique identifier of the participant compensation plan.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SrpCompPlanId":{
            "type":"integer",
            "description":"The unique identifier of the participant compensation plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "description":"The flex context segment code for the compensation plan. It determines which context-sensitive segments are displayed.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"HIDDEN"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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 : participantCompensationPlans-ParticipantPlanComponents-item-response

Type: object

Show Source

• CalculateIncentive: string
  Title: Calculate Incentive

  Read Only: true

  Maximum Length: 30

  Indicates whether the nature of plan component earning calculation is per event or per interval. Possible values include BONUS for per interval and COMMISSION for per event.
• CalculationPhase: integer (int32)
  Title: Calculation Phase

  Read Only: true

  Indicates the phase in which the application considers plan component for calculation. Possible values are phase 1 and phase 2.
• CalculationSequence: integer (int64)
  Title: Calculation Sequence

  Read Only: true

  Indicates the order in which the calculation engine considers the plan component within a compensation plan.
• CompensationPlanComponentId: integer (int64)
  Read Only: true

  The unique identifier of the plan component associated with the base compensation plan.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the participant compensation plan component.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the participant compensation plan component is created.
• EndDate: string (date)
  Title: End Date

  Read Only: true

  The date when the plan component becomes inactive.
• IncentiveType: string
  Title: Incentive Type

  Read Only: true

  Maximum Length: 30

  The code representing the incentive type, such as bonus or commission. Possible values include BONUS, COMMISSION, and STANDARD. A list of acceptable values is defined in the lookup CN_REPORT_GROUP. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• Individualize: string
  Title: Individualize

  Maximum Length: 30

  Default Value: ORA_CN_PRT_PLN_INDVDLZE_NONE

  Indicates if you want to enable individualization of the plan component measures and rates. Possible values include N, or False, and Y, or True. Changing the value from yes to no removes individualized values.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the participant compensation plan component is last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the participant compensation plan component.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantPlanComponentId: integer (int64)
  Read Only: true

  The unique identifier of the plan component associated with the participant compensation plan.
• ParticipantPlanComponentPerformanceMeasures: array Performance Measures
  Title: Performance Measures

  The plan component performance measures resource is used to view the participant performance measures for a plan component. A performance measure is used to measure the performance attainment.
• ParticipantPlanComponentRateTables: array Rate Tables
  Title: Rate Tables

  The plan component rate tables resource is used to view the rate tables for a participant plan component. The plan component rate table determines the compensation rate for earning calculations.
• PlanComponentId: integer (int64)
  Title: Name

  Read Only: true

  The unique identifier of the base plan component.
• PlanComponentName: string
  Title: Plan Component

  Read Only: true

  Maximum Length: 80

  The name of the plan component.
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  The date when the plan component becomes active.
• TargetIncentivePercent: number
  Title: Target Incentive Percent

  The percentage of influence a plan component has on the compensation plan. For example, a value of 20 indicates the plan component has a 20% influence.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the participant compensation plan component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the participant compensation plan component is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetIncentivePercent":{
            "title":"Target Incentive Percent",
            "type":"number",
            "description":"The percentage of influence a plan component has on the compensation plan. For example, a value of 20 indicates the plan component has a 20% influence.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the participant compensation plan component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IncentiveType":{
            "title":"Incentive Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code representing the incentive type, such as bonus or commission. Possible values include BONUS, COMMISSION, and STANDARD. A list of acceptable values is defined in the lookup CN_REPORT_GROUP. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantPlanComponentPerformanceMeasures":{
            "title":"Performance Measures",
            "type":"array",
            "description":"The plan component performance measures resource is used to view the participant performance measures for a plan component. A performance measure is used to measure the performance attainment.",
            "items":{
                "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-item-response"
            }
        },
        "PlanComponentId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of the base plan component.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CalculateIncentive":{
            "title":"Calculate Incentive",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the nature of plan component earning calculation is per event or per interval. Possible values include BONUS for per interval and COMMISSION for per event.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the plan component becomes inactive.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantPlanComponentRateTables":{
            "title":"Rate Tables",
            "type":"array",
            "description":"The plan component rate tables resource is used to view the rate tables for a participant plan component. The plan component rate table determines the compensation rate for earning calculations.",
            "items":{
                "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentRateTables-item-response"
            }
        },
        "CalculationSequence":{
            "title":"Calculation Sequence",
            "type":"integer",
            "description":"Indicates the order in which the calculation engine considers the plan component within a compensation plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the plan component becomes active.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantPlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the plan component associated with the participant compensation plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Individualize":{
            "title":"Individualize",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if you want to enable individualization of the plan component measures and rates. Possible values include N, or False, and Y, or True. Changing the value from yes to no removes individualized values.",
            "nullable":false,
            "default":"ORA_CN_PRT_PLN_INDVDLZE_NONE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CompensationPlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the plan component associated with the base compensation plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CalculationPhase":{
            "title":"Calculation Phase",
            "type":"integer",
            "description":"Indicates the phase in which the application considers plan component for calculation. Possible values are phase 1 and phase 2.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanComponentName":{
            "title":"Plan Component",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the plan component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the participant compensation plan component is last updated.",
            "format":"date-time",
            "nullable":false,
            "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 : Performance Measures

Type: array

Title: Performance Measures

The plan component performance measures resource is used to view the participant performance measures for a plan component. A performance measure is used to measure the performance attainment.

Show Source

• Array of: object participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-item-response

{
    "title":"Performance Measures",
    "type":"array",
    "description":"The plan component performance measures resource is used to view the participant performance measures for a plan component. A performance measure is used to measure the performance attainment.",
    "items":{
        "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-item-response"
    }
}

Nested Schema : Rate Tables

Type: array

Title: Rate Tables

The plan component rate tables resource is used to view the rate tables for a participant plan component. The plan component rate table determines the compensation rate for earning calculations.

Show Source

• Array of: object participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentRateTables-item-response

{
    "title":"Rate Tables",
    "type":"array",
    "description":"The plan component rate tables resource is used to view the rate tables for a participant plan component. The plan component rate table determines the compensation rate for earning calculations.",
    "items":{
        "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentRateTables-item-response"
    }
}

Nested Schema : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-item-response

Type: object

Show Source

• CalculationSequence: integer (int32)
  Read Only: true

  Indicates the order in which the calculation engine considers a performance measure within a plan component.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the participant performance measure.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the participant performance measure is created.
• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of the performance measure entered while creating the performance measure.
• EarningBasis: string
  Title: Earning Basis

  Read Only: true

  Maximum Length: 1

  Indicates whether attainment and earnings calculations use the same credit categories and whether the incentive formula uses the measure attainment in calculations.
• EndDate: string (date)
  Title: End Date

  Read Only: true

  The date when the performance measure associated with the plan component becomes inactive.
• IncludeInParticipantReportsFlag: boolean
  Title: Include in participant reports

  Read Only: true

  Maximum Length: 1

  Indicates the intent to display or exclude the measure attainment in reports. Valid values are Y and N. If No, then the intent is to exclude the measure attainment in reports. It is useful if the measure results are intermediate calculations which need not be shown in reports.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the participant performance measure is last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the participant performance measure.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeasureFormulaExpressionDescription: string
  Title: Expression Description

  Read Only: true

  Maximum Length: 1000

  The description of the measure formula expression entered while creating the expression.
• MeasureFormulaExpressionId: integer (int64)
  Read Only: true

  The unique identifier of the measure formula expression for this performance measure. The measure formula expression is used to calculate attainment of the performance measure.
• MeasureFormulaExpressionName: string
  Title: Expression Name

  Read Only: true

  Maximum Length: 160

  The name of the expression used in measure formula to calculate attainment of the performance measure.
• NumberOfDimensions: integer (int64)
  Title: Number of Dimensions

  Read Only: true

  The number of dimensions of the scorecard used in the performance measure.
• ParticipantPerformanceMeasureGoals: array Goals
  Title: Goals

  The performance measure goals resource is used to view and update the total target of a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component. The total target defines the performance target across a timeline.
• ParticipantPerformanceMeasureId: integer (int64)
  Read Only: true

  The unique identifier of the performance measure associated with the participant plan component.
• ParticipantPerformanceMeasureScorecards: array Scorecards
  Title: Scorecards

  The performance measure scorecards resource is used to view the scorecards of a participant performance measure. A scorecard is used to establish attainment rates or fixed amounts for different performance levels.
• ParticipantPlanComponentId: integer (int64)
  Read Only: true

  The unique identifier of the plan component associated with the participant compensation plan.
• PerformanceInterval: string
  Title: Performance Interval

  Read Only: true

  Maximum Length: 80

  This is the interval value for the performance measurement. Where a running total is considered, the accumulated value is reset based on this interval value. Interval would represent a unit of time like month, quarter, year.
• PerformanceMeasureId: integer (int64)
  Title: Name

  Read Only: true

  The unique identifier of the performance measure associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• PerformanceMeasureName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  The name of the performance measure, which is an indicator used to measure the progress toward a specified outcome or goal.
• PlanComponentId: integer (int64)
  Read Only: true

  The unique identifier of the plan component associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• ProcessTransactions: string
  Title: Process Transactions

  Read Only: true

  Maximum Length: 30

  Indicates how the application processes transactions in a measure. The possible values include GROUP, for grouping transactions for the specified interval, and INDIVIDUAL to evaluate each transaction independently. A list of acceptable values is defined in the lookup CN_PROCESS_TXN. Review the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• RenderedMeasureFormulaExpression: string (byte)
  Title: Rendered Expression

  Read Only: true

  The entire measure formula expression with all the expression components like operators, attributes, functions, etc. This attribute is used to display the entire expression on the user interface.
• RunningTotalFlag: boolean
  Title: Running total

  Read Only: true

  Maximum Length: 1

  Indicates whether to accumulate a calculation input, such as credit amount or credit quantity, over a period.
• SplitOption: string
  Title: Split Option

  Read Only: true

  Maximum Length: 30

  Indicates how to split the input number to a scorecard dimension. Possible values include NONE to apply a single rate for the entire attainment, NON_PROPORTIONAL to apply multiple rates, which are fixed for an attainment within a tier, and PROPORTIONAL to apply multiple rates, which are proportional for an attainment within a tier. A list of acceptable values is defined in the lookup CN_SPLIT_TYPE_OPTION. Review the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• StartDate: string (date)
  Title: Start Date

  Read Only: true

  The date when the performance measure associated with the plan component becomes active.
• TotalTarget: number
  Title: Total Target

  Read Only: true

  Default Value: 0

  The total target for the performance measure.
• UnitOfMeasure: string
  Title: Unit of Measure

  Read Only: true

  Maximum Length: 30

  The standardized quantity used as a factor to express occurring quantities of the performance measure property. Possible values include AMOUNT for measure attainment is based on an amount, PERCENT for measure attainment is based on a percent, QUANTITY for measure attainment is based on a quantity, and SCORE for measure attainment is based on a score. A list of acceptable values is defined in the lookup CN_MEASURE_UOM. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• UseExternalFormulaFlag: boolean
  Title: Use external formula

  Read Only: true

  Maximum Length: 1

  Indicates whether the performance measure uses an external formula from an external package.
• Weight: integer (int64)
  Title: Weight

  Read Only: true

  The percentage of influence a performance measure has on the plan component.

{
    "type":"object",
    "properties":{
        "PerformanceMeasureName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the performance measure, which is an indicator used to measure the progress toward a specified outcome or goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the participant performance measure is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the performance measure entered while creating the performance measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeasureFormulaExpressionName":{
            "title":"Expression Name",
            "maxLength":"160",
            "type":"string",
            "description":"The name of the expression used in measure formula to calculate attainment of the performance measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeasureFormulaExpressionDescription":{
            "title":"Expression Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the measure formula expression entered while creating the expression.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SplitOption":{
            "title":"Split Option",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates how to split the input number to a scorecard dimension. Possible values include NONE to apply a single rate for the entire attainment, NON_PROPORTIONAL to apply multiple rates, which are fixed for an attainment within a tier, and PROPORTIONAL to apply multiple rates, which are proportional for an attainment within a tier. A list of acceptable values is defined in the lookup CN_SPLIT_TYPE_OPTION. Review the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculationSequence":{
            "type":"integer",
            "description":"Indicates the order in which the calculation engine considers a performance measure within a plan component.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the performance measure associated with the plan component becomes active.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantPlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the plan component associated with the participant compensation plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParticipantPerformanceMeasureScorecards":{
            "title":"Scorecards",
            "type":"array",
            "description":"The performance measure scorecards resource is used to view the scorecards of a participant performance measure. A scorecard is used to establish attainment rates or fixed amounts for different performance levels.",
            "items":{
                "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-item-response"
            }
        },
        "MeasureFormulaExpressionId":{
            "type":"integer",
            "description":"The unique identifier of the measure formula expression for this performance measure. The measure formula expression is used to calculate attainment of the performance measure.",
            "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"
            }
        },
        "UseExternalFormulaFlag":{
            "title":"Use external formula",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the performance measure uses an external formula from an external package.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RenderedMeasureFormulaExpression":{
            "title":"Rendered Expression",
            "type":"string",
            "description":"The entire measure formula expression with all the expression components like operators, attributes, functions, etc. This attribute is used to display the entire expression on the user interface.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProcessTransactions":{
            "title":"Process Transactions",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates how the application processes transactions in a measure. The possible values include GROUP, for grouping transactions for the specified interval, and INDIVIDUAL to evaluate each transaction independently. A list of acceptable values is defined in the lookup CN_PROCESS_TXN. Review the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncludeInParticipantReportsFlag":{
            "title":"Include in participant reports",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the intent to display or exclude the measure attainment in reports. Valid values are Y and N.  If No, then the intent is to exclude the measure attainment in reports. It is useful if the measure results are intermediate calculations which need not be shown in reports.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceInterval":{
            "title":"Performance Interval",
            "maxLength":"80",
            "type":"string",
            "description":"This is the interval value for the performance measurement. Where a running total is considered, the accumulated value is reset based on this interval value. \nInterval would represent a unit of time like month, quarter, year.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the participant performance measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the participant performance measure.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":"30",
            "type":"string",
            "description":"The standardized quantity used as a factor to express occurring quantities of the performance measure property. Possible values include AMOUNT for measure attainment is based on an amount, PERCENT for measure attainment is based on a percent, QUANTITY for measure attainment is based on a quantity, and SCORE for measure attainment is based on a score. A list of acceptable values is defined in the lookup CN_MEASURE_UOM. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantPerformanceMeasureId":{
            "type":"integer",
            "description":"The unique identifier of the performance measure associated with the participant plan component.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PerformanceMeasureId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of the performance measure associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the plan component associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the performance measure associated with the plan component becomes inactive.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Weight":{
            "title":"Weight",
            "type":"integer",
            "description":"The percentage of influence a performance measure has on the plan component.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TotalTarget":{
            "title":"Total Target",
            "type":"number",
            "description":"The total target for the performance measure.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "NumberOfDimensions":{
            "title":"Number of Dimensions",
            "type":"integer",
            "description":"The number of dimensions of the scorecard used in the performance measure.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EarningBasis":{
            "title":"Earning Basis",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether attainment and earnings calculations use the same credit categories and whether the incentive formula uses the measure attainment in calculations.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantPerformanceMeasureGoals":{
            "title":"Goals",
            "type":"array",
            "description":"The performance measure goals resource is used to view and update the total target of a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component. The total target defines the performance target across a timeline.",
            "items":{
                "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-item-response"
            }
        },
        "RunningTotalFlag":{
            "title":"Running total",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether to accumulate a calculation input, such as credit amount or credit quantity, over a period.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the participant performance measure is last updated.",
            "format":"date-time",
            "nullable":false,
            "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 : Goals

Type: array

Title: Goals

The performance measure goals resource is used to view and update the total target of a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component. The total target defines the performance target across a timeline.

Show Source

• Array of: object participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-item-response

{
    "title":"Goals",
    "type":"array",
    "description":"The performance measure goals resource is used to view and update the total target of a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component. The total target defines the performance target across a timeline.",
    "items":{
        "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-item-response"
    }
}

Nested Schema : Scorecards

Type: array

Title: Scorecards

The performance measure scorecards resource is used to view the scorecards of a participant performance measure. A scorecard is used to establish attainment rates or fixed amounts for different performance levels.

Show Source

• Array of: object participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-item-response

{
    "title":"Scorecards",
    "type":"array",
    "description":"The performance measure scorecards resource is used to view the scorecards of a participant performance measure. A scorecard is used to establish attainment rates or fixed amounts for different performance levels.",
    "items":{
        "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-item-response"
    }
}

Nested Schema : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-item-response

Type: object

Show Source

• AlternateTarget1: number
  Title: Alternate Target 1

  Default Value: 0

  The alternate target number for a measure, for example, stretch goal.
• AlternateTarget2: number
  Title: Alternate Target 2

  Default Value: 0

  The alternate target number for a measure, for example, stretch goal.
• AlternateTarget3: number
  Title: Alternate Target 3

  Default Value: 0

  The alternate target number for a measure, for example, stretch goal.
• AlternateTarget4: number
  Title: Alternate Target 4

  Default Value: 0

  The alternate target number for a measure, for example, stretch goal.
• AlternateTarget5: number
  Title: Alternate Target 5

  Default Value: 0

  The alternate target number for a measure, for example, stretch goal.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the participant performance measure goal.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the participant performance measure goal is created.
• DistributeEvenlyFlag: boolean
  The instruction for the application to evenly distribute the total target and alternate targets to the respective interval and period amounts for this web service request. The possible values are TRUE and FALSE.
• GoalId: integer (int64)
  Read Only: true

  The unique identifier of the goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• GoalInterval: string
  Title: Interval

  Read Only: true

  The performance interval that describes the span of time to be measured for the attainment of the goal amounts, such as period, quarter, or year. This interval is the same as the corresponding performance (measure) interval.
• GoalTarget: number
  Title: Total Target

  Default Value: 0

  The expected level of attainment assigned to the participant for the measure.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the participant performance measure goal is last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the participant performance measure goal.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantGoalId: integer (int64)
  Read Only: true

  The unique identifier of the goal associated with the participant performance measure.
• ParticipantGoalIntervalGoals: array Interval Goals
  Title: Interval Goals

  The performance measure interval goals service is used to view the interval target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.
• ParticipantGoalPeriodGoals: array Period Goals
  Title: Period Goals

  The performance measure period goals service is used to view and update the period target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.
• ParticipantPerformanceMeasureId: integer (int64)
  Read Only: true

  The unique identifier of the participant performance measure.
• PerformanceMeasureId: integer (int64)
  Read Only: true

  The unique identifier of the performance measure associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• PerformanceMeasureName: string
  Title: Name

  Read Only: true

  The name of the performance measure.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the participant performance measure goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the participant performance measure goal is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceMeasureName":{
            "title":"Name",
            "type":"string",
            "description":"The name of the performance measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantGoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal associated with the participant performance measure.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the participant performance measure goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalInterval":{
            "title":"Interval",
            "type":"string",
            "description":"The performance interval that describes the span of time to be measured for the attainment of the goal amounts, such as period, quarter, or year. This interval is the same as the corresponding performance (measure) interval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalTarget":{
            "title":"Total Target",
            "type":"number",
            "description":"The expected level of attainment assigned to the participant for the measure.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "AlternateTarget1":{
            "title":"Alternate Target 1",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "AlternateTarget2":{
            "title":"Alternate Target 2",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "ParticipantGoalIntervalGoals":{
            "title":"Interval Goals",
            "type":"array",
            "description":"The performance measure interval goals service is used to view the interval target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.",
            "items":{
                "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalIntervalGoals-item-response"
            }
        },
        "AlternateTarget3":{
            "title":"Alternate Target 3",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "ParticipantPerformanceMeasureId":{
            "type":"integer",
            "description":"The unique identifier of the participant performance measure.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AlternateTarget4":{
            "title":"Alternate Target 4",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "AlternateTarget5":{
            "title":"Alternate Target 5",
            "type":"number",
            "description":"The alternate target number for a measure, for example, stretch goal.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "PerformanceMeasureId":{
            "type":"integer",
            "description":"The unique identifier of the performance measure associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DistributeEvenlyFlag":{
            "type":"boolean",
            "description":"The instruction for the application to evenly distribute the total target and alternate targets to the respective interval and period amounts for this web service request. The possible values are TRUE and FALSE.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParticipantGoalPeriodGoals":{
            "title":"Period Goals",
            "type":"array",
            "description":"The performance measure period goals service is used to view and update the period target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.",
            "items":{
                "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalPeriodGoals-item-response"
            }
        },
        "GoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the participant performance measure goal is last updated.",
            "format":"date-time",
            "nullable":false,
            "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 : Interval Goals

Type: array

Title: Interval Goals

The performance measure interval goals service is used to view the interval target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.

Show Source

• Array of: object participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalIntervalGoals-item-response

{
    "title":"Interval Goals",
    "type":"array",
    "description":"The performance measure interval goals service is used to view the interval target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.",
    "items":{
        "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalIntervalGoals-item-response"
    }
}

Nested Schema : Period Goals

Type: array

Title: Period Goals

The performance measure period goals service is used to view and update the period target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.

Show Source

• Array of: object participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalPeriodGoals-item-response

{
    "title":"Period Goals",
    "type":"array",
    "description":"The performance measure period goals service is used to view and update the period target amounts for a participant performance measure that can be individualized. You enable individualization for a performance measure by setting the Individualize option to Yes for the related participant plan component.",
    "items":{
        "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalPeriodGoals-item-response"
    }
}

Nested Schema : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalIntervalGoals-item-response

Type: object

Show Source

• AlternateIntervalTarget1: number
  Title: Alternate Interval Target 1

  Read Only: true

  Default Value: 0

  The alternate interval target for a measure, for example, stretch goal for an interval.
• AlternateIntervalTarget2: number
  Title: Alternate Interval Target 2

  Read Only: true

  Default Value: 0

  The alternate interval target for a measure, for example, stretch goal for an interval.
• AlternateIntervalTarget3: number
  Title: Alternate Interval Target 3

  Read Only: true

  Default Value: 0

  The alternate interval target for a measure, for example, stretch goal for an interval.
• AlternateIntervalTarget4: number
  Title: Alternate Interval Target 4

  Read Only: true

  Default Value: 0

  The alternate interval target for a measure, for example, stretch goal for an interval.
• AlternateIntervalTarget5: number
  Title: Alternate Interval Target 5

  Read Only: true

  Default Value: 0

  The alternate interval target for a measure, for example, stretch goal for an interval.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date and time when the interval goal is created.
• GoalId: integer (int64)
  Read Only: true

  The unique identifier of the goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• IntervalGoalId: integer (int64)
  Title: Period

  Read Only: true

  The unique identifier of the interval goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• IntervalNumber: number
  Title: Period

  Read Only: true

  The display number for the interval.
• IntervalTarget: number
  Title: Interval Target

  Read Only: true

  Default Value: 0

  The target number specified for the goal interval.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the interval is last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the interval goal.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantGoalId: integer (int64)
  Read Only: true

  The unique identifier of the goal.
• ParticipantIntervalGoalId: integer (int64)
  Read Only: true

  The unique identifier of the participant interval goal details.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the interval goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the interval goal is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantIntervalGoalId":{
            "type":"integer",
            "description":"The unique identifier of the participant interval goal details.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParticipantGoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the interval goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IntervalTarget":{
            "title":"Interval Target",
            "type":"number",
            "description":"The target number specified for the goal interval.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "AlternateIntervalTarget1":{
            "title":"Alternate Interval Target 1",
            "type":"number",
            "description":"The alternate interval target for a measure, for example, stretch goal for an interval.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "AlternateIntervalTarget2":{
            "title":"Alternate Interval Target 2",
            "type":"number",
            "description":"The alternate interval target for a measure, for example, stretch goal for an interval.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "AlternateIntervalTarget3":{
            "title":"Alternate Interval Target 3",
            "type":"number",
            "description":"The alternate interval target for a measure, for example, stretch goal for an interval.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "AlternateIntervalTarget4":{
            "title":"Alternate Interval Target 4",
            "type":"number",
            "description":"The alternate interval target for a measure, for example, stretch goal for an interval.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "AlternateIntervalTarget5":{
            "title":"Alternate Interval Target 5",
            "type":"number",
            "description":"The alternate interval target for a measure, for example, stretch goal for an interval.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IntervalGoalId":{
            "title":"Period",
            "type":"integer",
            "description":"The unique identifier of the interval goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "IntervalNumber":{
            "title":"Period",
            "type":"number",
            "description":"The display number for the interval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the interval is last updated.",
            "format":"date-time",
            "nullable":false,
            "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 : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureGoals-ParticipantGoalPeriodGoals-item-response

Type: object

Show Source

• AlternateITDTarget1: number
  Title: Alternate ITD Target 1

  Read Only: true

  Default Value: 0

  The alternate interval-to-date target number for a measure.
• AlternateITDTarget2: number
  Title: Alternate ITD Target 2

  Read Only: true

  Default Value: 0

  The alternate interval-to-date target number for a measure.
• AlternateITDTarget3: number
  Title: Alternate ITD Target 3

  Read Only: true

  Default Value: 0

  The alternate interval-to-date target number for a measure.
• AlternateITDTarget4: number
  Title: Alternate ITD Target 4

  Read Only: true

  Default Value: 0

  The alternate interval-to-date target number for a measure.
• AlternateITDTarget5: number
  Title: Alternate ITD Target 5

  Read Only: true

  Default Value: 0

  The alternate interval-to-date target number for a measure.
• AlternatePeriodTarget1: number
  Title: Alternate Period Target 1

  Default Value: 0

  The alternate period target number for a measure, for example, stretch goal for a period.
• AlternatePeriodTarget2: number
  Title: Alternate Period Target 2

  Default Value: 0

  The alternate period target number for a measure, for example, stretch goal for a period.
• AlternatePeriodTarget3: number
  Title: Alternate Period Target 3

  Default Value: 0

  The alternate period target number for a measure, for example, stretch goal for a period.
• AlternatePeriodTarget4: number
  Title: Alternate Period Target 4

  Default Value: 0

  The alternate period target number for a measure, for example, stretch goal for a period.
• AlternatePeriodTarget5: number
  Title: Alternate Period Target 5

  Default Value: 0

  The alternate period target number for a measure, for example, stretch goal for a period.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date and time when the period goal is created.
• GoalId: integer (int64)
  Read Only: true

  The unique identifier of the goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• IntervalGoalId: integer (int64)
  Read Only: true

  The unique identifier of the interval goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• ITDTarget: number
  Title: ITD Target

  Read Only: true

  Default Value: 0

  The interval-to-date target number for a measure.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the period goal is last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the period goal.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantGoalId: integer (int64)
  Read Only: true

  The unique identifier of the goal.
• ParticipantIntervalGoalId: integer (int64)
  Read Only: true

  The unique identifier of the participant interval goal details.
• ParticipantPeriodGoalId: integer (int64)
  Read Only: true

  The unique identifier of the period goal.
• PeriodEndDate: string (date)
  Title: End Date

  Read Only: true

  The date when the period of time ends.
• PeriodGoalId: integer (int64)
  Read Only: true

  The unique identifier of the period goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• PeriodId: integer (int64)
  Title: Period

  Read Only: true

  The unique identifier for the period of time defined in the calendar.
• PeriodName: string
  Title: Period

  Read Only: true

  Maximum Length: 30

  The name for a period of time defined in the calendar.
• PeriodStartDate: string (date)
  Title: Start Date

  Read Only: true

  The date when the period of time begins.
• PeriodTarget: number
  Title: Period Target

  Default Value: 0

  The period target number for a measure.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the period goal is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodGoalId":{
            "type":"integer",
            "description":"The unique identifier of the period goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PeriodEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the period of time ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AlternateITDTarget2":{
            "title":"Alternate ITD Target 2",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget2"
                ]
            },
            "x-queryable":true
        },
        "AlternatePeriodTarget4":{
            "title":"Alternate Period Target 4",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "AlternateITDTarget3":{
            "title":"Alternate ITD Target 3",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget3"
                ]
            },
            "x-queryable":true
        },
        "AlternatePeriodTarget5":{
            "title":"Alternate Period Target 5",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "AlternateITDTarget1":{
            "title":"Alternate ITD Target 1",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget1"
                ]
            },
            "x-queryable":true
        },
        "AlternateITDTarget4":{
            "title":"Alternate ITD Target 4",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget4"
                ]
            },
            "x-queryable":true
        },
        "AlternateITDTarget5":{
            "title":"Alternate ITD Target 5",
            "type":"number",
            "description":"The alternate interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "dependencies":[
                    "AlternatePeriodTarget5"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ITDTarget":{
            "title":"ITD Target",
            "type":"number",
            "description":"The interval-to-date target number for a measure.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "dependencies":[
                    "PeriodTarget"
                ]
            },
            "x-queryable":true
        },
        "ParticipantPeriodGoalId":{
            "type":"integer",
            "description":"The unique identifier of the period goal.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AlternatePeriodTarget1":{
            "title":"Alternate Period Target 1",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "AlternatePeriodTarget2":{
            "title":"Alternate Period Target 2",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "GoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AlternatePeriodTarget3":{
            "title":"Alternate Period Target 3",
            "type":"number",
            "description":"The alternate period target number for a measure, for example, stretch goal for a period.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the period goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantIntervalGoalId":{
            "type":"integer",
            "description":"The unique identifier of the participant interval goal details.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the period goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantGoalId":{
            "type":"integer",
            "description":"The unique identifier of the goal.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PeriodId":{
            "title":"Period",
            "type":"integer",
            "description":"The unique identifier for the period of time defined in the calendar.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PeriodTarget":{
            "title":"Period Target",
            "type":"number",
            "description":"The period target number for a measure.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "PeriodStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the period of time begins.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IntervalGoalId":{
            "type":"integer",
            "description":"The unique identifier of the interval goal associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PeriodName":{
            "title":"Period",
            "maxLength":"30",
            "type":"string",
            "description":"The name for a period of time defined in the calendar.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the period goal is last updated.",
            "format":"date-time",
            "nullable":false,
            "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 : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the participant scorecard rate table.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the participant scorecard rate table is created.
• EndDate: string (date)
  Read Only: true

  The date when the scorecard rate table associated with the performance measure becomes inactive.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the participant scorecard rate table is last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the participant scorecard rate table.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantPerformanceMeasureId: integer (int64)
  Read Only: true

  The unique identifier of the performance measure associated with the participant plan component.
• ParticipantPerformanceMeasureScorecardId: integer (int64)
  Read Only: true

  The unique identifier of the scorecard rate table associated with the participant performance measure.
• ParticipantScorecardRates: array Scorecard Rates
  Title: Scorecard Rates

  The scorecard rates resource is used to create, view, and update the rates for a participant scorecard that can be individualized. You enable individualization for a scorecard by setting the Individualize option to Yes for the related participant plan component.
• PerformanceMeasureId: integer (int64)
  Read Only: true

  The unique identifier of the performance measure associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• ScorecardDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of the scorecard rate table entered by the user while creating the scorecard.
• ScorecardId: integer (int64)
  The unique identifier of the scorecard rate table associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• ScorecardName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  The name of the scorecard rate table.
• StartDate: string (date)
  Read Only: true

  The date when the scorecard rate table associated with the performance measure becomes active.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the participant scorecard rate table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the participant scorecard rate table is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the participant scorecard rate table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScorecardName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the scorecard rate table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantPerformanceMeasureId":{
            "type":"integer",
            "description":"The unique identifier of the performance measure associated with the participant plan component.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParticipantScorecardRates":{
            "title":"Scorecard Rates",
            "type":"array",
            "description":"The scorecard rates resource is used to create, view, and update the rates for a participant scorecard that can be individualized. You enable individualization for a scorecard by setting the Individualize option to Yes for the related participant plan component.",
            "items":{
                "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-ParticipantScorecardRates-item-response"
            }
        },
        "PerformanceMeasureId":{
            "type":"integer",
            "description":"The unique identifier of the performance measure associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParticipantPerformanceMeasureScorecardId":{
            "type":"integer",
            "description":"The unique identifier of the scorecard rate table associated with the participant performance measure.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the scorecard rate table associated with the performance measure becomes inactive.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ScorecardId":{
            "type":"integer",
            "description":"The unique identifier of the scorecard rate table associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the scorecard rate table associated with the performance measure becomes active.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ScorecardDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the scorecard rate table entered by the user while creating the scorecard.",
            "nullable":true,
            "readOnly":true,
            "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 and time when the participant scorecard rate table is last updated.",
            "format":"date-time",
            "nullable":false,
            "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 : Scorecard Rates

Type: array

Title: Scorecard Rates

The scorecard rates resource is used to create, view, and update the rates for a participant scorecard that can be individualized. You enable individualization for a scorecard by setting the Individualize option to Yes for the related participant plan component.

Show Source

• Array of: object participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-ParticipantScorecardRates-item-response

{
    "title":"Scorecard Rates",
    "type":"array",
    "description":"The scorecard rates resource is used to create, view, and update the rates for a participant scorecard that can be individualized. You enable individualization for a scorecard by setting the Individualize option to Yes for the related participant plan component.",
    "items":{
        "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-ParticipantScorecardRates-item-response"
    }
}

Nested Schema : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentPerformanceMeasures-ParticipantPerformanceMeasureScorecards-ParticipantScorecardRates-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date and time when the participant rate is created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the participant rate is last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the participant rate.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantPerformanceMeasureScorecardId: integer (int64)
  Read Only: true

  The unique identifier of the scorecard rate table associated with the participant performance measure.
• ParticipantScorecardRateId: integer (int64)
  Read Only: true

  The unique identifier of the rate associated with the participant scorecard.
• Rate: number
  Title: Rate

  The output value of the scorecard rate table is used to establish attainment rates or fixed amounts for different performance levels. This value is a percent or an amount depending on the rate table type set for the rate table. If the rate table type is percent, then the value stored here needs to be divided by 100 to get the actual value. For example, if the rate table type is percent and the rate value is 10%, then 10 is the output value.
• RateDimension10Id: integer
  The unique identifier of the tenth dimension associated with the rate. Used only when the scorecard rate table has ten dimensions.
• RateDimension10Name: string
  Title: Name

  Read Only: true

  The name of the tenth dimension.
• RateDimension10TierId: integer
  The unique identifier of the tier for the tenth dimension associated with the rate.
• RateDimension10TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension1Id: integer
  The unique identifier of the first dimension associated with the rate.
• RateDimension1Name: string
  Title: Name

  Read Only: true

  The name of the first dimension.
• RateDimension1TierId: integer
  The unique identifier of the tier for the first dimension associated with the rate.
• RateDimension1TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension2Id: integer
  The unique identifier of the second dimension associated with the rate. Used only when the scorecard rate table has at least two dimensions.
• RateDimension2Name: string
  Title: Name

  Read Only: true

  The name of the second dimension.
• RateDimension2TierId: integer
  The unique identifier of the tier for the second dimension associated with the rate.
• RateDimension2TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension3Id: integer
  The unique identifier of the third dimension associated with the rate. Used only when the scorecard rate table has at least three dimensions.
• RateDimension3Name: string
  Title: Name

  Read Only: true

  The name of the third dimension.
• RateDimension3TierId: integer
  The unique identifier of the tier for the third dimension associated with the rate.
• RateDimension3TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension4Id: integer
  The unique identifier of the fourth dimension associated with the rate. Used only when the scorecard rate table has at least four dimensions.
• RateDimension4Name: string
  Title: Name

  Read Only: true

  The name of the fourth dimension.
• RateDimension4TierId: integer
  The unique identifier of the tier for the fourth dimension associated with the rate.
• RateDimension4TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension5Id: integer
  The unique identifier of the fifth dimension associated with the rate. Used only when the scorecard rate table has at least five dimensions.
• RateDimension5Name: string
  Title: Name

  Read Only: true

  The name of the fifth dimension.
• RateDimension5TierId: integer
  The unique identifier of the tier for the fifth dimension associated with the rate.
• RateDimension5TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension6Id: integer
  The unique identifier of the sixth dimension associated with the rate. Used only when the scorecard rate table has at least six dimensions.
• RateDimension6Name: string
  Title: Name

  Read Only: true

  The name of the sixth dimension.
• RateDimension6TierId: integer
  The unique identifier of the tier for the sixth dimension associated with the rate.
• RateDimension6TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension7Id: integer
  The unique identifier of the seventh dimension associated with the rate. Used only when the scorecard rate table has at least seven dimensions.
• RateDimension7Name: string
  Title: Name

  Read Only: true

  The name of the seventh dimension.
• RateDimension7TierId: integer
  The unique identifier of the tier for the seventh dimension associated with the rate.
• RateDimension7TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension8Id: integer
  The unique identifier of the eighth dimension associated with the rate. Used only when the scorecard rate table has at least eight dimensions.
• RateDimension8Name: string
  Title: Name

  Read Only: true

  The name of the eighth dimension.
• RateDimension8TierId: integer
  The unique identifier of the tier for the eighth dimension associated with the rate.
• RateDimension8TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension9Id: integer
  The unique identifier of the ninth dimension associated with the rate. Used only when the scorecard rate table has at least nine dimensions.
• RateDimension9Name: string
  Title: Name

  Read Only: true

  The name of the ninth dimension.
• RateDimension9TierId: integer
  The unique identifier of the tier for the ninth dimension associated with the rate.
• RateDimension9TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• ScorecardId: integer (int64)
  Read Only: true

  The unique identifier of the scorecard rate table associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• ScorecardRateId: integer (int64)
  The unique identifier of the rate associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the participant rate is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension3TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the third dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension2Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the second dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension4Id":{
            "type":"integer",
            "description":"The unique identifier of the fourth dimension associated with the rate. Used only when the scorecard rate table has at least four dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension6Id":{
            "type":"integer",
            "description":"The unique identifier of the sixth dimension associated with the rate. Used only when the scorecard rate table has at least six dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension8Id":{
            "type":"integer",
            "description":"The unique identifier of the eighth dimension associated with the rate. Used only when the scorecard rate table has at least eight dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension1Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the first dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RateDimension2Id":{
            "type":"integer",
            "description":"The unique identifier of the second dimension associated with the rate. Used only when the scorecard rate table has at least two dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the participant rate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension4Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the fourth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension9TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the ninth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the participant rate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Rate":{
            "title":"Rate",
            "type":"number",
            "description":"The output value of the scorecard rate table is used to establish attainment rates or fixed amounts for different performance levels. This value is a percent or an amount depending on the rate table type set for the rate table. If the rate table type is percent, then the value stored here needs to be divided by 100 to get the actual value. For example, if the rate table type is percent and the rate value is 10%, then 10 is the output value.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantPerformanceMeasureScorecardId":{
            "type":"integer",
            "description":"The unique identifier of the scorecard rate table associated with the participant performance measure.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ScorecardRateId":{
            "type":"integer",
            "description":"The unique identifier of the rate associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RateDimension2TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the second dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension1TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension3Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the third dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension6TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the sixth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension9TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension8TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the eighth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension7TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension8TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension1TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the first dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension10Id":{
            "type":"integer",
            "description":"The unique identifier of the tenth dimension associated with the rate. Used only when the scorecard rate table has ten dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension2TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension6Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the sixth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension10TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the tenth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension3Id":{
            "type":"integer",
            "description":"The unique identifier of the third dimension associated with the rate. Used only when the scorecard rate table has at least three dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension5Id":{
            "type":"integer",
            "description":"The unique identifier of the fifth dimension associated with the rate. Used only when the scorecard rate table has at least five dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension3TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension10TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension5TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the fifth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension7Id":{
            "type":"integer",
            "description":"The unique identifier of the seventh dimension associated with the rate. Used only when the scorecard rate table has at least seven dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension4TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension9Id":{
            "type":"integer",
            "description":"The unique identifier of the ninth dimension associated with the rate. Used only when the scorecard rate table has at least nine dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension5TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension10Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the tenth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension5Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the fifth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension6TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension1Id":{
            "type":"integer",
            "description":"The unique identifier of the first dimension associated with the rate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "ScorecardId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension9Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the ninth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension7TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the seventh dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ScorecardId":{
            "type":"integer",
            "description":"The unique identifier of the scorecard rate table associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RateDimension8Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the eighth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ParticipantScorecardRateId":{
            "type":"integer",
            "description":"The unique identifier of the rate associated with the participant scorecard.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RateDimension4TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the fourth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension7Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the seventh dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the participant rate is last updated.",
            "format":"date-time",
            "nullable":false,
            "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 : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentRateTables-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the participant rate table.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the participant rate table is created.
• EndDate: string (date)
  Read Only: true

  The date when the rate table associated with the plan component becomes inactive.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the participant rate table is last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the participant rate table.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantPlanComponentId: integer (int64)
  Read Only: true

  The unique identifier of the plan component associated with the participant compensation plan.
• ParticipantPlanComponentRateTableId: integer (int64)
  Read Only: true

  The unique identifier of the rate table associated with the participant plan component.
• ParticipantRateTableRates: array Rate Table Rates
  Title: Rate Table Rates

  The rate table rates resource is used to view, create, and update the rates for a participant rate table that can be individualized. You enable individualization for a rate table by setting the Individualize option to Yes for the related participant plan component.
• PlanComponentId: integer (int64)
  Read Only: true

  The unique identifier of the plan component associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• RateTableDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The description of the rate table entered while creating the rate table.
• RateTableId: integer (int64)
  The unique identifier of the rate table associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• RateTableName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  The name of the rate table.
• StartDate: string (date)
  Read Only: true

  The date when the rate table associated with the plan component becomes active.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the participant rate table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the participant rate table is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantPlanComponentRateTableId":{
            "type":"integer",
            "description":"The unique identifier of the rate table associated with the participant plan component.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the participant rate table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableDescription":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the rate table entered while creating the rate table.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the plan component associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the rate table associated with the plan component becomes inactive.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the rate table associated with the plan component becomes active.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantPlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the plan component associated with the participant compensation plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RateTableName":{
            "title":"Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the rate table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantRateTableRates":{
            "title":"Rate Table Rates",
            "type":"array",
            "description":"The rate table rates resource is used to view, create, and update the rates for a participant rate table that can be individualized. You enable individualization for a rate table by setting the Individualize option to Yes for the related participant plan component.",
            "items":{
                "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentRateTables-ParticipantRateTableRates-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RateTableId":{
            "type":"integer",
            "description":"The unique identifier of the rate table associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the participant rate table is last updated.",
            "format":"date-time",
            "nullable":false,
            "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 : Rate Table Rates

Type: array

Title: Rate Table Rates

The rate table rates resource is used to view, create, and update the rates for a participant rate table that can be individualized. You enable individualization for a rate table by setting the Individualize option to Yes for the related participant plan component.

Show Source

• Array of: object participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentRateTables-ParticipantRateTableRates-item-response

{
    "title":"Rate Table Rates",
    "type":"array",
    "description":"The rate table rates resource is used to view, create, and update the rates for a participant rate table that can be individualized. You enable individualization for a rate table by setting the Individualize option to Yes for the related participant plan component.",
    "items":{
        "$ref":"#/components/schemas/participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentRateTables-ParticipantRateTableRates-item-response"
    }
}

Nested Schema : participantCompensationPlans-ParticipantPlanComponents-ParticipantPlanComponentRateTables-ParticipantRateTableRates-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the participant rate table.
• CreationDate: string (date-time)
  Read Only: true

  The date when the participant rate table was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the participant rate table was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the participant rate table.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantPlanComponentRateTableId: integer (int64)
  Read Only: true

  The unique identifier of the participant rate table.
• ParticipantRateTableRateId: integer (int64)
  The unique identifier of the rate associated with the participant rate table.
• Rate: number
  Title: Rate

  The output value of the rate table used to calculate the earning rate. This value is a percent or an amount depending on the rate table type set for the rate table. If the rate table type is percent, then the value stored here needs to be divided by 100 to get the actual value. For example, if the rate table type is percent and the rate value is 10%, then 10 is the output value.
• RateDimension10Id: integer
  The unique identifier of the tenth dimension associated with the rate. Used only when the rate table has ten dimensions.
• RateDimension10Name: string
  Title: Name

  Read Only: true

  The name of the tenth dimension.
• RateDimension10TierId: integer
  The unique identifier of the tier for the tenth dimension associated with the rate.
• RateDimension10TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension1Id: integer
  The unique identifier of the first dimension associated with the rate.
• RateDimension1Name: string
  Title: Name

  Read Only: true

  The name of the first dimension.
• RateDimension1TierId: integer
  The unique identifier of the tier for the first dimension associated with the rate.
• RateDimension1TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension2Id: integer
  The unique identifier of the second dimension associated with the rate. Used only when the rate table has at least two dimensions.
• RateDimension2Name: string
  Title: Name

  Read Only: true

  The name of the second dimension.
• RateDimension2TierId: integer
  The unique identifier of the tier for the second dimension associated with the rate.
• RateDimension2TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension3Id: integer
  The unique identifier of the third dimension associated with the rate. Used only when the rate table has at least three dimensions.
• RateDimension3Name: string
  Title: Name

  Read Only: true

  The name of the third dimension.
• RateDimension3TierId: integer
  The unique identifier of the tier for the third dimension associated with the rate.
• RateDimension3TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension4Id: integer
  The unique identifier of the fourth dimension associated with the rate. Used only when the rate table has at least four dimensions.
• RateDimension4Name: string
  Title: Name

  Read Only: true

  The name of the fourth dimension.
• RateDimension4TierId: integer
  The unique identifier of the tier for the fourth dimension associated with the rate.
• RateDimension4TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension5Id: integer
  The unique identifier of the fifth dimension associated with the rate. Used only when the rate table has at least five dimensions.
• RateDimension5Name: string
  Title: Name

  Read Only: true

  The name of the fifth dimension.
• RateDimension5TierId: integer
  The unique identifier of the tier for the fifth dimension associated with the rate.
• RateDimension5TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension6Id: integer
  The unique identifier of the sixth dimension associated with the rate. Used only when the rate table has at least six dimensions.
• RateDimension6Name: string
  Title: Name

  Read Only: true

  The name of the sixth dimension.
• RateDimension6TierId: integer
  The unique identifier of the tier for the sixth dimension associated with the rate.
• RateDimension6TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension7Id: integer
  The unique identifier of the seventh dimension associated with the rate. Used only when the rate table has at least seven dimensions.
• RateDimension7Name: string
  Title: Name

  Read Only: true

  The name of the seventh dimension.
• RateDimension7TierId: integer
  The unique identifier of the tier for the seventh dimension associated with the rate.
• RateDimension7TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension8Id: integer
  The unique identifier of the eighth dimension associated with the rate. Used only when the rate table has at least eight dimensions.
• RateDimension8Name: string
  Title: Name

  Read Only: true

  The name of the eighth dimension.
• RateDimension8TierId: integer
  The unique identifier of the tier for the eighth dimension associated with the rate.
• RateDimension8TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateDimension9Id: integer
  The unique identifier of the ninth dimension associated with the rate. Used only when the rate table has at least nine dimensions.
• RateDimension9Name: string
  Title: Name

  Read Only: true

  The name of the ninth dimension.
• RateDimension9TierId: integer
  The unique identifier of the tier for the ninth dimension associated with the rate.
• RateDimension9TierSequence: integer
  Title: Sequence

  Read Only: true

  The tier sequence number within the dimension.
• RateTableId: integer (int64)
  Read Only: true

  The unique identifier of the rate table associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.
• RateTableRateId: integer (int64)
  Read Only: true

  The unique identifier of the rate associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the participant rate table was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension3TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the third dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension2Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the second dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension4Id":{
            "type":"integer",
            "description":"The unique identifier of the fourth dimension associated with the rate. Used only when the rate table has at least four dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension6Id":{
            "type":"integer",
            "description":"The unique identifier of the sixth dimension associated with the rate. Used only when the rate table has at least six dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension8Id":{
            "type":"integer",
            "description":"The unique identifier of the eighth dimension associated with the rate. Used only when the rate table has at least eight dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension1Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the first dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RateDimension2Id":{
            "type":"integer",
            "description":"The unique identifier of the second dimension associated with the rate. Used only when the rate table has at least two dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the participant rate table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension4Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the fourth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension9TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the ninth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the participant rate table.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Rate":{
            "title":"Rate",
            "type":"number",
            "description":"The output value of the rate table used to calculate the earning rate. This value is a percent or an amount depending on the rate table type set for the rate table. If the rate table type is percent, then the value stored here needs to be divided by 100 to get the actual value. For example, if the rate table type is percent and the rate value is 10%, then 10 is the output value.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantRateTableRateId":{
            "type":"integer",
            "description":"The unique identifier of the rate associated with the participant rate table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RateDimension2TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the second dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension1TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension3Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the third dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension6TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the sixth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension9TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantPlanComponentRateTableId":{
            "type":"integer",
            "description":"The unique identifier of the participant rate table.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RateDimension8TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the eighth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension7TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension8TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension1TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the first dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension10Id":{
            "type":"integer",
            "description":"The unique identifier of the tenth dimension associated with the rate. Used only when the rate table has ten dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension2TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableRateId":{
            "type":"integer",
            "description":"The unique identifier of the rate associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RateDimension6Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the sixth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension10TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the tenth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension3Id":{
            "type":"integer",
            "description":"The unique identifier of the third dimension associated with the rate. Used only when the rate table has at least three dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension5Id":{
            "type":"integer",
            "description":"The unique identifier of the fifth dimension associated with the rate. Used only when the rate table has at least five dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension3TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension10TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension5TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the fifth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension7Id":{
            "type":"integer",
            "description":"The unique identifier of the seventh dimension associated with the rate. Used only when the rate table has at least seven dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension4TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension9Id":{
            "type":"integer",
            "description":"The unique identifier of the ninth dimension associated with the rate. Used only when the rate table has at least nine dimensions.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension5TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension10Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the tenth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension5Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the fifth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension6TierSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The tier sequence number within the dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateDimension1Id":{
            "type":"integer",
            "description":"The unique identifier of the first dimension associated with the rate.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "RateTableId"
                ]
            },
            "x-queryable":true
        },
        "RateDimension9Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the ninth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension7TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the seventh dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateDimension8Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the eighth dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RateDimension4TierId":{
            "type":"integer",
            "description":"The unique identifier of the tier for the fourth dimension associated with the rate.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RateTableId":{
            "type":"integer",
            "description":"The unique identifier of the rate table associated with the base compensation plan. The base plan is modeled by the plan administrator and is the source of the participant plan.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RateDimension7Name":{
            "title":"Name",
            "type":"string",
            "description":"The name of the seventh dimension.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the participant rate table was last updated.",
            "format":"date-time",
            "nullable":false,
            "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"
    }
}

Back to Top