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

機械翻訳について

手動調整の作成

post

/fscmRestApi/resources/11.13.18.05/paymentTransactions

リクエスト

ヘッダー・パラメータ

Metadata-Context:

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

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

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

application/json

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

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

タイプ: 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のデフォルト・バージョンを選択します。

ルート・スキーマ : 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":"Indicates whether certain standard actions are not applicable. You 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":"Indicates whether certain standard actions are not applicable. You 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"
    }
}

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

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

リンク

BusinessUnitPVO

操作: /fscmRestApi/resources/11.13.18.05/incentiveCompensationBusinessUnitsLOV

ビジネス・ユニットの一意の識別子を含む値リスト。

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

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

CnLookupManualAdjustmentReasonCodeVO

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_CN_PAYSHEET_MANUAL_ADJ

手動修正事由の値リスト。

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

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

ParticipantPlanComponentsVO

操作: /fscmRestApi/resources/11.13.18.05/paybatchParticipantPlanComponentsLOV

パラメータ:

ファインダ: PlanComponentFinder%3Bb_participant_id%3D{CreditedParticipantId}%2Cb_payrun_id%3D{PayrunId}

プラン・コンポーネント名および一意の識別子を含む値リスト。

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

ソース属性: PlanComponentId;ターゲット属性: PlanComponentId
表示属性: PlanComponentId, PlanComponentName, PayrunId, ParticipantId

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行して、支払トランザクションを作成する方法を示しています。

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

リクエスト本文の例

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

{
"AdjustComments" :"LN1",
"ManualAdjustmentReasonCode" :"ORA_DISCRETIONARY_DRAW",
"PlanComponentId" :300100003303012,
"PayAmountPayCurrency" :111,
"PayrunId": 300100014485210,
"RecoverableFlag" :"Y"
}

レスポンス本文の例

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

{
    "items": [
        {
            "AdjustComments": null,
            "ParticipantPayId": 6118,
            "CommAmountCalculationCurrency": 3200,
            "CreatedBy": "27AB6EB0D7709DCAB38FB2F43B7785DE",
            "CreationDate": "2012-12-24T07:00:55+00:00",
            "CommissionValue": 4000,
            "CreditTypeId": -1000,
            "CreditedParticipantId": 12001,
            "EarningId": 47041,
            "HoldFlag": null,
            "HomeCurrencyCode": "USD",
            "IncentiveTypeCode": "COMMISSION",
            "LastUpdateDate": "2012-12-24T07:02:57+00:00",
            "LastUpdateLogin": "D19A1F1889A55198E0432720F00AE307",
            "LastUpdatedBy": "OIC_MGR_OPERATIONS",
            "ObjectStatus": "PAID",
            "OrgId": 204,
            "PayAmountFuncCurrency": 3200,
            "PayAmountHomeCurrency": 3200,
            "PayAmountPayCurrency": 3200,
            "PayCurrencyCode": "USD",
            "PayPeriodId": 2009001,
            "PayrunId": 300100014485210,
            "PlanComponentId": 300100014486100,
            "RecoverableFlag": false,
            "SourceEventDate": "2009-01-10",
            "SourceTrxNumber": null,
            "SrpPlanAssignId": 33006,
            "SourceEarningId": null,
            "CreditFactor": null,
            "EarningFactor": null,
            "EarningType": "BASE",
            "EligibleCatId": 300100014485986,
            "EarningHId": 13021,
            "PayrunName": "CN Pay BatchJan09_20121224131422",
            "ParticipantName": "IC_PARTY_20121224131422",
            "ParticipantId": 12001,
            "PersonNumber": null,
            "PrimaryWorkerNumber": null,
            "ManualAdjustmentReasonCode": null,
            "PaymentTransactionUpdateFlag": false,
            "PaymentTransactionDeleteFlag": false,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentTransactions/6118",
                    "name": "paymentTransactions",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentTransactions/6118",
                    "name": "paymentTransactions",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentTransactions/6118/lov/ParticipantPlanComponentsVO",
                    "name": "ParticipantPlanComponentsVO",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentTransactions/6118/lov/BusinessUnitPVO",
                    "name": "BusinessUnitPVO",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentTransactions/6118/lov/CnLookupManualAdjustmentReasonCodeVO",
                    "name": "CnLookupManualAdjustmentReasonCodeVO",
                    "kind": "collection"
                }
            ]
        },
        {
            "AdjustComments": null,
            "ParticipantPayId": 6119,
            "CommAmountCalculationCurrency": 3200,
            "CreatedBy": "27AB6EB0D7709DCAB38FB2F43B7785DE",
            "CreationDate": "2012-12-24T07:00:55+00:00",
            "CommissionValue": 4000,
            "CreditTypeId": -1000,
            "CreditedParticipantId": 12001,
            "EarningId": 47042,
            "HoldFlag": null,
            "HomeCurrencyCode": "USD",
            "IncentiveTypeCode": "COMMISSION",
            "LastUpdateDate": "2012-12-24T07:02:57+00:00",
            "LastUpdateLogin": "D19A1F1889A55198E0432720F00AE307",
            "LastUpdatedBy": "OIC_MGR_OPERATIONS",
            "ObjectStatus": "PAID",
            "OrgId": 204,
            "PayAmountFuncCurrency": 3200,
            "PayAmountHomeCurrency": 3200,
            "PayAmountPayCurrency": 3200,
            "PayCurrencyCode": "USD",
            "PayPeriodId": 2009001,
            "PayrunId": 300100014485210,
            "PlanComponentId": 300100014486100,
            "RecoverableFlag": false,
            "SourceEventDate": "2009-01-10",
            "SourceTrxNumber": null,
            "SrpPlanAssignId": 33006,
            "SourceEarningId": null,
            "CreditFactor": null,
            "EarningFactor": null,
            "EarningType": "BASE",
            "EligibleCatId": 300100014485986,
            "EarningHId": 13016,
            "PayrunName": "CN Pay BatchJan09_20121224131422",
            "ParticipantName": "IC_PARTY_20121224131422",
            "ParticipantId": 12001,
            "PersonNumber": null,
            "PrimaryWorkerNumber": null,
            "ManualAdjustmentReasonCode": null,
            "PaymentTransactionUpdateFlag": false,
            "PaymentTransactionDeleteFlag": false,
            "links": [
...
}

「トップに戻る」