Get all MDF requests
get
/crmRestApi/resources/11.13.18.05/mdfRequests
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- FundRequestVOAltKey: Finds an MDFRequest with the specified alternate key.
Finder Variables:- FundRequestCode; string; The alternate key identifier of the MDF request.
- MdfRequestsRestFinder: Finds the set of MDF request which can be associated with a claim.
Finder Variables:- bindBudgetId; integer; The unique identifier of the MDF budget associated with the request.
- bindStatus_1; string; The status of the MDF request.
- bindStatus_2; string; The status of the MDF request.
- bindSysDate; string; The deadline for the MDF claim.
- PrimaryKey: Finds an MDF request with the specified primary key.
Finder Variables:- FundRequestId; integer; The unique identifier of the MDF request.
- FundRequestVOAltKey: Finds an MDFRequest with the specified alternate key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ApprovedAmount; number; The amount approved for the MDF.
- ApprovedAmountPercent; number; The approved MDF amount in percentage.
- ApprovedBy; string; The person who approved the MDF request.
- ApprovedById; integer; The unique identifier of the person who approved the MDF request.
- ApprovedDate; string; The date on which the MDF request was approved.
- AvailableFundRequestAmount; number; The difference between the total approved MDF requests and the total approved claim amounts, which is available for new claims.
- BudgetCode; string; Public Unique Identifier for the marketing Budget.
- BudgetEndDate; string; The date when the budget ends.
- BudgetId; integer; The unique identifier of the budget associated with the MDF request.
- BudgetName; string; The name of the budget prescribed for allocation of funds to an MDF request.
- BudgetStartDate; string; The date when the budget starts.
- ChannelManager; string; The channel manager or the partner who own the MDF request.
- ChannelManagerId; integer; The unique identifier of the channel manager of the MDF request.
- CreatedBy; string; The user who created the MDF request.
- CurrencyCode; string; 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.
- FundRequestCode; string; The code indicating the user-defined, unique label for the MDF request.
- FundRequestId; integer; The unique identifier of the MDF request. This is a system generated value.
- FundRequestName; string; The display name of the MDF request.
- FundRequestStatusCode; string; 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.
- FundRequestType; string; 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.
- Justification; string; The justification provided for submitting the MDF request.
- LastUpdateDate; string; The date and time when the MDF request was last updated.
- LastUpdatedBy; string; The user who last updated the MDF request.
- OwnerId; integer; The unique identifier of the owner of MDF request.
- OwnerPartyNumber; string; Public Unique Identifier for the Resource.
- PartnerCompanyNumber; string; Public Unique Identifier for the Partner.
- PartnerCountry; string; The country of the partner associated with the MDF request.
- PartnerId; integer; The unique identifier of the partner account associated with the MDF request.
- PartnerPartyUniqueName; string; The name of the partner associated with the MDF request.
- RecordSet; string; 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.
- RejectedBy; string; The user who rejected the MDF request.
- RejectedById; integer; The unique identifier of the person who rejected the request.
- RejectedDate; string; The date when the MDF request was rejected.
- RequestedAmount; number; The amount requested on the MDF claim.
- SubmitClaimsBy; string; The user who submitted the MDF request.
- SubmitFundReqBy; string; The last day a budget can be associated with an MDF request.
- SubmittedBy; string; The user who submitted the MDF request.
- SubmittedById; integer; The unique identifier of the person who submitted the request.
- SubmittedDate; string; The date when the MDF request was submitted.
- TotalApprovedClaimAmount; number; The total amount of all the approved claims of an MDF request.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : mdfRequests
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : mdfRequests-item-response
Type:
Show Source
object
-
ActivityEndDate: string
(date)
Title:
End Date
The date when the activity ends. -
ActivityStartDate: string
(date)
Title:
Start Date
The date when the activity starts. -
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 of the claim approver on a request. -
ApprovalTaskStatusCode: string
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. -
ApprovedAmount: number
Title:
Approved Amount
Default Value:0
The amount approved for the MDF. -
ApprovedAmountPercent: number
Title:
Approved Percent
Default Value:100
The approved MDF amount in percentage. -
ApprovedBy: string
Title:
Approved By
Maximum Length:64
The person who approved the MDF request. -
ApprovedById: integer
(int64)
Title:
Approved by ID
The unique identifier of the person who approved the MDF request. -
ApprovedDate: string
(date)
Title:
Approved Date
The date on which the MDF request was approved. -
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
AvailableFundRequestAmount: number
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. -
BgtExchangeRate: number
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. -
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 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. -
BudgetEndDate: string
(date)
Title:
Budget End Date
Read Only:true
The date when the budget ends. -
BudgetId: integer
(int64)
Title:
Budget ID
The unique identifier of the budget associated with the MDF request. -
BudgetName: string
Title:
Budget
The name of the budget prescribed for allocation of funds to an MDF request. -
BudgetStartDate: string
(date)
Title:
Budget Start Date
Read Only:true
The date when the budget starts. -
CanApprove: boolean
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. -
CanReject: boolean
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. -
CanReturn: boolean
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. -
CanSubmit: boolean
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. -
CanTerminate: boolean
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. -
CanWithdraw: boolean
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. -
ChannelManager: string
Title:
Channel Manager
Read Only:true
Maximum Length:450
The channel manager or the partner who own the MDF request. -
ChannelManagerId: integer
(int64)
Title:
Channel Manager ID
Read Only:true
The unique identifier of the channel manager of the MDF request. -
Claim: array
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. -
Comments: string
Title:
Comments
Maximum Length:1000
The additional comments on the MDF request. -
ConversionCurrencyCode: string
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. -
ConversionRateType: string
Title:
Conversion Rate Type
Read Only:true
Maximum Length:30
The type of currency conversion rate used in processing the MDF request. -
ConvExchangeRate: number
Title:
Conversion Exchange Rate
Read Only:true
The exchange rate for converting the claim currency to the standard CRM corporate currency. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the MDF request. -
CreatedBy_FN: string
Title:
Created By
Read Only:true
The person who created the MDF request. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date 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. You can 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 used in Business Intelligence to convert from MDF budget currency to user preferred currency. -
DeleteFlag: boolean
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. -
Description: string
Title:
Description
Maximum Length:4000
A brief description for the MDF request. -
FundRequestCode: string
Title:
Code
Maximum Length:100
The code indicating the user-defined, unique label for the MDF request. -
FundRequestId: integer
(int64)
Title:
Fund Request ID
The unique identifier of the MDF request. This is a system generated value. -
FundRequestName: string
Title:
Name
Maximum Length:250
The display name of the MDF request. -
FundRequestResource: array
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. -
FundRequestStatusCode: string
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. -
FundRequestType: string
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. -
Justification: string
Title:
Justification
Maximum Length:1000
The justification provided for submitting the MDF request. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the MDF request was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the MDF request. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the MDF request. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Note: array
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. -
OwnerEmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email of the owner of the MDF request. -
OwnerFormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the owner of the claim. -
OwnerId: integer
(int64)
Title:
Owner ID
The unique identifier of the owner of MDF request. -
OwnerName: string
Title:
Owner
Maximum Length:360
The name of the owner of the MDF 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 MDF request. -
PartnerId: integer
(int64)
Title:
Partner ID
The unique identifier of the partner account associated with the MDF request. -
PartnerName: string
Title:
Partner
Maximum Length:360
The name of the partner account associated with the MDF request. -
PartnerPartyUniqueName: string
Title:
Partner
Read Only:true
Maximum Length:360
The name of the partner associated with the MDF request. -
RecordSet: string
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. -
RejectedBy: string
Title:
Rejected By
Maximum Length:64
The user who rejected the MDF request. -
RejectedById: integer
(int64)
Title:
Rejected by ID
The unique identifier of the person who rejected the request. -
RejectedDate: string
(date)
Title:
Rejected Date
The date when the MDF request was rejected. -
RejectReasonCode: string
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. -
RequestedAmount: number
Title:
Requested Amount
The amount requested on the MDF claim. -
RequestStatusMeaning: string
Title:
Status
The status of the MDF request. -
ReturnReasonCode: string
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. -
SubmitClaimsBy: string
(date)
Title:
Claim Deadline
Read Only:true
The user who submitted the MDF request. -
SubmitFundReqBy: string
(date)
Title:
Request Deadline
The last day a budget can be associated with an MDF request. -
SubmittedBy: string
Title:
Submitted By
Maximum Length:64
The user who submitted the MDF request. -
SubmittedById: integer
(int64)
Title:
Submitted by ID
The unique identifier of the person who submitted the request. -
SubmittedDate: string
(date)
Title:
Submitted Date
The date when the MDF request was submitted. -
TotalApprovedClaimAmount: number
Title:
Approved Claim Amount
Read Only:true
Default Value:0
The total amount of all the approved claims of an MDF request. -
UpdateFlag: boolean
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 : 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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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 : mdfRequests-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 : mdfRequests-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 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 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 when 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 MDF claim. MDF budget is associated to the claim through fund request. -
BudgetCurrency: string
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. -
BudgetEndDate: string
(date)
Title:
Budget End Date
Read Only:true
The date when the budget ends. -
BudgetName: string
Title:
Budget
Maximum Length:250
The name of the MDF request budget associated with the MDF claim. -
BudgetStartDate: string
(date)
Title:
Start Date
Read Only:true
The date when the budget starts. -
CanApprove: boolean
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. -
CanReject: boolean
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. -
CanReturn: boolean
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. -
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 if the user can withdraw the claim or an MDF request. If the user has access to withdraw a claim or an MDF request, then the default value is true, else false. -
ChannelManagerId: integer
(int64)
Title:
Account Director ID
Read Only:true
The unique identifier of the channel manager of the MDF claim. -
ChannelMgrName: string
Title:
Channel Manager
The name of the channel manager of the MDF claim. -
ClaimAmount: number
Title:
Requested Amount
The amount requested in the MDF claim. -
ClaimCode: string
Title:
Code
Maximum Length:100
The user-defined or system generated code for the MDF claim. -
ClaimId: integer
(int64)
Title:
Claim ID
The unique identifier of the claim. This is a system-generated value. -
ClaimName: string
Title:
Name
Maximum Length:250
The name of the MDF claim. -
ClaimStatusCode: string
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. -
Comments: string
Title:
Comments
Maximum Length:1000
The additional comments on the MDF claim. -
ConversionCurrencyCode: string
Title:
Conversion Currency Code
Read Only:true
Maximum Length:30
The currency code associated with the claim. -
ConversionRateType: string
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. -
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 when the MDF claim was created. -
CurrencyCode: string
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. -
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
A brief description of the MDF claim. -
FrExchangeRate: number
Title:
Fund Request Exchange Rate
Default Value:0
The exchange rate of the fund request associated with the claim. -
FundRequestApprovedAmount: number
Title:
MDF Request Approved Amount
Read Only:true
The approved amount of the MDF request against the MDF 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 associated with the MDF request. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
FundRequestId: integer
(int64)
Title:
Fund Request ID
The unique identifier of the MDF request associated with 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 MDF request. -
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 MDF claim. -
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 approved claim amount pending to be paid. -
OwnerEmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the MDF claim owner. -
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 owner of 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 phone number of the owner of the MDF claim. -
PartnerPartyUniqueName: string
Title:
Partner
Read Only:true
Maximum Length:360
The name of the partner associated with the MDF claim. -
RecordSet: string
Title:
Record Set
Read Only:true
The record set values for 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 last date to submit a claim against the MDF request. -
SubmittedBy: string
Title:
Submitted By
Maximum Length:64
The user who submitted the 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 when 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 : mdfRequests-FundRequestResource-item-response
Type:
Show Source
object
-
AccessLevelCode: string
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. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the resource in the MDF request team. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the resource was created in the MDF request team. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The e-mail address of the MDF Request team member associated with the MDF Request. -
FormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the MDF Request team member associated with the MDF Request. -
FundRequestCode: string
Title:
Code
Maximum Length:100
The public unique identifier for the marketing fund request. -
FundRequestId: integer
(int64)
Title:
Fund Request ID
The unique identifier of the MDF request associated with the resource. This is a system-generated value. -
FundRequestResourceId: integer
(int64)
Title:
MDF Request Resource ID
The unique identifier of the resource in the MDF request team. This is a system-generated value. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the MDF request team member record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the MDF request team member record. -
LastUpdateLogin: string
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
MemberFunctionCode: string
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. -
OwnerFlag: boolean
Title:
Owner
Read Only:true
Indicates whether the MDF Request team member is the owner of the MDF Request. The default value is true. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the resource. -
ResourceName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the MDF Request team member associated with the MDF Request. -
ResourcePartyNumber: string
Title:
Resource Party Number
Read Only:true
Maximum Length:30
The public unique identifier for the resource. -
ResourceUsername: string
Title:
Resource User Name
Read Only:true
The login username of the MDF Request team member associated with the MDF Request. -
UserLastUpdateDate: string
(date-time)
Title:
User Last Update Date
The date when the user last updated the record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : mdfRequests-Note-item-response
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The unique identifier of the relationship, populated when the note is associated with an MDF request user. -
CorpCurrencyCode: string
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. -
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 that 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 notes. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
The primary address of the user who created the notes. -
FormattedPhoneNumber: string
Title:
Primary Phone
Read Only:true
The primary phone number of the user who created the notes. -
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 request This is the primary key of the notes table. -
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 column which will store the actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
The code indicating the type of the note. -
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 Request to which the note is associated. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
The name of an MDF Request party. -
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 code indicating the visibility level of the note, such as internal or external.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source