機械翻訳について
  1. Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API
  2. タスク
  3. 請求
  4. 請求決済

すべての請求決済を取得

get

/crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/ClaimSettlements

リクエスト

パス・パラメータ
問合せパラメータ
  • このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2

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

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

    • ClaimCodeAndClaimSettlementCodeRF : 指定されたファインダ変数を持つ要求決済を検索します。
      ファインダ変数:
      • ClaimCode; string; マーケティング要求のユーザー定義の一意のラベル。
      • ClaimSettlementCode; string; 要求決済のタイプを示すコード。
    • ClaimSettlementsVOAltKey : 指定した代替キーを持つ要求決済を検索します。
      ファインダ変数:
      • ClaimSettlementCode; string; 要求決済のタイプを示すコード。
    • PrimaryKey : 指定した主キーを持つ要求決済を検索します。
      ファインダ変数:
      • ClaimSettlementId; integer; MDF請求決済の一意の識別子。
  • このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
  • このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • AccountingTypeMeaning;文字列;バックエンド財務システムでの貸方または借方を表すマーケティング要求決済の会計タイプ。
    • BudgetCurrencyExchangeRate; number;マーケティング要求決済通貨を親予算通貨に換算するために使用される換算レート。
    • BudgetName; string; 要求に関連付けられたMDF予算の名前。 MDF予算は、資金リクエストを介して請求に関連付けられます。
    • ClaimCode; string; マーケティング要求のユーザー定義の一意のラベル。
    • ClaimCurrencyExchangeRate; number;マーケティング請求決済通貨を親マーケティング請求通貨に換算するために使用される為替レート。
    • ClaimName; string; 要求決済に関連付けられた要求の名前。
    • ClaimSettlementAmount; number; MDF請求決済で決済された金額。
    • ClaimSettlementCode; string; MDF請求決済のユーザー定義の一意のラベル。
    • ClaimSettlementId; integer; MDF請求決済の一意の識別子。
    • ClaimSettlementType; string; 控除や支払など、MDF請求決済のタイプ。
    • ClaimSettlmntTypeMeaning;文字列。控除や支払など、マーケティング請求決済のタイプ。
    • ClaimStatusCode; string;要求決済のステータス。
    • ConvExchangeRate; number;法人通貨に対する要求決済の通貨換算レート。
    • ConversionCurrencyCode; string; 要求決済に関連付けられた通貨コード。
    • ConversionRateType; string; 要求決済に関連付けられた換算レート・タイプ。
    • CreatedBy; string; MDF請求決済を作成したユーザー。
    • CreatedById; integer;要求決済の作成者の一意の識別子。
    • CreationDate; string; 要求決済が作成された日付。
    • CurrencyConversionDate; string;法人通貨に対する要求決済の通貨換算レートの日付。
    • 説明;文字列;マーケティング請求決済の簡単な説明。
    • InvoiceReference; string; MDF請求決済で決済される請求書の参照識別子。
    • LastUpdateDate; string;決済が最後に更新された日付。
    • LastUpdateLogin; string;決済を最後に更新したユーザーのログイン。
    • LastUpdatedBy; string; マーケティング請求決済を最後に更新したユーザー。
    • OutstandingClaimLiabilityAmount; number;未回収請求負債金額。
    • PartnerName; string;パーティの名前。
    • StatusCode; string;マーケティング請求決済の完了ステータスを示すコード。
    • StatusMeaning; string;マーケティング請求決済の完了ステータス。
    • TransactionDate; string;要求決済が処理された日付または完了としてマークされた日付。
    • TransactionMethod; string; 要求決済トランザクションが処理されたメソッド。
    • TransactionMethodMeaning; string; 要求決済トランザクションが処理されるメソッド。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : mdfClaims-ClaimSettlements
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : mdfClaims-ClaimSettlements-item-response
タイプ: object
ソースを表示
  • タイトル: Accounting Type
    最大長: 30
    バックエンド財務システムの貸方または借方を表すMDF請求決済の会計タイプ。
  • タイトル: Accounting Type
    読取り専用: true
    バックエンド財務システムの貸方または借方を表す、マーケティング要求決済の会計タイプです。
  • タイトル: Conversion Rate to Budget
    読取り専用: true
    デフォルト値: 1
    マーケティング請求決済通貨を親予算通貨に換算するために使用される換算レート。
  • タイトル: Budget ID
    読取り専用: true
    MDF請求に関連付けられている親予算の一意の識別子。
  • タイトル: Name
    読取り専用: true
    最大長: 250
    請求に関連付けられているMDF予算の名前。 MDF予算は、資金リクエストを介して請求に関連付けられます。
  • タイトル: Code
    最大長: 100
    マーケティング請求のユーザー定義の一意のラベル。
  • タイトル: Conversion Rate to Claim
    読取り専用: true
    デフォルト値: 1
    マーケティング請求決済通貨を親マーケティング請求通貨に換算するために使用される為替レート。
  • タイトル: Claim ID
    MDF請求の一意の識別子。
  • タイトル: Name
    読取り専用: true
    最大長: 250
    請求決済に関連付けられた請求の名前。
  • タイトル: Amount
    MDF請求決済で決済された金額。
  • タイトル: Code
    最大長: 100
    MDF請求決済のユーザー定義の一意のラベル。
  • タイトル: Claim Settlement ID
    MDF請求決済の一意の識別子。
  • タイトル: Type
    最大長: 30
    控除または支払など、MDF請求決済のタイプです。
  • タイトル: Type
    読取り専用: true
    マーケティング要求決済のタイプ(控除、支払など)。
  • タイトル: Status
    読取り専用: true
    最大長: 30
    請求決済のステータス。
  • タイトル: Conversion Currency Code
    読取り専用: true
    最大長: 30
    要求決済に関連付けられた通貨コード。
  • タイトル: Conversion Rate Type
    読取り専用: true
    最大長: 30
    要求決済に関連付けられた換算レート・タイプです。
  • タイトル: Conversion Exchange Rate
    読取り専用: true
    企業通貨に対する要求決済の通貨換算レート。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    MDF請求決済を作成したユーザー。
  • タイトル: Created by ID
    読取り専用: true
    要求決済の作成者の一意の識別子。
  • タイトル: Creation Date
    読取り専用: true
    要求決済が作成された日付。
  • タイトル: Currency
    最大長: 30
    要求決済勘定に関連付けられた通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Currency Conversion Date
    読取り専用: true
    企業通貨に対する要求決済の通貨換算レートの日付。
  • タイトル: Description
    最大長: 1000
    マーケティング請求決済の簡単な説明。
  • タイトル: Transaction Reference
    最大長: 100
    MDF請求決済で決済される請求書の参照識別子。
  • タイトル: Last Update Date
    読取り専用: true
    決済が最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    マーケティング請求決済を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    決済を最後に更新したユーザーのログイン。
  • Links
  • タイトル: Liability Amount
    読取り専用: true
    デフォルト値: 0
    未回収請求負債金額です。
  • タイトル: Partner ID
    読取り専用: true
    パーティの一意識別子
  • タイトル: Partner
    読取り専用: true
    パーティの名前。
  • タイトル: Status
    最大長: 30
    デフォルト値: INCOMPLETE
    マーケティング要求決済の完了ステータスを示すコード。
  • タイトル: Status
    読取り専用: true
    マーケティング請求決済の完了ステータス。
  • タイトル: Transaction Date
    要求決済が処理されたか、完了としてマークされた日付。
  • タイトル: Transaction Method
    最大長: 30
    要求決済トランザクションが処理されたメソッド。
  • タイトル: Transaction Method
    読取り専用: true
    要求決済トランザクションの処理メソッド。
「トップに戻る」