機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 支払バッチ

すべての支払バッチの取得

get

/fscmRestApi/resources/11.13.18.05/paymentBatches

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
  • このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。

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

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

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

    使用可能なファインダ名および対応するファインダ変数を次に示します:

    • FindPaymentBatches : 指定した値を持つ支払バッチを検索します。
      ファインダ変数:
      • businessUnit; string;支払バッチが属するビジネス・ユニットの名前。
      • payGroupName; string;支払に対するインセンティブ報酬参加者を選択するために支払シート支払バッチで使用された支払グループの名前。 参加者割当作業領域の支払グループの管理タスクを使用して、支払グループをレビューします。
      • payPeriod; string;支払バッチの対象となるカレンダ期間の名前。 期間名は、インセンティブ報酬カレンダの定義時に入力されます。 たとえば、Jan-2015やQ1-2015などです。 期間名は、「設定およびメンテナンス」作業領域のカレンダの管理タスクを使用してレビューおよび管理できます。
      • payrunName; string;支払シートが属する支払バッチの名前。
      • ステータス;文字列;未払、確定済、支払済など、現在の支払バッチ・ステータスを表すコード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照CN_PAYRUN_STATUSに使用可能なコードをレビューします。
    • PrimaryKey : 指定した主キーを持つ支払バッチを検索します。
      ファインダ変数:
      • PayrunId; integer; 支払バッチの一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>

    例:
    self,canonical
  • リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
  • リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
  • このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
  • この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY

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

    次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
    • CreatedBy; string;
    • CreationDate; string; 支払バッチが作成された日付。
    • EarningsCalculatedBy;文字列;プラン・コンポーネント計算インセンティブ値を使用して適格支給をフィルタするために使用する支払バッチ選択基準。 指定可能な値は、COMMISSION (イベントごと)、BONUS (間隔ごと)およびALL (両方)です。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照CN_PAYMENT_INCENTIVE_TYPEに使用可能なコードをレビューします。
    • IncentiveTypeCode; string;将来の使用のために予約されています。
    • LastUpdateDate; string; 支払バッチが最後に更新された日付。
    • LastUpdateLogin; string; 支払バッチ・レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
    • LastUpdatedBy; string; 支払バッチ・レコードを最後に更新したユーザー。
    • OrgId; integer; 支払バッチが属するビジネス・ユニットの一意の識別子。 「設定およびメンテナンス」>「ビジネス・ユニットの定義」タスクを使用して、ビジネス・ユニットのビジネス・ユニットIDをレビューします。 Business Unit ID(ビジネス・ユニットID)列が表示されない場合は、View(表示)メニューをクリックしてBusiness Unit ID(ビジネス・ユニットID)列を追加します。
    • OrgName; string; 支払バッチが属するビジネス・ユニットの名前。
    • PayGroupId; integer;支払グループの一意の識別子。支払に対するインセンティブ報酬参加者の選択に使用されます。
    • PayGroupName; string;支払に対するインセンティブ報酬参加者を選択するために支払シート支払バッチで使用された支払グループの名前。 参加者割当作業領域の支払グループの管理タスクを使用して、支払グループをレビューします。
    • PayPeriodId; integer; 支払バッチを使用するカレンダ期間を表す期間番号。 期間番号は、「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用してインセンティブ報酬カレンダを定義するときに生成されます。 たとえば、期間番号2019001は、2019年の最初の期間を表します。
    • PaymentDate; string;支払バッチ支払日。 支払バッチ作成プロセスでは、支給イベント日が支給日以前になっている支払シートに含める未払支給が全て選択されます。
    • PayrunId; integer; 支払バッチの一意の識別子。
    • PayrunName; string;支払バッチ名。
    • PeriodName; string; 支払バッチを使用するカレンダ期間の名前。 期間名は、インセンティブ報酬カレンダの定義時に入力されます。 「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用して、期間名をレビューおよび管理します。
    • ReportGroup;文字列。賞与やコミッションなどのプラン・コンポーネント・インセンティブ・タイプを使用して適格な支給をフィルタするために使用する支払バッチ選択基準。 指定可能な値には、BONUS、COMMISSIONおよびSTANDARDがあります。 許容可能な値のリストは、参照CN_REPORT_GROUPで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
    • RequestId; integer; 支払バッチの支払シートを生成するために発行されるプロセスの一意の識別子。
    • ステータス;文字列。未払、確定済、支払済など、現在の支払バッチ・ステータスを表すコード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照CN_PAYRUN_STATUSに使用可能なコードをレビューします。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : paymentBatches
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : paymentBatches-item-response
タイプ: object
ソースを表示
  • タイトル: Created By
    読取り専用: true
    最大長: 64
  • タイトル: Creation Date
    読取り専用: true
    支払バッチが作成された日付。
  • タイトル: Incentive Type
    最大長: 30
    デフォルト値: ALL
    プラン・コンポーネント計算インセンティブ値を使用して適格支給をフィルタするために使用する支払バッチ選択基準。 指定可能な値は、COMMISSION (イベントごと)、BONUS (間隔ごと)およびALL (両方)です。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照CN_PAYMENT_INCENTIVE_TYPEに使用可能なコードをレビューします。
  • タイトル: Payment Type
    最大長: 30
    デフォルト値: ALL
    将来使用するために予約されています。
  • タイトル: Last Update Date
    読取り専用: true
    支払バッチが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    支払バッチ・レコードを最後に更新したユーザー。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 32
    支払バッチ・レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
  • Links
  • タイトル: Business Unit
    支払バッチが属するビジネス・ユニットの一意の識別子。 「設定およびメンテナンス」>「ビジネス・ユニットの定義」タスクを使用して、ビジネス・ユニットのビジネス・ユニットIDをレビューします。 Business Unit ID(ビジネス・ユニットID)列が表示されない場合は、View(表示)メニューをクリックしてBusiness Unit ID(ビジネス・ユニットID)列を追加します。
  • タイトル: Business Unit
    読取り専用: true
    最大長: 960
    支払バッチが属するビジネス・ユニットの名前。
  • 支払に対するインセンティブ報酬参加者の選択に使用される支払グループの一意の識別子。
  • タイトル: Pay Group
    読取り専用: true
    最大長: 80
    支払に対するインセンティブ報酬参加者を選択するために支払シート支払バッチで使用された支払グループの名前。 参加者割当作業領域の支払グループの管理タスクを使用して、支払グループをレビューします。
  • タイトル: Pay Date
    支払バッチ支払日。 支払バッチ作成プロセスでは、支給イベント日が支給日以前になっている支払シートに含める未払支給が全て選択されます。
  • Payment Transactions
    タイトル: Payment Transactions
    支払トランザクション・リソースは、参加者支払トランザクションの表示、作成、更新および削除に使用されます。 支払トランザクションは、インセンティブ報酬プラン・コンポーネントからの計算済支給、手動調整、回収済金額、または支払プラン前払金および回収調整です。 支払トランザクション・リソースは、支払トランザクション保留および未払ステータスの支払シートの手動調整の管理にも使用されます。
  • タイトル: Period
    支払バッチの対象となるカレンダ期間を表す期間番号。 期間番号は、「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用してインセンティブ報酬カレンダを定義するときに生成されます。 たとえば、期間番号2019001は、2019年の最初の期間を表します。
  • 支払バッチの一意の識別子。
  • タイトル: Payment Batch
    最大長: 80
    支払バッチ名。
  • Paysheets
    タイトル: Paysheets
    支払シート・リソースは、参加者の支払シートを表示および更新するために使用されます。 支払バッチでは、支払バッチ基準を満たす各インセンティブ報酬参加者の支払シートが生成されます。 個々の支払シートはプラン・コンポーネントごとに生成され、すべてのプラン・コンポーネントに対して要約支払シートが生成されます。
  • タイトル: Period Name
    読取り専用: true
    最大長: 30
    支払バッチを使用するカレンダ期間の名前。 期間名は、インセンティブ報酬カレンダの定義時に入力されます。 「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用して、期間名をレビューおよび管理します。
  • タイトル: Incentive Type
    最大長: 30
    賞与やコミッションなど、プラン・コンポーネント・インセンティブ・タイプを使用して適格な支給をフィルタするために使用する支払バッチ選択基準。 指定可能な値には、BONUS、COMMISSIONおよびSTANDARDがあります。 許容可能な値のリストは、参照CN_REPORT_GROUPで定義されます。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、この属性の値をレビューおよび更新します。
  • 支払バッチの支払シートを生成するために発行されるプロセスの一意の識別子。
  • タイトル: Status
    読取り専用: true
    最大長: 30
    デフォルト値: UNPAID
    未払、確定済、支払済など、現在の支払バッチ・ステータスを表すコード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照CN_PAYRUN_STATUSに使用可能なコードをレビューします。
ネストされたスキーマ : 支払トランザクション
タイプ: array
タイトル: Payment Transactions
支払トランザクション・リソースは、参加者支払トランザクションの表示、作成、更新および削除に使用されます。 支払トランザクションは、インセンティブ報酬プラン・コンポーネントからの計算済支給、手動調整、回収済金額、または支払プラン前払金および回収調整です。 支払トランザクション・リソースは、支払トランザクション保留および未払ステータスの支払シートの手動調整の管理にも使用されます。
ソースを表示
ネストされたスキーマ : 支払シート
タイプ: array
タイトル: Paysheets
支払シート・リソースは、参加者の支払シートを表示および更新するために使用されます。 支払バッチでは、支払バッチ基準を満たす各インセンティブ報酬参加者の支払シートが生成されます。 個々の支払シートはプラン・コンポーネントごとに生成され、すべてのプラン・コンポーネントに対して要約支払シートが生成されます。
ソースを表示
ネストされたスキーマ : paymentBatches-paymentTransactions-item-response
タイプ: object
ソースを表示
  • タイトル: Comment
    最大長: 1000
    支払トランザクション金額の修正時に入力された注釈。
  • タイトル: Earning Amount
    読取り専用: true
    処理通貨での計算済支給額。
  • タイトル: Earning Rate
    読取り専用: true
    支給額の計算に使用されたインセンティブ・レート表金額またはレート。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    支払トランザクション・レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    支払トランザクションが作成された日付。
  • タイトル: Credit Receiver
    ソース・トランザクションのクレジットを受け取ったインセンティブ報酬関係者の一意の識別子です。 参加者スナップショット作業領域の「参加者の選択」ページを使用して、参加者の参加者識別子をレビューします。
  • タイトル: Credit Factor
    読取り専用: true
    支給計算式で使用された期間のクレジット金額の増加に対するアップ・リフト率。
  • 読取り専用: true
    デフォルト値: -1000
    支給タイプの一意の識別子です。 支給タイプはプラン・コンポーネントで選択され、支給を金額および非通貨カテゴリに分類するために使用されます。 Oracleが提供する通貨支給タイプのみを支払処理に含めることができます。
  • タイトル: Earning Factor
    読取り専用: true
    支給計算式で使用された一定期間にわたる支給の増加に対するアップ・リフト率。
  • 読取り専用: true
    支給履歴レコードの一意の識別子です。 支給レコードへの変更は、支給履歴表に保存されています。
  • タイトル: Earnings
    読取り専用: true
    支給レコードの一意の識別子です。 支給項目は、参加者プラン・コンポーネントおよびソース・トランザクション・クレジットに基づいて計算されたインセンティブ金額です。
  • タイトル: Earning Type
    読取り専用: true
    最大長: 30
    支給のタイプ。 支給タイプはプラン・コンポーネントで選択され、支給を金額および非通貨カテゴリに分類するために使用されます。 支払処理には、支給タイプが通貨の支給のみが含まれます。
  • 読取り専用: true
    インセンティブ・クレジットに割り当てられたクレジット・カテゴリの一意の識別子。 クレジット・カテゴリは、パフォーマンス測定および支給計算のためにクレジットを分類してから、参加者プラン・コンポーネントとクレジットを照合するために使用されました。
  • タイトル: Payment Hold
    最大長: 1
    デフォルト値: false
    保留が明示的に解除されるまで支払トランザクションを保留するかどうかを示します。 値がYの場合、支払トランザクションは保留になります。 デフォルト値は「Y」です。
  • タイトル: Home Currency
    最大長: 15
    支払トランザクションのソース・イベント日の時点で有効な参加者ホーム通貨を示すコード。 関係者スナップショット作業領域の「参加者詳細の管理」ページを使用して、有効な関係者属性をレビューします。
  • タイトル: Payment Type
    最大長: 30
    デフォルト値: MANUAL_PAY_ADJ
    賞与、支払プラン調整、手動調整など、支払トランザクション・タイプのカテゴリを表すコード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照CN_PAYMENT_ADJUSTMENT_TYPEに使用可能なコードをレビューします。
  • タイトル: Last Update Date
    読取り専用: true
    支払トランザクションが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    支払トランザクション・レコードを最後に更新したユーザー。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 32
    支払トランザクション・レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
  • Links
  • タイトル: Reason
    最大長: 30
    支払シート手動調整の事由を表すコード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照ORA_CN_PAYSHEET_MANUAL_ADJに使用可能なコードをレビューします。
  • タイトル: Status
    読取り専用: true
    最大長: 30
    支払トランザクションのステータス。 有効な値は、UNPAIDとPAIDです。
  • タイトル: Business Unit
    支払トランザクションが属するビジネス・ユニットの一意の識別子。 「設定およびメンテナンス」>「ビジネス・ユニットの定義」タスクを使用して、ビジネス・ユニットのビジネス・ユニットIDをレビューします。 Business Unit ID(ビジネス・ユニットID)列が表示されない場合は、View(表示)メニューをクリックしてBusiness Unit ID(ビジネス・ユニットID)列を追加します。
  • タイトル: Participant Identifier
    読取り専用: true
    支払トランザクション金額の支払期日または控除対象であるインセンティブ報酬関係者の一意の識別子。 参加者スナップショット作業領域の「参加者の選択」ページを使用して、参加者の参加者識別子をレビューします。
  • タイトル: Participant Name
    読取り専用: true
    最大長: 360
    支払トランザクション金額の支払期日または控除対象となるインセンティブ報酬参加者の名前。
  • 支払トランザクションの一意の識別子。
  • タイトル: Operating Payment Amount
    読取り専用: true
    営業通貨での支払トランザクション金額。
  • タイトル: Home Payment Amount
    参加者ホーム通貨での支払トランザクション金額。
  • タイトル: Processing Payment Amount
    処理通貨での支払トランザクション金額。 処理通貨は、ビジネス・ユニットの営業通貨または参加者ホーム通貨として選択されます。 「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用して、処理通貨パラメータをレビューします。
  • タイトル: Currency
    読取り専用: true
    最大長: 20
    処理通貨を示すコード。 処理通貨は、ビジネス・ユニットの営業通貨または参加者ホーム通貨として選択されます。 「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用して、処理通貨パラメータをレビューします。
  • 読取り専用: true
    適用できない標準アクションを通知するためのアクセス・インジケータ。 ここでは、アプリケーションで生成された支払トランザクションに対してDELETE標準処理を使用できません。
  • 読取り専用: true
    適用できない標準アクションを通知するためのアクセス・インジケータ。 ここでは、支払プランの修正および前の支払シートからの回収済修正にUPDATE標準処理を使用できません。 また、支払シート・ステータスが未払以外のものである場合、更新は許可されません。
  • タイトル: Period
    手動支払シート修正の支払トランザクション支給イベント日または支払バッチ期間の期間を表す期間番号。 期間番号は、「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用してインセンティブ報酬カレンダを定義するときに生成されます。 たとえば、期間番号2015001は、2015年の最初の期間を表します。
  • この支払トランザクションが属する支払バッチの一意の識別子。
  • タイトル: Payment Batch
    読取り専用: true
    最大長: 80
    支払トランザクションが属する支払バッチの名前。
  • タイトル: Person Number
    読取り専用: true
    最大長: 30
    支払トランザクション金額の支払期日または控除対象である参加者のグローバル人事管理で生成された参加者個人レコードの識別子です。 「参加者スナップショット」作業領域、「参加者の選択」ページおよび「参加者詳細の管理」ページを使用して、参加者個人番号をレビューします。
  • 参加者支給額の計算に使用される参加者インセンティブ報酬プラン・コンポーネントの一意の識別子です。
  • タイトル: Worker Number
    読取り専用: true
    最大長: 30
    支払トランザクション金額の期日または控除対象である関係者の就業者または従業員番号。 関係者スナップショット作業領域の「参加者の選択」ページおよび「参加者詳細の管理」ページを使用して、就業者番号をレビューします。
  • タイトル: Recoverable
    最大長: 1
    デフォルト値: true
    支払修正が将来控除可能かどうかを示します。 値がYの場合、支払調整は控除可能です。 デフォルト値は「Y」です。
  • 読取り専用: true
    この支給元のソース支給項目の一意識別子です。
  • タイトル: Event Date
    読取り専用: true
    支給イベントの日付。 イベント日は、ソース・トランザクション・イベント日または計算グループ化イベント日のいずれかで、インセンティブ支給になりました。
  • タイトル: Transaction Number
    読取り専用: true
    最大長: 30
    参加者インセンティブ支給となったトランザクション番号。
  • 読取り専用: true
    参加者への報酬プランの割当の一意の識別子。
ネストされたスキーマ : paymentBatches-paysheets-item-response
タイプ: object
ソースを表示
  • タイトル: Beginning Balance
    読取り専用: true
    将来使用するために予約されています。
  • タイトル: Calculated Amount
    読取り専用: true
    支払シートの未調整計算済支給項目の合計です。
  • タイトル: Payment Reference Number
    最大長: 400
    支払システムによる実際の支払を確認する参照番号。
  • タイトル: Earning Difference
    読取り専用: true
    未調整の計算済支給と調整後に支払われる実績金額の合計の差異。
  • タイトル: Last Update Date
    読取り専用: true
    支払シートが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    支払シート・レコードを最後に更新したユーザー。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 32
    支払シート・レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
  • Links
  • タイトル: Waived Amount
    読取り専用: true
    将来使用するために予約されています。
  • タイトル: Business Unit
    読取り専用: true
    支払シートが属するビジネス・ユニットの一意の識別子。 「設定およびメンテナンス」>「ビジネス・ユニットの定義」タスクを使用して、ビジネス・ユニットのビジネス・ユニットIDをレビューします。 Business Unit ID(ビジネス・ユニットID)列が表示されない場合は、View(表示)メニューをクリックしてBusiness Unit ID(ビジネス・ユニットID)列を追加します。
  • タイトル: Business Unit
    読取り専用: true
    最大長: 960
    支払シートが属するビジネス・ユニットの名前。
  • タイトル: Participant Identifier
    読取り専用: true
    支払シート金額の期日または控除対象となるインセンティブ報酬関係者の一意の識別子。 参加者スナップショット作業領域の「参加者の選択」ページを使用して、参加者の参加者識別子をレビューします。
  • タイトル: Participant Name
    読取り専用: true
    最大長: 360
    支払シート金額の期日または控除対象となるインセンティブ報酬参加者の名前。
  • タイトル: Party Identifier
    読取り専用: true
    取引先コミュニティ内のパーティの一意の識別子。 パーティは、支払シート金額の支払期日または控除対象である参加者です。 参加者スナップショット作業領域の「参加者の選択」ページを使用して、参加者のパーティ識別子をレビューします。
  • タイトル: Party Number
    読取り専用: true
    最大長: 30
    取引先コミュニティのパーティの代替キー識別子。 パーティは、支払シート金額の支払期日または控除対象である参加者です。 参加者スナップショット作業領域の「参加者の選択」ページおよび「参加者詳細の管理」ページを使用して、参加者のパーティ番号をレビューします。
  • タイトル: Currency
    読取り専用: true
    最大長: 15
    処理通貨を示すコード。 処理通貨は、ビジネス・ユニットの営業通貨または参加者ホーム通貨として選択されます。 「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用して、処理通貨パラメータをレビューします。
  • 読取り専用: true
    支払に対するインセンティブ報酬参加者を選択するために支払シート支払バッチで使用された支払グループの一意の識別子です。
  • タイトル: Pay Group
    読取り専用: true
    最大長: 80
    支払に対するインセンティブ報酬参加者を選択するために支払シート支払バッチで使用された支払グループの名前。 参加者割当作業領域の支払グループの管理タスクを使用して、支払グループをレビューします。
  • タイトル: Payment Amount
    読取り専用: true
    修正済支払トランザクションと未修正支払トランザクションの両方の合計。
  • タイトル: Payment Date
    支払シート、支払バッチ支払日。 支払バッチ作成プロセスでは、支給イベント日が支給日以前になっている支払シートに含めるすべての未払支給項目が選択されました。
  • タイトル: Payment Method
    最大長: 30
    買掛/未払金や給与などの支払システムからの、電子資金振替や小切手などの確認済支払メソッド。
  • タイトル: Total Amount
    読取り専用: true
    処理通貨での支払シート支払金額。
  • Payment Transactions
    タイトル: Payment Transactions
    支払トランザクション・リソースは、参加者支払トランザクションの表示、作成、更新および削除に使用されます。 支払トランザクションは、インセンティブ報酬プラン・コンポーネントからの計算済支給、手動調整、回収済金額、または支払プラン前払金および回収調整です。 支払トランザクション・リソースは、支払トランザクション保留および未払ステータスの支払シートの手動調整の管理にも使用されます。
  • タイトル: Period
    読取り専用: true
    支払シート、支払バッチを使用するカレンダ期間を表す期間番号。 期間番号は、「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用してインセンティブ報酬カレンダを定義するときに生成されます。 たとえば、期間番号2015001は、2015年の最初の期間を表します。
  • 読取り専用: true
    支払シートが属する支払バッチの一意の識別子。
  • タイトル: Payment Batch
    読取り専用: true
    最大長: 80
    支払シートが属する支払バッチの名前。
  • 読取り専用: true
    デフォルト値: false
    適用できない標準アクションを通知するためのアクセス・インジケータ。 ここでは、ペイ・シートに対してDELETE標準処理を使用できません。
  • 支払シートの一意の識別子。
  • タイトル: Status
    読取り専用: true
    最大長: 30
    未払、送信済、承認済など、現在の支払シート・ステータスを表す参照コード。 設定およびメンテナンス、インセンティブ報酬参照の管理タスクを使用して、参照タイプCN_PAYSHEET_STATUSの使用可能な参照コードをレビューします。
  • 読取り専用: true
    デフォルト値: false
    適用できない標準アクションを通知するためのアクセス・インジケータ。 ここでは、要約支払シート・ステータス値が支払われるまで、UPDATE標準処理を使用できません。 要約支払シートのみ更新できます。 個々のプラン・コンポーネントの支払シートは更新できません。
  • タイトル: Incentive Compensation Calendar Period
    読取り専用: true
    支払シートの対象となるカレンダ期間を表す期間番号。 期間番号は、「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用してインセンティブ報酬カレンダを定義するときに生成されます。 たとえば、期間番号2015001は、2015年の最初の期間を表します。
  • タイトル: Period Name
    読取り専用: true
    最大長: 30
    支払シート、支払バッチを使用するカレンダ期間の名前。 期間名は、インセンティブ報酬カレンダの定義時に入力されます。 たとえば、Jan-2015やQ1-2015などです。 期間名は、「設定およびメンテナンス」作業領域のカレンダの管理タスクを使用してレビューおよび管理できます。
  • タイトル: Person Number
    読取り専用: true
    最大長: 30
    支払シート金額の支払期日または控除対象である参加者のグローバル人事管理で生成された参加者個人レコードの識別子です。 「参加者スナップショット」作業領域、「参加者の選択」ページおよび「参加者詳細の管理」ページを使用して、参加者個人番号をレビューします。
  • 読取り専用: true
    関係者の計算済支給項目および支払シート調整に関連付けられた関係者インセンティブ報酬プラン・コンポーネントの一意の識別子です。
  • タイトル: Plan Component
    読取り専用: true
    最大長: 80
    インセンティブ報酬プラン・コンポーネントの名前。
  • タイトル: Calculated Recovery Adjustment
    読取り専用: true
    現在のペイ・シートで回収される期首残高の一部。
  • タイトル: Worker Number
    読取り専用: true
    最大長: 30
    支払シート金額が支払期日または控除対象である関係者の就業者または従業員番号。 関係者スナップショット作業領域の「参加者の選択」ページおよび「参加者詳細の管理」ページを使用して、就業者番号をレビューします。
  • タイトル: Recoverable Adjustment
    読取り専用: true
    調整済金額が後続の支払シートで回収される予定の支払シート支払プラン調整の合計です。
  • 読取り専用: true
    将来使用するために予約されています。
  • タイトル: Total Amount in Home Currency
    読取り専用: true
    参加者のホーム通貨での支払シート支払金額。
  • タイトル: Calculated Total Currency Conversion Rate
    読取り専用: true
    参加者のホーム通貨での合計支払金額および処理通貨での合計支払金額に基づく計算済換算レート。 ペイ・シートの合計金額には為替レートが同じでない複数の期間が含まれている可能性があるため、これは混合通貨レートである可能性があります。
ネストされたスキーマ : 支払トランザクション
タイプ: array
タイトル: Payment Transactions
支払トランザクション・リソースは、参加者支払トランザクションの表示、作成、更新および削除に使用されます。 支払トランザクションは、インセンティブ報酬プラン・コンポーネントからの計算済支給、手動調整、回収済金額、または支払プラン前払金および回収調整です。 支払トランザクション・リソースは、支払トランザクション保留および未払ステータスの支払シートの手動調整の管理にも使用されます。
ソースを表示
ネストされたスキーマ : paymentBatches-paysheets-paymentTransactions-item-response
タイプ: object
ソースを表示
  • タイトル: Comment
    最大長: 1000
    支払トランザクション金額の修正時に入力された注釈。
  • タイトル: Earning Amount
    読取り専用: true
    処理通貨での計算済支給額。
  • タイトル: Earning Rate
    読取り専用: true
    支給額の計算に使用されたインセンティブ・レート表金額またはレート。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    支払トランザクション・レコードを作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    支払トランザクションが作成された日付。
  • タイトル: Credit Receiver
    ソース・トランザクションのクレジットを受け取ったインセンティブ報酬関係者の一意の識別子です。 参加者スナップショット作業領域の「参加者の選択」ページを使用して、参加者の参加者識別子をレビューします。
  • タイトル: Credit Factor
    読取り専用: true
    支給計算式で使用された期間のクレジット金額の増加に対するアップ・リフト率。
  • 読取り専用: true
    デフォルト値: -1000
    支給タイプの一意の識別子です。 支給タイプはプラン・コンポーネントで選択され、支給を金額および非通貨カテゴリに分類するために使用されます。 Oracleが提供する通貨支給タイプのみを支払処理に含めることができます。
  • タイトル: Earning Factor
    読取り専用: true
    支給計算式で使用された一定期間にわたる支給の増加に対するアップ・リフト率。
  • 読取り専用: true
    支給履歴レコードの一意の識別子です。 支給レコードへの変更は、支給履歴表に保存されています。
  • タイトル: Earnings
    読取り専用: true
    支給レコードの一意の識別子です。 支給項目は、参加者プラン・コンポーネントおよびソース・トランザクション・クレジットに基づいて計算されたインセンティブ金額です。
  • タイトル: Earning Type
    読取り専用: true
    最大長: 30
    支給のタイプ。 支給タイプはプラン・コンポーネントで選択され、支給を金額および非通貨カテゴリに分類するために使用されます。 支払処理には、支給タイプが通貨の支給のみが含まれます。
  • 読取り専用: true
    インセンティブ・クレジットに割り当てられたクレジット・カテゴリの一意の識別子。 クレジット・カテゴリは、パフォーマンス測定および支給計算のためにクレジットを分類してから、参加者プラン・コンポーネントとクレジットを照合するために使用されました。
  • タイトル: Payment Hold
    最大長: 1
    デフォルト値: false
    保留が明示的に解除されるまで支払トランザクションを保留するかどうかを示します。 値がYの場合、支払トランザクションは保留になります。 デフォルト値は「Y」です。
  • タイトル: Home Currency
    最大長: 15
    支払トランザクションのソース・イベント日の時点で有効な参加者ホーム通貨を示すコード。 関係者スナップショット作業領域の「参加者詳細の管理」ページを使用して、有効な関係者属性をレビューします。
  • タイトル: Payment Type
    最大長: 30
    デフォルト値: MANUAL_PAY_ADJ
    賞与、支払プラン調整、手動調整など、支払トランザクション・タイプのカテゴリを表すコード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照CN_PAYMENT_ADJUSTMENT_TYPEに使用可能なコードをレビューします。
  • タイトル: Last Update Date
    読取り専用: true
    支払トランザクションが最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    支払トランザクション・レコードを最後に更新したユーザー。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 32
    支払トランザクション・レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
  • Links
  • タイトル: Reason
    最大長: 30
    支払シート手動調整の事由を表すコード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照ORA_CN_PAYSHEET_MANUAL_ADJに使用可能なコードをレビューします。
  • タイトル: Status
    読取り専用: true
    最大長: 30
    支払トランザクションのステータス。 有効な値は、UNPAIDとPAIDです。
  • タイトル: Business Unit
    支払トランザクションが属するビジネス・ユニットの一意の識別子。 「設定およびメンテナンス」>「ビジネス・ユニットの定義」タスクを使用して、ビジネス・ユニットのビジネス・ユニットIDをレビューします。 Business Unit ID(ビジネス・ユニットID)列が表示されない場合は、View(表示)メニューをクリックしてBusiness Unit ID(ビジネス・ユニットID)列を追加します。
  • タイトル: Participant Identifier
    読取り専用: true
    支払トランザクション金額の支払期日または控除対象であるインセンティブ報酬関係者の一意の識別子。 参加者スナップショット作業領域の「参加者の選択」ページを使用して、参加者の参加者識別子をレビューします。
  • タイトル: Participant Name
    読取り専用: true
    最大長: 360
    支払トランザクション金額の支払期日または控除対象となるインセンティブ報酬参加者の名前。
  • 支払トランザクションの一意の識別子。
  • タイトル: Operating Payment Amount
    読取り専用: true
    営業通貨での支払トランザクション金額。
  • タイトル: Home Payment Amount
    参加者ホーム通貨での支払トランザクション金額。
  • タイトル: Processing Payment Amount
    処理通貨での支払トランザクション金額。 処理通貨は、ビジネス・ユニットの営業通貨または参加者ホーム通貨として選択されます。 「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用して、処理通貨パラメータをレビューします。
  • タイトル: Currency
    読取り専用: true
    最大長: 20
    処理通貨を示すコード。 処理通貨は、ビジネス・ユニットの営業通貨または参加者ホーム通貨として選択されます。 「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用して、処理通貨パラメータをレビューします。
  • 読取り専用: true
    適用できない標準アクションを通知するためのアクセス・インジケータ。 ここでは、アプリケーションで生成された支払トランザクションに対してDELETE標準処理を使用できません。
  • 読取り専用: true
    適用できない標準アクションを通知するためのアクセス・インジケータ。 ここでは、支払プランの修正および前の支払シートからの回収済修正にUPDATE標準処理を使用できません。 また、支払シート・ステータスが未払以外のものである場合、更新は許可されません。
  • タイトル: Period
    手動支払シート修正の支払トランザクション支給イベント日または支払バッチ期間の期間を表す期間番号。 期間番号は、「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用してインセンティブ報酬カレンダを定義するときに生成されます。 たとえば、期間番号2015001は、2015年の最初の期間を表します。
  • この支払トランザクションが属する支払バッチの一意の識別子。
  • タイトル: Payment Batch
    読取り専用: true
    最大長: 80
    支払トランザクションが属する支払バッチの名前。
  • タイトル: Person Number
    読取り専用: true
    最大長: 30
    支払トランザクション金額の支払期日または控除対象である参加者のグローバル人事管理で生成された参加者個人レコードの識別子です。 「参加者スナップショット」作業領域、「参加者の選択」ページおよび「参加者詳細の管理」ページを使用して、参加者個人番号をレビューします。
  • 参加者支給額の計算に使用される参加者インセンティブ報酬プラン・コンポーネントの一意の識別子です。
  • タイトル: Worker Number
    読取り専用: true
    最大長: 30
    支払トランザクション金額の期日または控除対象である関係者の就業者または従業員番号。 関係者スナップショット作業領域の「参加者の選択」ページおよび「参加者詳細の管理」ページを使用して、就業者番号をレビューします。
  • タイトル: Recoverable
    最大長: 1
    デフォルト値: true
    支払修正が将来控除可能かどうかを示します。 値がYの場合、支払調整は控除可能です。 デフォルト値は「Y」です。
  • 読取り専用: true
    この支給元のソース支給項目の一意識別子です。
  • タイトル: Event Date
    読取り専用: true
    支給イベントの日付。 イベント日は、ソース・トランザクション・イベント日または計算グループ化イベント日のいずれかで、インセンティブ支給になりました。
  • タイトル: Transaction Number
    読取り専用: true
    最大長: 30
    参加者インセンティブ支給となったトランザクション番号。
  • 読取り専用: true
    参加者への報酬プランの割当の一意の識別子。
トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、すべての支払バッチを取得する方法を示しています。

レスポンス本文の例

次に、JSON形式のレスポンス本文の例を示します。

{
  "items": [
    {
      "PayrunId": 300100071551742,
      "PayrunName": "January Salesperson Payments",
      "PayGroupName": "Salesperson Pay Group",
      "PeriodName": "Jan-16",
      "PayPeriodId": 2016001,
      "PayGroupId": 300100014486717,
      "PaymentDate": "2016-01-31",
      "OrgId": 204,
      "OrgName": "Vision Operations",
      "Status": "PAID",
      "CreationDate": "2016-02-06T14:23:16-08:00",
      "CreatedBy": "OIC_MGR_OPERATIONS",
      "IncentiveTypeCode": "ALL",
      "LastUpdateDate": "2016-02-06T14:23:28-08:00",
      "LastUpdateLogin": "2B222E6039714A99E0536703F40AE8F2",
      "LastUpdatedBy": "OIC_MGR_OPERATIONS",
      "links": [
        {
          "rel": "self",
          "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentBatches/300100071551742",
          "name": "paymentBatches",
          "kind": "item",
          "properties": {
            "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000004737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B020000787200106A6176612E6C616E672E4F626A656374000000000000000000000078700000000178"
          }
        },
        {
          "rel": "canonical",
          "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentBatches/300100071551742",
          "name": "paymentBatches",
          "kind": "item"
        },
        {
          "rel": "child",
          "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentBatches/300100071551742/child/paymentTransactions",
          "name": "paymentTransactions",
          "kind": "collection"
        },
        {
          "rel": "child",
          "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentBatches/300100071551742/child/paysheets",
          "name": "paysheets",
          "kind": "collection"
        }
      ]
    },
    {
  ....
    }
  ],
  "count": 25,
  "hasMore": true,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentBatches",
      "name": "paymentBatches",
      "kind": "collection"
    }
  ]
}
「トップに戻る」