Jump to

• Request
• Response

Create a simulation transaction

post

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

Request

Path Parameters

• SimulationId(required): integer(int64)
  The unique identifier of the calculation simulation.

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

• AdjustmentComments: string
  Maximum Length: 1000

  The comments explaining the adjustment to a transaction.
• BookedDate: string (date-time)
  The date when the sales order was booked in the order management application.
• ChangedTrxFlag: boolean
  Maximum Length: 1

  Indicates whether the transaction is a new transaction or a modified transaction.
• ClsfnRuleId: integer (int64)
  The unique identifier of the classification rule used to assign the credit category to the transaction.
• CreditDate: string (date-time)
  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.
• Credits: array Simulation Credits
  Title: Simulation Credits

  The simulation credits resource to is used to view, create, update, and delete credits of a calculation simulation.
• DirectParticipantId: integer (int64)
  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 (int64)
  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
  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.
• EventDate(required): string (date-time)
  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
  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.
• InvoiceDate: string (date-time)
  The date when the invoice for the transaction was generated in the source application.
• InvoiceNumber: string
  Maximum Length: 30

  The unique identifier of the invoice associated with the transaction.
• MarginPercentage: number
  The percentage of the transaction amount that depicts the profit of the sale.
• ObjectStatus: string
  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.
• OrderNumber: string
  Maximum Length: 30

  The sales order number in the source application associated with the transaction.
• PreserveCreditFlag: boolean
  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.
• ProcessCode: string
  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.
• ReasonCode: string
  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.
• RoleId: integer (int64)
  The unique identifier of the compensation role assigned to the direct participant.
• RollupDate: string (date-time)
  The date used to determine the roll up credit receivers when processing the roll up rules against transactions.
• SimulationDeleteFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether a transaction is deleted during calculation simulation processing.
• SimulationId(required): integer (int64)
  The unique identifier of the simulation to which this simulation transaction belongs.
• SimulationTransactionDFF: array 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.
• SourceCurrencyCode: string
  Maximum Length: 15

  The currency code that indicates the currency of the monetary transaction amount in the source application.
• SourceOrgId: integer (int64)
  The unique identifier of the source transaction business unit record.
• SourceTrxId: integer (int64)
  The unique identifier of the transaction in the source application.
• SourceTrxLineId: integer (int64)
  The unique identifier of the transaction line in the source application.
• SourceTrxSalesLineId: integer (int64)
  The unique identifier of the transaction credit in the source application.
• TerrId: integer (int64)
  The unique identifier of the territory to which the transaction belongs.
• TerrName: string
  Maximum Length: 1000

  The name of the territory to which the transaction belongs.
• TransactionAmountSource(required): number
  The transaction amount in source currency.
• TransactionId: integer (int64)
  The unique identifier of the transaction in a calculation simulation.
• TransactionNumber(required): string
  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.
• TransactionQuantity: number
  The quantity of the transaction line item.
• TransactionType(required): string
  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.
• UOMCode: string
  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.
• WorkerId: integer (int64)
  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".

{
    "required":[
        "EventDate",
        "SimulationId",
        "TransactionAmountSource",
        "TransactionNumber",
        "TransactionType"
    ],
    "type":"object",
    "properties":{
        "CreditDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true
        },
        "SourceCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code that indicates the currency of the monetary transaction amount in the source application.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TransactionType":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false
        },
        "EventDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":false
        },
        "TransactionNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false
        },
        "RollupDate":{
            "type":"string",
            "description":"The date used to determine the roll up credit receivers when processing the roll up rules against transactions.",
            "format":"date-time",
            "nullable":true
        },
        "BookedDate":{
            "type":"string",
            "description":"The date when the sales order was booked in the order management application.",
            "format":"date-time",
            "nullable":true
        },
        "SourceTrxLineId":{
            "type":"integer",
            "description":"The unique identifier of the transaction line in the source application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "OrderNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The sales order number in the source application associated with the transaction.",
            "nullable":true
        },
        "ObjectStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceTrxSalesLineId":{
            "type":"integer",
            "description":"The unique identifier of the transaction credit in the source application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "TransactionQuantity":{
            "type":"number",
            "description":"The quantity of the transaction line item.",
            "nullable":true
        },
        "AdjustmentComments":{
            "maxLength":"1000",
            "type":"string",
            "description":"The comments explaining the adjustment to a transaction.",
            "nullable":true
        },
        "TerrId":{
            "type":"integer",
            "description":"The unique identifier of the territory to which the transaction belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "TerrName":{
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the territory to which the transaction belongs.",
            "nullable":true
        },
        "InvoiceNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the invoice associated with the transaction.",
            "nullable":true
        },
        "InvoiceDate":{
            "type":"string",
            "description":"The date when the invoice for the transaction was generated in the source application.",
            "format":"date-time",
            "nullable":true
        },
        "UOMCode":{
            "maxLength":"10",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceOrgId":{
            "type":"integer",
            "description":"The unique identifier of the source transaction business unit record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "EligibleCatId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "ClsfnRuleId":{
            "type":"integer",
            "description":"The unique identifier of the classification rule used to assign the credit category to the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "DirectParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant who is directly involved in the closure of the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PreserveCreditFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether any of the manually created or adjusted credits for the transaction are not to be modified by the credit process.",
            "nullable":true
        },
        "ProcessCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "WorkerId":{
            "type":"integer",
            "description":"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\".",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier of the compensation role assigned to the direct participant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "TransactionId":{
            "type":"integer",
            "description":"The unique identifier of the transaction in a calculation simulation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Credits":{
            "title":"Simulation Credits",
            "type":"array",
            "description":"The simulation credits resource to is used to view, create, update, and delete credits of a calculation simulation.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationCalculationSimulations-Transactions-Credits-item-post-request"
            }
        },
        "TransactionAmountSource":{
            "type":"number",
            "description":"The transaction amount in source currency.",
            "nullable":false
        },
        "DiscountPercentage":{
            "type":"number",
            "description":"The percentage of the transaction amount that depicts the net amount to be paid by the buyer.",
            "nullable":true
        },
        "SimulationDeleteFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a transaction is deleted during calculation simulation processing.",
            "nullable":false,
            "default":false
        },
        "MarginPercentage":{
            "type":"number",
            "description":"The percentage of the transaction amount that depicts the profit of the sale.",
            "nullable":true
        },
        "SourceTrxId":{
            "type":"integer",
            "description":"The unique identifier of the transaction in the source application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SimulationId":{
            "type":"integer",
            "description":"The unique identifier of the simulation to which this simulation transaction belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SimulationTransactionDFF":{
            "title":"Simulation Transaction Descriptive Flex Fields",
            "type":"array",
            "description":"The simulation transaction descriptive flex fields resource is used to view and create additional attributes of the transaction that are used during the simulation.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationCalculationSimulations-Transactions-SimulationTransactionDFF-item-post-request"
            },
            "x-cardinality":"1"
        },
        "ErrorCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "HoldFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true
        },
        "ChangedTrxFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the transaction is a new transaction or a modified transaction.",
            "nullable":true
        }
    }
}

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

• Array of: object schema

{
    "title":"Simulation Credits",
    "type":"array",
    "description":"The simulation credits resource to is used to view, create, update, and delete credits of a calculation simulation.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationCalculationSimulations-Transactions-Credits-item-post-request"
    }
}

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

• Array of: object schema

{
    "title":"Simulation Transaction Descriptive Flex Fields",
    "type":"array",
    "description":"The simulation transaction descriptive flex fields resource is used to view and create additional attributes of the transaction that are used during the simulation.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationCalculationSimulations-Transactions-SimulationTransactionDFF-item-post-request"
    },
    "x-cardinality":"1"
}

Nested Schema : schema

Type: object

Show Source

• AdjustmentComments: string
  Maximum Length: 1000

  The comments explaining why the credit was adjusted.
• AdjustmentStatus: string
  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.
• CalculationConversionRate: number
  The exchange rate to convert from source currency to processing currency.
• CalculationCurrencyCode: string
  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.
• ClsfnRuleId: integer (int64)
  The unique identifier of the classification rule used to assign the credit category, to the credit.
• CollectionStatus: string
  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.
• CreditAmount: number
  The credit amount in processing currency.
• CreditCategoryId: integer (int64)
  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.
• CreditDate: string (date-time)
  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.
• CreditedParticipantId: integer (int64)
  The unique identifier of the participant who owns the credit.
• CreditRuleId: integer (int64)
  The unique identifier of the credit rule used to create the credit.
• CreditType: string
  Maximum Length: 30

  Default Value: DIRECT

  Indicates the nature of the credit such as Direct, Indirect, or Summarized.
• DirectParticipantId: integer (int64)
  The unique identifier of the participant who is directly involved in the closure of the transaction.
• DirectRuleId: integer (int64)
  The unique identifier of the credit rule used to create the direct credit that corresponds to this credit.
• HoldFlag: boolean
  Maximum Length: 1

  Indicates whether the application must exclude the transaction from further processing.
• HomeConversionRate: number
  The exchange rate to convert from processing currency to home currency.
• HomeCreditAmount: number
  The transaction amount in participant's home currency.
• HomeCurrencyCode: string
  Maximum Length: 15

  The code indicating the participant's home currency.
• ObjectStatus: string
  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.
• OperatingConversionRate: number
  The exchange rate to convert from source currency to operating currency.
• OperatingCreditAmount: number
  The credit amount in business unit operating currency.
• RevenueType: string
  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.
• RoleId: integer (int64)
  The unique identifier of the role assigned to the credit receiver.
• RollupDate: string (date-time)
  The date used to determine the roll up credit receivers when processing the roll up rules against transactions.
• RollupLevel: integer (int64)
  The level of the rollup rule in the rollup hierarchy. This value is applicable in case of rollup credits.
• SimulationDeleteFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether a credit is deleted during calculation simulation processing.
• SimulationId: integer (int64)
  The identifier of the simulation to which this simulation credit belongs.
• SourceBusinessUnitId: integer (int64)
  The unique identifier of the source transaction business unit.
• SourceCreditAmount: number
  The credit amount in source currency of the transaction.
• SourceCreditId: integer (int64)
  The unique identifier of the source credit or the summarized credit record from which the rollup credit is generated.
• SourceCurrencyCode: string
  Maximum Length: 15

  The currency code that represents the currency of the monetary transaction amount in the source application.
• SourceTransactionAmount: number
  The transaction amount in source currency of the transaction.
• SplitPct: number
  Default Value: 100

  The percent of the transaction amount that the credit receiver received.
• SummaryCreditId: integer (int64)
  The unique identifier of the summary credit to which the credit is associated.
• TransactionAmount: number
  The transaction amount in processing currency.
• TransactionQuantity: number
  The quantity for the transaction line item.

{
    "type":"object",
    "properties":{
        "CreditDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true
        },
        "SourceCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code that represents the currency of the monetary transaction amount in the source application.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RollupLevel":{
            "type":"integer",
            "description":"The level of the rollup rule in the rollup hierarchy. This value is applicable in case of rollup credits.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SplitPct":{
            "type":"number",
            "description":"The percent of the transaction amount that the credit receiver received.",
            "nullable":true,
            "default":"100"
        },
        "HomeCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The code indicating the participant's home currency.",
            "nullable":true
        },
        "RollupDate":{
            "type":"string",
            "description":"The date used to determine the roll up credit receivers when processing the roll up rules against transactions.",
            "format":"date-time",
            "nullable":true
        },
        "SourceBusinessUnitId":{
            "type":"integer",
            "description":"The unique identifier of the source transaction business unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CreditAmount":{
            "type":"number",
            "description":"The credit amount in processing currency.",
            "nullable":true
        },
        "DirectRuleId":{
            "type":"integer",
            "description":"The unique identifier of the credit rule used to create the direct credit that corresponds to this credit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "OperatingConversionRate":{
            "type":"number",
            "description":"The exchange rate to convert from source currency to operating currency.",
            "nullable":true
        },
        "ObjectStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "TransactionQuantity":{
            "type":"number",
            "description":"The quantity for the transaction line item.",
            "nullable":true
        },
        "AdjustmentComments":{
            "maxLength":"1000",
            "type":"string",
            "description":"The comments explaining why the credit was adjusted.",
            "nullable":true
        },
        "SourceTransactionAmount":{
            "type":"number",
            "description":"The transaction amount in source currency of the transaction.",
            "nullable":true
        },
        "CreditCategoryId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "CollectionStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "CreditType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the nature of the credit such as Direct, Indirect, or Summarized.",
            "nullable":false,
            "default":"DIRECT"
        },
        "ClsfnRuleId":{
            "type":"integer",
            "description":"The unique identifier of the classification rule used to assign the credit category, to the credit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "DirectParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant who is directly involved in the closure of the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceCreditId":{
            "type":"integer",
            "description":"The unique identifier of the source credit or the summarized credit record from which the rollup credit is generated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "HomeConversionRate":{
            "type":"number",
            "description":"The exchange rate to convert from processing currency to home currency.",
            "nullable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier of the role assigned to the credit receiver.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SourceCreditAmount":{
            "type":"number",
            "description":"The credit amount in source currency of the transaction.",
            "nullable":true
        },
        "CalculationCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "AdjustmentStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true
        },
        "TransactionAmount":{
            "type":"number",
            "description":"The transaction amount in processing currency.",
            "nullable":true
        },
        "HomeCreditAmount":{
            "type":"number",
            "description":"The transaction amount in participant's home currency.",
            "nullable":true
        },
        "CreditedParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant who owns the credit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CalculationConversionRate":{
            "type":"number",
            "description":"The exchange rate to convert from source currency to processing currency.",
            "nullable":true
        },
        "OperatingCreditAmount":{
            "type":"number",
            "description":"The credit amount in business unit operating currency.",
            "nullable":true
        },
        "SimulationDeleteFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a credit is deleted during calculation simulation processing.",
            "nullable":false,
            "default":false
        },
        "SimulationId":{
            "type":"integer",
            "description":"The identifier of the simulation to which this simulation credit belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CreditRuleId":{
            "type":"integer",
            "description":"The unique identifier of the credit rule used to create the credit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            }
        },
        "SummaryCreditId":{
            "type":"integer",
            "description":"The unique identifier of the summary credit to which the credit is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "HoldFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the application must exclude the transaction from further processing.",
            "nullable":true
        },
        "RevenueType":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• __FLEX_Context: string
  Title: Business Unit Context for Base Transaction Attributes

  Maximum Length: 30

  The context segment for the descriptive flex field.
• __FLEX_Context_DisplayValue: string
  Title: Business Unit Context for Base Transaction Attributes

  The display value of the context segment for the descriptive flex field.
• _Area_Code: string
  Title: Area Code

  Maximum Length: 360

  The geographic transaction attribute for the area code. The area code is a component of a phone number and is usually a 3-digit number that identifies each telephone service area in a country.
• _Billing_Address: number
  Title: Customer Billing Address Location

  The unique identifier of the customer billing location.
• _Billing_Contact: number
  Title: Customer Billing Contact

  The unique identifier of the contact person at the bill-to location.
• _City: string
  Title: City

  Maximum Length: 360

  The city related to this simulation transaction.
• _City_Display: string
  Title: City

  The name of the city related to this simulation transaction.
• _Country: string
  Title: Country

  Maximum Length: 360

  The country related to this simulation transaction.
• _Country_Display: string
  Title: Country

  The name of the country related to this simulation transaction.
• _Postal_Code: string
  Title: Postal Code

  Maximum Length: 360

  The postal code of the address.
• _Product_Item_ID: number
  Title: Line Item ID

  The unique identifier of the inventory item.
• _Product_Item_ID_Display: string
  Title: Line Item ID

  The display value of the inventory item.
• _Province: string
  Title: Province

  Maximum Length: 360

  The name of the province.
• _Sales_Channel: string
  Title: Sales Channel

  Maximum Length: 30

  The sales channel represents how the transaction was sold. For example, indirect or direct.
• _Shipping_Address: number
  Title: Shipping Address Location

  The unique identifier of the customer's ship-to location.
• _Shipping_Contact: number
  Title: Customer Shipping Contact

  The unique identifier of the contact person at the ship-to location.
• _Sold_To_Customer: number
  Title: Customer

  The unique identifier of customer who purchased the items or services listed on the transaction.
• _Sold_To_Customer_Display: string
  Title: Customer

  The name of customer who purchased the items or services listed on the transaction.
• _State: string
  Title: State

  Maximum Length: 360

  The state related to this simulation transaction.
• _State_Display: string
  Title: State

  The name of the state related to this simulation transaction.
• SimulationId: integer (int64)
  The unique identifier of the simulation to which this simulation transaction belongs.
• TransactionId: integer (int64)
  The unique identifier of the transaction to which this descriptive flex field belongs.

{
    "type":"object",
    "properties":{
        "_Product_Item_ID_Display":{
            "title":"Line Item ID",
            "type":"string",
            "description":"The display value of the inventory item.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_Product_Item_ID",
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Postal_Code":{
            "title":"Postal Code",
            "maxLength":"360",
            "type":"string",
            "description":"The postal code of the address.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"IC_CN_CHAR_360#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"360",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_SegmentName":"Postal_Code",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Country":{
            "title":"Country",
            "maxLength":"360",
            "type":"string",
            "description":"The country related to this simulation transaction.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_Country_Display",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"ORA_CN_COUNTRY#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_SegmentName":"Country",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Province":{
            "title":"Province",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the province.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"IC_CN_CHAR_360#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"360",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_SegmentName":"Province",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Sold_To_Customer_Display":{
            "title":"Customer",
            "type":"string",
            "description":"The name of customer who purchased the items or services listed on the transaction.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_Sold_To_Customer",
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Sales_Channel":{
            "title":"Sales Channel",
            "maxLength":"30",
            "type":"string",
            "description":"The sales channel represents how the transaction was sold. For example, indirect or direct.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"IC_CN_CHAR_30#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"30",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_SegmentName":"Sales_Channel",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "TransactionId":{
            "type":"integer",
            "description":"The unique identifier of the transaction to which this descriptive flex field belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "_Country_Display":{
            "title":"Country",
            "type":"string",
            "description":"The name of the country related to this simulation transaction.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_Country",
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_City":{
            "title":"City",
            "maxLength":"360",
            "type":"string",
            "description":"The city related to this simulation transaction.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_City_Display",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"ORA_CN_CITY#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_SegmentName":"City",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Shipping_Contact":{
            "title":"Customer Shipping Contact",
            "type":"number",
            "description":"The unique identifier of the contact person at the ship-to location.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_Precision":"18",
                "FND_ACFF_Scale":"0",
                "FND_ACFF_ValueSetInfo":"IC_CN_NUM_18#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.math.BigDecimal",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_SegmentName":"Shipping_Contact",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Sold_To_Customer":{
            "title":"Customer",
            "type":"number",
            "description":"The unique identifier of customer who purchased the items or services listed on the transaction.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_Sold_To_Customer_Display",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"ORA_CN_BASETRANS_CUSTOMER_NAME#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.math.BigDecimal",
                "FND_ACFF_SegmentName":"Sold_To_Customer",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_City_Display":{
            "title":"City",
            "type":"string",
            "description":"The name of the city related to this simulation transaction.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_City",
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_State":{
            "title":"State",
            "maxLength":"360",
            "type":"string",
            "description":"The state related to this simulation transaction.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_State_Display",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"ORA_CN_STATE#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_SegmentName":"State",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_State_Display":{
            "title":"State",
            "type":"string",
            "description":"The name of the state related to this simulation transaction.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_State",
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Billing_Address":{
            "title":"Customer Billing Address Location",
            "type":"number",
            "description":"The unique identifier of the customer billing location.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_Precision":"18",
                "FND_ACFF_Scale":"0",
                "FND_ACFF_ValueSetInfo":"IC_CN_NUM_18#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.math.BigDecimal",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_SegmentName":"Billing_Address",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Business Unit Context for Base Transaction Attributes",
            "type":"string",
            "description":"The display value of the context segment for the descriptive flex field.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "SimulationId":{
            "type":"integer",
            "description":"The unique identifier of the simulation to which this simulation transaction belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            }
        },
        "_Billing_Contact":{
            "title":"Customer Billing Contact",
            "type":"number",
            "description":"The unique identifier of the contact person at the bill-to location.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_Precision":"18",
                "FND_ACFF_Scale":"0",
                "FND_ACFF_ValueSetInfo":"IC_CN_NUM_18#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.math.BigDecimal",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_SegmentName":"Billing_Contact",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Product_Item_ID":{
            "title":"Line Item ID",
            "type":"number",
            "description":"The unique identifier of the inventory item.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_Product_Item_ID_Display",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"ORA_CN_BASETRANS_ITEM_NAME#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.math.BigDecimal",
                "FND_ACFF_SegmentName":"Product_Item_ID",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Shipping_Address":{
            "title":"Shipping Address Location",
            "type":"number",
            "description":"The unique identifier of the customer's ship-to location.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_Precision":"18",
                "FND_ACFF_Scale":"0",
                "FND_ACFF_ValueSetInfo":"IC_CN_NUM_18#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.math.BigDecimal",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_SegmentName":"Shipping_Address",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Area_Code":{
            "title":"Area Code",
            "maxLength":"360",
            "type":"string",
            "description":"The geographic transaction attribute for the area code. The area code is a component of a phone number and is usually a 3-digit number that identifies each telephone service area in a country.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"IC_CN_CHAR_360#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"360",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_SegmentName":"Area_Code",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Business Unit Context for Base Transaction Attributes",
            "maxLength":"30",
            "type":"string",
            "description":"The context segment for the descriptive flex field.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DerivedFromParameter":"CN_TP_BASETRANS_DFF_P1",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_DV":"CN_TP_BASETRANS_DFF_P1",
                "FND_ACFF_DVT":"P",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

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 : incentiveCompensationCalculationSimulations-Transactions-item-response

Type: object

Show Source

• AdjustmentComments: string
  Maximum Length: 1000

  The comments explaining the adjustment to a transaction.
• AdjustmentStatus: string
  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.
• BookedDate: string (date-time)
  The date when the sales order was booked in the order management application.
• ChangedTrxFlag: boolean
  Maximum Length: 1

  Indicates whether the transaction is a new transaction or a modified transaction.
• ClsfnRuleId: integer (int64)
  The unique identifier of the classification rule used to assign the credit category to the transaction.
• CollectionStatus: string
  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.
• ConversionRate: number
  Read Only: true

  The exchange rate to convert from source system currency to operating currency.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• CreditDate: string (date-time)
  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.
• Credits: array Simulation Credits
  Title: Simulation Credits

  The simulation credits resource to is used to view, create, update, and delete credits of a calculation simulation.
• DirectParticipantId: integer (int64)
  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 (int64)
  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
  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.
• ErrorMeaning: string
  Read Only: true

  Maximum Length: 80

  The reason explaining why the credit is in error status.
• EventDate: string (date-time)
  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
  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.
• InvoiceDate: string (date-time)
  The date when the invoice for the transaction was generated in the source application.
• InvoiceNumber: string
  Maximum Length: 30

  The unique identifier of the invoice associated with the transaction.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MarginPercentage: number
  The percentage of the transaction amount that depicts the profit of the sale.
• ObjectStatus: string
  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.
• OrderNumber: string
  Maximum Length: 30

  The sales order number in the source application associated with the transaction.
• PreserveCreditFlag: boolean
  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.
• ProcessCode: string
  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.
• ReasonCode: string
  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.
• RoleId: integer (int64)
  The unique identifier of the compensation role assigned to the direct participant.
• RollupDate: string (date-time)
  The date used to determine the roll up credit receivers when processing the roll up rules against transactions.
• SimulationDeleteFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether a transaction is deleted during calculation simulation processing.
• SimulationId: integer (int64)
  The unique identifier of the simulation to which this simulation transaction belongs.
• SimulationTransactionDFF: array 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.
• SourceCurrencyCode: string
  Maximum Length: 15

  The currency code that indicates the currency of the monetary transaction amount in the source application.
• SourceEventPeriodId: integer (int64)
  Read Only: true

  The unique identifier of the period to which the source event belongs.
• SourceOrgId: integer (int64)
  The unique identifier of the source transaction business unit record.
• SourceTrxId: integer (int64)
  The unique identifier of the transaction in the source application.
• SourceTrxLineId: integer (int64)
  The unique identifier of the transaction line in the source application.
• SourceTrxSalesLineId: integer (int64)
  The unique identifier of the transaction credit in the source application.
• TerrId: integer (int64)
  The unique identifier of the territory to which the transaction belongs.
• TerrName: string
  Maximum Length: 1000

  The name of the territory to which the transaction belongs.
• TransactionAmountFunc: number
  Read Only: true

  The transaction amount in operating currency.
• TransactionAmountSource: number
  The transaction amount in source currency.
• TransactionId: integer (int64)
  The unique identifier of the transaction in a calculation simulation.
• TransactionNumber: string
  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.
• TransactionQuantity: number
  The quantity of the transaction line item.
• TransactionType: string
  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.
• UOMCode: string
  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.
• WorkerId: integer (int64)
  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".

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code that indicates the currency of the monetary transaction amount in the source application.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EventDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "RollupDate":{
            "type":"string",
            "description":"The date used to determine the roll up credit receivers when processing the roll up rules against transactions.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTrxLineId":{
            "type":"integer",
            "description":"The unique identifier of the transaction line in the source application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OrderNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The sales order number in the source application associated with the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTrxSalesLineId":{
            "type":"integer",
            "description":"The unique identifier of the transaction credit in the source application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionQuantity":{
            "type":"number",
            "description":"The quantity of the transaction line item.",
            "nullable":true,
            "x-queryable":true
        },
        "TerrId":{
            "type":"integer",
            "description":"The unique identifier of the territory to which the transaction belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TerrName":{
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the territory to which the transaction belongs.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CollectionStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the invoice associated with the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":"10",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkerId":{
            "type":"integer",
            "description":"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\".",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"The unique identifier of the transaction in a calculation simulation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceTrxId":{
            "type":"integer",
            "description":"The unique identifier of the transaction in the source application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SimulationId":{
            "type":"integer",
            "description":"The unique identifier of the simulation to which this simulation transaction belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SimulationTransactionDFF":{
            "title":"Simulation Transaction Descriptive Flex Fields",
            "type":"array",
            "description":"The simulation transaction descriptive flex fields resource is used to view and create additional attributes of the transaction that are used during the simulation.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationCalculationSimulations-Transactions-SimulationTransactionDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangedTrxFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the transaction is a new transaction or a modified transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "BookedDate":{
            "type":"string",
            "description":"The date when the sales order was booked in the order management application.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionAmountFunc":{
            "type":"number",
            "description":"The transaction amount in operating currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentComments":{
            "maxLength":"1000",
            "type":"string",
            "description":"The comments explaining the adjustment to a transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceDate":{
            "type":"string",
            "description":"The date when the invoice for the transaction was generated in the source application.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SourceEventPeriodId":{
            "type":"integer",
            "description":"The unique identifier of the period to which the source event belongs.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceOrgId":{
            "type":"integer",
            "description":"The unique identifier of the source transaction business unit record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EligibleCatId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ClsfnRuleId":{
            "type":"integer",
            "description":"The unique identifier of the classification rule used to assign the credit category to the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "DirectParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant who is directly involved in the closure of the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PreserveCreditFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether any of the manually created or adjusted credits for the transaction are not to be modified by the credit process.",
            "nullable":true,
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier of the compensation role assigned to the direct participant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Credits":{
            "title":"Simulation Credits",
            "type":"array",
            "description":"The simulation credits resource to is used to view, create, update, and delete credits of a calculation simulation.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationCalculationSimulations-Transactions-Credits-item-response"
            }
        },
        "ConversionRate":{
            "type":"number",
            "description":"The exchange rate to convert from source system currency to operating currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionAmountSource":{
            "type":"number",
            "description":"The transaction amount in source currency.",
            "nullable":false,
            "x-queryable":true
        },
        "DiscountPercentage":{
            "type":"number",
            "description":"The percentage of the transaction amount that depicts the net amount to be paid by the buyer.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The reason explaining why the credit is in error status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SimulationDeleteFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a transaction is deleted during calculation simulation processing.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "MarginPercentage":{
            "type":"number",
            "description":"The percentage of the transaction amount that depicts the profit of the sale.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "HoldFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object incentiveCompensationCalculationSimulations-Transactions-Credits-item-response

{
    "title":"Simulation Credits",
    "type":"array",
    "description":"The simulation credits resource to is used to view, create, update, and delete credits of a calculation simulation.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationCalculationSimulations-Transactions-Credits-item-response"
    }
}

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 : 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

• Array of: object incentiveCompensationCalculationSimulations-Transactions-SimulationTransactionDFF-item-response

{
    "title":"Simulation Transaction Descriptive Flex Fields",
    "type":"array",
    "description":"The simulation transaction descriptive flex fields resource is used to view and create additional attributes of the transaction that are used during the simulation.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationCalculationSimulations-Transactions-SimulationTransactionDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : incentiveCompensationCalculationSimulations-Transactions-Credits-item-response

Type: object

Show Source

• AdjustmentComments: string
  Maximum Length: 1000

  The comments explaining why the credit was adjusted.
• AdjustmentStatus: string
  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.
• CalculationConversionRate: number
  The exchange rate to convert from source currency to processing currency.
• CalculationCurrencyCode: string
  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.
• ChangedCreditFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates if the credit is new or modified.
• ClsfnRuleId: integer (int64)
  The unique identifier of the classification rule used to assign the credit category, to the credit.
• CollectionStatus: string
  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.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreatedDuring: string
  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.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• CreditAmount: number
  The credit amount in processing currency.
• CreditCategoryId: integer (int64)
  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.
• CreditDate: string (date-time)
  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.
• CreditedParticipantId: integer (int64)
  The unique identifier of the participant who owns the credit.
• CreditId: integer (int64)
  Read Only: true

  The unique identifier of the credit.
• CreditRuleId: integer (int64)
  The unique identifier of the credit rule used to create the credit.
• CreditType: string
  Maximum Length: 30

  Default Value: DIRECT

  Indicates the nature of the credit such as Direct, Indirect, or Summarized.
• DirectParticipantId: integer (int64)
  The unique identifier of the participant who is directly involved in the closure of the transaction.
• DirectRuleId: integer (int64)
  The unique identifier of the credit rule used to create the direct credit that corresponds to this credit.
• ErrorCode: string
  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.
• ErrorMeaning: string
  Read Only: true

  Maximum Length: 80

  The display label explaining why the credit is in error status.
• EventDate: string (date-time)
  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.
• HoldFlag: boolean
  Maximum Length: 1

  Indicates whether the application must exclude the transaction from further processing.
• HomeConversionRate: number
  The exchange rate to convert from processing currency to home currency.
• HomeCreditAmount: number
  The transaction amount in participant's home currency.
• HomeCurrencyCode: string
  Maximum Length: 15

  The code indicating the participant's home currency.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectStatus: string
  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.
• OperatingConversionRate: number
  The exchange rate to convert from source currency to operating currency.
• OperatingCreditAmount: number
  The credit amount in business unit operating currency.
• OperatingCurrency: string
  Title: Operating Currency

  Read Only: true

  Maximum Length: 10

  The code indicating the functional currency of the business unit.
• ProcessCode: string
  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.
• ReasonCode: string
  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.
• RevenueType: string
  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.
• RoleId: integer (int64)
  The unique identifier of the role assigned to the credit receiver.
• RollupDate: string (date-time)
  The date used to determine the roll up credit receivers when processing the roll up rules against transactions.
• RollupLevel: integer (int64)
  The level of the rollup rule in the rollup hierarchy. This value is applicable in case of rollup credits.
• SimulationDeleteFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether a credit is deleted during calculation simulation processing.
• SimulationId: integer (int64)
  The identifier of the simulation to which this simulation credit belongs.
• SourceBusinessUnitId: integer (int64)
  The unique identifier of the source transaction business unit.
• SourceCreditAmount: number
  The credit amount in source currency of the transaction.
• SourceCreditId: integer (int64)
  The unique identifier of the source credit or the summarized credit record from which the rollup credit is generated.
• SourceCurrencyCode: string
  Maximum Length: 15

  The currency code that represents the currency of the monetary transaction amount in the source application.
• SourceTransactionAmount: number
  The transaction amount in source currency of the transaction.
• SplitPct: number
  Default Value: 100

  The percent of the transaction amount that the credit receiver received.
• SummaryCreditId: integer (int64)
  The unique identifier of the summary credit to which the credit is associated.
• TransactionAmount: number
  The transaction amount in processing currency.
• TransactionId: integer (int64)
  Read Only: true

  The unique identifier of the transaction.
• TransactionNumber: string
  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.
• TransactionQuantity: number
  The quantity for the transaction line item.
• TransactionType: string
  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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The currency code that represents the currency of the monetary transaction amount in the source application.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EventDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SplitPct":{
            "type":"number",
            "description":"The percent of the transaction amount that the credit receiver received.",
            "nullable":true,
            "default":"100",
            "x-queryable":true
        },
        "RollupDate":{
            "type":"string",
            "description":"The date used to determine the roll up credit receivers when processing the roll up rules against transactions.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SourceBusinessUnitId":{
            "type":"integer",
            "description":"The unique identifier of the source transaction business unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreditAmount":{
            "type":"number",
            "description":"The credit amount in processing currency.",
            "nullable":true,
            "x-queryable":true
        },
        "DirectRuleId":{
            "type":"integer",
            "description":"The unique identifier of the credit rule used to create the direct credit that corresponds to this credit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OperatingCurrency":{
            "title":"Operating Currency",
            "maxLength":"10",
            "type":"string",
            "description":"The code indicating the functional currency of the business unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionQuantity":{
            "type":"number",
            "description":"The quantity for the transaction line item.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditId":{
            "type":"integer",
            "description":"The unique identifier of the credit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceTransactionAmount":{
            "type":"number",
            "description":"The transaction amount in source currency of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreditCategoryId":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "CollectionStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The five letter code indicating the combination of Override Classification, Preserve Credits, Do Not Roll Up, and Do Not Calculate values for the transaction.",
            "nullable":true,
            "readOnly":true,
            "default":"CNNEC",
            "x-queryable":true
        },
        "ReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceCreditAmount":{
            "type":"number",
            "description":"The credit amount in source currency of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"The unique identifier of the transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CalculationCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "CalculationConversionRate":{
            "type":"number",
            "description":"The exchange rate to convert from source currency to processing currency.",
            "nullable":true,
            "x-queryable":true
        },
        "SimulationId":{
            "type":"integer",
            "description":"The identifier of the simulation to which this simulation credit belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SummaryCreditId":{
            "type":"integer",
            "description":"The unique identifier of the summary credit to which the credit is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RevenueType":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditDate":{
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RollupLevel":{
            "type":"integer",
            "description":"The level of the rollup rule in the rollup hierarchy. This value is applicable in case of rollup credits.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the transaction that users can recognize and search with, for example, an invoice number or order number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedDuring":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "default":"SIMULATION",
            "x-queryable":true
        },
        "HomeCurrencyCode":{
            "maxLength":"15",
            "type":"string",
            "description":"The code indicating the participant's home currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangedCreditFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the credit is new or modified.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperatingConversionRate":{
            "type":"number",
            "description":"The exchange rate to convert from source currency to operating currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentComments":{
            "maxLength":"1000",
            "type":"string",
            "description":"The comments explaining why the credit was adjusted.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditType":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the nature of the credit such as Direct, Indirect, or Summarized.",
            "nullable":false,
            "default":"DIRECT",
            "x-queryable":true
        },
        "ClsfnRuleId":{
            "type":"integer",
            "description":"The unique identifier of the classification rule used to assign the credit category, to the credit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DirectParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant who is directly involved in the closure of the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SourceCreditId":{
            "type":"integer",
            "description":"The unique identifier of the source credit or the summarized credit record from which the rollup credit is generated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "HomeConversionRate":{
            "type":"number",
            "description":"The exchange rate to convert from processing currency to home currency.",
            "nullable":true,
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier of the role assigned to the credit receiver.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TransactionAmount":{
            "type":"number",
            "description":"The transaction amount in processing currency.",
            "nullable":true,
            "x-queryable":true
        },
        "HomeCreditAmount":{
            "type":"number",
            "description":"The transaction amount in participant's home currency.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditedParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant who owns the credit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OperatingCreditAmount":{
            "type":"number",
            "description":"The credit amount in business unit operating currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"The display label explaining why the credit is in error status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SimulationDeleteFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether a credit is deleted during calculation simulation processing.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "CreditRuleId":{
            "type":"integer",
            "description":"The unique identifier of the credit rule used to create the credit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ErrorCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the application must exclude the transaction from further processing.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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."
        }
    }
}

Nested Schema : incentiveCompensationCalculationSimulations-Transactions-SimulationTransactionDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Business Unit Context for Base Transaction Attributes

  Maximum Length: 30

  The context segment for the descriptive flex field.
• __FLEX_Context_DisplayValue: string
  Title: Business Unit Context for Base Transaction Attributes

  The display value of the context segment for the descriptive flex field.
• _Area_Code: string
  Title: Area Code

  Maximum Length: 360

  The geographic transaction attribute for the area code. The area code is a component of a phone number and is usually a 3-digit number that identifies each telephone service area in a country.
• _Billing_Address: number
  Title: Customer Billing Address Location

  The unique identifier of the customer billing location.
• _Billing_Contact: number
  Title: Customer Billing Contact

  The unique identifier of the contact person at the bill-to location.
• _City: string
  Title: City

  Maximum Length: 360

  The city related to this simulation transaction.
• _City_Display: string
  Title: City

  The name of the city related to this simulation transaction.
• _Country: string
  Title: Country

  Maximum Length: 360

  The country related to this simulation transaction.
• _Country_Display: string
  Title: Country

  The name of the country related to this simulation transaction.
• _Postal_Code: string
  Title: Postal Code

  Maximum Length: 360

  The postal code of the address.
• _Product_Item_ID: number
  Title: Line Item ID

  The unique identifier of the inventory item.
• _Product_Item_ID_Display: string
  Title: Line Item ID

  The display value of the inventory item.
• _Province: string
  Title: Province

  Maximum Length: 360

  The name of the province.
• _Sales_Channel: string
  Title: Sales Channel

  Maximum Length: 30

  The sales channel represents how the transaction was sold. For example, indirect or direct.
• _Shipping_Address: number
  Title: Shipping Address Location

  The unique identifier of the customer's ship-to location.
• _Shipping_Contact: number
  Title: Customer Shipping Contact

  The unique identifier of the contact person at the ship-to location.
• _Sold_To_Customer: number
  Title: Customer

  The unique identifier of customer who purchased the items or services listed on the transaction.
• _Sold_To_Customer_Display: string
  Title: Customer

  The name of customer who purchased the items or services listed on the transaction.
• _State: string
  Title: State

  Maximum Length: 360

  The state related to this simulation transaction.
• _State_Display: string
  Title: State

  The name of the state related to this simulation transaction.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SimulationId: integer (int64)
  The unique identifier of the simulation to which this simulation transaction belongs.
• TransactionId: integer (int64)
  The unique identifier of the transaction to which this descriptive flex field belongs.

{
    "type":"object",
    "properties":{
        "_Product_Item_ID_Display":{
            "title":"Line Item ID",
            "type":"string",
            "description":"The display value of the inventory item.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_Product_Item_ID",
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "_Postal_Code":{
            "title":"Postal Code",
            "maxLength":"360",
            "type":"string",
            "description":"The postal code of the address.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"IC_CN_CHAR_360#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"360",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_SegmentName":"Postal_Code",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "_Country":{
            "title":"Country",
            "maxLength":"360",
            "type":"string",
            "description":"The country related to this simulation transaction.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_Country_Display",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"ORA_CN_COUNTRY#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_SegmentName":"Country",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "_Province":{
            "title":"Province",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the province.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"IC_CN_CHAR_360#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"360",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_SegmentName":"Province",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "_Sold_To_Customer_Display":{
            "title":"Customer",
            "type":"string",
            "description":"The name of customer who purchased the items or services listed on the transaction.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_Sold_To_Customer",
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "_Sales_Channel":{
            "title":"Sales Channel",
            "maxLength":"30",
            "type":"string",
            "description":"The sales channel represents how the transaction was sold. For example, indirect or direct.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"IC_CN_CHAR_30#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"30",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_SegmentName":"Sales_Channel",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"The unique identifier of the transaction to which this descriptive flex field belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "_Country_Display":{
            "title":"Country",
            "type":"string",
            "description":"The name of the country related to this simulation transaction.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_Country",
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "_City":{
            "title":"City",
            "maxLength":"360",
            "type":"string",
            "description":"The city related to this simulation transaction.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_City_Display",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"ORA_CN_CITY#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_SegmentName":"City",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "_Shipping_Contact":{
            "title":"Customer Shipping Contact",
            "type":"number",
            "description":"The unique identifier of the contact person at the ship-to location.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_Precision":"18",
                "FND_ACFF_Scale":"0",
                "FND_ACFF_ValueSetInfo":"IC_CN_NUM_18#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.math.BigDecimal",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_SegmentName":"Shipping_Contact",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "_Sold_To_Customer":{
            "title":"Customer",
            "type":"number",
            "description":"The unique identifier of customer who purchased the items or services listed on the transaction.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_Sold_To_Customer_Display",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"ORA_CN_BASETRANS_CUSTOMER_NAME#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.math.BigDecimal",
                "FND_ACFF_SegmentName":"Sold_To_Customer",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "_City_Display":{
            "title":"City",
            "type":"string",
            "description":"The name of the city related to this simulation transaction.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_City",
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "_State":{
            "title":"State",
            "maxLength":"360",
            "type":"string",
            "description":"The state related to this simulation transaction.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_State_Display",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"ORA_CN_STATE#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_SegmentName":"State",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "_State_Display":{
            "title":"State",
            "type":"string",
            "description":"The name of the state related to this simulation transaction.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_SegmentAttributeName":"_State",
                "controlType":"combo_lov",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Hide",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Value",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "_Billing_Address":{
            "title":"Customer Billing Address Location",
            "type":"number",
            "description":"The unique identifier of the customer billing location.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_Precision":"18",
                "FND_ACFF_Scale":"0",
                "FND_ACFF_ValueSetInfo":"IC_CN_NUM_18#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.math.BigDecimal",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_SegmentName":"Billing_Address",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Business Unit Context for Base Transaction Attributes",
            "type":"string",
            "description":"The display value of the context segment for the descriptive flex field.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "SimulationId":{
            "type":"integer",
            "description":"The unique identifier of the simulation to which this simulation transaction belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "_Billing_Contact":{
            "title":"Customer Billing Contact",
            "type":"number",
            "description":"The unique identifier of the contact person at the bill-to location.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_Precision":"18",
                "FND_ACFF_Scale":"0",
                "FND_ACFF_ValueSetInfo":"IC_CN_NUM_18#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.math.BigDecimal",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_SegmentName":"Billing_Contact",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "_Product_Item_ID":{
            "title":"Line Item ID",
            "type":"number",
            "description":"The unique identifier of the inventory item.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DisplayAttributeName":"_Product_Item_ID_Display",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_ValueSetInfo":"ORA_CN_BASETRANS_ITEM_NAME#TABLE",
                "includeInCompactView":true,
                "FlexClientDisplayHint":"Show",
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.math.BigDecimal",
                "FND_ACFF_SegmentName":"Product_Item_ID",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "_Shipping_Address":{
            "title":"Shipping Address Location",
            "type":"number",
            "description":"The unique identifier of the customer's ship-to location.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_Precision":"18",
                "FND_ACFF_Scale":"0",
                "FND_ACFF_ValueSetInfo":"IC_CN_NUM_18#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.math.BigDecimal",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_SegmentName":"Shipping_Address",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "_Area_Code":{
            "title":"Area Code",
            "maxLength":"360",
            "type":"string",
            "description":"The geographic transaction attribute for the area code. The area code is a component of a phone number and is usually a 3-digit number that identifies each telephone service area in a country.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"IC_CN_CHAR_360#FORMAT_ONLY",
                "includeInCompactView":true,
                "FND_ACFF_IsGlobal":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"360",
                "FND_ACFF_IsGlobalDisplay":"true",
                "FND_ACFF_SegmentName":"Area_Code",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Business Unit Context for Base Transaction Attributes",
            "maxLength":"30",
            "type":"string",
            "description":"The context segment for the descriptive flex field.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DerivedFromParameter":"CN_TP_BASETRANS_DFF_P1",
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_DV":"CN_TP_BASETRANS_DFF_P1",
                "FND_ACFF_DVT":"P",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "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"
    }
}

Links

ClassificationRuleVVO

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationRuleHierarchies

The list of values containing the unique identifiers of the classification rules.

The following properties are defined on the LOV link relation:

• Source Attribute: ClsfnRuleId; Target Attribute: RuleId
• Display Attribute: Name

Credits

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/Credits

Parameters:

• SimulationId: $request.path.SimulationId
• TransactionId: $request.path.TransactionId

The simulation credits resource to is used to view, create, update, and delete credits of a calculation simulation.

CurrencyVVO

Operation: /fscmRestApi/resources/11.13.18.05/currenciesLOV

Parameters:

• finder: CurrencyCodeFinder

The list of values containing the currency codes.

The following properties are defined on the LOV link relation:

• Source Attribute: SourceCurrencyCode; Target Attribute: CurrencyCode
• Display Attribute: CurrencyCode, Name

EligibleCategoryVVO

Operation: /fscmRestApi/resources/11.13.18.05/creditCategories

The list of values containing the unique identifiers of the credit categories.

The following properties are defined on the LOV link relation:

• Source Attribute: EligibleCatId; Target Attribute: EligibleCatId
• Display Attribute: Name

ObjectStatusVVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_TP_BASETRANS_OBJECT_STATUS

The list of values indicating the status of the object.

The following properties are defined on the LOV link relation:

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

SimulationTransactionDFF

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Transactions/{TransactionId}/child/SimulationTransactionDFF

Parameters:

• SimulationId: $request.path.SimulationId
• TransactionId: $request.path.TransactionId

The simulation transaction descriptive flex fields resource is used to view and create additional attributes of the transaction that are used during the simulation.

TransactionTypeVVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DCN_TP_TRANSACTION_TYPE

The list of value indicating the source of the transaction, such as order, invoice, or credit memo.

The following properties are defined on the LOV link relation:

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

UOMCodeVVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_CN_TP_TRANSACTION_UOM

The list of values containing the units of measure.

The following properties are defined on the LOV link relation:

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

Back to Top