Update an MDF claim
patch
/crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}
Request
Path Parameters
-
ClaimCode(required): string
The user-defined, unique label for the MDF claim.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ActivityOutcome: string
Title:
Activity Outcome
Maximum Length:1000
Partner Activity Out come. -
ApprovalActionComments: string
Title:
Approver Comments
The comments entered during approval action on the claim. -
ApprovalTaskStatusCode: string
Title:
Status
The code indicating the approval action that can be taken in the MDF Claim. The accepted values are Approve, Reject, Return, Withdraw, Terminate, and HtOutcmeReturnReturnAction. -
ApprovedAmount: number
Title:
Approved Amount
Default Value:0
The amount approved for the MDF claim. -
ApprovedBy: string
Title:
Approvers
Maximum Length:64
The user who approved the MDF claim. -
ApprovedById: integer
(int64)
Title:
Approved by ID
The unique identifier of the user who approved the MDF claim. -
ApprovedDate: string
(date)
Title:
Approved Date
The date when the MDF claim was approved. -
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
BgtExchangeRate: number
Title:
Conversion Rate to Budget
Default Value:0
The exchange rate of the MDF budget which is associated with the claim. MDF budget is associated to the claim through fund request. -
BudgetName: string
Title:
Budget
Maximum Length:250
The display name of the marketing budget associated to the MDF claim. -
ChannelMgrName: string
Title:
Channel Manager
The name of the channel manager on the claim. -
ClaimAmount: number
Title:
Requested Amount
The amount of reimbursement requested in the MDF claim. -
ClaimName: string
Title:
Name
Maximum Length:250
The display name of the MDF claim. -
ClaimResource: array
Claim Team Members
Title:
Claim Team Members
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. -
ClaimSettlements: array
Claim Settlements
Title:
Claim Settlements
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. -
ClaimStatusCode: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The code indicating the status of the MDF claim. -
Comments: string
Title:
Comments
Maximum Length:1000
Any additional comments for the MDF claim. -
ConvExchangeRate: number
Title:
Conversion Exchange Rate
The currency exchange rate for the claim against the corporate currency. -
CurrencyCode: string
Title:
Currency
Maximum Length:30
The 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 Date
The date of currency exchange rate for the claim against the corporate currency. -
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. -
FundRequestCode: string
Title:
Fund Request Code
Maximum Length:100
Public Unique Identifier for the marketing fund request. -
FundRequestId: integer
(int64)
Title:
Fund Request ID
The unique identifier of the MDF fund request associated with the MDF claim. -
FundRequestName: string
Title:
MDF Request
Maximum Length:250
The name of the fund request associated with the claim. -
Note: array
Notes
Title:
Notes
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. -
OutstngClaimLiabilityAmount: number
Title:
Liability Amount
Default Value:0
The outstanding claim liability amount. -
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 owner of the MDF 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. -
SubmittedBy: string
Title:
Submitted By
Maximum Length:64
The user who submitted the MDF claim. -
SubmittedById: integer
(int64)
Title:
Submitted by ID
The unique identifier of the user who submitted the MDF claim. -
SubmittedDate: string
(date)
Title:
Submitted Date
The date when the MDF claim was submitted.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Claim Team Members
Type:
array
Title:
Claim Team Members
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.
Show Source
Nested Schema : Claim Settlements
Type:
array
Title:
Claim Settlements
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.
Show Source
Nested Schema : Notes
Type:
array
Title:
Notes
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.
Show Source
Nested Schema : mdfClaims-Attachments-item-patch-request
Type:
Show Source
object
-
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment.
Nested Schema : schema
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Access
Maximum Length:30
The code indicating the level of access of a MDF claim team member. -
MemberFunctionCode: string
Title:
Function
Maximum Length:30
The code indicating the function of the MDF claim team member. -
UserLastUpdateDate: string
(date-time)
Title:
Last Update Date
The date and time when the MDF claim team member record was last updated.
Nested Schema : schema
Type:
Show Source
object
-
AccountingType: string
Title:
Accounting Type
Maximum Length:30
The accounting type of the MDF claim settlement, which represents credit or debit in the back-end financial system. -
ClaimSettlementAmount: number
Title:
Amount
The amount settled in the MDF claim settlement. -
ClaimSettlementCode: string
Title:
Code
Maximum Length:100
The user-defined, unique label for the MDF claim settlement. -
ClaimSettlementType: string
Title:
Type
Maximum Length:30
The type of the MDF claim settlement, for example deduction or payment. -
CurrencyCode: string
Title:
Currency
Maximum Length:30
The 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. -
Description: string
Title:
Description
Maximum Length:1000
A brief description of the marketing claim settlement. -
InvoiceReference: string
Title:
Transaction Reference
Maximum Length:100
The reference identifier of the invoice to be settled with the MDF claim settlement. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:INCOMPLETE
The code indicating the completion status of the marketing claim settlement. -
TransactionDate: string
(date)
Title:
Transaction Date
The date when the claim settlement was processed or marked as complete. -
TransactionMethod: string
Title:
Transaction Method
Maximum Length:30
The method by which the claim settlement transaction was processed.
Nested Schema : mdfClaims-Note-item-patch-request
Type:
Show Source
object
-
ContactRelationshipId: integer
(int64)
Title:
Contact Relationship ID
The 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 Code
Maximum Length:15
The 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. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique identifier of the party that the note creator belongs to. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
NoteTitle: string
Title:
Title
Maximum Length:500
The title of the note entered by the user. -
NoteTxt: string
(byte)
Title:
Note
The actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
This is the note type code for categorization of note. A list of valid values is defined in the lookup NoteSourceTypeVA. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The primary key identifier of the source object as defined in OBJECTS Metadata. -
VisibilityCode: string
Title:
Private
Maximum Length:30
Default Value:INTERNAL
The code indicating the visibility level of the note, such as internal or external.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : mdfClaims-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 MDF claim was created. -
ApprovalActionComments: string
Title:
Approver Comments
The comments entered during approval action on the claim. -
ApprovalTaskStatusCode: string
Title:
Status
The code indicating the approval action that can be taken in the MDF Claim. The accepted values are Approve, Reject, Return, Withdraw, Terminate, and HtOutcmeReturnReturnAction. -
ApprovedAmount: number
Title:
Approved Amount
Default Value:0
The amount approved for the MDF claim. -
ApprovedBy: string
Title:
Approvers
Maximum Length:64
The user who approved the MDF claim. -
ApprovedById: integer
(int64)
Title:
Approved by ID
The unique identifier of the user who approved the MDF claim. -
ApprovedDate: string
(date)
Title:
Approved Date
The date when the MDF claim was approved. -
Attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
BgtExchangeRate: number
Title:
Conversion Rate to Budget
Default Value:0
The exchange rate of the MDF budget which is associated with the claim. MDF budget is associated to the claim through fund request. -
BudgetCurrency: string
Title:
Budget Currency
Read Only:true
Maximum Length:30
The currency used for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request. -
BudgetEndDate: string
(date)
Title:
Budget End Date
Read Only:true
The end date for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request. -
BudgetName: string
Title:
Budget
Maximum Length:250
The display name of the marketing budget associated to the MDF claim. -
BudgetStartDate: string
(date)
Title:
Start Date
Read Only:true
The start date for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request. -
CanApprove: boolean
Title:
Can Approve
Read Only:true
Indicates whether the user can approve the MDF Claim. If the user has access to approve an MDF claim then the default value is true, else false. -
CanReject: boolean
Title:
Can Reject
Read Only:true
Indicates whether the user has access to reject the claim. -
CanReturn: boolean
Title:
Can Return
Read Only:true
Indicates whether the user has access to return the claim. -
CanSubmit: boolean
Title:
Can Submit
Read Only:true
Indicates whether the user has access to submit the claim. -
CanTerminate: boolean
Title:
Can Terminate
Read Only:true
Indicates whether the user has access to terminate the claim. -
CanWithdraw: boolean
Title:
Can Withdraw
Read Only:true
Indicates whether the user has access to withdraw the claim. -
ChannelManagerId: integer
(int64)
Title:
Account Director ID
Read Only:true
The unique identifier of the account director associated with the claim. -
ChannelMgrName: string
Title:
Channel Manager
The name of the channel manager on the claim. -
ClaimAmount: number
Title:
Requested Amount
The amount of reimbursement requested in the MDF claim. -
ClaimCode: string
Title:
Code
Maximum Length:100
The user-defined, unique label for the MDF claim. -
ClaimId: integer
(int64)
Title:
Claim ID
The unique identifier of the MDF claim. -
ClaimName: string
Title:
Name
Maximum Length:250
The display name of the MDF claim. -
ClaimResource: array
Claim Team Members
Title:
Claim Team Members
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. -
ClaimSettlements: array
Claim Settlements
Title:
Claim Settlements
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. -
ClaimStatusCode: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The code indicating the status of the MDF claim. -
Comments: string
Title:
Comments
Maximum Length:1000
Any additional comments for the MDF claim. -
ConversionCurrencyCode: string
Title:
Conversion Currency Code
Read Only:true
Maximum Length:30
The currency code used for conversion in the claim. -
ConversionRateType: string
Title:
Conversion Rate Type
Read Only:true
Maximum Length:30
The currency conversion rate type associated with the MDF claim. -
ConvExchangeRate: number
Title:
Conversion Exchange Rate
The currency exchange rate for the claim against the corporate currency. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the MDF claim. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the MDF claim was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:30
The 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 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 on the associated fund request. -
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 on the associated fund request. -
FundRequestId: integer
(int64)
Title:
Fund Request ID
The unique identifier of the MDF fund 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 fund request associated with the claim. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the claim was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the 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. -
Note: array
Notes
Title:
Notes
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. -
OutstngClaimLiabilityAmount: number
Title:
Liability Amount
Default Value:0
The outstanding claim liability amount. -
OwnerEmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the owner. -
OwnerFormattedPhoneNumber: string
Title:
Phone
Read Only:true
The formatted phone of the owner. -
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 owner of the MDF claim. -
OwnerPartyNumber: string
Title:
Owner Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the owner party. -
OwnerPrimaryPhoneNumber: string
Title:
Phone
Read Only:true
Maximum Length:40
The phone number of the owner. -
PartnerPartyUniqueName: string
Title:
Partner
Read Only:true
Maximum Length:360
The name of the partner associated with the claim. -
RecordSet: string
Title:
Record Set
Read Only:true
The record set values 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 date by which associated claim needs to be submitted. -
SubmittedBy: string
Title:
Submitted By
Maximum Length:64
The user who submitted the MDF claim. -
SubmittedById: integer
(int64)
Title:
Submitted by ID
The unique identifier of the user who submitted the MDF claim. -
SubmittedDate: string
(date)
Title:
Submitted Date
The date 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 : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Claim Team Members
Type:
array
Title:
Claim Team Members
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.
Show Source
Nested Schema : Claim Settlements
Type:
array
Title:
Claim Settlements
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.
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 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 : mdfClaims-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 : mdfClaims-ClaimResource-item-response
Type:
Show Source
object
-
AccessLevelCode: string
Title:
Access
Maximum Length:30
The code indicating the level of access of a MDF claim team member. -
ClaimCode: string
Title:
Code
Maximum Length:100
The user-defined, unique label for the marketing claim. -
ClaimId: integer
(int64)
Title:
Claim ID
The unique identifier of the MDF claim associated with the resource. -
ClaimResourceId: integer
(int64)
Title:
Claim Resource ID
The unique identifier of a member of the MDF request team. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the resource on the MDF claim team. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the resource was created on the MDF claim team. -
EmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the MDF claim team member associated with the MDF claim. -
FormattedPhoneNumber: string
Title:
Phone
Read Only:true
The phone number of the MDF claim team member associated with the MDF claim. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the resource was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the MDF claim team member. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the resource. -
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 claim team member. -
OwnerFlag: boolean
Title:
Owner
Read Only:true
Indicates whether the MDF claim team member is the owner of the MDF claim. -
PartyName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the MDF claim team member associated with the MDF claim. -
ResourceId: integer
(int64)
Title:
Resource ID
The unique identifier of the MDF claim team member. -
ResourcePartyNumber: string
Title:
Resource Party Number
Read Only:true
Maximum Length:30
The alternate key identifier of the resource party. -
ResourceUsername: string
Title:
Resource User Name
Read Only:true
The username of the MDF claim team member associated with the MDF claim. -
UserLastUpdateDate: string
(date-time)
Title:
Last Update Date
The date and time when the MDF claim team member record was last updated.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : mdfClaims-ClaimSettlements-item-response
Type:
Show Source
object
-
AccountingType: string
Title:
Accounting Type
Maximum Length:30
The accounting type of the MDF claim settlement, which represents credit or debit in the back-end financial system. -
AccountingTypeMeaning: string
Title:
Accounting Type
Read Only:true
The 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 Budget
Read Only:true
Default Value:1
The exchange rate used to convert the marketing claim settlement currency to the parent budget currency. -
BudgetId: number
Title:
Budget ID
Read Only:true
The unique identifier of the parent budget associated with the MDF claim. -
BudgetName: string
Title:
Name
Read Only:true
Maximum Length:250
The name of the MDF budget associated with the claim. MDF budget is associated to the claim through fund request. -
ClaimCode: string
Title:
Code
Maximum Length:100
The user-defined, unique label for the marketing claim. -
ClaimCurrencyExchangeRate: number
Title:
Conversion Rate to Claim
Read Only:true
Default Value:1
The exchange rate used to convert the marketing claim settlement currency to the parent marketing claim currency. -
ClaimId: number
Title:
Claim ID
The unique identifier of the MDF claim. -
ClaimName: string
Title:
Name
Read Only:true
Maximum Length:250
The name of the claim associated with the claim settlement. -
ClaimSettlementAmount: number
Title:
Amount
The amount settled in the MDF claim settlement. -
ClaimSettlementCode: string
Title:
Code
Maximum Length:100
The user-defined, unique label for the MDF claim settlement. -
ClaimSettlementId: integer
Title:
Claim Settlement ID
The unique identifier of the MDF claim settlement. -
ClaimSettlementType: string
Title:
Type
Maximum Length:30
The type of the MDF claim settlement, for example deduction or payment. -
ClaimSettlmntTypeMeaning: string
Title:
Type
Read Only:true
The type of marketing claim settlement, for example deduction or payment. -
ClaimStatusCode: string
Title:
Status
Read Only:true
Maximum Length:30
The status of the claim settlement. -
ConversionCurrencyCode: string
Title:
Conversion Currency Code
Read Only:true
Maximum Length:30
The currency code associated with the claim settlement. -
ConversionRateType: string
Title:
Conversion Rate Type
Read Only:true
Maximum Length:30
The conversion rate type associated with the claim settlement. -
ConvExchangeRate: number
Title:
Conversion Exchange Rate
Read Only:true
The currency exchange rate for the claim settlement against the corporate currency. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the MDF claim settlement. -
CreatedById: integer
(int64)
Title:
Created by ID
Read Only:true
The unique identifier of the creator of the claim settlement. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the claim settlement was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:30
The 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 Date
Read Only:true
The date of currency exchange rate for the claim settlement against the corporate currency. -
Description: string
Title:
Description
Maximum Length:1000
A brief description of the marketing claim settlement. -
InvoiceReference: string
Title:
Transaction Reference
Maximum Length:100
The reference identifier of the invoice to be settled with the MDF claim settlement. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the settlement was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the marketing claim settlement. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the settlement. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OutstandingClaimLiabilityAmount: number
Title:
Liability Amount
Read Only:true
Default Value:0
The outstanding claim liability amount. -
PartnerId: integer
(int64)
Title:
Partner ID
Read Only:true
The unique identifier of the party. -
PartnerName: string
Title:
Partner
Read Only:true
The name of the party. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:INCOMPLETE
The code indicating the completion status of the marketing claim settlement. -
StatusMeaning: string
Title:
Status
Read Only:true
The completion status of the marketing claim settlement. -
TransactionDate: string
(date)
Title:
Transaction Date
The date when the claim settlement was processed or marked as complete. -
TransactionMethod: string
Title:
Transaction Method
Maximum Length:30
The method by which the claim settlement transaction was processed. -
TransactionMethodMeaning: string
Title:
Transaction Method
Read Only:true
The method by which claim settlement transaction is processed.
Nested Schema : Links
Type:
array
Title:
Links
The 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 ID
The 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 Code
Maximum Length:15
The 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 By
Read Only:true
Maximum Length:64
The user who created the note. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the note was created. -
CreatorPartyId: integer
(int64)
Title:
Creator Party ID
The unique identifier of the party that the note creator belongs to. -
CurcyConvRateType: string
Title:
Currency Conversion Rate Type
Maximum Length:30
The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
CurrencyCode: string
Title:
Currency
Maximum Length:15
The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the note is to be deleted. If the value is Y, then the note has to be deleted. The default value is N. -
EmailAddress: string
Title:
Primary Email
Read Only:true
Maximum Length:320
The email address of the user who created the note. -
FormattedAddress: string
Title:
Primary Address
Read Only:true
The address of the user who created the note. -
FormattedPhoneNumber: string
Title:
Primary Phone
Read Only:true
The phone number of the user who created the note. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date and time when the note data was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the note. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the note. -
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 claim. 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 actual note text. -
NoteTypeCode: string
Title:
Type
Maximum Length:30
This 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 ID
The unique identifier of the parent note. -
PartyId: integer
(int64)
Title:
Party ID
Read Only:true
The unique identifier of the party associated with the note. -
PartyName: string
Title:
Author
Read Only:true
Maximum Length:360
The name of an MDF claim party. -
SourceObjectCode: string
Title:
Related Object Type
Maximum Length:30
The code indicating the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, Sales Business Plan, and so on. -
SourceObjectId: string
Title:
Related Object
Maximum Length:64
The primary key 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
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:
- 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:
- 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:
- 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: