Jump to

• Request
• Response

Get all calculation simulations

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations

Request

Query Parameters

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

  • PrimaryKey: Finds a calculation simulation with the specified primary key.
    Finder Variables:
    • SimulationId; integer; The unique identifier of the calculation simulation.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AsynchronousRequestId; integer; Indicates the request ID of the job used to execute the calculation simulation asynchronously.
  • CalculationCurrencyCode; string; Calculation currency code.
  • CreatedBy; string; The user who created the calculation simulation.
  • CreationDate; string; The date and time when the calculation simulation was created.
  • CurrentEarningsSumCalculation; number; The sum of the earnings in calculation currency already earned by a participant before the calculation simulation.
  • CurrentEarningsSumFunctional; number; The sum of the earnings in functional currency already earned by a participant before the calculation simulation.
  • CurrentEarningsSumHome; number; The sum of the earnings in home currency already earned by a participant before the calculation simulation.
  • EndPayPeriodId; integer; The highest pay period id for the earnings in this calculation simulation.
  • ErrorCode; string; When the calculation simulation ends in error or warning status, this value indicates the error type. If any simulation transactions or credits are in classification error, this value will be ORA_CN_CLASSIFICATION. If any simulation transactions or credits are in eligibility error, this value will be ORA_CN_ELIGIBILITY. If there are simulation earnings in error, or no simulation earnings at all this value will move to ORA_CN_SETUP. If the calculation simulation completes successfully but the results use different currencies, the value will be ORA_CN_MULTI_CURRENCY to indicate the reason why some of the aggregated columns for current earnings or gain cannot be calculated.
  • GainSumCalculation; number; The sum of the gain in calculation currency calculated during the calculation simulation.
  • GainSumFunctional; number; The sum of the gain in functional currency calculated during the calculation simulation.
  • GainSumHome; number; The sum of the gain in home currency calculated during the calculation simulation.
  • HomeCurrencyCode; string; Participant's home currency code.
  • IsLatestFlag; boolean; Indicates whether a simulation is the latest among all simulations processed which have the same SimulationName value.
  • LastUpdateDate; string; The date and time when the calculation simulation was last updated.
  • LastUpdateLogin; string; The login of the user who last updated the calculation simulation.
  • LastUpdatedBy; string; The user who last updated the calculation simulation.
  • OrgId; integer; The unique identifier of the business unit associated with the simulation.
  • ProcessAuditId; integer; The unique identifier of the process audit used to find the process audit logs.
  • ProcessingDate; string; The date when the simulation was processed.
  • ProcessingStatus; string; The status of the simulation process. The default value is ORA_CN_NOT_READY which indicates the simulation shouldn't run when the resource is created or updated. ORA_CN_READY indicates that the calculation simulation process must be executed when the resource is created or updated. Value ORA_CN_SCHEDULE means the calculation simulation process is ready to be scheduled to run as an asynchronous job. The simulation process will change the processing status to ORA_CN_STARTED while the simulation runs, and move it to a terminal state once it ends. Terminal states are ORA_CN_COMPLETE for successful execution, ORA_CN_WARNING if some of the simulation credits were processed but others ended in error, and ORA_CN_ERROR if no simulation credits were processed due to errors. If the status ends in ORA_CN_WARNING or ORA_CN_ERROR use ErrorCode field to identify the type of error. Moving a simulation to status ORA_CN_READY after the simulation process has already run will always end in error as a simulation can be run only once.
  • SimulationId; integer; The unique identifier of the calculation simulation.
  • SimulationName; string; An optional user-friendly name to identify the calculation simulation. At the time the simulation is processed, the field IsLatestFlag will be set to 'N' for all the existing simulations using the same name, while it will be set to 'Y' for the current calculation simulation.
  • SimulationType; string; The type of the calculation simulation. Use value ORA_CN_ESTIMATION to get estimated earnings for all the periods that the estimated transaction could affect. Use value ORA_CN_ESTIMATION_LIMITED to limit the estimated earnings to only the next payment period based on the plan component's payout frequency. For example - for a plan component with a quarterly payout frequency but having annual performance measures, if you are estimating a transaction in Q2, using ORA_CN_ESTIMATION in simulation type will return estimated earning results for Q1, Q2, Q3 and Q4. However using ORA_CN_ESTIMATION_LIMITED will return results for just Q2 and also estimate faster.
  • StartPayPeriodId; integer; The lowest pay period id for the earnings in this calculation simulation.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

• 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : incentiveCompensationCalculationSimulations

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationCalculationSimulations-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object incentiveCompensationCalculationSimulations-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationCalculationSimulations-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 : incentiveCompensationCalculationSimulations-item-response

Type: object

Show Source

• AsynchronousRequestId: integer (int64)
  Indicates the request ID of the job used to execute the calculation simulation asynchronously.
• CalculationCurrencyCode: string
  Maximum Length: 15

  Calculation currency code.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date and time when the calculation simulation was created.
• CurrentEarningsSumCalculation: number
  The sum of the earnings in calculation currency already earned by a participant before the calculation simulation.
• CurrentEarningsSumFunctional: number
  The sum of the earnings in functional currency already earned by a participant before the calculation simulation.
• CurrentEarningsSumHome: number
  The sum of the earnings in home currency already earned by a participant before the calculation simulation.
• Earnings: array Simulation Earnings
  Title: Simulation Earnings

  The simulation earnings resource is used to view all the earnings in a calculation simulation.
• EndPayPeriodId: integer (int64)
  The highest pay period id for the earnings in this calculation simulation.
• ErrorCode: string
  Maximum Length: 30

  When the calculation simulation ends in error or warning status, this value indicates the error type. If any simulation transactions or credits are in classification error, this value will be ORA_CN_CLASSIFICATION. If any simulation transactions or credits are in eligibility error, this value will be ORA_CN_ELIGIBILITY. If there are simulation earnings in error, or no simulation earnings at all this value will move to ORA_CN_SETUP. If the calculation simulation completes successfully but the results use different currencies, the value will be ORA_CN_MULTI_CURRENCY to indicate the reason why some of the aggregated columns for current earnings or gain cannot be calculated.
• GainSumCalculation: number
  The sum of the gain in calculation currency calculated during the calculation simulation.
• GainSumFunctional: number
  The sum of the gain in functional currency calculated during the calculation simulation.
• GainSumHome: number
  The sum of the gain in home currency calculated during the calculation simulation.
• HomeCurrencyCode: string
  Maximum Length: 15

  Participant's home currency code.
• IsLatestFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether a simulation is the latest among all simulations processed which have the same SimulationName value.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the calculation simulation was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• MeasureResults: array Simulation Meause Results
  Title: Simulation Meause Results

  The simulation measure results resource is used to view measure results of a calculation simulation.
• OrgId: integer (int64)
  The unique identifier of the business unit associated with the simulation.
• ProcessAuditId: integer (int64)
  The unique identifier of the process audit used to find the process audit logs.
• ProcessingDate: string (date-time)
  The date when the simulation was processed.
• ProcessingStatus: string
  Maximum Length: 20

  Default Value: ORA_CN_NOT_READY

  The status of the simulation process. The default value is ORA_CN_NOT_READY which indicates the simulation shouldn't run when the resource is created or updated. ORA_CN_READY indicates that the calculation simulation process must be executed when the resource is created or updated. Value ORA_CN_SCHEDULE means the calculation simulation process is ready to be scheduled to run as an asynchronous job. The simulation process will change the processing status to ORA_CN_STARTED while the simulation runs, and move it to a terminal state once it ends. Terminal states are ORA_CN_COMPLETE for successful execution, ORA_CN_WARNING if some of the simulation credits were processed but others ended in error, and ORA_CN_ERROR if no simulation credits were processed due to errors. If the status ends in ORA_CN_WARNING or ORA_CN_ERROR use ErrorCode field to identify the type of error. Moving a simulation to status ORA_CN_READY after the simulation process has already run will always end in error as a simulation can be run only once.
• SimulationId: integer (int64)
  The unique identifier of the calculation simulation.
• SimulationName: string
  Maximum Length: 160

  An optional user-friendly name to identify the calculation simulation. At the time the simulation is processed, the field IsLatestFlag will be set to 'N' for all the existing simulations using the same name, while it will be set to 'Y' for the current calculation simulation.
• SimulationType: string
  Maximum Length: 30

  The type of the calculation simulation. Use value ORA_CN_ESTIMATION to get estimated earnings for all the periods that the estimated transaction could affect. Use value ORA_CN_ESTIMATION_LIMITED to limit the estimated earnings to only the next payment period based on the plan component's payout frequency. For example - for a plan component with a quarterly payout frequency but having annual performance measures, if you are estimating a transaction in Q2, using ORA_CN_ESTIMATION in simulation type will return estimated earning results for Q1, Q2, Q3 and Q4. However using ORA_CN_ESTIMATION_LIMITED will return results for just Q2 and also estimate faster.
• StartPayPeriodId: integer (int64)
  The lowest pay period id for the earnings in this calculation simulation.
• Transactions: array Simulation Transactions
  Title: Simulation Transactions

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the calculation simulation was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IsLatestFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a simulation is the latest among all simulations processed which have the same SimulationName value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentEarningsSumCalculation":{
            "type":"number",
            "description":"The sum of the earnings in calculation currency already earned by a participant before the calculation simulation.",
            "nullable":true,
            "x-queryable":true
        },
        "GainSumFunctional":{
            "type":"number",
            "description":"The sum of the gain in functional currency calculated during the calculation simulation.",
            "nullable":true,
            "x-queryable":true
        },
        "HomeCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Participant's home currency code.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessAuditId":{
            "type":"integer",
            "description":"The unique identifier of the process audit used to find the process audit logs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SimulationType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the calculation simulation. \nUse value ORA_CN_ESTIMATION to get estimated earnings for all the periods that the estimated transaction could affect. Use value  ORA_CN_ESTIMATION_LIMITED to limit the estimated earnings to only the next payment period based on the plan component's payout frequency. For example - for a plan component with a quarterly payout frequency but having annual performance measures, if you are estimating a transaction in Q2, using ORA_CN_ESTIMATION in simulation type will return estimated earning results for Q1, Q2, Q3 and Q4. However using ORA_CN_ESTIMATION_LIMITED will return results for just Q2 and also estimate faster.",
            "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,
            "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"
            }
        },
        "CurrentEarningsSumHome":{
            "type":"number",
            "description":"The sum of the earnings in home currency already earned by a participant before the calculation simulation.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessingStatus":{
            "maxLength":20,
            "type":"string",
            "description":"The status of the simulation process. The default value is ORA_CN_NOT_READY which indicates the simulation shouldn't run when the resource is created or updated. ORA_CN_READY indicates that the calculation simulation process must be executed when the resource is created or updated. Value ORA_CN_SCHEDULE means the calculation simulation process is ready to be scheduled to run as an asynchronous job. The simulation process will change the processing status to ORA_CN_STARTED while the simulation runs, and move it to a terminal state once it ends. Terminal states are ORA_CN_COMPLETE for successful execution, ORA_CN_WARNING if some of the simulation credits were processed but others ended in error, and ORA_CN_ERROR if no simulation credits were processed due to errors. If the status ends in ORA_CN_WARNING or ORA_CN_ERROR use ErrorCode field to identify the type of error. Moving a simulation to status ORA_CN_READY after the simulation process has already run will always end in error as a simulation can be run only once.",
            "nullable":true,
            "default":"ORA_CN_NOT_READY",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndPayPeriodId":{
            "type":"integer",
            "description":"The highest pay period id for the earnings in this calculation simulation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SimulationName":{
            "maxLength":160,
            "type":"string",
            "description":"An optional user-friendly name to identify the calculation simulation. At the time the simulation is processed, the field IsLatestFlag will be set to 'N' for all the existing simulations using the same name, while it will be set to 'Y' for the current calculation simulation.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the calculation simulation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrentEarningsSumFunctional":{
            "type":"number",
            "description":"The sum of the earnings in functional currency already earned by a participant before the calculation simulation.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the calculation simulation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "GainSumHome":{
            "type":"number",
            "description":"The sum of the gain in home currency calculated during the calculation simulation.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcessingDate":{
            "type":"string",
            "description":"The date when the simulation was processed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "CalculationCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Calculation currency code.",
            "nullable":true,
            "x-queryable":true
        },
        "MeasureResults":{
            "title":"Simulation Meause Results",
            "type":"array",
            "description":"The simulation measure results resource is used to view measure results of a calculation simulation.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationCalculationSimulations-MeasureResults-item-response"
            }
        },
        "OrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the simulation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "Transactions":{
            "title":"Simulation Transactions",
            "type":"array",
            "description":"The simulation transactions resource is used to view, create, update, and delete transactions associated with a calculation simulation.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationCalculationSimulations-Transactions-item-response"
            }
        },
        "GainSumCalculation":{
            "type":"number",
            "description":"The sum of the gain in calculation currency calculated during the calculation simulation.",
            "nullable":true,
            "x-queryable":true
        },
        "SimulationId":{
            "type":"integer",
            "description":"The unique identifier of the calculation simulation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ErrorCode":{
            "maxLength":30,
            "type":"string",
            "description":"When the calculation simulation ends in error or warning status, this value indicates the error type. If any simulation transactions or credits are in classification error, this value will be ORA_CN_CLASSIFICATION. If any simulation transactions or credits are in eligibility error, this value will be ORA_CN_ELIGIBILITY. If there are simulation earnings in error, or no simulation earnings at all this value will move to ORA_CN_SETUP. If the calculation simulation completes successfully but the results use different currencies, the value will be ORA_CN_MULTI_CURRENCY to indicate the reason why some of the aggregated columns for current earnings or gain cannot be calculated.",
            "nullable":true,
            "x-queryable":true
        },
        "AsynchronousRequestId":{
            "type":"integer",
            "description":"Indicates the request ID of the job used to execute the calculation simulation asynchronously.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Earnings":{
            "title":"Simulation Earnings",
            "type":"array",
            "description":"The simulation earnings resource is used to view all the earnings in a calculation simulation.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationCalculationSimulations-Earnings-item-response"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the calculation simulation was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the calculation simulation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Simulation Earnings

Type: array

Title: Simulation Earnings

The simulation earnings resource is used to view all the earnings in a calculation simulation.

Show Source

• Array of: object incentiveCompensationCalculationSimulations-Earnings-item-response

{
    "title":"Simulation Earnings",
    "type":"array",
    "description":"The simulation earnings resource is used to view all the earnings in a calculation simulation.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationCalculationSimulations-Earnings-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Simulation Meause Results

Type: array

Title: Simulation Meause Results

The simulation measure results resource is used to view measure results of a calculation simulation.

Show Source

• Array of: object incentiveCompensationCalculationSimulations-MeasureResults-item-response

{
    "title":"Simulation Meause Results",
    "type":"array",
    "description":"The simulation measure results resource is used to view measure results of a calculation simulation.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationCalculationSimulations-MeasureResults-item-response"
    }
}

Nested Schema : Simulation Transactions

Type: array

Title: Simulation Transactions

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

Show Source

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

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

Nested Schema : incentiveCompensationCalculationSimulations-Earnings-item-response

Type: object

Show Source

• CalculationCurrency: string
  Read Only: true

  Maximum Length: 15

  The code indicating the processing currency of the earning amounts. The processing currency is selected as either the operating currency or the participant home currency for the business unit. Review the processing currency parameter using the Setup and Maintenance work area, Manage Parameters task.
• CommissionValue: number
  Read Only: true

  The incentive rate table amount, or the percentage, that was used to calculate the earning amount.
• CompensationPlanId: integer (int64)
  Read Only: true

  The unique identifier of the compensation plan for which the earnings are calculated.
• CompensationPlanName: string
  Title: Compensation Plan

  Read Only: true

  Maximum Length: 80

  The name of the compensation plan for which the earnings are calculated.
• ConversionRate: number
  Read Only: true

  The exchange rate to convert the processing currency into operating currency.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the simulation earning.
• CreatedDuring: string
  Read Only: true

  Maximum Length: 30

  The phase during which this record was created. The possible values are Rollup, Eligibility, Calculation.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the simulation earning was created.
• CreditAmount: number
  Read Only: true

  The credit amount expressed in processing currency.
• CreditedParticipantId: integer (int64)
  Read Only: true

  The unique identifier of the participant.
• EarningAmount: number
  Read Only: true

  The amount earned, expressed in processing currency.
• EarningId: integer (int64)
  Read Only: true

  The unique identifier of an earning in a calculation simulation.
• EarningType: string
  Read Only: true

  Maximum Length: 30

  The type of earning type for the plan component. This value is used to classify earnings into monetary and nonmonetary categories.
• EarningTypeId: integer (int64)
  Read Only: true

  The unique identifier of the type of earning.
• EligibleCatId: integer (int64)
  Read Only: true

  The unique identifier of the credit category.
• ErrorReason: string
  Read Only: true

  Maximum Length: 150

  The reason explaining why the earning is in error status.
• FormulaEcatId: integer (int64)
  Read Only: true

  The unique identifier of the credit category of a plan component.
• FormulaId: integer (int64)
  Read Only: true

  The unique identifier of the incentive formula.
• FormulaWeight: number
  Read Only: true

  The percentage of influence a plan component has on the compensation plan, also called target incentive percent.
• HomeCurrencyCode: string
  Read Only: true

  Maximum Length: 15

  The code indicating the participant home currency that is in effect as of the source event date of the payment transaction. Review the effective participant attributes using the Participant Snapshot work area, Manage Participant Detail page.
• HomeCurrencyConversionRate: number
  Read Only: true

  The exchange rate to convert the processing currency into home currency.
• HomeEarningAmount: number
  Read Only: true

  The amount earned, expressed in participant home currency.
• InputAchieved: number
  Read Only: true

  The amount passed to the rate table to calculate the earnings based on the input expression defined in the plan component.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the simulation earning.
• links: array Links
  Title: Links

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

  Maximum Length: 30

  The current status of the earnings record, such as calculated, calculation error, eligible, or reversed. Review the available lookup codes for the lookup type CN_TP_EARNING_OBJECT_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• ObjectStatusMeaning: string
  Read Only: true

  Maximum Length: 80

  The display label for the process status lookup code.
• OperatingEarningAmount: number
  Read Only: true

  The amount earned, expressed in business unit operating currency.
• OutputAchieved: number
  Read Only: true

  The amount calculated by the earnings expression of an incentive formula.
• ParticipantId: integer (int64)
  Read Only: true

  The unique identifier of the incentive compensation participant who received direct credit for the source transaction.
• ParticipantName: string
  Title: Participant Name

  Read Only: true

  Maximum Length: 360

  The name of the incentive compensation credit receiver.
• PayPeriodId: integer (int64)
  Read Only: true

  The unique identifier of the pay period. The period number represents the calendar period the pay sheet and payment batch are for. The period numbers are generated when you define your incentive compensation calendar using the Setup and Maintenance work area, Manage Calendars task. For example, the period number 2018001 represents the first period in the year 2018.
• PlanComponentId: integer (int64)
  Read Only: true

  The unique identifier of the plan component for which the earnings are calculated.
• PlanComponentName: string
  Title: Plan Component

  Read Only: true

  Maximum Length: 80

  The name of the plan component for which the earnings are calculated.
• PostingStatus: string
  Read Only: true

  Maximum Length: 1

  The status indicating whether the earning was included in the payment process. If true then the earning was included in the payment. Possible values include false and true.
• ProcessCode: string
  Read Only: true

  Maximum Length: 30

  The code indicating the process of the source transaction, such as to override classification, crediting, and rollup processing.
• SimulationDeleteFlag: boolean
  Read Only: true

  Maximum Length: 1

  Default Value: false

  Indicates whether an earning is deleted during calculation simulation processing.
• SimulationId: integer (int64)
  Read Only: true

  The unique identifier of the simulation to which the simulation earning belongs.
• SimulationResultType: string
  Read Only: true

  Maximum Length: 30

  Indicates whether a measure result comes from the simulation execution or from the existing calculated measure result.
• SourceEventDate: string (date-time)
  Read Only: true

  The date when the earning event occurred. The event date is either the source transaction event date or the calculation grouping event date which resulted in the incentive earning.
• SourceEventPeriodId: integer (int64)
  Read Only: true

  The unique identifier of the calendar period when the transaction event date falls.
• SourceOrgId: integer (int64)
  Read Only: true

  The unique identifier of the source business unit of the transaction.
• SourceTrxNumber: string
  Read Only: true

  Maximum Length: 30

  The transaction number which resulted in the incentive earnings.
• SplitPct: number
  Read Only: true

  The percentage number applied against the transaction amount to calculate the credit amount.
• SrpAlternatePayeeId: integer (int64)
  Read Only: true

  The unique identifier of the alternate person who is eligible to receive payment for this earnings.
• SrpCompensationPlanId: integer (int64)
  Read Only: true

  The unique identifier of the assignment of the compensation plan to the participant.
• TierSplits: integer (int64)
  Read Only: true

  The number of rate tiers used to calculate the earning rate.
• TransactionAmount: number
  Read Only: true

  The transaction amount expressed in processing currency.
• TransactionId: integer (int64)
  Read Only: true

  The unique identifier of the transaction.
• TransactionType: string
  Read Only: true

  Maximum Length: 30

  The type of the transaction. This value indicates the source of the transaction, such as order, invoice, or credit memo. Review the available lookup codes for the lookup type CN_TP_TRANSACTION_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• TransactionTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The display label for the Transaction Type lookup code.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the simulation earning was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "FormulaId":{
            "type":"integer",
            "description":"The unique identifier of the incentive formula.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SplitPct":{
            "type":"number",
            "description":"The percentage number applied against the transaction amount to calculate the credit amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompensationPlanId":{
            "type":"integer",
            "description":"The unique identifier of the compensation plan for which the earnings are calculated.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditAmount":{
            "type":"number",
            "description":"The credit amount expressed in processing currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InputAchieved":{
            "type":"number",
            "description":"The amount passed to the rate table to calculate the earnings based on the input expression defined in the plan component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Participant Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the incentive compensation credit receiver.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the incentive compensation participant who received direct credit for the source transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PostingStatus":{
            "maxLength":1,
            "type":"string",
            "description":"The status indicating whether the earning was included in the payment process. If true then the earning was included in the payment. Possible values include false and true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the simulation earning.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the simulation earning.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the process of the source transaction, such as to override classification, crediting, and rollup processing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the plan component for which the earnings are calculated.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectStatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The display label for the process status lookup code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"The unique identifier of the transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceTrxNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The transaction number which resulted in the incentive earnings.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SrpAlternatePayeeId":{
            "type":"integer",
            "description":"The unique identifier of the alternate person who is eligible to receive payment for this earnings.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SimulationId":{
            "type":"integer",
            "description":"The unique identifier of the simulation to which the simulation earning belongs.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TierSplits":{
            "type":"integer",
            "description":"The number of rate tiers used to calculate the earning rate.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SrpCompensationPlanId":{
            "type":"integer",
            "description":"The unique identifier of the assignment of the compensation plan to the participant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanComponentName":{
            "title":"Plan Component",
            "maxLength":80,
            "type":"string",
            "description":"The name of the plan component for which the earnings are calculated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PayPeriodId":{
            "type":"integer",
            "description":"The unique identifier of the pay period. The period number represents the calendar period the pay sheet and payment batch are for. The period numbers are generated when you define your incentive compensation calendar using the Setup and Maintenance work area, Manage Calendars task. For example, the period number 2018001 represents the first period in the year 2018.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the transaction. This value indicates the source of the transaction, such as order, invoice, or credit memo. Review the available lookup codes for the lookup type CN_TP_TRANSACTION_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedDuring":{
            "maxLength":30,
            "type":"string",
            "description":"The phase during which this record was created. The possible values are Rollup, Eligibility, Calculation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HomeCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The code indicating the participant home currency that is in effect as of the source event date of the payment transaction. Review the effective participant attributes using the Participant Snapshot work area, Manage Participant Detail page.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HomeEarningAmount":{
            "type":"number",
            "description":"The amount earned, expressed in participant home currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The display label for the Transaction Type lookup code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningTypeId":{
            "type":"integer",
            "description":"The unique identifier of the type of earning.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The current status of the earnings record, such as calculated, calculation error, eligible, or reversed. Review the available lookup codes for the lookup type CN_TP_EARNING_OBJECT_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceEventPeriodId":{
            "type":"integer",
            "description":"The unique identifier of the calendar period when the transaction event date falls.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EarningId":{
            "type":"integer",
            "description":"The unique identifier of an earning in a calculation simulation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceOrgId":{
            "type":"integer",
            "description":"The unique identifier of the source business unit of the transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EligibleCatId":{
            "type":"integer",
            "description":"The unique identifier of the credit category.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OutputAchieved":{
            "type":"number",
            "description":"The amount calculated by the earnings expression of an incentive formula.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompensationPlanName":{
            "title":"Compensation Plan",
            "maxLength":80,
            "type":"string",
            "description":"The name of the compensation plan for which the earnings are calculated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorReason":{
            "maxLength":150,
            "type":"string",
            "description":"The reason explaining why the earning is in error status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FormulaEcatId":{
            "type":"integer",
            "description":"The unique identifier of the credit category of a plan component.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EarningType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of earning type for the plan component. This value is used to classify earnings into monetary and nonmonetary categories.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceEventDate":{
            "type":"string",
            "description":"The date when the earning event occurred. The event date is either the source transaction event date or the calculation grouping event date which resulted in the incentive earning.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionAmount":{
            "type":"number",
            "description":"The transaction amount expressed in processing currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FormulaWeight":{
            "type":"number",
            "description":"The percentage of influence a plan component has on the compensation plan, also called target incentive percent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SimulationResultType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether a measure result comes from the simulation execution or from the existing calculated measure result.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditedParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConversionRate":{
            "type":"number",
            "description":"The exchange rate to convert the processing currency into operating currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SimulationDeleteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an earning is deleted during calculation simulation processing.",
            "nullable":false,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "HomeCurrencyConversionRate":{
            "type":"number",
            "description":"The exchange rate to convert the processing currency into home currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningAmount":{
            "type":"number",
            "description":"The amount earned, expressed in processing currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculationCurrency":{
            "maxLength":15,
            "type":"string",
            "description":"The code indicating the processing currency of the earning amounts. The processing currency is selected as either the operating currency or the participant home currency for the business unit. Review the processing currency parameter using the Setup and Maintenance work area, Manage Parameters task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperatingEarningAmount":{
            "type":"number",
            "description":"The amount earned, expressed in business unit operating currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommissionValue":{
            "type":"number",
            "description":"The incentive rate table amount, or the percentage, that was used to calculate the earning amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : incentiveCompensationCalculationSimulations-MeasureResults-item-response

Type: object

Show Source

• CalculationCurrency: string
  Read Only: true

  Maximum Length: 15

  The calculation currency code.
• CommissionValue: number
  Read Only: true

  The rate of the rate table.
• CompensationPlanId: integer (int64)
  Read Only: true

  The unique identifier of the compensation plan for which the measure results are calculated.
• CompensationPlanName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  The name of the compensation plan for which the measure results are calculated.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the measure result record.
• CreatedDuring: string
  Read Only: true

  Maximum Length: 30

  The phase during which this record was created. The possible values are Rollup, Eligibility, Calculation.
• CreationDate: string (date-time)
  Read Only: true

  The date when the measure result record was created.
• CreditAmount: number
  Read Only: true

  The credit amount in calculation currency.
• CreditedParticipantId: integer (int64)
  Read Only: true

  The unique identifier of the participant who receives credit for the transaction.
• CreditedParticipantName: string
  Title: Participant Name

  Read Only: true

  Maximum Length: 360

  The name of the participant who receives credit for the transaction.
• CreditFactor: number
  Read Only: true

  The credit factor applied to a credit category associated with the performance measure.
• CreditId: integer (int64)
  Read Only: true

  The unique identifier of the credited transaction.
• EarningFactor: number
  Read Only: true

  The earning factor associated with the performance measure.
• EarningTypeId: integer (int64)
  Read Only: true

  The identifier of the earning type.
• EligibleCatId: integer (int64)
  Read Only: true

  The transaction credit category populated during classification.
• ErrorReason: string
  Read Only: true

  Maximum Length: 150

  The reason for error during calculation.
• EventFactorValue: number
  Read Only: true

  The event factor for a transaction type applied to a credit category associated with the performance measure.
• FormulaId: integer (int64)
  Read Only: true

  The unique identifier of the performance measure for which the measure results are calculated.
• FormulaWeight: number
  Read Only: true

  The weight of the performance measure within the plan component.
• InputAchieved: number
  Read Only: true

  The amount passed to the rate table based on the input expression defined in the performance measure.
• LastUpdateDate: string (date-time)
  Read Only: true

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• MeasureResultId: integer (int64)
  Read Only: true

  The identifier of the simulation measure result.
• ObjectStatus: string
  Read Only: true

  Maximum Length: 30

  The current status of the measure results record, such as calculated, calculation error, eligible, or reversed.
• ObjectStatusMeaning: string
  Read Only: true

  Maximum Length: 80

  The display label for the process status lookup code.
• OrgId: integer (int64)
  Read Only: true

  The unique identifier of the business unit associated with the measure result record.
• OutputAchieved: number
  Read Only: true

  The amount calculated by the output expression of the performance measure.
• PerformanceMeasureName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  The name of the performance measure for which the measure results are calculated.
• PlanComponentId: integer (int64)
  Read Only: true

  The unique identifier of the plan component for which the measure results are calculated.
• PlanComponentName: string
  Title: Name

  Read Only: true

  Maximum Length: 80

  The name of the plan component for which the measure results are calculated.
• SimulationDeleteFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the measure result was deleted during calculation simulation processing.
• SimulationId: integer (int64)
  Read Only: true

  The identifier of the simulation to which this simulation measure result belongs.
• SimulationResultType: string
  Read Only: true

  Maximum Length: 30

  Indicates whether a measure result comes from the simulation execution or from the existing calculated measure result.
• SourceEventDate: string (date)
  Read Only: true

  The date of the simulation transaction.
• SourceEventPeriodId: integer (int64)
  Read Only: true

  The period identifier for the source event date.
• SourceTrxNumber: string
  Read Only: true

  Maximum Length: 30

  The transaction number which identifies the transaction.
• SrpCompensationPlanId: integer (int64)
  Read Only: true

  The unique identifier of the participant compensation plan assignment record.
• TierSplits: integer (int64)
  Read Only: true

  The tier of the rate table.
• TransactionAmount: number
  Read Only: true

  The transaction amount in calculation currency.
• TransactionId: integer (int64)
  Read Only: true

  The unique identifier for the transaction.
• TransactionType: string
  Read Only: true

  Maximum Length: 30

  The type of the transaction. This value indicates the source of the transaction, such as order, invoice, or credit memo. Review the available lookup codes for the lookup type CN_TP_TRANSACTION_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• TransactionTypeMeaning: string
  Read Only: true

  Maximum Length: 80

  The display label for the Transaction Type lookup code.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the measure result record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceMeasureName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the performance measure for which the measure results are calculated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the transaction. This value indicates the source of the transaction, such as order, invoice, or credit memo. Review the available lookup codes for the lookup type CN_TP_TRANSACTION_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CompensationPlanId":{
            "type":"integer",
            "description":"The unique identifier of the compensation plan for which the measure results are calculated.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FormulaId":{
            "type":"integer",
            "description":"The unique identifier of the performance measure for which the measure results are calculated.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedDuring":{
            "maxLength":30,
            "type":"string",
            "description":"The phase during which this record was created. The possible values are Rollup, Eligibility, Calculation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditAmount":{
            "type":"number",
            "description":"The credit amount in calculation currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InputAchieved":{
            "type":"number",
            "description":"The amount passed to the rate table based on the input expression defined in the performance measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionTypeMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The display label for the Transaction Type lookup code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditedParticipantName":{
            "title":"Participant Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the participant who receives credit for the transaction.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningTypeId":{
            "type":"integer",
            "description":"The identifier of the earning type.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The current status of the measure results record, such as calculated, calculation error, eligible, or reversed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditId":{
            "type":"integer",
            "description":"The unique identifier of the credited transaction.",
            "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"
            }
        },
        "SourceEventPeriodId":{
            "type":"integer",
            "description":"The period identifier for the source event date.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the measure result record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EligibleCatId":{
            "type":"integer",
            "description":"The transaction credit category populated during classification.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OutputAchieved":{
            "type":"number",
            "description":"The amount calculated by the output expression of the performance measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompensationPlanName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the compensation plan for which the measure results are calculated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorReason":{
            "maxLength":150,
            "type":"string",
            "description":"The reason for error during calculation.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EventFactorValue":{
            "type":"number",
            "description":"The event factor for a transaction type applied to a credit category associated with the performance measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningFactor":{
            "type":"number",
            "description":"The earning factor associated with the performance measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceEventDate":{
            "type":"string",
            "description":"The date of the simulation transaction.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the plan component for which the measure results are calculated.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectStatusMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The display label for the process status lookup code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"The unique identifier for the transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionAmount":{
            "type":"number",
            "description":"The transaction amount in calculation currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FormulaWeight":{
            "type":"number",
            "description":"The weight of the performance measure within the plan component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgId":{
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the measure result record.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SimulationResultType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether a measure result comes from the simulation execution or from the existing calculated measure result.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceTrxNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The transaction number which identifies the transaction.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditedParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant who receives credit for the transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MeasureResultId":{
            "type":"integer",
            "description":"The identifier of the simulation measure result.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SimulationDeleteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the measure result was deleted during calculation simulation processing.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SimulationId":{
            "type":"integer",
            "description":"The identifier of the simulation to which this simulation measure result belongs.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditFactor":{
            "type":"number",
            "description":"The credit factor applied to a credit category associated with the performance measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculationCurrency":{
            "maxLength":15,
            "type":"string",
            "description":"The calculation currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommissionValue":{
            "type":"number",
            "description":"The rate of the rate table.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TierSplits":{
            "type":"integer",
            "description":"The tier of the rate table.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SrpCompensationPlanId":{
            "type":"integer",
            "description":"The unique identifier of the participant compensation plan assignment record.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanComponentName":{
            "title":"Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of the plan component for which the measure results are calculated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

Type: object

Show Source

• AdjustmentComments: string
  Maximum Length: 1000

  The comments explaining the adjustment to a transaction.
• AdjustmentStatus: string
  Read Only: true

  Maximum Length: 30

  The lookup code that indicates the adjustment state of the transaction. Review the available lookup codes for the lookup type CN_TP_BASETRANS_ADJ_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• BookedDate: string (date-time)
  The date when the sales order was booked in the order management application.
• ChangedTrxFlag: boolean
  Maximum Length: 1

  Indicates whether the transaction is a new transaction or a modified transaction.
• ClsfnRuleId: integer (int64)
  The unique identifier of the classification rule used to assign the credit category to the transaction.
• CollectionStatus: string
  Read Only: true

  Maximum Length: 30

  The lookup code that indicates the reason for a collection error. Review the available lookup codes for the lookup type CN_TP_BASETRANS_COLL_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• ConversionRate: number
  Read Only: true

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

  Maximum Length: 64

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

  The date when the record was created.
• CreditDate: string (date-time)
  The date when the credit receiver should receive the credit. The date is used to determine the credit receivers when processing the credit rules against transactions.
• Credits: array Simulation Credits
  Title: Simulation Credits

  The simulation credits resource to is used to view, create, update, and delete credits of a calculation simulation.
• DirectParticipantId: integer (int64)
  The unique identifier of the participant who is directly involved in the closure of the transaction.
• DiscountPercentage: number
  The percentage of the transaction amount that depicts the net amount to be paid by the buyer.
• EligibleCatId: integer (int64)
  The unique identifier of the credit category that is used when overriding the classification process. The credit category is a user-defined business category used to classify a transaction for compensation purposes.
• ErrorCode: string
  Maximum Length: 30

  The code indicating the reason a transaction is in error status. Review the available lookup codes for the lookup type ORA_CN_PROCESS_ERR_REASON LOOKUP_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• ErrorMeaning: string
  Read Only: true

  Maximum Length: 80

  The reason explaining why the credit is in error status.
• EventDate: string (date-time)
  The date when the incentive event occurs. The event date is used to determine the effective currency conversion rate when the participant's home currency is used as the processing currency. The date must be within a defined Incentive Compensation calendar period where the period has an Open status and the calendar is defined for the same business unit as the transaction's business unit. If the value does not meet these requirements, the transaction process status is updated to Error.
• HoldFlag: boolean
  Maximum Length: 1

  Indicates whether the application must exclude the transaction from further processing. The transaction will not be further processed if this flag is set to Y.
• InvoiceDate: string (date-time)
  The date when the invoice for the transaction was generated in the source application.
• InvoiceNumber: string
  Maximum Length: 30

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

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• MarginPercentage: number
  The percentage of the transaction amount that depicts the profit of the sale.
• ObjectStatus: string
  Maximum Length: 30

  The lookup code that indicates the current state of the transaction, such as New, Obsolete, or Collection Error. Review the available lookup codes for the lookup type CN_TP_BASETRANS_OBJECT_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• OrderNumber: string
  Maximum Length: 30

  The sales order number in the source application associated with the transaction.
• PreserveCreditFlag: boolean
  Maximum Length: 1

  Indicates whether any of the manually created or adjusted credits for the transaction are not to be modified by the credit process.
• ProcessCode: string
  Maximum Length: 30

  The process code is a five letter code that indicates the combination of Override Classification, Preserve Credits, Do Not Roll Up, and Do Not Calculate values for the transaction. For example, the default value of the process code CCREC indicates that the Override Classification, Preserve Credits, and Do Not Roll Up check boxes are not checked and the normal calculation processing will occur. The first letter determines the Override Classification setting. Valid values are N and C. Enter a code starting with N to check the Override Classification checkbox. You must also provide a credit category to avoid the collection error status. For regular classification processing, enter a code starting with C. The second letter determines the Preserve Credits setting. Valid values are N and C. Enter a code with N as the second letter to check the Preserve Credits checkbox. For regular credit processing, enter C. The third letter determines the Do Not Rollup setting. Valid values are N and R. Enter a code with N as the third letter to check the Do Not Rollup checkbox. To allow rollup credit processing, enter R. The last two letters indicate earnings edibility and calculation. Valid values are EC, EN,NN, and NC. Enter a code with the value of N in either or both of the fourth and fifth position to exclude the credit from calculation. For regular calculation processing, enter EC.
• ReasonCode: string
  Maximum Length: 30

  The code indicating the reason for adjusting a transaction. You can view the CN_TP_ADJUSTMENT_REASON lookup from the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• RoleId: integer (int64)
  The unique identifier of the compensation role assigned to the direct participant.
• RollupDate: string (date-time)
  The date used to determine the roll up credit receivers when processing the roll up rules against transactions.
• SimulationDeleteFlag: boolean
  Maximum Length: 1

  Default Value: false

  Indicates whether a transaction is deleted during calculation simulation processing.
• SimulationId: integer (int64)
  The unique identifier of the simulation to which this simulation transaction belongs.
• SimulationTransactionDFF: array Simulation Transaction Descriptive Flex Fields
  Title: Simulation Transaction Descriptive Flex Fields

  The simulation transaction descriptive flex fields resource is used to view and create additional attributes of the transaction that are used during the simulation.
• SourceCurrencyCode: string
  Maximum Length: 15

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

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

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

  The transaction amount in operating currency.
• TransactionAmountSource: number
  The transaction amount in source currency.
• TransactionId: integer (int64)
  The unique identifier of the transaction in a calculation simulation.
• TransactionNumber: string
  Maximum Length: 30

  The alternate key identifier of the transaction. The users can use this attribute to search for an invoice number or an order number. If adjusting a transaction, the combination of the business unit, transaction number, and the transaction type uniquely identify an existing transaction.
• TransactionQuantity: number
  The quantity of the transaction line item.
• TransactionType: string
  Maximum Length: 30

  The type of the transaction indicating the source of the transaction, such as order, invoice, or credit memo. Review the available lookup codes for the lookup type CN_TP_TRANSACTION_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• UOMCode: string
  Maximum Length: 10

  The code indicating the unit of measure for the transaction line item. Review the available lookup codes for the lookup type ORA_CN_TP_TRANSACTION_UOM using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• WorkerId: integer (int64)
  The batch number assigned to the transaction. This is applicable if the batch processing in the system parameters page is set to "Use batch information provided at the transaction level".

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code that indicates the currency of the monetary transaction amount in the source application.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EventDate":{
            "type":"string",
            "description":"The date when the incentive event occurs. The event date is used to determine the effective currency conversion rate when the participant's home currency is used as the processing currency. The date must be within a defined Incentive Compensation calendar period where the period has an Open status and the calendar is defined for the same business unit as the transaction's business unit. If the value does not meet these requirements, the transaction process status is updated to Error.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "RollupDate":{
            "type":"string",
            "description":"The date used to determine the roll up credit receivers when processing the roll up rules against transactions.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTrxLineId":{
            "type":"integer",
            "description":"The unique identifier of the transaction line in the source application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrderNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The sales order number in the source application associated with the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTrxSalesLineId":{
            "type":"integer",
            "description":"The unique identifier of the transaction credit in the source application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionQuantity":{
            "type":"number",
            "description":"The quantity of the transaction line item.",
            "nullable":true,
            "x-queryable":true
        },
        "TerrId":{
            "type":"integer",
            "description":"The unique identifier of the territory to which the transaction belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TerrName":{
            "maxLength":1000,
            "type":"string",
            "description":"The name of the territory to which the transaction belongs.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CollectionStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates the reason for a collection error. Review the available lookup codes for the lookup type CN_TP_BASETRANS_COLL_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the invoice associated with the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMCode":{
            "maxLength":10,
            "type":"string",
            "description":"The code indicating the unit of measure for the transaction line item. Review the available lookup codes for the lookup type ORA_CN_TP_TRANSACTION_UOM using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessCode":{
            "maxLength":30,
            "type":"string",
            "description":"The process code is a five letter code that indicates the combination of Override Classification, Preserve Credits, Do Not Roll Up, and Do Not Calculate values for the transaction. For example, the default  value of the process code CCREC indicates that the Override Classification, Preserve Credits, and Do Not Roll Up check boxes are not checked and the normal calculation processing will occur. The first letter determines the Override Classification setting. Valid values are N and C. Enter a code starting with N to check the Override Classification checkbox. You must also provide a credit category to avoid the collection error status. For regular classification processing, enter a code starting with C. The second letter determines the Preserve Credits setting. Valid values are N and C. Enter a code with N as the second letter to check the Preserve Credits checkbox. For regular credit processing, enter C. The third letter determines the Do Not Rollup setting. Valid values are N and R. Enter a code with N as the third letter to check the Do Not Rollup checkbox. To allow rollup credit processing, enter R. The last two letters indicate earnings edibility and calculation. Valid values are EC, EN,NN, and NC. Enter a code with the value of N in either or both of the fourth and fifth position to exclude the credit from calculation. For regular calculation processing, enter EC.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkerId":{
            "type":"integer",
            "description":"The batch number assigned to the transaction. This is applicable if the batch processing in the system parameters page is set to \"Use batch information provided at the transaction level\".",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the reason for adjusting a transaction. You can view the CN_TP_ADJUSTMENT_REASON lookup from the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates the adjustment state of the transaction. Review the available lookup codes for the lookup type CN_TP_BASETRANS_ADJ_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"The unique identifier of the transaction in a calculation simulation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceTrxId":{
            "type":"integer",
            "description":"The unique identifier of the transaction in the source application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SimulationId":{
            "type":"integer",
            "description":"The unique identifier of the simulation to which this simulation transaction belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SimulationTransactionDFF":{
            "title":"Simulation Transaction Descriptive Flex Fields",
            "type":"array",
            "description":"The simulation transaction descriptive flex fields resource is used to view and create additional attributes of the transaction that are used during the simulation.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationCalculationSimulations-Transactions-SimulationTransactionDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangedTrxFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the transaction is a new transaction or a modified transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditDate":{
            "type":"string",
            "description":"The date when the credit receiver should receive the credit. The date is used to determine the credit receivers when processing the credit rules against transactions.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the transaction indicating the source of the transaction, such as order, invoice, or credit memo. Review the available lookup codes for the lookup type CN_TP_TRANSACTION_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "x-queryable":true
        },
        "TransactionNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the transaction. The users can use this attribute to search for an invoice number or an order number. If adjusting a transaction, the combination of the business unit, transaction number, and the transaction type uniquely identify an existing transaction.",
            "nullable":false,
            "x-queryable":true
        },
        "BookedDate":{
            "type":"string",
            "description":"The date when the sales order was booked in the order management application.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionAmountFunc":{
            "type":"number",
            "description":"The transaction amount in operating currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates the current state of the transaction, such as New, Obsolete, or Collection Error. Review the available lookup codes for the lookup type CN_TP_BASETRANS_OBJECT_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "AdjustmentComments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments explaining the adjustment to a transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "InvoiceDate":{
            "type":"string",
            "description":"The date when the invoice for the transaction was generated in the source application.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SourceEventPeriodId":{
            "type":"integer",
            "description":"The unique identifier of the period to which the source event belongs.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceOrgId":{
            "type":"integer",
            "description":"The unique identifier of the source transaction business unit record.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EligibleCatId":{
            "type":"integer",
            "description":"The unique identifier of the credit category that is used when overriding the classification process. The credit category is a user-defined business category used to classify a transaction for compensation purposes.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ClsfnRuleId":{
            "type":"integer",
            "description":"The unique identifier of the classification rule used to assign the credit category to the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "DirectParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant who is directly involved in the closure of the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreserveCreditFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether any of the manually created or adjusted credits for the transaction are not to be modified by the credit process.",
            "nullable":true,
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier of the compensation role assigned to the direct participant.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Credits":{
            "title":"Simulation Credits",
            "type":"array",
            "description":"The simulation credits resource to is used to view, create, update, and delete credits of a calculation simulation.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationCalculationSimulations-Transactions-Credits-item-response"
            }
        },
        "ConversionRate":{
            "type":"number",
            "description":"The exchange rate to convert from source system currency to operating currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionAmountSource":{
            "type":"number",
            "description":"The transaction amount in source currency.",
            "nullable":false,
            "x-queryable":true
        },
        "DiscountPercentage":{
            "type":"number",
            "description":"The percentage of the transaction amount that depicts the net amount to be paid by the buyer.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The reason explaining why the credit is in error status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SimulationDeleteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a transaction is deleted during calculation simulation processing.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "MarginPercentage":{
            "type":"number",
            "description":"The percentage of the transaction amount that depicts the profit of the sale.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the reason a transaction is in error status. Review the available lookup codes for the lookup type ORA_CN_PROCESS_ERR_REASON LOOKUP_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "HoldFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the application must exclude the transaction from further processing. The transaction will not be further processed if this flag is set to Y.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Simulation Credits

Type: array

Title: Simulation Credits

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

Show Source

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

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Simulation Transaction Descriptive Flex Fields

Type: array

Title: Simulation Transaction Descriptive Flex Fields

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

Show Source

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

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

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

Type: object

Show Source

• AdjustmentComments: string
  Maximum Length: 1000

  The comments explaining why the credit was adjusted.
• AdjustmentStatus: string
  Maximum Length: 30

  The status indicating the adjustment state of the credit. Review the available lookup codes for the lookup type CN_TP_CREDIT_ADJ_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• CalculationConversionRate: number
  The exchange rate to convert from source currency to processing currency.
• CalculationCurrencyCode: string
  Maximum Length: 15

  The code indicating the processing currency for the credit amount. The processing currency is selected as either the operating currency or the participant home currency for the business unit. Review the processing currency parameter using the Setup and Maintenance work area, Manage Parameters task.
• ChangedCreditFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates if the credit is new or modified.
• ClsfnRuleId: integer (int64)
  The unique identifier of the classification rule used to assign the credit category, to the credit.
• CollectionStatus: string
  Maximum Length: 30

  The lookup code that indicates the reason for a collection error. Review the available lookup codes for the lookup type CN_TP_CREDIT_COLL_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the record.
• CreatedDuring: string
  Read Only: true

  Maximum Length: 30

  Default Value: SIMULATION

  The lookup code indicating when this credit record was created. A list of valid values is stored in the lookup CN_TP_CREDIT_CREATED_DURING. Review the available lookup codes using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• CreationDate: string (date-time)
  Read Only: true

  The date when the record was created.
• CreditAmount: number
  The credit amount in processing currency.
• CreditCategoryId: integer (int64)
  The unique identifier of the credit category that is used when overriding the classification process. The credit category is a user-defined business category used to classify a credit for compensation purposes.
• CreditDate: string (date-time)
  The date when the credit receiver should receive the credit. The date is used to determine the credit receivers when processing the credit rules against transactions.
• CreditedParticipantId: integer (int64)
  The unique identifier of the participant who owns the credit.
• CreditId: integer (int64)
  Read Only: true

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

  Default Value: DIRECT

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

  Maximum Length: 30

  The code indicating the reason the credit is in error status. Review the available lookup codes for the lookup type ORA_CN_PROCESS_ERR_REASON LOOKUP_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• ErrorMeaning: string
  Read Only: true

  Maximum Length: 80

  The display label explaining why the credit is in error status.
• EventDate: string (date-time)
  Read Only: true

  The date when the incentive event occurs. The event date is used to determine the effective currency conversion rate when the participant's home currency is used as the processing currency.
• HoldFlag: boolean
  Maximum Length: 1

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

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

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

  Maximum Length: 64

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

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• ObjectStatus: string
  Maximum Length: 30

  The status of the credit, such as Credited, Obsolete, or Rolled up. Review the available lookup codes for the lookup type CN_TP_CREDIT_OBJECT_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• OperatingConversionRate: number
  The exchange rate to convert from source currency to operating currency.
• OperatingCreditAmount: number
  The credit amount in business unit operating currency.
• OperatingCurrency: string
  Title: Operating Currency

  Read Only: true

  Maximum Length: 10

  The code indicating the functional currency of the business unit.
• ProcessCode: string
  Read Only: true

  Maximum Length: 30

  Default Value: CNNEC

  The five letter code indicating the combination of Override Classification, Preserve Credits, Do Not Roll Up, and Do Not Calculate values for the transaction.
• ReasonCode: string
  Read Only: true

  Maximum Length: 30

  The code indicating the reason for adjusting a credit. You can view the CN_TP_ADJUSTMENT_REASON lookup from the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• RevenueType: string
  Maximum Length: 30

  The type of the credit, such as revenue or non-revenue. Review the available lookup codes for the lookup type CN_RS_REVENUE_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.
• RoleId: integer (int64)
  The unique identifier of the role assigned to the credit receiver.
• RollupDate: string (date-time)
  The date used to determine the roll up credit receivers when processing the roll up rules against transactions.
• RollupLevel: integer (int64)
  The level of the rollup rule in the rollup hierarchy. This value is applicable in case of rollup credits.
• SimulationDeleteFlag: boolean
  Maximum Length: 1

  Default Value: false

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

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

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

  The unique identifier of the transaction.
• TransactionNumber: string
  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the transaction that users can recognize and search with, for example, an invoice number or order number.
• TransactionQuantity: number
  The quantity for the transaction line item.
• TransactionType: string
  Read Only: true

  Maximum Length: 30

  The type of the transaction indicating the source of the transaction, such as order, invoice, or credit memo. Review the available lookup codes for the lookup type CN_TP_TRANSACTION_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code that represents the currency of the monetary transaction amount in the source application.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EventDate":{
            "type":"string",
            "description":"The date when the incentive event occurs. The event date is used to determine the effective currency conversion rate when the participant's home currency is used as the processing currency.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SplitPct":{
            "type":"number",
            "description":"The percent of the transaction amount that the credit receiver received.",
            "nullable":true,
            "default":100,
            "x-queryable":true
        },
        "RollupDate":{
            "type":"string",
            "description":"The date used to determine the roll up credit receivers when processing the roll up rules against transactions.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SourceBusinessUnitId":{
            "type":"integer",
            "description":"The unique identifier of the source transaction business unit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditAmount":{
            "type":"number",
            "description":"The credit amount in processing currency.",
            "nullable":true,
            "x-queryable":true
        },
        "DirectRuleId":{
            "type":"integer",
            "description":"The unique identifier of the credit rule used to create the direct credit that corresponds to this credit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OperatingCurrency":{
            "title":"Operating Currency",
            "maxLength":10,
            "type":"string",
            "description":"The code indicating the functional currency of the business unit.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionQuantity":{
            "type":"number",
            "description":"The quantity for the transaction line item.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditId":{
            "type":"integer",
            "description":"The unique identifier of the credit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceTransactionAmount":{
            "type":"number",
            "description":"The transaction amount in source currency of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CreditCategoryId":{
            "type":"integer",
            "description":"The unique identifier of the credit category that is used when overriding the classification process. The credit category is a user-defined business category used to classify a credit for compensation purposes.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "CollectionStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that indicates the reason for a collection error. Review the available lookup codes for the lookup type CN_TP_CREDIT_COLL_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessCode":{
            "maxLength":30,
            "type":"string",
            "description":"The five letter code indicating the combination of Override Classification, Preserve Credits, Do Not Roll Up, and Do Not Calculate values for the transaction.",
            "nullable":true,
            "readOnly":true,
            "default":"CNNEC",
            "x-queryable":true
        },
        "ReasonCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the reason for adjusting a credit. You can view the CN_TP_ADJUSTMENT_REASON lookup from the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceCreditAmount":{
            "type":"number",
            "description":"The credit amount in source currency of the transaction.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionId":{
            "type":"integer",
            "description":"The unique identifier of the transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CalculationCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The code indicating the processing currency for the credit amount. The processing currency is selected as either the operating currency or the participant home currency for the business unit. Review the processing currency parameter using the Setup and Maintenance work area, Manage Parameters task.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status indicating the adjustment state of the credit. Review the available lookup codes for the lookup type CN_TP_CREDIT_ADJ_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "CalculationConversionRate":{
            "type":"number",
            "description":"The exchange rate to convert from source currency to processing currency.",
            "nullable":true,
            "x-queryable":true
        },
        "SimulationId":{
            "type":"integer",
            "description":"The identifier of the simulation to which this simulation credit belongs.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SummaryCreditId":{
            "type":"integer",
            "description":"The unique identifier of the summary credit to which the credit is associated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RevenueType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the credit, such as revenue or non-revenue. Review the available lookup codes for the lookup type CN_RS_REVENUE_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditDate":{
            "type":"string",
            "description":"The date when the credit receiver should receive the credit. The date is used to determine the credit receivers when processing the credit rules against transactions.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "RollupLevel":{
            "type":"integer",
            "description":"The level of the rollup rule in the rollup hierarchy. This value is applicable in case of rollup credits.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":30,
            "type":"string",
            "description":"The type of the transaction indicating the source of the transaction, such as order, invoice, or credit memo. Review the available lookup codes for the lookup type CN_TP_TRANSACTION_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the transaction that users can recognize and search with, for example, an invoice number or order number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedDuring":{
            "maxLength":30,
            "type":"string",
            "description":"The lookup code indicating when this credit record was created. A list of valid values is stored in the lookup CN_TP_CREDIT_CREATED_DURING. Review the available lookup codes using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"SIMULATION",
            "x-queryable":true
        },
        "HomeCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The code indicating the participant's home currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ChangedCreditFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the credit is new or modified.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OperatingConversionRate":{
            "type":"number",
            "description":"The exchange rate to convert from source currency to operating currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectStatus":{
            "maxLength":30,
            "type":"string",
            "description":"The status of the credit, such as Credited, Obsolete, or Rolled up. Review the available lookup codes for the lookup type CN_TP_CREDIT_OBJECT_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustmentComments":{
            "maxLength":1000,
            "type":"string",
            "description":"The comments explaining why the credit was adjusted.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the nature of the credit such as Direct, Indirect, or Summarized.",
            "nullable":false,
            "default":"DIRECT",
            "x-queryable":true
        },
        "ClsfnRuleId":{
            "type":"integer",
            "description":"The unique identifier of the classification rule used to assign the credit category, to the credit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DirectParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant who is directly involved in the closure of the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceCreditId":{
            "type":"integer",
            "description":"The unique identifier of the source credit or the summarized credit record from which the rollup credit is generated.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HomeConversionRate":{
            "type":"number",
            "description":"The exchange rate to convert from processing currency to home currency.",
            "nullable":true,
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier of the role assigned to the credit receiver.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionAmount":{
            "type":"number",
            "description":"The transaction amount in processing currency.",
            "nullable":true,
            "x-queryable":true
        },
        "HomeCreditAmount":{
            "type":"number",
            "description":"The transaction amount in participant's home currency.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditedParticipantId":{
            "type":"integer",
            "description":"The unique identifier of the participant who owns the credit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OperatingCreditAmount":{
            "type":"number",
            "description":"The credit amount in business unit operating currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ErrorMeaning":{
            "maxLength":80,
            "type":"string",
            "description":"The display label explaining why the credit is in error status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SimulationDeleteFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a credit is deleted during calculation simulation processing.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "CreditRuleId":{
            "type":"integer",
            "description":"The unique identifier of the credit rule used to create the credit.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorCode":{
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the reason the credit is in error status. Review the available lookup codes for the lookup type ORA_CN_PROCESS_ERR_REASON LOOKUP_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the application must exclude the transaction from further processing.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

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

Type: object

Show Source

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

  Maximum Length: 30

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

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

  Maximum Length: 360

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

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

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

  Maximum Length: 360

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

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

  Maximum Length: 360

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

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

  Maximum Length: 360

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

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

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

  Maximum Length: 360

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

  Maximum Length: 30

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

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

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

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

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

  Maximum Length: 360

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

  The name of the state related to this simulation transaction.
• SimulationId: integer (int64)
• TransactionId: integer (int64)

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

Back to Top