Update a MDF budget
patch
/crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActivatedById: integer
(int64)
Title:
Activated by ID
The user ID of the user who activated the MDF budget. -
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
BudgetCountries: array
Budget Countries
Title:
Budget Countries
The budget countries resource is used to view, create, and update the list of partner countries to which budget can be allocated to. -
BudgetName: string
Title:
Name
Maximum Length:250
The display name for the MDF budget. -
BudgetNote: array
Notes
Title:
Notes
The note resource is used to capture comments, information, or instructions for an MDF budget. -
BudgetTeam: array
MDF Budget Teams
Title:
MDF Budget Teams
The MDF budget team resource is used to view, create, and update MDF budget team members. A budget team member is a resource who is assigned to the MDF budget team and who has the appropriate visibility and access to the MDF budget record. -
BudgetType: string
Title:
Type
Maximum Length:30
The type of MDF budget. -
CategoryCode: string
Title:
Category
Maximum Length:30
The category of the MDF budget. -
Claim: array
Claims
Title:
Claims
The claim resource is used to view, create, and update a claim. A claim is a request for reimbursement of marketing expenses submitted by a partner. -
ConvExchangeRate: number
Title:
Conversion Exchange Rate
The currency exchange rate for the MDF budget against the corporate currency. -
Country: string
Title:
Country
Maximum Length:2
The country value used to categorize MDF budgets by geographical countries. -
CurrencyCode: string
Title:
Currency
Maximum Length:30
The currency used of the MDF budgeted amount. -
Description: string
Title:
Description
Maximum Length:4000
The description of the MDF budget. -
EndDate: string
(date)
Title:
End Date
The end date for the MDF budget. -
FundRequest: array
Fund Requests
Title:
Fund Requests
The fund request resource is used view, create, and update fund requests. A fund request is a request for a portion of the budget to be allocated towards execution of certain marketing activities. -
InactivatedById: integer
(int64)
Title:
Inactivated by ID
The user ID of the user who inactivated the MDF budget. -
InitialBudgetAmount: number
Title:
Initial Amount
The original or initial MDF budget amount. -
OwnerId: integer
(int64)
Title:
Owner ID
The resource who manages the MDF budget. -
OwnerNameTrans: string
Title:
Owner
Maximum Length:360
The owner name of the MDF budget. -
PartnerId: integer
(int64)
Title:
Partner ID
The unique identifier of the partner company that the MDF budget is assigned to. -
PartnerNameTrans: string
Title:
Partner
Maximum Length:360
The partner name of the MDF budget. -
StartDate: string
(date)
Title:
Start Date
The start date of the MDF budget. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The activation status of the MDF budget. -
SubmitClaimsBy: string
(date)
Title:
Claim Deadline
The last date on which a MDF budget claim will be accepted for reimbursement. -
SubmitFundRequestBy: string
(date)
Title:
Request Deadline
The last date on which a MDF budget fund request will be accepted. -
TotalBudgetAmount: number
Title:
Total Budget
Default Value:0
The total MDF budget amount based on the initial MDF budget along with adjustments.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Budget Countries
Type:
array
Title:
Budget Countries
The budget countries resource is used to view, create, and update the list of partner countries to which budget can be allocated to.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The note resource is used to capture comments, information, or instructions for an MDF budget.
Show Source
Nested Schema : MDF Budget Teams
Type:
array
Title:
MDF Budget Teams
The MDF budget team resource is used to view, create, and update MDF budget team members. A budget team member is a resource who is assigned to the MDF budget team and who has the appropriate visibility and access to the MDF budget record.
Show Source
Nested Schema : Claims
Type:
array
Title:
Claims
The claim resource is used to view, create, and update a claim. A claim is a request for reimbursement of marketing expenses submitted by a partner.
Show Source
Nested Schema : Fund Requests
Type:
array
Title:
Fund Requests
The fund request resource is used view, create, and update fund requests. A fund request is a request for a portion of the budget to be allocated towards execution of certain marketing activities.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment.
Nested Schema : mdfBudgets-BudgetCountries-item-patch-request
Type:
Show Source
object
-
CountryCode: string
Maximum Length:
2
The country code associated to of MDF budget.
Nested Schema : schema
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the relationship when the note is associated with a MDF budget user. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the note associated with the MDF budget A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique identifier of the party who created the note. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the note A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the note A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
NoteTitle: string
Title:
Title
Maximum Length:500
The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
The actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
The code to categorize notes. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The unique identifier of the source object as defined in OBJECTS metadata. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
The visibility level of the note.
Nested Schema : schema
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Access
Maximum Length:30
The access level code of the resource on the MDF budget team. -
PhoneNumber: string
Title:
Phone
The phone number of the team member associated with the MDF budget. -
UserFunctionCode: string
Title:
Function
Maximum Length:30
The function code of the MDF budget team member.
Nested Schema : schema
Type:
Show Source
object
-
ActivityOutcome: string
Title:
Activity Outcome
Maximum Length:1000
Partner Activity Out come. -
ApprovalActionComments: string
Title:
Approver Comments
The comments entered during approval action on the claim. -
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 claim. -
ApprovedBy: string
Title:
Approvers
Maximum Length:64
The user who approved the MDF claim. -
ApprovedById: integer
(int64)
Title:
Approved by ID
The unique identifier of the user who approved the MDF claim. -
ApprovedDate: string
(date)
Title:
Approved Date
The date on which the MDF claim was approved. -
BgtExchangeRate: number
Title:
Conversion Rate to Budget
Default Value:0
The exchange rate of the MDF budget which is associated with the claim. MDF budget is associated to the claim through fund request. -
BudgetName: string
Title:
Budget
Maximum Length:250
The display name of the marketing budget associated to the MDF claim. -
ChannelMgrName: string
Title:
Channel Manager
The name of the channel manager of the claim. -
ClaimAmount: number
Title:
Requested Amount
The amount submitted for the MDF claim. -
ClaimName: string
Title:
Name
Maximum Length:250
The display name of the MDF claim. -
ClaimStatusCode: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The status code of the MDF claim. -
Comments: string
Title:
Comments
Maximum Length:1000
The additional comments for the MDF claim. -
ConvExchangeRate: number
Title:
Conversion Exchange Rate
The currency exchange rate for the claim against the corporate currency. -
CurrencyCode: string
Title:
Currency
Maximum Length:30
The ISO currency code entered for the MDF claim amount. -
CurrencyConversionDate: string
(date)
Title:
Currency Conversion Date
The date of currency exchange rate for the claim against the corporate currency. -
Description: string
Title:
Description
Maximum Length:4000
The description for the MDF claim. -
FrExchangeRate: number
Title:
Fund Request Exchange Rate
Default Value:0
The currency exchange rate for the claim against the fund request currency. -
FundRequestCode: string
Title:
Fund Request Code
Maximum Length:100
Public Unique Identifier for the marketing fund request. -
FundRequestId: integer
(int64)
Title:
Fund Request ID
The MDF fund request associated to the MDF claim. -
FundRequestName: string
Title:
MDF Request
Maximum Length:250
The name of the fund request associated with the claim. -
OutstngClaimLiabilityAmount: number
Title:
Liability Amount
Default Value:0
The outstanding claim liability amount that is pending for the budget claim. -
OwnerId: integer
(int64)
Title:
Owner ID
The unique identifier of the user who owns the MDF claim. -
OwnerName: string
Title:
Owner
Maximum Length:360
The name of the MDF claim owner. -
RejectedBy: string
Title:
Rejected By
Maximum Length:64
The user who rejected the MDF claim. -
RejectedById: integer
(int64)
Title:
Rejected by ID
The unique identifier of the user who rejected the MDF claim. -
RejectedDate: string
(date)
Title:
Rejected Date
The date when the MDF claim was rejected. -
RejectReasonCode: string
Title:
Reject Reason
The reason code for rejecting the claim. -
ReturnReasonCode: string
Title:
Return Reason
The reason code for returning the claim back to the submitter. -
SubmittedBy: string
Title:
Submitted By
Maximum Length:64
The user who submitted the MDF claim. -
SubmittedById: integer
(int64)
Title:
Submitted by ID
The unique identifier of the user who submitted the MDF claim. -
SubmittedDate: string
(date)
Title:
Submitted Date
The date on which the MDF claim was submitted.
Nested Schema : mdfBudgets-FundRequest-item-patch-request
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. -
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. -
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-item-response
Type:
Show Source
object
-
ActivatedBy: string
Title:
Activated By
Read Only:true
Maximum Length:64
The user who activated the MDF budget. -
ActivatedBy_FN: string
Title:
Activated By
Read Only:true
The name of the user who activated the budget. -
ActivatedById: integer
(int64)
Title:
Activated by ID
The user ID of the user who activated the MDF budget. -
ActivationDate: string
(date)
Title:
Activation Date
Read Only:true
The date on which the MDF budget was activated. -
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
BudgetCode: string
Title:
Code
Maximum Length:100
The unique alternate identifier of the MDF budget. -
BudgetCountries: array
Budget Countries
Title:
Budget Countries
The budget countries resource is used to view, create, and update the list of partner countries to which budget can be allocated to. -
BudgetId: integer
(int64)
Title:
Budget ID
The unique identifier of the MDF budget. -
BudgetName: string
Title:
Name
Maximum Length:250
The display name for the MDF budget. -
BudgetNote: array
Notes
Title:
Notes
The note resource is used to capture comments, information, or instructions for an MDF budget. -
BudgetTeam: array
MDF Budget Teams
Title:
MDF Budget Teams
The MDF budget team resource is used to view, create, and update MDF budget team members. A budget team member is a resource who is assigned to the MDF budget team and who has the appropriate visibility and access to the MDF budget record. -
BudgetType: string
Title:
Type
Maximum Length:30
The type of MDF budget. -
BudgetTypeMeaning: string
Title:
Type
Read Only:true
The budget type of the MDF budget. -
CategoryCode: string
Title:
Category
Maximum Length:30
The category of the MDF budget. -
CategoryCodeMeaning: string
Title:
Category
Read Only:true
The category of the MDF budget. -
Claim: array
Claims
Title:
Claims
The claim resource is used to view, create, and update a claim. A claim is a request for reimbursement of marketing expenses submitted by a partner. -
ConversionCurrencyCode: string
Title:
Conversion Currency Code
Read Only:true
Maximum Length:30
The currency code used for conversion in the MDF budget. -
ConversionRateType: string
Title:
Conversion Rate Type
Read Only:true
Maximum Length:30
The rate type applied against the MDF budget currency. -
ConvExchangeRate: number
Title:
Conversion Exchange Rate
The currency exchange rate for the MDF budget against the corporate currency. -
Country: string
Title:
Country
Maximum Length:2
The country value used to categorize MDF budgets by geographical countries. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the MDF budget. -
CreatedBy_FN: string
Title:
Created By
Read Only:true
The name of the user who created the MDF budget. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the MDF budget was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:30
The currency used of the MDF budgeted amount. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the MDF budget record can be deleted. -
Description: string
Title:
Description
Maximum Length:4000
The description of the MDF budget. -
EndDate: string
(date)
Title:
End Date
The end date for the MDF budget. -
FundRequest: array
Fund Requests
Title:
Fund Requests
The fund request resource is used view, create, and update fund requests. A fund request is a request for a portion of the budget to be allocated towards execution of certain marketing activities. -
InactivatedBy: string
Title:
Inactivated By
Read Only:true
Maximum Length:64
The user who inactivated the MDF budget. -
InactivatedById: integer
(int64)
Title:
Inactivated by ID
The user ID of the user who inactivated the MDF budget. -
InactivationDate: string
(date)
Title:
Inactivation Date
Read Only:true
The date on which the MDF budget was or will be inactivated. -
InitialBudgetAmount: number
Title:
Initial Amount
The original or initial MDF budget amount. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the MDF budget was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the MDF budget. -
LastUpdatedBy_FN: string
Title:
Last Updated By
Read Only:true
The name of the user who last updated the MDF budget. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the MDF budget. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumberClaimsPendingApproval: number
Title:
Pending MDF Claim Count
Read Only:true
Default Value:0
The number of claims pending approval. -
NumberFundRequestPendingApproval: number
Title:
Pending MDF Request Count
Read Only:true
Default Value:0
The number of fund requests pending approval. -
OwnerId: integer
(int64)
Title:
Owner ID
The resource who manages the MDF budget. -
OwnerNameTrans: string
Title:
Owner
Maximum Length:360
The owner name of the MDF budget. -
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. -
PartnerId: integer
(int64)
Title:
Partner ID
The unique identifier of the partner company that the MDF budget is assigned to. -
PartnerNameTrans: string
Title:
Partner
Maximum Length:360
The partner name of the MDF budget. -
RecordSet: string
Title:
Record Set
Read Only:true
The record set values for MDF budget. -
StartDate: string
(date)
Title:
Start Date
The start date of the MDF budget. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The activation status of the MDF budget. -
StatusMeaning: string
Title:
Status
Read Only:true
The status value of the MDF budget. -
SubmitClaimsBy: string
(date)
Title:
Claim Deadline
The last date on which a MDF budget claim will be accepted for reimbursement. -
SubmitFundRequestBy: string
(date)
Title:
Request Deadline
The last date on which a MDF budget fund request will be accepted. -
TotalApprovedClaimAmount: number
Title:
Approved MDF Claims
Read Only:true
Default Value:0
The total amount of approved claims for expense reimbursements against the MDF budget. -
TotalApprovedRequestAmount: number
Title:
Approved MDF Requests
Read Only:true
Default Value:0
The total approved fund requests for a MDF budget. -
TotalAvailableBudgetAmount: number
Title:
Available Budget
Read Only:true
The MDF budget amount available for fund requests and claims. -
TotalBudgetAmount: number
Title:
Total Budget
Default Value:0
The total MDF budget amount based on the initial MDF budget along with adjustments. -
TotalClaimAmount: number
Title:
Submitted Claims
Read Only:true
Default Value:0
The total amount of MDF budget claims for reimbursement that are submitted, pending approval, approved, or rejected. -
TotalClaimSettledAmount: number
Title:
Total Settled Claims
Read Only:true
Default Value:0
The total amount of MDF budget claims for reimbursement that are financially settled. -
TotalOutstandingClaimLiabilityAmount: number
Title:
Total Outstanding Claims
Read Only:true
Default Value:0
The total amount of MDF budget claims for reimbursement that are approved but not settled. -
TotalPendingClaimAmount: number
Title:
Pending MDF Claim Amount
Read Only:true
Default Value:0
The total amount of claims that are submitted or pending approval. -
TotalPendingFundRequestAmount: number
Title:
Pending MDF Request Amount
Read Only:true
Default Value:0
The total amount of fund requests that are submitted or pending approval. -
TotalRejectedClaimAmount: number
Title:
Rejected MDF Claims
Read Only:true
Default Value:0
The total amount of claims for reimbursement that are rejected. -
TotalRejectedFundRequestAmount: number
Title:
Rejected Fund Requests
Read Only:true
Default Value:0
The total amount of fund requests that are rejected. -
TotalRequestedAmount: number
Title:
Total Requests
Read Only:true
Default Value:0
The total amount from all fund requests that are submitted, pending approval, approved, or rejected. -
TotalUnclaimedFundRequestAmount: number
Title:
Total Unclaimed Requests
Read Only:true
Default Value:0
The total approved fund requests less the total approved claims. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Indicates whether the budget can be updated.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Budget Countries
Type:
array
Title:
Budget Countries
The budget countries resource is used to view, create, and update the list of partner countries to which budget can be allocated to.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
The note resource is used to capture comments, information, or instructions for an MDF budget.
Show Source
Nested Schema : MDF Budget Teams
Type:
array
Title:
MDF Budget Teams
The MDF budget team resource is used to view, create, and update MDF budget team members. A budget team member is a resource who is assigned to the MDF budget team and who has the appropriate visibility and access to the MDF budget record.
Show Source
Nested Schema : Claims
Type:
array
Title:
Claims
The claim resource is used to view, create, and update a claim. A claim is a request for reimbursement of marketing expenses submitted by a partner.
Show Source
Nested Schema : Fund Requests
Type:
array
Title:
Fund Requests
The fund request resource is used view, create, and update fund requests. A fund request is a request for a portion of the budget to be allocated towards execution of certain marketing activities.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : mdfBudgets-Attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
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.
Nested Schema : mdfBudgets-BudgetCountries-item-response
Type:
Show Source
object
-
BudgetCountryId: integer
(int64)
Read Only:
true
The unique identifier of the MDF budget country. -
BudgetId: integer
(int64)
Title:
Budget ID
Read Only:true
The unique identifier of the budget. -
CountryCode: string
Maximum Length:
2
The country code associated to of MDF budget. -
CountryName: string
Title:
Territory Name
Read Only:true
Maximum Length:80
The country associated to of MDF budget. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the MDF budget country. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the MDF budget country was created. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the note was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the MDF budget country. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TerritoryCode: string
Title:
Territory Code
Read Only:true
Maximum Length:2
The unique territory code of the country associated to MDF budget.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : mdfBudgets-BudgetNote-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the relationship when the note is associated with a MDF budget user. -
CorpCurrencyCode: string
Title:
Corporate Currency Code
Maximum Length:15
The corporate currency code of the note associated with the MDF budget A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the note record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the note record was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique identifier of the party who created the note. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the note A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the note A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the note is to be deleted If the value is Y, then the note has to be deleted The default value is N. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The email address of the user who created the note. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
The address of the user who created the note. -
FormattedPhoneNumber: string
Title:
Primary Phone
Read Only:true
The phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the note data was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note ID
Read Only:true
The unique identifier of the note associated with the MDF budget. -
NoteNumber: string
Maximum Length:
30
The alternate unique identifier of the note. A user key that's system generated or from an external system. -
NoteTitle: string
Title:
Title
Maximum Length:500
The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
The actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
The code to categorize notes. -
ParentNoteId: integer
(int64)
Title:
Parent Note ID
The unique identifier of the parent note. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier of the MDF budget to which the note is associated. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
The name of the party associated with the MDF budget. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
The code of the source object as defined in OBJECTS metadata. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The unique identifier of the source object as defined in OBJECTS metadata. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Indicates whether the note can be updated If the value is Y, then the note can be updated The default value is N. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
The visibility level of the note.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : mdfBudgets-BudgetTeam-item-response
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Access
Maximum Length:30
The access level code of the resource on the MDF budget team. -
BudgetCode: string
Title:
Code
Maximum Length:100
Public Unique Identifier for the marketing Budget. -
BudgetId: integer
(int64)
Title:
Budget ID
The unique alternate identifier of the MDF budget. -
BudgetTeamId: integer
(int64)
Title:
Budget Team ID
The unique identifier of the resource on the MDF budget team. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the resource on the MDF budget team. -
CreationDate: string
(date-time)
Title:
Membership Date
Read Only:true
The date when the resource on the MDF budget team was created. -
EmailAddress1: string
Title:
Email
Read Only:true
Maximum Length:320
The e-mail address of the MDF budget team member associated with the MDF budget. -
FormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the MDF budget team member associated with the MDF budget. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the MDF budget was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The name of the user who last updated the MDF budget. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the MDF budget. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnerFlag: boolean
Title:
Owner
Read Only:true
Indicates if the MDF budget team member is the owner of the MDF budget. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
The party name of the MDF budget team member associated with the MDF budget. -
PhoneNumber: string
Title:
Phone
The phone number of the team member associated with the MDF budget. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the team member associated with the MDF budget. -
ResourcePartyNumber: string
Title:
Resource Party Number
Read Only:true
Maximum Length:30
Public Unique Identifier for the Resource. -
UserFunction: string
Title:
Function
Read Only:true
The function display name of the team member associated with the MDF budget. -
UserFunctionCode: string
Title:
Function
Maximum Length:30
The function code of the MDF budget team member.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : mdfBudgets-Claim-item-response
Type:
Show Source
object
-
ActivityOutcome: string
Title:
Activity Outcome
Maximum Length:1000
Partner Activity Out come. -
Age: number
Title:
Claim Age
Read Only:true
The number of days since the creation of the MDF claim. -
ApprovalActionComments: string
Title:
Approver Comments
The comments entered during approval action on the claim. -
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 claim. -
ApprovedBy: string
Title:
Approvers
Maximum Length:64
The user who approved the MDF claim. -
ApprovedById: integer
(int64)
Title:
Approved by ID
The unique identifier of the user who approved the MDF claim. -
ApprovedDate: string
(date)
Title:
Approved Date
The date on which the MDF claim was approved. -
BgtExchangeRate: number
Title:
Conversion Rate to Budget
Default Value:0
The exchange rate of the MDF budget which is associated with the claim. MDF budget is associated to the claim through fund request. -
BudgetCurrency: string
Title:
Budget Currency
Read Only:true
Maximum Length:30
The currency used for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request. -
BudgetEndDate: string
(date)
Title:
Budget End Date
Read Only:true
The start date for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request. -
BudgetName: string
Title:
Budget
Maximum Length:250
The display name of the marketing budget associated to the MDF claim. -
BudgetStartDate: string
(date)
Title:
Start Date
Read Only:true
The end date for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request. -
CanApprove: boolean
Title:
Can Approve
Read Only:true
Indicates whether the user can approve the MDF Claim. If the user has access to approve an MDF claim, then the default value is true, else false. -
CanReject: boolean
Title:
Can Reject
Read Only:true
Indicates whether the user has access to reject the claim. -
CanReturn: boolean
Title:
Can Return
Read Only:true
Indicates whether the user has access to return the claim. -
CanSubmit: boolean
Title:
Can Submit
Read Only:true
Indicates whether the user has access to submit the claim. -
CanTerminate: boolean
Title:
Can Terminate
Read Only:true
Indicates whether the user has access to terminate the claim. -
CanWithdraw: boolean
Title:
Can Withdraw
Read Only:true
Indicates whether the user has access to withdraw the claim. -
ChannelManagerId: integer
(int64)
Title:
Account Director ID
Read Only:true
The unique identifier of the partner owner associated to the claim. -
ChannelMgrName: string
Title:
Channel Manager
The name of the channel manager of the claim. -
ClaimAmount: number
Title:
Requested Amount
The amount submitted for the MDF claim. -
ClaimCode: string
Title:
Code
Maximum Length:100
The unique alternate identifier of the MDF claim. -
ClaimId: integer
(int64)
Title:
Claim ID
The unique identifier of the MDF claim. -
ClaimName: string
Title:
Name
Maximum Length:250
The display name of the MDF claim. -
ClaimStatusCode: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The status code of the MDF claim. -
Comments: string
Title:
Comments
Maximum Length:1000
The additional comments for the MDF claim. -
ConversionCurrencyCode: string
Title:
Conversion Currency Code
Read Only:true
Maximum Length:30
The currency code used for conversion in the claim. -
ConversionRateType: string
Title:
Conversion Rate Type
Read Only:true
Maximum Length:30
The conversion rate type used for the MDF claim. -
ConvExchangeRate: number
Title:
Conversion Exchange Rate
The currency exchange rate for the claim against the corporate currency. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the MDF claim. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date on which the MDF claim was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:30
The ISO currency code entered for the MDF claim amount. -
CurrencyConversionDate: string
(date)
Title:
Currency Conversion Date
The date of currency exchange rate for the claim against the corporate currency. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the user has access to delete the record. -
Description: string
Title:
Description
Maximum Length:4000
The description for the MDF claim. -
FrExchangeRate: number
Title:
Fund Request Exchange Rate
Default Value:0
The currency exchange rate for the claim against the fund request currency. -
FundRequestApprovedAmount: number
Title:
MDF Request Approved Amount
Read Only:true
The approved amount of the fund request associated with the claim. -
FundRequestCode: string
Title:
Fund Request Code
Maximum Length:100
Public Unique Identifier for the marketing fund request. -
FundRequestCurrency: string
Title:
Currency
Read Only:true
Maximum Length:30
The currency code used for the fund request associated with the claim. -
FundRequestId: integer
(int64)
Title:
Fund Request ID
The MDF fund request associated to the MDF claim. -
FundRequestName: string
Title:
MDF Request
Maximum Length:250
The name of the fund request associated with the claim. -
FundRequestType: string
Title:
MDF Request Type
Read Only:true
Maximum Length:30
The type of the fund request associated with the claim. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the claim was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the marketing budget. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the claim. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OutstngClaimLiabilityAmount: number
Title:
Liability Amount
Default Value:0
The outstanding claim liability amount that is pending for the budget claim. -
OwnerEmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The e-mail address of the owner of the claim. -
OwnerFormattedPhoneNumber: string
Title:
Phone
Read Only:true
The formatted phone number of the owner of the claim. -
OwnerId: integer
(int64)
Title:
Owner ID
The unique identifier of the user who owns the MDF claim. -
OwnerName: string
Title:
Owner
Maximum Length:360
The name of the MDF claim owner. -
OwnerPartyNumber: string
Title:
Owner Party Number
Read Only:true
Maximum Length:30
Public Unique Identifier for the Resource. -
OwnerPrimaryPhoneNumber: string
Title:
Phone
Read Only:true
Maximum Length:40
The primary phone number of the owner of the claim. -
PartnerPartyUniqueName: string
Title:
Partner
Read Only:true
Maximum Length:360
The name of the partner associated with the claim. -
RecordSet: string
Title:
Record Set
Read Only:true
The record set values of the claim. -
RejectedBy: string
Title:
Rejected By
Maximum Length:64
The user who rejected the MDF claim. -
RejectedById: integer
(int64)
Title:
Rejected by ID
The unique identifier of the user who rejected the MDF claim. -
RejectedDate: string
(date)
Title:
Rejected Date
The date when the MDF claim was rejected. -
RejectReasonCode: string
Title:
Reject Reason
The reason code for rejecting the claim. -
ReturnReasonCode: string
Title:
Return Reason
The reason code for returning the claim back to the submitter. -
SubmitClaimsBy: string
(date)
Title:
Claim Deadline
Read Only:true
The date by which claim needs to be submitted. -
SubmittedBy: string
Title:
Submitted By
Maximum Length:64
The user who submitted the MDF claim. -
SubmittedById: integer
(int64)
Title:
Submitted by ID
The unique identifier of the user who submitted the MDF claim. -
SubmittedDate: string
(date)
Title:
Submitted Date
The date on which the MDF claim was submitted. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Indicates whether the user has access to update the record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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
Links
- Attachments
-
Parameters:
- BudgetCode:
$request.path.BudgetCode
The attachments resource is used to view, create, and update attachments. - BudgetCode:
- BudgetCountries
-
Parameters:
- BudgetCode:
$request.path.BudgetCode
The budget countries resource is used to view, create, and update the list of partner countries to which budget can be allocated to. - BudgetCode:
- BudgetCurrencyPVOVA
-
The list of values to indicate the default currency used by the MDF budget, such as USD or GBP.
The following properties are defined on the LOV link relation:- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode
- BudgetNote
-
Parameters:
- BudgetCode:
$request.path.BudgetCode
The note resource is used to capture comments, information, or instructions for an MDF budget. - BudgetCode:
- BudgetStatusLOVVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKT_MDF_BUDGET_STATUS%2CBindLookupCode%3D{StatusCode}
The list of values to indicate the budget status for the MDF budget.
The following properties are defined on the LOV link relation:- Source Attribute: StatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- BudgetTeam
-
Parameters:
- BudgetCode:
$request.path.BudgetCode
The MDF budget team resource is used to view, create, and update MDF budget team members. A budget team member is a resource who is assigned to the MDF budget team and who has the appropriate visibility and access to the MDF budget record. - BudgetCode:
- BudgetTypeLOVVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_MDFBUDGET_TYPE%2CBindLookupCode%3D{BudgetType}
The list of values to indicate the budget types for the MDF budget.
The following properties are defined on the LOV link relation:- Source Attribute: BudgetType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CategoryLOVVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_MDFBUDGET_CAT%2CBindLookupCode%3D{CategoryCode}
The list of values to indicate the categories for the MDF budget.
The following properties are defined on the LOV link relation:- Source Attribute: CategoryCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- Claim
-
Parameters:
- BudgetCode:
$request.path.BudgetCode
The claim resource is used to view, create, and update a claim. A claim is a request for reimbursement of marketing expenses submitted by a partner. - BudgetCode:
- FundRequest
-
Parameters:
- BudgetCode:
$request.path.BudgetCode
The fund request resource is used view, create, and update fund requests. A fund request is a request for a portion of the budget to be allocated towards execution of certain marketing activities. - BudgetCode:
- PartnerPickerVA
-
The list of values to indicate the partner name.
The following properties are defined on the LOV link relation:- Source Attribute: PartnerNameTrans; Target Attribute: PartyName
- Display Attribute: PartyName
- RecordSetVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_MDF_BUDGET_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:
- ResourceVOVA
-
Operation: /crmRestApi/resources/11.13.18.05/resourcesThe list of values to indicate the owner name.
The following properties are defined on the LOV link relation:- Source Attribute: OwnerNameTrans; Target Attribute: PartyName
- Display Attribute: PartyName