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

Get all payment transactions

get

/fscmRestApi/resources/11.13.18.05/paymentTransactions

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • ManualAdjustments: Finds payment transactions of the type manual adjustment.
      Finder Variables:
      • PrimaryKey: Finds a payment transaction with the specified primary key.
        Finder Variables:
        • ParticipantPayId; integer; The unique identifier of the payment transaction.
    • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
    • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

      Example:
      self,canonical
    • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
    • The resource item payload will be filtered in order to contain only data (no links section, for example).
    • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
    • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

      Format: ?q=expression1;expression2

      You can use these queryable attributes to filter this collection resource using the q query parameter:
      • AdjustComments; string; Commentary entered when adjusting the payment transaction amount.
      • CommAmountCalculationCurrency; number; The calculated earning amount in the processing currency.
      • CommissionValue; number; The incentive rate table amount or rate that was used to calculate the earning amount.
      • CreatedBy; string; The user who created the payment transaction record.
      • CreationDate; string; The date when the payment transaction was created.
      • CreditFactor; number; The uplift percentage for the increase in credit amounts over a period of time that was used in the earning calculation expression.
      • CreditTypeId; integer; 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.
      • CreditedParticipantId; integer; 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.
      • EarningFactor; number; The uplift percentage for the increase in earnings over a period of time that was used in the earning calculation expression.
      • EarningHId; integer; The unique identifier of the earning history record. The changes to the earning record are stored in the earning history table.
      • EarningId; integer; 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; 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; 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; 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; 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; 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; The date when the payment transaction was last updated.
      • LastUpdateLogin; string; The session login associated to the user who last updated the payment transaction record.
      • LastUpdatedBy; string; The user who last updated the payment transaction record.
      • ManualAdjustmentReasonCode; string; 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; The status of the payment transaction. The valid values are UNPAID and PAID.
      • OrgId; integer; 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; 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; The name of the incentive compensation participant for whom the payment transaction amount is due or recoverable.
      • ParticipantPayId; integer; The unique identifier of the payment transaction.
      • PayAmountFuncCurrency; number; The payment transaction amount in the operating currency.
      • PayAmountHomeCurrency; number; The payment transaction amount in the participant home currency.
      • PayAmountPayCurrency; number; 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; 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.
      • PayPeriodId; integer; 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; The unique identifier of the payment batch to which this payment transaction belongs.
      • PayrunName; string; The name of the payment batch to which the payment transaction belongs.
      • PersonNumber; string; 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; The unique identifier of the participant incentive compensation plan component used to calculate the participant earning amount.
      • PrimaryWorkerNumber; string; 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; 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; The unique identifier of the source earning from which this earning originated.
      • SourceEventDate; string; 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; The transaction number which resulted in the participant incentive earning.
      • SrpPlanAssignId; integer; The unique identifier of the assignment of the compensation plan to the participant.
    • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
    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.

    There's no request body for this operation.

    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 : paymentTransactions
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : 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
      Indicates whether certain standard actions are not applicable. You cannot use the DELETE standard action for payment transactions generated by the application.
    • 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.
    • 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.
    Back to Top

    Examples

    The following example shows how to get all payment transactions by submitting a get request on the REST resource using cURL.

    Example of Response Body

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

    {
  "items": [
    {
      "AdjustComments": null,
      "ParticipantPayId": 6122,
      "CommAmountCalculationCurrency": 3000,
      "CreatedBy": "27AB6EB0D7709DCAB38FB2F43B7785DE",
      "CreationDate": "2016-02-02 23:29:26.0",
      "CommissionValue": 4000,
      "CreditTypeId": -1000,
      "CreditedParticipantId": 13001,
      "EarningId": 48041,
      "HoldFlag": null,
      "HomeCurrencyCode": "USD",
      "IncentiveTypeCode": "COMMISSION",
      "LastUpdateDate": "2016-02-02 23:31:20.0",
      "LastUpdateLogin": "27AB6EB0D7709DCAB38FB2F43B7785DE",
      "LastUpdatedBy": "27AB6EB0D7709DCAB38FB2F43B7785DE",
      "ObjectStatus": "PAID",
      "OrgId": 204,
      "PayAmountFuncCurrency": 3000,
      "PayAmountHomeCurrency": 3000,
      "PayAmountPayCurrency": 3000,
      "PayCurrencyCode": "USD",
      "PayPeriodId": 2016001,
      "PayrunId": 300100016600360,
      "PlanComponentId": 300100016600146,
      "RecoverableFlag": false,
      "SourceEventDate": "2016-01-10",
      "SourceTrxNumber": null,
      "SrpPlanAssignId": 35006,
      "SourceEarningId": null,
      "CreditFactor": null,
      "EarningFactor": null,
      "EarningType": "BASE",
      "EligibleCatId": 300100016352701,
      "EarningHId": 14029,
      "PayrunName": "January Sales Manager Payments",
      "ParticipantName": "Williams,Gracie",
      "ParticipantId": 13001,
      "PersonNumber": "955160008173573",
      "PrimaryWorkerNumber": null,
      "links": [
        {
          "rel": "self",
          "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentTransactions/6122",
          "name": "paymentTransactions",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentTransactions/6122",
          "name": "paymentTransactions",
          "kind": "item"
        }
      ]
    },
    {
     ...
    }
  ],
  "count": 25,
  "hasMore": true,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentTransactions",
      "name": "paymentTransactions",
      "kind": "collection"
    }
  ]
}
    Back to Top