機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 支払トランザクション

すべての支払トランザクションの取得

get

/fscmRestApi/resources/11.13.18.05/paymentTransactions

リクエスト

問合せパラメータ
  • このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"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>

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

    • ManualAdjustments : 手動調整タイプの支払トランザクションを検索します。
      ファインダ変数:
      • PrimaryKey : 指定した主キーを持つ支払トランザクションを検索します。
        ファインダ変数:
        • ParticipantPayId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
      • AdjustComments; string; 支払トランザクション金額を調整するときに注釈が入力されます。
      • CommAmountCalculationCurrency; number;処理通貨での計算済支給額。
      • CommissionValue; number;支給額の計算に使用されたインセンティブ・レート表金額またはレート。
      • CreatedBy; string; 支払トランザクション・レコードを作成したユーザー。
      • CreationDate; string; 支払トランザクションが作成された日付。
      • CreditFactor; number;支給計算式で使用された期間のクレジット金額の増加に対するアップ・リフト率。
      • CreditTypeId; integer;支給タイプの一意の識別子。 支給タイプはプラン・コンポーネントで選択され、支給を金額および非通貨カテゴリに分類するために使用されます。 Oracleが提供する通貨支給タイプのみを支払処理に含めることができます。
      • CreditedParticipantId; integer; ソース・トランザクションのクレジットを受け取ったインセンティブ報酬参加者の一意の識別子。 参加者スナップショット作業領域の「参加者の選択」ページを使用して、参加者の参加者識別子をレビューします。
      • EarningFactor; number;支給計算式で使用された一定期間における支給の増加に対するアップ・リフト率。
      • EarningHId; integer;支給履歴レコードの一意の識別子。 支給レコードへの変更は、支給履歴表に保存されています。
      • EarningId; integer;支給レコードの一意の識別子。 支給項目は、参加者プラン・コンポーネントおよびソース・トランザクション・クレジットに基づいて計算されたインセンティブ金額です。
      • EarningType; string;支給のタイプ。 支給タイプはプラン・コンポーネントで選択され、支給を金額および非通貨カテゴリに分類するために使用されます。 支払処理には、支給タイプが通貨の支給のみが含まれます。
      • EligibleCatId; integer;インセンティブ・クレジットが割り当てられたクレジット・カテゴリの一意の識別子。 クレジット・カテゴリは、パフォーマンス測定および支給計算のためにクレジットを分類してから、参加者プラン・コンポーネントとクレジットを照合するために使用されました。
      • HoldFlag; boolean;保留が明示的に解除されるまで支払トランザクションを保留するかどうかを示します。 値がYの場合、支払トランザクションは保留になります。 デフォルト値は「Y」です。
      • HomeCurrencyCode;文字列。支払トランザクションのソース・イベント日時点で有効な参加者ホーム通貨を示すコード。 関係者スナップショット作業領域の「参加者詳細の管理」ページを使用して、有効な関係者属性をレビューします。
      • IncentiveTypeCode;文字列。ボーナス、支払プラン調整、手動調整など、支払トランザクション・タイプのカテゴリを表すコード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照CN_PAYMENT_ADJUSTMENT_TYPEに使用可能なコードをレビューします。
      • LastUpdateDate; string; 支払トランザクションが最後に更新された日付。
      • LastUpdateLogin; string; 支払トランザクション・レコードを最後に更新したユーザーに関連付けられたセッション・ログイン。
      • LastUpdatedBy; string; 支払トランザクション・レコードを最後に更新したユーザー。
      • ManualAdjustmentReasonCode; string; 支払シートの手動調整の事由を表すコード。 設定およびメンテナンスのインセンティブ報酬参照の管理タスクを使用して、参照ORA_CN_PAYSHEET_MANUAL_ADJに使用可能なコードをレビューします。
      • ObjectStatus; string;支払トランザクションのステータス。 有効な値は、UNPAIDとPAIDです。
      • OrgId; integer; 支払トランザクションが属するビジネス・ユニットの一意の識別子。 「設定およびメンテナンス」>「ビジネス・ユニットの定義」タスクを使用して、ビジネス・ユニットのビジネス・ユニットIDをレビューします。 Business Unit ID(ビジネス・ユニットID)列が表示されない場合は、View(表示)メニューをクリックしてBusiness Unit ID(ビジネス・ユニットID)列を追加します。
      • ParticipantId; integer; 支払トランザクション金額の支払期日または控除対象となるインセンティブ報酬参加者の一意の識別子。 参加者スナップショット作業領域の「参加者の選択」ページを使用して、参加者の参加者識別子をレビューします。
      • ParticipantName; string; 支払トランザクション金額の支払期日または控除対象となるインセンティブ報酬参加者の名前。
      • ParticipantPayId; integer; 支払トランザクションの一意の識別子。
      • PayAmountFuncCurrency; number;営業通貨での支払トランザクション金額。
      • PayAmountHomeCurrency; number;参加者ホーム通貨での支払トランザクション金額。
      • PayAmountPayCurrency; number;処理通貨での支払トランザクション金額。 処理通貨は、ビジネス・ユニットの営業通貨または参加者ホーム通貨として選択されます。 「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用して、処理通貨パラメータをレビューします。
      • PayCurrencyCode; string; 処理通貨を示すコード。 処理通貨は、ビジネス・ユニットの営業通貨または参加者ホーム通貨として選択されます。 「設定およびメンテナンス」作業領域のパラメータの管理タスクを使用して、処理通貨パラメータをレビューします。
      • PayPeriodId; integer; 手動支払シート調整の支払トランザクション支給イベント日または支払バッチ期間の期間を表す期間番号。 期間番号は、「設定およびメンテナンス」作業領域、「カレンダの管理」タスクを使用してインセンティブ報酬カレンダを定義するときに生成されます。 たとえば、期間番号2015001は、2015年の最初の期間を表します。
      • PayrunId; integer; この支払トランザクションが属する支払バッチの一意の識別子。
      • PayrunName; string; 支払トランザクションが属する支払バッチの名前。
      • PersonNumber; string; 支払トランザクション金額の支払期日または控除対象である参加者のグローバル人事管理における参加者個人レコードに対して生成された識別子。 「参加者スナップショット」作業領域、「参加者の選択」ページおよび「参加者詳細の管理」ページを使用して、参加者個人番号をレビューします。
      • PlanComponentId; integer;参加者支給額の計算に使用される参加者インセンティブ報酬プラン・コンポーネントの一意の識別子。
      • PrimaryWorkerNumber;文字列。支払トランザクション金額の支払期日または控除対象である関係者の就業者または従業員番号。 関係者スナップショット作業領域の「参加者の選択」ページおよび「参加者詳細の管理」ページを使用して、就業者番号をレビューします。
      • RecoverableFlag; boolean;支払調整が将来控除可能かどうかを示します。 値がYの場合、支払調整は控除可能です。 デフォルト値は「Y」です。
      • SourceEarningId; integer;この支給元のソース支給項目の一意の識別子。
      • SourceEventDate; string;支給イベントの日付。 イベント日は、ソース・トランザクション・イベント日または計算グループ化イベント日のいずれかで、インセンティブ支給になりました。
      • SourceTrxNumber; string; 参加者インセンティブ支給が発生したトランザクション番号。
      • SrpPlanAssignId; integer; 参加者への報酬プランの割当ての一意の識別子。
    • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
    ヘッダー・パラメータ
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

    トップに戻る

    応答

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

    デフォルトのレスポンス

    次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
    ヘッダー
    • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
    • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
    本文( )
    ルート・スキーマ : paymentTransactions
    タイプ: object
    ソースを表示
    ネストされたスキーマ : アイテム
    タイプ: array
    タイトル: Items
    コレクション内のアイテム。
    ソースを表示
    ネストされたスキーマ : 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": [
    {
      "AdjustComments": null,
      "ParticipantPayId": 6122,
      "CommAmountCalculationCurrency": 3000,
      "CreatedBy": "27AB6EB0D7709DCAB38FB2F43B7785DE",
      "CreationDate": "2016-02-02 23:29:26.0",
      "CommissionValue": 4000,
      "CreditTypeId": -1000,
      "CreditedParticipantId": 13001,
      "EarningId": 48041,
      "HoldFlag": null,
      "HomeCurrencyCode": "USD",
      "IncentiveTypeCode": "COMMISSION",
      "LastUpdateDate": "2016-02-02 23:31:20.0",
      "LastUpdateLogin": "27AB6EB0D7709DCAB38FB2F43B7785DE",
      "LastUpdatedBy": "27AB6EB0D7709DCAB38FB2F43B7785DE",
      "ObjectStatus": "PAID",
      "OrgId": 204,
      "PayAmountFuncCurrency": 3000,
      "PayAmountHomeCurrency": 3000,
      "PayAmountPayCurrency": 3000,
      "PayCurrencyCode": "USD",
      "PayPeriodId": 2016001,
      "PayrunId": 300100016600360,
      "PlanComponentId": 300100016600146,
      "RecoverableFlag": false,
      "SourceEventDate": "2016-01-10",
      "SourceTrxNumber": null,
      "SrpPlanAssignId": 35006,
      "SourceEarningId": null,
      "CreditFactor": null,
      "EarningFactor": null,
      "EarningType": "BASE",
      "EligibleCatId": 300100016352701,
      "EarningHId": 14029,
      "PayrunName": "January Sales Manager Payments",
      "ParticipantName": "Williams,Gracie",
      "ParticipantId": 13001,
      "PersonNumber": "955160008173573",
      "PrimaryWorkerNumber": null,
      "links": [
        {
          "rel": "self",
          "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentTransactions/6122",
          "name": "paymentTransactions",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentTransactions/6122",
          "name": "paymentTransactions",
          "kind": "item"
        }
      ]
    },
    {
     ...
    }
  ],
  "count": 25,
  "hasMore": true,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/paymentTransactions",
      "name": "paymentTransactions",
      "kind": "collection"
    }
  ]
}
    「トップに戻る」