Create a MDF request for the budget
post
/crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/FundRequest
Request
Path Parameters
-
BudgetCode(required): string
The unique alternate identifier of the MDF budget.
Header Parameters
-
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.
-
Upsert-Mode:
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
-
ActivityEndDate: string
(date)
Title:
End Date
The date when the fund request activity was completed. -
ActivityStartDate: string
(date)
Title:
Start Date
The date when the fund request activity was started. -
ApprovalActionComments: string
Title:
Approver Comments
The comments entered during approval action on the fund request. -
ApprovalTaskStatusCode: string
Title:
Status
The 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 Amount
Default Value:0
The amount approved for the MDF request. -
ApprovedAmountPercent: number
Title:
Approved Percent
Default Value:100
The percentage of amount approved of the total fund request. -
ApprovedBy: string
Title:
Approved By
Maximum Length:64
The user who approved the MDF request. -
ApprovedById: integer
(int64)
Title:
Approved by ID
The unique identifier of the user who approved the marketing MDF request. -
ApprovedDate: string
(date)
Title:
Approved Date
The date on which the MDF request was approved. -
BgtExchangeRate: number
Title:
Budget Exchange Rate
Default Value:0
The exchange rate of the MDF budget which is associated with the fund request. -
BudgetId: integer
(int64)
Title:
Budget ID
The parent budget associated with the marketing MDF request. -
BudgetName: string
Title:
Budget
The name of the MDF budget associated with the fund request. -
Comments: string
Title:
Comments
Maximum Length:1000
The additional comments for the marketing MDF request. -
CurrencyCode: string
Title:
Currency
Maximum Length:30
The currency code for 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. -
Description: string
Title:
Description
Maximum Length:4000
The description for the marketing MDF request. -
FundRequestCode: string
Title:
Code
Maximum Length:100
The unique alternate identifier of the marketing MDF request. -
FundRequestId: integer
(int64)
Title:
Fund Request ID
The unique identifier of the MDF request. -
FundRequestName: string
Title:
Name
Maximum Length:250
The display name for the MDF request. -
FundRequestStatusCode: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The status code of the marketing MDF request. -
FundRequestType: string
Title:
Type
Maximum Length:30
The type of the fund request. -
Justification: string
Title:
Justification
Maximum Length:1000
The justification for the fund request. -
OwnerId: integer
(int64)
Title:
Owner ID
The internal resource who manages the marketing budget. -
OwnerName: string
Title:
Owner
Maximum Length:360
The owner of the fund request. -
PartnerCompanyNumber: string
Title:
Partner Company Number
Maximum Length:30
Public Unique Identifier for the Partner. -
PartnerId: integer
(int64)
Title:
Partner ID
The unique identifier of the partner account associated to the marketing MDF request. -
PartnerName: string
Title:
Partner
Maximum Length:360
The partner account identifier name associated to the marketing MDF request. -
RejectedBy: string
Title:
Rejected By
Maximum Length:64
The user who rejected the marketing MDF request. -
RejectedById: integer
(int64)
Title:
Rejected by ID
The unique identifier of the user who rejected the MDF request. -
RejectedDate: string
(date)
Title:
Rejected Date
The date when the marketing MDF request was rejected. -
RejectReasonCode: string
Title:
Reject Reason
The reason code for rejecting the fund request. -
RequestedAmount: number
Title:
Requested Amount
The amount submitted for the MDF request. The amount is displayed in the currency code associated with the MDF claim. -
RequestStatusMeaning: string
Title:
Status
The status of the MDF request. -
ReturnReasonCode: string
Title:
Return Reason
The reason code for returning the fund request back to the submitter. -
SubmitFundReqBy: string
(date)
Title:
Request Deadline
The date by which fund request needs to be submitted. -
SubmittedBy: string
Title:
Submitted By
Maximum Length:64
The user who submitted the marketing MDF request. -
SubmittedById: integer
(int64)
Title:
Submitted by ID
The unique identifier of the user who submitted the request. -
SubmittedDate: string
(date)
Title:
Submitted Date
The date when the marketing MDF request 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 : mdfBudgets-FundRequest-item-response
Type:
Show Source
object
-
ActivityEndDate: string
(date)
Title:
End Date
The date when the fund request activity was completed. -
ActivityStartDate: string
(date)
Title:
Start Date
The date when the fund request activity was started. -
Age: number
Title:
Request Age
Read Only:true
The number of days since the creation of the MDF request. -
ApprovalActionComments: string
Title:
Approver Comments
The comments entered during approval action on the fund request. -
ApprovalTaskStatusCode: string
Title:
Status
The 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 Amount
Default Value:0
The amount approved for the MDF request. -
ApprovedAmountPercent: number
Title:
Approved Percent
Default Value:100
The percentage of amount approved of the total fund request. -
ApprovedBy: string
Title:
Approved By
Maximum Length:64
The user who approved the MDF request. -
ApprovedById: integer
(int64)
Title:
Approved by ID
The unique identifier of the user who approved the marketing MDF request. -
ApprovedDate: string
(date)
Title:
Approved Date
The date on which the MDF request was approved. -
AvailableFundRequestAmount: number
Title:
Available Amount
Read Only:true
Default Value:0
The difference between total approved marketing MDF request and total approved claim amounts, which is available to new claims. -
BgtExchangeRate: number
Title:
Budget Exchange Rate
Default Value:0
The exchange rate of the MDF budget which is associated with the fund request. -
BudgetCode: string
Title:
Budget Code
Read Only:true
Maximum Length:100
Public Unique Identifier for the marketing Budget. -
BudgetCurrency: string
Title:
Budget Currency
Read Only:true
Maximum Length:30
The currency used for the MDF budget associated with the fund request. -
BudgetEndDate: string
(date)
Title:
Budget End Date
Read Only:true
The end date for the MDF budget associated with the fund request. -
BudgetId: integer
(int64)
Title:
Budget ID
The parent budget associated with the marketing MDF request. -
BudgetName: string
Title:
Budget
The name of the MDF budget associated with the fund request. -
BudgetStartDate: string
(date)
Title:
Budget Start Date
Read Only:true
The start date for the MDF budget associated with the fund request. -
CanApprove: boolean
Title:
Can Approve
Read Only:true
Indicates whether a request can be approved by the user. -
CanReject: boolean
Title:
Can Reject
Read Only:true
Indicates whether a request can be rejected by the user. -
CanReturn: boolean
Title:
Can Return
Read Only:true
Indicates whether a request can be returned by the user. -
CanSubmit: boolean
Title:
Can Submit
Read Only:true
Indicates whether a request can be submitted by the user. -
CanTerminate: boolean
Title:
Can Terminate
Read Only:true
Indicates whether a request can be terminated by the user. -
CanWithdraw: boolean
Title:
Can Withdraw
Read Only:true
Indicates whether a request can be withdrawn by the user. -
ChannelManager: string
Title:
Channel Manager
Read Only:true
Maximum Length:450
The user who is the channel manager for the fund request. -
ChannelManagerId: integer
(int64)
Title:
Channel Manager ID
Read Only:true
The unique identifier of the resource who is the channel manager for the fund request. -
Comments: string
Title:
Comments
Maximum Length:1000
The additional comments for the marketing MDF request. -
ConversionCurrencyCode: string
Title:
Conversion Currency Code
Read Only:true
Maximum Length:30
The currency code used for conversion in the request. -
ConversionRateType: string
Title:
Conversion Rate Type
Read Only:true
Maximum Length:30
The currency conversion rate type for the MDF fund request. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
ConvExchangeRate: number
Title:
Conversion Exchange Rate
Read Only:true
The currency exchange rate for the request against the corporate currency. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the marketing MDF request. -
CreatedBy_FN: string
Title:
Created By
Read Only:true
The name of the creator of the fund request. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the MDF request was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:30
The currency code for 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. -
CurrencyConversionDate: string
(date)
Title:
Currency Conversion Date
Read Only:true
The date of currency exchange rate for the request against the corporate currency. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the request can be deleted. If the user has access to delete the request then the default value is true, else false. -
Description: string
Title:
Description
Maximum Length:4000
The description for the marketing MDF request. -
FundRequestCode: string
Title:
Code
Maximum Length:100
The unique alternate identifier of the marketing MDF request. -
FundRequestId: integer
(int64)
Title:
Fund Request ID
The unique identifier of the MDF request. -
FundRequestName: string
Title:
Name
Maximum Length:250
The display name for the MDF request. -
FundRequestStatusCode: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The status code of the marketing MDF request. -
FundRequestType: string
Title:
Type
Maximum Length:30
The type of the fund request. -
Justification: string
Title:
Justification
Maximum Length:1000
The justification for the fund request. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the fund request was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the marketing MDF request. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the fund request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnerEmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The e-mail address of the owner of the fund request. -
OwnerFormattedPhoneNumber: string
Title:
Phone
Read Only:true
The formatted phone number of the owner of the fund request. -
OwnerId: integer
(int64)
Title:
Owner ID
The internal resource who manages the marketing budget. -
OwnerName: string
Title:
Owner
Maximum Length:360
The owner of the fund request. -
OwnerPartyNumber: string
Title:
Owner Party Number
Read Only:true
Maximum Length:30
Public Unique Identifier for the Resource. -
PartnerCompanyNumber: string
Title:
Partner Company Number
Maximum Length:30
Public Unique Identifier for the Partner. -
PartnerCountry: string
Title:
Partner Country
Read Only:true
Maximum Length:2
The country of the partner associated with the fund request. -
PartnerId: integer
(int64)
Title:
Partner ID
The unique identifier of the partner account associated to the marketing MDF request. -
PartnerName: string
Title:
Partner
Maximum Length:360
The partner account identifier name associated to the marketing MDF request. -
PartnerPartyUniqueName: string
Title:
Partner
Read Only:true
Maximum Length:360
The name of the partner associated with the fund request. -
RecordSet: string
Title:
Record Set
Read Only:true
Finds MDF request based on the filter criteria. -
RejectedBy: string
Title:
Rejected By
Maximum Length:64
The user who rejected the marketing MDF request. -
RejectedById: integer
(int64)
Title:
Rejected by ID
The unique identifier of the user who rejected the MDF request. -
RejectedDate: string
(date)
Title:
Rejected Date
The date when the marketing MDF request was rejected. -
RejectReasonCode: string
Title:
Reject Reason
The reason code for rejecting the fund request. -
RequestedAmount: number
Title:
Requested Amount
The amount submitted for the MDF request. The amount is displayed in the currency code associated with the MDF claim. -
RequestStatusMeaning: string
Title:
Status
The status of the MDF request. -
ReturnReasonCode: string
Title:
Return Reason
The reason code for returning the fund request back to the submitter. -
SubmitClaimsBy: string
(date)
Title:
Claim Deadline
Read Only:true
The date by which associated claim needs to be submitted. -
SubmitFundReqBy: string
(date)
Title:
Request Deadline
The date by which fund request needs to be submitted. -
SubmittedBy: string
Title:
Submitted By
Maximum Length:64
The user who submitted the marketing MDF request. -
SubmittedById: integer
(int64)
Title:
Submitted by ID
The unique identifier of the user who submitted the request. -
SubmittedDate: string
(date)
Title:
Submitted Date
The date when the marketing MDF request was submitted. -
TotalApprovedClaimAmount: number
Title:
Approved Claim Amount
Read Only:true
Default Value:0
The total amount of all approved claims for the marketing MDF request. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Indicates whether the request can be updated. If the user has access to update the request then the default value is true, else false.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed 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
The list of values to indicate the budget name associated to fund request.
The following properties are defined on the LOV link relation:- Source Attribute: BudgetName; Target Attribute: BudgetName
- Display Attribute: BudgetName, PartnerNameTrans
- finder:
- CurrencyPVA
-
The list of values to indicate the currency code for the MDF Request such as USD, CAD, or Euro.
The following properties are defined on the LOV link relation:- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode
- FundRequestPartnerPartySearchVA
-
The list of values to indicate the partners associated with the MDF request.
The following properties are defined on the LOV link relation:- Source Attribute: PartnerId; Target Attribute: PartyId
- Display Attribute: PartyId
- FundRequestTypeLOVVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_MDFREQUEST_TYPE%2CBindLookupCode%3D{FundRequestType}
The list of values to indicate the types of the MDF requests.
The following properties are defined on the LOV link relation:- Source Attribute: FundRequestType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RecordSetVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_MDF_RECORD_SET%2CBindLookupCode%3D{RecordSet}
The list of values that lets you to select the record set.
The following properties are defined on the LOV link relation:- Source Attribute: RecordSet; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RejectReasonCodeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{RejectReasonCode}%2CBindLookupType%3DORA_MKT_MDFREQUEST_REJECT
The list of values to indicate the reject reason of the fund request.
The following properties are defined on the LOV link relation:- Source Attribute: RejectReasonCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RequestStatusLOVVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKT_MDF_FUNDREQ_STATUS%2CBindLookupCode%3D{FundRequestStatusCode}
The list of values to indicate the status of the MDF request.
The following properties are defined on the LOV link relation:- Source Attribute: FundRequestStatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ResourceVOVA
-
Operation: /crmRestApi/resources/11.13.18.05/resourcesThe list of values to indicate the name of the owner associated with the MDF request.
The following properties are defined on the LOV link relation:- Source Attribute: OwnerName; Target Attribute: PartyName
- Display Attribute: PartyName
- ReturnReasonCodeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{ReturnReasonCode}%2CBindLookupType%3DORA_MKT_MDFREQUEST_RETURN
The list of values to indicate the return reason of the fund request.
The following properties are defined on the LOV link relation:- Source Attribute: ReturnReasonCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: