予算に関連付けられたMDF請求を取得
get
/crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/Claim/{ClaimCode}
リクエスト
パス・パラメータ
- BudgetCode(required): string
MDF予算の一意の代替識別子。
- ClaimCode(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 - links: string
このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
例:
self,canonical
- onlyData: boolean
リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
ヘッダー・パラメータ
- 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のデフォルト・バージョンを選択します。
ルート・スキーマ : mdfBudgets-Claim-item-response
タイプ:
ソースを表示
object-
ActivityOutcome: string
タイトル:
Activity Outcome最大長:1000パートナ・アクティビティが終了しました。 -
年齢: number
タイトル:
Claim Age読取り専用:trueMDF請求が作成されてからの日数。 -
ApprovalActionComments: string
タイトル:
Approver Comments要求の承認処理中に入力されたコメント。 -
ApprovalTaskStatusCode: string
タイトル:
StatusMDF請求で実行できる承認処理を示すコード。 受け入れられる値は、承認、拒否、戻る、取下げ、終了およびHtOutcmeReturnReturnActionです。 -
ApprovedAmount: number
タイトル:
Approved Amountデフォルト値:0MDF請求に対して承認された金額。 -
ApprovedBy: string
タイトル:
Approvers最大長:64MDF請求を承認したユーザー。 -
ApprovedById: integer (int64)
タイトル:
Approved by IDMDF請求を承認したユーザーの一意の識別子。 -
ApprovedDate: 文字列(日付)
タイトル:
Approved DateMDF請求が承認された日付。 -
BgtExchangeRate: number
タイトル:
Conversion Rate to Budgetデフォルト値:0請求に関連付けられているMDF予算の換算レート。 MDF予算は、資金リクエストを介して請求に関連付けられます。 -
BudgetCurrency: string
タイトル:
Budget Currency読取り専用:true最大長:30請求に関連付けられたMDF予算に使用される通貨。 MDF予算は、資金リクエストを介して請求に関連付けられます。 -
BudgetEndDate: 文字列(日付)
タイトル:
Budget End Date読取り専用:true請求に関連付けられているMDF予算の開始日。 MDF予算は、資金リクエストを介して請求に関連付けられます。 -
BudgetName: string
タイトル:
Budget最大長:250MDF請求に関連付けられているマーケティング予算の表示名。 -
BudgetStartDate: 文字列(日付)
タイトル:
Start Date読取り専用:true請求に関連付けられているMDF予算の終了日。 MDF予算は、資金リクエストを介して請求に関連付けられます。 -
CanApprove: boolean
タイトル:
Can Approve読取り専用:trueユーザーがMDF請求を承認できるかどうかを示します。 ユーザーがMDF請求を承認するアクセス権を持っている場合、デフォルト値はtrue、それ以外の場合はfalseです。 -
CanReject: boolean
タイトル:
Can Reject読取り専用:trueユーザーが要求を否認するためのアクセス権を持っているかどうかを示します。 -
CanReturn: boolean
タイトル:
Can Return読取り専用:trueユーザーが要求を返品するためのアクセス権を持っているかどうかを示します。 -
CanSubmit: boolean
タイトル:
Can Submit読取り専用:trueユーザーが要求を発行するためのアクセス権を持っているかどうかを示します。 -
CanTerminate: boolean
タイトル:
Can Terminate読取り専用:trueユーザーが要求を終了するためのアクセス権を持っているかどうかを示します。 -
CanWithdraw: boolean
タイトル:
Can Withdraw読取り専用:trueユーザーが要求を取り下げることができるかどうかを示します。 -
ChannelManagerId: integer (int64)
タイトル:
Account Director ID読取り専用:true請求に関連付けられているパートナ所有者の一意の識別子。 -
ChannelMgrName: string
タイトル:
Channel Manager請求のチャネル・マネージャの名前。 -
ClaimAmount: number
タイトル:
Requested AmountMDF請求用に送信された金額。 -
ClaimCode: string
タイトル:
Code最大長:100MDF請求の一意の代替識別子。 -
ClaimId: integer (int64)
タイトル:
Claim IDMDF請求の一意の識別子。 -
ClaimName: string
タイトル:
Name最大長:250MDF請求の表示名。 -
ClaimStatusCode: string
タイトル:
Status最大長:30デフォルト値:DRAFTMDF請求のステータス・コード。 -
Comments: string
タイトル:
Comments最大長:1000MDF請求の追加コメント。 -
ConversionCurrencyCode: string
タイトル:
Conversion Currency Code読取り専用:true最大長:30請求における換算に使用される通貨コード。 -
ConversionRateType: string
タイトル:
Conversion Rate Type読取り専用:true最大長:30MDF請求に使用される換算レート・タイプ。 -
ConvExchangeRate: number
タイトル:
Conversion Exchange Rate企業通貨に対する請求の通貨換算レート。 -
CreatedBy: string
タイトル:
Created By読取り専用:true最大長:64MDF請求を作成したユーザー。 -
CreationDate: string (date-time)
タイトル:
Creation Date読取り専用:trueMDF請求が作成された日付。 -
CurrencyCode: string
タイトル:
Currency最大長:30MDF請求金額に対して入力されたISO通貨コード。 -
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読取り専用:true請求に関連付けられている資金リクエストの承認済み金額。 -
FundRequestCode: string
タイトル:
Fund Request Code最大長:100マーケティング資金リクエストの公開一意識別子です。 -
FundRequestCurrency: string
タイトル:
Currency読取り専用:true最大長:30請求に関連する資金リクエストに使用される通貨コード。 -
FundRequestId: integer (int64)
タイトル:
Fund Request IDMDF請求に関連付けられているMDF資金リクエスト。 -
FundRequestName: string
タイトル:
MDF Request最大長:250請求に関連付けられている資金リクエストの名前。 -
FundRequestType: string
タイトル:
MDF Request Type読取り専用:true最大長:30請求に関連付けられている資金リクエストのタイプ。 -
LastUpdateDate: string (date-time)
タイトル:
Last Update Date読取り専用:true請求が最後に更新された日付。 -
LastUpdatedBy: string
タイトル:
Last Updated By読取り専用:true最大長:64マーケティング予算を最後に更新したユーザー。 -
LastUpdateLogin: string
タイトル:
Last Update Login読取り専用:true最大長:32請求を最後に更新したユーザーのログイン。 -
links: array Links
タイトル:
Linksリソース・インスタンスに関連付けられたリンク関係。 -
OutstngClaimLiabilityAmount: number
タイトル:
Liability Amountデフォルト値:0予算請求に対して待ち状態の未回収請求負債金額です。 -
OwnerEmailAddress: string
タイトル:
Email読取り専用:true最大長:320請求の所有者のEメール・アドレス。 -
OwnerFormattedPhoneNumber: string
タイトル:
Phone読取り専用:true請求の所有者の書式設定された電話番号。 -
OwnerId: integer (int64)
タイトル:
Owner IDMDF請求を所有するユーザーの一意の識別子。 -
OwnerName: string
タイトル:
Owner最大長:360MDF請求所有者の名前。 -
OwnerPartyNumber: string
タイトル:
Owner Party Number読取り専用:true最大長:30リソースのパブリック一意識別子。 -
OwnerPrimaryPhoneNumber: string
タイトル:
Phone読取り専用:true最大長:40請求の所有者のプライマリ電話番号。 -
PartnerPartyUniqueName: string
タイトル:
Partner読取り専用:true最大長:360請求に関連付けられているパートナの名前。 -
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読取り専用:true請求を送信する必要がある日付。 -
SubmittedBy: string
タイトル:
Submitted By最大長:64MDF請求を送信したユーザー。 -
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値を変更します。
リンク
- BudgetLOVVA
-
パラメータ:
- ファインダ:
MdfRestActiveBudgetFinder%3BbindStatus%3DACTIVE
要求に関連付けられた予算名を示す値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: BudgetName;ターゲット属性: BudgetName
- 表示属性: BudgetName
- ファインダ:
- ClaimStatusLOVVA
-
パラメータ:
- ファインダ:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKT_MDF_FUNDREQ_STATUS%2CBindLookupCode%3D{ClaimStatusCode}
MDF請求のステータスを示す値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: ClaimStatusCode;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- CurrencyLOVVA
-
LOVリンク関連では、次のプロパティが定義されます:
- ソース属性: CurrencyCode;ターゲット属性: CurrencyCode
- 表示属性: CurrencyCode
- FundRequestLOVVA_WithoutBudget
-
パラメータ:
- ファインダ:
MdfRequestsRestFinder%3BbindStatus_1%3DAPPROVED
請求に関連付けられている承認済資金リクエスト名を示す値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: FundRequestName;ターゲット属性: FundRequestName
- 表示属性: FundRequestName
- ファインダ:
- RecordSetVA
-
パラメータ:
- ファインダ:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_MDF_CLAIM_RECORD_SET%2CBindLookupCode%3D{RecordSet}
レコード・セットを選択できる値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: RecordSet;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- RejectReasonCodeVA
-
パラメータ:
- ファインダ:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{RejectReasonCode}%2CBindLookupType%3DORA_MKT_MDFCLAIM_REJECT
要求の否認事由を示す値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: RejectReasonCode;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
- ResourceVOVA
-
MDF請求に関連付けられている所有者の名前を示す値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: OwnerName;ターゲット属性: PartyName
- 表示属性: PartyName
- ReturnReasonCodeVA
-
パラメータ:
- ファインダ:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{ReturnReasonCode}%2CBindLookupType%3DORA_MKT_MDFCLAIM_RETURN
要求の返品事由を示す値リスト。
LOVリンク関連では、次のプロパティが定義されます:- ソース属性: ReturnReasonCode;ターゲット属性: LookupCode
- 表示属性: 意味
- ファインダ:
例:
次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによって、予算に関連付けられたmdf要求を取得する方法を示しています。
cURLコマンド
curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/Claim/{ClaimCode}
レスポンス本文の例
次に、JSON形式のレスポンス本文の例を示します。
{
"RecordSet": null,
"ClaimId": 300100543257888,
"FundRequestId": 300100543257820,
"ClaimName": "[CLAIMNAME]",
"Description": null,
"CurrencyCode": "USD",
"Age": 123,
"ClaimAmount": 100,
"ApprovedAmount": 100,
"ClaimCode": "ClaimCode19702792276_4bd02801966",
"ClaimStatusCode": "APPROVED",
"ApprovedBy": "Account_MgrENT1 CAM",
"ApprovedDate": "2021-06-17",
"RejectedBy": null,
"RejectedDate": null,
"SubmittedDate": null,
"CreatedBy": "CHANNEL_OPERATIONS_MANAGER",
"CreationDate": "2021-06-17T04:06:41+00:00",
"LastUpdatedBy": "Channel_OPS_Mgr_ENT1 COM",
"LastUpdateLogin": "C4774F721408A0D0E0533DFDF40A851E",
"LastUpdateDate": "2021-06-17T04:06:49.974+00:00",
"FundRequestName": "RequestApp_0b602762412",
"SubmittedBy": null,
"FundRequestCurrency": "USD",
"Comments": null,
"ConversionRateType": "Corporate",
"ConversionCurrencyCode": "USD",
"OutstngClaimLiabilityAmount": 100,
"OwnerId": 100010038017885,
"OwnerName": "Channel_OPS_Mgr_ENT1 COM",
"ChannelMgrName": "Account_MgrENT1 CAM",
"FundRequestType": null,
"ActivityOutcome": null,
"FundRequestApprovedAmount": 100000,
"ChannelManagerId": 100010038017873,
"PartnerPartyUniqueName": "Stryker Corp.",
"OwnerPrimaryPhoneNumber": "6338437",
"OwnerEmailAddress": "sendmail-test-discard@oracle.com",
"ApprovedById": 100010038017873,
"CurrencyConversionDate": "2021-06-17",
"RejectedById": null,
"SubmittedById": null,
"CanSubmit": "false",
"CanTerminate": "true",
"OwnerFormattedPhoneNumber": "+1 (650) 633-8437",
"CanApprove": "false",
"CanReject": "false",
"CanWithdraw": "false",
"CanReturn": "false",
"FrExchangeRate": 1,
"ReturnReasonCode": null,
"RejectReasonCode": null,
"ApprovalActionComments": null,
"ConvExchangeRate": 1,
"UpdateFlag": false,
"DeleteFlag": false,
"ApprovalTaskStatusCode": null,
"BgtExchangeRate": 1,
"FundRequestCode": "RequestApp_0b602762412",
"OwnerPartyNumber": "100010038017885",
"SubmitClaimsBy": "2021-06-24",
"BudgetName": "BudgetActive_64d02762383",
"BudgetCurrency": "USD",
"BudgetStartDate": "2021-06-17",
"BudgetEndDate": null,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/Claim/ClaimCode19702792276_4bd02801966",
"name": "Claim",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/Claim/ClaimCode19702792276_4bd02801966",
"name": "Claim",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383",
"name": "mdfBudgets",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/Claim/ClaimCode19702792276_4bd02801966/lov/ClaimStatusLOVVA",
"name": "ClaimStatusLOVVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/Claim/ClaimCode19702792276_4bd02801966/lov/CurrencyLOVVA",
"name": "CurrencyLOVVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/Claim/ClaimCode19702792276_4bd02801966/lov/ReturnReasonCodeVA",
"name": "ReturnReasonCodeVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/Claim/ClaimCode19702792276_4bd02801966/lov/ResourceVOVA",
"name": "ResourceVOVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/Claim/ClaimCode19702792276_4bd02801966/lov/FundRequestLOVVA_WithoutBudget",
"name": "FundRequestLOVVA_WithoutBudget",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/Claim/ClaimCode19702792276_4bd02801966/lov/RejectReasonCodeVA",
"name": "RejectReasonCodeVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/Claim/ClaimCode19702792276_4bd02801966/lov/BudgetLOVVA",
"name": "BudgetLOVVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/Claim/ClaimCode19702792276_4bd02801966/lov/RecordSetVA",
"name": "RecordSetVA",
"kind": "collection"
}
]
}