機械翻訳について

ジャンプ先

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

支払バッチの作成

post

/fscmRestApi/resources/11.13.18.05/paymentBatches

リクエスト

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• EarningsCalculatedBy: string
  タイトル: Incentive Type

  最大長: 30

  デフォルト値: ALL

  プラン・コンポーネント計算インセンティブ値を使用して適格支給をフィルタするために使用する支払バッチ選択基準。 指定可能な値は、COMMISSION (イベントごと)、BONUS (間隔ごと)およびALL (両方)です。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照CN_PAYMENT_INCENTIVE_TYPEに使用可能なコードをレビューします。
• IncentiveTypeCode: string
  タイトル: Payment Type

  最大長: 30

  デフォルト値: ALL

  将来使用するために予約されています。
• OrgId: integer (int64)
  タイトル: Business Unit

  支払バッチが属するビジネス・ユニットの一意の識別子。 「設定およびメンテナンス」>「ビジネス・ユニットの定義」タスクを使用して、ビジネス・ユニットのビジネス・ユニットIDをレビューします。 Business Unit ID(ビジネス・ユニットID)列が表示されない場合は、View(表示)メニューをクリックしてBusiness Unit ID(ビジネス・ユニットID)列を追加します。
• PayGroupId(required): integer (int64)
  支払に対するインセンティブ報酬参加者の選択に使用される支払グループの一意の識別子。
• PaymentDate: 文字列(日付)
  タイトル: Pay Date

  支払バッチ支払日。 支払バッチ作成プロセスでは、支給イベント日が支給日以前になっている支払シートに含める未払支給が全て選択されます。
• paymentTransactions: array Payment Transactions
  タイトル: Payment Transactions

  支払トランザクション・リソースは、参加者支払トランザクションの表示、作成、更新および削除に使用されます。 支払トランザクションは、インセンティブ報酬プラン・コンポーネントからの計算済支給、手動調整、回収済金額、または支払プラン前払金および回収調整です。 支払トランザクション・リソースは、支払トランザクション保留および未払ステータスの支払シートの手動調整の管理にも使用されます。
• PayPeriodId(required): integer (int64)
  タイトル: Period

  支払バッチの対象となるカレンダ期間を表す期間番号。 期間番号は、「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用してインセンティブ報酬カレンダを定義するときに生成されます。 たとえば、期間番号2019001は、2019年の最初の期間を表します。
• PayrunId: integer (int64)
  支払バッチの一意の識別子。
• PayrunName(required): string
  タイトル: Payment Batch

  最大長: 80

  支払バッチ名。
• paysheets: array Paysheets
  タイトル: Paysheets

  支払シート・リソースは、参加者の支払シートを表示および更新するために使用されます。 支払バッチでは、支払バッチ基準を満たす各インセンティブ報酬参加者の支払シートが生成されます。 個々の支払シートはプラン・コンポーネントごとに生成され、すべてのプラン・コンポーネントに対して要約支払シートが生成されます。
• ReportGroup: string
  タイトル: Incentive Type

  最大長: 30

  賞与やコミッションなど、プラン・コンポーネント・インセンティブ・タイプを使用して適格な支給をフィルタするために使用する支払バッチ選択基準。 指定可能な値には、BONUS、COMMISSIONおよびSTANDARDがあります。 許容可能な値のリストは、参照CN_REPORT_GROUPで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• RequestId: integer (int64)
  支払バッチの支払シートを生成するために発行されるプロセスの一意の識別子。

{
    "required":[
        "PayGroupId",
        "PayPeriodId",
        "PayrunName"
    ],
    "type":"object",
    "properties":{
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit to which the payment batch 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
            }
        },
        "paymentTransactions":{
            "title":"Payment Transactions",
            "type":"array",
            "description":"The payment transactions resource is used to view, create, update, and delete participant payment transactions. A payment transaction can be the calculated earnings from an incentive compensation plan component, a manual adjustment, a recovered amount, or a payment plan draw and recovery adjustment. The payment transaction resource is also used to manage payment transaction holds and manual adjustments for paysheets with a status of unpaid.",
            "items":{
                "$ref":"#/components/schemas/paymentBatches-paymentTransactions-item-post-request"
            }
        },
        "RequestId":{
            "type":"integer",
            "description":"The unique identifier for the process submitted to generate the paysheets for the payment batch.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PaymentDate":{
            "title":"Pay Date",
            "type":"string",
            "description":"The payment batch pay date. The payment batch creation process selects all unpaid earnings to include in the paysheet where the earning event dates are on or earlier than the pay date.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PayPeriodId"
                ]
            }
        },
        "paysheets":{
            "title":"Paysheets",
            "type":"array",
            "description":"The paysheets resource is used to view and update participant paysheets. A payment batch generates paysheets for each incentive compensation participant who meets the payment batch criteria. Individual paysheets are generated for each plan component and a summarized paysheet is generated for all plan components.",
            "items":{
                "$ref":"#/components/schemas/paymentBatches-paysheets-item-post-request"
            }
        },
        "PayGroupId":{
            "type":"integer",
            "description":"The unique identifier of the pay group, used to select the incentive compensation participants for payment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "OrgId"
                ]
            }
        },
        "PayrunId":{
            "type":"integer",
            "description":"The unique identifier of the payment batch.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "IncentiveTypeCode":{
            "title":"Payment Type",
            "maxLength":30,
            "type":"string",
            "description":"Reserved for future use.",
            "nullable":true,
            "default":"ALL"
        },
        "EarningsCalculatedBy":{
            "title":"Incentive Type",
            "maxLength":30,
            "type":"string",
            "description":"The payment batch selection criteria that is used to filter eligible earnings using the plan component calculate incentives value. Acceptable values are COMMISSION (per event), BONUS (per interval), and ALL (both). Review the available codes for lookup CN_PAYMENT_INCENTIVE_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "default":"ALL",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PayrunName":{
            "title":"Payment Batch",
            "maxLength":80,
            "type":"string",
            "description":"The payment batch name.",
            "nullable":false
        },
        "PayPeriodId":{
            "title":"Period",
            "type":"integer",
            "description":"The period number representing the calendar period the payment batch is for. The period numbers are generated when you define your incentive compensation calendar using the Setup and Maintenance work area, Manage Calendars task. For example, the period number 2019001 represents the first period in the year 2019.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18,
                "dependencies":[
                    "PayGroupId"
                ]
            }
        },
        "ReportGroup":{
            "title":"Incentive Type",
            "maxLength":30,
            "type":"string",
            "description":"The payment batch selection criteria that is used to filter eligible earnings using the plan component 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":true,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

ネストされたスキーマ : 支払トランザクション

タイプ: array

タイトル: Payment Transactions

支払トランザクション・リソースは、参加者支払トランザクションの表示、作成、更新および削除に使用されます。 支払トランザクションは、インセンティブ報酬プラン・コンポーネントからの計算済支給、手動調整、回収済金額、または支払プラン前払金および回収調整です。 支払トランザクション・リソースは、支払トランザクション保留および未払ステータスの支払シートの手動調整の管理にも使用されます。

ソースを表示

• Array of: object schema

{
    "title":"Payment Transactions",
    "type":"array",
    "description":"The payment transactions resource is used to view, create, update, and delete participant payment transactions. A payment transaction can be the calculated earnings from an incentive compensation plan component, a manual adjustment, a recovered amount, or a payment plan draw and recovery adjustment. The payment transaction resource is also used to manage payment transaction holds and manual adjustments for paysheets with a status of unpaid.",
    "items":{
        "$ref":"#/components/schemas/paymentBatches-paymentTransactions-item-post-request"
    }
}

ネストされたスキーマ : 支払シート

タイプ: array

タイトル: Paysheets

支払シート・リソースは、参加者の支払シートを表示および更新するために使用されます。 支払バッチでは、支払バッチ基準を満たす各インセンティブ報酬参加者の支払シートが生成されます。 個々の支払シートはプラン・コンポーネントごとに生成され、すべてのプラン・コンポーネントに対して要約支払シートが生成されます。

ソースを表示

• Array of: object paymentBatches-paysheets-item-post-request

{
    "title":"Paysheets",
    "type":"array",
    "description":"The paysheets resource is used to view and update participant paysheets. A payment batch generates paysheets for each incentive compensation participant who meets the payment batch criteria. Individual paysheets are generated for each plan component and a summarized paysheet is generated for all plan components.",
    "items":{
        "$ref":"#/components/schemas/paymentBatches-paysheets-item-post-request"
    }
}

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

タイプ: object

ソースを表示

• AdjustComments: string
  タイトル: Comment

  最大長: 1000

  支払トランザクション金額の修正時に入力された注釈。
• CreditedParticipantId: integer (int64)
  タイトル: Credit Receiver

  ソース・トランザクションのクレジットを受け取ったインセンティブ報酬関係者の一意の識別子です。 参加者スナップショット作業領域の「参加者の選択」ページを使用して、参加者の参加者識別子をレビューします。
• HoldFlag: boolean
  タイトル: Payment Hold

  最大長: 1

  デフォルト値: false

  保留が明示的に解除されるまで支払トランザクションを保留するかどうかを示します。 値がYの場合、支払トランザクションは保留になります。 デフォルト値は「Y」です。
• HomeCurrencyCode: string
  タイトル: Home Currency

  最大長: 15

  支払トランザクションのソース・イベント日の時点で有効な参加者ホーム通貨を示すコード。 関係者スナップショット作業領域の「参加者詳細の管理」ページを使用して、有効な関係者属性をレビューします。
• IncentiveTypeCode: string
  タイトル: Payment Type

  最大長: 30

  デフォルト値: MANUAL_PAY_ADJ

  賞与、支払プラン調整、手動調整など、支払トランザクション・タイプのカテゴリを表すコード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照CN_PAYMENT_ADJUSTMENT_TYPEに使用可能なコードをレビューします。
• ManualAdjustmentReasonCode: string
  タイトル: Reason

  最大長: 30

  支払シート手動調整の事由を表すコード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照ORA_CN_PAYSHEET_MANUAL_ADJに使用可能なコードをレビューします。
• OrgId: integer (int64)
  タイトル: Business Unit

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

  参加者ホーム通貨での支払トランザクション金額。
• PayAmountPayCurrency: number
  タイトル: Processing Payment Amount

  処理通貨での支払トランザクション金額。 処理通貨は、ビジネス・ユニットの営業通貨または参加者ホーム通貨として選択されます。 「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用して、処理通貨パラメータをレビューします。
• PayPeriodId: integer (int64)
  タイトル: Period

  手動支払シート修正の支払トランザクション支給イベント日または支払バッチ期間の期間を表す期間番号。 期間番号は、「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用してインセンティブ報酬カレンダを定義するときに生成されます。 たとえば、期間番号2015001は、2015年の最初の期間を表します。
• PayrunId: integer (int64)
  この支払トランザクションが属する支払バッチの一意の識別子。
• PlanComponentId: integer (int64)
  参加者支給額の計算に使用される参加者インセンティブ報酬プラン・コンポーネントの一意の識別子です。
• RecoverableFlag: boolean
  タイトル: Recoverable

  最大長: 1

  デフォルト値: true

  支払修正が将来控除可能かどうかを示します。 値がYの場合、支払調整は控除可能です。 デフォルト値は「Y」です。

{
    "type":"object",
    "properties":{
        "RecoverableFlag":{
            "title":"Recoverable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the payment adjustment is recoverable in the future. If the value is Y, then the payment adjustment is recoverable. The default value is Y.",
            "nullable":true,
            "default":true
        },
        "HomeCurrencyCode":{
            "title":"Home Currency",
            "maxLength":15,
            "type":"string",
            "description":"The code indicating the participant home currency that is in effect as of the source event date of the payment transaction. Review the effective participant attributes using the Participant Snapshot work area, Manage Participant Detail page.",
            "nullable":true
        },
        "AdjustComments":{
            "title":"Comment",
            "maxLength":1000,
            "type":"string",
            "description":"Commentary entered when adjusting the payment transaction amount.",
            "nullable":true
        },
        "PayrunId":{
            "type":"integer",
            "description":"The unique identifier of the payment batch to which this payment transaction belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the participant incentive compensation plan component used to calculate the participant earning amount.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "CreditedParticipantId",
                    "PayrunId"
                ]
            }
        },
        "ManualAdjustmentReasonCode":{
            "title":"Reason",
            "maxLength":30,
            "type":"string",
            "description":"The code that represents the reason for the paysheet manual adjustment. Review the available codes for lookup ORA_CN_PAYSHEET_MANUAL_ADJ using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ParticipantPayId":{
            "type":"integer",
            "description":"The unique identifier of the payment transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PayAmountPayCurrency":{
            "title":"Processing Payment Amount",
            "type":"number",
            "description":"The payment transaction amount in the processing currency. The processing currency is selected as either the operating currency or the participant home currency for the business unit. Review the processing currency parameter using the Setup and Maintenance work area, Manage Parameters task.",
            "nullable":false
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit to which the payment transaction 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
            }
        },
        "PayAmountHomeCurrency":{
            "title":"Home Payment Amount",
            "type":"number",
            "description":"The payment transaction amount in the participant home currency.",
            "nullable":true
        },
        "CreditedParticipantId":{
            "title":"Credit Receiver",
            "type":"integer",
            "description":"The unique identifier of the incentive compensation participant who received credit for the source transaction. Review the participant identifier for a participant using the Participant Snapshot work area, Select Participant page.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "IncentiveTypeCode":{
            "title":"Payment Type",
            "maxLength":30,
            "type":"string",
            "description":"The code that represents the categorization of the payment transaction types, such as bonus, payment plan adjustments, and manual adjustments. Review the available codes for lookup CN_PAYMENT_ADJUSTMENT_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "default":"MANUAL_PAY_ADJ",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "HoldFlag":{
            "title":"Payment Hold",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether to hold a payment transaction until the hold is explicitly released. If the value is Y, then the payment transaction is on hold. The default value is Y.",
            "nullable":true,
            "default":false
        },
        "PayPeriodId":{
            "title":"Period",
            "type":"integer",
            "description":"The period number representing the period of the payment transaction earning event date or the payment batch period for the manual paysheet adjustment. The period numbers are generated when you define your incentive compensation calendar using the Setup and Maintenance work area, Manage Calendars task. For example, the period number 2015001 represents the first period in the year 2015.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

ネストされたスキーマ : paymentBatches-paysheets-item-post-request

タイプ: object

ソースを表示

• ChequeNumber: string
  タイトル: Payment Reference Number

  最大長: 400

  支払システムによる実際の支払を確認する参照番号。
• PaymentDate: 文字列(日付)
  タイトル: Payment Date

  支払シート、支払バッチ支払日。 支払バッチ作成プロセスでは、支給イベント日が支給日以前になっている支払シートに含めるすべての未払支給項目が選択されました。
• PaymentMethod: string
  タイトル: Payment Method

  最大長: 30

  買掛/未払金や給与などの支払システムからの、電子資金振替や小切手などの確認済支払メソッド。
• paymentTransactions: array Payment Transactions
  タイトル: Payment Transactions
• PaysheetId: integer (int64)
  支払シートの一意の識別子。

{
    "type":"object",
    "properties":{
        "ChequeNumber":{
            "title":"Payment Reference Number",
            "maxLength":400,
            "type":"string",
            "description":"The reference number that acknowledges the actual payment made by the paying systems.",
            "nullable":true
        },
        "PaysheetId":{
            "type":"integer",
            "description":"The unique identifier of the paysheet.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PaymentMethod":{
            "title":"Payment Method",
            "maxLength":30,
            "type":"string",
            "description":"The acknowledged method of payment, such as electronic funds transfer or a check, from a paying system, such as payables or payroll.",
            "nullable":true
        },
        "paymentTransactions":{
            "title":"Payment Transactions",
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/paymentBatches-paysheets-paymentTransactions-item-post-request"
            }
        },
        "PaymentDate":{
            "title":"Payment Date",
            "type":"string",
            "description":"The paysheet, payment batch pay date. The payment batch creation process selected all unpaid earnings to include in the paysheet where the earning event dates were on or earlier than the pay date.",
            "format":"date",
            "nullable":true
        }
    }
}

ネストされたスキーマ : 支払トランザクション

タイプ: array

タイトル: Payment Transactions

ソースを表示

• Array of: object paymentBatches-paysheets-paymentTransactions-item-post-request

{
    "title":"Payment Transactions",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/paymentBatches-paysheets-paymentTransactions-item-post-request"
    }
}

ネストされたスキーマ : paymentBatches-paysheets-paymentTransactions-item-post-request

タイプ: object

ソースを表示

• AdjustComments: string
  タイトル: Comment

  最大長: 1000

  支払トランザクション金額の修正時に入力された注釈。
• CreditedParticipantId: integer (int64)
  タイトル: Credit Receiver

  ソース・トランザクションのクレジットを受け取ったインセンティブ報酬関係者の一意の識別子です。 参加者スナップショット作業領域の「参加者の選択」ページを使用して、参加者の参加者識別子をレビューします。
• HoldFlag: boolean
  タイトル: Payment Hold

  最大長: 1

  デフォルト値: false

  保留が明示的に解除されるまで支払トランザクションを保留するかどうかを示します。 値がYの場合、支払トランザクションは保留になります。 デフォルト値は「Y」です。
• HomeCurrencyCode: string
  タイトル: Home Currency

  最大長: 15

  支払トランザクションのソース・イベント日の時点で有効な参加者ホーム通貨を示すコード。 関係者スナップショット作業領域の「参加者詳細の管理」ページを使用して、有効な関係者属性をレビューします。
• IncentiveTypeCode: string
  タイトル: Payment Type

  最大長: 30

  デフォルト値: MANUAL_PAY_ADJ

  賞与、支払プラン調整、手動調整など、支払トランザクション・タイプのカテゴリを表すコード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照CN_PAYMENT_ADJUSTMENT_TYPEに使用可能なコードをレビューします。
• ManualAdjustmentReasonCode: string
  タイトル: Reason

  最大長: 30

  支払シート手動調整の事由を表すコード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照ORA_CN_PAYSHEET_MANUAL_ADJに使用可能なコードをレビューします。
• OrgId: integer (int64)
  タイトル: Business Unit

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

  参加者ホーム通貨での支払トランザクション金額。
• PayAmountPayCurrency: number
  タイトル: Processing Payment Amount

  処理通貨での支払トランザクション金額。 処理通貨は、ビジネス・ユニットの営業通貨または参加者ホーム通貨として選択されます。 「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用して、処理通貨パラメータをレビューします。
• PayPeriodId: integer (int64)
  タイトル: Period

  手動支払シート修正の支払トランザクション支給イベント日または支払バッチ期間の期間を表す期間番号。 期間番号は、「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用してインセンティブ報酬カレンダを定義するときに生成されます。 たとえば、期間番号2015001は、2015年の最初の期間を表します。
• PayrunId: integer (int64)
  この支払トランザクションが属する支払バッチの一意の識別子。
• PlanComponentId: integer (int64)
  参加者支給額の計算に使用される参加者インセンティブ報酬プラン・コンポーネントの一意の識別子です。
• RecoverableFlag: boolean
  タイトル: Recoverable

  最大長: 1

  デフォルト値: true

  支払修正が将来控除可能かどうかを示します。 値がYの場合、支払調整は控除可能です。 デフォルト値は「Y」です。

{
    "type":"object",
    "properties":{
        "RecoverableFlag":{
            "title":"Recoverable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the payment adjustment is recoverable in the future. If the value is Y, then the payment adjustment is recoverable. The default value is Y.",
            "nullable":true,
            "default":true
        },
        "HomeCurrencyCode":{
            "title":"Home Currency",
            "maxLength":15,
            "type":"string",
            "description":"The code indicating the participant home currency that is in effect as of the source event date of the payment transaction. Review the effective participant attributes using the Participant Snapshot work area, Manage Participant Detail page.",
            "nullable":true
        },
        "AdjustComments":{
            "title":"Comment",
            "maxLength":1000,
            "type":"string",
            "description":"Commentary entered when adjusting the payment transaction amount.",
            "nullable":true
        },
        "PayrunId":{
            "type":"integer",
            "description":"The unique identifier of the payment batch to which this payment transaction belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the participant incentive compensation plan component used to calculate the participant earning amount.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "CreditedParticipantId",
                    "PayrunId"
                ]
            }
        },
        "ManualAdjustmentReasonCode":{
            "title":"Reason",
            "maxLength":30,
            "type":"string",
            "description":"The code that represents the reason for the paysheet manual adjustment. Review the available codes for lookup ORA_CN_PAYSHEET_MANUAL_ADJ using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ParticipantPayId":{
            "type":"integer",
            "description":"The unique identifier of the payment transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PayAmountPayCurrency":{
            "title":"Processing Payment Amount",
            "type":"number",
            "description":"The payment transaction amount in the processing currency. The processing currency is selected as either the operating currency or the participant home currency for the business unit. Review the processing currency parameter using the Setup and Maintenance work area, Manage Parameters task.",
            "nullable":false
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit to which the payment transaction 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
            }
        },
        "PayAmountHomeCurrency":{
            "title":"Home Payment Amount",
            "type":"number",
            "description":"The payment transaction amount in the participant home currency.",
            "nullable":true
        },
        "CreditedParticipantId":{
            "title":"Credit Receiver",
            "type":"integer",
            "description":"The unique identifier of the incentive compensation participant who received credit for the source transaction. Review the participant identifier for a participant using the Participant Snapshot work area, Select Participant page.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "IncentiveTypeCode":{
            "title":"Payment Type",
            "maxLength":30,
            "type":"string",
            "description":"The code that represents the categorization of the payment transaction types, such as bonus, payment plan adjustments, and manual adjustments. Review the available codes for lookup CN_PAYMENT_ADJUSTMENT_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "default":"MANUAL_PAY_ADJ",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "HoldFlag":{
            "title":"Payment Hold",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether to hold a payment transaction until the hold is explicitly released. If the value is Y, then the payment transaction is on hold. The default value is Y.",
            "nullable":true,
            "default":false
        },
        "PayPeriodId":{
            "title":"Period",
            "type":"integer",
            "description":"The period number representing the period of the payment transaction earning event date or the payment batch period for the manual paysheet adjustment. The period numbers are generated when you define your incentive compensation calendar using the Setup and Maintenance work area, Manage Calendars task. For example, the period number 2015001 represents the first period in the year 2015.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  支払バッチが作成された日付。
• EarningsCalculatedBy: string
  タイトル: Incentive Type

  最大長: 30

  デフォルト値: ALL

  プラン・コンポーネント計算インセンティブ値を使用して適格支給をフィルタするために使用する支払バッチ選択基準。 指定可能な値は、COMMISSION (イベントごと)、BONUS (間隔ごと)およびALL (両方)です。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照CN_PAYMENT_INCENTIVE_TYPEに使用可能なコードをレビューします。
• IncentiveTypeCode: string
  タイトル: Payment Type

  最大長: 30

  デフォルト値: ALL

  将来使用するために予約されています。
• LastUpdateDate: string (date-time)
  タイトル: Last Update Date

  読取り専用: true

  支払バッチが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  支払バッチ・レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 32

  支払バッチ・レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
• links: array Links
  タイトル: Links

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

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

  読取り専用: true

  最大長: 960

  支払バッチが属するビジネス・ユニットの名前。
• PayGroupId: integer (int64)
  支払に対するインセンティブ報酬参加者の選択に使用される支払グループの一意の識別子。
• PayGroupName: string
  タイトル: Pay Group

  読取り専用: true

  最大長: 80

  支払に対するインセンティブ報酬参加者を選択するために支払シート支払バッチで使用された支払グループの名前。 参加者割当作業領域の支払グループの管理タスクを使用して、支払グループをレビューします。
• PaymentDate: 文字列(日付)
  タイトル: Pay Date

  支払バッチ支払日。 支払バッチ作成プロセスでは、支給イベント日が支給日以前になっている支払シートに含める未払支給が全て選択されます。
• paymentTransactions: array Payment Transactions
  タイトル: Payment Transactions

  支払トランザクション・リソースは、参加者支払トランザクションの表示、作成、更新および削除に使用されます。 支払トランザクションは、インセンティブ報酬プラン・コンポーネントからの計算済支給、手動調整、回収済金額、または支払プラン前払金および回収調整です。 支払トランザクション・リソースは、支払トランザクション保留および未払ステータスの支払シートの手動調整の管理にも使用されます。
• PayPeriodId: integer (int64)
  タイトル: Period

  支払バッチの対象となるカレンダ期間を表す期間番号。 期間番号は、「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用してインセンティブ報酬カレンダを定義するときに生成されます。 たとえば、期間番号2019001は、2019年の最初の期間を表します。
• PayrunId: integer (int64)
  支払バッチの一意の識別子。
• PayrunName: string
  タイトル: Payment Batch

  最大長: 80

  支払バッチ名。
• paysheets: array Paysheets
  タイトル: Paysheets

  支払シート・リソースは、参加者の支払シートを表示および更新するために使用されます。 支払バッチでは、支払バッチ基準を満たす各インセンティブ報酬参加者の支払シートが生成されます。 個々の支払シートはプラン・コンポーネントごとに生成され、すべてのプラン・コンポーネントに対して要約支払シートが生成されます。
• PeriodName: string
  タイトル: Period Name

  読取り専用: true

  最大長: 30

  支払バッチを使用するカレンダ期間の名前。 期間名は、インセンティブ報酬カレンダの定義時に入力されます。 「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用して、期間名をレビューおよび管理します。
• ReportGroup: string
  タイトル: Incentive Type

  最大長: 30

  賞与やコミッションなど、プラン・コンポーネント・インセンティブ・タイプを使用して適格な支給をフィルタするために使用する支払バッチ選択基準。 指定可能な値には、BONUS、COMMISSIONおよびSTANDARDがあります。 許容可能な値のリストは、参照CN_REPORT_GROUPで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
• RequestId: integer (int64)
  支払バッチの支払シートを生成するために発行されるプロセスの一意の識別子。
• Status: string
  タイトル: Status

  読取り専用: true

  最大長: 30

  デフォルト値: UNPAID

  未払、確定済、支払済など、現在の支払バッチ・ステータスを表すコード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照CN_PAYRUN_STATUSに使用可能なコードをレビューします。

{
    "type":"object",
    "properties":{
        "Status":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code that represents the current payment batch status, such as unpaid, frozen, and paid. Review the available codes for the lookup CN_PAYRUN_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "default":"UNPAID",
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the payment batch record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the payment batch was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "paymentTransactions":{
            "title":"Payment Transactions",
            "type":"array",
            "description":"The payment transactions resource is used to view, create, update, and delete participant payment transactions. A payment transaction can be the calculated earnings from an incentive compensation plan component, a manual adjustment, a recovered amount, or a payment plan draw and recovery adjustment. The payment transaction resource is also used to manage payment transaction holds and manual adjustments for paysheets with a status of unpaid.",
            "items":{
                "$ref":"#/components/schemas/paymentBatches-paymentTransactions-item-response"
            }
        },
        "RequestId":{
            "type":"integer",
            "description":"The unique identifier for the process submitted to generate the paysheets for the payment batch.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaymentDate":{
            "title":"Pay Date",
            "type":"string",
            "description":"The payment batch pay date. The payment batch creation process selects all unpaid earnings to include in the paysheet where the earning event dates are on or earlier than the pay date.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "PayPeriodId"
                ]
            },
            "x-queryable":true
        },
        "paysheets":{
            "title":"Paysheets",
            "type":"array",
            "description":"The paysheets resource is used to view and update participant paysheets. A payment batch generates paysheets for each incentive compensation participant who meets the payment batch criteria. Individual paysheets are generated for each plan component and a summarized paysheet is generated for all plan components.",
            "items":{
                "$ref":"#/components/schemas/paymentBatches-paysheets-item-response"
            }
        },
        "OrgName":{
            "title":"Business Unit",
            "maxLength":960,
            "type":"string",
            "description":"The name of the business unit to which the payment batch belongs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayrunId":{
            "type":"integer",
            "description":"The unique identifier of the payment batch.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PayGroupName":{
            "title":"Pay Group",
            "maxLength":80,
            "type":"string",
            "description":"The name of the pay group which was used by the paysheet payment batch to select the incentive compensation participants for the payment. Review pay groups using the Participant Assignments work area, Manage Pay Groups task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningsCalculatedBy":{
            "title":"Incentive Type",
            "maxLength":30,
            "type":"string",
            "description":"The payment batch selection criteria that is used to filter eligible earnings using the plan component calculate incentives value. Acceptable values are COMMISSION (per event), BONUS (per interval), and ALL (both). Review the available codes for lookup CN_PAYMENT_INCENTIVE_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "default":"ALL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ReportGroup":{
            "title":"Incentive Type",
            "maxLength":30,
            "type":"string",
            "description":"The payment batch selection criteria that is used to filter eligible earnings using the plan component 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":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit to which the payment batch 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
        },
        "PayGroupId":{
            "type":"integer",
            "description":"The unique identifier of the pay group, used to select the incentive compensation participants for payment.",
            "format":"int64",
            "nullable":false,
            "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"
            }
        },
        "PeriodName":{
            "title":"Period Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the calendar period the payment batch is for. The period name is entered when defining the incentive compensation calendar. Review and manage period names using the Setup and Maintenance work area, Manage Calendars task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "IncentiveTypeCode":{
            "title":"Payment Type",
            "maxLength":30,
            "type":"string",
            "description":"Reserved for future use.",
            "nullable":true,
            "default":"ALL",
            "x-queryable":true
        },
        "PayrunName":{
            "title":"Payment Batch",
            "maxLength":80,
            "type":"string",
            "description":"The payment batch name.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the payment batch was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated By",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the payment batch record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayPeriodId":{
            "title":"Period",
            "type":"integer",
            "description":"The period number representing the calendar period the payment batch is for. The period numbers are generated when you define your incentive compensation calendar using the Setup and Maintenance work area, Manage Calendars task. For example, the period number 2019001 represents the first period in the year 2019.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18,
                "dependencies":[
                    "PayGroupId"
                ]
            },
            "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 Transactions

支払トランザクション・リソースは、参加者支払トランザクションの表示、作成、更新および削除に使用されます。 支払トランザクションは、インセンティブ報酬プラン・コンポーネントからの計算済支給、手動調整、回収済金額、または支払プラン前払金および回収調整です。 支払トランザクション・リソースは、支払トランザクション保留および未払ステータスの支払シートの手動調整の管理にも使用されます。

ソースを表示

• Array of: object paymentBatches-paymentTransactions-item-response

{
    "title":"Payment Transactions",
    "type":"array",
    "description":"The payment transactions resource is used to view, create, update, and delete participant payment transactions. A payment transaction can be the calculated earnings from an incentive compensation plan component, a manual adjustment, a recovered amount, or a payment plan draw and recovery adjustment. The payment transaction resource is also used to manage payment transaction holds and manual adjustments for paysheets with a status of unpaid.",
    "items":{
        "$ref":"#/components/schemas/paymentBatches-paymentTransactions-item-response"
    }
}

ネストされたスキーマ : 支払シート

タイプ: array

タイトル: Paysheets

支払シート・リソースは、参加者の支払シートを表示および更新するために使用されます。 支払バッチでは、支払バッチ基準を満たす各インセンティブ報酬参加者の支払シートが生成されます。 個々の支払シートはプラン・コンポーネントごとに生成され、すべてのプラン・コンポーネントに対して要約支払シートが生成されます。

ソースを表示

• Array of: object paymentBatches-paysheets-item-response

{
    "title":"Paysheets",
    "type":"array",
    "description":"The paysheets resource is used to view and update participant paysheets. A payment batch generates paysheets for each incentive compensation participant who meets the payment batch criteria. Individual paysheets are generated for each plan component and a summarized paysheet is generated for all plan components.",
    "items":{
        "$ref":"#/components/schemas/paymentBatches-paysheets-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."
        }
    }
}

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

タイプ: object

ソースを表示

• AdjustComments: string
  タイトル: Comment

  最大長: 1000

  支払トランザクション金額の修正時に入力された注釈。
• CommAmountCalculationCurrency: number
  タイトル: Earning Amount

  読取り専用: true

  処理通貨での計算済支給額。
• CommissionValue: number
  タイトル: Earning Rate

  読取り専用: true

  支給額の計算に使用されたインセンティブ・レート表金額またはレート。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  支払トランザクション・レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  支払トランザクションが作成された日付。
• CreditedParticipantId: integer (int64)
  タイトル: Credit Receiver

  ソース・トランザクションのクレジットを受け取ったインセンティブ報酬関係者の一意の識別子です。 参加者スナップショット作業領域の「参加者の選択」ページを使用して、参加者の参加者識別子をレビューします。
• CreditFactor: number
  タイトル: Credit Factor

  読取り専用: true

  支給計算式で使用された期間のクレジット金額の増加に対するアップ・リフト率。
• CreditTypeId: integer (int64)
  読取り専用: true

  デフォルト値: -1000

  支給タイプの一意の識別子です。 支給タイプはプラン・コンポーネントで選択され、支給を金額および非通貨カテゴリに分類するために使用されます。 Oracleが提供する通貨支給タイプのみを支払処理に含めることができます。
• EarningFactor: number
  タイトル: Earning Factor

  読取り専用: true

  支給計算式で使用された一定期間にわたる支給の増加に対するアップ・リフト率。
• EarningHId: integer (int64)
  読取り専用: true

  支給履歴レコードの一意の識別子です。 支給レコードへの変更は、支給履歴表に保存されています。
• EarningId: integer (int64)
  タイトル: Earnings

  読取り専用: true

  支給レコードの一意の識別子です。 支給項目は、参加者プラン・コンポーネントおよびソース・トランザクション・クレジットに基づいて計算されたインセンティブ金額です。
• EarningType: string
  タイトル: Earning Type

  読取り専用: true

  最大長: 30

  支給のタイプ。 支給タイプはプラン・コンポーネントで選択され、支給を金額および非通貨カテゴリに分類するために使用されます。 支払処理には、支給タイプが通貨の支給のみが含まれます。
• EligibleCatId: integer (int64)
  読取り専用: true

  インセンティブ・クレジットに割り当てられたクレジット・カテゴリの一意の識別子。 クレジット・カテゴリは、パフォーマンス測定および支給計算のためにクレジットを分類してから、参加者プラン・コンポーネントとクレジットを照合するために使用されました。
• HoldFlag: boolean
  タイトル: Payment Hold

  最大長: 1

  デフォルト値: false

  保留が明示的に解除されるまで支払トランザクションを保留するかどうかを示します。 値がYの場合、支払トランザクションは保留になります。 デフォルト値は「Y」です。
• HomeCurrencyCode: string
  タイトル: Home Currency

  最大長: 15

  支払トランザクションのソース・イベント日の時点で有効な参加者ホーム通貨を示すコード。 関係者スナップショット作業領域の「参加者詳細の管理」ページを使用して、有効な関係者属性をレビューします。
• IncentiveTypeCode: string
  タイトル: Payment Type

  最大長: 30

  デフォルト値: MANUAL_PAY_ADJ

  賞与、支払プラン調整、手動調整など、支払トランザクション・タイプのカテゴリを表すコード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照CN_PAYMENT_ADJUSTMENT_TYPEに使用可能なコードをレビューします。
• LastUpdateDate: string (date-time)
  タイトル: Last Update Date

  読取り専用: true

  支払トランザクションが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  支払トランザクション・レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 32

  支払トランザクション・レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
• links: array Links
  タイトル: Links

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

  最大長: 30

  支払シート手動調整の事由を表すコード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照ORA_CN_PAYSHEET_MANUAL_ADJに使用可能なコードをレビューします。
• ObjectStatus: string
  タイトル: Status

  読取り専用: true

  最大長: 30

  支払トランザクションのステータス。 有効な値は、UNPAIDとPAIDです。
• OrgId: integer (int64)
  タイトル: Business Unit

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

  読取り専用: true

  支払トランザクション金額の支払期日または控除対象であるインセンティブ報酬関係者の一意の識別子。 参加者スナップショット作業領域の「参加者の選択」ページを使用して、参加者の参加者識別子をレビューします。
• ParticipantName: string
  タイトル: Participant Name

  読取り専用: true

  最大長: 360

  支払トランザクション金額の支払期日または控除対象となるインセンティブ報酬参加者の名前。
• ParticipantPayId: integer (int64)
  支払トランザクションの一意の識別子。
• PayAmountFuncCurrency: number
  タイトル: Operating Payment Amount

  読取り専用: true

  営業通貨での支払トランザクション金額。
• PayAmountHomeCurrency: number
  タイトル: Home Payment Amount

  参加者ホーム通貨での支払トランザクション金額。
• PayAmountPayCurrency: number
  タイトル: Processing Payment Amount

  処理通貨での支払トランザクション金額。 処理通貨は、ビジネス・ユニットの営業通貨または参加者ホーム通貨として選択されます。 「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用して、処理通貨パラメータをレビューします。
• PayCurrencyCode: string
  タイトル: Currency

  読取り専用: true

  最大長: 20

  処理通貨を示すコード。 処理通貨は、ビジネス・ユニットの営業通貨または参加者ホーム通貨として選択されます。 「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用して、処理通貨パラメータをレビューします。
• PaymentTransactionDeleteFlag: boolean
  読取り専用: true

  適用できない標準アクションを通知するためのアクセス・インジケータ。 ここでは、アプリケーションで生成された支払トランザクションに対してDELETE標準処理を使用できません。
• PaymentTransactionUpdateFlag: boolean
  読取り専用: true

  適用できない標準アクションを通知するためのアクセス・インジケータ。 ここでは、支払プランの修正および前の支払シートからの回収済修正にUPDATE標準処理を使用できません。 また、支払シート・ステータスが未払以外のものである場合、更新は許可されません。
• PayPeriodId: integer (int64)
  タイトル: Period

  手動支払シート修正の支払トランザクション支給イベント日または支払バッチ期間の期間を表す期間番号。 期間番号は、「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用してインセンティブ報酬カレンダを定義するときに生成されます。 たとえば、期間番号2015001は、2015年の最初の期間を表します。
• PayrunId: integer (int64)
  この支払トランザクションが属する支払バッチの一意の識別子。
• PayrunName: string
  タイトル: Payment Batch

  読取り専用: true

  最大長: 80

  支払トランザクションが属する支払バッチの名前。
• PersonNumber: string
  タイトル: Person Number

  読取り専用: true

  最大長: 30

  支払トランザクション金額の支払期日または控除対象である参加者のグローバル人事管理で生成された参加者個人レコードの識別子です。 「参加者スナップショット」作業領域、「参加者の選択」ページおよび「参加者詳細の管理」ページを使用して、参加者個人番号をレビューします。
• PlanComponentId: integer (int64)
  参加者支給額の計算に使用される参加者インセンティブ報酬プラン・コンポーネントの一意の識別子です。
• PrimaryWorkerNumber: string
  タイトル: Worker Number

  読取り専用: true

  最大長: 30

  支払トランザクション金額の期日または控除対象である関係者の就業者または従業員番号。 関係者スナップショット作業領域の「参加者の選択」ページおよび「参加者詳細の管理」ページを使用して、就業者番号をレビューします。
• RecoverableFlag: boolean
  タイトル: Recoverable

  最大長: 1

  デフォルト値: true

  支払修正が将来控除可能かどうかを示します。 値がYの場合、支払調整は控除可能です。 デフォルト値は「Y」です。
• SourceEarningId: integer (int64)
  読取り専用: true

  この支給元のソース支給項目の一意識別子です。
• SourceEventDate: 文字列(日付)
  タイトル: Event Date

  読取り専用: true

  支給イベントの日付。 イベント日は、ソース・トランザクション・イベント日または計算グループ化イベント日のいずれかで、インセンティブ支給になりました。
• SourceTrxNumber: string
  タイトル: Transaction Number

  読取り専用: true

  最大長: 30

  参加者インセンティブ支給となったトランザクション番号。
• SrpPlanAssignId: integer (int64)
  読取り専用: true

  参加者への報酬プランの割当の一意の識別子。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the payment transaction was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeId":{
            "type":"integer",
            "description":"The unique identifier of the earning type. The earning type is selected for the plan component and is used to classify earnings into monetary and nonmonetary categories. You can only include the monetary earning type, provided by Oracle, in payment processing.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "default":-1000,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HomeCurrencyCode":{
            "title":"Home Currency",
            "maxLength":15,
            "type":"string",
            "description":"The code indicating the participant home currency that is in effect as of the source event date of the payment transaction. Review the effective participant attributes using the Participant Snapshot work area, Manage Participant Detail page.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustComments":{
            "title":"Comment",
            "maxLength":1000,
            "type":"string",
            "description":"Commentary entered when adjusting the payment transaction amount.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Participant Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the incentive compensation participant for whom the payment transaction amount is due or recoverable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningHId":{
            "type":"integer",
            "description":"The unique identifier of the earning history record. The changes to the earning record are stored in the earning history table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the payment transaction. The valid values are UNPAID and PAID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "title":"Participant Identifier",
            "type":"integer",
            "description":"The unique identifier of the incentive compensation participant for whom the payment transaction amount is due or recoverable. Review the participant identifier for a participant using the Participant Snapshot work area, Select Participant page.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantPayId":{
            "type":"integer",
            "description":"The unique identifier of the payment transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PayAmountPayCurrency":{
            "title":"Processing Payment Amount",
            "type":"number",
            "description":"The payment transaction amount in the processing currency. The processing currency is selected as either the operating currency or the participant home currency for the business unit. Review the processing currency parameter using the Setup and Maintenance work area, Manage Parameters task.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IncentiveTypeCode":{
            "title":"Payment Type",
            "maxLength":30,
            "type":"string",
            "description":"The code that represents the categorization of the payment transaction types, such as bonus, payment plan adjustments, and manual adjustments. Review the available codes for lookup CN_PAYMENT_ADJUSTMENT_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "default":"MANUAL_PAY_ADJ",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PayrunName":{
            "title":"Payment Batch",
            "maxLength":80,
            "type":"string",
            "description":"The name of the payment batch to which the payment transaction belongs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningId":{
            "title":"Earnings",
            "type":"integer",
            "description":"The unique identifier of the earning record. An earning is the calculated incentive amount based on the participant plan component and source transaction credit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the payment transaction record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"The generated identifier for the participant person record in Global Human Resources for the participant for whom the payment transaction amount is due or recoverable. Review the participant person number using the Participant Snapshot work area, Select Participant page and the Manage Participant Detail page.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommAmountCalculationCurrency":{
            "title":"Earning Amount",
            "type":"number",
            "description":"The calculated earning amount in the processing currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the payment transaction record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EligibleCatId":{
            "type":"integer",
            "description":"The unique identifier of the credit category assigned the incentive credit. The credit category was used to classify the credit and then match the credit to the participant plan component for performance measurement and earning calculation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecoverableFlag":{
            "title":"Recoverable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the payment adjustment is recoverable in the future. If the value is Y, then the payment adjustment is recoverable. The default value is Y.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "SrpPlanAssignId":{
            "type":"integer",
            "description":"The unique identifier of the assignment of the compensation plan to the participant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaymentTransactionDeleteFlag":{
            "type":"boolean",
            "description":"The access indicator to inform which standard actions are not applicable. Here we cannot use the DELETE standard action for payment transactions generated by the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PayAmountFuncCurrency":{
            "title":"Operating Payment Amount",
            "type":"number",
            "description":"The payment transaction amount in the operating currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayrunId":{
            "type":"integer",
            "description":"The unique identifier of the payment batch to which this payment transaction belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceEventDate":{
            "title":"Event Date",
            "type":"string",
            "description":"The date of the earning event. The event date is either the source transaction event date or the calculation grouping event date which resulted in the incentive earning.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningFactor":{
            "title":"Earning Factor",
            "type":"number",
            "description":"The uplift percentage for the increase in earnings over a period of time that was used in the earning calculation expression.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningType":{
            "title":"Earning Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the earning. The earning type is selected for the plan component and is used to classify earnings into monetary and nonmonetary categories. Only earnings with the monetary earning type are included in payment processing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryWorkerNumber":{
            "title":"Worker Number",
            "maxLength":30,
            "type":"string",
            "description":"The worker, or employee, number for the participant for whom the payment transaction amount is due or recoverable. Review the worker number using the Participant Snapshot work area, Select Participant page and the Manage Participant Detail page.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the participant incentive compensation plan component used to calculate the participant earning amount.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "CreditedParticipantId",
                    "PayrunId"
                ]
            },
            "x-queryable":true
        },
        "ManualAdjustmentReasonCode":{
            "title":"Reason",
            "maxLength":30,
            "type":"string",
            "description":"The code that represents the reason for the paysheet manual adjustment. Review the available codes for lookup ORA_CN_PAYSHEET_MANUAL_ADJ using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PayCurrencyCode":{
            "title":"Currency",
            "maxLength":20,
            "type":"string",
            "description":"The code indicating the processing currency. The processing currency is selected as either the operating currency or the participant home currency for the business unit. Review the processing currency parameter using the Setup and Maintenance work area, Manage Parameters task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit to which the payment transaction 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
        },
        "SourceTrxNumber":{
            "title":"Transaction Number",
            "maxLength":30,
            "type":"string",
            "description":"The transaction number which resulted in the participant incentive earning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayAmountHomeCurrency":{
            "title":"Home Payment Amount",
            "type":"number",
            "description":"The payment transaction amount in the participant home currency.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditedParticipantId":{
            "title":"Credit Receiver",
            "type":"integer",
            "description":"The unique identifier of the incentive compensation participant who received credit for the source transaction. Review the participant identifier for a participant using the Participant Snapshot work area, Select Participant page.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceEarningId":{
            "type":"integer",
            "description":"The unique identifier of the source earning from which this earning originated.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditFactor":{
            "title":"Credit Factor",
            "type":"number",
            "description":"The uplift percentage for the increase in credit amounts over a period of time that was used in the earning calculation expression.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentTransactionUpdateFlag":{
            "type":"boolean",
            "description":"The access indicator to inform which standard actions are not applicable. Here we cannot use the UPDATE standard action for payment plan adjustments and recovered adjustments from previous paysheets. Additionally, no updates are allowed when the paysheet status is something other than unpaid.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CommissionValue":{
            "title":"Earning Rate",
            "type":"number",
            "description":"The incentive rate table amount or rate that was used to calculate the earning amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldFlag":{
            "title":"Payment Hold",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether to hold a payment transaction until the hold is explicitly released. If the value is Y, then the payment transaction is on hold. The default value is Y.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the payment transaction was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated By",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the payment transaction record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayPeriodId":{
            "title":"Period",
            "type":"integer",
            "description":"The period number representing the period of the payment transaction earning event date or the payment batch period for the manual paysheet adjustment. The period numbers are generated when you define your incentive compensation calendar using the Setup and Maintenance work area, Manage Calendars task. For example, the period number 2015001 represents the first period in the year 2015.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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"
    }
}

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

タイプ: object

ソースを表示

• BeginningBalanceAmount: number
  タイトル: Beginning Balance

  読取り専用: true

  将来使用するために予約されています。
• CalculatedEarnings: number
  タイトル: Calculated Amount

  読取り専用: true

  支払シートの未調整計算済支給項目の合計です。
• ChequeNumber: string
  タイトル: Payment Reference Number

  最大長: 400

  支払システムによる実際の支払を確認する参照番号。
• EarningDifference: number
  タイトル: Earning Difference

  読取り専用: true

  未調整の計算済支給と調整後に支払われる実績金額の合計の差異。
• LastUpdateDate: string (date-time)
  タイトル: Last Update Date

  読取り専用: true

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

  読取り専用: true

  最大長: 64

  支払シート・レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 32

  支払シート・レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• NonRecEarningAdjustment: number
  タイトル: Waived Amount

  読取り専用: true

  将来使用するために予約されています。
• OrgId: integer (int64)
  タイトル: Business Unit

  読取り専用: true

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

  読取り専用: true

  最大長: 960

  支払シートが属するビジネス・ユニットの名前。
• ParticipantId: integer (int64)
  タイトル: Participant Identifier

  読取り専用: true

  支払シート金額の期日または控除対象となるインセンティブ報酬関係者の一意の識別子。 参加者スナップショット作業領域の「参加者の選択」ページを使用して、参加者の参加者識別子をレビューします。
• ParticipantName: string
  タイトル: Participant Name

  読取り専用: true

  最大長: 360

  支払シート金額の期日または控除対象となるインセンティブ報酬参加者の名前。
• PartyId: integer (int64)
  タイトル: Party Identifier

  読取り専用: true

  取引先コミュニティ内のパーティの一意の識別子。 パーティは、支払シート金額の支払期日または控除対象である参加者です。 参加者スナップショット作業領域の「参加者の選択」ページを使用して、参加者のパーティ識別子をレビューします。
• PartyNumber: string
  タイトル: Party Number

  読取り専用: true

  最大長: 30

  取引先コミュニティのパーティの代替キー識別子。 パーティは、支払シート金額の支払期日または控除対象である参加者です。 参加者スナップショット作業領域の「参加者の選択」ページおよび「参加者詳細の管理」ページを使用して、参加者のパーティ番号をレビューします。
• PayCurrencyCode: string
  タイトル: Currency

  読取り専用: true

  最大長: 15

  処理通貨を示すコード。 処理通貨は、ビジネス・ユニットの営業通貨または参加者ホーム通貨として選択されます。 「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用して、処理通貨パラメータをレビューします。
• PayGroupId: integer (int64)
  読取り専用: true

  支払に対するインセンティブ報酬参加者を選択するために支払シート支払バッチで使用された支払グループの一意の識別子です。
• PayGroupName: string
  タイトル: Pay Group

  読取り専用: true

  最大長: 80

  支払に対するインセンティブ報酬参加者を選択するために支払シート支払バッチで使用された支払グループの名前。 参加者割当作業領域の支払グループの管理タスクを使用して、支払グループをレビューします。
• PaymentAdjustmentAmount: number
  タイトル: Payment Amount

  読取り専用: true

  修正済支払トランザクションと未修正支払トランザクションの両方の合計。
• PaymentDate: 文字列(日付)
  タイトル: Payment Date

  支払シート、支払バッチ支払日。 支払バッチ作成プロセスでは、支給イベント日が支給日以前になっている支払シートに含めるすべての未払支給項目が選択されました。
• PaymentMethod: string
  タイトル: Payment Method

  最大長: 30

  買掛/未払金や給与などの支払システムからの、電子資金振替や小切手などの確認済支払メソッド。
• PaymentTotalAmount: number
  タイトル: Total Amount

  読取り専用: true

  処理通貨での支払シート支払金額。
• paymentTransactions: array Payment Transactions
  タイトル: Payment Transactions

  支払トランザクション・リソースは、参加者支払トランザクションの表示、作成、更新および削除に使用されます。 支払トランザクションは、インセンティブ報酬プラン・コンポーネントからの計算済支給、手動調整、回収済金額、または支払プラン前払金および回収調整です。 支払トランザクション・リソースは、支払トランザクション保留および未払ステータスの支払シートの手動調整の管理にも使用されます。
• PayPeriodId: integer (int64)
  タイトル: Period

  読取り専用: true

  支払シート、支払バッチを使用するカレンダ期間を表す期間番号。 期間番号は、「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用してインセンティブ報酬カレンダを定義するときに生成されます。 たとえば、期間番号2015001は、2015年の最初の期間を表します。
• PayrunId: integer (int64)
  読取り専用: true

  支払シートが属する支払バッチの一意の識別子。
• PayrunName: string
  タイトル: Payment Batch

  読取り専用: true

  最大長: 80

  支払シートが属する支払バッチの名前。
• PaysheetDeleteFlag: boolean
  読取り専用: true

  デフォルト値: false

  適用できない標準アクションを通知するためのアクセス・インジケータ。 ここでは、ペイ・シートに対してDELETE標準処理を使用できません。
• PaysheetId: integer (int64)
  支払シートの一意の識別子。
• PaysheetStatus: string
  タイトル: Status

  読取り専用: true

  最大長: 30

  未払、送信済、承認済など、現在の支払シート・ステータスを表す参照コード。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_PAYSHEET_STATUSの使用可能な参照コードをレビューします。
• PaysheetUpdateFlag: boolean
  読取り専用: true

  デフォルト値: false

  適用できない標準アクションを通知するためのアクセス・インジケータ。 ここでは、要約支払シート・ステータス値が支払われるまで、UPDATE標準処理を使用できません。 要約支払シートのみ更新できます。 個々のプラン・コンポーネントの支払シートは更新できません。
• PeriodId: integer (int64)
  タイトル: Incentive Compensation Calendar Period

  読取り専用: true

  支払シートの対象となるカレンダ期間を表す期間番号。 期間番号は、「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用してインセンティブ報酬カレンダを定義するときに生成されます。 たとえば、期間番号2015001は、2015年の最初の期間を表します。
• PeriodName: string
  タイトル: Period Name

  読取り専用: true

  最大長: 30

  支払シート、支払バッチを使用するカレンダ期間の名前。 期間名は、インセンティブ報酬カレンダの定義時に入力されます。 たとえば、Jan-2015やQ1-2015などです。 期間名は、「設定およびメンテナンス」作業領域のカレンダの管理タスクを使用してレビューおよび管理できます。
• PersonNumber: string
  タイトル: Person Number

  読取り専用: true

  最大長: 30

  支払シート金額の支払期日または控除対象である参加者のグローバル人事管理で生成された参加者個人レコードの識別子です。 「参加者スナップショット」作業領域、「参加者の選択」ページおよび「参加者詳細の管理」ページを使用して、参加者個人番号をレビューします。
• PlanComponentId: integer (int64)
  読取り専用: true

  関係者の計算済支給項目および支払シート調整に関連付けられた関係者インセンティブ報酬プラン・コンポーネントの一意の識別子です。
• PlanComponentName: string
  タイトル: Plan Component

  読取り専用: true

  最大長: 80

  インセンティブ報酬プラン・コンポーネントの名前。
• PmtAmountRecovery: number
  タイトル: Calculated Recovery Adjustment

  読取り専用: true

  現在のペイ・シートで回収される期首残高の一部。
• PrimaryWorkerNumber: string
  タイトル: Worker Number

  読取り専用: true

  最大長: 30

  支払シート金額が支払期日または控除対象である関係者の就業者または従業員番号。 関係者スナップショット作業領域の「参加者の選択」ページおよび「参加者詳細の管理」ページを使用して、就業者番号をレビューします。
• RecEarningAdjustment: number
  タイトル: Recoverable Adjustment

  読取り専用: true

  調整済金額が後続の支払シートで回収される予定の支払シート支払プラン調整の合計です。
• SrpCompensationPlanId: integer
  読取り専用: true

  将来使用するために予約されています。
• TotalAmountHomeCurrency: number
  タイトル: Total Amount in Home Currency

  読取り専用: true

  参加者のホーム通貨での支払シート支払金額。
• TotalAmountPayToHomeCnvrt: number
  タイトル: Calculated Total Currency Conversion Rate

  読取り専用: true

  参加者のホーム通貨での合計支払金額および処理通貨での合計支払金額に基づく計算済換算レート。 ペイ・シートの合計金額には為替レートが同じでない複数の期間が含まれている可能性があるため、これは混合通貨レートである可能性があります。

{
    "type":"object",
    "properties":{
        "TotalAmountPayToHomeCnvrt":{
            "title":"Calculated Total Currency Conversion Rate",
            "type":"number",
            "description":"The calculated exchange rate based on the total payment amount in participant's home currency and total payment amount in processing currency. This could be a blended currency rate since the total amount in a paysheet could include multiple periods where the exchange rates may not be the same.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "paymentTransactions":{
            "title":"Payment Transactions",
            "type":"array",
            "description":"The payment transactions resource is used to view, create, update, and delete participant payment transactions. A payment transaction can be the calculated earnings from an incentive compensation plan component, a manual adjustment, a recovered amount, or a payment plan draw and recovery adjustment. The payment transaction resource is also used to manage payment transaction holds and manual adjustments for paysheets with a status of unpaid.",
            "items":{
                "$ref":"#/components/schemas/paymentBatches-paysheets-paymentTransactions-item-response"
            }
        },
        "CalculatedEarnings":{
            "title":"Calculated Amount",
            "type":"number",
            "description":"The sum of unadjusted calculated earnings for the paysheet.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgName":{
            "title":"Business Unit",
            "maxLength":960,
            "type":"string",
            "description":"The name of the business unit to which the paysheet belongs.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Participant Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the incentive compensation participant for whom the paysheet amount is due or recoverable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecEarningAdjustment":{
            "title":"Recoverable Adjustment",
            "type":"number",
            "description":"The sum of paysheet payment plan adjustments where the adjusted amount is expected to be recovered on a subsequent paysheet.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "title":"Participant Identifier",
            "type":"integer",
            "description":"The unique identifier of the incentive compensation participant for whom the paysheet amount is due or recoverable. Review the participant identifier for a participant using the Participant Snapshot work area, Select Participant page.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PayGroupId":{
            "type":"integer",
            "description":"The unique identifier of the pay group which was used by the paysheet payment batch to select the incentive compensation participants for payment.",
            "format":"int64",
            "nullable":false,
            "readOnly":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"
            }
        },
        "PaysheetDeleteFlag":{
            "type":"boolean",
            "description":"The access indicator to inform which standard actions are not applicable. Here we cannot use the DELETE standard action for paysheets.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "PayrunName":{
            "title":"Payment Batch",
            "maxLength":80,
            "type":"string",
            "description":"The name of the payment batch to which the paysheet belongs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the paysheet record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"The generated identifier for the participant person record in Global Human Resources for the participant for whom the paysheet amount is due or recoverable. Review the participant person number using the Participant Snapshot work area, Select Participant page and the Manage Participant Detail page.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaysheetId":{
            "type":"integer",
            "description":"The unique identifier of the paysheet.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaymentTotalAmount":{
            "title":"Total Amount",
            "type":"number",
            "description":"The paysheet payment amount in the processing currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentDate":{
            "title":"Payment Date",
            "type":"string",
            "description":"The paysheet, payment batch pay date. The payment batch creation process selected all unpaid earnings to include in the paysheet where the earning event dates were on or earlier than the pay date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "NonRecEarningAdjustment":{
            "title":"Waived Amount",
            "type":"number",
            "description":"Reserved for future use.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PmtAmountRecovery":{
            "title":"Calculated Recovery Adjustment",
            "type":"number",
            "description":"The portion of the beginning balance which is recovered in the current paysheet.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodId":{
            "title":"Incentive Compensation Calendar Period",
            "type":"integer",
            "description":"The period number representing the calendar period the paysheet is for. The period numbers are generated when you define your incentive compensation calendar using the Setup and Maintenance work area, Manage Calendars task. For example, the period number 2015001 represents the first period in the year 2015.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TotalAmountHomeCurrency":{
            "title":"Total Amount in Home Currency",
            "type":"number",
            "description":"The paysheet payment amount in the participant's home currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayrunId":{
            "type":"integer",
            "description":"The unique identifier of the payment batch to which the paysheet belongs.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryWorkerNumber":{
            "title":"Worker Number",
            "maxLength":30,
            "type":"string",
            "description":"The worker, or employee, number for the participant for whom the paysheet amount is due or recoverable. Review the worker number using the Participant Snapshot work area, Select Participant page and the Manage Participant Detail page.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the participant incentive compensation plan component associated with the participant calculated earnings and paysheet adjustments.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaysheetUpdateFlag":{
            "type":"boolean",
            "description":"The access indicator to inform which standard actions are not applicable. Here we cannot use the UPDATE standard action until the summary paysheet status value is paid. Only the summary paysheet can be updated. Individual plan component paysheets can't be updated.",
            "nullable":true,
            "readOnly":true,
            "default":false,
            "x-queryable":true
        },
        "PayGroupName":{
            "title":"Pay Group",
            "maxLength":80,
            "type":"string",
            "description":"The name of the pay group which was used by the paysheet payment batch to select the incentive compensation participants for payment. Review pay groups using the Participant Assignments work area, Manage Pay Groups task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PaysheetStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The lookup code that represents the current paysheet status, such as unpaid, submitted, and approved. Review available lookup codes for the lookup type CN_PAYSHEET_STATUS using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit to which the paysheet 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,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PayCurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The code indicating the processing currency. The processing currency is selected as either the operating currency or the participant home currency for the business unit. Review the processing currency parameter using the Setup and Maintenance work area, Manage Parameters task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the party in the trading community. The party is the participant for whom the paysheet amount is due or recoverable. Review the party number for a participant using the Participant Snapshot work area, Select Participant page and the Manage Participant Detail page.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party Identifier",
            "type":"integer",
            "description":"The unique identifier of the party in the trading community. The party is the participant for whom the paysheet amount is due or recoverable. Review the party identifier for a participant using the Participant Snapshot work area, Select Participant page.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaymentAdjustmentAmount":{
            "title":"Payment Amount",
            "type":"number",
            "description":"The sum of both adjusted and unadjusted payment transactions.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChequeNumber":{
            "title":"Payment Reference Number",
            "maxLength":400,
            "type":"string",
            "description":"The reference number that acknowledges the actual payment made by the paying systems.",
            "nullable":true,
            "x-queryable":true
        },
        "PaymentMethod":{
            "title":"Payment Method",
            "maxLength":30,
            "type":"string",
            "description":"The acknowledged method of payment, such as electronic funds transfer or a check, from a paying system, such as payables or payroll.",
            "nullable":true,
            "x-queryable":true
        },
        "BeginningBalanceAmount":{
            "title":"Beginning Balance",
            "type":"number",
            "description":"Reserved for future use.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningDifference":{
            "title":"Earning Difference",
            "type":"number",
            "description":"The difference between the sum of unadjusted calculated earnings and the actual amount to be paid after adjustments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PeriodName":{
            "title":"Period Name",
            "maxLength":30,
            "type":"string",
            "description":"The name of the calendar period the paysheet, payment batch is for. The period name is entered when defining the incentive compensation calendar. For example, Jan-2015 or Q1-2015. You can review and manage period names using the Setup and Maintenance work area, Manage Calendars task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentName":{
            "title":"Plan Component",
            "maxLength":80,
            "type":"string",
            "description":"The name of the incentive compensation plan component.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SrpCompensationPlanId":{
            "type":"integer",
            "description":"Reserved for future use.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated By",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the paysheet record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the paysheet was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PayPeriodId":{
            "title":"Period",
            "type":"integer",
            "description":"The period number representing the calendar period the paysheet, payment batch is for. The period numbers are generated when you define your incentive compensation calendar using the Setup and Maintenance work area, Manage Calendars task. For example, the period number 2015001 represents the first period in the year 2015.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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 Transactions

支払トランザクション・リソースは、参加者支払トランザクションの表示、作成、更新および削除に使用されます。 支払トランザクションは、インセンティブ報酬プラン・コンポーネントからの計算済支給、手動調整、回収済金額、または支払プラン前払金および回収調整です。 支払トランザクション・リソースは、支払トランザクション保留および未払ステータスの支払シートの手動調整の管理にも使用されます。

ソースを表示

• Array of: object paymentBatches-paysheets-paymentTransactions-item-response

{
    "title":"Payment Transactions",
    "type":"array",
    "description":"The payment transactions resource is used to view, create, update, and delete participant payment transactions. A payment transaction can be the calculated earnings from an incentive compensation plan component, a manual adjustment, a recovered amount, or a payment plan draw and recovery adjustment. The payment transaction resource is also used to manage payment transaction holds and manual adjustments for paysheets with a status of unpaid.",
    "items":{
        "$ref":"#/components/schemas/paymentBatches-paysheets-paymentTransactions-item-response"
    }
}

ネストされたスキーマ : paymentBatches-paysheets-paymentTransactions-item-response

タイプ: object

ソースを表示

• AdjustComments: string
  タイトル: Comment

  最大長: 1000

  支払トランザクション金額の修正時に入力された注釈。
• CommAmountCalculationCurrency: number
  タイトル: Earning Amount

  読取り専用: true

  処理通貨での計算済支給額。
• CommissionValue: number
  タイトル: Earning Rate

  読取り専用: true

  支給額の計算に使用されたインセンティブ・レート表金額またはレート。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  支払トランザクション・レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  支払トランザクションが作成された日付。
• CreditedParticipantId: integer (int64)
  タイトル: Credit Receiver

  ソース・トランザクションのクレジットを受け取ったインセンティブ報酬関係者の一意の識別子です。 参加者スナップショット作業領域の「参加者の選択」ページを使用して、参加者の参加者識別子をレビューします。
• CreditFactor: number
  タイトル: Credit Factor

  読取り専用: true

  支給計算式で使用された期間のクレジット金額の増加に対するアップ・リフト率。
• CreditTypeId: integer (int64)
  読取り専用: true

  デフォルト値: -1000

  支給タイプの一意の識別子です。 支給タイプはプラン・コンポーネントで選択され、支給を金額および非通貨カテゴリに分類するために使用されます。 Oracleが提供する通貨支給タイプのみを支払処理に含めることができます。
• EarningFactor: number
  タイトル: Earning Factor

  読取り専用: true

  支給計算式で使用された一定期間にわたる支給の増加に対するアップ・リフト率。
• EarningHId: integer (int64)
  読取り専用: true

  支給履歴レコードの一意の識別子です。 支給レコードへの変更は、支給履歴表に保存されています。
• EarningId: integer (int64)
  タイトル: Earnings

  読取り専用: true

  支給レコードの一意の識別子です。 支給項目は、参加者プラン・コンポーネントおよびソース・トランザクション・クレジットに基づいて計算されたインセンティブ金額です。
• EarningType: string
  タイトル: Earning Type

  読取り専用: true

  最大長: 30

  支給のタイプ。 支給タイプはプラン・コンポーネントで選択され、支給を金額および非通貨カテゴリに分類するために使用されます。 支払処理には、支給タイプが通貨の支給のみが含まれます。
• EligibleCatId: integer (int64)
  読取り専用: true

  インセンティブ・クレジットに割り当てられたクレジット・カテゴリの一意の識別子。 クレジット・カテゴリは、パフォーマンス測定および支給計算のためにクレジットを分類してから、参加者プラン・コンポーネントとクレジットを照合するために使用されました。
• HoldFlag: boolean
  タイトル: Payment Hold

  最大長: 1

  デフォルト値: false

  保留が明示的に解除されるまで支払トランザクションを保留するかどうかを示します。 値がYの場合、支払トランザクションは保留になります。 デフォルト値は「Y」です。
• HomeCurrencyCode: string
  タイトル: Home Currency

  最大長: 15

  支払トランザクションのソース・イベント日の時点で有効な参加者ホーム通貨を示すコード。 関係者スナップショット作業領域の「参加者詳細の管理」ページを使用して、有効な関係者属性をレビューします。
• IncentiveTypeCode: string
  タイトル: Payment Type

  最大長: 30

  デフォルト値: MANUAL_PAY_ADJ

  賞与、支払プラン調整、手動調整など、支払トランザクション・タイプのカテゴリを表すコード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照CN_PAYMENT_ADJUSTMENT_TYPEに使用可能なコードをレビューします。
• LastUpdateDate: string (date-time)
  タイトル: Last Update Date

  読取り専用: true

  支払トランザクションが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  支払トランザクション・レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 32

  支払トランザクション・レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
• links: array Links
  タイトル: Links

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

  最大長: 30

  支払シート手動調整の事由を表すコード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照ORA_CN_PAYSHEET_MANUAL_ADJに使用可能なコードをレビューします。
• ObjectStatus: string
  タイトル: Status

  読取り専用: true

  最大長: 30

  支払トランザクションのステータス。 有効な値は、UNPAIDとPAIDです。
• OrgId: integer (int64)
  タイトル: Business Unit

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

  読取り専用: true

  支払トランザクション金額の支払期日または控除対象であるインセンティブ報酬関係者の一意の識別子。 参加者スナップショット作業領域の「参加者の選択」ページを使用して、参加者の参加者識別子をレビューします。
• ParticipantName: string
  タイトル: Participant Name

  読取り専用: true

  最大長: 360

  支払トランザクション金額の支払期日または控除対象となるインセンティブ報酬参加者の名前。
• ParticipantPayId: integer (int64)
  支払トランザクションの一意の識別子。
• PayAmountFuncCurrency: number
  タイトル: Operating Payment Amount

  読取り専用: true

  営業通貨での支払トランザクション金額。
• PayAmountHomeCurrency: number
  タイトル: Home Payment Amount

  参加者ホーム通貨での支払トランザクション金額。
• PayAmountPayCurrency: number
  タイトル: Processing Payment Amount

  処理通貨での支払トランザクション金額。 処理通貨は、ビジネス・ユニットの営業通貨または参加者ホーム通貨として選択されます。 「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用して、処理通貨パラメータをレビューします。
• PayCurrencyCode: string
  タイトル: Currency

  読取り専用: true

  最大長: 20

  処理通貨を示すコード。 処理通貨は、ビジネス・ユニットの営業通貨または参加者ホーム通貨として選択されます。 「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用して、処理通貨パラメータをレビューします。
• PaymentTransactionDeleteFlag: boolean
  読取り専用: true

  適用できない標準アクションを通知するためのアクセス・インジケータ。 ここでは、アプリケーションで生成された支払トランザクションに対してDELETE標準処理を使用できません。
• PaymentTransactionUpdateFlag: boolean
  読取り専用: true

  適用できない標準アクションを通知するためのアクセス・インジケータ。 ここでは、支払プランの修正および前の支払シートからの回収済修正にUPDATE標準処理を使用できません。 また、支払シート・ステータスが未払以外のものである場合、更新は許可されません。
• PayPeriodId: integer (int64)
  タイトル: Period

  手動支払シート修正の支払トランザクション支給イベント日または支払バッチ期間の期間を表す期間番号。 期間番号は、「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用してインセンティブ報酬カレンダを定義するときに生成されます。 たとえば、期間番号2015001は、2015年の最初の期間を表します。
• PayrunId: integer (int64)
  この支払トランザクションが属する支払バッチの一意の識別子。
• PayrunName: string
  タイトル: Payment Batch

  読取り専用: true

  最大長: 80

  支払トランザクションが属する支払バッチの名前。
• PersonNumber: string
  タイトル: Person Number

  読取り専用: true

  最大長: 30

  支払トランザクション金額の支払期日または控除対象である参加者のグローバル人事管理で生成された参加者個人レコードの識別子です。 「参加者スナップショット」作業領域、「参加者の選択」ページおよび「参加者詳細の管理」ページを使用して、参加者個人番号をレビューします。
• PlanComponentId: integer (int64)
  参加者支給額の計算に使用される参加者インセンティブ報酬プラン・コンポーネントの一意の識別子です。
• PrimaryWorkerNumber: string
  タイトル: Worker Number

  読取り専用: true

  最大長: 30

  支払トランザクション金額の期日または控除対象である関係者の就業者または従業員番号。 関係者スナップショット作業領域の「参加者の選択」ページおよび「参加者詳細の管理」ページを使用して、就業者番号をレビューします。
• RecoverableFlag: boolean
  タイトル: Recoverable

  最大長: 1

  デフォルト値: true

  支払修正が将来控除可能かどうかを示します。 値がYの場合、支払調整は控除可能です。 デフォルト値は「Y」です。
• SourceEarningId: integer (int64)
  読取り専用: true

  この支給元のソース支給項目の一意識別子です。
• SourceEventDate: 文字列(日付)
  タイトル: Event Date

  読取り専用: true

  支給イベントの日付。 イベント日は、ソース・トランザクション・イベント日または計算グループ化イベント日のいずれかで、インセンティブ支給になりました。
• SourceTrxNumber: string
  タイトル: Transaction Number

  読取り専用: true

  最大長: 30

  参加者インセンティブ支給となったトランザクション番号。
• SrpPlanAssignId: integer (int64)
  読取り専用: true

  参加者への報酬プランの割当の一意の識別子。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the payment transaction was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreditTypeId":{
            "type":"integer",
            "description":"The unique identifier of the earning type. The earning type is selected for the plan component and is used to classify earnings into monetary and nonmonetary categories. You can only include the monetary earning type, provided by Oracle, in payment processing.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "default":-1000,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HomeCurrencyCode":{
            "title":"Home Currency",
            "maxLength":15,
            "type":"string",
            "description":"The code indicating the participant home currency that is in effect as of the source event date of the payment transaction. Review the effective participant attributes using the Participant Snapshot work area, Manage Participant Detail page.",
            "nullable":true,
            "x-queryable":true
        },
        "AdjustComments":{
            "title":"Comment",
            "maxLength":1000,
            "type":"string",
            "description":"Commentary entered when adjusting the payment transaction amount.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Participant Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the incentive compensation participant for whom the payment transaction amount is due or recoverable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningHId":{
            "type":"integer",
            "description":"The unique identifier of the earning history record. The changes to the earning record are stored in the earning history table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectStatus":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the payment transaction. The valid values are UNPAID and PAID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "title":"Participant Identifier",
            "type":"integer",
            "description":"The unique identifier of the incentive compensation participant for whom the payment transaction amount is due or recoverable. Review the participant identifier for a participant using the Participant Snapshot work area, Select Participant page.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantPayId":{
            "type":"integer",
            "description":"The unique identifier of the payment transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PayAmountPayCurrency":{
            "title":"Processing Payment Amount",
            "type":"number",
            "description":"The payment transaction amount in the processing currency. The processing currency is selected as either the operating currency or the participant home currency for the business unit. Review the processing currency parameter using the Setup and Maintenance work area, Manage Parameters task.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IncentiveTypeCode":{
            "title":"Payment Type",
            "maxLength":30,
            "type":"string",
            "description":"The code that represents the categorization of the payment transaction types, such as bonus, payment plan adjustments, and manual adjustments. Review the available codes for lookup CN_PAYMENT_ADJUSTMENT_TYPE using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "default":"MANUAL_PAY_ADJ",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PayrunName":{
            "title":"Payment Batch",
            "maxLength":80,
            "type":"string",
            "description":"The name of the payment batch to which the payment transaction belongs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningId":{
            "title":"Earnings",
            "type":"integer",
            "description":"The unique identifier of the earning record. An earning is the calculated incentive amount based on the participant plan component and source transaction credit.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the payment transaction record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNumber":{
            "title":"Person Number",
            "maxLength":30,
            "type":"string",
            "description":"The generated identifier for the participant person record in Global Human Resources for the participant for whom the payment transaction amount is due or recoverable. Review the participant person number using the Participant Snapshot work area, Select Participant page and the Manage Participant Detail page.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommAmountCalculationCurrency":{
            "title":"Earning Amount",
            "type":"number",
            "description":"The calculated earning amount in the processing currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the payment transaction record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EligibleCatId":{
            "type":"integer",
            "description":"The unique identifier of the credit category assigned the incentive credit. The credit category was used to classify the credit and then match the credit to the participant plan component for performance measurement and earning calculation.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RecoverableFlag":{
            "title":"Recoverable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the payment adjustment is recoverable in the future. If the value is Y, then the payment adjustment is recoverable. The default value is Y.",
            "nullable":true,
            "default":true,
            "x-queryable":true
        },
        "SrpPlanAssignId":{
            "type":"integer",
            "description":"The unique identifier of the assignment of the compensation plan to the participant.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PaymentTransactionDeleteFlag":{
            "type":"boolean",
            "description":"The access indicator to inform which standard actions are not applicable. Here we cannot use the DELETE standard action for payment transactions generated by the application.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PayAmountFuncCurrency":{
            "title":"Operating Payment Amount",
            "type":"number",
            "description":"The payment transaction amount in the operating currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayrunId":{
            "type":"integer",
            "description":"The unique identifier of the payment batch to which this payment transaction belongs.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceEventDate":{
            "title":"Event Date",
            "type":"string",
            "description":"The date of the earning event. The event date is either the source transaction event date or the calculation grouping event date which resulted in the incentive earning.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningFactor":{
            "title":"Earning Factor",
            "type":"number",
            "description":"The uplift percentage for the increase in earnings over a period of time that was used in the earning calculation expression.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EarningType":{
            "title":"Earning Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the earning. The earning type is selected for the plan component and is used to classify earnings into monetary and nonmonetary categories. Only earnings with the monetary earning type are included in payment processing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryWorkerNumber":{
            "title":"Worker Number",
            "maxLength":30,
            "type":"string",
            "description":"The worker, or employee, number for the participant for whom the payment transaction amount is due or recoverable. Review the worker number using the Participant Snapshot work area, Select Participant page and the Manage Participant Detail page.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PlanComponentId":{
            "type":"integer",
            "description":"The unique identifier of the participant incentive compensation plan component used to calculate the participant earning amount.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "CreditedParticipantId",
                    "PayrunId"
                ]
            },
            "x-queryable":true
        },
        "ManualAdjustmentReasonCode":{
            "title":"Reason",
            "maxLength":30,
            "type":"string",
            "description":"The code that represents the reason for the paysheet manual adjustment. Review the available codes for lookup ORA_CN_PAYSHEET_MANUAL_ADJ using the Setup and Maintenance, Manage Incentive Compensation Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PayCurrencyCode":{
            "title":"Currency",
            "maxLength":20,
            "type":"string",
            "description":"The code indicating the processing currency. The processing currency is selected as either the operating currency or the participant home currency for the business unit. Review the processing currency parameter using the Setup and Maintenance work area, Manage Parameters task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrgId":{
            "title":"Business Unit",
            "type":"integer",
            "description":"The unique identifier of the business unit to which the payment transaction 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
        },
        "SourceTrxNumber":{
            "title":"Transaction Number",
            "maxLength":30,
            "type":"string",
            "description":"The transaction number which resulted in the participant incentive earning.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayAmountHomeCurrency":{
            "title":"Home Payment Amount",
            "type":"number",
            "description":"The payment transaction amount in the participant home currency.",
            "nullable":true,
            "x-queryable":true
        },
        "CreditedParticipantId":{
            "title":"Credit Receiver",
            "type":"integer",
            "description":"The unique identifier of the incentive compensation participant who received credit for the source transaction. Review the participant identifier for a participant using the Participant Snapshot work area, Select Participant page.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceEarningId":{
            "type":"integer",
            "description":"The unique identifier of the source earning from which this earning originated.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreditFactor":{
            "title":"Credit Factor",
            "type":"number",
            "description":"The uplift percentage for the increase in credit amounts over a period of time that was used in the earning calculation expression.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PaymentTransactionUpdateFlag":{
            "type":"boolean",
            "description":"The access indicator to inform which standard actions are not applicable. Here we cannot use the UPDATE standard action for payment plan adjustments and recovered adjustments from previous paysheets. Additionally, no updates are allowed when the paysheet status is something other than unpaid.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CommissionValue":{
            "title":"Earning Rate",
            "type":"number",
            "description":"The incentive rate table amount or rate that was used to calculate the earning amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HoldFlag":{
            "title":"Payment Hold",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether to hold a payment transaction until the hold is explicitly released. If the value is Y, then the payment transaction is on hold. The default value is Y.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the payment transaction was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Updated By",
            "maxLength":32,
            "type":"string",
            "description":"The session login associated to the user who last updated the payment transaction record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayPeriodId":{
            "title":"Period",
            "type":"integer",
            "description":"The period number representing the period of the payment transaction earning event date or the payment batch period for the manual paysheet adjustment. The period numbers are generated when you define your incentive compensation calendar using the Setup and Maintenance work area, Manage Calendars task. For example, the period number 2015001 represents the first period in the year 2015.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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"
    }
}

リンク

BusinessUnitsVO

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationBusinessUnitsLOV

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: OrgId;ターゲット属性: OrganizationId
• 表示属性: 名前

EarningsCalculatedByVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: EarningsCalculatedBy;ターゲット属性: LookupCode
• 表示属性: 意味

PayPeriodIdVO

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationPeriodsLOV

パラメータ:

• ファインダ: OpenPeriodsFinder%3Bb_end_date%3D{EndDate}%2Cb_org_id%3D{OrgId}%2Cb_start_date%3D{StartDate}

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: PayPeriodId;ターゲット属性: PeriodId
• 表示属性: PeriodName, PeriodId

PaygroupsVO

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationEligiblePayGroupsLOV

パラメータ:

• ファインダ: ValidPaygroupFinder%3Bb_org_id%3D{OrgId}

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: PayGroupId;ターゲット属性: PayGroupId
• 表示属性: OrgId, PayGroupId, PayGroupName

ReportGroupVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

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

LOVリンク関連では、次のプロパティが定義されます:

• ソース属性: ReportGroup;ターゲット属性: LookupCode
• 表示属性: 意味

paymentTransactions

操作: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paymentTransactions

パラメータ:

• PayrunId: $request.path.PayrunId

支払トランザクション・リソースは、参加者支払トランザクションの表示、作成、更新および削除に使用されます。 支払トランザクションは、インセンティブ報酬プラン・コンポーネントからの計算済支給、手動調整、回収済金額、または支払プラン前払金および回収調整です。 支払トランザクション・リソースは、支払トランザクション保留および未払ステータスの支払シートの手動調整の管理にも使用されます。

支払シート

操作: /fscmRestApi/resources/11.13.18.05/paymentBatches/{PayrunId}/child/paysheets

パラメータ:

• PayrunId: $request.path.PayrunId

支払シート・リソースは、参加者の支払シートを表示および更新するために使用されます。 支払バッチでは、支払バッチ基準を満たす各インセンティブ報酬参加者の支払シートが生成されます。 個々の支払シートはプラン・コンポーネントごとに生成され、すべてのプラン・コンポーネントに対して要約支払シートが生成されます。

「トップに戻る」