1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. MDF Requests

Create an MDF request

post

/crmRestApi/resources/11.13.18.05/mdfRequests

Request

Header Parameters
  • 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".
  • 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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: End Date
    The date when the activity ends.
  • Title: Start Date
    The date when the activity starts.
  • Title: Approver Comments
    The comments of the claim approver on a request.
  • Title: Status
    The code indicating the approval action that can be taken in the MDF request. The accepted values are Approve, Reject, Return, Withdraw, Terminate, and HtOutcmeReturnReturnAction.
  • Title: Approved Amount
    Default Value: 0
    The amount approved for the MDF.
  • Title: Approved Percent
    Default Value: 100
    The approved MDF amount in percentage.
  • Title: Approved By
    Maximum Length: 64
    The person who approved the MDF request.
  • Title: Approved by ID
    The unique identifier of the person who approved the MDF request.
  • Title: Approved Date
    The date on which the MDF request was approved.
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Title: Budget Exchange Rate
    Default Value: 0
    The exchange rate between an MDF Request and an MDF Budget currency. This value is set at the time of budget selection on the MDF request.
  • Title: Budget ID
    The unique identifier of the budget associated with the MDF request.
  • Title: Budget
    The name of the budget prescribed for allocation of funds to an MDF request.
  • Claims
    Title: Claims
    The claims resource is used to create, view, create, update, and delete claims. A claim is a request for reimbursement of marketing expenses submitted by a partner.
  • Title: Comments
    Maximum Length: 1000
    The additional comments on the MDF request.
  • 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. You can review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Description
    Maximum Length: 4000
    A brief description for the MDF request.
  • Fund Request Approval Histories
    Title: Fund Request Approval Histories
    The fund request approval history lets you access a comprehensive record of approval-related information associated with the fund request, encompassing the names of approvers, action dates, and the specific actions taken.
  • Title: Code
    Maximum Length: 100
    The code indicating the user-defined, unique label for the MDF request.
  • Title: Fund Request ID
    The unique identifier of the MDF request. This is a system generated value.
  • Title: Name
    Maximum Length: 250
    The display name of the MDF request.
  • MDF Request Teams
    Title: MDF Request Teams
    The Fund Request Teams resource is used to view, create, update, and delete a team member. An MDF request team member is a resource who is assigned to the MDF request team, and has the appropriate visibility and access to the MDF Request record.
  • Title: Status
    Maximum Length: 30
    Default Value: DRAFT
    The code indicating the status of the MDF request. A list of valid values are defined in the lookup FundRequestStatusCode. The valid values can be Approved, Draft, Failed, Pending Approval, Rejected, Returned, Terminated, or Withdrawn.
  • Title: Type
    Maximum Length: 30
    The type of MDF request, for example, Advertising, Customer Event, Demand Generation, Training, or Other. A list of valid values is defined in the lookup FundRequestType.
  • Title: Justification
    Maximum Length: 1000
    The justification provided for submitting the MDF request.
  • Notes
    Title: Notes
    The note resource is used to view, create, update, and delete notes associated with an MDF request. A note captures comments, information, or instructions related to an MDF request.
  • Title: Owner ID
    The unique identifier of the owner of MDF request.
  • Title: Owner
    Maximum Length: 360
    The name of the owner of the MDF request.
  • Title: Partner Company Number
    Maximum Length: 30
    Public Unique Identifier for the Partner.
  • Title: Partner ID
    The unique identifier of the partner account associated with the MDF request.
  • Title: Partner
    Maximum Length: 360
    The name of the partner account associated with the MDF request.
  • Title: Rejected By
    Maximum Length: 64
    The user who rejected the MDF request.
  • Title: Rejected by ID
    The unique identifier of the person who rejected the request.
  • Title: Rejected Date
    The date when the MDF request was rejected.
  • Title: Reject Reason
    The code indicating the reason the claim approver rejected the request. A list of valid values is defined in the lookup ReturnReasonCode. The valid values are Ineligible Activity, Ineligible Amount, or Other.
  • Title: Requested Amount
    The amount requested on the MDF claim.
  • Title: Status
    The status of the MDF request.
  • Title: Return Reason
    The code indicating the reason the claim approver returned the request. A list of valid values is defined in the lookup ReturnReasonCode. The valid values are Need Additional Information, or Other.
  • Smart Actions
    Title: Smart Actions
    This VO stores the endpoint and security details for every user action.
  • Title: Request Deadline
    The last day a budget can be associated with an MDF request.
  • Title: Submitted By
    Maximum Length: 64
    The user who submitted the MDF request.
  • Title: Submitted by ID
    The unique identifier of the person who submitted the request.
  • Title: Submitted Date
    The date when the MDF request was submitted.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Claims
Type: array
Title: Claims
The claims resource is used to create, view, create, update, and delete claims. A claim is a request for reimbursement of marketing expenses submitted by a partner.
Show Source
Nested Schema : Fund Request Approval Histories
Type: array
Title: Fund Request Approval Histories
The fund request approval history lets you access a comprehensive record of approval-related information associated with the fund request, encompassing the names of approvers, action dates, and the specific actions taken.
Show Source
Nested Schema : MDF Request Teams
Type: array
Title: MDF Request Teams
The Fund Request Teams resource is used to view, create, update, and delete a team member. An MDF request team member is a resource who is assigned to the MDF request team, and has the appropriate visibility and access to the MDF Request record.
Show Source
Nested Schema : Notes
Type: array
Title: Notes
The note resource is used to view, create, update, and delete notes associated with an MDF request. A note captures comments, information, or instructions related to an MDF request.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : mdfRequests-FundRequestApprovalHistory-item-post-request
Type: object
Show Source
Nested Schema : mdfRequests-FundRequestResource-item-post-request
Type: object
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : mdfRequests-FundRequestResource-smartActions-item-post-request
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : mdfRequests-FundRequestResource-smartActions-UserActionNavigation-item-post-request
Type: object
Show Source
Nested Schema : mdfRequests-FundRequestResource-smartActions-UserActionRequestPayload-item-post-request
Type: object
Show Source
Nested Schema : mdfRequests-FundRequestResource-smartActions-UserActionURLBinding-item-post-request
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : schema
Type: object
Show Source
  • Title: Contact Relationship ID
    The unique identifier of the relationship, populated when the note is associated with an MDF request user.
  • Title: Corporate Currency Code
    Maximum Length: 15
    The corporate currency code of the note associated with the MDF request. 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.
  • Title: Creator Party ID
    The unique identifier of the party that created the note.
  • 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.
  • 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.
  • Maximum Length: 30
    The alternate unique identifier of the note. A user key that's system generated or from an external system.
  • Title: Title
    Maximum Length: 500
    The title of the note entered by the user.
  • Title: Note
    The column which will store the actual note text.
  • Title: Type
    Maximum Length: 30
    The code indicating the type of the note.
  • Title: Parent Note ID
    The unique identifier of the parent note.
  • Smart Actions
    Title: Smart Actions
    This VO stores the endpoint and security details for every user action.
  • Title: Related Object Type
    Maximum Length: 30
    The code of the source object as defined in OBJECTS Metadata.
  • Title: Related Object
    Maximum Length: 64
    The unique identifier of the source object as defined in OBJECTS Metadata.
  • Title: Source System
    Maximum Length: 30
    This is the source object code for the source object as defined in OBJECTS Metadata.
  • Title: Private
    Maximum Length: 30
    Default Value: INTERNAL
    The code indicating the visibility level of the note, such as internal or external.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : mdfRequests-Note-smartActions-item-post-request
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : mdfRequests-Note-smartActions-UserActionNavigation-item-post-request
Type: object
Show Source
Nested Schema : mdfRequests-Note-smartActions-UserActionRequestPayload-item-post-request
Type: object
Show Source
Nested Schema : mdfRequests-Note-smartActions-UserActionURLBinding-item-post-request
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : mdfRequests-smartActions-item-post-request
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : mdfRequests-smartActions-UserActionNavigation-item-post-request
Type: object
Show Source
Nested Schema : mdfRequests-smartActions-UserActionRequestPayload-item-post-request
Type: object
Show Source
Nested Schema : mdfRequests-smartActions-UserActionURLBinding-item-post-request
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : mdfRequests-item-response
Type: object
Show Source
  • Title: End Date
    The date when the activity ends.
  • Title: Start Date
    The date when the activity starts.
  • Title: Request Age
    Read Only: true
    The number of days since the creation of the MDF request.
  • Title: Approver Comments
    The comments of the claim approver on a request.
  • Title: Status
    The code indicating the approval action that can be taken in the MDF request. The accepted values are Approve, Reject, Return, Withdraw, Terminate, and HtOutcmeReturnReturnAction.
  • Title: Approved Amount
    Default Value: 0
    The amount approved for the MDF.
  • Title: Approved Percent
    Default Value: 100
    The approved MDF amount in percentage.
  • Title: Approved By
    Maximum Length: 64
    The person who approved the MDF request.
  • Title: Approved by ID
    The unique identifier of the person who approved the MDF request.
  • Title: Approved Date
    The date on which the MDF request was approved.
  • Attachments
    Title: Attachments
    The attachments resource is used to view, create, and update attachments.
  • Title: Available Amount
    Read Only: true
    Default Value: 0
    The difference between the total approved MDF requests and the total approved claim amounts, which is available for new claims.
  • Title: Budget Exchange Rate
    Default Value: 0
    The exchange rate between an MDF Request and an MDF Budget currency. This value is set at the time of budget selection on the MDF request.
  • Title: Budget Code
    Read Only: true
    Maximum Length: 100
    Public Unique Identifier for the marketing Budget.
  • Title: Budget Currency
    Read Only: true
    Maximum Length: 30
    The currency code for the MDF budget. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. You can review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Budget End Date
    Read Only: true
    The date when the budget ends.
  • Title: Budget ID
    The unique identifier of the budget associated with the MDF request.
  • Title: Budget
    The name of the budget prescribed for allocation of funds to an MDF request.
  • Title: Budget Start Date
    Read Only: true
    The date when the budget starts.
  • Title: Can Approve
    Read Only: true
    Indicates if the user can approve the MDF request. If the user has access to approve an MDF request, then the default value is true, else false.
  • Title: Can Reject
    Read Only: true
    Indicates if the user can reject the MDF request. If the user has access to reject an MDF request, then the default value is true, else false.
  • Title: Can Return
    Read Only: true
    Indicates if the user can return the MDF request. If the user has access to return an MDF request, then the default value is true, else false.
  • Title: Can Submit
    Read Only: true
    Indicates if the user can submit a claim. If the user has access to submit a claim, then the default value is true, else false.
  • Title: Can Terminate
    Read Only: true
    Indicates if the user can terminate a claim. If the user has access to terminate a claim, then the default value is true, else false.
  • Title: Can Withdraw
    Read Only: true
    Indicates if the user can withdraw the MDF request. If the user has access to withdraw an MDF request, then the default value is true, else false.
  • Title: Channel Manager
    Read Only: true
    Maximum Length: 450
    The channel manager or the partner who own the MDF request.
  • Title: Channel Manager ID
    Read Only: true
    The unique identifier of the channel manager of the MDF request.
  • Claims
    Title: Claims
    The claims resource is used to create, view, create, update, and delete claims. A claim is a request for reimbursement of marketing expenses submitted by a partner.
  • Title: Comments
    Maximum Length: 1000
    The additional comments on the MDF request.
  • Title: Conversion Currency Code
    Read Only: true
    Maximum Length: 30
    The code indicating the CRM corporate currency associated with the MDF request as of the transaction date.
  • Title: Conversion Rate Type
    Read Only: true
    Maximum Length: 30
    The type of currency conversion rate used in processing the MDF request.
  • Title: Conversion Exchange Rate
    Read Only: true
    The exchange rate for converting the claim currency to the standard CRM corporate currency.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the MDF request.
  • Title: Created By
    Read Only: true
    The person who created the MDF request.
  • Title: Creation Date
    Read Only: true
    The date the MDF request was created.
  • 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. You can review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Currency Conversion Date
    Read Only: true
    The date used in Business Intelligence to convert from MDF budget currency to user preferred currency.
  • Title: Delete Indicator
    Read Only: true
    Indicates whether the claim can be deleted. If the user has access to delete the claim then the default value is true, else false.
  • Title: Description
    Maximum Length: 4000
    A brief description for the MDF request.
  • Fund Request Approval Histories
    Title: Fund Request Approval Histories
    The fund request approval history lets you access a comprehensive record of approval-related information associated with the fund request, encompassing the names of approvers, action dates, and the specific actions taken.
  • Title: Code
    Maximum Length: 100
    The code indicating the user-defined, unique label for the MDF request.
  • Title: Fund Request ID
    The unique identifier of the MDF request. This is a system generated value.
  • Title: Name
    Maximum Length: 250
    The display name of the MDF request.
  • MDF Request Teams
    Title: MDF Request Teams
    The Fund Request Teams resource is used to view, create, update, and delete a team member. An MDF request team member is a resource who is assigned to the MDF request team, and has the appropriate visibility and access to the MDF Request record.
  • Title: Status
    Maximum Length: 30
    Default Value: DRAFT
    The code indicating the status of the MDF request. A list of valid values are defined in the lookup FundRequestStatusCode. The valid values can be Approved, Draft, Failed, Pending Approval, Rejected, Returned, Terminated, or Withdrawn.
  • Title: Type
    Maximum Length: 30
    The type of MDF request, for example, Advertising, Customer Event, Demand Generation, Training, or Other. A list of valid values is defined in the lookup FundRequestType.
  • Title: Justification
    Maximum Length: 1000
    The justification provided for submitting the MDF request.
  • Title: Last Update Date
    Read Only: true
    The date and time when the MDF request was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the MDF request.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the MDF request.
  • Links
  • Read Only: true
    Indicates whether user can modify fund request attributes while the fund request is awaiting approval.
  • Read Only: true
    Indicates whether user can modify fund request attributes when the fund request is either in draft or returned or withdrawn status.
  • Read Only: true
    Indicates that partner users are restricted from modifying the partner field. It indicates whether channel users can update the partner field when the fund request is in draft, return, or withdrawn status.
  • Read Only: true
    Indicates whether the logged in user has full access on the fund request record.
  • Notes
    Title: Notes
    The note resource is used to view, create, update, and delete notes associated with an MDF request. A note captures comments, information, or instructions related to an MDF request.
  • Title: Email
    Read Only: true
    Maximum Length: 320
    The email of the owner of the MDF request.
  • Title: Phone
    Read Only: true
    The phone number of the owner of the claim.
  • Title: Owner ID
    The unique identifier of the owner of MDF request.
  • Title: Owner
    Maximum Length: 360
    The name of the owner of the MDF request.
  • Title: Owner Party Number
    Read Only: true
    Maximum Length: 30
    Public Unique Identifier for the Resource.
  • Title: Partner Company Number
    Maximum Length: 30
    Public Unique Identifier for the Partner.
  • Title: Partner Country
    Read Only: true
    Maximum Length: 2
    The country of the partner associated with the MDF request.
  • Title: Partner ID
    The unique identifier of the partner account associated with the MDF request.
  • Title: Partner
    Maximum Length: 360
    The name of the partner account associated with the MDF request.
  • Title: Partner
    Read Only: true
    Maximum Length: 360
    The name of the partner associated with the MDF request.
  • Title: Record Set
    Read Only: true
    The filter to search for MDF Requests that are visible to the user. The accepted values are ORA_I_OWN, ORA_I_CAN_SEE, and ORA_PENDING_MY_APPROVAL.
  • Title: Rejected By
    Maximum Length: 64
    The user who rejected the MDF request.
  • Title: Rejected by ID
    The unique identifier of the person who rejected the request.
  • Title: Rejected Date
    The date when the MDF request was rejected.
  • Title: Reject Reason
    The code indicating the reason the claim approver rejected the request. A list of valid values is defined in the lookup ReturnReasonCode. The valid values are Ineligible Activity, Ineligible Amount, or Other.
  • Title: Requested Amount
    The amount requested on the MDF claim.
  • Title: Status
    The status of the MDF request.
  • Title: Return Reason
    The code indicating the reason the claim approver returned the request. A list of valid values is defined in the lookup ReturnReasonCode. The valid values are Need Additional Information, or Other.
  • Smart Actions
    Title: Smart Actions
    This VO stores the endpoint and security details for every user action.
  • Title: Claim Deadline
    Read Only: true
    The user who submitted the MDF request.
  • Title: Request Deadline
    The last day a budget can be associated with an MDF request.
  • Title: Submitted By
    Maximum Length: 64
    The user who submitted the MDF request.
  • Title: Submitted by ID
    The unique identifier of the person who submitted the request.
  • Title: Submitted Date
    The date when the MDF request was submitted.
  • Title: Approved Claim Amount
    Read Only: true
    Default Value: 0
    The total amount of all the approved claims of an MDF request.
  • Title: Update Indicator
    Read Only: true
    Indicates whether the claim can be updated. If the user has access to update the claim then the default value is true, else false.
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Claims
Type: array
Title: Claims
The claims resource is used to create, view, create, update, and delete claims. A claim is a request for reimbursement of marketing expenses submitted by a partner.
Show Source
Nested Schema : Fund Request Approval Histories
Type: array
Title: Fund Request Approval Histories
The fund request approval history lets you access a comprehensive record of approval-related information associated with the fund request, encompassing the names of approvers, action dates, and the specific actions taken.
Show Source
Nested Schema : MDF Request Teams
Type: array
Title: MDF Request Teams
The Fund Request Teams resource is used to view, create, update, and delete a team member. An MDF request team member is a resource who is assigned to the MDF request team, and has the appropriate visibility and access to the MDF Request record.
Show Source
Nested Schema : Notes
Type: array
Title: Notes
The note resource is used to view, create, update, and delete notes associated with an MDF request. A note captures comments, information, or instructions related to an MDF request.
Show Source
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : mdfRequests-Attachments-item-response
Type: object
Show Source
Nested Schema : mdfRequests-Claim-item-response
Type: object
Show Source
  • Title: Activity Outcome
    Maximum Length: 1000
    Partner Activity Out come.
  • Title: Claim Age
    Read Only: true
    The number of days since the creation of the claim.
  • Title: Approver Comments
    The comments entered during approval action on the claim.
  • 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.
  • Title: Approved Amount
    Default Value: 0
    The amount approved for the claim.
  • Title: Approvers
    Maximum Length: 64
    The user who approved the MDF claim.
  • Title: Approved by ID
    The unique identifier of the user who approved the MDF claim.
  • Title: Approved Date
    The date when the MDF claim was approved.
  • Title: Conversion Rate to Budget
    Default Value: 0
    The exchange rate of the MDF budget which is associated with the MDF claim. MDF budget is associated to the claim through fund request.
  • Title: Budget Currency
    Read Only: true
    Maximum Length: 30
    The 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.
  • Title: Budget End Date
    Read Only: true
    The date when the budget ends.
  • Title: Budget ID
    The unique identifier of the Budget associated with the MDF claim.
  • Title: Budget
    Maximum Length: 250
    The name of the MDF request budget associated with the MDF claim.
  • Title: Start Date
    Read Only: true
    The date when the budget starts.
  • Title: Can Approve
    Read Only: true
    Indicates 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.
  • Title: Can Reject
    Read Only: true
    Indicates 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.
  • Title: Can Return
    Read Only: true
    Indicates 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.
  • Title: Can Submit
    Read Only: true
    Indicates whether the user has access to submit the claim.
  • Title: Can Terminate
    Read Only: true
    Indicates whether the user has access to terminate the claim.
  • Title: Can Withdraw
    Read Only: true
    Indicates 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.
  • Title: Account Director ID
    Read Only: true
    The unique identifier of the channel manager of the MDF claim.
  • Title: Channel Manager
    The name of the channel manager of the MDF claim.
  • Title: Requested Amount
    The amount requested in the MDF claim.
  • Title: Code
    Maximum Length: 100
    The user-defined or system generated code for the MDF claim.
  • Title: Claim ID
    The unique identifier of the claim. This is a system-generated value.
  • Title: Name
    Maximum Length: 250
    The name of the MDF claim.
  • Title: Status
    Maximum Length: 30
    Default Value: DRAFT
    The 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.
  • Title: Comments
    Maximum Length: 1000
    The additional comments on the MDF claim.
  • Title: Conversion Currency Code
    Read Only: true
    Maximum Length: 30
    The currency code associated with the claim.
  • Title: Conversion Rate Type
    Read Only: true
    Maximum Length: 30
    The currency conversion rate type used to derive the exchange rate between the MDF claim user entered currency and the CRM corporate currency code.
  • Title: Conversion Exchange Rate
    The currency exchange rate for the claim against the corporate currency.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the MDF claim.
  • Title: Creation Date
    Read Only: true
    The date when the MDF claim was created.
  • Title: Currency
    Maximum Length: 30
    The 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.
  • Title: Currency Conversion Date
    The date of currency exchange rate for the claim against the corporate currency.
  • Title: Delete Indicator
    Read Only: true
    Indicates whether the user has access to delete the record.
  • Title: Description
    Maximum Length: 4000
    A brief description of the MDF claim.
  • Title: Fund Request Exchange Rate
    Default Value: 0
    The exchange rate of the fund request associated with the claim.
  • Title: MDF Request Approved Amount
    Read Only: true
    The approved amount of the MDF request against the MDF claim.
  • Title: Fund Request Code
    Maximum Length: 100
    Public Unique Identifier for the marketing fund request.
  • Title: Currency
    Read Only: true
    Maximum Length: 30
    The 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.
  • Title: Fund Request ID
    The unique identifier of the MDF request associated with the MDF claim.
  • Title: MDF Request
    Maximum Length: 250
    The name of the fund request associated with the claim.
  • Title: MDF Request Type
    Read Only: true
    Maximum Length: 30
    The type of the MDF request.
  • Title: Last Update Date
    Read Only: true
    The date when the claim was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the MDF claim.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the claim.
  • Links
  • Read Only: true
    Indicates whether user can modify claim attributes while the claim is awaiting approval.
  • Read Only: true
    Indicates whether user can modify claim attributes when the claim is either in draft or returned or withdrawn status.
  • Read Only: true
    Indicates 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.
  • Read Only: true
    Indicates whether the logged in user has full access on the claim record.
  • Title: Liability Amount
    Default Value: 0
    The approved claim amount pending to be paid.
  • Title: Email
    Read Only: true
    Maximum Length: 320
    The email address of the MDF claim owner.
  • Title: Phone
    Read Only: true
    The formatted phone number of the owner of the claim.
  • Title: Owner ID
    The unique identifier of the owner of the MDF claim.
  • Title: Owner
    Maximum Length: 360
    The name of the MDF claim owner.
  • Title: Owner Party Number
    Read Only: true
    Maximum Length: 30
    Public Unique Identifier for the Resource.
  • Title: Phone
    Read Only: true
    Maximum Length: 40
    The phone number of the owner of the MDF claim.
  • Title: Partner Company Number
    Maximum Length: 30
    Public Unique Identifier for the Partner.
  • Title: Partner ID
    The unique identifier of the partner account associated with the MDF claim.
  • Title: Partner
    Read Only: true
    Maximum Length: 360
    The name of the partner associated with the MDF claim.
  • Title: Record Set
    Read Only: true
    The record set values for claim.
  • Title: Rejected By
    Maximum Length: 64
    The user who rejected the MDF claim.
  • Title: Rejected by ID
    The unique identifier of the user who rejected the MDF claim.
  • Title: Rejected Date
    The date when the MDF claim was rejected.
  • Title: Reject Reason
    The reason code for rejecting the claim.
  • Title: Return Reason
    The reason code for returning the claim back to the submitter.
  • Title: Claim Deadline
    Read Only: true
    The last date to submit a claim against the MDF request.
  • Title: Submitted By
    Maximum Length: 64
    The user who submitted the claim.
  • Title: Submitted by ID
    The unique identifier of the user who submitted the MDF claim.
  • Title: Submitted Date
    The date when the MDF claim was submitted.
  • Title: Update Indicator
    Read Only: true
    Indicates whether the user has access to update the record.
Nested Schema : mdfRequests-FundRequestApprovalHistory-item-response
Type: object
Show Source
  • Read Only: true
    Maximum Length: 255
    User name of the user who has taken the action.
  • Read Only: true
    Maximum Length: 255
    Party name of the user who has taken the action.
  • Read Only: true
    Maximum Length: 255
    Action taken by the user. This will be non-translatable value.
  • Read Only: true
    Date when the action was taken.
  • Read Only: true
    Maximum Length: 255
    User name of the user to whom fund request is assigned.
  • Read Only: true
    Maximum Length: 255
    Party name of the user to whom the fund request is assigned.
  • Read Only: true
    Maximum Length: 255
    Type of assignee. It can be a user or a role.
  • Read Only: true
    Maximum Length: 255
    Comments provided by the user for each action taken. For submit action there won't be any comments.
  • Read Only: true
    Maximum Length: 255
    The unique identifier for which approval history records needs to be shown.
  • Links
  • Read Only: true
    Maximum Length: 255
    Reason provided by the user for any action taken. This is displayed only when the fund request is either rejected or returned.
  • Read Only: true
    Maximum Length: 255
    Version of each row of approval history.
  • Read Only: true
    Maximum Length: 255
    The primary key identifier of the approval history.
Nested Schema : mdfRequests-FundRequestResource-item-response
Type: object
Show Source
  • Title: Access
    Maximum Length: 30
    The code indicating the level of access of the resource in the MDF request team. A list of valid values is defined in the lookup AccessLevelCode. The valid values are View, Edit, or Full.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the resource in the MDF request team.
  • Title: Creation Date
    Read Only: true
    The date when the resource was created in the MDF request team.
  • Title: Email
    Read Only: true
    Maximum Length: 320
    The e-mail address of the MDF Request team member associated with the MDF Request.
  • Title: Phone
    Read Only: true
    The phone number of the MDF Request team member associated with the MDF Request.
  • Title: Code
    Maximum Length: 100
    The public unique identifier for the marketing fund request.
  • Title: Fund Request ID
    The unique identifier of the MDF request associated with the resource. This is a system-generated value.
  • Title: MDF Request Resource ID
    The unique identifier of the resource in the MDF request team. This is a system-generated value.
  • Title: Last Update Date
    Read Only: true
    The date and time when the MDF request team member record was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the MDF request team member record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the MDF request team member record.
  • Links
  • Title: Function
    Maximum Length: 30
    The code indicating the function of the MDF Request team member. A list of valid values is defined in the lookup MemberFunctionCode. The valid values are Channel Account Manager, Channel Sales Manager, Marketing Specialist, Support Specialist, Sales Representative, Sales Manager, or MDF Request Processor.
  • Title: Owner
    Read Only: true
    Indicates whether the MDF Request team member is the owner of the MDF Request. The default value is true.
  • Title: Resource ID
    The unique identifier of the resource.
  • Title: Name
    Read Only: true
    Maximum Length: 360
    The name of the MDF Request team member associated with the MDF Request.
  • Title: Resource Party Number
    Read Only: true
    Maximum Length: 30
    The public unique identifier for the resource.
  • Title: Resource User Name
    Read Only: true
    The login username of the MDF Request team member associated with the MDF Request.
  • Smart Actions
    Title: Smart Actions
    This VO stores the endpoint and security details for every user action.
  • Title: User Last Update Date
    The date when the user last updated the record.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : mdfRequests-FundRequestResource-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : mdfRequests-FundRequestResource-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : mdfRequests-FundRequestResource-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : mdfRequests-FundRequestResource-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : mdfRequests-Note-item-response
Type: object
Show Source
  • Title: Contact Relationship ID
    The unique identifier of the relationship, populated when the note is associated with an MDF request user.
  • Title: Corporate Currency Code
    Maximum Length: 15
    The corporate currency code of the note associated with the MDF request. 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.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the note record.
  • Title: Creation Date
    Read Only: true
    The date and time when the note record was created.
  • Title: Creator Party ID
    The unique identifier of the party that created the note.
  • 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.
  • 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.
  • 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.
  • Read Only: true
    Maximum Length: 320
    The email address of the user who created the notes.
  • Read Only: true
    The primary address of the user who created the notes.
  • Read Only: true
    The primary phone number of the user who created the notes.
  • Title: Last Update Date
    Read Only: true
    The date and time when the note data was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the record.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the record.
  • Links
  • Title: Note ID
    Read Only: true
    The unique identifier of the note associated with the MDF request This is the primary key of the notes table.
  • Maximum Length: 30
    The alternate unique identifier of the note. A user key that's system generated or from an external system.
  • Title: Title
    Maximum Length: 500
    The title of the note entered by the user.
  • Title: Note
    The column which will store the actual note text.
  • Title: Type
    Maximum Length: 30
    The code indicating the type of the note.
  • Title: Parent Note ID
    The unique identifier of the parent note.
  • Read Only: true
    The unique identifier of the MDF Request to which the note is associated.
  • Title: Author
    Read Only: true
    Maximum Length: 360
    The name of an MDF Request party.
  • Smart Actions
    Title: Smart Actions
    This VO stores the endpoint and security details for every user action.
  • Title: Related Object Type
    Maximum Length: 30
    The code of the source object as defined in OBJECTS Metadata.
  • Title: Related Object
    Maximum Length: 64
    The unique identifier of the source object as defined in OBJECTS Metadata.
  • Title: Source System
    Maximum Length: 30
    This is the source object code for the source object as defined in OBJECTS Metadata.
  • 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.
  • Title: Private
    Maximum Length: 30
    Default Value: INTERNAL
    The code indicating the visibility level of the note, such as internal or external.
Nested Schema : Smart Actions
Type: array
Title: Smart Actions
This VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : mdfRequests-Note-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : mdfRequests-Note-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : mdfRequests-Note-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : mdfRequests-Note-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : mdfRequests-smartActions-item-response
Type: object
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
UI navigation metadata striped by app usage.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type: array
Title: Smart Action REST Payload Definitions
If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type: array
Title: Smart Action User Interface Definitions
Binding metadata for a variable in the URL.
Show Source
Nested Schema : mdfRequests-smartActions-UserActionNavigation-item-response
Type: object
Show Source
Nested Schema : mdfRequests-smartActions-UserActionRequestPayload-item-response
Type: object
Show Source
Nested Schema : mdfRequests-smartActions-UserActionURLBinding-item-response
Type: object
Show Source
  • Title: URL Binding Type
    Maximum Length: 64
    This is a hint for processing the Url Binding runtime.
  • Links
  • Title: System Action
    Maximum Length: 1
    Default Value: false
    Boolean indicator.
  • Uniquely identifies the URL Bind for smart actions. For internal use.
  • Title: URL Binding Parameter Name
    Maximum Length: 256
    For action REST endpoints that require runtime binding, this is the key in the key value pair.
  • Title: URL Binding Parameter Value
    Maximum Length: 1000
    For action REST endpoints that require runtime binding, this is the value in the key value pair.
Links
Attachments
Parameters:
  • FundRequestCode: $request.path.FundRequestCode
The attachments resource is used to view, create, and update attachments.
BudgetLOVVA
Parameters:
  • finder: MdfRestActiveBudgetFinder%3BbindStatus%3DACTIVE
A marketing budget contains details pertaining to monetary incentives for partners to execute marketing activities.
Claim
Parameters:
  • FundRequestCode: $request.path.FundRequestCode
The claims resource is used to create, view, create, update, and delete claims. A claim is a request for reimbursement of marketing expenses submitted by a partner.
CurrencyPVA
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.
FundRequestApprovalHistory
Parameters:
  • FundRequestCode: $request.path.FundRequestCode
The fund request approval history lets you access a comprehensive record of approval-related information associated with the fund request, encompassing the names of approvers, action dates, and the specific actions taken.
FundRequestPartnerPartySearchVA
The partner list of values resource is used to view a list of partners.
FundRequestResource
Parameters:
  • FundRequestCode: $request.path.FundRequestCode
The Fund Request Teams resource is used to view, create, update, and delete a team member. An MDF request team member is a resource who is assigned to the MDF request team, and has the appropriate visibility and access to the MDF Request record.
FundRequestTypeLOVVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_MDFREQUEST_TYPE%2CBindLookupCode%3D{FundRequestType}
The lookups resource is used to view standard lookup codes.
Note
Parameters:
  • FundRequestCode: $request.path.FundRequestCode
The note resource is used to view, create, update, and delete notes associated with an MDF request. A note captures comments, information, or instructions related to an MDF request.
RecordSetVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_MDF_RECORD_SET%2CBindLookupCode%3D{RecordSet}
The lookups resource is used to view standard lookup codes.
RejectReasonCodeVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{RejectReasonCode}%2CBindLookupType%3DORA_MKT_MDFREQUEST_REJECT
The lookups resource is used to view standard lookup codes.
RequestStatusLOVVA
Parameters:
  • finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKT_MDF_FUNDREQ_STATUS%2CBindLookupCode%3D{FundRequestStatusCode}
The lookups resource is used to view standard lookup codes.
ResourceVOVA
A 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_MDFREQUEST_RETURN
The lookups resource is used to view standard lookup codes.
smartActions
Parameters:
  • FundRequestCode: $request.path.FundRequestCode
This VO stores the endpoint and security details for every user action.
Back to Top