機械翻訳について

ジャンプ先

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

プラン・コンポーネントの更新

patch

/fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}

リクエスト

パス・パラメータ

• planComponentsUniqID(required): string
  これは、プラン・コンポーネント・リソースのコンポジット・キー(PlanComponentIdおよびOrgId)を構成する属性のハッシュ・キーで、プラン・コンポーネントのインスタンスを一意に識別するために使用されます。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、プラン・コンポーネントの特定のインスタンスに移動するために、主キー値に対するフィルタを使用してプラン・コンポーネント・コレクション・リソースを問い合せる必要があります。
  
  次に例を示します: planComponents?q=PlanComponentId=<value1>;OrgId=<value2>

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

サポートされるメディア・タイプ

• application/json

リクエスト本文 - application/json ()

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

• CalculationPhase: 整数(int32)
  タイトル: Calculation Phase

  デフォルト値: 1

  アプリケーションでプラン・コンポーネントが計算対象とみなされるフェーズ。 サポートされている2つのフェーズ: フェーズ1およびフェーズ2。 取り得る値は1と2です。デフォルト値は1です。 許容可能な値のリストは、参照CN_CALCULATION_PHASEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• Description: string
  タイトル: Description

  最大長: 1000

  プラン・コンポーネントに関連するユーザーが追加した追加詳細。
• DisplayName: string
  タイトル: Display Name

  最大長: 80

  このプラン・コンポーネントを表すために営業担当ユーザー・インタフェース画面に表示されるプラン・コンポーネントのオプション名。
• EndDate: 文字列(日付)
  タイトル: End Date

  プラン・コンポーネントが非アクティブになる日付。 書式はyyyy-mm-ddです。
• IncentiveType: string
  タイトル: Incentive Type

  最大長: 30

  賞与やコミッションなど、インセンティブ・タイプを表す属性。 指定可能な値には、BONUS、COMMISSIONおよびSTANDARDがあります。 許容可能な値のリストは、参照CN_REPORT_GROUPで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• Name: string
  タイトル: Plan Component Name

  最大長: 80

  プラン・コンポーネントの名前。パフォーマンスに基づいて参加者の支給を定義します。
• PaymentMadeThroughThirdPartyFlag: boolean
  タイトル: Payment Made Through Third Party

  最大長: 1

  デフォルト値: false

  このプラン・コンポーネントの支払を他のリソースから実行できるかどうかを示します。 取り得る値は、N、FALSE、YまたはTRUEです。 デフォルト値はFALSEです。 許容可能な値のリストは、参照CN_YES_NOで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• PaymentPlanCategory: string
  タイトル: Payment Plan Category

  最大長: 30

  デフォルト値: STANDARD

  プラン・コンポーネント間で参加者の支払プランから支払調整を配賦するために使用される支払プラン・カテゴリです。 可能な値には、提供されるサービスの報酬月額、販売された製品、または追加の業績に対する報酬額のCOMMISSION、提供されるサービスや販売された製品に対する報酬額のCOMMISSION、販売者に報奨する一般的な方法、保証対象特定の期間にコミッション営業担当が受け取ることが保証される最小金額と、支払プラン調整の決定に使用されるプラン・コンポーネントに適用される一般条件であるSTANDARDです。 デフォルト値はSTANDARDです。 許容可能な値のリストは、参照CN_PAYMENT_PLAN_CATEGORYで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• planComponentIncentiveFormulas: array Plan Component - Incentive Formulas
  タイトル: Plan Component - Incentive Formulas

  プラン・コンポーネント - インセンティブ算式リソースは、インセンティブ算式のプラン・コンポーネントへの関連付けを更新するために使用されます。 また、プラン・コンポーネントに関連付けられたインセンティブ算式のすべての詳細を表示するために使用することもできます。 このレコードでは、支給の計算に使用するフォーミュラを指定し、このレベルの追加詳細を提供します。 これは、プラン・コンポーネントが作成され、後で更新する必要がある場合に、値なしで自動的に作成されます。
• planComponentPerformanceMeasures: array Plan Component - Performance Measures
  タイトル: Plan Component - Performance Measures

  プラン・コンポーネント - パフォーマンス・メジャー・リソースは、パフォーマンス・メジャーとプラン・コンポーネントの関連付けを作成、更新または削除するために使用されます。 また、プラン・コンポーネントでパフォーマンス・メジャーのすべての詳細を表示するために使用することもできます。 プラン・コンポーネント - パフォーマンス・メジャー・レコードは、パフォーマンス・メジャーをプラン・コンポーネントにリンクし、このレベルで追加詳細を提供します。 このレコードを作成する前に、パフォーマンス・メジャーが存在している必要があります。
• planComponentsDFF: array Plan Component Descriptive Flex Fields
  タイトル: Plan Component Descriptive Flex Fields

  プラン・コンポーネント - 付加フレックスフィールド・リソースは、プラン・コンポーネントのユーザー定義値の格納に使用されます。 新しいAPI名を定義するには、Setup and Maintenance(設定および保守)に移動し、Manage Descriptive Flex Fields(付加フレックスフィールドの管理)タスクを開きます。
• SplitOption: string
  タイトル: Split Option

  入力番号をレート表ディメンションに分割する方法を示します。 可能な値には、達成全体に単一のレートを適用するNONE、階層内の達成に対して固定される複数のレートを適用するNON PROPORTIONAL、階層内の達成に対して比例する複数のレートを適用するPROPORTIONALなどがあります。 デフォルト値はNONEです。 許容可能な値のリストは、参照CN_SPLIT_TYPE_OPTIONで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• StartDate: 文字列(日付)
  タイトル: Start Date

  プラン・コンポーネントがアクティブになる日付。 書式はyyyy-mm-ddです。
• ValidForCalculation: string
  タイトル: Valid for Calculation

  最大長: 30

  デフォルト値: INCOMPLETE

  プラン・コンポーネントの計算準備が完了しているかどうかを示します。 可能な値には、有効で計算の準備ができている場合はCOMPLETE、無効で計算の準備ができていない場合はINCOMPLETEが含まれます。 デフォルト値はINCOMPLETEです。 許容可能な値のリストは、参照CN_FORMULA_STATUSで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。

{
    "type":"object",
    "properties":{
        "PaymentMadeThroughThirdPartyFlag":{
            "title":"Payment Made Through Third Party",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the payment for this plan component can be made through other resources. Possible values include N or FALSE and Y or TRUE. The default value is FALSE. A list of acceptable values is defined in the lookup CN_YES_NO. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"radio"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The additional details added by the user related to a plan component.",
            "nullable":true
        },
        "planComponentIncentiveFormulas":{
            "title":"Plan Component - Incentive Formulas",
            "type":"array",
            "description":"The plan component - incentive formulas resource is used to update the association of an incentive formula to the plan component. It can also be used to display all the details of a incentive formula associated to a plan component. This record specifies the formula used to calculate the earnings and provides additional details at this level.\nThis is created automatically, without any values, when a plan component is created and has to be updated later.",
            "items":{
                "$ref":"#/components/schemas/planComponents-planComponentIncentiveFormulas-item-patch-request"
            }
        },
        "ValidForCalculation":{
            "title":"Valid for Calculation",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the plan component is ready for calculation. Possible values include COMPLETE for valid and ready for calculation and INCOMPLETE for not valid and not ready for calculation. The default value is INCOMPLETE. A list of acceptable values is defined in the lookup CN_FORMULA_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "default":"INCOMPLETE",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "planComponentsDFF":{
            "title":"Plan Component Descriptive Flex Fields",
            "type":"array",
            "description":"The plan component - descriptive flex fields resource is used to store user defined values for the plan component. A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.",
            "items":{
                "$ref":"#/components/schemas/planComponents-planComponentsDFF-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "IncentiveType":{
            "title":"Incentive Type",
            "maxLength":30,
            "type":"string",
            "description":"The attribute representing the incentive type, such as bonus or commission. Possible values include BONUS, COMMISSION, and STANDARD. A list of acceptable values is defined in the lookup CN_REPORT_GROUP. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SplitOption":{
            "title":"Split Option",
            "type":"string",
            "description":"Indicates how to split the input number to a rate table dimension. Possible values include NONE to apply a single rate for the entire attainment, NON PROPORTIONAL to apply multiple rates, which are fixed for an attainment within a tier, and PROPORTIONAL to apply multiple rates, which are proportional for an attainment within a tier. The default value is NONE. A list of acceptable values is defined in the lookup CN_SPLIT_TYPE_OPTION. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the plan component becomes inactive. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false
        },
        "Name":{
            "title":"Plan Component Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of a plan component, which defines the earnings of a participant based on their performance.",
            "nullable":false
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the plan component becomes active. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false
        },
        "PaymentPlanCategory":{
            "title":"Payment Plan Category",
            "maxLength":30,
            "type":"string",
            "description":"The payment plan category which is used to allocate payment adjustments from a participant's payment plan among plan components. Possible values include BONUS for remuneration for services rendered, products sold, or for extra performance, COMMISSION for remuneration for services rendered or products sold, a common way to reward sales people, GUARANTEE for the minimum amount that a commission sales person is guaranteed to receive for a given period of time, and STANDARD which is a generic term applied to any plan component used for determining payment plan adjustments. The default value is STANDARD. A list of acceptable values is defined in the lookup CN_PAYMENT_PLAN_CATEGORY . Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "default":"STANDARD",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "planComponentPerformanceMeasures":{
            "title":"Plan Component - Performance Measures",
            "type":"array",
            "description":"The plan component - performance measures resource is used to create, update or delete the association of a performance measure with a plan component. It can also be used to display all the details of performance measures under a plan component. A plan component - performance measure record links the performance measure to a plan component and provides additional details at this level.\nA performance measure needs to exist before creating this record.",
            "items":{
                "$ref":"#/components/schemas/planComponents-planComponentPerformanceMeasures-item-patch-request"
            }
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":80,
            "type":"string",
            "description":"The optional name of the plan component that is shown to the sales representatives user interface screens to represent this plan component.",
            "nullable":true
        },
        "CalculationPhase":{
            "title":"Calculation Phase",
            "type":"integer",
            "description":"The phase in which the application considers plan component for calculation. Two supported phases: Phase 1 and Phase 2. Possible values include 1 and 2.The default value is 1. A list of acceptable values is defined in the lookup CN_CALCULATION_PHASE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "controlType":"choice",
                "precision":9
            }
        }
    }
}

ネストされたスキーマ : プラン・コンポーネント - インセンティブ算式

タイプ: array

タイトル: Plan Component - Incentive Formulas

プラン・コンポーネント - インセンティブ算式リソースは、インセンティブ算式のプラン・コンポーネントへの関連付けを更新するために使用されます。 また、プラン・コンポーネントに関連付けられたインセンティブ算式のすべての詳細を表示するために使用することもできます。 このレコードでは、支給の計算に使用するフォーミュラを指定し、このレベルの追加詳細を提供します。 これは、プラン・コンポーネントが作成され、後で更新する必要がある場合に、値なしで自動的に作成されます。

ソースを表示

• Array of: object schema

{
    "title":"Plan Component - Incentive Formulas",
    "type":"array",
    "description":"The plan component - incentive formulas resource is used to update the association of an incentive formula to the plan component. It can also be used to display all the details of a incentive formula associated to a plan component. This record specifies the formula used to calculate the earnings and provides additional details at this level.\nThis is created automatically, without any values, when a plan component is created and has to be updated later.",
    "items":{
        "$ref":"#/components/schemas/planComponents-planComponentIncentiveFormulas-item-patch-request"
    }
}

ネストされたスキーマ : プラン・コンポーネント - パフォーマンス・メジャー

タイプ: array

タイトル: Plan Component - Performance Measures

プラン・コンポーネント - パフォーマンス・メジャー・リソースは、パフォーマンス・メジャーとプラン・コンポーネントの関連付けを作成、更新または削除するために使用されます。 また、プラン・コンポーネントでパフォーマンス・メジャーのすべての詳細を表示するために使用することもできます。 プラン・コンポーネント - パフォーマンス・メジャー・レコードは、パフォーマンス・メジャーをプラン・コンポーネントにリンクし、このレベルで追加詳細を提供します。 このレコードを作成する前に、パフォーマンス・メジャーが存在している必要があります。

ソースを表示

• Array of: object schema

{
    "title":"Plan Component - Performance Measures",
    "type":"array",
    "description":"The plan component - performance measures resource is used to create, update or delete the association of a performance measure with a plan component. It can also be used to display all the details of performance measures under a plan component. A plan component - performance measure record links the performance measure to a plan component and provides additional details at this level.\nA performance measure needs to exist before creating this record.",
    "items":{
        "$ref":"#/components/schemas/planComponents-planComponentPerformanceMeasures-item-patch-request"
    }
}

ネストされたスキーマ : プラン・コンポーネント付加フレックスフィールド

タイプ: array

タイトル: Plan Component Descriptive Flex Fields

プラン・コンポーネント - 付加フレックスフィールド・リソースは、プラン・コンポーネントのユーザー定義値の格納に使用されます。 新しいAPI名を定義するには、Setup and Maintenance(設定および保守)に移動し、Manage Descriptive Flex Fields(付加フレックスフィールドの管理)タスクを開きます。

ソースを表示

• Array of: object planComponents-planComponentsDFF-item-patch-request

{
    "title":"Plan Component Descriptive Flex Fields",
    "type":"array",
    "description":"The plan component - descriptive flex fields resource is used to store user defined values for the plan component. A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.",
    "items":{
        "$ref":"#/components/schemas/planComponents-planComponentsDFF-item-patch-request"
    },
    "x-cardinality":"1"
}

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

タイプ: object

ソースを表示

• CalculateEnddateParticipantFlag: boolean
  タイトル: Calculate end-dated participants

  現在の計算期間より前に終了日を持つ参加者が計算の対象となるかどうかを示します。 取り得る値はFALSEとTRUEです。 許容可能な値のリストは、参照CN_YES_NOで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 これは、「インセンティブの計算」フィールドが間隔ごと(BONUS)の場合にのみ適用されます。
• IncentiveFormulaExpressionId: integer (int64)
  タイトル: Output Expression ID

  インセンティブ算式で使用される式レコードの一意の識別子。 支給の計算に使用される式です。
• IncentiveFormulaExpressionName: string
  タイトル: Expression Name

  最大長: 160

  インセンティブ算式で使用される式の名前。 支給の計算に使用される式です。
• IncludeIndirectCredits: string
  タイトル: Include Indirect Credits

  プラン・コンポーネントの計算に含める間接クレジットのタイプ。 可能な値は、このプラン・コンポーネントの達成または支給計算に含まれるすべての間接クレジットに対してALL、このプランの達成または支給計算に含められる積上間接クレジットのみのMGRですこのプラン・コンポーネントの達成または支給計算に含められる間接クレジットがない場合はなし、このプラン・コンポーネントの達成または支給計算に含められるチーム間接クレジットのみの場合はチーム。 デフォルト値はNONEです。 受理可能な値のリストは、参照CN_PLAN_INDIRECT_CREDITで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• PayoutFrequency: string
  タイトル: Payout Frequency

  デフォルト値: -1000

  支給が計算される頻度を決定する間隔値です。 間隔は、月、四半期、年などの時間の単位を表します。 デフォルト値は'-1000'です。
• planComponentRateDimensionalInputs: array Plan Component - Rate Dimensional Input Expressions
  タイトル: Plan Component - Rate Dimensional Input Expressions

  プラン・コンポーネント - レート・ディメンション入力式リソースは、入力式とプラン・コンポーネントの関連付けを更新するために使用されます。 また、プラン・コンポーネントに関連付けられた入力式のすべての詳細を表示するために使用することもできます。 このレコードは、レート表のレート・ディメンションの入力を指定し、このレベルの追加詳細を提供します。 このレコードを作成する前に、有効な使用方法もある有効な式が存在する必要があります。 レート表が割り当てられた後にのみ、入力式を割り当てる必要があります。
• planComponentRateTables: array Plan Component - Rate Tables
  タイトル: Plan Component - Rate Tables

  プラン・コンポーネント - レート表リソースは、レート表とプラン・コンポーネントの関連付けを作成、更新または削除するために使用されます。 また、パフォーマンス・メジャーに関連付けられたレート表のすべての詳細を表示するために使用することもできます。 このレコードは、レート表をパフォーマンス・メジャーにリンクし、このレベルの追加詳細を提供します。 このレコードを作成する前に、レート表が存在する必要があります。 レート表関連は、インセンティブ算式が作成された後にのみ作成できます。
• ResetInterval: integer (int64)
  タイトル: Reset Interval

  調整支給または累積支給が計算される期間です。 間隔は、月、四半期、年などの時間の単位を表します。 これは、True UpがYの場合にのみ適用されます。
• TrueUpFlag: boolean
  タイトル: True up

  最大長: 1

  当期間に対して計算された支給に、以前に計算された金額または支払金額(累積)が含まれているかどうかを示します 計算エンジンは、現在の計算済支給項目から前の支給項目を自動的に減算します。 取り得る値はFALSEとTRUEです。

{
    "type":"object",
    "properties":{
        "planComponentRateDimensionalInputs":{
            "title":"Plan Component - Rate Dimensional Input Expressions",
            "type":"array",
            "description":"The plan component - rate dimensional input expressions resource is used to update the association of a input expression with a plan component. It can also be used to display all  the details of input expressions associated with a plan component. This record specifies the inputs of a rate dimension of a rate table and provides additional details at this level.\nA valid expression which also has a valid usage needs to exist before creating this record. You should assign the input expression only after the rate table is assigned.",
            "items":{
                "$ref":"#/components/schemas/planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-patch-request"
            }
        },
        "ResetInterval":{
            "title":"Reset Interval",
            "type":"integer",
            "description":"It is the span of time for which the true up or cumulative earnings are calculated. Interval would represent a unit of time like month, quarter, year. This is applicable only if True Up is Y.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "CalculateEnddateParticipantFlag":{
            "title":"Calculate end-dated participants",
            "type":"boolean",
            "description":"Indicates whether participants who have an end date before the current calculation period are considered for calculation. Possible values include FALSE and TRUE. A list of acceptable values is defined in the lookup CN_YES_NO. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. This is only applicable if Calculate Incentive field is Per interval ('BONUS').",
            "nullable":true
        },
        "planComponentRateTables":{
            "title":"Plan Component - Rate Tables",
            "type":"array",
            "description":"The plan component - rate tables resource is used to create, update or delete the association of a rate table with a plan component. It can also be used to display all the details of rate table associated with a performance measure. This record links the rate table to a performance measure and provides additional details at this level.\nA rate table needs to exist before creating this record. The rate table association can be created only after an incentive formula is created.",
            "items":{
                "$ref":"#/components/schemas/planComponents-planComponentIncentiveFormulas-planComponentRateTables-item-patch-request"
            }
        },
        "PayoutFrequency":{
            "title":"Payout Frequency",
            "type":"string",
            "description":"This is the interval value that determines how often the earning is calculated. Interval would represent a unit of time like month, quarter, year. The default value is '-1000'.",
            "nullable":true,
            "default":"-1000",
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "OrgId"
                ]
            }
        },
        "IncentiveFormulaExpressionId":{
            "title":"Output Expression ID",
            "type":"integer",
            "description":"The unique identifier of the expression record used in the incentive formula. This is the expression that is used to calculate the earnings.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "TrueUpFlag":{
            "title":"True up",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the earnings calculated for the current period includes the previously calculated or paid amount (Cumulative.) Calculation engine then automatically subtracts previous earnings from the current earning calculated. Possible values include FALSE and TRUE.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "IncludeIndirectCredits":{
            "title":"Include Indirect Credits",
            "type":"string",
            "description":"Type of indirect credits to include in the calculation, for the plan component. Possible values include ALL for all indirect credits that are included for attainment or earnings calculation for this plan component, MGR for only rollup indirect credits that are included for attainment or earnings calculation for this plan component, NONE for no indirect credits that are included for attainment or earnings calculation for this plan component, and TEAM for only team indirect credits that are included for attainment or earnings calculation for this plan component. The default value is NONE. A list of acceptable values is defined in the lookup CN_PLAN_INDIRECT_CREDIT. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "IncentiveFormulaExpressionName":{
            "title":"Expression Name",
            "maxLength":160,
            "type":"string",
            "description":"The name for the expression used in the incentive formula. This is the expression that is used to calculate the earnings.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov",
                "dependencies":[
                    "ProcessTransactions"
                ]
            }
        }
    }
}

ネストされたスキーマ : プラン・コンポーネント - レート・ディメンション入力式

タイプ: array

タイトル: Plan Component - Rate Dimensional Input Expressions

プラン・コンポーネント - レート・ディメンション入力式リソースは、入力式とプラン・コンポーネントの関連付けを更新するために使用されます。 また、プラン・コンポーネントに関連付けられた入力式のすべての詳細を表示するために使用することもできます。 このレコードは、レート表のレート・ディメンションの入力を指定し、このレベルの追加詳細を提供します。 このレコードを作成する前に、有効な使用方法もある有効な式が存在する必要があります。 レート表が割り当てられた後にのみ、入力式を割り当てる必要があります。

ソースを表示

• Array of: object planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-patch-request

{
    "title":"Plan Component - Rate Dimensional Input Expressions",
    "type":"array",
    "description":"The plan component - rate dimensional input expressions resource is used to update the association of a input expression with a plan component. It can also be used to display all  the details of input expressions associated with a plan component. This record specifies the inputs of a rate dimension of a rate table and provides additional details at this level.\nA valid expression which also has a valid usage needs to exist before creating this record. You should assign the input expression only after the rate table is assigned.",
    "items":{
        "$ref":"#/components/schemas/planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-patch-request"
    }
}

ネストされたスキーマ : プラン・コンポーネント - レート表

タイプ: array

タイトル: Plan Component - Rate Tables

プラン・コンポーネント - レート表リソースは、レート表とプラン・コンポーネントの関連付けを作成、更新または削除するために使用されます。 また、パフォーマンス・メジャーに関連付けられたレート表のすべての詳細を表示するために使用することもできます。 このレコードは、レート表をパフォーマンス・メジャーにリンクし、このレベルの追加詳細を提供します。 このレコードを作成する前に、レート表が存在する必要があります。 レート表関連は、インセンティブ算式が作成された後にのみ作成できます。

ソースを表示

• Array of: object schema

{
    "title":"Plan Component - Rate Tables",
    "type":"array",
    "description":"The plan component - rate tables resource is used to create, update or delete the association of a rate table with a plan component. It can also be used to display all the details of rate table associated with a performance measure. This record links the rate table to a performance measure and provides additional details at this level.\nA rate table needs to exist before creating this record. The rate table association can be created only after an incentive formula is created.",
    "items":{
        "$ref":"#/components/schemas/planComponents-planComponentIncentiveFormulas-planComponentRateTables-item-patch-request"
    }
}

ネストされたスキーマ : planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-patch-request

タイプ: object

ソースを表示

• IncentiveFormulaId: integer (int64)
  タイトル: Incentive Formula ID

  インセンティブ算式レコードの一意の識別子。 1つのプラン・コンポーネントに対して1つのインセンティブ算式のみを指定できます。
• InputExpressionId: integer (int64)
  タイトル: Input Expression ID

  レート表のレート・ディメンションの入力式の一意の識別子。
• InputExpressionName: string
  タイトル: Input Expression Name

  最大長: 160

  プラン・コンポーネントで使用されるレート表のレート・ディメンションの入力式の名前。 入力式は、トランザクションから評価する値を制御し、結果と対応するレート表ディメンションを照合します。
• RateDimSequence: integer (int64)
  タイトル: Sequence

  レート表の入力式の順序。
• SplitFlag: boolean
  タイトル: Split

  最大長: 1

  デフォルト値: false

  レートを階層間で分割する場合、分割オプションは1つのレート・ディメンション入力式にのみ適用できます。 使用するレート・ディメンション入力式(レート・ディメンション)を指定します。 可能な値はFALSEおよびTRUEです。 デフォルト値はFALSEです。

{
    "type":"object",
    "properties":{
        "IncentiveFormulaId":{
            "title":"Incentive Formula ID",
            "type":"integer",
            "description":"The unique identifier of the incentive formula record. There can be only one incentive formula for one plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "InputExpressionId":{
            "title":"Input Expression ID",
            "type":"integer",
            "description":"The unique identifier of the input expression for the rate dimension of a rate table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RateDimSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order of the input expressions for the rate table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SplitFlag":{
            "title":"Split",
            "maxLength":1,
            "type":"boolean",
            "description":"When splitting the rate across tiers, the split option can apply to only one rate dimension input expression. This specifies which rate dimension input expression (rate dimension) to use. Possible values are FALSE and TRUE. The default value is FALSE.",
            "nullable":true,
            "default":false
        },
        "InputExpressionName":{
            "title":"Input Expression Name",
            "maxLength":160,
            "type":"string",
            "description":"The name of the input expression for the rate dimension of a rate table used in the plan component. The input expression drives a value to evaluate from the transaction and matches the results with the corresponding rate table dimension.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        }
    }
}

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

タイプ: object

ソースを表示

• EndDate: 文字列(日付)
  タイトル: End Date

  レート表がプラン・コンポーネントに対して非アクティブになる日付。 書式はyyyy-mm-ddです。
• StartDate: 文字列(日付)
  タイトル: Start Date

  レート表がプラン・コンポーネントに対してアクティブになる日付。 書式はyyyy-mm-ddです。

{
    "type":"object",
    "properties":{
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the rate table becomes active for the plan component. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the rate table becomes inactive for the plan component. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true
        }
    }
}

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

タイプ: object

ソースを表示

• CalculationSequence: 整数(int32)
  タイトル: Calculation Sequence

  デフォルト値: 1

  プラン・コンポーネント内のパフォーマンス・メジャーが計算エンジンで考慮される順序。 これは、依存メジャーが他の基準メジャーの計算結果を参照する場合に設定されます。 依存メジャーは、基準メジャーよりも高い計算順序にする必要があります。
• EarningBasis: string
  タイトル: Earning Basis

  最大長: 1

  デフォルト値: Y

  達成計算と支給計算で同じクレジット・カテゴリを使用するかどうか、およびインセンティブ算式で計算にメジャー達成を使用するかどうかを指定します。 使用可能な値はY、Nです。 Yのままにして、プラン・コンポーネントのインセンティブ算式でパフォーマンス・メジャー達成を参照します。 トランザクションを個別に処理するパフォーマンス・メジャーが、イベントごとにインセンティブを計算するプラン・コンポーネントに関連付けられている場合、支給基準はYである必要があります。 許容可能な値のリストは、参照CN_YES_NOで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• PerformanceMeasureId: integer (int64)
  タイトル: Performance Measure ID

  パフォーマンス・メジャー・レコードの一意の識別子。
• PerformanceMeasureWeight: integer (int64)
  タイトル: Weight

  デフォルト値: 100

  パフォーマンス・メジャーがプラン・コンポーネントに与える影響の割合。
• PlanComponentId: integer (int64)
  タイトル: Plan Component ID

  ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。

{
    "type":"object",
    "properties":{
        "PerformanceMeasureWeight":{
            "title":"Weight",
            "type":"integer",
            "description":"The percentage of influence a performance measure has on the plan component.",
            "format":"int64",
            "nullable":true,
            "default":100,
            "x-hints":{
                "precision":18
            }
        },
        "PerformanceMeasureId":{
            "title":"Performance Measure ID",
            "type":"integer",
            "description":"The unique identifier of a performance measure record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "EarningBasis":{
            "title":"Earning Basis",
            "maxLength":1,
            "type":"string",
            "description":"Specifies whether attainment and earnings calculations use the same credit categories and whether the incentive formula uses the measure attainment in calculations. Possible values include Y, N. \nKeep it Y, references the performance measure attainment in the incentive formula expression of the plan component. \nEarning basis must be Y when a performance measure that processes transactions individually is associated with plan components that calculate incentive per event. A list of acceptable values is defined in the lookup CN_YES_NO. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PlanComponentId":{
            "title":"Plan Component ID",
            "type":"integer",
            "description":"The unique identifier of the plan component record within a business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CalculationSequence":{
            "title":"Calculation Sequence",
            "type":"integer",
            "description":"The order in which the calculation engine considers a performance measure within a plan component. This is set when dependent measures refer to the calculated results of other base measures. Dependent measures must have a higher calculation sequence than base measures.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":9
            }
        }
    }
}

ネストされたスキーマ : planComponents-planComponentsDFF-item-patch-request

タイプ: object

ソースを表示

• __FLEX_Context: string
  タイトル: Context Segment

  最大長: 30

  このフィールドは、プラン・コンポーネントのフレックス・コンテキスト・セグメント・コードを表します。 どのコンテキスト依存セグメントを表示するかを決定します。
• __FLEX_Context_DisplayValue: string
  タイトル: Context Segment

  このフィールドは、プラン・コンポーネントのフレックス・コンテキスト・セグメント表示名を表します。 どのコンテキスト依存セグメントを表示するかを決定します。

{
    "type":"object",
    "properties":{
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"This field represents the flex context segment display name for the  plan component. It determines which context-sensitive segments are displayed.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"This field represents the flex context segment code for the plan component. It determines which context-sensitive segments are displayed.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            }
        }
    }
}

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : planComponents-item-response

タイプ: object

ソースを表示

• CalculateIncentive: string
  タイトル: Calculate Incentive

  最大長: 30

  イベントごとまたは間隔ごとのプラン・コンポーネント支給計算の性質。 イベントごとに、適格なクレジットがあるたびに収益が生成されることを示します。 間隔ごとは、間隔のすべての適格クレジットが集計され、その間隔に対して1つの支給が生成されることを示します。 指定可能な値には、イベントごとにCOMMISSION、間隔ごとにBONUSがあります。 許容可能な値のリストは、参照CN_PLAN_INCENTIVE_TYPEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• CalculationPhase: 整数(int32)
  タイトル: Calculation Phase

  デフォルト値: 1

  アプリケーションでプラン・コンポーネントが計算対象とみなされるフェーズ。 サポートされている2つのフェーズ: フェーズ1およびフェーズ2。 取り得る値は1と2です。デフォルト値は1です。 許容可能な値のリストは、参照CN_CALCULATION_PHASEで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日付。
• Description: string
  タイトル: Description

  最大長: 1000

  プラン・コンポーネントに関連するユーザーが追加した追加詳細。
• DisplayName: string
  タイトル: Display Name

  最大長: 80

  このプラン・コンポーネントを表すために営業担当ユーザー・インタフェース画面に表示されるプラン・コンポーネントのオプション名。
• EarningType: number
  タイトル: Earning Type

  デフォルト値: -1000

  支給項目を通貨カテゴリおよび非通貨カテゴリに分類するために使用する属性です。 可能な値は、金銭的な利益、ポイント、航空マイルを表します。 この値はOrgIdに依存するため、OrgId値の後に渡す必要があります。 デフォルト値は金銭支給 ('-1000')です。
• EndDate: 文字列(日付)
  タイトル: End Date

  プラン・コンポーネントが非アクティブになる日付。 書式はyyyy-mm-ddです。
• IncentiveType: string
  タイトル: Incentive Type

  最大長: 30

  賞与やコミッションなど、インセンティブ・タイプを表す属性。 指定可能な値には、BONUS、COMMISSIONおよびSTANDARDがあります。 許容可能な値のリストは、参照CN_REPORT_GROUPで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• InvalidReason: string
  タイトル: Reason

  読取り専用: true

  プラン・コンポーネントが無効な理由を説明する事由。
• LastUpdateDate: string (date-time)
  タイトル: Last Update Date

  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのセッション・ログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• Name: string
  タイトル: Plan Component Name

  最大長: 80

  プラン・コンポーネントの名前。パフォーマンスに基づいて参加者の支給を定義します。
• NumberOfDimensions: integer
  タイトル: Number of Dimensions

  読取り専用: true

  プラン・コンポーネントで使用されるレート表のディメンション数。
• OrgId: integer (int64)
  タイトル: Business Unit

  ビジネス・ユニットの一意の識別子。
• PaymentMadeThroughThirdPartyFlag: boolean
  タイトル: Payment Made Through Third Party

  最大長: 1

  デフォルト値: false

  このプラン・コンポーネントの支払を他のリソースから実行できるかどうかを示します。 取り得る値は、N、FALSE、YまたはTRUEです。 デフォルト値はFALSEです。 許容可能な値のリストは、参照CN_YES_NOで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• PaymentPlanCategory: string
  タイトル: Payment Plan Category

  最大長: 30

  デフォルト値: STANDARD

  プラン・コンポーネント間で参加者の支払プランから支払調整を配賦するために使用される支払プラン・カテゴリです。 可能な値には、提供されるサービスの報酬月額、販売された製品、または追加の業績に対する報酬額のCOMMISSION、提供されるサービスや販売された製品に対する報酬額のCOMMISSION、販売者に報奨する一般的な方法、保証対象特定の期間にコミッション営業担当が受け取ることが保証される最小金額と、支払プラン調整の決定に使用されるプラン・コンポーネントに適用される一般条件であるSTANDARDです。 デフォルト値はSTANDARDです。 許容可能な値のリストは、参照CN_PAYMENT_PLAN_CATEGORYで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• PlanComponentId: integer (int64)
  タイトル: Plan Component ID

  ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。
• planComponentIncentiveFormulas: array Plan Component - Incentive Formulas
  タイトル: Plan Component - Incentive Formulas

  プラン・コンポーネント - インセンティブ算式リソースは、インセンティブ算式のプラン・コンポーネントへの関連付けを更新するために使用されます。 また、プラン・コンポーネントに関連付けられたインセンティブ算式のすべての詳細を表示するために使用することもできます。 このレコードでは、支給の計算に使用するフォーミュラを指定し、このレベルの追加詳細を提供します。 これは、プラン・コンポーネントが作成され、後で更新する必要がある場合に、値なしで自動的に作成されます。
• planComponentPerformanceMeasures: array Plan Component - Performance Measures
  タイトル: Plan Component - Performance Measures

  プラン・コンポーネント - パフォーマンス・メジャー・リソースは、パフォーマンス・メジャーとプラン・コンポーネントの関連付けを作成、更新または削除するために使用されます。 また、プラン・コンポーネントでパフォーマンス・メジャーのすべての詳細を表示するために使用することもできます。 プラン・コンポーネント - パフォーマンス・メジャー・レコードは、パフォーマンス・メジャーをプラン・コンポーネントにリンクし、このレベルで追加詳細を提供します。 このレコードを作成する前に、パフォーマンス・メジャーが存在している必要があります。
• planComponentsDFF: array Plan Component Descriptive Flex Fields
  タイトル: Plan Component Descriptive Flex Fields

  プラン・コンポーネント - 付加フレックスフィールド・リソースは、プラン・コンポーネントのユーザー定義値の格納に使用されます。 新しいAPI名を定義するには、Setup and Maintenance(設定および保守)に移動し、Manage Descriptive Flex Fields(付加フレックスフィールドの管理)タスクを開きます。
• SplitOption: string
  タイトル: Split Option

  入力番号をレート表ディメンションに分割する方法を示します。 可能な値には、達成全体に単一のレートを適用するNONE、階層内の達成に対して固定される複数のレートを適用するNON PROPORTIONAL、階層内の達成に対して比例する複数のレートを適用するPROPORTIONALなどがあります。 デフォルト値はNONEです。 許容可能な値のリストは、参照CN_SPLIT_TYPE_OPTIONで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• StartDate: 文字列(日付)
  タイトル: Start Date

  プラン・コンポーネントがアクティブになる日付。 書式はyyyy-mm-ddです。
• ValidForCalculation: string
  タイトル: Valid for Calculation

  最大長: 30

  デフォルト値: INCOMPLETE

  プラン・コンポーネントの計算準備が完了しているかどうかを示します。 可能な値には、有効で計算の準備ができている場合はCOMPLETE、無効で計算の準備ができていない場合はINCOMPLETEが含まれます。 デフォルト値はINCOMPLETEです。 許容可能な値のリストは、参照CN_FORMULA_STATUSで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentMadeThroughThirdPartyFlag":{
            "title":"Payment Made Through Third Party",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the payment for this plan component can be made through other resources. Possible values include N or FALSE and Y or TRUE. The default value is FALSE. A list of acceptable values is defined in the lookup CN_YES_NO. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"radio"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The additional details added by the user related to a plan component.",
            "nullable":true,
            "x-queryable":true
        },
        "planComponentIncentiveFormulas":{
            "title":"Plan Component - Incentive Formulas",
            "type":"array",
            "description":"The plan component - incentive formulas resource is used to update the association of an incentive formula to the plan component. It can also be used to display all the details of a incentive formula associated to a plan component. This record specifies the formula used to calculate the earnings and provides additional details at this level.\nThis is created automatically, without any values, when a plan component is created and has to be updated later.",
            "items":{
                "$ref":"#/components/schemas/planComponents-planComponentIncentiveFormulas-item-response"
            }
        },
        "ValidForCalculation":{
            "title":"Valid for Calculation",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the plan component is ready for calculation. Possible values include COMPLETE for valid and ready for calculation and INCOMPLETE for not valid and not ready for calculation. The default value is INCOMPLETE. A list of acceptable values is defined in the lookup CN_FORMULA_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "default":"INCOMPLETE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SplitOption":{
            "title":"Split Option",
            "type":"string",
            "description":"Indicates how to split the input number to a rate table dimension. Possible values include NONE to apply a single rate for the entire attainment, NON PROPORTIONAL to apply multiple rates, which are fixed for an attainment within a tier, and PROPORTIONAL to apply multiple rates, which are proportional for an attainment within a tier. The default value is NONE. A list of acceptable values is defined in the lookup CN_SPLIT_TYPE_OPTION. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Plan Component Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of a plan component, which defines the earnings of a participant based on their performance.",
            "nullable":false,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the plan component becomes active. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Display Name",
            "maxLength":80,
            "type":"string",
            "description":"The optional name of the plan component that is shown to the sales representatives user interface screens to represent this plan component.",
            "nullable":true,
            "x-queryable":true
        },
        "CalculationPhase":{
            "title":"Calculation Phase",
            "type":"integer",
            "description":"The phase in which the application considers plan component for calculation. Two supported phases: Phase 1 and Phase 2. Possible values include 1 and 2.The default value is 1. A list of acceptable values is defined in the lookup CN_CALCULATION_PHASE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "controlType":"choice",
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "planComponentsDFF":{
            "title":"Plan Component Descriptive Flex Fields",
            "type":"array",
            "description":"The plan component - descriptive flex fields resource is used to store user defined values for the plan component. A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.",
            "items":{
                "$ref":"#/components/schemas/planComponents-planComponentsDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "IncentiveType":{
            "title":"Incentive Type",
            "maxLength":30,
            "type":"string",
            "description":"The attribute representing the incentive type, such as bonus or commission. Possible values include BONUS, COMMISSION, and STANDARD. A list of acceptable values is defined in the lookup CN_REPORT_GROUP. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PlanComponentId":{
            "title":"Plan Component ID",
            "type":"integer",
            "description":"The unique identifier of the plan component record within a business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CalculateIncentive":{
            "title":"Calculate Incentive",
            "maxLength":30,
            "type":"string",
            "description":"The nature of plan component earning calculation, per event or per interval. Per event indicates that an earning will be generated each time there is an eligible credit. Per interval indicates that all eligible credits for the interval will be aggregated to generate one earning for the interval. Possible values include COMMISSION for per event, and BONUS for per interval. A list of acceptable values is defined in the lookup CN_PLAN_INCENTIVE_TYPE. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EarningType":{
            "title":"Earning Type",
            "type":"number",
            "description":"The attribute used to classify earnings into monetary and nonmonetary categories. Possible values represent Monetary earnings, Points, Air miles. This value is dependent on the OrgId so it should be passed after the OrgId value. The default value is Monetary Earnings ('-1000').",
            "nullable":false,
            "default":-1000,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "OrgId"
                ]
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the plan component becomes inactive. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "NumberOfDimensions":{
            "title":"Number of Dimensions",
            "type":"integer",
            "description":"The number of dimensions of the rate table used in the plan component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentPlanCategory":{
            "title":"Payment Plan Category",
            "maxLength":30,
            "type":"string",
            "description":"The payment plan category which is used to allocate payment adjustments from a participant's payment plan among plan components. Possible values include BONUS for remuneration for services rendered, products sold, or for extra performance, COMMISSION for remuneration for services rendered or products sold, a common way to reward sales people, GUARANTEE for the minimum amount that a commission sales person is guaranteed to receive for a given period of time, and STANDARD which is a generic term applied to any plan component used for determining payment plan adjustments. The default value is STANDARD. A list of acceptable values is defined in the lookup CN_PAYMENT_PLAN_CATEGORY . Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "default":"STANDARD",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "planComponentPerformanceMeasures":{
            "title":"Plan Component - Performance Measures",
            "type":"array",
            "description":"The plan component - performance measures resource is used to create, update or delete the association of a performance measure with a plan component. It can also be used to display all the details of performance measures under a plan component. A plan component - performance measure record links the performance measure to a plan component and provides additional details at this level.\nA performance measure needs to exist before creating this record.",
            "items":{
                "$ref":"#/components/schemas/planComponents-planComponentPerformanceMeasures-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InvalidReason":{
            "title":"Reason",
            "type":"string",
            "description":"The reason explaining why the plan component is invalid.",
            "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"
    }
}

ネストされたスキーマ : プラン・コンポーネント - インセンティブ算式

タイプ: array

タイトル: Plan Component - Incentive Formulas

プラン・コンポーネント - インセンティブ算式リソースは、インセンティブ算式のプラン・コンポーネントへの関連付けを更新するために使用されます。 また、プラン・コンポーネントに関連付けられたインセンティブ算式のすべての詳細を表示するために使用することもできます。 このレコードでは、支給の計算に使用するフォーミュラを指定し、このレベルの追加詳細を提供します。 これは、プラン・コンポーネントが作成され、後で更新する必要がある場合に、値なしで自動的に作成されます。

ソースを表示

• Array of: object planComponents-planComponentIncentiveFormulas-item-response

{
    "title":"Plan Component - Incentive Formulas",
    "type":"array",
    "description":"The plan component - incentive formulas resource is used to update the association of an incentive formula to the plan component. It can also be used to display all the details of a incentive formula associated to a plan component. This record specifies the formula used to calculate the earnings and provides additional details at this level.\nThis is created automatically, without any values, when a plan component is created and has to be updated later.",
    "items":{
        "$ref":"#/components/schemas/planComponents-planComponentIncentiveFormulas-item-response"
    }
}

ネストされたスキーマ : プラン・コンポーネント - パフォーマンス・メジャー

タイプ: array

タイトル: Plan Component - Performance Measures

プラン・コンポーネント - パフォーマンス・メジャー・リソースは、パフォーマンス・メジャーとプラン・コンポーネントの関連付けを作成、更新または削除するために使用されます。 また、プラン・コンポーネントでパフォーマンス・メジャーのすべての詳細を表示するために使用することもできます。 プラン・コンポーネント - パフォーマンス・メジャー・レコードは、パフォーマンス・メジャーをプラン・コンポーネントにリンクし、このレベルで追加詳細を提供します。 このレコードを作成する前に、パフォーマンス・メジャーが存在している必要があります。

ソースを表示

• Array of: object planComponents-planComponentPerformanceMeasures-item-response

{
    "title":"Plan Component - Performance Measures",
    "type":"array",
    "description":"The plan component - performance measures resource is used to create, update or delete the association of a performance measure with a plan component. It can also be used to display all the details of performance measures under a plan component. A plan component - performance measure record links the performance measure to a plan component and provides additional details at this level.\nA performance measure needs to exist before creating this record.",
    "items":{
        "$ref":"#/components/schemas/planComponents-planComponentPerformanceMeasures-item-response"
    }
}

ネストされたスキーマ : プラン・コンポーネント付加フレックスフィールド

タイプ: array

タイトル: Plan Component Descriptive Flex Fields

プラン・コンポーネント - 付加フレックスフィールド・リソースは、プラン・コンポーネントのユーザー定義値の格納に使用されます。 新しいAPI名を定義するには、Setup and Maintenance(設定および保守)に移動し、Manage Descriptive Flex Fields(付加フレックスフィールドの管理)タスクを開きます。

ソースを表示

• Array of: object planComponents-planComponentsDFF-item-response

{
    "title":"Plan Component Descriptive Flex Fields",
    "type":"array",
    "description":"The plan component - descriptive flex fields resource is used to store user defined values for the plan component. A new API Name can be defined by going to Setup and Maintenance and opening the Manage Descriptive Flex Fields task.",
    "items":{
        "$ref":"#/components/schemas/planComponents-planComponentsDFF-item-response"
    },
    "x-cardinality":"1"
}

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

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

ネストされたスキーマ : planComponents-planComponentIncentiveFormulas-item-response

タイプ: object

ソースを表示

• CalculateEnddateParticipantFlag: boolean
  タイトル: Calculate end-dated participants

  現在の計算期間より前に終了日を持つ参加者が計算の対象となるかどうかを示します。 取り得る値はFALSEとTRUEです。 許容可能な値のリストは、参照CN_YES_NOで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。 これは、「インセンティブの計算」フィールドが間隔ごと(BONUS)の場合にのみ適用されます。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 255

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日時。
• IncentiveFormulaExpressionDescription: string
  タイトル: Expression Description

  読取り専用: true

  最大長: 1000

  プラン・コンポーネント・インセンティブ算式に関連するユーザーが追加した追加詳細。
• IncentiveFormulaExpressionId: integer (int64)
  タイトル: Output Expression ID

  インセンティブ算式で使用される式レコードの一意の識別子。 支給の計算に使用される式です。
• IncentiveFormulaExpressionName: string
  タイトル: Expression Name

  最大長: 160

  インセンティブ算式で使用される式の名前。 支給の計算に使用される式です。
• IncentiveFormulaId: integer (int64)
  インセンティブ算式レコードの一意の識別子。 1つのプラン・コンポーネントに対して1つのインセンティブ算式のみを指定できます。
• IncludeIndirectCredits: string
  タイトル: Include Indirect Credits

  プラン・コンポーネントの計算に含める間接クレジットのタイプ。 可能な値は、このプラン・コンポーネントの達成または支給計算に含まれるすべての間接クレジットに対してALL、このプランの達成または支給計算に含められる積上間接クレジットのみのMGRですこのプラン・コンポーネントの達成または支給計算に含められる間接クレジットがない場合はなし、このプラン・コンポーネントの達成または支給計算に含められるチーム間接クレジットのみの場合はチーム。 デフォルト値はNONEです。 受理可能な値のリストは、参照CN_PLAN_INDIRECT_CREDITで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  レコードが最後に更新された日時。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 255

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのセッション・ログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• PayoutFrequency: string
  タイトル: Payout Frequency

  デフォルト値: -1000

  支給が計算される頻度を決定する間隔値です。 間隔は、月、四半期、年などの時間の単位を表します。 デフォルト値は'-1000'です。
• PlanComponentId: integer (int64)
  タイトル: Plan Component ID

  読取り専用: true

  ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。
• PlanComponentIncentiveFormulaId: integer (int64)
  読取り専用: true

  プラン・コンポーネントのインセンティブ算式レコードの一意の識別子。
• PlanComponentIncentiveFormulasDeleteFlag: boolean
  読取り専用: true

  デフォルト値: false

  プラン・コンポーネント・インセンティブ算式を削除できるかどうかを示します。
• planComponentRateDimensionalInputs: array Plan Component - Rate Dimensional Input Expressions
  タイトル: Plan Component - Rate Dimensional Input Expressions

  プラン・コンポーネント - レート・ディメンション入力式リソースは、入力式とプラン・コンポーネントの関連付けを更新するために使用されます。 また、プラン・コンポーネントに関連付けられた入力式のすべての詳細を表示するために使用することもできます。 このレコードは、レート表のレート・ディメンションの入力を指定し、このレベルの追加詳細を提供します。 このレコードを作成する前に、有効な使用方法もある有効な式が存在する必要があります。 レート表が割り当てられた後にのみ、入力式を割り当てる必要があります。
• planComponentRateTables: array Plan Component - Rate Tables
  タイトル: Plan Component - Rate Tables

  プラン・コンポーネント - レート表リソースは、レート表とプラン・コンポーネントの関連付けを作成、更新または削除するために使用されます。 また、パフォーマンス・メジャーに関連付けられたレート表のすべての詳細を表示するために使用することもできます。 このレコードは、レート表をパフォーマンス・メジャーにリンクし、このレベルの追加詳細を提供します。 このレコードを作成する前に、レート表が存在する必要があります。 レート表関連は、インセンティブ算式が作成された後にのみ作成できます。
• RenderedIncentiveFormulaExpression: 文字列(バイト)
  タイトル: Rendered Expression

  読取り専用: true

  演算子、属性、関数などのすべての式コンポーネントを含むインセンティブ算式全体。これは、主に式全体を表示するために使用されます。
• ResetInterval: integer (int64)
  タイトル: Reset Interval

  調整支給または累積支給が計算される期間です。 間隔は、月、四半期、年などの時間の単位を表します。 これは、True UpがYの場合にのみ適用されます。
• TrueUpFlag: boolean
  タイトル: True up

  最大長: 1

  当期間に対して計算された支給に、以前に計算された金額または支払金額(累積)が含まれているかどうかを示します 計算エンジンは、現在の計算済支給項目から前の支給項目を自動的に減算します。 取り得る値はFALSEとTRUEです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "planComponentRateDimensionalInputs":{
            "title":"Plan Component - Rate Dimensional Input Expressions",
            "type":"array",
            "description":"The plan component - rate dimensional input expressions resource is used to update the association of a input expression with a plan component. It can also be used to display all  the details of input expressions associated with a plan component. This record specifies the inputs of a rate dimension of a rate table and provides additional details at this level.\nA valid expression which also has a valid usage needs to exist before creating this record. You should assign the input expression only after the rate table is assigned.",
            "items":{
                "$ref":"#/components/schemas/planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-response"
            }
        },
        "RenderedIncentiveFormulaExpression":{
            "title":"Rendered Expression",
            "type":"string",
            "description":"The entire incentive formula expression with all the expression components like operators, attributes, functions, etc. This is primarily used to display the entire expression.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IncentiveFormulaExpressionDescription":{
            "title":"Expression Description",
            "maxLength":1000,
            "type":"string",
            "description":"The additional details added by the user related to plan component incentive formulas.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentIncentiveFormulaId":{
            "type":"integer",
            "description":"The unique identifier of the incentive formula record for the plan component.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CalculateEnddateParticipantFlag":{
            "title":"Calculate end-dated participants",
            "type":"boolean",
            "description":"Indicates whether participants who have an end date before the current calculation period are considered for calculation. Possible values include FALSE and TRUE. A list of acceptable values is defined in the lookup CN_YES_NO. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task. This is only applicable if Calculate Incentive field is Per interval ('BONUS').",
            "nullable":true,
            "x-queryable":true
        },
        "planComponentRateTables":{
            "title":"Plan Component - Rate Tables",
            "type":"array",
            "description":"The plan component - rate tables resource is used to create, update or delete the association of a rate table with a plan component. It can also be used to display all the details of rate table associated with a performance measure. This record links the rate table to a performance measure and provides additional details at this level.\nA rate table needs to exist before creating this record. The rate table association can be created only after an incentive formula is created.",
            "items":{
                "$ref":"#/components/schemas/planComponents-planComponentIncentiveFormulas-planComponentRateTables-item-response"
            }
        },
        "IncentiveFormulaId":{
            "type":"integer",
            "description":"The unique identifier for the incentive formula record. There can be only one incentive formula for one plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            },
            "x-queryable":true
        },
        "PlanComponentIncentiveFormulasDeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether a plan component incentive formula can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "IncentiveFormulaExpressionId":{
            "title":"Output Expression ID",
            "type":"integer",
            "description":"The unique identifier of the expression record used in the incentive formula. This is the expression that is used to calculate the earnings.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "precision":18
            }
        },
        "IncludeIndirectCredits":{
            "title":"Include Indirect Credits",
            "type":"string",
            "description":"Type of indirect credits to include in the calculation, for the plan component. Possible values include ALL for all indirect credits that are included for attainment or earnings calculation for this plan component, MGR for only rollup indirect credits that are included for attainment or earnings calculation for this plan component, NONE for no indirect credits that are included for attainment or earnings calculation for this plan component, and TEAM for only team indirect credits that are included for attainment or earnings calculation for this plan component. The default value is NONE. A list of acceptable values is defined in the lookup CN_PLAN_INDIRECT_CREDIT. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PlanComponentId":{
            "title":"Plan Component ID",
            "type":"integer",
            "description":"The unique identifier of the plan component record within a business unit.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResetInterval":{
            "title":"Reset Interval",
            "type":"integer",
            "description":"It is the span of time for which the true up or cumulative earnings are calculated. Interval would represent a unit of time like month, quarter, year. This is applicable only if True Up is Y.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "PayoutFrequency":{
            "title":"Payout Frequency",
            "type":"string",
            "description":"This is the interval value that determines how often the earning is calculated. Interval would represent a unit of time like month, quarter, year. The default value is '-1000'.",
            "nullable":true,
            "default":"-1000",
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "OrgId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TrueUpFlag":{
            "title":"True up",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the earnings calculated for the current period includes the previously calculated or paid amount (Cumulative.) Calculation engine then automatically subtracts previous earnings from the current earning calculated. Possible values include FALSE and TRUE.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncentiveFormulaExpressionName":{
            "title":"Expression Name",
            "maxLength":160,
            "type":"string",
            "description":"The name for the expression used in the incentive formula. This is the expression that is used to calculate the earnings.",
            "nullable":true,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "controlType":"combo_lov",
                "dependencies":[
                    "ProcessTransactions"
                ]
            },
            "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"
    }
}

ネストされたスキーマ : プラン・コンポーネント - レート・ディメンション入力式

タイプ: array

タイトル: Plan Component - Rate Dimensional Input Expressions

プラン・コンポーネント - レート・ディメンション入力式リソースは、入力式とプラン・コンポーネントの関連付けを更新するために使用されます。 また、プラン・コンポーネントに関連付けられた入力式のすべての詳細を表示するために使用することもできます。 このレコードは、レート表のレート・ディメンションの入力を指定し、このレベルの追加詳細を提供します。 このレコードを作成する前に、有効な使用方法もある有効な式が存在する必要があります。 レート表が割り当てられた後にのみ、入力式を割り当てる必要があります。

ソースを表示

• Array of: object planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-response

{
    "title":"Plan Component - Rate Dimensional Input Expressions",
    "type":"array",
    "description":"The plan component - rate dimensional input expressions resource is used to update the association of a input expression with a plan component. It can also be used to display all  the details of input expressions associated with a plan component. This record specifies the inputs of a rate dimension of a rate table and provides additional details at this level.\nA valid expression which also has a valid usage needs to exist before creating this record. You should assign the input expression only after the rate table is assigned.",
    "items":{
        "$ref":"#/components/schemas/planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-response"
    }
}

ネストされたスキーマ : プラン・コンポーネント - レート表

タイプ: array

タイトル: Plan Component - Rate Tables

プラン・コンポーネント - レート表リソースは、レート表とプラン・コンポーネントの関連付けを作成、更新または削除するために使用されます。 また、パフォーマンス・メジャーに関連付けられたレート表のすべての詳細を表示するために使用することもできます。 このレコードは、レート表をパフォーマンス・メジャーにリンクし、このレベルの追加詳細を提供します。 このレコードを作成する前に、レート表が存在する必要があります。 レート表関連は、インセンティブ算式が作成された後にのみ作成できます。

ソースを表示

• Array of: object planComponents-planComponentIncentiveFormulas-planComponentRateTables-item-response

{
    "title":"Plan Component - Rate Tables",
    "type":"array",
    "description":"The plan component - rate tables resource is used to create, update or delete the association of a rate table with a plan component. It can also be used to display all the details of rate table associated with a performance measure. This record links the rate table to a performance measure and provides additional details at this level.\nA rate table needs to exist before creating this record. The rate table association can be created only after an incentive formula is created.",
    "items":{
        "$ref":"#/components/schemas/planComponents-planComponentIncentiveFormulas-planComponentRateTables-item-response"
    }
}

ネストされたスキーマ : planComponents-planComponentIncentiveFormulas-planComponentRateDimensionalInputs-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 255

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日時。
• IncentiveFormulaId: integer (int64)
  タイトル: Incentive Formula ID

  インセンティブ算式レコードの一意の識別子。 1つのプラン・コンポーネントに対して1つのインセンティブ算式のみを指定できます。
• InputExpressionDescription: string
  タイトル: Input Expression Description

  読取り専用: true

  最大長: 1000

  式の作成時に入力された入力式の説明。
• InputExpressionId: integer (int64)
  タイトル: Input Expression ID

  レート表のレート・ディメンションの入力式の一意の識別子。
• InputExpressionName: string
  タイトル: Input Expression Name

  最大長: 160

  プラン・コンポーネントで使用されるレート表のレート・ディメンションの入力式の名前。 入力式は、トランザクションから評価する値を制御し、結果と対応するレート表ディメンションを照合します。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  レコードが最後に更新された日時。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 255

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのセッション・ログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• PlanComponentId: integer
  読取り専用: true

  ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。
• PlanComponentInputExpressionId: integer (int64)
  タイトル: Plan Component Input Expression Id

  プラン・コンポーネントの入力式レコードの一意の識別子。
• PlanComponentRateDimensionalInputsDeleteFlag: boolean
  読取り専用: true

  デフォルト値: false

  レート・ディメンション入力を削除できるかどうかを示します。
• RateDimName: integer
  タイトル: Dimension Name

  読取り専用: true

  レート・ディメンションの名前。 レート表には、1つ以上のレート・ディメンションを含めることができます。
• RateDimSequence: integer (int64)
  タイトル: Sequence

  レート表の入力式の順序。
• SplitFlag: boolean
  タイトル: Split

  最大長: 1

  デフォルト値: false

  レートを階層間で分割する場合、分割オプションは1つのレート・ディメンション入力式にのみ適用できます。 使用するレート・ディメンション入力式(レート・ディメンション)を指定します。 可能な値はFALSEおよびTRUEです。 デフォルト値はFALSEです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InputExpressionDescription":{
            "title":"Input Expression Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the input expression entered while creating the expression.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SplitFlag":{
            "title":"Split",
            "maxLength":1,
            "type":"boolean",
            "description":"When splitting the rate across tiers, the split option can apply to only one rate dimension input expression. This specifies which rate dimension input expression (rate dimension) to use. Possible values are FALSE and TRUE. The default value is FALSE.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "PlanComponentRateDimensionalInputsDeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the rate dimension input can be deleted.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":false
        },
        "IncentiveFormulaId":{
            "title":"Incentive Formula ID",
            "type":"integer",
            "description":"The unique identifier of the incentive formula record. There can be only one incentive formula for one plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the plan component record within a business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentInputExpressionId":{
            "title":"Plan Component Input Expression Id",
            "type":"integer",
            "description":"The unique identifier of the input expression record for the plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RateDimName":{
            "title":"Dimension Name",
            "type":"integer",
            "description":"The name of the rate dimension. A rate table can have one or more rate dimensions.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "InputExpressionName":{
            "title":"Input Expression Name",
            "maxLength":160,
            "type":"string",
            "description":"The name of the input expression for the rate dimension of a rate table used in the plan component. The input expression drives a value to evaluate from the transaction and matches the results with the corresponding rate table dimension.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "InputExpressionId":{
            "title":"Input Expression ID",
            "type":"integer",
            "description":"The unique identifier of the input expression for the rate dimension of a rate table.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RateDimSequence":{
            "title":"Sequence",
            "type":"integer",
            "description":"The order of the input expressions for the rate table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "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"
    }
}

ネストされたスキーマ : planComponents-planComponentIncentiveFormulas-planComponentRateTables-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 255

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日時。
• EndDate: 文字列(日付)
  タイトル: End Date

  レート表がプラン・コンポーネントに対して非アクティブになる日付。 書式はyyyy-mm-ddです。
• IncentiveFormulaId: integer (int64)
  タイトル: Incentive Formula ID

  インセンティブ算式レコードの一意の識別子。 1つのプラン・コンポーネントに対して1つのインセンティブ算式のみを指定できます。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  レコードが最後に更新された日時。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 255

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのセッション・ログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• PlanComponentId: integer
  読取り専用: true

  ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。
• PlanComponentName: string
  タイトル: Plan Component Name

  読取り専用: true

  プラン・コンポーネントの名前。パフォーマンスに基づいて参加者の支給を定義します。
• PlanComponentRateTableId: integer (int64)
  プラン・コンポーネントに関連付けられたレート表の一意の識別子。
• RateTableDescription: string
  タイトル: Description

  読取り専用: true

  最大長: 1000

  レート表の名称。
• RateTableId: integer (int64)
  タイトル: Rate Table ID

  レート表の一意の識別子。
• RateTableName: string
  タイトル: Rate Table Name

  最大長: 80

  レート表の名前。 レート表は、さまざまなパフォーマンス・レベルに対して給与比率レートや固定額を設定するために使用します。
• StartDate: 文字列(日付)
  タイトル: Start Date

  レート表がプラン・コンポーネントに対してアクティブになる日付。 書式はyyyy-mm-ddです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableDescription":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the rate table.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IncentiveFormulaId":{
            "title":"Incentive Formula ID",
            "type":"integer",
            "description":"The unique identifier for the incentive formula record. There can be only one incentive formula for one plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier for the plan component record within a business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the rate table becomes inactive for the plan component. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the rate table becomes active for the plan component. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "RateTableName":{
            "title":"Rate Table Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of a rate table. A rate table is used to establish compensation percentage rates or fixed amounts for different performance levels.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "PlanComponentRateTableId":{
            "type":"integer",
            "description":"The unique identifier of the rate table associated to the plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanComponentName":{
            "title":"Plan Component Name",
            "type":"string",
            "description":"The name of a plan component, which defines the earnings of a participant based on their performance.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RateTableId":{
            "title":"Rate Table ID",
            "type":"integer",
            "description":"The unique identifier of the rate table.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "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"
    }
}

ネストされたスキーマ : planComponents-planComponentPerformanceMeasures-item-response

タイプ: object

ソースを表示

• CalculationSequence: 整数(int32)
  タイトル: Calculation Sequence

  デフォルト値: 1

  プラン・コンポーネント内のパフォーマンス・メジャーが計算エンジンで考慮される順序。 これは、依存メジャーが他の基準メジャーの計算結果を参照する場合に設定されます。 依存メジャーは、基準メジャーよりも高い計算順序にする必要があります。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日時。
• EarningBasis: string
  タイトル: Earning Basis

  最大長: 1

  デフォルト値: Y

  達成計算と支給計算で同じクレジット・カテゴリを使用するかどうか、およびインセンティブ算式で計算にメジャー達成を使用するかどうかを指定します。 使用可能な値はY、Nです。 Yのままにして、プラン・コンポーネントのインセンティブ算式でパフォーマンス・メジャー達成を参照します。 トランザクションを個別に処理するパフォーマンス・メジャーが、イベントごとにインセンティブを計算するプラン・コンポーネントに関連付けられている場合、支給基準はYである必要があります。 許容可能な値のリストは、参照CN_YES_NOで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• EndDate: 文字列(日付)
  タイトル: End Date

  読取り専用: true

  パフォーマンス・メジャーに関連付けられたパフォーマンス・メジャーが非アクティブになる日付。 これは読取り専用フィールドです。 パフォーマンス・メジャーは、プラン・コンポーネントの日付を取得します。 書式はyyyy-mm-ddです。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  レコードが最後に更新された日時。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのセッション・ログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• PerformanceInterval: string
  タイトル: Performance Interval

  読取り専用: true

  デフォルト値: -1000

  これはパフォーマンス測定の間隔値です。 累計が考慮される場合は、この間隔値に基づいて累計値がリセットされます。 間隔は、月、四半期、年などの時間の単位を表します。 デフォルト値は'-1000'です。
• PerformanceMeasureId: integer (int64)
  タイトル: Performance Measure ID

  パフォーマンス・メジャー・レコードの一意の識別子。
• PerformanceMeasureName: string
  タイトル: Performance Measure Name

  読取り専用: true

  最大長: 80

  パフォーマンス・メジャーの名前。指定した結果または目標に対する進捗を測定するために使用されるインジケータです。
• PerformanceMeasureWeight: integer (int64)
  タイトル: Weight

  デフォルト値: 100

  パフォーマンス・メジャーがプラン・コンポーネントに与える影響の割合。
• PlanComponentId: integer (int64)
  タイトル: Plan Component ID

  ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。
• PlanComponentName: string
  タイトル: Plan Component Name

  読取り専用: true

  最大長: 80

  プラン・コンポーネントの名前。パフォーマンスに基づいて参加者の支給を定義します。
• PlanComponentPerformanceMeasureId: integer (int64)
  プラン・コンポーネントに関連付けられたパフォーマンス・メジャー・レコードの一意の識別子です。
• ProcessTransactions: string
  タイトル: Process Transactions

  読取り専用: true

  最大長: 30

  メジャーでのトランザクションの処理方法を示します。 指定可能な値には、達成計算のためのグループ・トランザクションのGROUP、達成計算のためのINDIVIDUAL、達成計算のための各トランザクションの個別評価のためのINDIVIDUALが含まれます。 許容可能な値のリストは、参照CN_PROCESS_TXNで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• StartDate: 文字列(日付)
  タイトル: Start Date

  読取り専用: true

  パフォーマンス・メジャーに関連付けられたパフォーマンス・メジャーがアクティブになる日付。 これは読取り専用フィールドです。 パフォーマンス・メジャーは、プラン・コンポーネントの日付を取得します。 書式はyyyy-mm-ddです。
• UnitOfMeasure: string
  タイトル: Unit of Measure

  読取り専用: true

  最大長: 30

  デフォルト値: AMOUNT

  パフォーマンス・メジャー・プロパティの発生数量を表すファクタとして使用される標準化された数量。 可能な値には、メジャー達成のAMOUNTは金額に基づき、メジャー達成のPERCENTはパーセントに基づき、メジャー達成のQUANTITYは数量に基づき、メジャー達成のSCOREはスコアに基づきます。 デフォルト値はAMOUNTです。 許容可能な値のリストは、参照CN_MEASURE_UOMで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• ValidForCalculation: string
  タイトル: Valid for Calculation

  読取り専用: true

  最大長: 30

  デフォルト値: INCOMPLETE

  パフォーマンス・メジャーの計算準備が完了しているかどうかを示します。 可能な値には、有効で計算の準備ができている場合はCOMPLETE、無効で計算の準備ができていない場合はINCOMPLETEが含まれます。 デフォルト値はINCOMPLETEです。 許容可能な値のリストは、参照CN_COMP_PLAN_STATUSで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceInterval":{
            "title":"Performance Interval",
            "type":"string",
            "description":"This is the interval value  for the performance measurement. Where running total is considered, the accumulated value is reset based on this interval value. \nInterval would represent a unit of time like month, quarter, year. The default value is '-1000'.",
            "nullable":true,
            "readOnly":true,
            "default":"-1000",
            "x-queryable":true
        },
        "PerformanceMeasureName":{
            "title":"Performance Measure Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of a performance measure, which is an indicator used to measure the progress toward a specified outcome or goal.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":30,
            "type":"string",
            "description":"The standardized quantity used as a factor to express occurring quantities of the performance measure property. Possible values include AMOUNT for measure attainment is based on an amount, PERCENT for measure attainment is based on a percent, QUANTITY for measure attainment is based on a quantity, and SCORE for measure attainment is based on a score. The default value is AMOUNT. A list of acceptable values is defined in the lookup CN_MEASURE_UOM. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "default":"AMOUNT",
            "x-queryable":true
        },
        "ValidForCalculation":{
            "title":"Valid for Calculation",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the performance measure is ready for calculation. Possible values include COMPLETE for valid and ready for calculation and INCOMPLETE for invalid and not ready for calculation. The default value is INCOMPLETE. A list of acceptable values is defined in the lookup CN_COMP_PLAN_STATUS. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":false,
            "readOnly":true,
            "default":"INCOMPLETE",
            "x-queryable":true
        },
        "PerformanceMeasureId":{
            "title":"Performance Measure ID",
            "type":"integer",
            "description":"The unique identifier of a performance measure record.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the performance measure associated with the performance measure becomes inactive. This is a read only field. The performance measure takes the date of the plan component. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentId":{
            "title":"Plan Component ID",
            "type":"integer",
            "description":"The unique identifier of the plan component record within a business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CalculationSequence":{
            "title":"Calculation Sequence",
            "type":"integer",
            "description":"The order in which the calculation engine considers a performance measure within a plan component. This is set when dependent measures refer to the calculated results of other base measures. Dependent measures must have a higher calculation sequence than base measures.",
            "format":"int32",
            "nullable":true,
            "default":1,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the performance measure associated with the performance measure becomes active. This is a read only field. The performance measure takes the date of the plan component. The format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PerformanceMeasureWeight":{
            "title":"Weight",
            "type":"integer",
            "description":"The percentage of influence a performance measure has on the plan component.",
            "format":"int64",
            "nullable":true,
            "default":100,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EarningBasis":{
            "title":"Earning Basis",
            "maxLength":1,
            "type":"string",
            "description":"Specifies whether attainment and earnings calculations use the same credit categories and whether the incentive formula uses the measure attainment in calculations. Possible values include Y, N. \nKeep it Y, references the performance measure attainment in the incentive formula expression of the plan component. \nEarning basis must be Y when a performance measure that processes transactions individually is associated with plan components that calculate incentive per event. A list of acceptable values is defined in the lookup CN_YES_NO. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "default":"Y",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanComponentPerformanceMeasureId":{
            "type":"integer",
            "description":"The unique identifier for the performance measure record associated with the plan component.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProcessTransactions":{
            "title":"Process Transactions",
            "maxLength":30,
            "type":"string",
            "description":"Indicates how the application processes transactions in a measure. The possible values include GROUP for Group transactions for the specified interval, for attainment calculation and INDIVIDUAL for evaluating each transaction independently, for attainment calculation. A list of acceptable values is defined in the lookup CN_PROCESS_TXN. Review and update the value for this attribute using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentName":{
            "title":"Plan Component Name",
            "maxLength":80,
            "type":"string",
            "description":"The name of a plan component, which defines the earnings of a participant based on their performance.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The session login of the user who last updated the record.",
            "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"
    }
}

ネストされたスキーマ : planComponents-planComponentsDFF-item-response

タイプ: object

ソースを表示

• __FLEX_Context: string
  タイトル: Context Segment

  最大長: 30

  このフィールドは、プラン・コンポーネントのフレックス・コンテキスト・セグメント・コードを表します。 どのコンテキスト依存セグメントを表示するかを決定します。
• __FLEX_Context_DisplayValue: string
  タイトル: Context Segment

  このフィールドは、プラン・コンポーネントのフレックス・コンテキスト・セグメント表示名を表します。 どのコンテキスト依存セグメントを表示するかを決定します。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• OrgId: integer (int64)
  タイトル: Business Unit

  ビジネス・ユニット組織の一意の識別子。
• PlanComponentId: integer (int64)
  ビジネス・ユニット内のプラン・コンポーネント・レコードの一意の識別子。

{
    "type":"object",
    "properties":{
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit organisation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier for the plan component record within a business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18
            },
            "x-queryable":true
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "description":"This field represents the flex context segment display name for the  plan component. It determines which context-sensitive segments are displayed.",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "description":"This field represents the flex context segment code for the plan component. It determines which context-sensitive segments are displayed.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

• Array of: object link

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

リンク

ApplySplitLookup

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DCN_SPLIT_TYPE_OPTION

標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。

BusinessUnitPVO

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationBusinessUnitsLOV

ビジネス・ユニット値リスト・リソースは、定義済ビジネス・ユニットのリストを表示するために使用されます。

CnLookupCalculateIncentiveVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DCN_PLAN_INCENTIVE_TYPE

標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。

CnLookupCalculationPhaseVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DCN_CALCULATION_PHASE

標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。

CnLookupIncentiveTypeVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DCN_REPORT_GROUP

標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。

CnLookupPaymentPlanCategory

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DCN_PAYMENT_PLAN_CATEGORY

標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。

CnLookupValidForCalculationVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DCN_COMP_PLAN_STATUS

標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。

CnLookupYesNoVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder%3BLookupType%3DCN_YES_NO

標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。

EarningTypesVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

• ファインダ: LookupTypeFinder

標準参照値リスト・リソースは、標準参照の値リストを問い合せるために使用されます。このリストには、使用可能なコードと翻訳された内容がリストされます。 標準参照は、参照データ共有をサポートする標準参照ビューおよび格納参照コードで定義されます。

planComponentIncentiveFormulas

操作: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentIncentiveFormulas

パラメータ:

• planComponentsUniqID: $request.path.planComponentsUniqID

プラン・コンポーネント - インセンティブ算式リソースは、インセンティブ算式のプラン・コンポーネントへの関連付けを更新するために使用されます。 また、プラン・コンポーネントに関連付けられたインセンティブ算式のすべての詳細を表示するために使用することもできます。 このレコードでは、支給の計算に使用するフォーミュラを指定し、このレベルの追加詳細を提供します。 これは、プラン・コンポーネントが作成され、後で更新する必要がある場合に、値なしで自動的に作成されます。

planComponentPerformanceMeasures

操作: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentPerformanceMeasures

パラメータ:

• planComponentsUniqID: $request.path.planComponentsUniqID

プラン・コンポーネント - パフォーマンス・メジャー・リソースは、パフォーマンス・メジャーとプラン・コンポーネントの関連付けを作成、更新または削除するために使用されます。 また、プラン・コンポーネントでパフォーマンス・メジャーのすべての詳細を表示するために使用することもできます。 プラン・コンポーネント - パフォーマンス・メジャー・レコードは、パフォーマンス・メジャーをプラン・コンポーネントにリンクし、このレベルで追加詳細を提供します。 このレコードを作成する前に、パフォーマンス・メジャーが存在している必要があります。

planComponentsDFF

操作: /fscmRestApi/resources/11.13.18.05/planComponents/{planComponentsUniqID}/child/planComponentsDFF

パラメータ:

• planComponentsUniqID: $request.path.planComponentsUniqID

プラン・コンポーネント - 付加フレックスフィールド・リソースは、プラン・コンポーネントのユーザー定義値の格納に使用されます。 新しいAPI名を定義するには、Setup and Maintenance(設定および保守)に移動し、Manage Descriptive Flex Fields(付加フレックスフィールドの管理)タスクを開きます。

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対してPATCHリクエストを発行することによって、プラン・コンポーネントを更新する方法を示しています。

cURLコマンド

curl -u <username:password> \ -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/planComponents/00020000000EACED00057708000110F07F4ABECA0000000EACED0005770800000000000000CC

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{
"Description": "Sales Plan Bonus Plan Component"
}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています。

{
  "PlanComponentId": 300100090511050,
  "Name": "Sales Plan Bonus",
  "Description": "Sales Plan Bonus Plan Component",
  "CalculateIncentive": "BONUS",
  "OrgId": 204,
  "EarningType": -1000,
  "StartDate": "2016-01-01",
  "EndDate": "2016-12-31",
  "CalculationPhase": 1,
  "IncentiveType": "BONUS",
  "PaymentPlanCategory": "STANDARD",
  "PaymentMadeThroughThirdPartyFlag": false,
  "LastUpdateDate": "2017-06-08T12:37:08.021-07:00",
  "LastUpdatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "CreationDate": "2017-06-08T12:32:10.001-07:00",
  "CreatedBy": "OIC_PLAN_ADMIN_OPERATIONS",
  "LastUpdateLogin": "516E508C5BC4377FE0532DD6F00A0214",
  "DisplayName": "Sales Plan Bonus",
  "ValidForCalculation": "INCOMPLETE",
  "InvalidReason": "This plan component is not valid for calculation. Add at least one valid performance measure to make it valid. (CN-1575358)",
  "SplitOption": "NONE",
  "NumberOfDimensions": null,
  "links": [
    ...
  ]
}

「トップに戻る」