Create a claim
post
/crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Claim
Request
Path Parameters
-
FundRequestCode(required): string
The code indicating the user-defined, unique label for the MDF request.
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
ActivityOutcome: string
Title:
Activity OutcomeMaximum Length:1000Partner Activity Out come. -
ApprovalActionComments: string
Title:
Approver CommentsThe comments entered during approval action on the claim. -
ApprovalTaskStatusCode: string
Title:
StatusThe code indicating the approval action that can be taken in the MDF Claim. The accepted values are Approve, Reject, Return, Withdraw, Terminate, and HtOutcmeReturnReturnAction. -
ApprovedAmount: number
Title:
Approved AmountDefault Value:0The amount approved for the claim. -
ApprovedBy: string
Title:
ApproversMaximum Length:64The user who approved the MDF claim. -
ApprovedById: integer
(int64)
Title:
Approved by IDThe unique identifier of the user who approved the MDF claim. -
ApprovedDate: string
(date)
Title:
Approved DateThe date when the MDF claim was approved. -
BgtExchangeRate: number
Title:
Conversion Rate to BudgetDefault Value:0The exchange rate of the MDF budget which is associated with the MDF claim. MDF budget is associated to the claim through fund request. -
BudgetId: integer
(int64)
Title:
Budget IDThe unique identifier of the Budget associated with the MDF claim. -
BudgetName: string
Title:
BudgetMaximum Length:250The name of the MDF request budget associated with the MDF claim. -
ChannelMgrName: string
Title:
Channel ManagerThe name of the channel manager of the MDF claim. -
ClaimAmount: number
Title:
Requested AmountThe amount requested in the MDF claim. -
ClaimCode: string
Title:
CodeMaximum Length:100The user-defined or system generated code for the MDF claim. -
ClaimId: integer
(int64)
Title:
Claim IDThe unique identifier of the claim. This is a system-generated value. -
ClaimName: string
Title:
NameMaximum Length:250The name of the MDF claim. -
ClaimStatusCode: string
Title:
StatusMaximum Length:30Default Value:DRAFTThe code indicating the status of the MDF claim. A list of valid values is defined in the lookup ClaimStatusCode. The valid values are Approved, Draft, Failed, Pending Approval, Rejected, Returned, Terminated, or Withdrawn. -
Comments: string
Title:
CommentsMaximum Length:1000The additional comments on the MDF claim. -
ConvExchangeRate: number
Title:
Conversion Exchange RateThe currency exchange rate for the claim against the corporate currency. -
CurrencyCode: string
Title:
CurrencyMaximum Length:30The currency code associated with the claim. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyConversionDate: string
(date)
Title:
Currency Conversion DateThe date of currency exchange rate for the claim against the corporate currency. -
Description: string
Title:
DescriptionMaximum Length:4000A brief description of the MDF claim. -
FrExchangeRate: number
Title:
Fund Request Exchange RateDefault Value:0The exchange rate of the fund request associated with the claim. -
FundRequestCode: string
Title:
Fund Request CodeMaximum Length:100Public Unique Identifier for the marketing fund request. -
FundRequestId: integer
(int64)
Title:
Fund Request IDThe unique identifier of the MDF request associated with the MDF claim. -
FundRequestName: string
Title:
MDF RequestMaximum Length:250The name of the fund request associated with the claim. -
OutstngClaimLiabilityAmount: number
Title:
Liability AmountDefault Value:0The approved claim amount pending to be paid. -
OwnerId: integer
(int64)
Title:
Owner IDThe unique identifier of the owner of the MDF claim. -
OwnerName: string
Title:
OwnerMaximum Length:360The name of the MDF claim owner. -
PartnerCompanyNumber: string
Title:
Partner Company NumberMaximum Length:30Public Unique Identifier for the Partner. -
PartnerId: integer
(int64)
Title:
Partner IDThe unique identifier of the partner account associated with the MDF claim. -
RejectedBy: string
Title:
Rejected ByMaximum Length:64The user who rejected the MDF claim. -
RejectedById: integer
(int64)
Title:
Rejected by IDThe unique identifier of the user who rejected the MDF claim. -
RejectedDate: string
(date)
Title:
Rejected DateThe date when the MDF claim was rejected. -
RejectReasonCode: string
Title:
Reject ReasonThe reason code for rejecting the claim. -
ReturnReasonCode: string
Title:
Return ReasonThe reason code for returning the claim back to the submitter. -
SubmittedBy: string
Title:
Submitted ByMaximum Length:64The user who submitted the claim. -
SubmittedById: integer
(int64)
Title:
Submitted by IDThe unique identifier of the user who submitted the MDF claim. -
SubmittedDate: string
(date)
Title:
Submitted DateThe date when the MDF claim was submitted.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : mdfRequests-Claim-item-response
Type:
Show Source
object-
ActivityOutcome: string
Title:
Activity OutcomeMaximum Length:1000Partner Activity Out come. -
Age: number
Title:
Claim AgeRead Only:trueThe number of days since the creation of the claim. -
ApprovalActionComments: string
Title:
Approver CommentsThe comments entered during approval action on the claim. -
ApprovalTaskStatusCode: string
Title:
StatusThe code indicating the approval action that can be taken in the MDF Claim. The accepted values are Approve, Reject, Return, Withdraw, Terminate, and HtOutcmeReturnReturnAction. -
ApprovedAmount: number
Title:
Approved AmountDefault Value:0The amount approved for the claim. -
ApprovedBy: string
Title:
ApproversMaximum Length:64The user who approved the MDF claim. -
ApprovedById: integer
(int64)
Title:
Approved by IDThe unique identifier of the user who approved the MDF claim. -
ApprovedDate: string
(date)
Title:
Approved DateThe date when the MDF claim was approved. -
BgtExchangeRate: number
Title:
Conversion Rate to BudgetDefault Value:0The exchange rate of the MDF budget which is associated with the MDF claim. MDF budget is associated to the claim through fund request. -
BudgetCurrency: string
Title:
Budget CurrencyRead Only:trueMaximum Length:30The currency code associated with the MDF budget. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
BudgetEndDate: string
(date)
Title:
Budget End DateRead Only:trueThe date when the budget ends. -
BudgetId: integer
(int64)
Title:
Budget IDThe unique identifier of the Budget associated with the MDF claim. -
BudgetName: string
Title:
BudgetMaximum Length:250The name of the MDF request budget associated with the MDF claim. -
BudgetStartDate: string
(date)
Title:
Start DateRead Only:trueThe date when the budget starts. -
CanApprove: boolean
Title:
Can ApproveRead Only:trueIndicates if the user can approve the claim or an MDF request. If the user has access to approve a claim or an MDF request, then the default value is true, else false. -
CanReject: boolean
Title:
Can RejectRead Only:trueIndicates if the user can reject the claim or an MDF request. If the user has access to reject a claim or an MDF request, then the default value is true, else false. -
CanReturn: boolean
Title:
Can ReturnRead Only:trueIndicates if the user can return the claim or an MDF request. If the user has access to return a claim or an MDF request, then the default value is true, else false. -
CanSubmit: boolean
Title:
Can SubmitRead Only:trueIndicates whether the user has access to submit the claim. -
CanTerminate: boolean
Title:
Can TerminateRead Only:trueIndicates whether the user has access to terminate the claim. -
CanWithdraw: boolean
Title:
Can WithdrawRead Only:trueIndicates if the user can withdraw the claim or an MDF request. If the user has access to withdraw a claim or an MDF request, then the default value is true, else false. -
ChannelManagerId: integer
(int64)
Title:
Account Director IDRead Only:trueThe unique identifier of the channel manager of the MDF claim. -
ChannelMgrName: string
Title:
Channel ManagerThe name of the channel manager of the MDF claim. -
ClaimAmount: number
Title:
Requested AmountThe amount requested in the MDF claim. -
ClaimCode: string
Title:
CodeMaximum Length:100The user-defined or system generated code for the MDF claim. -
ClaimId: integer
(int64)
Title:
Claim IDThe unique identifier of the claim. This is a system-generated value. -
ClaimName: string
Title:
NameMaximum Length:250The name of the MDF claim. -
ClaimStatusCode: string
Title:
StatusMaximum Length:30Default Value:DRAFTThe code indicating the status of the MDF claim. A list of valid values is defined in the lookup ClaimStatusCode. The valid values are Approved, Draft, Failed, Pending Approval, Rejected, Returned, Terminated, or Withdrawn. -
Comments: string
Title:
CommentsMaximum Length:1000The additional comments on the MDF claim. -
ConversionCurrencyCode: string
Title:
Conversion Currency CodeRead Only:trueMaximum Length:30The currency code associated with the claim. -
ConversionRateType: string
Title:
Conversion Rate TypeRead Only:trueMaximum Length:30The currency conversion rate type used to derive the exchange rate between the MDF claim user entered currency and the CRM corporate currency code. -
ConvExchangeRate: number
Title:
Conversion Exchange RateThe currency exchange rate for the claim against the corporate currency. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the MDF claim. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the MDF claim was created. -
CurrencyCode: string
Title:
CurrencyMaximum Length:30The currency code associated with the claim. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyConversionDate: string
(date)
Title:
Currency Conversion DateThe date of currency exchange rate for the claim against the corporate currency. -
DeleteFlag: boolean
Title:
Delete IndicatorRead Only:trueIndicates whether the user has access to delete the record. -
Description: string
Title:
DescriptionMaximum Length:4000A brief description of the MDF claim. -
FrExchangeRate: number
Title:
Fund Request Exchange RateDefault Value:0The exchange rate of the fund request associated with the claim. -
FundRequestApprovedAmount: number
Title:
MDF Request Approved AmountRead Only:trueThe approved amount of the MDF request against the MDF claim. -
FundRequestCode: string
Title:
Fund Request CodeMaximum Length:100Public Unique Identifier for the marketing fund request. -
FundRequestCurrency: string
Title:
CurrencyRead Only:trueMaximum Length:30The currency code associated with the MDF request. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
FundRequestId: integer
(int64)
Title:
Fund Request IDThe unique identifier of the MDF request associated with the MDF claim. -
FundRequestName: string
Title:
MDF RequestMaximum Length:250The name of the fund request associated with the claim. -
FundRequestType: string
Title:
MDF Request TypeRead Only:trueMaximum Length:30The type of the MDF request. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the claim was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the MDF claim. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the claim. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManageApprovalDataFlag: boolean
Read Only:
trueIndicates whether user can modify claim attributes while the claim is awaiting approval. -
ManageGeneralDataFlag: boolean
Read Only:
trueIndicates whether user can modify claim attributes when the claim is either in draft or returned or withdrawn status. -
ManagePartnerDataFlag: boolean
Read Only:
trueIndicates whether the partner users are restricted from modifying the partner field. It indicates whether channel users can update the partner field when the claim is in draft, return, or withdrawn status. -
ManageTeamDataFlag: boolean
Read Only:
trueIndicates whether the logged in user has full access on the claim record. -
OutstngClaimLiabilityAmount: number
Title:
Liability AmountDefault Value:0The approved claim amount pending to be paid. -
OwnerEmailAddress: string
Title:
EmailRead Only:trueMaximum Length:320The email address of the MDF claim owner. -
OwnerFormattedPhoneNumber: string
Title:
PhoneRead Only:trueThe formatted phone number of the owner of the claim. -
OwnerId: integer
(int64)
Title:
Owner IDThe unique identifier of the owner of the MDF claim. -
OwnerName: string
Title:
OwnerMaximum Length:360The name of the MDF claim owner. -
OwnerPartyNumber: string
Title:
Owner Party NumberRead Only:trueMaximum Length:30Public Unique Identifier for the Resource. -
OwnerPrimaryPhoneNumber: string
Title:
PhoneRead Only:trueMaximum Length:40The phone number of the owner of the MDF claim. -
PartnerCompanyNumber: string
Title:
Partner Company NumberMaximum Length:30Public Unique Identifier for the Partner. -
PartnerId: integer
(int64)
Title:
Partner IDThe unique identifier of the partner account associated with the MDF claim. -
PartnerPartyUniqueName: string
Title:
PartnerRead Only:trueMaximum Length:360The name of the partner associated with the MDF claim. -
RecordSet: string
Title:
Record SetRead Only:trueThe record set values for claim. -
RejectedBy: string
Title:
Rejected ByMaximum Length:64The user who rejected the MDF claim. -
RejectedById: integer
(int64)
Title:
Rejected by IDThe unique identifier of the user who rejected the MDF claim. -
RejectedDate: string
(date)
Title:
Rejected DateThe date when the MDF claim was rejected. -
RejectReasonCode: string
Title:
Reject ReasonThe reason code for rejecting the claim. -
ReturnReasonCode: string
Title:
Return ReasonThe reason code for returning the claim back to the submitter. -
SubmitClaimsBy: string
(date)
Title:
Claim DeadlineRead Only:trueThe last date to submit a claim against the MDF request. -
SubmittedBy: string
Title:
Submitted ByMaximum Length:64The user who submitted the claim. -
SubmittedById: integer
(int64)
Title:
Submitted by IDThe unique identifier of the user who submitted the MDF claim. -
SubmittedDate: string
(date)
Title:
Submitted DateThe date when the MDF claim was submitted. -
UpdateFlag: boolean
Title:
Update IndicatorRead Only:trueIndicates whether the user has access to update the record.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- BudgetLOVVA
-
Operation: /crmRestApi/resources/11.13.18.05/mdfBudgetsParameters:
- finder:
MdfRestActiveBudgetFinder%3BbindStatus%3DACTIVE
A marketing budget contains details pertaining to monetary incentives for partners to execute marketing activities. - finder:
- ClaimStatusLOVVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKT_MDF_FUNDREQ_STATUS%2CBindLookupCode%3D{ClaimStatusCode}
The lookups resource is used to view standard lookup codes. - finder:
- CurrencyLOVVA
-
The rated currencies resource is used to view details of currency codes for CRM. It gives a list of accepted values that are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.
- FundRequestLOVVA_WithoutBudget
-
Parameters:
- finder:
MdfRequestsRestFinder%3BbindStatus_1%3DAPPROVED
The market development fund requests resource is used to view, create, update, and delete an MDF Request. An MDF request is a request for resources to develop and maintain sales and marketing activities. - finder:
- FundRequestTypeMeaningVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_MDFREQUEST_TYPE%2CBindLookupCode%3D{FundRequestType}
The lookups resource is used to view standard lookup codes. - finder:
- PartnerNameVA
-
The partner list of values resource is used to view a list of partners.
- RecordSetVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_MDF_CLAIM_RECORD_SET%2CBindLookupCode%3D{RecordSet}
The lookups resource is used to view standard lookup codes. - finder:
- RejectReasonCodeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{RejectReasonCode}%2CBindLookupType%3DORA_MKT_MDFCLAIM_REJECT
The lookups resource is used to view standard lookup codes. - finder:
- ResourceVOVA
-
Operation: /crmRestApi/resources/11.13.18.05/resourcesA front office person. For example, sales persons or partner members can be tagged as resources.
- ReturnReasonCodeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{ReturnReasonCode}%2CBindLookupType%3DORA_MKT_MDFCLAIM_RETURN
The lookups resource is used to view standard lookup codes. - finder: