シミュレーション支給の取得
get
/fscmRestApi/resources/11.13.18.05/incentiveCompensationCalculationSimulations/{SimulationId}/child/Earnings/{EarningId}
リクエスト
パス・パラメータ
- EarningId(required): integer(int64)
計算シミュレーションにおける支給の一意の識別子です。
- SimulationId(required): integer(int64)
計算シミュレーションの一意の識別子。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : incentiveCompensationCalculationSimulations-Earnings-item-response
タイプ:
ソースを表示
object
-
CalculationCurrency: string
読取り専用:
true
最大長:15
支給額の処理通貨を示すコード。 処理通貨は、ビジネス・ユニットの営業通貨または参加者ホーム通貨として選択されます。 「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用して、処理通貨パラメータをレビューします。 -
CommissionValue: number
読取り専用:
true
支給額の計算に使用されたインセンティブ・レート表金額(パーセント)。 -
CompensationPlanId: integer (int64)
読取り専用:
true
支給項目が計算される報酬プランの一意の識別子です。 -
CompensationPlanName: string
タイトル:
Compensation Plan
読取り専用:true
最大長:80
支給が計算される報酬プランの名前。 -
ConversionRate: number
読取り専用:
true
処理通貨を営業通貨に換算する換算レート。 -
CreatedBy: string
読取り専用:
true
最大長:64
シミュレーション支給を作成したユーザーです。 -
CreatedDuring: string
読取り専用:
true
最大長:30
このレコードが作成されたフェーズ。 指定可能な値は、ロールアップ、適格、計算です。 -
CreationDate: string (date-time)
読取り専用:
true
シミュレーション支給が作成された日時です。 -
CreditAmount: number
読取り専用:
true
処理通貨で表されるクレジット金額。 -
CreditedParticipantId: integer (int64)
読取り専用:
true
関係者の一意の識別子。 -
EarningAmount: number
読取り専用:
true
処理通貨で表される対象額です。 -
EarningId: integer (int64)
読取り専用:
true
計算シミュレーションにおける支給の一意の識別子です。 -
EarningType: string
読取り専用:
true
最大長:30
プラン・コンポーネントの支給タイプのタイプです。 この値は、支給を金額および金額以外のカテゴリに分類するために使用されます。 -
EarningTypeId: integer (int64)
読取り専用:
true
支給タイプの一意の識別子です。 -
EligibleCatId: integer (int64)
読取り専用:
true
クレジット・カテゴリの一意の識別子。 -
ErrorReason: string
読取り専用:
true
最大長:150
支給のステータスがエラーである理由を説明する理由。 -
FormulaEcatId: integer (int64)
読取り専用:
true
プラン・コンポーネントのクレジット・カテゴリの一意の識別子。 -
FormulaId: integer (int64)
読取り専用:
true
インセンティブ算式の一意の識別子。 -
FormulaWeight: number
読取り専用:
true
プラン・コンポーネントが報酬プランに与える影響の割合(ターゲット・インセンティブ・パーセントとも呼ばれます)。 -
HomeCurrencyCode: string
読取り専用:
true
最大長:15
支払トランザクションのソース・イベント日の時点で有効な参加者ホーム通貨を示すコード。 関係者スナップショット作業領域の「参加者詳細の管理」ページを使用して、有効な関係者属性をレビューします。 -
HomeCurrencyConversionRate: number
読取り専用:
true
処理通貨をホーム通貨に換算する換算レート。 -
HomeEarningAmount: number
読取り専用:
true
関係者ホーム通貨で表された対象額です。 -
InputAchieved: number
読取り専用:
true
プラン・コンポーネントで定義された入力式に基づいて支給を計算するために、レート表に渡される金額。 -
LastUpdatedBy: string
読取り専用:
true
最大長:64
シミュレーション支給を最後に更新したユーザー。 -
links: array Links
タイトル:
Links
リソース・インスタンスに関連付けられたリンク関係。 -
ObjectStatus: string
読取り専用:
true
最大長:30
計算済、計算エラー、適格または戻し処理済など、支給レコードの現在のステータス。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_EARNING_OBJECT_STATUSの使用可能な参照コードをレビューします。 -
ObjectStatusMeaning: string
読取り専用:
true
最大長:80
プロセス・ステータス参照コードの表示ラベル。 -
OperatingEarningAmount: number
読取り専用:
true
ビジネス・ユニット営業通貨で表される対象額です。 -
OutputAchieved: number
読取り専用:
true
インセンティブ算式の支給式で計算された金額。 -
ParticipantId: integer (int64)
読取り専用:
true
ソース・トランザクションの直接クレジットを受け取ったインセンティブ報酬関係者の一意の識別子です。 -
ParticipantName: string
タイトル:
Participant Name
読取り専用:true
最大長:360
インセンティブ報酬クレジット受領者の名前。 -
PayPeriodId: integer (int64)
読取り専用:
true
支払期間の一意の識別子。 期間番号は、ペイ・シートおよび支給バッチの対象となるカレンダ期間を表します。 期間番号は、「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用してインセンティブ報酬カレンダを定義するときに生成されます。 たとえば、期間番号2018001は、2018年の最初の期間を表します。 -
PlanComponentId: integer (int64)
読取り専用:
true
支給項目が計算されるプラン・コンポーネントの一意の識別子。 -
PlanComponentName: string
タイトル:
Plan Component
読取り専用:true
最大長:80
支給項目が計算されるプラン・コンポーネントの名前。 -
PostingStatus: string
読取り専用:
true
最大長:1
支給が支払プロセスに含まれていたかどうかを示すステータス。 trueの場合、支給は支払に含まれていました。 使用可能な値はfalseおよびtrueです。 -
ProcessCode: string
読取り専用:
true
最大長:30
分類、クレジット処理および積上処理の上書きなど、ソース・トランザクションのプロセスを示すコード。 -
SimulationDeleteFlag: boolean
読取り専用:
true
最大長:1
デフォルト値:false
計算シミュレーション処理中に支給が削除されるかどうかを示します。 -
SimulationId: integer (int64)
読取り専用:
true
シミュレーション支給が属するシミュレーションの一意の識別子。 -
SimulationResultType: string
読取り専用:
true
最大長:30
メジャー結果がシミュレーション実行からのものか、既存の計算済メジャー結果からのものかを示します。 -
SourceEventDate: string (date-time)
読取り専用:
true
支給イベントが発生した日付。 イベント日は、ソース・トランザクション・イベント日または計算グループ化イベント日のいずれかで、インセンティブ支給になりました。 -
SourceEventPeriodId: integer (int64)
読取り専用:
true
トランザクション・イベント日が該当する場合のカレンダ期間の一意の識別子。 -
SourceOrgId: integer (int64)
読取り専用:
true
トランザクションのソース・ビジネス・ユニットの一意の識別子。 -
SourceTrxNumber: string
読取り専用:
true
最大長:30
インセンティブ支給の結果としてのトランザクション番号。 -
SplitPct: number
読取り専用:
true
貸方金額を計算するためにトランザクション金額に対して適用されるパーセント数値。 -
SrpAlternatePayeeId: integer (int64)
読取り専用:
true
この支給項目の支払を受け取る資格がある代替個人の一意の識別子。 -
SrpCompensationPlanId: integer (int64)
読取り専用:
true
参加者への報酬プランの割当の一意の識別子。 -
TierSplits: integer (int64)
読取り専用:
true
支給レートの計算に使用されるレート階層の数。 -
TransactionAmount: number
読取り専用:
true
処理通貨で表されたトランザクション金額。 -
TransactionId: integer (int64)
読取り専用:
true
トランザクションの一意の識別子。 -
TransactionType: string
読取り専用:
true
最大長:30
トランザクションのタイプ。 この値は、オーダー、請求書、クレジット・メモなど、トランザクションのソースを示します。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_TRANSACTION_TYPEの使用可能な参照コードをレビューします。 -
TransactionTypeMeaning: string
読取り専用:
true
最大長:80
トランザクション・タイプ参照コードの表示ラベル。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
object
-
href: string
タイトル:
hyperlink reference
関連リソースへのURI。 -
kind: string
タイトル:
kind
許可された値:[ "collection", "item", "describe", "other" ]
関連リソースの種類。 -
name: string
タイトル:
name
関連リソースへのリンクの名前。 -
properties: object properties
-
rel: string
タイトル:
relation
許可された値:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
リソース・インスタンスとの関係の名前。 例: self.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object
-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。