Jump to

• Request
• Response

Get all simulation earnings

get

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

Request

Path Parameters

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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:
  
  

  • EarningIdFinder: Finds a simulation earning with the specified simulation earning identifier.
    Finder Variables:
    • EarningId; integer; The unique identifier of the simulation earning.
  • PrimaryKey: Finds a simulation earning with the specified primary key.
    Finder Variables:
    • EarningId; integer; The unique identifier of the simulation earning.
    • 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:
  

  • CalculationCurrency; string; 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; The incentive rate table amount, or the percentage, that was used to calculate the earning amount.
  • CompensationPlanId; integer; The unique identifier of the compensation plan for which the earnings are calculated.
  • CompensationPlanName; string; The name of the compensation plan for which the earnings are calculated.
  • ConversionRate; number; The exchange rate to convert the processing currency into operating currency.
  • CreatedBy; string; The user who created the simulation earning.
  • CreatedDuring; string; The phase during which this record was created. The possible values are Rollup, Eligibility, Calculation.
  • CreationDate; string; The date and time when the simulation earning was created.
  • CreditAmount; number; The credit amount expressed in processing currency.
  • CreditedParticipantId; integer; The unique identifier of the participant.
  • EarningAmount; number; The amount earned, expressed in processing currency.
  • EarningId; integer; The unique identifier of an earning in a calculation simulation.
  • EarningType; string; The type of earning type for the plan component. This value is used to classify earnings into monetary and nonmonetary categories.
  • EarningTypeId; integer; The unique identifier of the type of earning.
  • EligibleCatId; integer; The unique identifier of the credit category.
  • ErrorReason; string; The reason explaining why the earning is in error status.
  • FormulaEcatId; integer; The unique identifier of the credit category of a plan component.
  • FormulaId; integer; The unique identifier of the incentive formula.
  • FormulaWeight; number; The percentage of influence a plan component has on the compensation plan, also called target incentive percent.
  • HomeCurrencyCode; string; The code indicating the participant home currency that is in effect as of the source event date of the payment transaction. Review the effective participant attributes using the Participant Snapshot work area, Manage Participant Detail page.
  • HomeCurrencyConversionRate; number; The exchange rate to convert the processing currency into home currency.
  • HomeEarningAmount; number; The amount earned, expressed in participant home currency.
  • InputAchieved; number; The amount passed to the rate table to calculate the earnings based on the input expression defined in the plan component.
  • LastUpdatedBy; string; The user who last updated the simulation earning.
  • ObjectStatus; string; 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; The display label for the process status lookup code.
  • OperatingEarningAmount; number; The amount earned, expressed in business unit operating currency.
  • OutputAchieved; number; The amount calculated by the earnings expression of an incentive formula.
  • ParticipantId; integer; The unique identifier of the incentive compensation participant who received direct credit for the source transaction.
  • ParticipantName; string; The name of the incentive compensation credit receiver.
  • PayPeriodId; integer; 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; The unique identifier of the plan component for which the earnings are calculated.
  • PlanComponentName; string; The name of the plan component for which the earnings are calculated.
  • PostingStatus; string; 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; The code indicating the process of the source transaction, such as to override classification, crediting, and rollup processing.
  • SimulationDeleteFlag; boolean; Indicates whether an earning is deleted during calculation simulation processing.
  • SimulationId; integer; The unique identifier of the simulation to which the simulation earning belongs.
  • SimulationResultType; string; Indicates whether a measure result comes from the simulation execution or from the existing calculated measure result.
  • SourceEventDate; string; 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; The unique identifier of the calendar period when the transaction event date falls.
  • SourceOrgId; integer; The unique identifier of the source business unit of the transaction.
  • SourceTrxNumber; string; The transaction number which resulted in the incentive earnings.
  • SplitPct; number; The percentage number applied against the transaction amount to calculate the credit amount.
  • SrpAlternatePayeeId; integer; The unique identifier of the alternate person who is eligible to receive payment for this earnings.
  • SrpCompensationPlanId; integer; The unique identifier of the assignment of the compensation plan to the participant.
  • TierSplits; integer; The number of rate tiers used to calculate the earning rate.
  • TransactionAmount; number; The transaction amount expressed in processing currency.
  • TransactionId; integer; The unique identifier of the transaction.
  • TransactionType; string; 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; The display label for the Transaction Type lookup code.
• 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-Earnings

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-Earnings-item-response"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "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 : 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."
        }
    }
}

Back to Top