Get an earning
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationEarnings/{EarningId}
Request
Path Parameters
-
EarningId(required): integer(int64)
The unique identifier of the earnings.
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : incentiveCompensationEarnings-item-response
Type:
Show Source
object-
CalculationCurrency: string
Title:
CurrencyRead Only:trueMaximum Length:15The code indicating the processing currency for 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
Title:
Earning RateRead Only:trueThe incentive rate table amount, or percent, that was used to calculate the earning amount. -
CompensationPlanId: integer
(int64)
Read Only:
trueThe unique identifier of the compensation plan. -
CompensationPlanName: string
Title:
Compensation PlanRead Only:trueMaximum Length:80The name of the compensation plan for which the earnings are calculated. -
ConversionRate: number
Title:
Conversion RateRead Only:trueThe exchange rate to convert the processing currency into operating currency. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the incentive compensation earning. -
CreatedDuring: string
Title:
Earning Process TypeRead Only:trueMaximum Length:30The lookup code indicating when this earning record was created. The possible values include ELIGIBLE and CALCULATION. A list of acceptable values is defined in the lookup CN_TP_EARNING_CREATED_DURING. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the earning was created. -
CreditAmount: number
Title:
Calculation Currency Credit AmountRead Only:trueThe credit amount expressed in processing currency. -
CreditedParticipantId: integer
(int64)
Title:
Credit ReceiverRead Only:trueThe unique identifier of the participant. -
EarningAmount: number
Title:
Earning AmountRead Only:trueThe amount earned expressed in processing currency. -
EarningId: integer
(int64)
Title:
Earning IDRead Only:trueThe unique identifier of the earnings. -
EarningType: string
Title:
Earning TypeRead Only:trueMaximum Length:30The name of the earning type for the plan component. This values is used to classify earnings into monetary and nonmonetary categories. -
EarningTypeId: integer
(int64)
Read Only:
trueThe unique identifier of the type of earning. -
EligibleCatId: integer
(int64)
Title:
Credit CategoryRead Only:trueThe unique identifier of the credit category. -
ErrorReason: string
Title:
Error ReasonRead Only:trueMaximum Length:150The reason explaining why the earning is in error status. -
FormulaEcatId: integer
(int64)
Title:
Plan Component CategoryRead Only:trueThe unique identifier representing the credit category for a plan component. -
FormulaId: integer
(int64)
Read Only:
trueThe unique identifier for the incentive formula. -
FormulaWeight: number
Title:
WeightRead Only:trueThe percentage of influence a plan component has on the compensation plan. It is also called target incentive percent. -
HomeCurrencyCode: string
Title:
Home CurrencyRead Only:trueMaximum Length:15The participant home currency code 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
Title:
Home Currency Conversion RateRead Only:trueThe exchange rate to convert the processing currency into home currency. -
HomeEarningAmount: number
Title:
Home Earning AmountRead Only:trueThe amount earned expressed in participant home currency. -
InputAchieved: number
Title:
Input AchievedRead Only:trueThe amount passed to the rate table to calculate the earnings based on the input expression defined in the plan component. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the earning. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectStatus: string
Title:
Process StatusRead Only:trueMaximum Length:30The lookup code indicating 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. -
OperatingEarningAmount: number
Title:
Operating Earning AmountRead Only:trueThe amount earned expressed in business unit operating currency. -
OrgId: integer
(int64)
Title:
Business UnitRead Only:trueThe unique identifier of the business unit. -
OutputAchieved: number
Title:
Output AchievedRead Only:trueThe amount calculated by the earnings expression of an incentive formula. -
ParticipantId: integer
(int64)
Title:
Direct ParticipantRead Only:trueThe unique identifier of the incentive compensation participant who received direct credit for the source transaction. -
ParticipantName: string
Title:
Participant NameRead Only:trueMaximum Length:360The name of the incentive compensation credit receiver. -
PayPeriodId: integer
(int64)
Title:
PeriodRead Only:trueThe unique identifier of the pay period. The period number represents the calendar period the paysheet and payment batch is 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:
trueThe unique identifier of the plan component. -
PlanComponentName: string
Title:
Plan ComponentRead Only:trueMaximum Length:80The name of the plan component for which the earnings are calculated. -
PostingStatus: string
Title:
PostedRead Only:trueMaximum Length:1The status code indicating if 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
Title:
OverrideRead Only:trueMaximum Length:30The process code provided in the source transaction to override classification, crediting, and rollup processing. -
SourceEventDate: string
(date)
Title:
Event DateRead Only:trueThe date of the earning event. 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)
Title:
Event PeriodRead Only:trueThe unique identifier of the calendar period in which the transaction event date falls. -
SourceOrgId: integer
(int64)
Title:
Source BURead Only:trueThe unique identifier of the source business unit of the transaction. -
SourceTrxNumber: string
Title:
Transaction NumberRead Only:trueMaximum Length:30The transaction number which resulted in the incentive earnings. -
SplitPct: number
Title:
Split PercentRead Only:trueThe percentage number applied against the transaction amount to calculate the credit amount. -
SrpAlternatePayeeId: integer
(int64)
Read Only:
trueThe unique identifier of the alternate person who is eligible to receive payment for this earnings. -
SrpCompensationPlanId: integer
(int64)
Read Only:
trueThe unique identifier of the assignment of the compensation plan to the participant. -
TierSplits: integer
(int64)
Read Only:
trueThe number of rate tiers used to calculate the earning rate. -
TransactionAmount: number
Title:
Transaction AmountRead Only:trueThe transaction amount expressed in processing currency. -
TransactionId: integer
(int64)
Title:
Transaction IDRead Only:trueThe unique identifier of the transaction. -
TransactionType: string
Title:
Transaction TypeRead Only:trueMaximum Length:30The 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.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- BusinessUnitPVO
-
The following properties are defined on the LOV link relation:
- Source Attribute: OrgId; Target Attribute: OrganizationId
- Display Attribute: Name