機械翻訳について

すべての請求を取得

get

/crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Claim

リクエスト

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

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

    • ClaimVOAltKey : 指定された代替キーを持つMDFClaimを検索します。
      ファインダ変数:
      • ClaimCode; string; MDF請求のユーザー定義またはシステム生成コード。
    • PrimaryKey : 指定された主キーを持つMDF請求を検索します。
      ファインダ変数:
      • ClaimId; 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問合せパラメータを使用してこの収集リソースをフィルタできます:
    • ActivityOutcome; string; Partner Activity Out come.
    • ApprovedAmount; number;要求に対して承認された金額。
    • ApprovedBy; string; MDF請求を承認したユーザー。
    • ApprovedById; integer; MDF請求を承認したユーザーの一意の識別子。
    • ApprovedDate; string; MDF請求が承認された日付。
    • BudgetCurrency; string; MDF予算に関連付けられた通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • BudgetEndDate; string; 予算が終了する日付。
    • BudgetName; string; MDF請求に関連付けられているMDFリクエスト予算の名前。
    • BudgetStartDate; string; 予算が開始する日付。
    • ChannelManagerId; integer; MDF請求のチャネル・マネージャの一意の識別子。
    • ClaimAmount; number; MDF請求でリクエストされた金額。
    • ClaimCode; string; MDF請求のユーザー定義またはシステム生成コード。
    • ClaimId; integer;要求の一意の識別子。 これはシステム生成の値です。
    • ClaimName; string; MDF請求の名前。
    • ClaimStatusCode; string; MDF請求のステータスを示すコード。 有効な値のリストは、参照ClaimStatusCodeで定義されます。 有効な値は、承認、ドラフト、失敗、承認保留、拒否、返却済み、終了済みまたは取消済みです。
    • ConvExchangeRate; number;法人通貨に対する要求の通貨換算レート。
    • CreatedBy; string; MDF請求を作成したユーザー。
    • CreationDate; string; MDF請求が作成された日付。
    • CurrencyCode; string; 要求に関連付けられた通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
    • CurrencyConversionDate; string;法人通貨に対する要求の通貨換算レートの日付。
    • FrExchangeRate; number;請求に関連する資金リクエストの為替レート。
    • FundRequestApprovedAmount; number; MDF請求に対するMDFリクエストの承認済金額。
    • FundRequestCode; string;マーケティング資金リクエストの公開一意識別子。
    • FundRequestName; string; 請求に関連付けられている資金リクエストの名前。
    • FundRequestType; string; MDFリクエストのタイプ。
    • LastUpdateDate; string; 要求が最後に更新された日付。
    • LastUpdatedBy; string; MDF請求を最後に更新したユーザー。
    • OutstngClaimLiabilityAmount; number;支払待ちの承認済要求金額。
    • OwnerEmailAddress; string; MDF請求所有者のEメール・アドレス。
    • OwnerId; integer; MDF請求の所有者の一意の識別子。
    • OwnerName; string; MDF請求所有者の名前。
    • OwnerPartyNumber; string;リソースのパブリック一意識別子。
    • OwnerPrimaryPhoneNumber; string; MDF請求の所有者の電話番号。
    • PartnerPartyUniqueName; string; MDF請求に関連付けられているパートナの名前。
    • RecordSet; string; クレームのレコード・セット値。
    • RejectedBy; string; MDF請求を拒否したユーザー。
    • RejectedById; integer; MDF請求を拒否したユーザーの一意の識別子。
    • RejectedDate; string; MDF請求が拒否された日付。
    • SubmitClaimsBy; string; MDFリクエストに対してリクエストを発行する最終日。
    • SubmittedBy; string; 要求を発行したユーザー。
    • SubmittedById; integer; MDF請求を発行したユーザーの一意の識別子。
    • SubmittedDate; string; MDF請求が発行された日付。
  • "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

トップに戻る

応答

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

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
  • REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
  • RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
本文( )
ルート・スキーマ : mdfRequests-Claim
タイプ: object
ソースを表示
ネストされたスキーマ : アイテム
タイプ: array
タイトル: Items
コレクション内のアイテム。
ソースを表示
ネストされたスキーマ : mdfRequests-Claim-item-response
タイプ: object
ソースを表示
  • タイトル: Activity Outcome
    最大長: 1000
    パートナ・アクティビティが終了しました。
  • タイトル: Claim Age
    読取り専用: true
    請求が作成されてからの日数。
  • タイトル: Approver Comments
    要求の承認処理中に入力されたコメント。
  • タイトル: Status
    MDF請求で実行できる承認処理を示すコード。 受け入れられる値は、承認、拒否、戻る、取下げ、終了およびHtOutcmeReturnReturnActionです。
  • タイトル: Approved Amount
    デフォルト値: 0
    請求に対して承認された金額。
  • タイトル: Approvers
    最大長: 64
    MDF請求を承認したユーザー。
  • タイトル: Approved by ID
    MDF請求を承認したユーザーの一意の識別子。
  • タイトル: Approved Date
    MDF請求が承認された日付。
  • タイトル: Conversion Rate to Budget
    デフォルト値: 0
    MDF請求に関連付けられているMDF予算の換算レート。 MDF予算は、資金リクエストを介して請求に関連付けられます。
  • タイトル: Budget Currency
    読取り専用: true
    最大長: 30
    MDF予算に関連付けられた通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Budget End Date
    読取り専用: true
    予算が終了する日付。
  • タイトル: Budget
    最大長: 250
    MDF請求に関連付けられているMDFリクエスト予算の名前。
  • タイトル: Start Date
    読取り専用: true
    予算が開始する日付。
  • タイトル: Can Approve
    読取り専用: true
    ユーザーが請求またはMDFリクエストを承認できるかどうかを示します。 ユーザーが請求またはMDFリクエストを承認する権限がある場合、デフォルト値はtrue、それ以外の場合はfalseです。
  • タイトル: Can Reject
    読取り専用: true
    ユーザーが請求またはMDFリクエストを拒否できるかどうかを示します。 ユーザーが請求またはMDFリクエストを却下するアクセス権がある場合、デフォルト値はtrueで、それ以外の場合はfalseです。
  • タイトル: Can Return
    読取り専用: true
    ユーザーが請求を返品できるか、MDFリクエストを返品できるかを示します。 ユーザーが請求またはMDFリクエストを返すアクセス権を持っている場合、デフォルト値はtrue、それ以外の場合はfalseです。
  • タイトル: Can Submit
    読取り専用: true
    ユーザーが要求を発行するためのアクセス権を持っているかどうかを示します。
  • タイトル: Can Terminate
    読取り専用: true
    ユーザーが要求を終了するためのアクセス権を持っているかどうかを示します。
  • タイトル: Can Withdraw
    読取り専用: true
    ユーザーが請求を取り下げることができるか、MDFリクエストを取り下げることができるかを示します。 ユーザーが請求またはMDFリクエストを取り下げるアクセス権を持っている場合、デフォルト値はtrueで、それ以外はfalseです。
  • タイトル: Account Director ID
    読取り専用: true
    MDF請求のチャネル・マネージャの一意の識別子。
  • タイトル: Channel Manager
    MDF請求のチャネル・マネージャの名前。
  • タイトル: Requested Amount
    MDF請求でリクエストされた金額。
  • タイトル: Code
    最大長: 100
    MDF請求のユーザー定義またはシステム生成コード。
  • タイトル: Claim ID
    要求の一意の識別子。 これはシステム生成の値です。
  • タイトル: Name
    最大長: 250
    MDF請求の名前。
  • タイトル: Status
    最大長: 30
    デフォルト値: DRAFT
    MDF請求のステータスを示すコード。 有効な値のリストは、参照ClaimStatusCodeで定義されます。 有効な値は、承認、ドラフト、失敗、承認保留、拒否、返却済み、終了済みまたは取消済みです。
  • タイトル: Comments
    最大長: 1000
    MDF請求に関する追加コメント。
  • タイトル: Conversion Currency Code
    読取り専用: true
    最大長: 30
    請求に関連する通貨コード。
  • タイトル: Conversion Rate Type
    読取り専用: true
    最大長: 30
    MDF請求ユーザー入力通貨とCRM企業通貨コードの間の換算レートを導出するために使用される通貨換算レート・タイプです。
  • タイトル: Conversion Exchange Rate
    企業通貨に対する請求の通貨換算レート。
  • タイトル: Created By
    読取り専用: true
    最大長: 64
    MDF請求を作成したユーザー。
  • タイトル: Creation Date
    読取り専用: true
    MDF請求が作成された日付。
  • タイトル: Currency
    最大長: 30
    請求に関連する通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Currency Conversion Date
    企業通貨に対する請求の通貨為替レートの日付。
  • タイトル: Delete Indicator
    読取り専用: true
    レコードを削除するためのアクセス権がユーザーに付与されているかどうかを示します。
  • タイトル: Description
    最大長: 4000
    MDF請求の簡単な説明。
  • タイトル: Fund Request Exchange Rate
    デフォルト値: 0
    請求に関連付けられている資金リクエストの為替レート。
  • タイトル: MDF Request Approved Amount
    読取り専用: true
    MDF請求に対するMDFリクエストの承認済み金額。
  • タイトル: Fund Request Code
    最大長: 100
    マーケティング資金リクエストの公開一意識別子です。
  • タイトル: Currency
    読取り専用: true
    最大長: 30
    MDFリクエストに関連付けられた通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。
  • タイトル: Fund Request ID
    MDF請求に関連付けられているMDFリクエストの一意の識別子。
  • タイトル: MDF Request
    最大長: 250
    請求に関連付けられている資金リクエストの名前。
  • タイトル: MDF Request Type
    読取り専用: true
    最大長: 30
    MDFリクエストのタイプ。
  • タイトル: Last Update Date
    読取り専用: true
    請求が最後に更新された日付。
  • タイトル: Last Updated By
    読取り専用: true
    最大長: 64
    MDF請求を最後に更新したユーザー。
  • タイトル: Last Update Login
    読取り専用: true
    最大長: 32
    請求を最後に更新したユーザーのログイン。
  • Links
  • タイトル: Liability Amount
    デフォルト値: 0
    支払待ちの承認済要求金額。
  • タイトル: Email
    読取り専用: true
    最大長: 320
    MDF請求所有者の電子メール・アドレス。
  • タイトル: Phone
    読取り専用: true
    請求の所有者の書式設定された電話番号。
  • タイトル: Owner ID
    MDF請求の所有者の一意の識別子。
  • タイトル: Owner
    最大長: 360
    MDF請求所有者の名前。
  • タイトル: Owner Party Number
    読取り専用: true
    最大長: 30
    リソースのパブリック一意識別子。
  • タイトル: Phone
    読取り専用: true
    最大長: 40
    MDF請求の所有者の電話番号。
  • タイトル: Partner
    読取り専用: true
    最大長: 360
    MDF請求に関連付けられているパートナの名前。
  • タイトル: Record Set
    読取り専用: true
    請求のレコード・セット値。
  • タイトル: Rejected By
    最大長: 64
    MDF請求を拒否したユーザー。
  • タイトル: Rejected by ID
    MDF請求を否認したユーザーの一意の識別子。
  • タイトル: Rejected Date
    MDF請求が拒否された日付。
  • タイトル: Reject Reason
    要求を否認する事由コード。
  • タイトル: Return Reason
    要求を送信者に返却する事由コード。
  • タイトル: Claim Deadline
    読取り専用: true
    MDFリクエストに対する請求を送信する最終日。
  • タイトル: Submitted By
    最大長: 64
    請求を送信したユーザー。
  • タイトル: Submitted by ID
    MDF請求を送信したユーザーの一意の識別子。
  • タイトル: Submitted Date
    MDF請求が送信された日付。
  • タイトル: Update Indicator
    読取り専用: true
    レコードを更新するためのアクセス権がユーザーに付与されているかどうかを示します。
「トップに戻る」