Jump to

• Request
• Response
• Examples

Create a manual adjustment

post

/fscmRestApi/resources/11.13.18.05/paymentTransactions

Request

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AdjustComments: string
  Title: Comment

  Maximum Length: 1000

  Commentary entered when adjusting the payment transaction amount.
• CreditedParticipantId: integer (int64)
  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.
• HoldFlag: boolean
  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.
• HomeCurrencyCode: string
  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.
• IncentiveTypeCode: string
  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.
• ManualAdjustmentReasonCode: string
  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.
• OrgId: integer (int64)
  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.
• ParticipantPayId: integer (int64)
  The unique identifier of the payment transaction.
• PayAmountHomeCurrency: number
  Title: Home Payment Amount

  The payment transaction amount in the participant home currency.
• PayAmountPayCurrency: number
  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.
• PayPeriodId: integer (int64)
  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.
• PayrunId: integer (int64)
  The unique identifier of the payment batch to which this payment transaction belongs.
• PlanComponentId: integer (int64)
  The unique identifier of the participant incentive compensation plan component used to calculate the participant earning amount.
• RecoverableFlag: boolean
  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.

{
    "type":"object",
    "properties":{
        "RecoverableFlag":{
            "title":"Recoverable",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":true
        },
        "HomeCurrencyCode":{
            "title":"Home Currency",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "AdjustComments":{
            "title":"Comment",
            "maxLength":"1000",
            "type":"string",
            "description":"Commentary entered when adjusting the payment transaction amount.",
            "nullable":true
        },
        "PayrunId":{
            "type":"integer",
            "description":"The unique identifier of the payment batch to which this payment transaction belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the participant incentive compensation plan component used to calculate the participant earning amount.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "dependencies":[
                    "CreditedParticipantId",
                    "PayrunId"
                ]
            }
        },
        "ManualAdjustmentReasonCode":{
            "title":"Reason",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ParticipantPayId":{
            "type":"integer",
            "description":"The unique identifier of the payment transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PayAmountPayCurrency":{
            "title":"Processing Payment Amount",
            "type":"number",
            "description":"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.",
            "nullable":false
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "PayAmountHomeCurrency":{
            "title":"Home Payment Amount",
            "type":"number",
            "description":"The payment transaction amount in the participant home currency.",
            "nullable":true
        },
        "CreditedParticipantId":{
            "title":"Credit Receiver",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "IncentiveTypeCode":{
            "title":"Payment Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"MANUAL_PAY_ADJ",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "HoldFlag":{
            "title":"Payment Hold",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false
        },
        "PayPeriodId":{
            "title":"Period",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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

Type: object

Show Source

• AdjustComments: string
  Title: Comment

  Maximum Length: 1000

  Commentary entered when adjusting the payment transaction amount.
• CommAmountCalculationCurrency: number
  Title: Earning Amount

  Read Only: true

  The calculated earning amount in the processing currency.
• CommissionValue: number
  Title: Earning Rate

  Read Only: true

  The incentive rate table amount or rate that was used to calculate the earning amount.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the payment transaction was created.
• CreditedParticipantId: integer (int64)
  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.
• CreditFactor: number
  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.
• CreditTypeId: integer (int64)
  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.
• EarningFactor: number
  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.
• EarningHId: integer (int64)
  Read Only: true

  The unique identifier of the earning history record. The changes to the earning record are stored in the earning history table.
• EarningId: integer (int64)
  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.
• EarningType: string
  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.
• EligibleCatId: integer (int64)
  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.
• HoldFlag: boolean
  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.
• HomeCurrencyCode: string
  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.
• IncentiveTypeCode: string
  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.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the payment transaction was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the payment transaction record.
• LastUpdateLogin: string
  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: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManualAdjustmentReasonCode: string
  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.
• ObjectStatus: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  The status of the payment transaction. The valid values are UNPAID and PAID.
• OrgId: integer (int64)
  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.
• ParticipantId: integer (int64)
  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.
• ParticipantName: string
  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.
• ParticipantPayId: integer (int64)
  The unique identifier of the payment transaction.
• PayAmountFuncCurrency: number
  Title: Operating Payment Amount

  Read Only: true

  The payment transaction amount in the operating currency.
• PayAmountHomeCurrency: number
  Title: Home Payment Amount

  The payment transaction amount in the participant home currency.
• PayAmountPayCurrency: number
  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.
• PayCurrencyCode: string
  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.
• PaymentTransactionDeleteFlag: boolean
  Read Only: true

  Indicates whether certain standard actions are not applicable. You cannot use the DELETE standard action for payment transactions generated by the application.
• PaymentTransactionUpdateFlag: boolean
  Read Only: true

  Indicates whether certain standard actions are not applicable. You 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.
• PayPeriodId: integer (int64)
  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.
• PayrunId: integer (int64)
  The unique identifier of the payment batch to which this payment transaction belongs.
• PayrunName: string
  Title: Payment Batch

  Read Only: true

  Maximum Length: 80

  The name of the payment batch to which the payment transaction belongs.
• PersonNumber: string
  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.
• PlanComponentId: integer (int64)
  The unique identifier of the participant incentive compensation plan component used to calculate the participant earning amount.
• PrimaryWorkerNumber: string
  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.
• RecoverableFlag: boolean
  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.
• SourceEarningId: integer (int64)
  Read Only: true

  The unique identifier of the source earning from which this earning originated.
• SourceEventDate: string (date)
  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.
• SourceTrxNumber: string
  Title: Transaction Number

  Read Only: true

  Maximum Length: 30

  The transaction number which resulted in the participant incentive earning.
• SrpPlanAssignId: integer (int64)
  Read Only: true

  The unique identifier of the assignment of the compensation plan to the participant.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the payment transaction was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "default":"-1000",
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "HomeCurrencyCode":{
            "title":"Home Currency",
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustComments":{
            "title":"Comment",
            "maxLength":"1000",
            "type":"string",
            "description":"Commentary entered when adjusting the payment transaction amount.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Participant Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the incentive compensation participant for whom the payment transaction amount is due or recoverable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningHId":{
            "type":"integer",
            "description":"The unique identifier of the earning history record. The changes to the earning record are stored in the earning history table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectStatus":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the payment transaction. The valid values are UNPAID and PAID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "title":"Participant Identifier",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParticipantPayId":{
            "type":"integer",
            "description":"The unique identifier of the payment transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PayAmountPayCurrency":{
            "title":"Processing Payment Amount",
            "type":"number",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IncentiveTypeCode":{
            "title":"Payment Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "default":"MANUAL_PAY_ADJ",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PayrunName":{
            "title":"Payment Batch",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the payment batch to which the payment transaction belongs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningId":{
            "title":"Earnings",
            "type":"integer",
            "description":"The unique identifier of the earning record. An earning is the calculated incentive amount based on the participant plan component and source transaction credit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the payment transaction record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommAmountCalculationCurrency":{
            "title":"Earning Amount",
            "type":"number",
            "description":"The calculated earning amount in the processing currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the payment transaction record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EligibleCatId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RecoverableFlag":{
            "title":"Recoverable",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "SrpPlanAssignId":{
            "type":"integer",
            "description":"The unique identifier of the assignment of the compensation plan to the participant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PaymentTransactionDeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether certain standard actions are not applicable. You cannot use the DELETE standard action for payment transactions generated by the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PayAmountFuncCurrency":{
            "title":"Operating Payment Amount",
            "type":"number",
            "description":"The payment transaction amount in the operating currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayrunId":{
            "type":"integer",
            "description":"The unique identifier of the payment batch to which this payment transaction belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceEventDate":{
            "title":"Event Date",
            "type":"string",
            "description":"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.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningFactor":{
            "title":"Earning Factor",
            "type":"number",
            "description":"The uplift percentage for the increase in earnings over a period of time that was used in the earning calculation expression.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningType":{
            "title":"Earning Type",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryWorkerNumber":{
            "title":"Worker Number",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the participant incentive compensation plan component used to calculate the participant earning amount.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "dependencies":[
                    "CreditedParticipantId",
                    "PayrunId"
                ]
            },
            "x-queryable":true
        },
        "ManualAdjustmentReasonCode":{
            "title":"Reason",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PayCurrencyCode":{
            "title":"Currency",
            "maxLength":"20",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceTrxNumber":{
            "title":"Transaction Number",
            "maxLength":"30",
            "type":"string",
            "description":"The transaction number which resulted in the participant incentive earning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayAmountHomeCurrency":{
            "title":"Home Payment Amount",
            "type":"number",
            "description":"The payment transaction amount in the participant home currency.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditedParticipantId":{
            "title":"Credit Receiver",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceEarningId":{
            "type":"integer",
            "description":"The unique identifier of the source earning from which this earning originated.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreditFactor":{
            "title":"Credit Factor",
            "type":"number",
            "description":"The uplift percentage for the increase in credit amounts over a period of time that was used in the earning calculation expression.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentTransactionUpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether certain standard actions are not applicable. You 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CommissionValue":{
            "title":"Earning Rate",
            "type":"number",
            "description":"The incentive rate table amount or rate that was used to calculate the earning amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldFlag":{
            "title":"Payment Hold",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the payment transaction was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated By",
            "maxLength":"32",
            "type":"string",
            "description":"The session login associated to the user who last updated the payment transaction record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayPeriodId":{
            "title":"Period",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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."
        }
    }
}

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

CnLookupManualAdjustmentReasonCodeVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_CN_PAYSHEET_MANUAL_ADJ

The list of values for the manual adjustment reason.

The following properties are defined on the LOV link relation:

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

ParticipantPlanComponentsVO

Operation: /fscmRestApi/resources/11.13.18.05/paybatchParticipantPlanComponentsLOV

Parameters:

• finder: PlanComponentFinder%3Bb_participant_id%3D{CreditedParticipantId}%2Cb_payrun_id%3D{PayrunId}

The list of values containing the plan component names and unique identifiers.

The following properties are defined on the LOV link relation:

• Source Attribute: PlanComponentId; Target Attribute: PlanComponentId
• Display Attribute: PlanComponentId, PlanComponentName, PayrunId, ParticipantId

Back to Top

Examples

The following example shows how to create a payment transaction by submitting a POST request on the REST resource using cURL.

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com//fscmRestApi/resources/11.13.18.05/paymentTransactions

Example of Request Body

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

{
"AdjustComments" :"LN1",
"ManualAdjustmentReasonCode" :"ORA_DISCRETIONARY_DRAW",
"PlanComponentId" :300100003303012,
"PayAmountPayCurrency" :111,
"PayrunId": 300100014485210,
"RecoverableFlag" :"Y"
}

Example of Response Body

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

{
    "items": [
        {
            "AdjustComments": null,
            "ParticipantPayId": 6118,
            "CommAmountCalculationCurrency": 3200,
            "CreatedBy": "27AB6EB0D7709DCAB38FB2F43B7785DE",
            "CreationDate": "2012-12-24T07:00:55+00:00",
            "CommissionValue": 4000,
            "CreditTypeId": -1000,
            "CreditedParticipantId": 12001,
            "EarningId": 47041,
            "HoldFlag": null,
            "HomeCurrencyCode": "USD",
            "IncentiveTypeCode": "COMMISSION",
            "LastUpdateDate": "2012-12-24T07:02:57+00:00",
            "LastUpdateLogin": "D19A1F1889A55198E0432720F00AE307",
            "LastUpdatedBy": "OIC_MGR_OPERATIONS",
            "ObjectStatus": "PAID",
            "OrgId": 204,
            "PayAmountFuncCurrency": 3200,
            "PayAmountHomeCurrency": 3200,
            "PayAmountPayCurrency": 3200,
            "PayCurrencyCode": "USD",
            "PayPeriodId": 2009001,
            "PayrunId": 300100014485210,
            "PlanComponentId": 300100014486100,
            "RecoverableFlag": false,
            "SourceEventDate": "2009-01-10",
            "SourceTrxNumber": null,
            "SrpPlanAssignId": 33006,
            "SourceEarningId": null,
            "CreditFactor": null,
            "EarningFactor": null,
            "EarningType": "BASE",
            "EligibleCatId": 300100014485986,
            "EarningHId": 13021,
            "PayrunName": "CN Pay BatchJan09_20121224131422",
            "ParticipantName": "IC_PARTY_20121224131422",
            "ParticipantId": 12001,
            "PersonNumber": null,
            "PrimaryWorkerNumber": null,
            "ManualAdjustmentReasonCode": null,
            "PaymentTransactionUpdateFlag": false,
            "PaymentTransactionDeleteFlag": false,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentTransactions/6118",
                    "name": "paymentTransactions",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentTransactions/6118",
                    "name": "paymentTransactions",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentTransactions/6118/lov/ParticipantPlanComponentsVO",
                    "name": "ParticipantPlanComponentsVO",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentTransactions/6118/lov/BusinessUnitPVO",
                    "name": "BusinessUnitPVO",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentTransactions/6118/lov/CnLookupManualAdjustmentReasonCodeVO",
                    "name": "CnLookupManualAdjustmentReasonCodeVO",
                    "kind": "collection"
                }
            ]
        },
        {
            "AdjustComments": null,
            "ParticipantPayId": 6119,
            "CommAmountCalculationCurrency": 3200,
            "CreatedBy": "27AB6EB0D7709DCAB38FB2F43B7785DE",
            "CreationDate": "2012-12-24T07:00:55+00:00",
            "CommissionValue": 4000,
            "CreditTypeId": -1000,
            "CreditedParticipantId": 12001,
            "EarningId": 47042,
            "HoldFlag": null,
            "HomeCurrencyCode": "USD",
            "IncentiveTypeCode": "COMMISSION",
            "LastUpdateDate": "2012-12-24T07:02:57+00:00",
            "LastUpdateLogin": "D19A1F1889A55198E0432720F00AE307",
            "LastUpdatedBy": "OIC_MGR_OPERATIONS",
            "ObjectStatus": "PAID",
            "OrgId": 204,
            "PayAmountFuncCurrency": 3200,
            "PayAmountHomeCurrency": 3200,
            "PayAmountPayCurrency": 3200,
            "PayCurrencyCode": "USD",
            "PayPeriodId": 2009001,
            "PayrunId": 300100014485210,
            "PlanComponentId": 300100014486100,
            "RecoverableFlag": false,
            "SourceEventDate": "2009-01-10",
            "SourceTrxNumber": null,
            "SrpPlanAssignId": 33006,
            "SourceEarningId": null,
            "CreditFactor": null,
            "EarningFactor": null,
            "EarningType": "BASE",
            "EligibleCatId": 300100014485986,
            "EarningHId": 13016,
            "PayrunName": "CN Pay BatchJan09_20121224131422",
            "ParticipantName": "IC_PARTY_20121224131422",
            "ParticipantId": 12001,
            "PersonNumber": null,
            "PrimaryWorkerNumber": null,
            "ManualAdjustmentReasonCode": null,
            "PaymentTransactionUpdateFlag": false,
            "PaymentTransactionDeleteFlag": false,
            "links": [
...
}

Back to Top