Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

すべての支払プランの取得

get

/fscmRestApi/resources/11.13.18.05/incentiveCompensationPaymentPlans

リクエスト

問合せパラメータ

expand: string

このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。この問合せパラメータの値は"all"または""です。カンマをセパレータとして使用して、複数の子を指定できます。例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
fields: string

このパラメータは、リソース・フィールドをフィルタします。指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。両方を指定した場合、フィールドのみが考慮されます。

フォーマット : ?fields=Attribute1,Attribute2

子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。

フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

使用可能なファインダ名および対応するファインダ変数を次に示します:
- PrimaryKey : 指定した主キーを持つ支払プランを検索します。
  ファインダ変数:
  - PaymentPlanId; integer; 支払プランの一意の識別子。
limit: integer

このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
links: string

このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

例:
self,canonical
offset: integer

リソース・コレクションの開始位置を定義するために使用します。オフセットがリソース数を超えると、リソースは返されません。デフォルト値は0です。
onlyData: boolean

リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
orderBy: string

このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。昇順の場合は「asc」、降順の場合は「desc」を指定します。デフォルト値は「asc」です。たとえば、?orderBy=field1:asc,field2:descです
q: string
この問合せパラメータは、where句を定義します。リソース・コレクションは、指定された式を使用して問い合せられます。この問合せパラメータの値は、1つ以上の式です。例 : ?q=部門番号>=10および<= 30;Loc!=NY

フォーマット : ?q=expression1;expression2

次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
- CreatedBy; string; 支払プランを作成したユーザー。
- CreationDate; string; 支払プランが作成された日時。
- DelayRecoveryFlag; boolean;前払金金額の回収を、支払後に数か月間延期する必要があるかどうかを示します。有効な値はYおよびNです。遅延リカバリを有効にする値「Y」を指定する場合は、リカバリの開始を指定し、オプションでリカバリの終了を指定します。値"N"を指定すると、次の後続の支払でリカバリが即時に開始されます。デフォルト値は「N」です。
- 説明;文字列;支払計画の簡単な説明。
- DrawEnd; string; 参加者の前払金計算が終了する時期を示すコード。この値は、支払プラン割当開始日より後の相対日付を決定するために使用されます。指定可能な値は、3か月後に前払金を停止する場合は"-1"、6か月後に前払金を停止する場合は"-2"、9か月後に前払金を停止する場合は"-3"、12か月後に前払金を停止する場合は"-4"です。
- EndDate; string; 支払プランが非アクティブになる日付。許容可能な書式はyyyy-mm-ddです。
- FlatMinimumAmount; number;支払間隔ごとに参加者に支払う最小金額。支払プロセスでは、支払期間の支給合計が最小金額を下回ると、支払調整が作成されます。この支払調整は、通常、前払金または保証された最小額と呼ばれます。
- LastUpdateDate; string; 支払プランが最後に更新された日時。
- LastUpdatedBy; string; 支払プランを最後に更新したユーザー。
- MaximumAmount; number;支払間隔で参加者に支払う最大金額。支払期間の支給合計が最大金額を超えると、支払プロセスによって支払調整が作成されます。この支払調整は、多くの場合、上限と呼ばれます。
- MinimumRecoverFlag; boolean;関係者に支払われた前払金金額を後続の支払期間で回収する必要があるかどうかを示します。有効にすると、支払プロセスは一定期間にわたる支給の支払から、全額前払金が回収されるまで差し引かれます。有効な値はYおよびNです。デフォルト値は「Y」です。
- OrgId; integer; 支払プランが属するビジネス・ユニットの一意の識別子。「設定およびメンテナンス」>「ビジネス・ユニットの定義」タスクを使用して、ビジネス・ユニットのビジネス・ユニットIDをレビューします。 Business Unit ID(ビジネス・ユニットID)列が表示されない場合は、View(表示)メニューをクリックしてBusiness Unit ID(ビジネス・ユニットID)列を追加します。
- PayExcessLaterFlag; boolean;最大支払調整を相殺支給短期に繰り越す必要があるかどうかを示します。有効な値はYおよびNです。デフォルト値はNです。
- PayIntervalTypeId; integer; 支払プラン前払金および上限調整の頻度を定義するビジネス・ユニット間隔の一意の識別子。間隔には、期間、四半期、年間および半期が含まれます。デフォルト値は、期間間隔の識別子"-1000"です。設定およびメンテナンスの間隔の管理タスクを使用して、ビジネス・ユニットに追加の間隔が定義されます。このリソースのファインダを使用して、間隔の一意の識別子を取得します。
- PaymentPlanCategory; string; 描画および上限を適用するプラン・コンポーネントを示すコード。デフォルト値はSTANDARDです。許容可能な値のリストは、参照CN_PAYMENT_PLAN_CATEGORYで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
- PaymentPlanId; integer; 支払プランの一意の識別子。
- PaymentPlanName; string;支払計画の名前。
- RecoverExpressionId; integer; リカバリ式の一意の識別子。回収式によって、支払済前払金を回収するために控除できる支給が決まります。デフォルトの有効な値は"-1001"のみで、全ての支給に対して回収されます。
- RecoveryEndIntervalId; integer; 描画リカバリを終了するタイミングを示すコード。遅延リカバリが有効な場合、この値はオプションです。この値は、遅延リカバリ開始後の相対日付を決定するために使用されます。可能な値は、3か月後にリカバリを停止する"-1"、6か月後にリカバリを停止する"-2"、9か月後にリカバリを停止する"-3"、12か月後にリカバリを停止する"-4"です。
- RecoveryStartIntervalId; integer; 遅延リカバリ期間が終了し、リカバリ処理が開始するタイミングを示すコード。遅延リカバリが有効な場合、この値は必須です。この値は、支払プラン割当開始日より後の相対日付を決定するために使用されます。可能な値は、3か月後にリカバリを開始する場合は"-1"、6か月後にリカバリを開始する場合は"-2"、9か月後にリカバリを開始する場合は"-3"、12か月後にリカバリを開始する場合は"-4"です。
- StartDate; string; 支払プランがアクティブになる日付。許容可能な書式はyyyy-mm-ddです。
totalResults: boolean

"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。デフォルト値はfalseです。

ヘッダー・パラメータ

Metadata-Context:

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

ルート・スキーマ : incentiveCompensationPaymentPlans

タイプ: object

ソースを表示

count(required): integer

現在の範囲で返されたリソース・インスタンスの数。
hasMore(required): boolean

サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。値がtrueの場合、サーバーから取得するリソースがさらにあります。デフォルト値はfalseです。
items: array Items

タイトル: Items

コレクション内のアイテム。
limit(required): integer

サーバーで使用される実際のページング・サイズ。
links(required): array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
offset(required): integer

現在のページで使用されるオフセット値。
totalResults: integer

"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPaymentPlans-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

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

タイプ: array

タイトル: Items

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

ソースを表示

Array of: object incentiveCompensationPaymentPlans-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPaymentPlans-item-response"
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

Array of: object link

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

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

タイプ: object

ソースを表示

CreatedBy: string

読取り専用: true

最大長: 64

支払プランを作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

支払プランが作成された日時。
DelayRecoveryFlag: boolean

タイトル: Recovery Start Option

最大長: 1

デフォルト値: false

前払金金額の回収を、支払後数か月間延期する必要があるかどうかを示します。有効な値はYおよびNです。遅延リカバリを有効にする値「Y」を指定する場合は、リカバリの開始を指定し、オプションでリカバリの終了を指定します。値"N"を指定すると、次の後続の支払でリカバリが即時に開始されます。デフォルト値は「N」です。
Description: string

タイトル: Description

最大長: 1000

支払プランの簡単な説明。
DrawEnd: string

タイトル: Draw End

最大長: 30

参加者の前払金計算が終了する時期を示すコード。この値は、支払プラン割当開始日より後の相対日付を決定するために使用されます。指定可能な値は、3か月後に前払金を停止する場合は"-1"、6か月後に前払金を停止する場合は"-2"、9か月後に前払金を停止する場合は"-3"、12か月後に前払金を停止する場合は"-4"です。
EndDate: 文字列(日付)

タイトル: End Date

支払プランが非アクティブになる日付。許容可能な書式はyyyy-mm-ddです。
FlatMinimumAmount: number

タイトル: Flat Minimum Amount to Pay Participant

支払間隔ごとに参加者に支払う最小金額。支払プロセスでは、支払期間の支給合計が最小金額を下回ると、支払調整が作成されます。この支払調整は、通常、前払金または保証された最小額と呼ばれます。
LastUpdateDate: string (date-time)

読取り専用: true

支払プランが最後に更新された日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

支払プランを最後に更新したユーザー。
links: array Links

タイトル: Links

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

タイトル: Maximum Payment

支払間隔の参加者に支払う最大金額。支払期間の支給合計が最大金額を超えると、支払プロセスによって支払調整が作成されます。この支払調整は、多くの場合、上限と呼ばれます。
MinimumRecoverFlag: boolean

タイトル: Minimum Recovery

最大長: 1

デフォルト値: true

関係者に支払われた前払金金額を後続の支払期間で回収する必要があるかどうかを示します。有効にすると、支払プロセスは一定期間にわたる支給の支払から、全額前払金が回収されるまで差し引かれます。有効な値はYおよびNです。デフォルト値は「Y」です。
OrgId: integer (int64)

タイトル: Business Unit

支払プランが属するビジネス・ユニットの一意の識別子。「設定およびメンテナンス」>「ビジネス・ユニットの定義」タスクを使用して、ビジネス・ユニットのビジネス・ユニットIDをレビューします。 Business Unit ID(ビジネス・ユニットID)列が表示されない場合は、View(表示)メニューをクリックしてBusiness Unit ID(ビジネス・ユニットID)列を追加します。
PayExcessLaterFlag: boolean

タイトル: Carry forward maximum

最大長: 1

デフォルト値: false

最大支払調整を相殺する支給不足額を後続の支給期間に繰り越す必要があるかどうかを示します。有効な値はYおよびNです。デフォルト値はNです。
PayIntervalTypeId: integer (int64)

タイトル: Payment Interval

デフォルト値: -1000

支払プラン前払金および上限調整の頻度を定義するビジネス・ユニット間隔の一意の識別子です。間隔には、期間、四半期、年間および半期が含まれます。デフォルト値は、期間間隔の識別子"-1000"です。設定およびメンテナンスの間隔の管理タスクを使用して、ビジネス・ユニットに追加の間隔が定義されます。このリソースのファインダを使用して、間隔の一意の識別子を取得します。
PaymentPlanAssignments: array Payment Plans Assignments

タイトル: Payment Plans Assignments

割当リソースは、支払プランのインセンティブ報酬割当を表示、作成、更新または削除するために使用されます。
PaymentPlanCategory: string

タイトル: Payment Plan Category

最大長: 30

デフォルト値: STANDARD

ド・ローおよびキャップを適用するプラン・コンポーネントを示すコード。デフォルト値はSTANDARDです。許容可能な値のリストは、参照CN_PAYMENT_PLAN_CATEGORYで定義されます。設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
PaymentPlanId: integer (int64)

タイトル: Payment Plan

支払プランの一意の識別子。
PaymentPlanName: string

タイトル: Name

最大長: 160

支払プランの名前。
PaymentPlanRoles: array Payment Plans Roles

タイトル: Payment Plans Roles

ロール・リソースは、支払プランのインセンティブ報酬ロール割当を表示、作成、更新または削除するために使用されます。
RecoverExpressionId: integer (int64)

タイトル: Recovery Method

デフォルト値: -1001

リカバリ式の一意の識別子。回収式によって、支払済前払金を回収するために控除できる支給が決まります。デフォルトの有効な値は"-1001"のみで、全ての支給に対して回収されます。
RecoveryEndIntervalId: 整数(int32)

タイトル: Recovery End

前払金回収を終了する時期を示すコード。遅延リカバリが有効な場合、この値はオプションです。この値は、遅延リカバリ開始後の相対日付を決定するために使用されます。可能な値は、3か月後にリカバリを停止する"-1"、6か月後にリカバリを停止する"-2"、9か月後にリカバリを停止する"-3"、12か月後にリカバリを停止する"-4"です。
RecoveryStartIntervalId: 整数(int32)

タイトル: Recovery Start

遅延リカバリ期間が終了し、リカバリ処理を開始する時期を示すコード。遅延リカバリが有効な場合、この値は必須です。この値は、支払プラン割当開始日より後の相対日付を決定するために使用されます。可能な値は、3か月後にリカバリを開始する場合は"-1"、6か月後にリカバリを開始する場合は"-2"、9か月後にリカバリを開始する場合は"-3"、12か月後にリカバリを開始する場合は"-4"です。
StartDate: 文字列(日付)

タイトル: Start Date

支払プランがアクティブになる日付。許容可能な書式はyyyy-mm-ddです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the payment plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumRecoverFlag":{
            "title":"Minimum Recovery",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the draw amounts paid to the participant should be recovered in subsequent pay periods. When enabled, the payment process deducts from the payment of earnings over a period of time until the full draw amount is recovered. Valid values are Y and N. The default value is Y.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "RecoveryEndIntervalId":{
            "title":"Recovery End",
            "type":"integer",
            "description":"The code indicating when draw recovery should end. This value is optional if delayed recovery is enabled. The value is used to determine the relative date after the delayed recovery start. Possible values are \"-1\" to stop the recovery after 3 months, \"-2\" to stop the recovery after 6 months, \"-3\" to stop the recovery after 9 months, and \"-4\" to stop the recovery after 12 months.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":1
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the payment plan is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the payment plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"A brief description of the payment plan.",
            "nullable":true,
            "x-queryable":true
        },
        "MaximumAmount":{
            "title":"Maximum Payment",
            "type":"number",
            "description":"The maximum amount to pay the participant for the payment interval. The payment process creates a payment adjustment when the total earnings for the pay period are more than the maximum amount. This payment adjustment is often referred to as a cap.",
            "nullable":true,
            "x-queryable":true
        },
        "DrawEnd":{
            "title":"Draw End",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating when the draw calculation for the participant should end. The value is used to determine the relative date after the payment plan assignment start date. Possible values are \"-1\", to stop the draw after 3 months, \"-2\", to stop the draw after 6 months, \"-3\", to stop the draw after 9 months, and \"-4\", to stop the draw after 12 months.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PayExcessLaterFlag":{
            "title":"Carry forward maximum",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the maximum payment adjustment should be carried forward to offset earning short falls in subsequent pay periods. Valid values are Y and N. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the payment plan becomes inactive. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RecoverExpressionId":{
            "title":"Recovery Method",
            "type":"integer",
            "description":"The unique identifier of the recover expression. Recover expression determines which earnings can be deducted from, to recover a paid draw. The default, and only, valid value is \"-1001\" to recover against all earnings.",
            "format":"int64",
            "nullable":true,
            "default":-1001,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaymentPlanRoles":{
            "title":"Payment Plans Roles",
            "type":"array",
            "description":"The roles resource is used to view, create, update, or delete an incentive compensation role assignment for a payment plan.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPaymentPlans-PaymentPlanRoles-item-response"
            }
        },
        "PaymentPlanAssignments":{
            "title":"Payment Plans Assignments",
            "type":"array",
            "description":"The assignments resource is used to view, create, update, or delete an incentive compensation assignment for a payment plan.",
            "items":{
                "$ref":"#/components/schemas/incentiveCompensationPaymentPlans-PaymentPlanAssignments-item-response"
            }
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the payment plan becomes active. The acceptable 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 to which the payment plan belongs. Review the business unit ID for a business unit using the Setup and Maintenance, Define Business Units task. If the Business Unit ID column is not displayed, then click the View menu to add the Business Unit ID column.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "FlatMinimumAmount":{
            "title":"Flat Minimum Amount to Pay Participant",
            "type":"number",
            "description":"The minimum amount to pay the participant per the payment interval. The payment process creates a payment adjustment when the total earnings for the pay period are less than the minimum amount. This payment adjustment is often referred to as a draw or a guaranteed minimum.",
            "nullable":false,
            "x-queryable":true
        },
        "PaymentPlanCategory":{
            "title":"Payment Plan Category",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating which plan components to apply the draw and cap. 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":false,
            "default":"STANDARD",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PaymentPlanName":{
            "title":"Name",
            "maxLength":160,
            "type":"string",
            "description":"The name of the payment plan.",
            "nullable":false,
            "x-queryable":true
        },
        "PayIntervalTypeId":{
            "title":"Payment Interval",
            "type":"integer",
            "description":"The unique identifier of the business unit interval that defines the frequency of the payment plan draw and cap adjustments. Intervals include period, quarter, annual, and semi annual. The default value is the identifier \"-1000\" for the period interval. Additional intervals are defined for the business unit using the Setup and Maintenance, Manage Intervals task. Use the finder for this resource to get the unique identifiers for the intervals.",
            "format":"int64",
            "nullable":false,
            "default":-1000,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "OrgId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecoveryStartIntervalId":{
            "title":"Recovery Start",
            "type":"integer",
            "description":"The code indicating when the delayed recovery period ends and the recovery processing should start. This value is required if delayed recovery is enabled. The value is used to determine the relative date after the payment plan assignment start date. Possible values are \"-1\" to start the recovery after 3 months, \"-2\" to start the recovery after 6 months, \"-3\" to start the recovery after 9 months, and \"-4\" to start the recovery after 12 months.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":1
            },
            "x-queryable":true
        },
        "PaymentPlanId":{
            "title":"Payment Plan",
            "type":"integer",
            "description":"The unique identifier of the payment plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the payment plan was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DelayRecoveryFlag":{
            "title":"Recovery Start Option",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether recovering draw amounts should be delayed for several months after being paid. Valid values are Y and N. If providing the value \"Y\" to enable delayed recovery, then provide the recovery start and optionally provide a recovery end.  If providing the value \"N\", then the recovery starts immediately in the next subsequent payment. The default value is \"N\".",
            "nullable":true,
            "default":false,
            "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

タイトル: Payment Plans Assignments

割当リソースは、支払プランのインセンティブ報酬割当を表示、作成、更新または削除するために使用されます。

ソースを表示

Array of: object incentiveCompensationPaymentPlans-PaymentPlanAssignments-item-response

{
    "title":"Payment Plans Assignments",
    "type":"array",
    "description":"The assignments resource is used to view, create, update, or delete an incentive compensation assignment for a payment plan.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPaymentPlans-PaymentPlanAssignments-item-response"
    }
}

ネストされたスキーマ : 支払プラン・ロール

タイプ: array

タイトル: Payment Plans Roles

ロール・リソースは、支払プランのインセンティブ報酬ロール割当を表示、作成、更新または削除するために使用されます。

ソースを表示

Array of: object incentiveCompensationPaymentPlans-PaymentPlanRoles-item-response

{
    "title":"Payment Plans Roles",
    "type":"array",
    "description":"The roles resource is used to view, create, update, or delete an incentive compensation role assignment for a payment plan.",
    "items":{
        "$ref":"#/components/schemas/incentiveCompensationPaymentPlans-PaymentPlanRoles-item-response"
    }
}

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

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

ネストされたスキーマ : incentiveCompensationPaymentPlans-PaymentPlanAssignments-item-response

タイプ: object

ソースを表示

AnalystId: integer (int64)

タイトル: Analyst

読取り専用: true

支払プランに割り当てられたアナリストの一意の識別子。
AnalystName: string

タイトル: Analyst Name

読取り専用: true

最大長: 360

支払プランに割り当てられたアナリストの名前。
AssignmentType: string

タイトル: Assignment Type

読取り専用: true

支払プランのアサイメント・タイプ。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

支払プラン割当を作成したユーザー。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

支払プラン割当が作成された日時。
EndDate: 文字列(日付)

タイトル: End Date

支払プランの割当が非アクティブになる日付。許容可能な書式はyyyy-mm-ddです。
FlatMinimumAmount: number

タイトル: Flat Minimum Amount to Pay Participant

支払間隔ごとに参加者に支払う最小金額。支払プロセスでは、支払期間の支給合計が最小金額を下回ると、支払調整が作成されます。この支払調整は、通常、前払金または保証された最小額と呼ばれます。
LastUpdateDate: string (date-time)

タイトル: Last Updated Date

読取り専用: true

支払プラン割当が最後に更新された日時。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

支払プラン割当を最後に更新したユーザー。
links: array Links

タイトル: Links

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

タイトル: Maximum Payment

支払間隔の参加者に支払う最大金額。支払期間の支給合計が最大金額を超えると、支払プロセスによって支払調整が作成されます。この支払調整は、多くの場合、上限と呼ばれます。
ParticipantId: integer (int64)

タイトル: Participant Identifier

関係者の一意の識別子。
ParticipantName: string

タイトル: Participant Name

読取り専用: true

最大長: 360

インセンティブ報酬の関係者の名前。
ParticipantPaymentPlanId: integer (int64)

支払プランの一意の識別子。
PersonNumber: string

タイトル: Person Number

読取り専用: true

最大長: 30

企業との関係に関係なく、アプリケーション内の個人を一意に識別するFusion HCM固有の識別子。国別識別子コンポーネントとの関連はありません。
RecoveryEndDate: 文字列(日付)

タイトル: Recovery End Date

参加者による前払金の回収が終了する日付。
RecoveryStartDate: 文字列(日付)

タイトル: Recovery Start Date

参加者による前払金の回収が開始する日付。
RoleId: integer (int64)

読取り専用: true

支払プラン・ロールに対する一意の識別子。
RoleName: string

タイトル: Role Name

読取り専用: true

最大長: 60

ロールの名前。
StartDate: 文字列(日付)

タイトル: Start Date

割当がアクティブになる日付。許容可能な書式はyyyy-mm-ddです。

{
    "type":"object",
    "properties":{
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"The Fusion HCM specific identifier that uniquely identifies a person in the application, regardless of their relationship to the enterprise. It does not have any relation to any national identifier component.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the payment plan assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the payment plan assignment is 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 payment plan assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantPaymentPlanId":{
            "type":"integer",
            "description":"The unique identifier of the payment plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MaximumAmount":{
            "title":"Maximum Payment",
            "type":"number",
            "description":"The maximum amount to pay the participant for the payment interval. The payment process creates a payment adjustment when the total earnings for the pay period are more than the maximum amount. This payment adjustment is often referred to as a cap.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Participant Name",
            "maxLength":360,
            "type":"string",
            "description":"The name  of the participant in incentive compensation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier off the payment plan role.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the assignment for a payment plan becomes inactive. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AnalystName":{
            "title":"Analyst Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the analyst assigned to the payment plan.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "title":"Participant Identifier",
            "type":"integer",
            "description":"The unique identifier for a participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the assignment becomes active. The acceptable format is yyyy-mm-dd.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "FlatMinimumAmount":{
            "title":"Flat Minimum Amount to Pay Participant",
            "type":"number",
            "description":"The minimum amount to pay the participant per the payment interval. The payment process creates a payment adjustment when the total earnings for the pay period are less than the minimum amount. This payment adjustment is often referred to as a draw or a guaranteed minimum.",
            "nullable":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AnalystId":{
            "title":"Analyst",
            "type":"integer",
            "description":"The unique identifier of the analyst assigned to the payment plan.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentType":{
            "title":"Assignment Type",
            "type":"string",
            "description":"The assignment type for the payment plan.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecoveryStartDate":{
            "title":"Recovery Start Date",
            "type":"string",
            "description":"The date when the recovery of draw owed by the participant starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the payment plan assignment was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecoveryEndDate":{
            "title":"Recovery End Date",
            "type":"string",
            "description":"The date when the recovery of draw owed by the participant ends.",
            "format":"date",
            "nullable":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"
    }
}

ネストされたスキーマ : incentiveCompensationPaymentPlans-PaymentPlanRoles-item-response

タイプ: object

ソースを表示

CreatedBy: string

読取り専用: true

最大長: 64

支払プラン・ロール割当を作成したユーザー。
CreationDate: string (date-time)

読取り専用: true

支払プラン・ロール割当が作成された日時。
Description: string

タイトル: Role Description

読取り専用: true

最大長: 120

支払プラン・ロールの簡単な説明。
EndDate: 文字列(日付)

タイトル: End Date

支払プランのロール割当が非アクティブになる日付。許容可能な書式はyyyy-mm-ddです。日付は、支払プラン終了日以前にする必要があります。
LastUpdateDate: string (date-time)

読取り専用: true

支払プラン・ロール割当が最後に更新された日時。
LastUpdatedBy: string

読取り専用: true

最大長: 64

支払プラン・ロール割当を最後に更新したユーザー。
links: array Links

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。
PaymentPlanId: integer (int64)

支払プランの一意の識別子。
RoleId: integer (int64)

支払プラン・ロールに対する一意の識別子。
RoleName: string

タイトル: Role Name

読取り専用: true

最大長: 60

ロールの名前。
RolePaymentPlanId: integer (int64)

支払プランに関連付けられたロールの一意の識別子。
StartDate: 文字列(日付)

タイトル: Start Date

支払プランのロール割当がアクティブになる日付。許容可能な書式はyyyy-mm-ddです。日付は、支払プラン開始日以降にする必要があります。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the payment plan role assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the role assignment for a payment plan becomes active. The acceptable format is yyyy-mm-dd. The date must be equal to or later than the payment plan start date.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the payment plan role assignment is created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":60,
            "type":"string",
            "description":"The name of the role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Role Description",
            "maxLength":120,
            "type":"string",
            "description":"A brief description of the payment plan role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the payment plan role assignment.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RolePaymentPlanId":{
            "type":"integer",
            "description":"The unique identifier of the role associated with a payment plan.",
            "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"
            }
        },
        "PaymentPlanId":{
            "type":"integer",
            "description":"The unique identifier of the payment plan.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier off the payment plan role.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the role assignment for a payment plan becomes inactive. The acceptable format is yyyy-mm-dd. The date must be equal to or earlier than the payment plan end date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the payment plan role assignment was last updated.",
            "format":"date-time",
            "nullable":false,
            "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"
    }
}

「トップに戻る」