Incentive Compensation Payment Export
Service to export paysheet and related payment batch and participant information. This service is typically used to retrieve incentive compensation payment information for your internal or external payment system.
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/apps/incentiveCompensation/cn/paymentSetup/paysheets/paymentTransactionService/}PaymentExportService
Service WSDL URL: https://servername/fscmService/PaymentExportService?WSDL
Logical Business Objects
-
IC : Incentive Compensation : Incentive Compensation Payment Transaction
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 |
Operations
exportPaymentTransactionByPeriodName
Exports payment transactions for a period and business unit.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
pdName |
string |
The calendar period name. You define period names for your calendar using the Setup and Maintenance, Manage Calendars task. |
|
orgId |
long |
The unique identifier of the business unit to which the pay sheet belongs. You can view the business unit identifier for a business unit from the Setup and Maintenance, Define Business Units task. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The list of payment transactions. |
exportPaymentTransactionByPaymentDateRange
Exports paid payment transactions for a payment date range and business unit.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
startDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
The start of the date range used to select pay sheet payment transactions. Use the format YYYY-MM-DD. For example, 2016-12-01. |
|
endDate |
{http://xmlns.oracle.com/adf/svc/types/}date-Date |
The last date, of the date range, used to select pay sheet payment transactions. Use the format YYYY-MM-DD. For example, 2016-12-31. |
|
orgId |
long |
The unique identifier of the business unit to which the pay sheet belongs. You can view the business unit identifier for a business unit from the Setup and Maintenance, Define Business Units task. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The list of payment transactions. |
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 the 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_PAYSHEET_PRIV |
Manage Incentive Compensation Paysheet |
Allows maintenance of incentive compensation paysheets that contain the payable commission, draw and recovery, and payment adjustments for a single eligible participant. |
Privileges to Duty Roles Mapping
| Privilege Code | Granted to Duty Role Code | Granted to Duty Role Name | Granted To Duty Role Description |
|---|---|---|---|
|
CN_MANAGE_INCENTIVE_COMPENSATION_PAYSHEET_PRIV |
ORA_CN_INCENTIVE_COMPENSATION_PAYMENT_DUTY |
Incentive Compensation Payments |
Create and maintain payment batches. Adjust incentive compensation paysheets and payment transactions. Submit paysheets for approval. |