すべての請求を取得
get
/crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Claim
リクエスト
パス・パラメータ
- FundRequestCode(required): string
MDFリクエストのユーザー定義の一意のラベルを示すコード。
問合せパラメータ
- dependency: string
このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
フォーマット: <attr1>=<val1>,<attr2>=<value2> - expand: string
このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
- fields: string
このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
フォーマット : ?fields=Attribute1,Attribute2
子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2 - finder: string
コレクションを検索するための事前定義済ファインダとして使用されます。
フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
使用可能なファインダ名および対応するファインダ変数を次に示します:- ClaimVOAltKey : 指定された代替キーを持つMDFClaimを検索します。
ファインダ変数:- ClaimCode; string; MDF請求のユーザー定義またはシステム生成コード。
- PrimaryKey : 指定された主キーを持つMDF請求を検索します。
ファインダ変数:- ClaimId; integer; MDF請求の一意の識別子。
- ClaimVOAltKey : 指定された代替キーを持つMDFClaimを検索します。
- limit: integer
このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
- links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- offset: integer
リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
- orderBy: string
このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
- q: string
この問合せパラメータは、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: boolean
"?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。
ヘッダー・パラメータ
- Metadata-Context:
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version:
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
この操作にはリクエスト本文がありません。
トップに戻る応答
サポートされるメディア・タイプ
- application/json
デフォルトのレスポンス
次の表では、このタスクに対するデフォルトのレスポンスについて説明します。
ヘッダー
- Metadata-Context(required):
REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
- REST-Framework-Version(required):
RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
ルート・スキーマ : mdfRequests-Claim
タイプ:
ソースを表示
object-
count(required): integer
現在の範囲で返されたリソース・インスタンスの数。
-
hasMore(required): boolean
サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
-
items: array Items
タイトル:
Itemsコレクション内のアイテム。 -
limit(required): integer
サーバーで使用される実際のページング・サイズ。
-
links(required): array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
offset(required): integer
現在のページで使用されるオフセット値。
-
totalResults: integer
"?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。
ネストされたスキーマ : mdfRequests-Claim-item-response
タイプ:
ソースを表示
object-
ActivityOutcome: string
タイトル:
Activity Outcome最大長:1000パートナ・アクティビティが終了しました。 -
年齢: number
タイトル:
Claim Age読取り専用:true請求が作成されてからの日数。 -
ApprovalActionComments: string
タイトル:
Approver Comments要求の承認処理中に入力されたコメント。 -
ApprovalTaskStatusCode: string
タイトル:
StatusMDF請求で実行できる承認処理を示すコード。 受け入れられる値は、承認、拒否、戻る、取下げ、終了およびHtOutcmeReturnReturnActionです。 -
ApprovedAmount: number
タイトル:
Approved Amountデフォルト値:0請求に対して承認された金額。 -
ApprovedBy: string
タイトル:
Approvers最大長:64MDF請求を承認したユーザー。 -
ApprovedById: integer (int64)
タイトル:
Approved by IDMDF請求を承認したユーザーの一意の識別子。 -
ApprovedDate: 文字列(日付)
タイトル:
Approved DateMDF請求が承認された日付。 -
BgtExchangeRate: number
タイトル:
Conversion Rate to Budgetデフォルト値:0MDF請求に関連付けられているMDF予算の換算レート。 MDF予算は、資金リクエストを介して請求に関連付けられます。 -
BudgetCurrency: string
タイトル:
Budget Currency読取り専用:true最大長:30MDF予算に関連付けられた通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
BudgetEndDate: 文字列(日付)
タイトル:
Budget End Date読取り専用:true予算が終了する日付。 -
BudgetName: string
タイトル:
Budget最大長:250MDF請求に関連付けられているMDFリクエスト予算の名前。 -
BudgetStartDate: 文字列(日付)
タイトル:
Start Date読取り専用:true予算が開始する日付。 -
CanApprove: boolean
タイトル:
Can Approve読取り専用:trueユーザーが請求またはMDFリクエストを承認できるかどうかを示します。 ユーザーが請求またはMDFリクエストを承認する権限がある場合、デフォルト値はtrue、それ以外の場合はfalseです。 -
CanReject: boolean
タイトル:
Can Reject読取り専用:trueユーザーが請求またはMDFリクエストを拒否できるかどうかを示します。 ユーザーが請求またはMDFリクエストを却下するアクセス権がある場合、デフォルト値はtrueで、それ以外の場合はfalseです。 -
CanReturn: boolean
タイトル:
Can Return読取り専用:trueユーザーが請求を返品できるか、MDFリクエストを返品できるかを示します。 ユーザーが請求またはMDFリクエストを返すアクセス権を持っている場合、デフォルト値はtrue、それ以外の場合はfalseです。 -
CanSubmit: boolean
タイトル:
Can Submit読取り専用:trueユーザーが要求を発行するためのアクセス権を持っているかどうかを示します。 -
CanTerminate: boolean
タイトル:
Can Terminate読取り専用:trueユーザーが要求を終了するためのアクセス権を持っているかどうかを示します。 -
CanWithdraw: boolean
タイトル:
Can Withdraw読取り専用:trueユーザーが請求を取り下げることができるか、MDFリクエストを取り下げることができるかを示します。 ユーザーが請求またはMDFリクエストを取り下げるアクセス権を持っている場合、デフォルト値はtrueで、それ以外はfalseです。 -
ChannelManagerId: integer (int64)
タイトル:
Account Director ID読取り専用:trueMDF請求のチャネル・マネージャの一意の識別子。 -
ChannelMgrName: string
タイトル:
Channel ManagerMDF請求のチャネル・マネージャの名前。 -
ClaimAmount: number
タイトル:
Requested AmountMDF請求でリクエストされた金額。 -
ClaimCode: string
タイトル:
Code最大長:100MDF請求のユーザー定義またはシステム生成コード。 -
ClaimId: integer (int64)
タイトル:
Claim ID要求の一意の識別子。 これはシステム生成の値です。 -
ClaimName: string
タイトル:
Name最大長:250MDF請求の名前。 -
ClaimStatusCode: string
タイトル:
Status最大長:30デフォルト値:DRAFTMDF請求のステータスを示すコード。 有効な値のリストは、参照ClaimStatusCodeで定義されます。 有効な値は、承認、ドラフト、失敗、承認保留、拒否、返却済み、終了済みまたは取消済みです。 -
Comments: string
タイトル:
Comments最大長:1000MDF請求に関する追加コメント。 -
ConversionCurrencyCode: string
タイトル:
Conversion Currency Code読取り専用:true最大長:30請求に関連する通貨コード。 -
ConversionRateType: string
タイトル:
Conversion Rate Type読取り専用:true最大長:30MDF請求ユーザー入力通貨とCRM企業通貨コードの間の換算レートを導出するために使用される通貨換算レート・タイプです。 -
ConvExchangeRate: number
タイトル:
Conversion Exchange Rate企業通貨に対する請求の通貨換算レート。 -
CreatedBy: string
タイトル:
Created By読取り専用:true最大長:64MDF請求を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date読取り専用:trueMDF請求が作成された日付。 -
CurrencyCode: string
タイトル:
Currency最大長:30請求に関連する通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
CurrencyConversionDate: 文字列(日付)
タイトル:
Currency Conversion Date企業通貨に対する請求の通貨為替レートの日付。 -
DeleteFlag: boolean
タイトル:
Delete Indicator読取り専用:trueレコードを削除するためのアクセス権がユーザーに付与されているかどうかを示します。 -
Description: string
タイトル:
Description最大長:4000MDF請求の簡単な説明。 -
FrExchangeRate: number
タイトル:
Fund Request Exchange Rateデフォルト値:0請求に関連付けられている資金リクエストの為替レート。 -
FundRequestApprovedAmount: number
タイトル:
MDF Request Approved Amount読取り専用:trueMDF請求に対するMDFリクエストの承認済み金額。 -
FundRequestCode: string
タイトル:
Fund Request Code最大長:100マーケティング資金リクエストの公開一意識別子です。 -
FundRequestCurrency: string
タイトル:
Currency読取り専用:true最大長:30MDFリクエストに関連付けられた通貨コード。 有効な値のリストは、参照ZCA_COMMON_CORPORATE_CURRENCYで定義されます。 「設定およびメンテナンス」作業領域の通貨プロファイル・オプションの管理タスクを使用して、プロファイル・オプションをレビューおよび更新します。 -
FundRequestId: integer (int64)
タイトル:
Fund Request IDMDF請求に関連付けられているMDFリクエストの一意の識別子。 -
FundRequestName: string
タイトル:
MDF Request最大長:250請求に関連付けられている資金リクエストの名前。 -
FundRequestType: string
タイトル:
MDF Request Type読取り専用:true最大長:30MDFリクエストのタイプ。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date読取り専用:true請求が最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By読取り専用:true最大長:64MDF請求を最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login読取り専用:true最大長:32請求を最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
OutstngClaimLiabilityAmount: number
タイトル:
Liability Amountデフォルト値:0支払待ちの承認済要求金額。 -
OwnerEmailAddress: string
タイトル:
Email読取り専用:true最大長:320MDF請求所有者の電子メール・アドレス。 -
OwnerFormattedPhoneNumber: string
タイトル:
Phone読取り専用:true請求の所有者の書式設定された電話番号。 -
OwnerId: integer (int64)
タイトル:
Owner IDMDF請求の所有者の一意の識別子。 -
OwnerName: string
タイトル:
Owner最大長:360MDF請求所有者の名前。 -
OwnerPartyNumber: string
タイトル:
Owner Party Number読取り専用:true最大長:30リソースのパブリック一意識別子。 -
OwnerPrimaryPhoneNumber: string
タイトル:
Phone読取り専用:true最大長:40MDF請求の所有者の電話番号。 -
PartnerPartyUniqueName: string
タイトル:
Partner読取り専用:true最大長:360MDF請求に関連付けられているパートナの名前。 -
RecordSet: string
タイトル:
Record Set読取り専用:true請求のレコード・セット値。 -
RejectedBy: string
タイトル:
Rejected By最大長:64MDF請求を拒否したユーザー。 -
RejectedById: integer (int64)
タイトル:
Rejected by IDMDF請求を否認したユーザーの一意の識別子。 -
RejectedDate: 文字列(日付)
タイトル:
Rejected DateMDF請求が拒否された日付。 -
RejectReasonCode: string
タイトル:
Reject Reason要求を否認する事由コード。 -
ReturnReasonCode: string
タイトル:
Return Reason要求を送信者に返却する事由コード。 -
SubmitClaimsBy: 文字列(日付)
タイトル:
Claim Deadline読取り専用:trueMDFリクエストに対する請求を送信する最終日。 -
SubmittedBy: string
タイトル:
Submitted By最大長:64請求を送信したユーザー。 -
SubmittedById: integer (int64)
タイトル:
Submitted by IDMDF請求を送信したユーザーの一意の識別子。 -
SubmittedDate: 文字列(日付)
タイトル:
Submitted DateMDF請求が送信された日付。 -
UpdateFlag: boolean
タイトル:
Update Indicator読取り専用:trueレコードを更新するためのアクセス権がユーザーに付与されているかどうかを示します。
ネストされたスキーマ : リンク
タイプ:
ソースを表示
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.
ネストされたスキーマ : properties
タイプ:
ソースを表示
object-
changeIndicator: string
リソース・インスタンスのインジケータまたはETag値を変更します。