Incentive Compensation Dispute Request
Service to create, retrieve, and update incentive compensation disputes. A dispute can be related to an incentive compensation paysheet, credit, or calculated earning, as well as transactions for which the participant did not receive credit.
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/apps/incentiveCompensation/cn/disputeManagement/disputeService/}DisputeService
Service WSDL URL: https://servername/fscmService/DisputeService?WSDL
Logical Business Objects
-
IC : Incentive Compensation : Incentive Compensation Dispute
Relationships
The following table describes how this service data object is related to other service data objects or business object services.
| Relationship Type | Object or Service |
|---|---|
|
Handles |
|
|
Handles |
Operations
getAssigneesList
Gets the list of assignees for the tasks related to a single dispute that matches the specified unique dispute identifier.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
disputeId |
string |
The unique identifier of the dispute human task instance. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
The list of assignees for the dispute task that matches the specified criteria. The list is in the <UserId> | <User Name> format. |
approveDisputeWithResolutionOnBehalfOf
Approves the task for the specified dispute and user. The task should be in Assigned state and Assigned to the user. The dispute resolution can also be provided using this method.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
disputeId |
string |
The unique identifier of the dispute human task instance. |
|
user |
string |
The identifier of the user for whom the approval is on behalf of. The user identifier can be obtained from the getAssigneesList method. |
|
resolution |
string |
The lookup code that represents the dispute resolution. Valid lookup codes for lookup type CN_DISPUTE_RESLN_TYPE can be reviewed using the Setup and Maintenance, Manage Incentive Compensation Lookups task. |
|
comments |
string |
The comments for the approval. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
Returns SUCCESS if the dispute approval is successful. |
approveDisputeOnBehalfOf
Approves the task for the specified dispute and user. The task should be in Assigned state and Assigned to the user.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
disputeId |
string |
The unique identifier of the dispute human task instance. |
|
user |
string |
The identifier of the user for whom the approval is on behalf of. The user identifier can be obtained from the getAssigneesList method. |
|
comments |
string |
The comments for the approval. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
Returns SUCCESS if the dispute approval is successful. |
rejectDisputeWithResolutionOnBehalfOf
Rejects the task for the specified dispute and user. The task should be in Assigned state and Assigned to the user. The dispute resolution can also be provided using this method.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
disputeId |
string |
The unique identifier of the dispute human task instance. |
|
user |
string |
The identifier of the user for whom the rejection is on behalf of. The user identifier can be obtained from the getAssigneesList method. |
|
resolution |
string |
The lookup code that represents the dispute resolution. Valid lookup codes for lookup type CN_DISPUTE_RESLN_TYPE can be reviewed using the Setup and Maintenance, Manage Incentive Compensation Lookups task. |
|
comments |
string |
The comments for the rejection. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
Returns SUCCESS if the dispute rejection is successful. |
rejectDisputeOnBehalfOf
Rejects the task for the specified dispute and user. The task should be in Assigned state and Assigned to the user.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
disputeId |
string |
The unique identifier of the dispute human task instance. |
|
user |
string |
The identifier of the user for whom the rejection is on behalf of. The user identifier can be obtained from the getAssigneesList method. |
|
comments |
string |
The comments for the rejection. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
Returns SUCCESS if the dispute rejection is successful. |
initMOAC
Initializes the business unit context.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
privName |
string |
Name of the privilege with which to initialize the business unit context. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
void |
No return object. |
submitRequestedInformation
Submits the request for information for a dispute.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
disputeId |
string |
The unique identifier of the dispute human task instance. |
|
user |
string |
The identifier of the user for whom the request for more information is from. The user identifier can be obtained from the getAssigneesList method. |
|
comments |
string |
The comments for the request for more information. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
Returns SUCCESS if the dispute request for more information is successful. |
reassignTasksonBehalfOf
Method to reassign a particular task associated with the disputeId (parameter) and assigned to the user (parameter - currentUser). The task should be in ASSIGNED state and assigned to the user. User Type can also be provided using this method.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
disputeId |
string |
DisputeId which is associated with the Human Tasks |
|
currentUser |
string |
User obtained from the getAssigneesList method |
|
newUser |
string |
New User to which the task has to be reassigned. |
|
type |
string |
The type of new User. The type can be one of the following values 1. user 2. group 3. role |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
Returns a message if the task for the specific dispute Id is successfully reassigned |
getUserComments
Method to get the User Comments for the tasks related to the dispute with the specified disputeId
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
disputeId |
string |
DisputeId which is associated with the Human Tasks |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
User Comments List for the tasks related to the dispute with the specified disputeId. This will be a list of strings where each string will be of the format '<Time> | <User Name>|<Comment>'. |
delegateTaskonBehalfOf
Method to delegate a particular task associated with the disputeId (parameter) and assigned to the user (parameter - currentUser). The task should be in ASSIGNED state and assigned to the user.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
disputeId |
string |
DisputeId which is associated with the Human Tasks |
|
currentUser |
string |
User obtained from the getAssigneesList method |
|
newUser |
string |
New User to which the task has to be delegated. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
string |
Returns a message if the task for the specific dispute Id is successfully reassigned |
createDispute
Creates a single dispute.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
disputeP |
Incentive Compensation Dispute Request |
The input payload for the dispute to be created. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The created dispute. |
updateDispute
Updates a single dispute.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
disputeP |
Incentive Compensation Dispute Request |
The input payload for the dispute to be updated. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The updated dispute. |
getDispute
Gets a single dispute that matches the specified unique dispute identifier.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
disputeId |
long |
The unique identifier of the dispute human task instance. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The dispute that matches the specified criteria. |
getDfltObjAttrHints
Gets user interface hints, such as the service data object label and object attribute labels, for the specified service data object and locale. As a prerequisite, invoke the getEntityList operation defined on this service to get the list of possible values for the viewName request payload element.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
viewName |
string |
The service view usage name, an internal name for the service data object. Specify the value of the name element from the getEntityList operation response payload. |
|
localeName |
string |
The locale to use when evaluating the locale-based user interface hints. The locale name is in the ISO 639-1 format. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}ObjAttrHints |
The label and user interface hints for the specified service data object and its attributes in a name-value pair format. |
getServiceLastUpdateTime
Gets the date and time for when the schema files, referenced in the service definition, last changed.
Life Cycle Status: Active
Request Payload
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
The date and time when the service definition last changed in ISO 8601 format. |
getEntityList
Gets the list of service data objects defined on this service.
Life Cycle Status: Active
Request Payload
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/adf/svc/types/}ServiceViewInfo |
A list of service data objects defined for this service. For each service data object, the result includes the QName, internal name, and Boolean values indicating whether create, update, merge, and delete operations can be performed on the object. |
Security
The following tables list the privileges required to perform the service operations, and the duty roles that each privilege is granted to.
Service Operations to Privileges Mapping
| Operation Name | Privilege Code | Privilege Name | Privilege Description |
|---|---|---|---|
|
All Operations |
CN_MANAGE_INCENTIVE_COMPENSATION_DISPUTE_PRIV |
Manage Incentive Compensation Dispute |
Allows analysis of incentive compensation disputes. |
|
All Operations |
CN_MAINTAIN_INCENTIVE_COMPENSATION_PARTICIPANT_DETAIL_PRIV |
Maintain Incentive Compensation Participant Detail |
Allows assignment of participants to analysts, who manage incentive compensation details for a person or organization whose credits, attainment, earnings, disputes, and payments the incentive compensation application computes and manages. A person or organization can be an employee, salesperson, party, supplier contract, partner, or third party resale contractor. |
|
All Operations |
CN_CREATE_INCENTIVE_COMPENSATION_DISPUTE_PRIV |
Create Incentive Compensation Dispute |
Allows creation of dispute over incentive compensation credits, earnings, payments, and goals for participant. |
Privileges to Duty Roles Mapping
| Privilege Code | Granted to Duty Role Code | Granted to Duty Role Name | Granted To Duty Role Description |
|---|---|---|---|
|
CN_MAINTAIN_INCENTIVE_COMPENSATION_PARTICIPANT_DETAIL_PRIV |
ORA_CN_INCENTIVE_COMPENSATION_PARTICIPANT_PLAN_MANAGEMENT_DUTY |
Incentive Compensation Participant Snapshot Management |
Assign and maintain incentive plans and transactions for participants |
|
CN_CREATE_INCENTIVE_COMPENSATION_DISPUTE_PRIV |
ORA_CN_INCENTIVE_COMPENSATION_PARTICIPANT_MANAGER_ABSTRACT |
Incentive Compensation Participant Manager |
Manage participants who receive incentive compensation and review reports |
|
CN_CREATE_INCENTIVE_COMPENSATION_DISPUTE_PRIV |
ORA_CN_INCENTIVE_COMPENSATION_PARTICIPANT_ABSTRACT |
Incentive Compensation Participant |
Receive incentive compensation computed by the application and review reports |
|
CN_CREATE_INCENTIVE_COMPENSATION_DISPUTE_PRIV |
ORA_ZBS_SALES_VP_JOB |
Sales VP |
Manages sales managers within the organization. Responsible for account planning, territory and quota management, and managing sales forecasts for the territory. |
|
CN_CREATE_INCENTIVE_COMPENSATION_DISPUTE_PRIV |
ORA_ZBS_SALES_REPRESENTATIVE_JOB |
Sales Representative |
Represents the business to sell its products. Maintains relationships with customers and contacts, builds pipeline, manages leads and opportunities and performs sales forecasting. |
|
CN_CREATE_INCENTIVE_COMPENSATION_DISPUTE_PRIV |
ORA_ZBS_SALES_MANAGER_JOB |
Sales Manager |
Manages salespersons within the organization. Generates revenue within a territory, builds pipeline, manages territory forecasts, and assists salespersons in closing deals. |
|
CN_MANAGE_INCENTIVE_COMPENSATION_DISPUTE_PRIV |
ORA_CN_INCENTIVE_COMPENSATION_PARTICIPANT_MANAGER_ABSTRACT |
Incentive Compensation Participant Manager |
Manage participants who receive incentive compensation and review reports |
|
CN_MANAGE_INCENTIVE_COMPENSATION_DISPUTE_PRIV |
ORA_CN_INCENTIVE_COMPENSATION_PARTICIPANT_PLAN_MANAGEMENT_DUTY |
Incentive Compensation Participant Snapshot Management |
Assign and maintain incentive plans and transactions for participants |
|
CN_MANAGE_INCENTIVE_COMPENSATION_DISPUTE_PRIV |
ORA_ZBS_SALES_VP_JOB |
Sales VP |
Manages sales managers within the organization. Responsible for account planning, territory and quota management, and managing sales forecasts for the territory. |
|
CN_MANAGE_INCENTIVE_COMPENSATION_DISPUTE_PRIV |
ORA_ZBS_SALES_MANAGER_JOB |
Sales Manager |
Manages salespersons within the organization. Generates revenue within a territory, builds pipeline, manages territory forecasts, and assists salespersons in closing deals. |
Duty Roles to Duty or Job Roles Mapping
| Duty Role Code | Granted to Duty or Job Role Code | Granted to Duty or Job Role Name | Granted To Duty or Job Role Description |
|---|---|---|---|
|
ORA_CN_INCENTIVE_COMPENSATION_PARTICIPANT_MANAGER_ABSTRACT |
ORA_CN_INCENTIVE_COMPENSATION_PARTICIPANT_ABSTRACT |
Incentive Compensation Participant |
Receive incentive compensation computed by the application and review reports |
|
ORA_ZBS_SALES_VP_JOB |
ORA_ZCM_SALES_PARTY_MANAGEMENT_DUTY_FSCM |
Sales Party Management |
Manages creation and maintenance of the sales organizations and consumers for internal sales users. Additional duties include viewing of opportunities and opportunity revenue, reviewing sales leads as well as appointments, interactions, and customer contacts. |
|
ORA_ZBS_SALES_MANAGER_JOB |
ORA_ZCM_SALES_PARTY_MANAGEMENT_DUTY_FSCM |
Sales Party Management |
Manages creation and maintenance of the sales organizations and consumers for internal sales users. Additional duties include viewing of opportunities and opportunity revenue, reviewing sales leads as well as appointments, interactions, and customer contacts. |
|
ORA_ZBS_SALES_REPRESENTATIVE_JOB |
ORA_ZCM_SALES_PARTY_MANAGEMENT_DUTY_FSCM |
Sales Party Management |
Manages creation and maintenance of the sales organizations and consumers for internal sales users. Additional duties include viewing of opportunities and opportunity revenue, reviewing sales leads as well as appointments, interactions, and customer contacts. |
|
ORA_ZBS_SALES_REPRESENTATIVE_JOB |
ORA_ZCM_SALES_PARTY_REVIEW_DUTY_FSCM |
Sales Party Review |
Allows resources read-only access to sales parties information such as manage customer work area and all sales party duties. Additional duties include view access to other customer and sales lead features. |
|
ORA_ZBS_SALES_VP_JOB |
ORA_SVC_SR_CONTRIBUTOR_FSCM |
Service Request Contributor |
Can create Service Requests and help with resolution of the Service Request. Has basic Service Request Management capabilities. Would not be able to respond to customer, assign SR to a user or change the status of a SR. |
|
ORA_ZBS_SALES_MANAGER_JOB |
ORA_SVC_SR_CONTRIBUTOR_FSCM |
Service Request Contributor |
Can create Service Requests and help with resolution of the Service Request. Has basic Service Request Management capabilities. Would not be able to respond to customer, assign SR to a user or change the status of a SR. |
|
ORA_ZBS_SALES_REPRESENTATIVE_JOB |
ORA_SVC_SR_CONTRIBUTOR_FSCM |
Service Request Contributor |
Can create Service Requests and help with resolution of the Service Request. Has basic Service Request Management capabilities. Would not be able to respond to customer, assign SR to a user or change the status of a SR. |
|
ORA_ZBS_SALES_VP_JOB |
ORA_OSS_SUBSCRIPTION_SALES_VIEW_DUTY_FSCM |
Subscription Sales View |
Searches and views subscriptions for the assigned business units. This duty role is specifically applicable for sales job roles. |
|
ORA_ZBS_SALES_MANAGER_JOB |
ORA_OSS_SUBSCRIPTION_SALES_VIEW_DUTY_FSCM |
Subscription Sales View |
Searches and views subscriptions for the assigned business units. This duty role is specifically applicable for sales job roles. |
|
ORA_ZBS_SALES_REPRESENTATIVE_JOB |
ORA_OSS_SUBSCRIPTION_SALES_VIEW_DUTY_FSCM |
Subscription Sales View |
Searches and views subscriptions for the assigned business units. This duty role is specifically applicable for sales job roles. |
|
ORA_ZBS_SALES_VP_JOB |
ORA_MOT_TERRITORY_MANAGEMENT_DUTY_FSCM |
Territory Management |
Manages sales territories, territory proposals, and quotas. |
|
ORA_ZBS_SALES_MANAGER_JOB |
ORA_MOT_TERRITORY_MANAGEMENT_DUTY_FSCM |
Territory Management |
Manages sales territories, territory proposals, and quotas. |