Jump to

• Request
• Response

Update a calculation estimation

patch

/fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimations/{SimulationId}

Request

Path Parameters

• SimulationId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  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: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ProcessingStatus: string
  Maximum Length: 20

  Default Value: ORA_CN_NOT_READY

  The status of the calculation simulation, used to know if the simulation is ready to be processed, is being processed, has completed, or has ended in error.
• SimulationType: string
  Maximum Length: 30

  Defines the type of processing that needs to be used in this simulation.
• Transactions: array Participant Simulation Transactions
  Title: Participant Simulation Transactions

  The estimation transactions resource is used to view, create, update, and delete transactions associated with a calculation estimation.

{
    "type":"object",
    "properties":{
        "ProcessingStatus":{
            "maxLength":20,
            "type":"string",
            "description":"The status of the calculation simulation, used to know if the simulation is ready to be processed, is being processed, has completed, or has ended in error.",
            "nullable":true,
            "default":"ORA_CN_NOT_READY",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SimulationType":{
            "maxLength":30,
            "type":"string",
            "description":"Defines the type of processing that needs to be used in this simulation.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Transactions":{
            "title":"Participant Simulation Transactions",
            "type":"array",
            "description":"The estimation transactions resource is used to view, create, update, and delete transactions associated with a calculation estimation.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationEstimations-Transactions-item-patch-request"
            }
        }
    }
}

Nested Schema : Participant Simulation Transactions

Type: array

Title: Participant Simulation Transactions

The estimation transactions resource is used to view, create, update, and delete transactions associated with a calculation estimation.

Show Source

• Array of: object incentiveCompensationEstimations-Transactions-item-patch-request

{
    "title":"Participant Simulation Transactions",
    "type":"array",
    "description":"The estimation transactions resource is used to view, create, update, and delete transactions associated with a calculation estimation.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationEstimations-Transactions-item-patch-request"
    }
}

Nested Schema : incentiveCompensationEstimations-Transactions-item-patch-request

Type: object

Show Source

• AdjustmentComments: string
  Maximum Length: 1000

  Reason for adjustment
• AdjustmentReasonCode: string
  Maximum Length: 30

  Adjustment reason code
• AdjustmentStatus: string
  Maximum Length: 30

  Adjustment status
• BookedDate: string (date-time)
  Date order gets booked
• CreditDate: string (date-time)
  Date based on which crediting rule will be determined.
• Credits: array Participant Simulation Credits
  Title: Participant Simulation Credits

  The estimation credits resource is used to view, create, update, and delete credits of a calculation estimation.
• DiscountPercentage: number
  Discount percentage, exposed in UI
• EligibleCategoryId: integer (int64)
  The unique identifier of the eligible credit category.
• InvoiceDate: string (date-time)
  Invoice date
• InvoiceNumber: string
  Maximum Length: 30

  Unique identifier for invoice
• MarginPercentage: number
  Margin Percentage, exposed in UI
• OrderNumber: string
  Maximum Length: 30

  Unique identifier for order
• ParticipantId: integer (int64)
  The unique identifier of the participant with whom the earnings are associated.
• RollupDate: string (date-time)
  Date based on which rollup hierarchy will be determined
• SimulationTransactionDFF: array SimulationTransactionDFF
• SourceCurrencyCode: string
  Maximum Length: 15

  Currency code in which the source amounts are specified.
• SourceEventDate: string (date-time)
  The date when transaction was processed.
• TerrId: integer (int64)
  Unique identifier of territory
• TerrName: string
  Maximum Length: 1000

  Territory name
• TransactionAmountSource: number
  Transaction amount in source currency
• TransactionNumber: string
  Maximum Length: 30

  Transaction number
• TransactionQuantity: number
  The quantity of the unit sold in the transaction.
• TransactionType: string
  Maximum Length: 30

  The transaction type identifying the source of the transaction.
• UOMCode: string
  Maximum Length: 10

  Unit of Measure

{
    "type":"object",
    "properties":{
        "AdjustmentComments":{
            "maxLength":1000,
            "type":"string",
            "description":"Reason for adjustment",
            "nullable":true
        },
        "AdjustmentReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Adjustment reason code",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdjustmentStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Adjustment status",
            "nullable":true
        },
        "BookedDate":{
            "type":"string",
            "description":"Date order gets booked",
            "format":"date-time",
            "nullable":true
        },
        "CreditDate":{
            "type":"string",
            "description":"Date based on which crediting rule will be determined.",
            "format":"date-time",
            "nullable":true
        },
        "Credits":{
            "title":"Participant Simulation Credits",
            "type":"array",
            "description":"The estimation credits resource is used to view, create, update, and delete credits of a calculation estimation.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationEstimations-Transactions-Credits-item-patch-request"
            }
        },
        "DiscountPercentage":{
            "type":"number",
            "description":"Discount percentage, exposed in UI",
            "nullable":true
        },
        "EligibleCategoryId":{
            "type":"integer",
            "description":"The unique identifier of the eligible credit category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "InvoiceDate":{
            "type":"string",
            "description":"Invoice date",
            "format":"date-time",
            "nullable":true
        },
        "InvoiceNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for invoice",
            "nullable":true
        },
        "MarginPercentage":{
            "type":"number",
            "description":"Margin Percentage, exposed in UI",
            "nullable":true
        },
        "OrderNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for order",
            "nullable":true
        },
        "ParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant with whom the earnings are associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "RollupDate":{
            "type":"string",
            "description":"Date based on which rollup hierarchy will be determined",
            "format":"date-time",
            "nullable":true
        },
        "SimulationTransactionDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationEstimations-Transactions-SimulationTransactionDFF-item-patch-request"
            }
        },
        "SourceCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Currency code in which the source amounts are specified.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceEventDate":{
            "type":"string",
            "description":"The date when transaction was processed.",
            "format":"date-time",
            "nullable":false
        },
        "TerrId":{
            "type":"integer",
            "description":"Unique identifier of territory",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "TerrName":{
            "maxLength":1000,
            "type":"string",
            "description":"Territory name",
            "nullable":true
        },
        "TransactionAmountSource":{
            "type":"number",
            "description":"Transaction amount in source currency",
            "nullable":false
        },
        "TransactionNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Transaction number",
            "nullable":false
        },
        "TransactionQuantity":{
            "type":"number",
            "description":"The quantity of the unit sold in the transaction.",
            "nullable":true
        },
        "TransactionType":{
            "maxLength":30,
            "type":"string",
            "description":"The transaction type identifying the source of the transaction.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UOMCode":{
            "maxLength":10,
            "type":"string",
            "description":"Unit of Measure",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Nested Schema : Participant Simulation Credits

Type: array

Title: Participant Simulation Credits

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

Show Source

• Array of: object incentiveCompensationEstimations-Transactions-Credits-item-patch-request

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

Nested Schema : SimulationTransactionDFF

Type: array

Show Source

• Array of: object incentiveCompensationEstimations-Transactions-SimulationTransactionDFF-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationEstimations-Transactions-SimulationTransactionDFF-item-patch-request"
    }
}

Nested Schema : incentiveCompensationEstimations-Transactions-Credits-item-patch-request

Type: object

Show Source

• AdjustmentComments: string
  Maximum Length: 1000

  Reason for adjustment
• AdjustmentReasonCode: string
  Maximum Length: 30

  Adjustment reason code
• AdjustmentStatus: string
  Maximum Length: 30

  Adjustment status
• CollectionStatus: string
  Maximum Length: 30

  Collection status of the transaction
• CreditAmountCalculation: number
  Credit amount in calculation currency
• CreditDate: string (date-time)
  Date based on which crediting rule will be determined.
• CreditedParticipantId: integer (int64)
  Unique identifier for credited sales rep
• CreditType: string
  Maximum Length: 30

  Default Value: DIRECT

  Possible values: Direct, Indirect, and Summarized
• EligibleCategoryId: integer (int64)
  The unique identifier of the eligible credit category.
• ObjectVersionNumber: integer (int32)
  Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• ParticipantId: integer (int64)
  The unique identifier of the participant with whom the earnings are associated.
• RevenueType: string
  Maximum Length: 30

  The possible values are revenue, nonrevenue, and custom revenue types.
• RollupDate: string (date-time)
  Date based on which rollup hierarchy will be determined
• RollupLevel: integer (int64)
  Level in the hierarchy in case of rollup credits
• SourceCurrencyCode: string
  Maximum Length: 15

  Currency code in which the source amounts are specified.
• SourceEventDate: string (date-time)
  The date when transaction was processed.
• SplitPct: number
  Default Value: 100

  Split percentage

{
    "type":"object",
    "properties":{
        "AdjustmentComments":{
            "maxLength":1000,
            "type":"string",
            "description":"Reason for adjustment",
            "nullable":true
        },
        "AdjustmentReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Adjustment reason code",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AdjustmentStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Adjustment status",
            "nullable":true
        },
        "CollectionStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Collection status of the transaction",
            "nullable":true
        },
        "CreditAmountCalculation":{
            "type":"number",
            "description":"Credit amount in calculation currency",
            "nullable":true
        },
        "CreditDate":{
            "type":"string",
            "description":"Date based on which crediting rule will be determined.",
            "format":"date-time",
            "nullable":true
        },
        "CreditType":{
            "maxLength":30,
            "type":"string",
            "description":"Possible values: Direct, Indirect, and Summarized",
            "nullable":false,
            "default":"DIRECT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreditedParticipantId":{
            "type":"integer",
            "description":"Unique identifier for credited sales rep",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "EligibleCategoryId":{
            "type":"integer",
            "description":"The unique identifier of the eligible credit category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant with whom the earnings are associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "RevenueType":{
            "maxLength":30,
            "type":"string",
            "description":"The possible values are revenue, nonrevenue, and custom revenue types.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RollupDate":{
            "type":"string",
            "description":"Date based on which rollup hierarchy will be determined",
            "format":"date-time",
            "nullable":true
        },
        "RollupLevel":{
            "type":"integer",
            "description":"Level in the hierarchy in case of rollup credits",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SourceCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Currency code in which the source amounts are specified.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceEventDate":{
            "type":"string",
            "description":"The date when transaction was processed.",
            "format":"date-time",
            "nullable":true
        },
        "SplitPct":{
            "type":"number",
            "description":"Split percentage",
            "nullable":true,
            "default":100
        }
    }
}

Nested Schema : incentiveCompensationEstimations-Transactions-SimulationTransactionDFF-item-patch-request

Type: object

Show Source

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

  Maximum Length: 30

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

  Business Unit Context for Base Transaction Attributes
• _Area_Code: string
  Title: Area Code

  Maximum Length: 360

  Area Code
• _Billing_Address: number
  Title: Customer Billing Address Location

  Customer Billing Address Location
• _Billing_Contact: number
  Title: Customer Billing Contact

  Customer Billing Contact
• _City: string
  Title: City

  Maximum Length: 360

  City
• _City_Display: string
  Title: City

  City
• _Country: string
  Title: Country

  Maximum Length: 360

  Country
• _Country_Display: string
  Title: Country

  Country
• _Postal_Code: string
  Title: Postal Code

  Maximum Length: 360

  Postal Code
• _Product_Item_ID: number
  Title: Line Item ID

  Line Item ID
• _Product_Item_ID_Display: string
  Title: Line Item ID

  Line Item ID
• _Province: string
  Title: Province

  Maximum Length: 360

  Province
• _Sales_Channel: string
  Title: Sales Channel

  Maximum Length: 30

  Sales Channel
• _Shipping_Address: number
  Title: Shipping Address Location

  Shipping Address Location
• _Shipping_Contact: number
  Title: Customer Shipping Contact

  Customer Shipping Contact
• _Sold_To_Customer: number
  Title: Customer

  Customer
• _Sold_To_Customer_Display: string
  Title: Customer

  Customer
• _State: string
  Title: State

  Maximum Length: 360

  State
• _State_Display: string
  Title: State

  State

{
    "type":"object",
    "properties":{
        "_Area_Code":{
            "title":"Area Code",
            "maxLength":360,
            "type":"string",
            "description":"Area Code",
            "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_ColumnName":"AREA_CODE",
                "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"
                }
            }
        },
        "_Billing_Address":{
            "title":"Customer Billing Address Location",
            "type":"number",
            "description":"Customer Billing Address 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_ColumnName":"BILL_TO_ADDRESS_ID",
                "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"
                }
            }
        },
        "_Billing_Contact":{
            "title":"Customer Billing Contact",
            "type":"number",
            "description":"Customer Billing Contact",
            "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_ColumnName":"BILL_TO_CONTACT_ID",
                "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"
                }
            }
        },
        "_City":{
            "title":"City",
            "maxLength":360,
            "type":"string",
            "description":"City",
            "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_ColumnName":"CITY",
                "FND_ACFF_SegmentName":"City",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_City_Display":{
            "title":"City",
            "type":"string",
            "description":"City",
            "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"
                }
            }
        },
        "_Country":{
            "title":"Country",
            "maxLength":360,
            "type":"string",
            "description":"Country",
            "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_ColumnName":"COUNTRY",
                "FND_ACFF_SegmentName":"Country",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Country_Display":{
            "title":"Country",
            "type":"string",
            "description":"Country",
            "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"
                }
            }
        },
        "_Postal_Code":{
            "title":"Postal Code",
            "maxLength":360,
            "type":"string",
            "description":"Postal Code",
            "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_ColumnName":"POSTAL_CODE",
                "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"
                }
            }
        },
        "_Product_Item_ID":{
            "title":"Line Item ID",
            "type":"number",
            "description":"Line Item ID",
            "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_ColumnName":"INVENTORY_ITEM_ID",
                "FND_ACFF_SegmentName":"Product_Item_ID",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Product_Item_ID_Display":{
            "title":"Line Item ID",
            "type":"string",
            "description":"Line Item ID",
            "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"
                }
            }
        },
        "_Province":{
            "title":"Province",
            "maxLength":360,
            "type":"string",
            "description":"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_ColumnName":"PROVINCE",
                "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"
                }
            }
        },
        "_Sales_Channel":{
            "title":"Sales Channel",
            "maxLength":30,
            "type":"string",
            "description":"Sales Channel",
            "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_ColumnName":"SALES_CHANNEL",
                "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"
                }
            }
        },
        "_Shipping_Address":{
            "title":"Shipping Address Location",
            "type":"number",
            "description":"Shipping Address 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_ColumnName":"SHIP_TO_ADDRESS_ID",
                "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"
                }
            }
        },
        "_Shipping_Contact":{
            "title":"Customer Shipping Contact",
            "type":"number",
            "description":"Customer Shipping Contact",
            "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_ColumnName":"SHIP_TO_CONTACT_ID",
                "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":"Customer",
            "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_ColumnName":"CUSTOMER_ID",
                "FND_ACFF_SegmentName":"Sold_To_Customer",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "_Sold_To_Customer_Display":{
            "title":"Customer",
            "type":"string",
            "description":"Customer",
            "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"
                }
            }
        },
        "_State":{
            "title":"State",
            "maxLength":360,
            "type":"string",
            "description":"State",
            "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_ColumnName":"STATE",
                "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":"State",
            "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"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Business Unit Context for Base Transaction Attributes",
            "maxLength":30,
            "type":"string",
            "description":"Business Unit Context for Base Transaction Attributes",
            "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"
                }
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Business Unit Context for Base Transaction Attributes",
            "type":"string",
            "description":"Business Unit Context for Base Transaction Attributes",
            "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"
                }
            }
        }
    }
}

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

Type: object

Show Source

• AsynchronousRequestId: integer (int64)
  Read Only: true

  Indicates the request ID of the job used to execute the calculation simulation asynchronously.
• CalculationCurrencyCode: string
  Read Only: true

  Maximum Length: 15

  The participant's calculation currency code.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  Who column: indicates the date and time of the creation of the row.
• CurrentEarningsSumCalculation: number
  Read Only: true

  Current earnings in calculation currency
• CurrentEarningsSumHome: number
  Read Only: true

  The sum of the earnings in home currency already earned by a participant before the calculation simulation.
• EndPayPeriodId: integer (int64)
  Read Only: true

  The highest pay period ID for the earnings in this calculation simulation.
• ErrorCode: string
  Read Only: true

  Maximum Length: 30

  When the calculation simulation ends in error status, this value indicates the error type.
• GainSumCalculation: number
  Read Only: true

  Earnings gain in calculation currency
• GainSumHome: number
  Read Only: true

  The sum of the gain in home currency calculated during the calculation simulation.
• HomeCurrencyCode: string
  Read Only: true

  Maximum Length: 15

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

  Who column: indicates the date and time of the last update of the row.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who last updated the row.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Who column: indicates the session login associated to the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrgId: integer (int64)
  The unique identifier of the business unit.
• ProcessAuditId: integer (int64)
  Read Only: true

  Foreign key to relate the processing logs stored in cn_process_audits_all table.
• ProcessingDate: string (date-time)
  Read Only: true

  The date when this calculation simulation was processed.
• ProcessingStatus: string
  Maximum Length: 20

  Default Value: ORA_CN_NOT_READY

  The status of the calculation simulation, used to know if the simulation is ready to be processed, is being processed, has completed, or has ended in error.
• SimulationId: integer (int64)
  Read Only: true

  Unique identifier for a calculation simulation.
• SimulationType: string
  Maximum Length: 30

  Defines the type of processing that needs to be used in this simulation.
• StartPayPeriodId: integer (int64)
  Read Only: true

  The lowest pay period ID for the earnings in this calculation simulation.
• Transactions: array Participant Simulation Transactions
  Title: Participant Simulation Transactions

  The estimation transactions resource is used to view, create, update, and delete transactions associated with a calculation estimation.

{
    "type":"object",
    "properties":{
        "AsynchronousRequestId":{
            "type":"integer",
            "description":"Indicates the request ID of the job used to execute the calculation simulation asynchronously.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CalculationCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The participant's calculation currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Who column: indicates the date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentEarningsSumCalculation":{
            "type":"number",
            "description":"Current earnings in calculation currency",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentEarningsSumHome":{
            "type":"number",
            "description":"The sum of the earnings in home currency already earned by a participant before the calculation simulation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndPayPeriodId":{
            "type":"integer",
            "description":"The highest pay period ID for the earnings in this calculation simulation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorCode":{
            "maxLength":30,
            "type":"string",
            "description":"When the calculation simulation ends in error status, this value indicates the error type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GainSumCalculation":{
            "type":"number",
            "description":"Earnings gain in calculation currency",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GainSumHome":{
            "type":"number",
            "description":"The sum of the gain in home currency calculated during the calculation simulation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HomeCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The participant's home currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Who column: indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Who column: indicates the session login associated to the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ProcessAuditId":{
            "type":"integer",
            "description":"Foreign key to relate the processing logs stored in cn_process_audits_all table.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProcessingDate":{
            "type":"string",
            "description":"The date when this calculation simulation was processed.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessingStatus":{
            "maxLength":20,
            "type":"string",
            "description":"The status of the calculation simulation, used to know if the simulation is ready to be processed, is being processed, has completed, or has ended in error.",
            "nullable":true,
            "default":"ORA_CN_NOT_READY",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SimulationId":{
            "type":"integer",
            "description":"Unique identifier for a calculation simulation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SimulationType":{
            "maxLength":30,
            "type":"string",
            "description":"Defines the type of processing that needs to be used in this simulation.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartPayPeriodId":{
            "type":"integer",
            "description":"The lowest pay period ID for the earnings in this calculation simulation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Transactions":{
            "title":"Participant Simulation Transactions",
            "type":"array",
            "description":"The estimation transactions resource is used to view, create, update, and delete transactions associated with a calculation estimation.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationEstimations-Transactions-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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 : Participant Simulation Transactions

Type: array

Title: Participant Simulation Transactions

The estimation transactions resource is used to view, create, update, and delete transactions associated with a calculation estimation.

Show Source

• Array of: object incentiveCompensationEstimations-Transactions-item-response

{
    "title":"Participant Simulation Transactions",
    "type":"array",
    "description":"The estimation transactions resource is used to view, create, update, and delete transactions associated with a calculation estimation.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationEstimations-Transactions-item-response"
    }
}

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

Type: object

Show Source

• AdjustmentComments: string
  Maximum Length: 1000

  Reason for adjustment
• AdjustmentReasonCode: string
  Maximum Length: 30

  Adjustment reason code
• AdjustmentStatus: string
  Maximum Length: 30

  Adjustment status
• BookedDate: string (date-time)
  Date order gets booked
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  Who column: indicates the date and time of the creation of the row.
• CreditDate: string (date-time)
  Date based on which crediting rule will be determined.
• Credits: array Participant Simulation Credits
  Title: Participant Simulation Credits

  The estimation credits resource is used to view, create, update, and delete credits of a calculation estimation.
• DiscountPercentage: number
  Discount percentage, exposed in UI
• EligibleCategoryId: integer (int64)
  The unique identifier of the eligible credit category.
• InvoiceDate: string (date-time)
  Invoice date
• InvoiceNumber: string
  Maximum Length: 30

  Unique identifier for invoice
• LastUpdateDate: string (date-time)
  Read Only: true

  Who column: indicates the date and time of the last update of the row.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who last updated the row.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Who column: indicates the session login associated to the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MarginPercentage: number
  Margin Percentage, exposed in UI
• ObjectStatus: string
  Read Only: true

  Maximum Length: 30

  The status of the transaction. Possible values are calculated, calculation error, posted,and reversed.
• OrderNumber: string
  Maximum Length: 30

  Unique identifier for order
• ParticipantId: integer (int64)
  The unique identifier of the participant with whom the earnings are associated.
• RollupDate: string (date-time)
  Date based on which rollup hierarchy will be determined
• SimulationId: integer (int64)
  Unique identifier for a calculation simulation.
• SimulationTransactionDFF: array SimulationTransactionDFF
• SourceCurrencyCode: string
  Maximum Length: 15

  Currency code in which the source amounts are specified.
• SourceEventDate: string (date-time)
  The date when transaction was processed.
• TerrId: integer (int64)
  Unique identifier of territory
• TerrName: string
  Maximum Length: 1000

  Territory name
• TransactionAmountSource: number
  Transaction amount in source currency
• TransactionId: integer (int64)
  Points to the base transaction from which the earning is generated.
• TransactionNumber: string
  Maximum Length: 30

  Transaction number
• TransactionQuantity: number
  The quantity of the unit sold in the transaction.
• TransactionType: string
  Maximum Length: 30

  The transaction type identifying the source of the transaction.
• UOMCode: string
  Maximum Length: 10

  Unit of Measure

{
    "type":"object",
    "properties":{
        "AdjustmentComments":{
            "maxLength":1000,
            "type":"string",
            "description":"Reason for adjustment",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Adjustment reason code",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Adjustment status",
            "nullable":true,
            "x-queryable":true
        },
        "BookedDate":{
            "type":"string",
            "description":"Date order gets booked",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Who column: indicates the date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditDate":{
            "type":"string",
            "description":"Date based on which crediting rule will be determined.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Credits":{
            "title":"Participant Simulation Credits",
            "type":"array",
            "description":"The estimation credits resource is used to view, create, update, and delete credits of a calculation estimation.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationEstimations-Transactions-Credits-item-response"
            }
        },
        "DiscountPercentage":{
            "type":"number",
            "description":"Discount percentage, exposed in UI",
            "nullable":true,
            "x-queryable":true
        },
        "EligibleCategoryId":{
            "type":"integer",
            "description":"The unique identifier of the eligible credit category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "InvoiceDate":{
            "type":"string",
            "description":"Invoice date",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for invoice",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Who column: indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Who column: indicates the session login associated to the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MarginPercentage":{
            "type":"number",
            "description":"Margin Percentage, exposed in UI",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the transaction. Possible values are calculated, calculation error, posted,and reversed.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrderNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier for order",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant with whom the earnings are associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "RollupDate":{
            "type":"string",
            "description":"Date based on which rollup hierarchy will be determined",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SimulationId":{
            "type":"integer",
            "description":"Unique identifier for a calculation simulation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SimulationTransactionDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationEstimations-Transactions-SimulationTransactionDFF-item-response"
            }
        },
        "SourceCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Currency code in which the source amounts are specified.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceEventDate":{
            "type":"string",
            "description":"The date when transaction was processed.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "TerrId":{
            "type":"integer",
            "description":"Unique identifier of territory",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TerrName":{
            "maxLength":1000,
            "type":"string",
            "description":"Territory name",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionAmountSource":{
            "type":"number",
            "description":"Transaction amount in source currency",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Points to the base transaction from which the earning is generated.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionNumber":{
            "maxLength":30,
            "type":"string",
            "description":"Transaction number",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionQuantity":{
            "type":"number",
            "description":"The quantity of the unit sold in the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":30,
            "type":"string",
            "description":"The transaction type identifying the source of the transaction.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":10,
            "type":"string",
            "description":"Unit of Measure",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Participant Simulation Credits

Type: array

Title: Participant Simulation Credits

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

Show Source

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

{
    "title":"Participant Simulation Credits",
    "type":"array",
    "description":"The estimation credits resource is used to view, create, update, and delete credits of a calculation estimation.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationEstimations-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 : SimulationTransactionDFF

Type: array

Show Source

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

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationEstimations-Transactions-SimulationTransactionDFF-item-response"
    }
}

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

Type: object

Show Source

• AdjustmentComments: string
  Maximum Length: 1000

  Reason for adjustment
• AdjustmentReasonCode: string
  Maximum Length: 30

  Adjustment reason code
• AdjustmentStatus: string
  Maximum Length: 30

  Adjustment status
• CalculationCurrencyCode: string
  Read Only: true

  Maximum Length: 15

  The participant's calculation currency code.
• CalculationToHomeRate: number
  Read Only: true

  Calculation currency to home currency conversion rate.
• CalculationToSourceRate: number
  Read Only: true

  Calculation currency to source currency conversion rate.
• CollectionStatus: string
  Maximum Length: 30

  Collection status of the transaction
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  Who column: indicates the date and time of the creation of the row.
• CreditAmountCalculation: number
  Credit amount in calculation currency
• CreditAmountHome: number
  Read Only: true

  Credit amount in home currency
• CreditAmountSource: number
  Read Only: true

  Credit amount in source currency
• CreditDate: string (date-time)
  Date based on which crediting rule will be determined.
• CreditedParticipantId: integer (int64)
  Unique identifier for credited sales rep
• CreditId: integer (int64)
  Generated from the sequence
• CreditType: string
  Maximum Length: 30

  Default Value: DIRECT

  Possible values: Direct, Indirect, and Summarized
• EligibleCategoryId: integer (int64)
  The unique identifier of the eligible credit category.
• HomeCurrencyCode: string
  Read Only: true

  Maximum Length: 15

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

  Who column: indicates the date and time of the last update of the row.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Who column: indicates the user who last updated the row.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Who column: indicates the session login associated to the user who last updated the row.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectStatus: string
  Read Only: true

  Maximum Length: 30

  The status of the transaction. Possible values are calculated, calculation error, posted,and reversed.
• ObjectVersionNumber: integer (int32)
  Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.
• ParticipantId: integer (int64)
  The unique identifier of the participant with whom the earnings are associated.
• RevenueType: string
  Maximum Length: 30

  The possible values are revenue, nonrevenue, and custom revenue types.
• RollupDate: string (date-time)
  Date based on which rollup hierarchy will be determined
• RollupLevel: integer (int64)
  Level in the hierarchy in case of rollup credits
• SimulationId: integer (int64)
  Unique identifier for a calculation simulation.
• SourceCurrencyCode: string
  Maximum Length: 15

  Currency code in which the source amounts are specified.
• SourceEventDate: string (date-time)
  The date when transaction was processed.
• SourceToCalculationRate: number
  Read Only: true

  Source currency to calculation currency conversion rate.
• SourceToHomeRate: number
  Read Only: true

  Source currency to home currency conversion rate.
• SourceTrxNumber: string
  Read Only: true

  Maximum Length: 30

  The source_trx_number info about the transaction.
• SplitPct: number
  Default Value: 100

  Split percentage
• TransactionId: integer (int64)
  Read Only: true

  Points to the base transaction from which the earning is generated.

{
    "type":"object",
    "properties":{
        "AdjustmentComments":{
            "maxLength":1000,
            "type":"string",
            "description":"Reason for adjustment",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"Adjustment reason code",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Adjustment status",
            "nullable":true,
            "x-queryable":true
        },
        "CalculationCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The participant's calculation currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculationToHomeRate":{
            "type":"number",
            "description":"Calculation currency to home currency conversion rate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculationToSourceRate":{
            "type":"number",
            "description":"Calculation currency to source currency conversion rate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CollectionStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Collection status of the transaction",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Who column: indicates the date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditAmountCalculation":{
            "type":"number",
            "description":"Credit amount in calculation currency",
            "nullable":true,
            "x-queryable":true
        },
        "CreditAmountHome":{
            "type":"number",
            "description":"Credit amount in home currency",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditAmountSource":{
            "type":"number",
            "description":"Credit amount in source currency",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditDate":{
            "type":"string",
            "description":"Date based on which crediting rule will be determined.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CreditId":{
            "type":"integer",
            "description":"Generated from the sequence",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditType":{
            "maxLength":30,
            "type":"string",
            "description":"Possible values: Direct, Indirect, and Summarized",
            "nullable":false,
            "default":"DIRECT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CreditedParticipantId":{
            "type":"integer",
            "description":"Unique identifier for credited sales rep",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "EligibleCategoryId":{
            "type":"integer",
            "description":"The unique identifier of the eligible credit category.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "HomeCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The participant's home currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Who column: indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Who column: indicates the session login associated to the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the transaction. Possible values are calculated, calculation error, posted,and reversed.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Used to implement optimistic locking. This number is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "ParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant with whom the earnings are associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "RevenueType":{
            "maxLength":30,
            "type":"string",
            "description":"The possible values are revenue, nonrevenue, and custom revenue types.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "RollupDate":{
            "type":"string",
            "description":"Date based on which rollup hierarchy will be determined",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RollupLevel":{
            "type":"integer",
            "description":"Level in the hierarchy in case of rollup credits",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SimulationId":{
            "type":"integer",
            "description":"Unique identifier for a calculation simulation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Currency code in which the source amounts are specified.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceEventDate":{
            "type":"string",
            "description":"The date when transaction was processed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SourceToCalculationRate":{
            "type":"number",
            "description":"Source currency to calculation currency conversion rate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceToHomeRate":{
            "type":"number",
            "description":"Source currency to home currency conversion rate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTrxNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The source_trx_number info about the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SplitPct":{
            "type":"number",
            "description":"Split percentage",
            "nullable":true,
            "default":100,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"Points to the base transaction from which the earning is generated.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

Type: object

Show Source

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

  Maximum Length: 30

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

  Business Unit Context for Base Transaction Attributes
• _Area_Code: string
  Title: Area Code

  Maximum Length: 360

  Area Code
• _Billing_Address: number
  Title: Customer Billing Address Location

  Customer Billing Address Location
• _Billing_Contact: number
  Title: Customer Billing Contact

  Customer Billing Contact
• _City: string
  Title: City

  Maximum Length: 360

  City
• _City_Display: string
  Title: City

  City
• _Country: string
  Title: Country

  Maximum Length: 360

  Country
• _Country_Display: string
  Title: Country

  Country
• _Postal_Code: string
  Title: Postal Code

  Maximum Length: 360

  Postal Code
• _Product_Item_ID: number
  Title: Line Item ID

  Line Item ID
• _Product_Item_ID_Display: string
  Title: Line Item ID

  Line Item ID
• _Province: string
  Title: Province

  Maximum Length: 360

  Province
• _Sales_Channel: string
  Title: Sales Channel

  Maximum Length: 30

  Sales Channel
• _Shipping_Address: number
  Title: Shipping Address Location

  Shipping Address Location
• _Shipping_Contact: number
  Title: Customer Shipping Contact

  Customer Shipping Contact
• _Sold_To_Customer: number
  Title: Customer

  Customer
• _Sold_To_Customer_Display: string
  Title: Customer

  Customer
• _State: string
  Title: State

  Maximum Length: 360

  State
• _State_Display: string
  Title: State

  State
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SimulationId: integer (int64)
• TransactionId: integer (int64)

{
    "type":"object",
    "properties":{
        "SimulationId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "_Area_Code":{
            "title":"Area Code",
            "maxLength":360,
            "type":"string",
            "description":"Area Code",
            "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_ColumnName":"AREA_CODE",
                "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
        },
        "_Billing_Address":{
            "title":"Customer Billing Address Location",
            "type":"number",
            "description":"Customer Billing Address 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_ColumnName":"BILL_TO_ADDRESS_ID",
                "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
        },
        "_Billing_Contact":{
            "title":"Customer Billing Contact",
            "type":"number",
            "description":"Customer Billing Contact",
            "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_ColumnName":"BILL_TO_CONTACT_ID",
                "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
        },
        "_City":{
            "title":"City",
            "maxLength":360,
            "type":"string",
            "description":"City",
            "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_ColumnName":"CITY",
                "FND_ACFF_SegmentName":"City",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "_City_Display":{
            "title":"City",
            "type":"string",
            "description":"City",
            "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
        },
        "_Country":{
            "title":"Country",
            "maxLength":360,
            "type":"string",
            "description":"Country",
            "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_ColumnName":"COUNTRY",
                "FND_ACFF_SegmentName":"Country",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "_Country_Display":{
            "title":"Country",
            "type":"string",
            "description":"Country",
            "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
        },
        "_Postal_Code":{
            "title":"Postal Code",
            "maxLength":360,
            "type":"string",
            "description":"Postal Code",
            "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_ColumnName":"POSTAL_CODE",
                "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
        },
        "_Product_Item_ID":{
            "title":"Line Item ID",
            "type":"number",
            "description":"Line Item ID",
            "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_ColumnName":"INVENTORY_ITEM_ID",
                "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
        },
        "_Product_Item_ID_Display":{
            "title":"Line Item ID",
            "type":"string",
            "description":"Line Item ID",
            "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
        },
        "_Province":{
            "title":"Province",
            "maxLength":360,
            "type":"string",
            "description":"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_ColumnName":"PROVINCE",
                "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
        },
        "_Sales_Channel":{
            "title":"Sales Channel",
            "maxLength":30,
            "type":"string",
            "description":"Sales Channel",
            "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_ColumnName":"SALES_CHANNEL",
                "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
        },
        "_Shipping_Address":{
            "title":"Shipping Address Location",
            "type":"number",
            "description":"Shipping Address 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_ColumnName":"SHIP_TO_ADDRESS_ID",
                "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
        },
        "_Shipping_Contact":{
            "title":"Customer Shipping Contact",
            "type":"number",
            "description":"Customer Shipping Contact",
            "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_ColumnName":"SHIP_TO_CONTACT_ID",
                "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":"Customer",
            "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_ColumnName":"CUSTOMER_ID",
                "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
        },
        "_Sold_To_Customer_Display":{
            "title":"Customer",
            "type":"string",
            "description":"Customer",
            "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
        },
        "_State":{
            "title":"State",
            "maxLength":360,
            "type":"string",
            "description":"State",
            "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_ColumnName":"STATE",
                "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":"State",
            "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
        },
        "__FLEX_Context":{
            "title":"Business Unit Context for Base Transaction Attributes",
            "maxLength":30,
            "type":"string",
            "description":"Business Unit Context for Base Transaction Attributes",
            "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
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Business Unit Context for Base Transaction Attributes",
            "type":"string",
            "description":"Business Unit Context for Base Transaction Attributes",
            "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
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

SalesRepBusinessUnitPVO

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationSalesrepBusinessUnitsLOV

The following properties are defined on the LOV link relation:

• Source Attribute: OrgId; Target Attribute: OrgId
• Display Attribute: OrgName

SimulationProcessStatusVVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_CN_CALC_SIMULATION_STATUS

The following properties are defined on the LOV link relation:

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

SimulationTypeVVO

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DORA_CN_CALC_SIMULATION_TYPE

The following properties are defined on the LOV link relation:

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

Transactions

Operation: /fscmRestApi/resources/11.13.18.05/incentiveCompensationEstimations/{SimulationId}/child/Transactions

Parameters:

• SimulationId: $request.path.SimulationId

The estimation transactions resource is used to view, create, update, and delete transactions associated with a calculation estimation.

Back to Top