機械翻訳について

ジャンプ先

• リクエスト
• レスポンス

すべてのシミュレーション支給の取得

get

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

リクエスト

パス・パラメータ

• 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
• finder: string
  コレクションを検索するための事前定義済ファインダとして使用されます。
  
  フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  使用可能なファインダ名および対応するファインダ変数を次に示します:
  
  

  • EarningIdFinder : 指定したシミュレーション支給IDでシミュレーション支給を検索します。
    ファインダ変数:
    • EarningId; integer;シミュレーション支給項目の一意の識別子。
  • PrimaryKey : 指定した主キーを持つシミュレーション支給を検索します。
    ファインダ変数:
    • EarningId; integer;シミュレーション支給項目の一意の識別子。
    • SimulationId; integer;計算シミュレーションの一意の識別子。
• limit: integer
  このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• offset: integer
  リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
• onlyData: boolean
  リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
• orderBy: string
  このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
• q: string
  この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
  
  フォーマット : ?q=expression1;expression2
  
  次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
  

  • CalculationCurrency; string; 支給額の処理通貨を示すコード。 処理通貨は、ビジネス・ユニットの営業通貨または参加者ホーム通貨として選択されます。 「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用して、処理通貨パラメータをレビューします。
  • CommissionValue;数値;支給額の計算に使用されたインセンティブ・レート表の金額(パーセント)。
  • CompensationPlanId; integer;支給項目が計算される報酬プランの一意の識別子。
  • CompensationPlanName; string;支給が計算される報酬プランの名前。
  • ConversionRate; number;処理通貨を営業通貨に換算する換算レート。
  • CreatedBy; string;シミュレーション支給を作成したユーザー。
  • CreatedDuring; string; このレコードが作成されたフェーズ。 指定可能な値は、ロールアップ、適格、計算です。
  • CreationDate; string;シミュレーション支給が作成された日時。
  • CreditAmount; number;処理通貨で表される貸方金額。
  • CreditedParticipantId; integer;参加者の一意の識別子。
  • EarningAmount; number;獲得金額。処理通貨で表されます。
  • EarningId; integer;計算シミュレーションにおける支給の一意の識別子。
  • EarningType; string;プラン・コンポーネントの支給タイプのタイプ。 この値は、支給を金額および金額以外のカテゴリに分類するために使用されます。
  • EarningTypeId; integer;支給タイプの一意の識別子。
  • EligibleCatId; integer;クレジット・カテゴリの一意の識別子。
  • ErrorReason; string; 支給のステータスがエラーである理由を説明する理由。
  • FormulaEcatId; integer;プラン・コンポーネントのクレジット・カテゴリの一意の識別子。
  • FormulaId; integer;インセンティブ算式の一意の識別子。
  • FormulaWeight;数値。プラン・コンポーネントが報酬プランに与える影響の割合(ターゲット・インセンティブ・パーセントとも呼ばれます)。
  • HomeCurrencyCode;文字列。支払トランザクションのソース・イベント日時点で有効な参加者ホーム通貨を示すコード。 関係者スナップショット作業領域の「参加者詳細の管理」ページを使用して、有効な関係者属性をレビューします。
  • HomeCurrencyConversionRate; number;処理通貨をホーム通貨に換算する換算レート。
  • HomeEarningAmount; number;取得金額。参加者ホーム通貨で表されます。
  • InputAchieved; number;プラン・コンポーネントで定義された入力式に基づいて支給を計算するためにレート表に渡される金額。
  • LastUpdatedBy; string;シミュレーション支給を最後に更新したユーザー。
  • ObjectStatus; string;計算済、計算エラー、適格または戻し処理済など、支給レコードの現在のステータス。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_EARNING_OBJECT_STATUSの使用可能な参照コードをレビューします。
  • ObjectStatusMeaning; string;プロセス・ステータス参照コードの表示ラベル。
  • OperatingEarningAmount; number;獲得金額。ビジネス・ユニット営業通貨で表されます。
  • OutputAchieved; number;インセンティブ算式の支給式によって計算された金額。
  • ParticipantId; integer;ソース・トランザクションに対して直接クレジットを受け取ったインセンティブ報酬関係者の一意の識別子。
  • ParticipantName; string;インセンティブ報酬クレジット受領者の名前。
  • PayPeriodId; integer;支払期間の一意の識別子。 期間番号は、ペイ・シートおよび支給バッチの対象となるカレンダ期間を表します。 期間番号は、「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用してインセンティブ報酬カレンダを定義するときに生成されます。 たとえば、期間番号2018001は、2018年の最初の期間を表します。
  • PlanComponentId; integer;支給項目が計算されるプラン・コンポーネントの一意の識別子。
  • PlanComponentName; string;支給が計算されるプラン・コンポーネントの名前。
  • PostingStatus; string; 支給が支払プロセスに含まれていたかどうかを示すステータス。 trueの場合、支給は支払に含まれていました。 使用可能な値はfalseおよびtrueです。
  • ProcessCode;文字列。分類、クレジット処理およびロールアップ処理を上書きするなど、ソース・トランザクションのプロセスを示すコード。
  • SimulationDeleteFlag; boolean;計算シミュレーション処理中に支給が削除されるかどうかを示します。
  • SimulationId; integer;シミュレーション支給が属するシミュレーションの一意の識別子。
  • SimulationResultType; string; メジャー結果がシミュレーション実行によるものか、既存の計算済メジャー結果からのものかを示します。
  • SourceEventDate; string;支給イベントが発生した日付。 イベント日は、ソース・トランザクション・イベント日または計算グループ化イベント日のいずれかで、インセンティブ支給になりました。
  • SourceEventPeriodId; integer; トランザクション・イベント日付が該当するカレンダ期間の一意の識別子。
  • SourceOrgId; integer;トランザクションのソース・ビジネス・ユニットの一意の識別子。
  • SourceTrxNumber; string; インセンティブ支給が発生したトランザクション番号。
  • SplitPct; number;貸方金額を計算するためにトランザクション金額に対して適用されるパーセント数。
  • SrpAlternatePayeeId; integer; この支給項目に対する支払を受け取る資格がある代替個人の一意の識別子。
  • SrpCompensationPlanId; integer; 参加者への報酬プランの割当ての一意の識別子。
  • TierSplits; integer;支給レートの計算に使用されるレート階層の数。
  • TransactionAmount; number;処理通貨で表されるトランザクション金額。
  • TransactionId; integer;トランザクションの一意の識別子。
  • TransactionType; string;トランザクションのタイプ。 この値は、オーダー、請求書、クレジット・メモなど、トランザクションのソースを示します。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_TP_TRANSACTION_TYPEの使用可能な参照コードをレビューします。
  • TransactionTypeMeaning; string;トランザクション・タイプ参照コードの表示ラベル。
• totalResults: boolean
  "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。

ヘッダー・パラメータ

• 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

タイプ: object

ソースを表示

• count(required): integer
  現在の範囲で返されたリソース・インスタンスの数。
• hasMore(required): boolean
  サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
• items: array Items
  タイトル: Items

  コレクション内のアイテム。
• limit(required): integer
  サーバーで使用される実際のページング・サイズ。
• links(required): array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• offset(required): integer
  現在のページで使用されるオフセット値。
• totalResults: integer
  "?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "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"
            }
        }
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

• 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"
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

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

ネストされたスキーマ : 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

  トランザクション・タイプ参照コードの表示ラベル。

{
    "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
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

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

ネストされたスキーマ : リンク

タイプ: 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.

{
    "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."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

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

「トップに戻る」