1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Paysheets

Update a paysheet

patch

/fscmRestApi/resources/11.13.18.05/paysheets/{PaysheetId}

Request

Path Parameters
Header Parameters
  • 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".
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Payment Reference Number
    Maximum Length: 400
    The reference number that acknowledges the actual payment made by the paying systems.
  • Title: Payment Date
    The paysheet, payment batch pay date. The payment batch creation process selected all unpaid earnings to include in the paysheet where the earning event dates were on or earlier than the pay date.
  • Title: Payment Method
    Maximum Length: 30
    The acknowledged method of payment, such as electronic funds transfer or a check, from a paying system, such as payables or payroll.
  • Payment Transactions
    Title: Payment Transactions
    The payment transactions resource is used to view, create, update, and delete participant payment transactions. A payment transaction can be the calculated earnings from an incentive compensation plan component, a manual adjustment, a recovered amount, or a payment plan draw and recovery adjustment. The payment transaction resource is also used to manage payment transaction holds and manual adjustments for paysheets with a status of unpaid.
Nested Schema : Payment Transactions
Type: array
Title: Payment Transactions
The payment transactions resource is used to view, create, update, and delete participant payment transactions. A payment transaction can be the calculated earnings from an incentive compensation plan component, a manual adjustment, a recovered amount, or a payment plan draw and recovery adjustment. The payment transaction resource is also used to manage payment transaction holds and manual adjustments for paysheets with a status of unpaid.
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Comment
    Maximum Length: 1000
    Commentary entered when adjusting the payment transaction amount.
  • Title: Credit Receiver
    The unique identifier of the incentive compensation participant who received credit for the source transaction. Review the participant identifier for a participant using the Participant Snapshot work area, Select Participant page.
  • Title: Payment Hold
    Maximum Length: 1
    Default Value: false
    Indicates whether to hold a payment transaction until the hold is explicitly released. If the value is Y, then the payment transaction is on hold. The default value is Y.
  • Title: Home Currency
    Maximum Length: 15
    The code indicating the participant home currency that is in effect as of the source event date of the payment transaction. Review the effective participant attributes using the Participant Snapshot work area, Manage Participant Detail page.
  • Title: Payment Type
    Maximum Length: 30
    Default Value: MANUAL_PAY_ADJ
    The code that represents the categorization of the payment transaction types, such as bonus, payment plan adjustments, and manual adjustments. Review the available codes for lookup CN_PAYMENT_ADJUSTMENT_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • Title: Reason
    Maximum Length: 30
    The code that represents the reason for the paysheet manual adjustment. Review the available codes for lookup ORA_CN_PAYSHEET_MANUAL_ADJ using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • Title: Business Unit
    The unique identifier of the business unit to which the payment transaction belongs. Review the business unit ID for a business unit using the Setup and Maintenance, Define Business Units task. If the Business Unit ID column is not displayed, then click the View menu to add the Business Unit ID column.
  • The unique identifier of the payment transaction.
  • Title: Home Payment Amount
    The payment transaction amount in the participant home currency.
  • Title: Processing Payment Amount
    The payment transaction amount in the processing currency. The processing currency is selected as either the operating currency or the participant home currency for the business unit. Review the processing currency parameter using the Setup and Maintenance work area, Manage Parameters task.
  • Title: Period
    The period number representing the period of the payment transaction earning event date or the payment batch period for the manual paysheet adjustment. The period numbers are generated when you define your incentive compensation calendar using the Setup and Maintenance work area, Manage Calendars task. For example, the period number 2015001 represents the first period in the year 2015.
  • The unique identifier of the payment batch to which this payment transaction belongs.
  • The unique identifier of the participant incentive compensation plan component used to calculate the participant earning amount.
  • Title: Recoverable
    Maximum Length: 1
    Default Value: true
    Indicates whether the payment adjustment is recoverable in the future. If the value is Y, then the payment adjustment is recoverable. The default value is Y.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : paysheets-item-response
Type: object
Show Source
  • Title: Beginning Balance
    Read Only: true
    Reserved for future use.
  • Title: Calculated Amount
    Read Only: true
    The sum of unadjusted calculated earnings for the paysheet.
  • Title: Payment Reference Number
    Maximum Length: 400
    The reference number that acknowledges the actual payment made by the paying systems.
  • Title: Earning Difference
    Read Only: true
    The difference between the sum of unadjusted calculated earnings and the actual amount to be paid after adjustments.
  • Title: Last Update Date
    Read Only: true
    The date when the paysheet was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the paysheet record.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 32
    The session login associated to the user who last updated the paysheet record.
  • Links
  • Title: Waived Amount
    Read Only: true
    Reserved for future use.
  • Title: Business Unit
    Read Only: true
    The unique identifier of the business unit to which the paysheet belongs. Review the business unit ID for a business unit using the Setup and Maintenance, Define Business Units task. If the Business Unit ID column is not displayed, then click the View menu to add the Business Unit ID column.
  • Title: Business Unit
    Read Only: true
    Maximum Length: 960
    The name of the business unit to which the paysheet belongs.
  • Title: Participant Identifier
    Read Only: true
    The unique identifier of the incentive compensation participant for whom the paysheet amount is due or recoverable. Review the participant identifier for a participant using the Participant Snapshot work area, Select Participant page.
  • Title: Participant Name
    Read Only: true
    Maximum Length: 360
    The name of the incentive compensation participant for whom the paysheet amount is due or recoverable.
  • Title: Party Identifier
    Read Only: true
    The unique identifier of the party in the trading community. The party is the participant for whom the paysheet amount is due or recoverable. Review the party identifier for a participant using the Participant Snapshot work area, Select Participant page.
  • Title: Party Number
    Read Only: true
    Maximum Length: 30
    The alternate key identifier of the party in the trading community. The party is the participant for whom the paysheet amount is due or recoverable. Review the party number for a participant using the Participant Snapshot work area, Select Participant page and the Manage Participant Detail page.
  • Title: Currency
    Read Only: true
    Maximum Length: 15
    The code indicating the processing currency. The processing currency is selected as either the operating currency or the participant home currency for the business unit. Review the processing currency parameter using the Setup and Maintenance work area, Manage Parameters task.
  • Read Only: true
    The unique identifier of the pay group which was used by the paysheet payment batch to select the incentive compensation participants for payment.
  • Title: Pay Group
    Read Only: true
    Maximum Length: 80
    The name of the pay group which was used by the paysheet payment batch to select the incentive compensation participants for payment. Review pay groups using the Participant Assignments work area, Manage Pay Groups task.
  • Title: Payment Amount
    Read Only: true
    The sum of both adjusted and unadjusted payment transactions.
  • Title: Payment Date
    The paysheet, payment batch pay date. The payment batch creation process selected all unpaid earnings to include in the paysheet where the earning event dates were on or earlier than the pay date.
  • Title: Payment Method
    Maximum Length: 30
    The acknowledged method of payment, such as electronic funds transfer or a check, from a paying system, such as payables or payroll.
  • Title: Total Amount
    Read Only: true
    The paysheet payment amount in the processing currency.
  • Payment Transactions
    Title: Payment Transactions
    The payment transactions resource is used to view, create, update, and delete participant payment transactions. A payment transaction can be the calculated earnings from an incentive compensation plan component, a manual adjustment, a recovered amount, or a payment plan draw and recovery adjustment. The payment transaction resource is also used to manage payment transaction holds and manual adjustments for paysheets with a status of unpaid.
  • Title: Period
    Read Only: true
    The period number representing the calendar period the paysheet, payment batch is for. The period numbers are generated when you define your incentive compensation calendar using the Setup and Maintenance work area, Manage Calendars task. For example, the period number 2015001 represents the first period in the year 2015.
  • Read Only: true
    The unique identifier of the payment batch to which the paysheet belongs.
  • Title: Payment Batch
    Read Only: true
    Maximum Length: 80
    The name of the payment batch to which the paysheet belongs.
  • Read Only: true
    Default Value: false
    The access indicator to inform which standard actions are not applicable. Here we cannot use the DELETE standard action for paysheets.
  • The unique identifier of the paysheet.
  • Title: Status
    Read Only: true
    Maximum Length: 30
    The lookup code that represents the current paysheet status, such as unpaid, submitted, and approved. Review available lookup codes for the lookup type CN_PAYSHEET_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • Read Only: true
    Default Value: false
    The access indicator to inform which standard actions are not applicable. Here we cannot use the UPDATE standard action until the summary paysheet status value is paid. Only the summary paysheet can be updated. Individual plan component paysheets can't be updated.
  • Title: Incentive Compensation Calendar Period
    Read Only: true
    The period number representing the calendar period the paysheet is for. The period numbers are generated when you define your incentive compensation calendar using the Setup and Maintenance work area, Manage Calendars task. For example, the period number 2015001 represents the first period in the year 2015.
  • Title: Period Name
    Read Only: true
    Maximum Length: 30
    The name of the calendar period the paysheet, payment batch is for. The period name is entered when defining the incentive compensation calendar. For example, Jan-2015 or Q1-2015. You can review and manage period names using the Setup and Maintenance work area, Manage Calendars task.
  • Title: Person Number
    Read Only: true
    Maximum Length: 30
    The generated identifier for the participant person record in Global Human Resources for the participant for whom the paysheet amount is due or recoverable. Review the participant person number using the Participant Snapshot work area, Select Participant page and the Manage Participant Detail page.
  • Read Only: true
    The unique identifier of the participant incentive compensation plan component associated with the participant calculated earnings and paysheet adjustments.
  • Title: Plan Component
    Read Only: true
    Maximum Length: 80
    The name of the incentive compensation plan component.
  • Title: Calculated Recovery Adjustment
    Read Only: true
    The portion of the beginning balance which is recovered in the current paysheet.
  • Title: Worker Number
    Read Only: true
    Maximum Length: 30
    The worker, or employee, number for the participant for whom the paysheet amount is due or recoverable. Review the worker number using the Participant Snapshot work area, Select Participant page and the Manage Participant Detail page.
  • Title: Recoverable Adjustment
    Read Only: true
    The sum of paysheet payment plan adjustments where the adjusted amount is expected to be recovered on a subsequent paysheet.
  • Read Only: true
    Reserved for future use.
  • Title: Total Amount in Home Currency
    Read Only: true
    The paysheet payment amount in the participant's home currency.
  • Title: Calculated Total Currency Conversion Rate
    Read Only: true
    The calculated exchange rate based on the total payment amount in participant's home currency and total payment amount in processing currency. This could be a blended currency rate since the total amount in a paysheet could include multiple periods where the exchange rates may not be the same.
Nested Schema : Payment Transactions
Type: array
Title: Payment Transactions
The payment transactions resource is used to view, create, update, and delete participant payment transactions. A payment transaction can be the calculated earnings from an incentive compensation plan component, a manual adjustment, a recovered amount, or a payment plan draw and recovery adjustment. The payment transaction resource is also used to manage payment transaction holds and manual adjustments for paysheets with a status of unpaid.
Show Source
Nested Schema : paysheets-paymentTransactions-item-response
Type: object
Show Source
  • Title: Comment
    Maximum Length: 1000
    Commentary entered when adjusting the payment transaction amount.
  • Title: Earning Amount
    Read Only: true
    The calculated earning amount in the processing currency.
  • Title: Earning Rate
    Read Only: true
    The incentive rate table amount or rate that was used to calculate the earning amount.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the payment transaction record.
  • Title: Creation Date
    Read Only: true
    The date when the payment transaction was created.
  • Title: Credit Receiver
    The unique identifier of the incentive compensation participant who received credit for the source transaction. Review the participant identifier for a participant using the Participant Snapshot work area, Select Participant page.
  • Title: Credit Factor
    Read Only: true
    The uplift percentage for the increase in credit amounts over a period of time that was used in the earning calculation expression.
  • Read Only: true
    Default Value: -1000
    The unique identifier of the earning type. The earning type is selected for the plan component and is used to classify earnings into monetary and nonmonetary categories. You can only include the monetary earning type, provided by Oracle, in payment processing.
  • Title: Earning Factor
    Read Only: true
    The uplift percentage for the increase in earnings over a period of time that was used in the earning calculation expression.
  • Read Only: true
    The unique identifier of the earning history record. The changes to the earning record are stored in the earning history table.
  • Title: Earnings
    Read Only: true
    The unique identifier of the earning record. An earning is the calculated incentive amount based on the participant plan component and source transaction credit.
  • Title: Earning Type
    Read Only: true
    Maximum Length: 30
    The type of the earning. The earning type is selected for the plan component and is used to classify earnings into monetary and nonmonetary categories. Only earnings with the monetary earning type are included in payment processing.
  • Read Only: true
    The unique identifier of the credit category assigned the incentive credit. The credit category was used to classify the credit and then match the credit to the participant plan component for performance measurement and earning calculation.
  • Title: Payment Hold
    Maximum Length: 1
    Default Value: false
    Indicates whether to hold a payment transaction until the hold is explicitly released. If the value is Y, then the payment transaction is on hold. The default value is Y.
  • Title: Home Currency
    Maximum Length: 15
    The code indicating the participant home currency that is in effect as of the source event date of the payment transaction. Review the effective participant attributes using the Participant Snapshot work area, Manage Participant Detail page.
  • Title: Payment Type
    Maximum Length: 30
    Default Value: MANUAL_PAY_ADJ
    The code that represents the categorization of the payment transaction types, such as bonus, payment plan adjustments, and manual adjustments. Review the available codes for lookup CN_PAYMENT_ADJUSTMENT_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • Title: Last Update Date
    Read Only: true
    The date when the payment transaction was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the payment transaction record.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 32
    The session login associated to the user who last updated the payment transaction record.
  • Links
  • Title: Reason
    Maximum Length: 30
    The code that represents the reason for the paysheet manual adjustment. Review the available codes for lookup ORA_CN_PAYSHEET_MANUAL_ADJ using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • Title: Status
    Read Only: true
    Maximum Length: 30
    The status of the payment transaction. The valid values are UNPAID and PAID.
  • Title: Business Unit
    The unique identifier of the business unit to which the payment transaction belongs. Review the business unit ID for a business unit using the Setup and Maintenance, Define Business Units task. If the Business Unit ID column is not displayed, then click the View menu to add the Business Unit ID column.
  • Title: Participant Identifier
    Read Only: true
    The unique identifier of the incentive compensation participant for whom the payment transaction amount is due or recoverable. Review the participant identifier for a participant using the Participant Snapshot work area, Select Participant page.
  • Title: Participant Name
    Read Only: true
    Maximum Length: 360
    The name of the incentive compensation participant for whom the payment transaction amount is due or recoverable.
  • The unique identifier of the payment transaction.
  • Title: Operating Payment Amount
    Read Only: true
    The payment transaction amount in the operating currency.
  • Title: Home Payment Amount
    The payment transaction amount in the participant home currency.
  • Title: Processing Payment Amount
    The payment transaction amount in the processing currency. The processing currency is selected as either the operating currency or the participant home currency for the business unit. Review the processing currency parameter using the Setup and Maintenance work area, Manage Parameters task.
  • Title: Currency
    Read Only: true
    Maximum Length: 20
    The code indicating the processing currency. The processing currency is selected as either the operating currency or the participant home currency for the business unit. Review the processing currency parameter using the Setup and Maintenance work area, Manage Parameters task.
  • Read Only: true
    The access indicator to inform which standard actions are not applicable. Here we cannot use the DELETE standard action for payment transactions generated by the application.
  • Read Only: true
    The access indicator to inform which standard actions are not applicable. Here we cannot use the UPDATE standard action for payment plan adjustments and recovered adjustments from previous paysheets. Additionally, no updates are allowed when the paysheet status is something other than unpaid.
  • Title: Period
    The period number representing the period of the payment transaction earning event date or the payment batch period for the manual paysheet adjustment. The period numbers are generated when you define your incentive compensation calendar using the Setup and Maintenance work area, Manage Calendars task. For example, the period number 2015001 represents the first period in the year 2015.
  • The unique identifier of the payment batch to which this payment transaction belongs.
  • Title: Payment Batch
    Read Only: true
    Maximum Length: 80
    The name of the payment batch to which the payment transaction belongs.
  • Title: Person Number
    Read Only: true
    Maximum Length: 30
    The generated identifier for the participant person record in Global Human Resources for the participant for whom the payment transaction amount is due or recoverable. Review the participant person number using the Participant Snapshot work area, Select Participant page and the Manage Participant Detail page.
  • The unique identifier of the participant incentive compensation plan component used to calculate the participant earning amount.
  • Title: Worker Number
    Read Only: true
    Maximum Length: 30
    The worker, or employee, number for the participant for whom the payment transaction amount is due or recoverable. Review the worker number using the Participant Snapshot work area, Select Participant page and the Manage Participant Detail page.
  • Title: Recoverable
    Maximum Length: 1
    Default Value: true
    Indicates whether the payment adjustment is recoverable in the future. If the value is Y, then the payment adjustment is recoverable. The default value is Y.
  • Read Only: true
    The unique identifier of the source earning from which this earning originated.
  • Title: Event Date
    Read Only: true
    The date of the earning event. The event date is either the source transaction event date or the calculation grouping event date which resulted in the incentive earning.
  • Title: Transaction Number
    Read Only: true
    Maximum Length: 30
    The transaction number which resulted in the participant incentive earning.
  • Read Only: true
    The unique identifier of the assignment of the compensation plan to the participant.
Links
paymentTransactions
Parameters:
  • PaysheetId: $request.path.PaysheetId
The payment transactions resource is used to view, create, update, and delete participant payment transactions. A payment transaction can be the calculated earnings from an incentive compensation plan component, a manual adjustment, a recovered amount, or a payment plan draw and recovery adjustment. The payment transaction resource is also used to manage payment transaction holds and manual adjustments for paysheets with a status of unpaid.
Back to Top

Examples

The following example shows how to update get a paysheet by submitting a patch request on the REST resource using cURL.

cURL Command

curl --location --request PATCH 'https://fuscdrmsmc379-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/paysheets/8132' \
--header 'Content-Type: application/vnd.oracle.adf.resourceitem+json' \
--header 'Authorization: Basic b2ljX21ncl9vcGVyYXRpb25zOldlbGNvbWUx' \
--data-raw '{
"PaymentDate":"2021-07-04",
"PaymentMethod": "Cheque",
"ChequeNumber": "IX1A"
}'
The following shows an example of the response body in JSON format.

Example of Request Body

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

{
"PaymentDate":"2021-07-04",
"PaymentMethod": "Cheque",
"ChequeNumber": "IX1A"
}

Example of Response Body

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

{
    "PaysheetId": 8132,
    "ParticipantId": 12001,
    "PaysheetStatus": "APPROVED",
    "OrgId": 204,
    "OrgName": "Vision Operations",
    "LastUpdatedBy": "OIC_MGR_OPERATIONS",
    "LastUpdateLogin": "CC36DFAC47A2A905E05338C3F20AC0C6",
    "LastUpdateDate": "2021-09-20T10:39:41+00:00",
    "PaymentAdjustmentAmount": 0,
    "TotalAmountHomeCurrency": null,
    "TotalAmountPayToHomeCnvrt": null,
    "PayCurrencyCode": "USD",
    "PaymentDate": "2021-07-04",
    "PaymentMethod": "Cheque",
    "PayrunId": 300100014485210,
    "NonRecEarningAdjustment": 0,
    "RecEarningAdjustment": 0,
    "CalculatedEarnings": 6400,
    "PmtAmountRecovery": 0,
    "PayrunName": "CN Pay BatchJan09_20121224131422",
    "PayPeriodId": 2009001,
    "PayGroupId": 300100014485107,
    "PeriodName": "Jan-09",
    "PeriodId": 2009001,
    "PayGroupName": "CN Paygroup1 20121224131422",
    "PaymentTotalAmount": 6400,
    "BeginningBalanceAmount": null,
    "EarningDifference": 0,
    "ParticipantName": "IC_PARTY_20121224131422",
    "PartyId": 300100014479802,
    "PartyNumber": "CDRM_7531",
    "PersonNumber": null,
    "PrimaryWorkerNumber": null,
    "PlanComponentName": null,
    "PlanComponentId": null,
    "ChequeNumber": "IX1A",
    "PaysheetDeleteFlag": false,
    "PaysheetUpdateFlag": true,
    "SrpCompensationPlanId": null,
    "links": [
        {
            "rel": "self",
            "href": "https://fuscdrmsmc379-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/paysheets/8132",
            "name": "paysheets",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
            }
        },
        {
            "rel": "canonical",
            "href": "https://fuscdrmsmc379-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/paysheets/8132",
            "name": "paysheets",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://fuscdrmsmc379-fa-ext.us.oracle.com:443/fscmRestApi/resources/11.13.18.05/paysheets/8132/child/paymentTransactions",
            "name": "paymentTransactions",
            "kind": "collection"
        }
    ]
}
Back to Top