1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Calculation Simulations
  4. Simulation Transactions

Get all simulation transactions

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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:

    • PrimaryKey: Finds a simulation transaction with the specified primary key.
      Finder Variables:
      • SimulationId; integer; The unique identifier of the calculation simulation.
      • TransactionId; integer; The unique identifier of the simulation transaction.
    • TransactionIdFinder: Finds a simulation transaction with the specified simulation transaction identifier.
      Finder Variables:
      • TransactionId; integer; The unique identifier of the simulation 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:
    • AdjustmentComments; string; The comments explaining the adjustment to a transaction.
    • AdjustmentStatus; string; The lookup code that indicates the adjustment state of the transaction. Review the available lookup codes for the lookup type CN_TP_BASETRANS_ADJ_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
    • BookedDate; string; The date when the sales order was booked in the order management application.
    • ChangedTrxFlag; boolean; Indicates whether the transaction is a new transaction or a modified transaction.
    • ClsfnRuleId; integer; The unique identifier of the classification rule used to assign the credit category to the transaction.
    • CollectionStatus; string; The lookup code that indicates the reason for a collection error. Review the available lookup codes for the lookup type CN_TP_BASETRANS_COLL_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
    • ConversionRate; number; The exchange rate to convert from source system currency to operating currency.
    • CreatedBy; string; The user who created the record.
    • CreationDate; string; The date when the record was created.
    • CreditDate; string; The date when the credit receiver should receive the credit. The date is used to determine the credit receivers when processing the credit rules against transactions.
    • DirectParticipantId; integer; The unique identifier of the participant who is directly involved in the closure of the transaction.
    • DiscountPercentage; number; The percentage of the transaction amount that depicts the net amount to be paid by the buyer.
    • EligibleCatId; integer; The unique identifier of the credit category that is used when overriding the classification process. The credit category is a user-defined business category used to classify a transaction for compensation purposes.
    • ErrorCode; string; The code indicating the reason a transaction is in error status. Review the available lookup codes for the lookup type ORA_CN_PROCESS_ERR_REASON LOOKUP_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
    • ErrorMeaning; string; The reason explaining why the credit is in error status.
    • EventDate; string; The date when the incentive event occurs. The event date is used to determine the effective currency conversion rate when the participant's home currency is used as the processing currency. The date must be within a defined Incentive Compensation calendar period where the period has an Open status and the calendar is defined for the same business unit as the transaction's business unit. If the value does not meet these requirements, the transaction process status is updated to Error.
    • HoldFlag; boolean; Indicates whether the application must exclude the transaction from further processing. The transaction will not be further processed if this flag is set to Y.
    • InvoiceDate; string; The date when the invoice for the transaction was generated in the source application.
    • InvoiceNumber; string; The unique identifier of the invoice associated with the transaction.
    • LastUpdateDate; string; The date when the record was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the record.
    • LastUpdatedBy; string; The user who last updated the record.
    • MarginPercentage; number; The percentage of the transaction amount that depicts the profit of the sale.
    • ObjectStatus; string; The lookup code that indicates the current state of the transaction, such as New, Obsolete, or Collection Error. Review the available lookup codes for the lookup type CN_TP_BASETRANS_OBJECT_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
    • OrderNumber; string; The sales order number in the source application associated with the transaction.
    • PreserveCreditFlag; boolean; Indicates whether any of the manually created or adjusted credits for the transaction are not to be modified by the credit process.
    • ProcessCode; string; The process code is a five letter code that indicates the combination of Override Classification, Preserve Credits, Do Not Roll Up, and Do Not Calculate values for the transaction. For example, the default value of the process code CCREC indicates that the Override Classification, Preserve Credits, and Do Not Roll Up check boxes are not checked and the normal calculation processing will occur. The first letter determines the Override Classification setting. Valid values are N and C. Enter a code starting with N to check the Override Classification checkbox. You must also provide a credit category to avoid the collection error status. For regular classification processing, enter a code starting with C. The second letter determines the Preserve Credits setting. Valid values are N and C. Enter a code with N as the second letter to check the Preserve Credits checkbox. For regular credit processing, enter C. The third letter determines the Do Not Rollup setting. Valid values are N and R. Enter a code with N as the third letter to check the Do Not Rollup checkbox. To allow rollup credit processing, enter R. The last two letters indicate earnings edibility and calculation. Valid values are EC, EN,NN, and NC. Enter a code with the value of N in either or both of the fourth and fifth position to exclude the credit from calculation. For regular calculation processing, enter EC.
    • ReasonCode; string; The code indicating the reason for adjusting a transaction. You can view the CN_TP_ADJUSTMENT_REASON lookup from the Setup and Maintenance, Manage Incentive Compensation Lookups task.
    • RoleId; integer; The unique identifier of the compensation role assigned to the direct participant.
    • RollupDate; string; The date used to determine the roll up credit receivers when processing the roll up rules against transactions.
    • SimulationDeleteFlag; boolean; Indicates whether a transaction is deleted during calculation simulation processing.
    • SimulationId; integer; The unique identifier of the simulation to which this simulation transaction belongs.
    • SourceCurrencyCode; string; The currency code that indicates the currency of the monetary transaction amount in the source application.
    • SourceEventPeriodId; integer; The unique identifier of the period to which the source event belongs.
    • SourceOrgId; integer; The unique identifier of the source transaction business unit record.
    • SourceTrxId; integer; The unique identifier of the transaction in the source application.
    • SourceTrxLineId; integer; The unique identifier of the transaction line in the source application.
    • SourceTrxSalesLineId; integer; The unique identifier of the transaction credit in the source application.
    • TerrId; integer; The unique identifier of the territory to which the transaction belongs.
    • TerrName; string; The name of the territory to which the transaction belongs.
    • TransactionAmountFunc; number; The transaction amount in operating currency.
    • TransactionAmountSource; number; The transaction amount in source currency.
    • TransactionId; integer; The unique identifier of the transaction in a calculation simulation.
    • TransactionNumber; string; The alternate key identifier of the transaction. The users can use this attribute to search for an invoice number or an order number. If adjusting a transaction, the combination of the business unit, transaction number, and the transaction type uniquely identify an existing transaction.
    • TransactionQuantity; number; The quantity of the transaction line item.
    • TransactionType; string; The type of the transaction indicating the source of the transaction, such as order, invoice, or credit memo. Review the available lookup codes for the lookup type CN_TP_TRANSACTION_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
    • UOMCode; string; The code indicating the unit of measure for the transaction line item. Review the available lookup codes for the lookup type ORA_CN_TP_TRANSACTION_UOM using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
    • WorkerId; integer; The batch number assigned to the transaction. This is applicable if the batch processing in the system parameters page is set to "Use batch information provided at the transaction level".
  • 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 : incentiveCompensationCalculationSimulations-Transactions
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : incentiveCompensationCalculationSimulations-Transactions-item-response
Type: object
Show Source
  • Maximum Length: 1000
    The comments explaining the adjustment to a transaction.
  • Read Only: true
    Maximum Length: 30
    The lookup code that indicates the adjustment state of the transaction. Review the available lookup codes for the lookup type CN_TP_BASETRANS_ADJ_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • The date when the sales order was booked in the order management application.
  • Maximum Length: 1
    Indicates whether the transaction is a new transaction or a modified transaction.
  • The unique identifier of the classification rule used to assign the credit category to the transaction.
  • Read Only: true
    Maximum Length: 30
    The lookup code that indicates the reason for a collection error. Review the available lookup codes for the lookup type CN_TP_BASETRANS_COLL_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • Read Only: true
    The exchange rate to convert from source system currency to operating currency.
  • Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Read Only: true
    The date when the record was created.
  • The date when the credit receiver should receive the credit. The date is used to determine the credit receivers when processing the credit rules against transactions.
  • Simulation Credits
    Title: Simulation Credits
    The simulation credits resource to is used to view, create, update, and delete credits of a calculation simulation.
  • The unique identifier of the participant who is directly involved in the closure of the transaction.
  • The percentage of the transaction amount that depicts the net amount to be paid by the buyer.
  • The unique identifier of the credit category that is used when overriding the classification process. The credit category is a user-defined business category used to classify a transaction for compensation purposes.
  • Maximum Length: 30
    The code indicating the reason a transaction is in error status. Review the available lookup codes for the lookup type ORA_CN_PROCESS_ERR_REASON LOOKUP_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • Read Only: true
    Maximum Length: 80
    The reason explaining why the credit is in error status.
  • The date when the incentive event occurs. The event date is used to determine the effective currency conversion rate when the participant's home currency is used as the processing currency. The date must be within a defined Incentive Compensation calendar period where the period has an Open status and the calendar is defined for the same business unit as the transaction's business unit. If the value does not meet these requirements, the transaction process status is updated to Error.
  • Maximum Length: 1
    Indicates whether the application must exclude the transaction from further processing. The transaction will not be further processed if this flag is set to Y.
  • The date when the invoice for the transaction was generated in the source application.
  • Maximum Length: 30
    The unique identifier of the invoice associated with the transaction.
  • Read Only: true
    The date when the record was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • The percentage of the transaction amount that depicts the profit of the sale.
  • Maximum Length: 30
    The lookup code that indicates the current state of the transaction, such as New, Obsolete, or Collection Error. Review the available lookup codes for the lookup type CN_TP_BASETRANS_OBJECT_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • Maximum Length: 30
    The sales order number in the source application associated with the transaction.
  • Maximum Length: 1
    Indicates whether any of the manually created or adjusted credits for the transaction are not to be modified by the credit process.
  • Maximum Length: 30
    The process code is a five letter code that indicates the combination of Override Classification, Preserve Credits, Do Not Roll Up, and Do Not Calculate values for the transaction. For example, the default value of the process code CCREC indicates that the Override Classification, Preserve Credits, and Do Not Roll Up check boxes are not checked and the normal calculation processing will occur. The first letter determines the Override Classification setting. Valid values are N and C. Enter a code starting with N to check the Override Classification checkbox. You must also provide a credit category to avoid the collection error status. For regular classification processing, enter a code starting with C. The second letter determines the Preserve Credits setting. Valid values are N and C. Enter a code with N as the second letter to check the Preserve Credits checkbox. For regular credit processing, enter C. The third letter determines the Do Not Rollup setting. Valid values are N and R. Enter a code with N as the third letter to check the Do Not Rollup checkbox. To allow rollup credit processing, enter R. The last two letters indicate earnings edibility and calculation. Valid values are EC, EN,NN, and NC. Enter a code with the value of N in either or both of the fourth and fifth position to exclude the credit from calculation. For regular calculation processing, enter EC.
  • Maximum Length: 30
    The code indicating the reason for adjusting a transaction. You can view the CN_TP_ADJUSTMENT_REASON lookup from the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • The unique identifier of the compensation role assigned to the direct participant.
  • The date used to determine the roll up credit receivers when processing the roll up rules against transactions.
  • Maximum Length: 1
    Default Value: false
    Indicates whether a transaction is deleted during calculation simulation processing.
  • The unique identifier of the simulation to which this simulation transaction belongs.
  • Simulation Transaction Descriptive Flex Fields
    Title: Simulation Transaction Descriptive Flex Fields
    The simulation transaction descriptive flex fields resource is used to view and create additional attributes of the transaction that are used during the simulation.
  • Maximum Length: 15
    The currency code that indicates the currency of the monetary transaction amount in the source application.
  • Read Only: true
    The unique identifier of the period to which the source event belongs.
  • The unique identifier of the source transaction business unit record.
  • The unique identifier of the transaction in the source application.
  • The unique identifier of the transaction line in the source application.
  • The unique identifier of the transaction credit in the source application.
  • The unique identifier of the territory to which the transaction belongs.
  • Maximum Length: 1000
    The name of the territory to which the transaction belongs.
  • Read Only: true
    The transaction amount in operating currency.
  • The transaction amount in source currency.
  • The unique identifier of the transaction in a calculation simulation.
  • Maximum Length: 30
    The alternate key identifier of the transaction. The users can use this attribute to search for an invoice number or an order number. If adjusting a transaction, the combination of the business unit, transaction number, and the transaction type uniquely identify an existing transaction.
  • The quantity of the transaction line item.
  • Maximum Length: 30
    The type of the transaction indicating the source of the transaction, such as order, invoice, or credit memo. Review the available lookup codes for the lookup type CN_TP_TRANSACTION_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • Maximum Length: 10
    The code indicating the unit of measure for the transaction line item. Review the available lookup codes for the lookup type ORA_CN_TP_TRANSACTION_UOM using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • The batch number assigned to the transaction. This is applicable if the batch processing in the system parameters page is set to "Use batch information provided at the transaction level".
Nested Schema : Simulation Credits
Type: array
Title: Simulation Credits
The simulation credits resource to is used to view, create, update, and delete credits of a calculation simulation.
Show Source
Nested Schema : Simulation Transaction Descriptive Flex Fields
Type: array
Title: Simulation Transaction Descriptive Flex Fields
The simulation transaction descriptive flex fields resource is used to view and create additional attributes of the transaction that are used during the simulation.
Show Source
Nested Schema : incentiveCompensationCalculationSimulations-Transactions-Credits-item-response
Type: object
Show Source
  • Maximum Length: 1000
    The comments explaining why the credit was adjusted.
  • Maximum Length: 30
    The status indicating the adjustment state of the credit. Review the available lookup codes for the lookup type CN_TP_CREDIT_ADJ_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • The exchange rate to convert from source currency to processing currency.
  • Maximum Length: 15
    The code indicating the processing currency for the credit amount. 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
    Maximum Length: 1
    Indicates if the credit is new or modified.
  • The unique identifier of the classification rule used to assign the credit category, to the credit.
  • Maximum Length: 30
    The lookup code that indicates the reason for a collection error. Review the available lookup codes for the lookup type CN_TP_CREDIT_COLL_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • Read Only: true
    Maximum Length: 64
    The user who created the record.
  • Read Only: true
    Maximum Length: 30
    Default Value: SIMULATION
    The lookup code indicating when this credit record was created. A list of valid values is stored in the lookup CN_TP_CREDIT_CREATED_DURING. Review the available lookup codes using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • Read Only: true
    The date when the record was created.
  • The credit amount in processing currency.
  • The unique identifier of the credit category that is used when overriding the classification process. The credit category is a user-defined business category used to classify a credit for compensation purposes.
  • The date when the credit receiver should receive the credit. The date is used to determine the credit receivers when processing the credit rules against transactions.
  • The unique identifier of the participant who owns the credit.
  • Read Only: true
    The unique identifier of the credit.
  • The unique identifier of the credit rule used to create the credit.
  • Maximum Length: 30
    Default Value: DIRECT
    Indicates the nature of the credit such as Direct, Indirect, or Summarized.
  • The unique identifier of the participant who is directly involved in the closure of the transaction.
  • The unique identifier of the credit rule used to create the direct credit that corresponds to this credit.
  • Read Only: true
    Maximum Length: 30
    The code indicating the reason the credit is in error status. Review the available lookup codes for the lookup type ORA_CN_PROCESS_ERR_REASON LOOKUP_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • Read Only: true
    Maximum Length: 80
    The display label explaining why the credit is in error status.
  • Read Only: true
    The date when the incentive event occurs. The event date is used to determine the effective currency conversion rate when the participant's home currency is used as the processing currency.
  • Maximum Length: 1
    Indicates whether the application must exclude the transaction from further processing.
  • The exchange rate to convert from processing currency to home currency.
  • The transaction amount in participant's home currency.
  • Maximum Length: 15
    The code indicating the participant's home currency.
  • Read Only: true
    The date when the record was last updated.
  • Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Maximum Length: 30
    The status of the credit, such as Credited, Obsolete, or Rolled up. Review the available lookup codes for the lookup type CN_TP_CREDIT_OBJECT_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • The exchange rate to convert from source currency to operating currency.
  • The credit amount in business unit operating currency.
  • Title: Operating Currency
    Read Only: true
    Maximum Length: 10
    The code indicating the functional currency of the business unit.
  • Read Only: true
    Maximum Length: 30
    Default Value: CNNEC
    The five letter code indicating the combination of Override Classification, Preserve Credits, Do Not Roll Up, and Do Not Calculate values for the transaction.
  • Read Only: true
    Maximum Length: 30
    The code indicating the reason for adjusting a credit. You can view the CN_TP_ADJUSTMENT_REASON lookup from the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • Maximum Length: 30
    The type of the credit, such as revenue or non-revenue. Review the available lookup codes for the lookup type CN_RS_REVENUE_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
  • The unique identifier of the role assigned to the credit receiver.
  • The date used to determine the roll up credit receivers when processing the roll up rules against transactions.
  • The level of the rollup rule in the rollup hierarchy. This value is applicable in case of rollup credits.
  • Maximum Length: 1
    Default Value: false
    Indicates whether a credit is deleted during calculation simulation processing.
  • The identifier of the simulation to which this simulation credit belongs.
  • The unique identifier of the source transaction business unit.
  • The credit amount in source currency of the transaction.
  • The unique identifier of the source credit or the summarized credit record from which the rollup credit is generated.
  • Maximum Length: 15
    The currency code that represents the currency of the monetary transaction amount in the source application.
  • The transaction amount in source currency of the transaction.
  • Default Value: 100
    The percent of the transaction amount that the credit receiver received.
  • The unique identifier of the summary credit to which the credit is associated.
  • The transaction amount in processing currency.
  • Read Only: true
    The unique identifier of the transaction.
  • Read Only: true
    Maximum Length: 30
    The alternate key identifier of the transaction that users can recognize and search with, for example, an invoice number or order number.
  • The quantity for the transaction line item.
  • Read Only: true
    Maximum Length: 30
    The type of the transaction indicating the source of the transaction, such as order, invoice, or credit memo. Review the available lookup codes for the lookup type CN_TP_TRANSACTION_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
Nested Schema : incentiveCompensationCalculationSimulations-Transactions-SimulationTransactionDFF-item-response
Type: object
Show Source
Back to Top