Get an MDF claim
get
/crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}
Request
Path Parameters
-
ClaimCode(required): string
The user-defined, unique label for the MDF claim.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
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 : mdfClaims-item-response
Type:
Show Source
object-
ActivityOutcome: string
Title:
Activity OutcomeMaximum Length:1000Partner Activity Out come. -
Age: number
Title:
Claim AgeRead Only:trueThe number of days since the MDF claim was created. -
ApprovalActionComments: string
Title:
Approver CommentsThe comments entered during approval action on the claim. -
ApprovalTaskStatusCode: string
Title:
StatusThe code indicating the approval action that can be taken in the MDF Claim. The accepted values are Approve, Reject, Return, Withdraw, Terminate, and HtOutcmeReturnReturnAction. -
ApprovedAmount: number
Title:
Approved AmountDefault Value:0The amount approved for the MDF claim. -
ApprovedBy: string
Title:
ApproversMaximum Length:64The user who approved the MDF claim. -
ApprovedById: integer
(int64)
Title:
Approved by IDThe unique identifier of the user who approved the MDF claim. -
ApprovedDate: string
(date)
Title:
Approved DateThe date when the MDF claim was approved. -
Attachments: array
Attachments
Title:
AttachmentsThe attachments resource is used to view, create, and update attachments. -
BgtExchangeRate: number
Title:
Conversion Rate to BudgetDefault Value:0The exchange rate of the MDF budget which is associated with the claim. MDF budget is associated to the claim through fund request. -
BudgetCurrency: string
Title:
Budget CurrencyRead Only:trueMaximum Length:30The currency used for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request. -
BudgetEndDate: string
(date)
Title:
Budget End DateRead Only:trueThe end date for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request. -
BudgetId: integer
(int64)
Title:
Budget IDThe unique identifier of the parent budget associated with the MDF claim. -
BudgetName: string
Title:
BudgetMaximum Length:250The display name of the marketing budget associated to the MDF claim. -
BudgetStartDate: string
(date)
Title:
Start DateRead Only:trueThe start date for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request. -
CanApprove: boolean
Title:
Can ApproveRead Only:trueIndicates whether the user can approve the MDF Claim. If the user has access to approve an MDF claim then the default value is true, else false. -
CanReject: boolean
Title:
Can RejectRead Only:trueIndicates whether the user has access to reject the claim. -
CanReturn: boolean
Title:
Can ReturnRead Only:trueIndicates whether the user has access to return the claim. -
CanSubmit: boolean
Title:
Can SubmitRead Only:trueIndicates whether the user has access to submit the claim. -
CanTerminate: boolean
Title:
Can TerminateRead Only:trueIndicates whether the user has access to terminate the claim. -
CanWithdraw: boolean
Title:
Can WithdrawRead Only:trueIndicates whether the user has access to withdraw the claim. -
ChannelManagerId: integer
(int64)
Title:
Account Director IDRead Only:trueThe unique identifier of the account director associated with the claim. -
ChannelMgrName: string
Title:
Channel ManagerThe name of the channel manager on the claim. -
ClaimAmount: number
Title:
Requested AmountThe amount of reimbursement requested in the MDF claim. -
ClaimApprovalHistory: array
Claim Approval Histories
Title:
Claim Approval HistoriesThe claim approval history lets you access a comprehensive record of approval-related information associated with the claim, encompassing the names of approvers, action dates, and the specific actions taken. -
ClaimCode: string
Title:
CodeMaximum Length:100The user-defined, unique label for the MDF claim. -
ClaimId: integer
(int64)
Title:
Claim IDThe unique identifier of the MDF claim. -
ClaimName: string
Title:
NameMaximum Length:250The display name of the MDF claim. -
ClaimResource: array
Claim Team Members
Title:
Claim Team MembersThe claim team members resource is used to view, create, update, and delete a claim team member. A claim team member is a resource who is assigned to the MDF claim team, and who has the appropriate visibility and access to the MDF Claim record. -
ClaimSettlements: array
Claim Settlements
Title:
Claim SettlementsThe claim settlements resource is used to view, create, update, and delete the payments made to partners as reimbursement for the marketing expenses incurred by that partner. -
ClaimStatusCode: string
Title:
StatusMaximum Length:30Default Value:DRAFTThe code indicating the status of the MDF claim. -
Comments: string
Title:
CommentsMaximum Length:1000Any additional comments for the MDF claim. -
ConversionCurrencyCode: string
Title:
Conversion Currency CodeRead Only:trueMaximum Length:30The currency code used for conversion in the claim. -
ConversionRateType: string
Title:
Conversion Rate TypeRead Only:trueMaximum Length:30The currency conversion rate type associated with the MDF claim. -
ConvExchangeRate: number
Title:
Conversion Exchange RateThe currency exchange rate for the claim against the corporate currency. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the MDF claim. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the MDF claim was created. -
CurrencyCode: string
Title:
CurrencyMaximum Length:30The currency code. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyConversionDate: string
(date)
Title:
Currency Conversion DateThe date of currency exchange rate for the claim against the corporate currency. -
DeleteFlag: boolean
Title:
Delete IndicatorRead Only:trueIndicates whether the user has access to delete the record. -
Description: string
Title:
DescriptionMaximum Length:4000A brief description of the MDF claim. -
FrExchangeRate: number
Title:
Fund Request Exchange RateDefault Value:0The exchange rate of the fund request associated with the claim. -
FundRequestApprovedAmount: number
Title:
MDF Request Approved AmountRead Only:trueThe approved amount on the associated fund request. -
FundRequestCode: string
Title:
Fund Request CodeMaximum Length:100Public Unique Identifier for the marketing fund request. -
FundRequestCurrency: string
Title:
CurrencyRead Only:trueMaximum Length:30The currency code on the associated fund request. -
FundRequestId: integer
(int64)
Title:
Fund Request IDThe unique identifier of the MDF fund request associated with the MDF claim. -
FundRequestName: string
Title:
MDF RequestMaximum Length:250The name of the fund request associated with the claim. -
FundRequestType: string
Title:
MDF Request TypeRead Only:trueMaximum Length:30The type of fund request associated with the claim. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the claim was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the MDF claim. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the claim. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManageApprovalDataFlag: boolean
Read Only:
trueIndicates whether user can modify claim attributes while the claim is awaiting approval. -
ManageGeneralDataFlag: boolean
Read Only:
trueIndicates whether user can modify claim attributes when the claim is either in draft or returned or withdrawn status. -
ManagePartnerDataFlag: boolean
Read Only:
trueIndicates that partner users are restricted from modifying the partner field. It indicates whether channel users can update the partner field when the claim is in draft, return, or withdrawn status. -
ManageTeamDataFlag: boolean
Read Only:
trueIndicates whether the logged in user has full access on the claim record. -
Note: array
Notes
Title:
NotesThe notes resource is used to view, create, update, and delete notes associated with a claim. A note captures comments, information, or instructions related to a claim. -
OutstngClaimLiabilityAmount: number
Title:
Liability AmountDefault Value:0The outstanding claim liability amount. -
OwnerEmailAddress: string
Title:
EmailRead Only:trueMaximum Length:320The email address of the owner. -
OwnerFormattedPhoneNumber: string
Title:
PhoneRead Only:trueThe formatted phone of the owner. -
OwnerId: integer
(int64)
Title:
Owner IDThe unique identifier of the owner of the MDF claim. -
OwnerName: string
Title:
OwnerMaximum Length:360The name of owner of the MDF claim. -
OwnerPartyNumber: string
Title:
Owner Party NumberRead Only:trueMaximum Length:30The alternate key identifier of the owner party. -
OwnerPrimaryPhoneNumber: string
Title:
PhoneRead Only:trueMaximum Length:40The phone number of the owner. -
PartnerCompanyNumber: string
Title:
Partner Company NumberMaximum Length:30Public Unique Identifier for the Partner. -
PartnerId: integer
(int64)
Title:
Partner IDThe unique identifier of the partner account associated with the MDF claim. -
PartnerPartyUniqueName: string
Title:
PartnerRead Only:trueMaximum Length:360The name of the partner associated with the claim. -
RecordSet: string
Title:
Record SetRead Only:trueThe record set values for claim. -
RejectedBy: string
Title:
Rejected ByMaximum Length:64The user who rejected the MDF claim. -
RejectedById: integer
(int64)
Title:
Rejected by IDThe unique identifier of the user who rejected the MDF claim. -
RejectedDate: string
(date)
Title:
Rejected DateThe date when the MDF claim was rejected. -
RejectReasonCode: string
Title:
Reject ReasonThe reason code for rejecting the claim. -
ReturnReasonCode: string
Title:
Return ReasonThe reason code for returning the claim back to the submitter. -
smartActions: array
Smart Actions
Title:
Smart ActionsThis VO stores the endpoint and security details for every user action. -
SubmitClaimsBy: string
(date)
Title:
Claim DeadlineRead Only:trueThe date by which associated claim needs to be submitted. -
SubmittedBy: string
Title:
Submitted ByMaximum Length:64The user who submitted the MDF claim. -
SubmittedById: integer
(int64)
Title:
Submitted by IDThe unique identifier of the user who submitted the MDF claim. -
SubmittedDate: string
(date)
Title:
Submitted DateThe date when the MDF claim was submitted. -
UpdateFlag: boolean
Title:
Update IndicatorRead Only:trueIndicates whether the user has access to update the record.
Nested Schema : Attachments
Type:
arrayTitle:
AttachmentsThe attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Claim Approval Histories
Type:
arrayTitle:
Claim Approval HistoriesThe claim approval history lets you access a comprehensive record of approval-related information associated with the claim, encompassing the names of approvers, action dates, and the specific actions taken.
Show Source
Nested Schema : Claim Team Members
Type:
arrayTitle:
Claim Team MembersThe claim team members resource is used to view, create, update, and delete a claim team member. A claim team member is a resource who is assigned to the MDF claim team, and who has the appropriate visibility and access to the MDF Claim record.
Show Source
Nested Schema : Claim Settlements
Type:
arrayTitle:
Claim SettlementsThe claim settlements resource is used to view, create, update, and delete the payments made to partners as reimbursement for the marketing expenses incurred by that partner.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Notes
Type:
arrayTitle:
NotesThe notes resource is used to view, create, update, and delete notes associated with a claim. A note captures comments, information, or instructions related to a claim.
Show Source
Nested Schema : Smart Actions
Type:
arrayTitle:
Smart ActionsThis VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : mdfClaims-Attachments-item-response
Type:
Show Source
object-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker IdAttribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document IdThe unique identifier of the attached document. -
CategoryName: string
Title:
CategoryMaximum Length:30The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:255The user who created the record. -
CreatedByUserName: string
Title:
Created By User NameRead Only:trueThe user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DatatypeCode: string
Title:
TypeMaximum Length:30Default Value:FILEA value that indicates the data type. -
Description: string
Title:
DescriptionMaximum Length:255The description of the attachment. -
DmDocumentId: string
Maximum Length:
255The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder PathMaximum Length:1000The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfoJSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status CodeThe error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status MessageThe error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration DateThe expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File ContentsThe contents of the attachment. -
FileName: string
Title:
File NameMaximum Length:2048The file name of the attachment. -
FileUrl: string
Title:
File UrlThe URI of the file. -
FileWebImage: string
(byte)
Title:
File Web ImageRead Only:trueThe base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:255The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By UserRead Only:trueThe user name who last updated the record. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingActionThe name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
TitleThe title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content TypeThe content type of the attachment. -
UploadedFileLength: integer
Title:
File SizeThe size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File NameThe name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded TextThe text content for a new text attachment. -
Uri: string
Title:
UriMaximum Length:4000The URI of a Topology Manager type attachment. -
Url: string
Title:
UrlMaximum Length:4000The URL of a web page type attachment. -
UserName: string
Title:
User NameRead Only:trueMaximum Length:255The login credentials of the user who created the attachment.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : mdfClaims-ClaimApprovalHistory-item-response
Type:
Show Source
object-
ActionBy: string
Read Only:
trueMaximum Length:255User name of the user who has taken the action. -
ActionByDisplay: string
Read Only:
trueMaximum Length:255Party name of the user who has taken the action. -
ActionCode: string
Read Only:
trueMaximum Length:255Action taken by the user. This will be non-translatable value. -
ActionDate: string
(date-time)
Read Only:
trueDate when the action was taken. -
Assignee: string
Read Only:
trueMaximum Length:255User name of the user to whom claim is assigned. -
AssigneeDisplayName: string
Read Only:
trueMaximum Length:255Party name of the user to whom the claim is assigned. -
AssigneeType: string
Read Only:
trueMaximum Length:255Type of assignee. It can be a user or a role. -
CommentText: string
Read Only:
trueMaximum Length:255Comments provided by the user for each action taken. For submit action there won't be any comments. -
IdentificationKey: string
Read Only:
trueMaximum Length:255The unique identifier for which approval history records needs to be shown. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ReasonDisplay: string
Read Only:
trueMaximum Length:255Reason provided by the user for any action taken. This is displayed only when the claim is either rejected or returned. -
Version: string
Read Only:
trueMaximum Length:255Version of each row of approval history. -
VersionKey: string
Read Only:
trueMaximum Length:255The primary key identifier of the approval history.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : mdfClaims-ClaimResource-item-response
Type:
Show Source
object-
AccessLevelCode: string
Title:
AccessMaximum Length:30The code indicating the level of access of a MDF claim team member. -
ClaimCode: string
Title:
CodeMaximum Length:100The user-defined, unique label for the marketing claim. -
ClaimId: integer
(int64)
Title:
Claim IDThe unique identifier of the MDF claim associated with the resource. -
ClaimResourceId: integer
(int64)
Title:
Claim Resource IDThe unique identifier of a member of the MDF request team. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the resource on the MDF claim team. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the resource was created on the MDF claim team. -
EmailAddress: string
Title:
EmailRead Only:trueMaximum Length:320The email address of the MDF claim team member associated with the MDF claim. -
FormattedPhoneNumber: string
Title:
PhoneRead Only:trueThe phone number of the MDF claim team member associated with the MDF claim. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the resource was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the MDF claim team member. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the resource. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MemberFunctionCode: string
Title:
FunctionMaximum Length:30The code indicating the function of the MDF claim team member. -
OwnerFlag: boolean
Title:
OwnerRead Only:trueIndicates whether the MDF claim team member is the owner of the MDF claim. -
PartyName: string
Title:
NameRead Only:trueMaximum Length:360The name of the MDF claim team member associated with the MDF claim. -
ResourceId: integer
(int64)
Title:
Resource IDThe unique identifier of the MDF claim team member. -
ResourcePartyNumber: string
Title:
Resource Party NumberRead Only:trueMaximum Length:30The alternate key identifier of the resource party. -
ResourceUsername: string
Title:
Resource User NameRead Only:trueThe username of the MDF claim team member associated with the MDF claim. -
smartActions: array
Smart Actions
Title:
Smart ActionsThis VO stores the endpoint and security details for every user action. -
UserLastUpdateDate: string
(date-time)
Title:
Last Update DateThe date and time when the MDF claim team member record was last updated.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Smart Actions
Type:
arrayTitle:
Smart ActionsThis VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : mdfClaims-ClaimResource-smartActions-item-response
Type:
Show Source
object-
ActionIntent: string
(byte)
Title:
Action IntentJSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation MessageMaximum Length:4000A message to seek confirmation for the action being performed. -
ContentType: string
Title:
Content TypeMaximum Length:50The content type to use when invoking the REST endpoint. -
DisplayLabel: string
Title:
Action NameMaximum Length:256Consumer-friendly action name. -
Entity: string
Title:
Parent EntityMaximum Length:150REST Resources the action belongs to. -
Href: string
Title:
REST EndpointMaximum Length:1024The REST endpoint to perform the action. -
IncludedInApplication: string
Title:
Included in ApplicationMaximum Length:512List of applications that this action can be used in. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass ActionMaximum Length:1Boolean type indicating if this action can be mass processed. -
Method: string
Title:
HTTP MethodMaximum Length:15HTTP method to use with HREF. -
ObjectFunctionName: string
Title:
Object FunctionMaximum Length:64The object function associated with the smart action. -
PageType: string
Title:
Page TypeMaximum Length:256The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart SuggestMaximum Length:1Indicates if smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Boolean type indicating if the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to UpdateMaximum Length:512Attributes to be updated when the Actions UI is launched. -
UserActionId: integer
(int64)
Title:
User Action IDUniquely identifies the action. For internal use. -
UserActionName: string
Title:
Action NameMaximum Length:256Uniquely identifies the action with a name. For internal use. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
PriorityNumber to indicate priority of the action. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload DefinitionsIf an LOV required for constructing a request payload needs to post data, the payload metadata is stored here. -
UserActionURLBinding: array
Smart Action User Interface Definitions
Title:
Smart Action User Interface DefinitionsBinding metadata for a variable in the URL.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type:
arrayTitle:
Smart Action REST Payload DefinitionsIf 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:
arrayTitle:
Smart Action User Interface DefinitionsBinding metadata for a variable in the URL.
Show Source
Nested Schema : mdfClaims-ClaimResource-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object-
Binding: string
Title:
Payload Value Binding TypeMaximum Length:64Indicates the binding type of the value. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
MandatoryMaximum Length:1Boolean value indicating if the payload is mandatory. -
RequestPayloadId: integer
(int64)
Uniquely identifies the payload for smart actions. For internal use.
-
RequestPayloadName: string
Title:
Request Payload Attribute NameMaximum Length:256The key in the Key Value pair that forms the payload. -
SmartSuggestPath: string
Title:
Smart Suggest PathMaximum Length:2048The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseBoolean value. -
Value: string
Title:
Request Payload Attribute ValueMaximum Length:1000The value in the Key Value pair that forms the payload. -
ValueStruct: string
Title:
Payload Value StructureMaximum Length:20If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : mdfClaims-ClaimResource-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object-
Binding: string
Title:
URL Binding TypeMaximum Length:64This is a hint for processing the Url Binding runtime. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseBoolean indicator. -
URLBindingId: integer
(int64)
Uniquely identifies the URL Bind for smart actions. For internal use.
-
URLBindingName: string
Title:
URL Binding Parameter NameMaximum Length:256For action REST endpoints that require runtime binding, this is the key in the key value pair. -
Value: string
Title:
URL Binding Parameter ValueMaximum Length:1000For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : mdfClaims-ClaimSettlements-item-response
Type:
Show Source
object-
AccountingType: string
Title:
Accounting TypeMaximum Length:30The accounting type of the MDF claim settlement, which represents credit or debit in the back-end financial system. -
AccountingTypeMeaning: string
Title:
Accounting TypeRead Only:trueThe accounting type of the marketing claim settlement, which represents a credit or debit in the back-end financial system. -
BudgetCurrencyExchangeRate: number
Title:
Conversion Rate to BudgetRead Only:trueDefault Value:1The exchange rate used to convert the marketing claim settlement currency to the parent budget currency. -
BudgetId: number
Title:
Budget IDRead Only:trueThe unique identifier of the parent budget associated with the MDF claim. -
BudgetName: string
Title:
NameRead Only:trueMaximum Length:250The name of the MDF budget associated with the claim. MDF budget is associated to the claim through fund request. -
ClaimCode: string
Title:
CodeMaximum Length:100The user-defined, unique label for the marketing claim. -
ClaimCurrencyExchangeRate: number
Title:
Conversion Rate to ClaimRead Only:trueDefault Value:1The exchange rate used to convert the marketing claim settlement currency to the parent marketing claim currency. -
ClaimId: number
Title:
Claim IDThe unique identifier of the MDF claim. -
ClaimName: string
Title:
NameRead Only:trueMaximum Length:250The name of the claim associated with the claim settlement. -
ClaimSettlementAmount: number
Title:
AmountThe amount settled in the MDF claim settlement. -
ClaimSettlementCode: string
Title:
CodeMaximum Length:100The user-defined, unique label for the MDF claim settlement. -
ClaimSettlementId: integer
Title:
Claim Settlement IDThe unique identifier of the MDF claim settlement. -
ClaimSettlementType: string
Title:
TypeMaximum Length:30The type of the MDF claim settlement, for example deduction or payment. -
ClaimSettlmntTypeMeaning: string
Title:
TypeRead Only:trueThe type of marketing claim settlement, for example deduction or payment. -
ClaimStatusCode: string
Title:
StatusRead Only:trueMaximum Length:30The status of the claim settlement. -
ConversionCurrencyCode: string
Title:
Conversion Currency CodeRead Only:trueMaximum Length:30The currency code associated with the claim settlement. -
ConversionRateType: string
Title:
Conversion Rate TypeRead Only:trueMaximum Length:30The conversion rate type associated with the claim settlement. -
ConvExchangeRate: number
Title:
Conversion Exchange RateRead Only:trueThe currency exchange rate for the claim settlement against the corporate currency. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the MDF claim settlement. -
CreatedById: integer
(int64)
Title:
Created by IDRead Only:trueThe unique identifier of the creator of the claim settlement. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the claim settlement was created. -
CurrencyCode: string
Title:
CurrencyMaximum Length:30The currency code associated with the claim settlement account. 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 DateRead Only:trueThe date of currency exchange rate for the claim settlement against the corporate currency. -
Description: string
Title:
DescriptionMaximum Length:1000A brief description of the marketing claim settlement. -
InvoiceReference: string
Title:
Transaction ReferenceMaximum Length:100The reference identifier of the invoice to be settled with the MDF claim settlement. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the settlement was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the marketing claim settlement. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the settlement. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OutstandingClaimLiabilityAmount: number
Title:
Liability AmountRead Only:trueDefault Value:0The outstanding claim liability amount. -
PartnerId: integer
(int64)
Title:
Partner IDRead Only:trueThe unique identifier of the party. -
PartnerName: string
Title:
PartnerRead Only:trueThe name of the party. -
smartActions: array
Smart Actions
Title:
Smart ActionsThis VO stores the endpoint and security details for every user action. -
StatusCode: string
Title:
StatusMaximum Length:30Default Value:INCOMPLETEThe code indicating the completion status of the marketing claim settlement. -
StatusMeaning: string
Title:
StatusRead Only:trueThe completion status of the marketing claim settlement. -
TransactionDate: string
(date)
Title:
Transaction DateThe date when the claim settlement was processed or marked as complete. -
TransactionMethod: string
Title:
Transaction MethodMaximum Length:30The method by which the claim settlement transaction was processed. -
TransactionMethodMeaning: string
Title:
Transaction MethodRead Only:trueThe method by which claim settlement transaction is processed.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Smart Actions
Type:
arrayTitle:
Smart ActionsThis VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : mdfClaims-ClaimSettlements-smartActions-item-response
Type:
Show Source
object-
ActionIntent: string
(byte)
Title:
Action IntentJSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation MessageMaximum Length:4000A message to seek confirmation for the action being performed. -
ContentType: string
Title:
Content TypeMaximum Length:50The content type to use when invoking the REST endpoint. -
DisplayLabel: string
Title:
Action NameMaximum Length:256Consumer-friendly action name. -
Entity: string
Title:
Parent EntityMaximum Length:150REST Resources the action belongs to. -
Href: string
Title:
REST EndpointMaximum Length:1024The REST endpoint to perform the action. -
IncludedInApplication: string
Title:
Included in ApplicationMaximum Length:512List of applications that this action can be used in. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass ActionMaximum Length:1Boolean type indicating if this action can be mass processed. -
Method: string
Title:
HTTP MethodMaximum Length:15HTTP method to use with HREF. -
ObjectFunctionName: string
Title:
Object FunctionMaximum Length:64The object function associated with the smart action. -
PageType: string
Title:
Page TypeMaximum Length:256The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart SuggestMaximum Length:1Indicates if smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Boolean type indicating if the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to UpdateMaximum Length:512Attributes to be updated when the Actions UI is launched. -
UserActionId: integer
(int64)
Title:
User Action IDUniquely identifies the action. For internal use. -
UserActionName: string
Title:
Action NameMaximum Length:256Uniquely identifies the action with a name. For internal use. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
PriorityNumber to indicate priority of the action. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload DefinitionsIf an LOV required for constructing a request payload needs to post data, the payload metadata is stored here. -
UserActionURLBinding: array
Smart Action User Interface Definitions
Title:
Smart Action User Interface DefinitionsBinding metadata for a variable in the URL.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type:
arrayTitle:
Smart Action REST Payload DefinitionsIf 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:
arrayTitle:
Smart Action User Interface DefinitionsBinding metadata for a variable in the URL.
Show Source
Nested Schema : mdfClaims-ClaimSettlements-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object-
Binding: string
Title:
Payload Value Binding TypeMaximum Length:64Indicates the binding type of the value. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
MandatoryMaximum Length:1Boolean value indicating if the payload is mandatory. -
RequestPayloadId: integer
(int64)
Uniquely identifies the payload for smart actions. For internal use.
-
RequestPayloadName: string
Title:
Request Payload Attribute NameMaximum Length:256The key in the Key Value pair that forms the payload. -
SmartSuggestPath: string
Title:
Smart Suggest PathMaximum Length:2048The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseBoolean value. -
Value: string
Title:
Request Payload Attribute ValueMaximum Length:1000The value in the Key Value pair that forms the payload. -
ValueStruct: string
Title:
Payload Value StructureMaximum Length:20If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : mdfClaims-ClaimSettlements-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object-
Binding: string
Title:
URL Binding TypeMaximum Length:64This is a hint for processing the Url Binding runtime. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseBoolean indicator. -
URLBindingId: integer
(int64)
Uniquely identifies the URL Bind for smart actions. For internal use.
-
URLBindingName: string
Title:
URL Binding Parameter NameMaximum Length:256For action REST endpoints that require runtime binding, this is the key in the key value pair. -
Value: string
Title:
URL Binding Parameter ValueMaximum Length:1000For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : mdfClaims-Note-item-response
Type:
Show Source
object-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship IDThe unique identifier of the contact relationship. This attribute is populated when the note is associated with an MDF claim user. -
CorpCurrencyCode: string
Title:
Corporate Currency CodeMaximum Length:15The corporate currency code of the note associated with the MDF claim. 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 ByRead Only:trueMaximum Length:64The user who created the note. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the note was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party IDThe unique identifier of the party that the note creator belongs to. -
CurcyConvRateType: string
Title:
Currency Conversion Rate TypeMaximum Length:30The 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:
CurrencyMaximum Length:15The 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 IndicatorRead Only:trueIndicates 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
Read Only:
trueMaximum Length:320The email address of the user who created the note. -
FormattedAddress: string
Read Only:
trueThe address of the user who created the note. -
FormattedPhoneNumber: string
Read Only:
trueThe phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date and time when the note data was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the note. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the note. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
NoteId: integer
(int64)
Title:
Note IDRead Only:trueThe unique identifier of the note associated with the MDF claim. This is the primary key of the notes table. -
NoteNumber: string
Maximum Length:
30The alternate unique identifier of the note. A user key that's system generated or from an external system. -
NoteTitle: string
Title:
TitleMaximum Length:500The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
NoteThe actual note text. -
NoteTypeCode: string
Title:
TypeMaximum Length:30This is the note type code for categorization of note. A list of valid values is defined in the lookup NoteSourceTypeVA. -
ParentNoteId: integer
(int64)
Title:
Parent Note IDThe unique identifier of the parent note. -
PartyId: integer
(int64)
Read Only:
trueThe unique identifier of the party associated with the note. -
PartyName: string
Title:
AuthorRead Only:trueMaximum Length:360The name of an MDF claim party. -
smartActions: array
Smart Actions
Title:
Smart ActionsThis VO stores the endpoint and security details for every user action. -
SourceObjectCode: string
Title:
Related Object TypeMaximum Length:30The code indicating the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, Sales Business Plan, and so on. -
SourceObjectId: string
Title:
Related ObjectMaximum Length:64The primary key identifier of the source object as defined in OBJECTS Metadata. -
SourceSystem: string
Title:
Source SystemMaximum Length:30This is the source object code for the source object as defined in OBJECTS Metadata. -
UpdateFlag: boolean
Title:
Update IndicatorRead Only:trueIndicates 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:
PrivateMaximum Length:30Default Value:INTERNALThe code indicating the visibility level of the note, such as internal or external.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Smart Actions
Type:
arrayTitle:
Smart ActionsThis VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : mdfClaims-Note-smartActions-item-response
Type:
Show Source
object-
ActionIntent: string
(byte)
Title:
Action IntentJSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation MessageMaximum Length:4000A message to seek confirmation for the action being performed. -
ContentType: string
Title:
Content TypeMaximum Length:50The content type to use when invoking the REST endpoint. -
DisplayLabel: string
Title:
Action NameMaximum Length:256Consumer-friendly action name. -
Entity: string
Title:
Parent EntityMaximum Length:150REST Resources the action belongs to. -
Href: string
Title:
REST EndpointMaximum Length:1024The REST endpoint to perform the action. -
IncludedInApplication: string
Title:
Included in ApplicationMaximum Length:512List of applications that this action can be used in. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass ActionMaximum Length:1Boolean type indicating if this action can be mass processed. -
Method: string
Title:
HTTP MethodMaximum Length:15HTTP method to use with HREF. -
ObjectFunctionName: string
Title:
Object FunctionMaximum Length:64The object function associated with the smart action. -
PageType: string
Title:
Page TypeMaximum Length:256The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart SuggestMaximum Length:1Indicates if smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Boolean type indicating if the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to UpdateMaximum Length:512Attributes to be updated when the Actions UI is launched. -
UserActionId: integer
(int64)
Title:
User Action IDUniquely identifies the action. For internal use. -
UserActionName: string
Title:
Action NameMaximum Length:256Uniquely identifies the action with a name. For internal use. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
PriorityNumber to indicate priority of the action. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload DefinitionsIf an LOV required for constructing a request payload needs to post data, the payload metadata is stored here. -
UserActionURLBinding: array
Smart Action User Interface Definitions
Title:
Smart Action User Interface DefinitionsBinding metadata for a variable in the URL.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type:
arrayTitle:
Smart Action REST Payload DefinitionsIf 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:
arrayTitle:
Smart Action User Interface DefinitionsBinding metadata for a variable in the URL.
Show Source
Nested Schema : mdfClaims-Note-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object-
Binding: string
Title:
Payload Value Binding TypeMaximum Length:64Indicates the binding type of the value. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
MandatoryMaximum Length:1Boolean value indicating if the payload is mandatory. -
RequestPayloadId: integer
(int64)
Uniquely identifies the payload for smart actions. For internal use.
-
RequestPayloadName: string
Title:
Request Payload Attribute NameMaximum Length:256The key in the Key Value pair that forms the payload. -
SmartSuggestPath: string
Title:
Smart Suggest PathMaximum Length:2048The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseBoolean value. -
Value: string
Title:
Request Payload Attribute ValueMaximum Length:1000The value in the Key Value pair that forms the payload. -
ValueStruct: string
Title:
Payload Value StructureMaximum Length:20If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : mdfClaims-Note-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object-
Binding: string
Title:
URL Binding TypeMaximum Length:64This is a hint for processing the Url Binding runtime. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseBoolean indicator. -
URLBindingId: integer
(int64)
Uniquely identifies the URL Bind for smart actions. For internal use.
-
URLBindingName: string
Title:
URL Binding Parameter NameMaximum Length:256For action REST endpoints that require runtime binding, this is the key in the key value pair. -
Value: string
Title:
URL Binding Parameter ValueMaximum Length:1000For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : mdfClaims-smartActions-item-response
Type:
Show Source
object-
ActionIntent: string
(byte)
Title:
Action IntentJSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation MessageMaximum Length:4000A message to seek confirmation for the action being performed. -
ContentType: string
Title:
Content TypeMaximum Length:50The content type to use when invoking the REST endpoint. -
DisplayLabel: string
Title:
Action NameMaximum Length:256Consumer-friendly action name. -
Entity: string
Title:
Parent EntityMaximum Length:150REST Resources the action belongs to. -
Href: string
Title:
REST EndpointMaximum Length:1024The REST endpoint to perform the action. -
IncludedInApplication: string
Title:
Included in ApplicationMaximum Length:512List of applications that this action can be used in. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass ActionMaximum Length:1Boolean type indicating if this action can be mass processed. -
Method: string
Title:
HTTP MethodMaximum Length:15HTTP method to use with HREF. -
ObjectFunctionName: string
Title:
Object FunctionMaximum Length:64The object function associated with the smart action. -
PageType: string
Title:
Page TypeMaximum Length:256The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart SuggestMaximum Length:1Indicates if smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Boolean type indicating if the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to UpdateMaximum Length:512Attributes to be updated when the Actions UI is launched. -
UserActionId: integer
(int64)
Title:
User Action IDUniquely identifies the action. For internal use. -
UserActionName: string
Title:
Action NameMaximum Length:256Uniquely identifies the action with a name. For internal use. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
PriorityNumber to indicate priority of the action. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload DefinitionsIf an LOV required for constructing a request payload needs to post data, the payload metadata is stored here. -
UserActionURLBinding: array
Smart Action User Interface Definitions
Title:
Smart Action User Interface DefinitionsBinding metadata for a variable in the URL.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type:
arrayTitle:
Smart Action REST Payload DefinitionsIf 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:
arrayTitle:
Smart Action User Interface DefinitionsBinding metadata for a variable in the URL.
Show Source
Nested Schema : mdfClaims-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object-
Binding: string
Title:
Payload Value Binding TypeMaximum Length:64Indicates the binding type of the value. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
MandatoryMaximum Length:1Boolean value indicating if the payload is mandatory. -
RequestPayloadId: integer
(int64)
Uniquely identifies the payload for smart actions. For internal use.
-
RequestPayloadName: string
Title:
Request Payload Attribute NameMaximum Length:256The key in the Key Value pair that forms the payload. -
SmartSuggestPath: string
Title:
Smart Suggest PathMaximum Length:2048The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseBoolean value. -
Value: string
Title:
Request Payload Attribute ValueMaximum Length:1000The value in the Key Value pair that forms the payload. -
ValueStruct: string
Title:
Payload Value StructureMaximum Length:20If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : mdfClaims-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object-
Binding: string
Title:
URL Binding TypeMaximum Length:64This is a hint for processing the Url Binding runtime. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseBoolean indicator. -
URLBindingId: integer
(int64)
Uniquely identifies the URL Bind for smart actions. For internal use.
-
URLBindingName: string
Title:
URL Binding Parameter NameMaximum Length:256For action REST endpoints that require runtime binding, this is the key in the key value pair. -
Value: string
Title:
URL Binding Parameter ValueMaximum Length:1000For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- Attachments
-
Parameters:
- ClaimCode:
$request.path.ClaimCode
The attachments resource is used to view, create, and update attachments. - ClaimCode:
- BudgetLOVVA
-
Operation: /crmRestApi/resources/11.13.18.05/mdfBudgetsParameters:
- finder:
MdfRestActiveBudgetFinder%3BbindStatus%3DACTIVE
The list of values containing the display names of the budgets associated with the claims.
The following properties are defined on the LOV link relation:- Source Attribute: BudgetName; Target Attribute: BudgetName
- Display Attribute: BudgetName
- finder:
- ClaimApprovalHistory
-
Parameters:
- ClaimCode:
$request.path.ClaimCode
The claim approval history lets you access a comprehensive record of approval-related information associated with the claim, encompassing the names of approvers, action dates, and the specific actions taken. - ClaimCode:
- ClaimResource
-
Parameters:
- ClaimCode:
$request.path.ClaimCode
The claim team members resource is used to view, create, update, and delete a claim team member. A claim team member is a resource who is assigned to the MDF claim team, and who has the appropriate visibility and access to the MDF Claim record. - ClaimCode:
- ClaimSettlements
-
Parameters:
- ClaimCode:
$request.path.ClaimCode
The claim settlements resource is used to view, create, update, and delete the payments made to partners as reimbursement for the marketing expenses incurred by that partner. - ClaimCode:
- ClaimStatusLOVVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKT_MDF_FUNDREQ_STATUS%2CBindLookupCode%3D{ClaimStatusCode}
The list of values indicating the status of the MDF claim.
The following properties are defined on the LOV link relation:- Source Attribute: ClaimStatusCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- CurrencyLOVVA
-
The following properties are defined on the LOV link relation:
- Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
- Display Attribute: CurrencyCode
- FundRequestLOVVA_WithoutBudget
-
Parameters:
- finder:
MdfRequestsRestFinder%3BbindStatus_1%3DAPPROVED
The list of values to indicate the approved fund request name associated to the claim.
The following properties are defined on the LOV link relation:- Source Attribute: FundRequestName; Target Attribute: FundRequestName
- Display Attribute: FundRequestName
- finder:
- FundRequestTypeMeaningVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_MDFREQUEST_TYPE%2CBindLookupCode%3D{FundRequestType}
The list of values to indicate the fund request type for associated fund request.
The following properties are defined on the LOV link relation:- Source Attribute: FundRequestType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- Note
-
Parameters:
- ClaimCode:
$request.path.ClaimCode
The notes resource is used to view, create, update, and delete notes associated with a claim. A note captures comments, information, or instructions related to a claim. - ClaimCode:
- PartnerNameVA
-
The list of values containing the unique identifiers of the partners associated with the MDF claim.
The following properties are defined on the LOV link relation:- Source Attribute: PartnerId; Target Attribute: PartyId
- Display Attribute: PartyId
- RecordSetVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_MDF_CLAIM_RECORD_SET%2CBindLookupCode%3D{RecordSet}
The list of values that lets you to select the record set.
The following properties are defined on the LOV link relation:- Source Attribute: RecordSet; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- RejectReasonCodeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{RejectReasonCode}%2CBindLookupType%3DORA_MKT_MDFCLAIM_REJECT
The list of values to indicate the reject reason of the claim.
The following properties are defined on the LOV link relation:- Source Attribute: RejectReasonCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- ResourceVOVA
-
Operation: /crmRestApi/resources/11.13.18.05/resourcesThe list of values containing the names of the owners associated with MDF claims.
The following properties are defined on the LOV link relation:- Source Attribute: OwnerName; Target Attribute: PartyName
- Display Attribute: PartyName
- ReturnReasonCodeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{ReturnReasonCode}%2CBindLookupType%3DORA_MKT_MDFCLAIM_RETURN
The list of values to indicate the return reason of the claim.
The following properties are defined on the LOV link relation:- Source Attribute: ReturnReasonCode; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- smartActions
-
Parameters:
- ClaimCode:
$request.path.ClaimCode
This VO stores the endpoint and security details for every user action. - ClaimCode:
Examples
The following example shows how to get an mdf claim by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \ -X
https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}
Example of Response Body
The following shows an example of the response body in JSON format.
{
"RecordSet": null,
"ClaimId": 300100006856455,
"FundRequestId": 300100006817301,
"ClaimName": "QTPClaim646201224712120103",
"Description": null,
"CurrencyCode": "USD",
"Age": 3482,
"ClaimAmount": 50,
"ApprovedAmount": 0,
"ClaimCode": "CLM-2012-04-06 02:56:28.294",
"ClaimStatusCode": "DRAFT",
"ApprovedBy": null,
"ApprovedDate": null,
"RejectedBy": null,
"RejectedDate": null,
"SubmittedDate": null,
"CreatedBy": "CHANNEL_ACCOUNT_MANAGER",
"CreationDate": "2012-04-06T02:56:28+00:00",
"LastUpdatedBy": "Account_MgrENT1 CAM",
"LastUpdateLogin": "BCFDB100DD7A3B23E0432220F00AE860",
"LastUpdateDate": "2012-04-06T02:57:09.800+00:00",
"FundRequestName": "FR646201224712120102",
"SubmittedBy": null,
"FundRequestCurrency": "USD",
"Comments": null,
"ConversionRateType": "Corporate",
"ConversionCurrencyCode": "USD",
"OutstngClaimLiabilityAmount": 0,
"OwnerId": null,
"OwnerName": null,
"ChannelMgrName": "Account_MgrENT1 CAM",
"FundRequestType": null,
"ActivityOutcome": null,
"FundRequestApprovedAmount": 100,
"ChannelManagerId": 100010038017873,
"PartnerPartyUniqueName": "Stryker Corp.",
"OwnerPrimaryPhoneNumber": null,
"OwnerEmailAddress": null,
"ApprovedById": null,
"CurrencyConversionDate": null,
"RejectedById": null,
"SubmittedById": null,
"CanSubmit": "false",
"CanTerminate": "false",
"OwnerFormattedPhoneNumber": null,
"CanApprove": "false",
"CanReject": "false",
"CanWithdraw": "false",
"CanReturn": "false",
"FrExchangeRate": 1,
"ReturnReasonCode": null,
"RejectReasonCode": null,
"ApprovalActionComments": null,
"ConvExchangeRate": 1,
"UpdateFlag": true,
"DeleteFlag": true,
"ApprovalTaskStatusCode": null,
"BgtExchangeRate": 1,
"FundRequestCode": "FRC646201224712120104",
"OwnerPartyNumber": null,
"SubmitClaimsBy": "2012-06-05",
"BudgetName": "QTPBudgetAuto646201224712120101",
"BudgetCurrency": "USD",
"BudgetStartDate": "2012-04-06",
"BudgetEndDate": "2012-06-07",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CLM-2012-04-06%2002%3A56%3A28.294",
"name": "mdfClaims",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CLM-2012-04-06%2002%3A56%3A28.294",
"name": "mdfClaims",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CLM-2012-04-06%2002%3A56%3A28.294/lov/ClaimStatusLOVVA",
"name": "ClaimStatusLOVVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CLM-2012-04-06%2002%3A56%3A28.294/lov/CurrencyLOVVA",
"name": "CurrencyLOVVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CLM-2012-04-06%2002%3A56%3A28.294/lov/ReturnReasonCodeVA",
"name": "ReturnReasonCodeVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CLM-2012-04-06%2002%3A56%3A28.294/lov/ResourceVOVA",
"name": "ResourceVOVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CLM-2012-04-06%2002%3A56%3A28.294/lov/FundRequestLOVVA_WithoutBudget",
"name": "FundRequestLOVVA_WithoutBudget",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CLM-2012-04-06%2002%3A56%3A28.294/lov/RejectReasonCodeVA",
"name": "RejectReasonCodeVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CLM-2012-04-06%2002%3A56%3A28.294/lov/BudgetLOVVA",
"name": "BudgetLOVVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CLM-2012-04-06%2002%3A56%3A28.294/lov/RecordSetVA",
"name": "RecordSetVA",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CLM-2012-04-06%2002%3A56%3A28.294/child/Attachments",
"name": "Attachments",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CLM-2012-04-06%2002%3A56%3A28.294/child/ClaimResource",
"name": "ClaimResource",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CLM-2012-04-06%2002%3A56%3A28.294/child/ClaimSettlements",
"name": "ClaimSettlements",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CLM-2012-04-06%2002%3A56%3A28.294/child/Note",
"name": "Note",
"kind": "collection"
}
]
}