Jump to

• Request
• Response
• Examples

Get a compensation plan

get

/fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}

Request

Path Parameters

• CompensationPlanId(required): integer(int64)
  The unique identifier of the compensation plan.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

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

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

Type: object

Show Source

• AllowCreditCategoryOverlapFlag: boolean
  Title: Allow Credit Category Overlap

  Maximum Length: 1

  Default Value: false

  Indicates whether a credit category can exist in multiple plan components within the compensation plan. Possible values include N, or FALSE, and Y, or TRUE. The default value is FALSE. A list of acceptable values is defined in the lookup CN_ECAT_OVERLAP_FLAG. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• ApprovalStatus: string
  Title: Approval Status

  Maximum Length: 30

  Default Value: NOT_APPROVED

  The status of the compensation plan in the approval process. Possible values include APPROVED, NOT_APPROVED, PENDING, and REJECTED. The default value is NOT_APPROVED. A list of acceptable values is defined in the lookup CN_PLAN_APPR_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• CompensationPlanAssignments: array Assigned Participants
  Title: Assigned Participants

  The assignments resource is used to view all the participants associated with a compensation plan. This includes participants that are assigned directly or assigned through incentive compensation roles. An assignments provides the dates when a participant became a part of a compensation plan. An active compensation plan and a participant need to exist before creating an assignment.
• CompensationPlanComponents: array Compensation Plan - Plan Components
  Title: Compensation Plan - Plan Components

  The plan components resource is used to create, update, or delete the association of a plan component with a compensation plan. It can also be used to display all the details of plan components under a compensation plan. A plan component resource links the plan component with the compensation and provides additional details at this level. A plan component needs to exist before creating this record.
• CompensationPlanDirectAssignmentRequests: array Direct Assignment Requests
  Title: Direct Assignment Requests

  The direct assignment requests resource is used to view, create, and delete direct participant assignment requests. The resource can be used to request a new participant to be assigned to a plan, edit an existing participant assignment, or delete a participant assigned to a plan. The resource can also be used to delete a previously raised request. Once a request is created, the user must run the Deploy Compensation Plans process for it to apply. Once applied, this change can be seen in the Assignments resource.
• CompensationPlanId: integer (int64)
  Title: Compensation Plan ID

  The unique identifier of the compensation plan.
• CompensationPlanRoles: array Compensation Plan - Roles
  Title: Compensation Plan - Roles

  The roles resource is used to create, update, or delete the assignment of a role to a compensation plan. It is also be used to display all the details of roles assigned to a compensation plan. A roles resource links the Incentive Compensation role to a compensation plan and provides additional details at this level. A role needs to exist before creating this record. Only the plan administrator can assign a role to the compensation plan using this service.
• compensationPlansDFF: array Compensation Plan - Descriptive Flex Fields
  Title: Compensation Plan - Descriptive Flex Fields

  The descriptive flex fields resource is used to store user defined values for the compensation plan. A new API name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• Description: string
  Title: Description

  Maximum Length: 1000

  The description of the compensation plan.
• DisplayName: string
  Title: Display Name

  Maximum Length: 80

  The name of the compensation plan that is displayed on the sales representative's user interface.
• EndDate: string (date)
  Title: End Date

  The date and time when the compensation plan becomes inactive. The acceptable format is yyyy-mm-dd. Once the date is assigned, it cannot be updated to null.
• InvalidReason: string
  Read Only: true

  The reason explaining why the compensation plan is invalid.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the record.
• links: array Links
  Title: Links

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

  Maximum Length: 80

  The name of the compensation plan.
• OrgId: integer (int64)
  Title: Business Unit

  The unique identifier of the business unit.
• PlanDocumentTemplate: string
  Title: Plan Document Template

  Maximum Length: 80

  The name of the report template used to create a compensation plan.
• StartDate: string (date)
  Title: Start Date

  The date and time when the compensation plan becomes active. The acceptable format is yyyy-mm-dd.
• TargetIncentive: number
  Title: Target Incentive

  Default Value: 0

  The expected earnings (variable compensation) of a participant when all the objectives or goals in a plan are met. The default value is 0.
• ValidForCalculation: string
  Title: Valid for Calculation

  Read Only: true

  Maximum Length: 30

  Default Value: INCOMPLETE

  Indicates if the compensation plan is valid for calculation. Possible values include COMPLETE and INCOMPLETE. The default value is INCOMPLETE. A list of acceptable values is defined in the lookup CN_COMP_PLAN_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "compensationPlansDFF":{
            "title":"Compensation Plan - Descriptive Flex Fields",
            "type":"array",
            "description":"The descriptive flex fields resource is used to store user defined values for the compensation plan. A new API name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.",
            "items":{
                "$ref":"#/components/schemas/compensationPlans-compensationPlansDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompensationPlanId":{
            "title":"Compensation Plan ID",
            "type":"integer",
            "description":"The unique identifier of the compensation plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the compensation plan.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidForCalculation":{
            "title":"Valid for Calculation",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the compensation plan is valid for calculation. Possible values include COMPLETE and INCOMPLETE. The default value is INCOMPLETE. A list of acceptable values is defined in the lookup CN_COMP_PLAN_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"INCOMPLETE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CompensationPlanRoles":{
            "title":"Compensation Plan - Roles",
            "type":"array",
            "description":"The roles resource is used to create, update, or delete the assignment of a role to a compensation plan. It is also be used to display all the details of roles assigned to a compensation plan. A roles resource links the Incentive Compensation role to a compensation plan and provides additional details at this level. A role needs to exist before creating this record. Only the plan administrator can assign a role to the compensation plan using this service.",
            "items":{
                "$ref":"#/components/schemas/compensationPlans-CompensationPlanRoles-item-response"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time when the compensation plan becomes inactive. The acceptable format is yyyy-mm-dd. Once the date is assigned, it cannot be updated to null.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ApprovalStatus":{
            "title":"Approval Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the compensation plan in the approval process. Possible values include APPROVED, NOT_APPROVED, PENDING, and REJECTED. The default value is NOT_APPROVED. A list of acceptable values is defined in the lookup CN_PLAN_APPR_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "default":"NOT_APPROVED",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Compensation Plan Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the compensation plan.",
            "nullable":false,
            "x-queryable":true
        },
        "CompensationPlanAssignments":{
            "title":"Assigned Participants",
            "type":"array",
            "description":"The assignments resource is used to view all the participants associated with a compensation plan. This includes participants that are assigned directly or assigned through incentive compensation roles. An assignments provides the dates when a participant became a part of a compensation plan. An active compensation plan and a participant need to exist before creating an assignment.",
            "items":{
                "$ref":"#/components/schemas/compensationPlans-CompensationPlanAssignments-item-response"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when the compensation plan becomes active. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "TargetIncentive":{
            "title":"Target Incentive",
            "type":"number",
            "description":"The expected earnings (variable compensation) of a participant when all the objectives or goals in a plan are met. The default value is 0.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "CompensationPlanComponents":{
            "title":"Compensation Plan - Plan Components",
            "type":"array",
            "description":"The plan components resource is used to create, update, or delete the association of a plan component with a compensation plan. It can also be used to display all the details of plan components under a compensation plan. A plan component resource links the plan component with the compensation and provides additional details at this level. A plan component needs to exist before creating this record.",
            "items":{
                "$ref":"#/components/schemas/compensationPlans-CompensationPlanComponents-item-response"
            }
        },
        "CompensationPlanDirectAssignmentRequests":{
            "title":"Direct Assignment Requests",
            "type":"array",
            "description":"The direct assignment requests resource is used to view, create, and delete direct participant assignment requests. The resource can be used to request a new participant to be assigned to a plan, edit an existing participant assignment, or delete a participant assigned to a plan. The resource can also be used to delete a previously raised request. Once a request is created, the user must run the Deploy Compensation Plans process for it to apply. Once applied, this change can be seen in the Assignments resource.",
            "items":{
                "$ref":"#/components/schemas/compensationPlans-CompensationPlanDirectAssignmentRequests-item-response"
            }
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the compensation plan that is displayed on the sales representative's user interface.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllowCreditCategoryOverlapFlag":{
            "title":"Allow Credit Category Overlap",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a credit category can exist in multiple plan components within the compensation plan. Possible values include N, or FALSE, and Y, or TRUE. The default value is FALSE. A list of acceptable values is defined in the lookup CN_ECAT_OVERLAP_FLAG. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PlanDocumentTemplate":{
            "title":"Plan Document Template",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the report template used to create a compensation plan.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvalidReason":{
            "type":"string",
            "description":"The reason explaining why the compensation plan is invalid.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Assigned Participants

Type: array

Title: Assigned Participants

The assignments resource is used to view all the participants associated with a compensation plan. This includes participants that are assigned directly or assigned through incentive compensation roles. An assignments provides the dates when a participant became a part of a compensation plan. An active compensation plan and a participant need to exist before creating an assignment.

Show Source

• Array of: object compensationPlans-CompensationPlanAssignments-item-response

{
    "title":"Assigned Participants",
    "type":"array",
    "description":"The assignments resource is used to view all the participants associated with a compensation plan. This includes participants that are assigned directly or assigned through incentive compensation roles. An assignments provides the dates when a participant became a part of a compensation plan. An active compensation plan and a participant need to exist before creating an assignment.",
    "items":{
        "$ref":"#/components/schemas/compensationPlans-CompensationPlanAssignments-item-response"
    }
}

Nested Schema : Compensation Plan - Plan Components

Type: array

Title: Compensation Plan - Plan Components

The plan components resource is used to create, update, or delete the association of a plan component with a compensation plan. It can also be used to display all the details of plan components under a compensation plan. A plan component resource links the plan component with the compensation and provides additional details at this level. A plan component needs to exist before creating this record.

Show Source

• Array of: object compensationPlans-CompensationPlanComponents-item-response

{
    "title":"Compensation Plan - Plan Components",
    "type":"array",
    "description":"The plan components resource is used to create, update, or delete the association of a plan component with a compensation plan. It can also be used to display all the details of plan components under a compensation plan. A plan component resource links the plan component with the compensation and provides additional details at this level. A plan component needs to exist before creating this record.",
    "items":{
        "$ref":"#/components/schemas/compensationPlans-CompensationPlanComponents-item-response"
    }
}

Nested Schema : Direct Assignment Requests

Type: array

Title: Direct Assignment Requests

The direct assignment requests resource is used to view, create, and delete direct participant assignment requests. The resource can be used to request a new participant to be assigned to a plan, edit an existing participant assignment, or delete a participant assigned to a plan. The resource can also be used to delete a previously raised request. Once a request is created, the user must run the Deploy Compensation Plans process for it to apply. Once applied, this change can be seen in the Assignments resource.

Show Source

• Array of: object compensationPlans-CompensationPlanDirectAssignmentRequests-item-response

{
    "title":"Direct Assignment Requests",
    "type":"array",
    "description":"The direct assignment requests resource is used to view, create, and delete direct participant assignment requests. The resource can be used to request a new participant to be assigned to a plan, edit an existing participant assignment, or delete a participant assigned to a plan. The resource can also be used to delete a previously raised request. Once a request is created, the user must run the Deploy Compensation Plans process for it to apply. Once applied, this change can be seen in the Assignments resource.",
    "items":{
        "$ref":"#/components/schemas/compensationPlans-CompensationPlanDirectAssignmentRequests-item-response"
    }
}

Nested Schema : Compensation Plan - Roles

Type: array

Title: Compensation Plan - Roles

The roles resource is used to create, update, or delete the assignment of a role to a compensation plan. It is also be used to display all the details of roles assigned to a compensation plan. A roles resource links the Incentive Compensation role to a compensation plan and provides additional details at this level. A role needs to exist before creating this record. Only the plan administrator can assign a role to the compensation plan using this service.

Show Source

• Array of: object compensationPlans-CompensationPlanRoles-item-response

{
    "title":"Compensation Plan - Roles",
    "type":"array",
    "description":"The roles resource is used to create, update, or delete the assignment of a role to a compensation plan. It is also be used to display all the details of roles assigned to a compensation plan. A roles resource links the Incentive Compensation role to a compensation plan and provides additional details at this level. A role needs to exist before creating this record. Only the plan administrator can assign a role to the compensation plan using this service.",
    "items":{
        "$ref":"#/components/schemas/compensationPlans-CompensationPlanRoles-item-response"
    }
}

Nested Schema : Compensation Plan - Descriptive Flex Fields

Type: array

Title: Compensation Plan - Descriptive Flex Fields

The descriptive flex fields resource is used to store user defined values for the compensation plan. A new API name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.

Show Source

• Array of: object compensationPlans-compensationPlansDFF-item-response

{
    "title":"Compensation Plan - Descriptive Flex Fields",
    "type":"array",
    "description":"The descriptive flex fields resource is used to store user defined values for the compensation plan. A new API name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.",
    "items":{
        "$ref":"#/components/schemas/compensationPlans-compensationPlansDFF-item-response"
    },
    "x-cardinality":"1"
}

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 : compensationPlans-CompensationPlanAssignments-item-response

Type: object

Show Source

• AcceptanceStatus: string
  Title: Acceptance Status

  Maximum Length: 30

  Default Value: ACCEPTED

  The status of the published participant compensation plan document. 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 can be updated when the Enable Plan Approval and Acceptance Workflow attribute are set to the No for the business unit. Review and update the attribute value using the Setup and Maintenance, Manage Parameters task.
• AnalystId: integer (int64)
  Title: Analyst

  Read Only: true

  The unique identifier of the analyst assigned to a participant.
• AnalystName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the analyst assigned to a participant.
• AssignmentType: string
  Title: Assignment Type

  Maximum Length: 30

  The type of the assignment, for example whether a participant is assigned to a compensation plan directly or through a role. A list of acceptable values is defined in the lookup CN_PARTICIPANT_PLN_ASSIGN_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• CompensationPlanId: integer (int64)
  Title: Compensation Plan

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

  Maximum Length: 64

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

  The date and time when the compensation plan assignment was created.
• EndDate: string (date)
  Title: End Date

  The date when the compensation plan assignment becomes inactive.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• ParticipantId: integer (int64)
  Title: Participant Name

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

  Read Only: true

  Maximum Length: 360

  The name of the participant.
• ParticipantPlanNumber: string
  Title: Participant Plan Number

  Maximum Length: 30

  The alternate key identifier of the participant plan.
• ParticipantType: string
  Title: Type

  Read Only: true

  Maximum Length: 60

  Default Value: PARTICIPANT

  The type of the participant. This attribute indicates whether the participant is an administrator, responsible for updating tools, or a sales team member, capable of getting a sales credit. Possible values include ANALYST for an Administrator, and PARTICIPANT for a Sales Team member. A list of acceptable values is defined in the lookup CN_PARTICIPANT_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• PersonNumber: string
  Title: Person Number

  Read Only: true

  Maximum Length: 30

  The Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component.
• RoleId: integer (int64)
  Title: Name

  Read Only: true

  The unique identifier of a incentive compensation role.
• RoleName: string
  Title: Name

  Read Only: true

  Maximum Length: 60

  The name of the incentive compensation role.
• SrpCompPlanId: integer (int64)
  The unique identifier of the compensation plan.
• StartDate: string (date)
  Title: Start Date

  The date when the compensation plan assignment becomes active.
• ViewPlanDocument: string (byte)
  Read Only: true

  The link to the plan document. The plan document contains details about the compensation plan assigned to the participant. It is only available if the plan approval feature has been enabled using the Setup and Maintenance, Manage Parameters task. The plan document gets generated once the participant's plan is submitted for approval.

{
    "type":"object",
    "properties":{
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"The Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the compensation plan assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the compensation plan assignment was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AcceptanceStatus":{
            "title":"Acceptance Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the published participant compensation plan document. 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 can be updated when the Enable Plan Approval and Acceptance Workflow attribute are set to the 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
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the compensation plan assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SrpCompPlanId":{
            "type":"integer",
            "description":"The unique identifier of the compensation plan.",
            "format":"int64",
            "nullable":false,
            "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,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the participant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleId":{
            "title":"Name",
            "type":"integer",
            "description":"The unique identifier of a incentive compensation role.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the compensation plan assignment becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AnalystName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the analyst assigned to a participant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ViewPlanDocument":{
            "type":"string",
            "description":"The link to the plan document. The plan document contains details about the compensation plan assigned to the participant. It is only available if the plan approval feature has been enabled using the Setup and Maintenance, Manage Parameters task. The plan document gets generated once the participant's plan is submitted for approval.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ParticipantId":{
            "title":"Participant Name",
            "type":"integer",
            "description":"The unique identifier of the participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the compensation plan assignment becomes active.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the incentive compensation role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AnalystId":{
            "title":"Analyst",
            "type":"integer",
            "description":"The unique identifier of the analyst assigned to a participant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the assignment, for example whether a participant is assigned to a compensation plan directly or through a role. A list of acceptable values is defined in the lookup CN_PARTICIPANT_PLN_ASSIGN_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParticipantType":{
            "title":"Type",
            "maxLength":"60",
            "type":"string",
            "description":"The type of the participant. This attribute indicates whether the participant is an administrator, responsible for updating tools, or a sales team member, capable of getting a sales credit. Possible values include ANALYST for an Administrator, and PARTICIPANT for a Sales Team member. A list of acceptable values is defined in the lookup CN_PARTICIPANT_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"PARTICIPANT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ParticipantPlanNumber":{
            "title":"Participant Plan Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the participant plan.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the compensation plan assignment 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 : 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 : compensationPlans-CompensationPlanComponents-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. This cannot be updated once the plan component has been created. A list of acceptable values is defined in the lookup CN_PLAN_INCENTIVE_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• CalculationPhase: integer (int32)
  Title: Calculation Phase

  Read Only: true

  The phase in which the application considers plan component for calculation. Two supported phases: Phase 1 and Phase 2. Possible values include 1 and 2. The default value is 1. A list of acceptable values is defined in the lookup CN_CALCULATION_PHASE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• CalculationSequence: integer (int64)
  Title: Calculation Sequence

  Default Value: 1

  Indicates the order in which the calculation engine considers the plan component within a compensation plan. The default value is 1.
• CompensationPlanComponentId: integer (int64)
  The unique identifier for a plan component associated with a compensation plan.
• CompensationPlanId: integer (int64)
  Title: Compensation Plan ID

  The unique identifier for a compensation plan.
• CompensationPlanName: string
  Title: Compensation Plan Name

  Read Only: true

  Maximum Length: 80

  The name of the compensation plan.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• EndDate: string (date)
  Title: End Date

  The date and time when the plan component associated with a compensation plan becomes inactive. This field is mandatory. The acceptable format is yyyy-mm-dd. Once a date is assigned, it cannot be updated to null.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The session login associated to the user who last updated the record.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The date when the record was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PlanComponentId: integer (int64)
  Title: Plan Component ID

  The unique identifier of a plan component.
• PlanComponentName: string
  Title: Plan Component Name

  Read Only: true

  Maximum Length: 80

  The name of a plan component.
• PlanComponentValidForCalculation: string
  Title: Valid for Calculation

  Read Only: true

  Maximum Length: 30

  Default Value: INCOMPLETE

  Indicates whether the plan component is ready for calculation. Possible values include COMPLETE when the plan component is valid and ready for calculation, and INCOMPLETE when the plan component is not valid and not ready for calculation. The default value is INCOMPLETE. A list of acceptable values is defined in the lookup CN_FORMULA_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• StartDate: string (date)
  Title: Start Date

  The date and time when the plan component associated with a compensation plan becomes active. This field is mandatory. The acceptable format is yyyy-mm-dd. Once a date is assigned, it cannot be updated to null.
• TargetIncentiveAmount: number
  Title: Target Incentive Amount

  Read Only: true

  Default Value: 100

  The amount for each plan component derived by multiplying the weight with the compensation plan target incentive.
• TargetIncentivePercent: number
  Title: Target Incentive Percent

  Default Value: 100

  The percentage of influence a plan component has on the compensation plan. The default value is 100.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetIncentivePercent":{
            "title":"Target Incentive Percent",
            "type":"number",
            "description":"The percentage of influence a plan component has on the compensation plan. The default value is 100.",
            "nullable":true,
            "default":"100",
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompensationPlanId":{
            "title":"Compensation Plan ID",
            "type":"integer",
            "description":"The unique identifier for a compensation plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CompensationPlanName":{
            "title":"Compensation Plan Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the compensation plan.",
            "nullable":false,
            "readOnly":true,
            "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. This cannot be updated once the plan component has been created.  A list of acceptable values is defined in the lookup CN_PLAN_INCENTIVE_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"default"
            },
            "x-queryable":true
        },
        "PlanComponentId":{
            "title":"Plan Component ID",
            "type":"integer",
            "description":"The unique identifier of a plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date and time when the plan component associated with a compensation plan becomes inactive. This field is mandatory. The acceptable format is yyyy-mm-dd. Once a date is assigned, it cannot be updated to null.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CalculationSequence":{
            "title":"Calculation Sequence",
            "type":"integer",
            "description":"Indicates the order in which the calculation engine considers the plan component within a compensation plan. The default value is 1.",
            "format":"int64",
            "nullable":true,
            "default":"1",
            "x-hints":{
                "controlType":"default",
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date and time when the plan component associated with a compensation plan becomes active. This field is mandatory. The acceptable format is yyyy-mm-dd. Once a date is assigned, it cannot be updated to null.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CompensationPlanComponentId":{
            "type":"integer",
            "description":"The unique identifier for a plan component associated with a compensation plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CalculationPhase":{
            "title":"Calculation Phase",
            "type":"integer",
            "description":"The phase in which the application considers plan component for calculation. Two supported phases: Phase 1 and Phase 2. Possible values include 1 and 2. The default value is 1. A list of acceptable values is defined in the lookup CN_CALCULATION_PHASE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"default",
                "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 Name",
            "maxLength":"80",
            "type":"string",
            "description":"The name of a plan component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentValidForCalculation":{
            "title":"Valid for Calculation",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates whether the plan component is ready for calculation. Possible values include COMPLETE when the plan component is valid and ready for calculation, and INCOMPLETE when the plan component is not valid and not ready for calculation. The default value is INCOMPLETE.  A list of acceptable values is defined in the lookup CN_FORMULA_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"INCOMPLETE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "TargetIncentiveAmount":{
            "title":"Target Incentive Amount",
            "type":"number",
            "description":"The amount for each plan component derived by multiplying the weight with the compensation plan target incentive.",
            "nullable":true,
            "readOnly":true,
            "default":"100",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The date when the record was last updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : compensationPlans-CompensationPlanDirectAssignmentRequests-item-response

Type: object

Show Source

• CompensationPlanId: integer (int64)
  The unique identifier of the base compensation plan.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date and time when the direct assignment request was created.
• EndDate: string (date)
  The date when the direct assignment request becomes inactive.
• ErrorReason: string
  Maximum Length: 240

  The reason why Deploy Compensation Plans process rejected the request. This attribute is not populated if the record has been processed.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the direct assignment request was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• ParticipantId: integer (int64)
  The unique identifier of the participant.
• ParticipantName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the participant.
• ParticipantPlanNumber: string
  Read Only: true

  Maximum Length: 30

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

  The unique identifier of the direct assignment request.
• ProcessingStatus: string
  Read Only: true

  The processing status of the participant direct assignment request specifying the stage the request is in, such as Create requested, Create request completed, Create request failed, Edit requested, Update request completed, Update request failed, Delete requested, Delete request completed, or Delete request failed. A list of acceptable values is defined in the lookup ORA_CN_PRT_DRCT_ASGN_RQ_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• ProcessRequestId: integer (int64)
  Read Only: true

  The unique identifier of the request of the Deploy Compensation Plan process that picked up the request.
• RequestCreateFlag: boolean
  Indicates whether a direct assignment request should be created.
• RequestDeleteFlag: boolean
  Indicates whether a direct assignment request should be deleted. If the flag is set Y and the delete does not work, then you must set the flag to True.
• RequestEditFlag: boolean
  Indicates whether a direct assignment request should be edited.
• SrpCompPlanId: integer (int64)
  The unique identifier of the compensation plan.
• StartDate: string (date)
  The date when the direct assignment request becomes active.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the direct assignment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the direct assignment request was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanDirectAssignmentRequestId":{
            "type":"integer",
            "description":"The unique identifier of the direct assignment request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the direct assignment request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SrpCompPlanId":{
            "type":"integer",
            "description":"The unique identifier of the compensation plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "CompensationPlanId":{
            "type":"integer",
            "description":"The unique identifier of the base compensation plan.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RequestCreateFlag":{
            "type":"boolean",
            "description":"Indicates whether a direct assignment request should be created.",
            "nullable":true,
            "x-queryable":false
        },
        "RequestDeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether a direct assignment request should be deleted. If the flag is set Y and the delete does not work, then you must set the flag to True.",
            "nullable":true,
            "x-queryable":false
        },
        "ProcessRequestId":{
            "type":"integer",
            "description":"The unique identifier of the request of the Deploy Compensation Plan process that picked up the request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ErrorReason":{
            "maxLength":"240",
            "type":"string",
            "description":"The reason why Deploy Compensation Plans process rejected the request. This attribute is not populated if the record has been processed.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the participant.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The date when the direct assignment request becomes inactive.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The date when the direct assignment request becomes active.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ParticipantPlanNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the participant plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessingStatus":{
            "type":"string",
            "description":"The processing status of the participant direct assignment request specifying the stage the request is in, such as Create requested, Create request completed, Create request failed, Edit requested, Update request completed, Update request failed, Delete requested, Delete request completed, or Delete request failed. A list of acceptable values is defined in the lookup ORA_CN_PRT_DRCT_ASGN_RQ_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the direct assignment request was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login details of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequestEditFlag":{
            "type":"boolean",
            "description":"Indicates whether a direct assignment request should be edited.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : compensationPlans-CompensationPlanRoles-item-response

Type: object

Show Source

• CompensationPlanId: integer (int64)
  The unique identifier for a compensation plan.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the record was created.
• EndDate: string (date)
  Title: End Date

  The date when the role assignment in a compensation plan becomes inactive. The acceptable format is yyyy-mm-dd. Once a date has been assigned, it cannot be updated to null.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The session login associated to the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RoleDescription: string
  Title: Role Description

  Read Only: true

  Maximum Length: 120

  The description of the role entered by the user while creating the role.
• RoleId: integer (int64)
  The unique identifier for a role.
• RoleName: string
  Title: Role Name

  Read Only: true

  Maximum Length: 60

  The name of the role.
• RolePlanId: integer (int64)
  The unique identifier for the role associated with a plan.
• StartDate: string (date)
  Title: Start Date

  The date when the role assignment in a compensation plan becomes active. The acceptable format is yyyy-mm-dd.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompensationPlanId":{
            "type":"integer",
            "description":"The unique identifier for a compensation plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RoleDescription":{
            "title":"Role Description",
            "maxLength":"120",
            "type":"string",
            "description":"The description of the role entered by the user while creating the role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier for a role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the role assignment in a compensation plan becomes inactive. The acceptable format is yyyy-mm-dd. Once a date has been assigned, it cannot be updated to null.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RolePlanId":{
            "type":"integer",
            "description":"The unique identifier for the role associated with a plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the role assignment in a compensation plan becomes active. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":"60",
            "type":"string",
            "description":"The name of the role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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 : compensationPlans-compensationPlansDFF-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

  The flex context segment display name for the compensation plan. It determines which context-sensitive segments are displayed.
• CompPlanId: integer (int64)
  The unique identifier of the compensation plan.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "CompPlanId":{
            "type":"integer",
            "description":"The unique identifier of the compensation plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"The flex context segment display name for the compensation plan. It determines which context-sensitive segments are displayed.",
            "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":"TEXT_BOX"
            },
            "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":{
                "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":"TEXT_BOX"
            },
            "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"
    }
}

Links

BusinessUnitPVO

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationBusinessUnitsLOV

The list of values containing the unique identifiers of the business units.

The following properties are defined on the LOV link relation:

• Source Attribute: OrgId; Target Attribute: OrganizationId
• Display Attribute: Name

CnLookupPlanApprovalStatusVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_PLAN_APPR_STATUS

The list of values indicating whether the compensation plan is in the approval process. Possible values include Approved, Not Approved, Pending Approval, and Rejected.

The following properties are defined on the LOV link relation:

• Source Attribute: ApprovalStatus; Target Attribute: LookupCode
• Display Attribute: Meaning

CnLookupPlanValidforCalculationVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_COMP_PLAN_STATUS

The list of values indicating if the compensation plan is valid for calculation. Possible values include Yes and No.

The following properties are defined on the LOV link relation:

• Source Attribute: ValidForCalculation; Target Attribute: LookupCode
• Display Attribute: Meaning

CnLookupYesNoVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_YES_NO

The list of values indicating whether a credit category can exist in multiple plan components within the compensation plan. If Yes then the compensation plan allows multiple plan components. Possible values include Yes and No.

The following properties are defined on the LOV link relation:

• Source Attribute: AllowCreditCategoryOverlapFlag; Target Attribute: LookupCode
• Display Attribute: Meaning

CompensationPlanAssignments

Operation: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanAssignments

Parameters:

• CompensationPlanId: $request.path.CompensationPlanId

The assignments resource is used to view all the participants associated with a compensation plan. This includes participants that are assigned directly or assigned through incentive compensation roles. An assignments provides the dates when a participant became a part of a compensation plan. An active compensation plan and a participant need to exist before creating an assignment.

CompensationPlanComponents

Operation: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanComponents

Parameters:

• CompensationPlanId: $request.path.CompensationPlanId

The plan components resource is used to create, update, or delete the association of a plan component with a compensation plan. It can also be used to display all the details of plan components under a compensation plan. A plan component resource links the plan component with the compensation and provides additional details at this level. A plan component needs to exist before creating this record.

CompensationPlanDirectAssignmentRequests

Operation: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanDirectAssignmentRequests

Parameters:

• CompensationPlanId: $request.path.CompensationPlanId

The direct assignment requests resource is used to view, create, and delete direct participant assignment requests. The resource can be used to request a new participant to be assigned to a plan, edit an existing participant assignment, or delete a participant assigned to a plan. The resource can also be used to delete a previously raised request. Once a request is created, the user must run the Deploy Compensation Plans process for it to apply. Once applied, this change can be seen in the Assignments resource.

CompensationPlanRoles

Operation: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/CompensationPlanRoles

Parameters:

• CompensationPlanId: $request.path.CompensationPlanId

The roles resource is used to create, update, or delete the assignment of a role to a compensation plan. It is also be used to display all the details of roles assigned to a compensation plan. A roles resource links the Incentive Compensation role to a compensation plan and provides additional details at this level. A role needs to exist before creating this record. Only the plan administrator can assign a role to the compensation plan using this service.

PlanDocumentTemplateVO

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPlanDocumentTemplatesLOV

The list of values containing the name of the report template used to create a compensation plan document for participants who are part of this compensation plan.

The following properties are defined on the LOV link relation:

• Source Attribute: PlanDocumentTemplate; Target Attribute: TemplateName
• Display Attribute: TemplateName

compensationPlansDFF

Operation: /fscmRestApi/resources/11.13.18.05/compensationPlans/{CompensationPlanId}/child/compensationPlansDFF

Parameters:

• CompensationPlanId: $request.path.CompensationPlanId

The descriptive flex fields resource is used to store user defined values for the compensation plan. A new API name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.

Back to Top

Examples

The following example shows how to get a compensation plan by submitting a GET request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/compensationPlans/300100090306794

Example of Response Body

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

{
  "ApprovalStatus": "NOT_APPROVED",
  "ValidForCalculation": "COMPLETE",
  "OrgId": 204,
  "StartDate": "2016-01-01",
  "EndDate": "2016-12-31",
  "TargetIncentive": 10000,
  "AllowCreditCategoryOverlapFlag": false,
  "Description": null,
  "LastUpdateDate": "2017-06-07T07:58:01.093-07:00",
  "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "CreationDate": "2017-06-02T05:37:52.001-07:00",
  "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "LastUpdateLogin": "5160681C1C454D39E0532DD6F00A08CA",
  "DisplayName": "Compensation Plan for Silver incorporated for 2016",
  "CompensationPlanId": 300100090306794,
  "PlanDocumentTemplate": "Participant Plan Template",
  "Name": "Silver Inc Plan",
  "InvalidReason": null,
  "links": [
    ...
  ]
}

Back to Top