Jump to

• Request
• Response

Create a claim

post

/crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Claim

Request

Path Parameters

• FundRequestCode(required): string
  The code indicating the user-defined, unique label for the MDF request.

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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 claim.
• ApprovedBy: string
  Title: Approvers

  Maximum Length: 64

  The user who approved the MDF claim.
• ApprovedById: integer (int64)
  Title: Approved by ID

  The unique identifier of the user who approved the MDF claim.
• ApprovedDate: string (date)
  Title: Approved Date

  The date when the MDF claim was approved.
• BgtExchangeRate: number
  Title: Conversion Rate to Budget

  Default Value: 0

  The exchange rate of the MDF budget which is associated with the MDF claim. MDF budget is associated to the claim through fund request.
• BudgetName: string
  Title: Budget

  Maximum Length: 250

  The name of the MDF request budget associated with the MDF claim.
• ChannelMgrName: string
  Title: Channel Manager

  The name of the channel manager of the MDF claim.
• ClaimAmount: number
  Title: Requested Amount

  The amount requested in the MDF claim.
• ClaimCode: string
  Title: Code

  Maximum Length: 100

  The user-defined or system generated code for the MDF claim.
• ClaimId: integer (int64)
  Title: Claim ID

  The unique identifier of the claim. This is a system-generated value.
• ClaimName: string
  Title: Name

  Maximum Length: 250

  The name of the MDF claim.
• ClaimStatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: DRAFT

  The code indicating the status of the MDF claim. A list of valid values is defined in the lookup ClaimStatusCode. The valid values are Approved, Draft, Failed, Pending Approval, Rejected, Returned, Terminated, or Withdrawn.
• Comments: string
  Title: Comments

  Maximum Length: 1000

  The additional comments on the MDF claim.
• 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 associated with the claim. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyConversionDate: string (date)
  Title: Currency Conversion Date

  The date of currency exchange rate for the claim against the corporate currency.
• 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 request associated with the MDF claim.
• FundRequestName: string
  Title: MDF Request

  Maximum Length: 250

  The name of the fund request associated with the claim.
• OutstngClaimLiabilityAmount: number
  Title: Liability Amount

  Default Value: 0

  The approved claim amount pending to be paid.
• OwnerId: integer (int64)
  Title: Owner ID

  The unique identifier of the owner of the MDF claim.
• OwnerName: string
  Title: Owner

  Maximum Length: 360

  The name of the MDF claim owner.
• 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 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.

{
    "type":"object",
    "properties":{
        "RejectedDate":{
            "title":"Rejected Date",
            "type":"string",
            "description":"The date when the MDF claim was rejected.",
            "format":"date",
            "nullable":true
        },
        "ClaimId":{
            "title":"Claim ID",
            "type":"integer",
            "description":"The unique identifier of the claim. This is a system-generated value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OwnerName":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the MDF claim owner.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "="
                ]
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"A brief description of the MDF claim.",
            "nullable":true,
            "x-queryable":false
        },
        "ClaimStatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the status of the MDF claim. A list of valid values is defined in the lookup ClaimStatusCode. The valid values are Approved, Draft, Failed, Pending Approval, Rejected, Returned, Terminated, or Withdrawn.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            }
        },
        "ApprovedById":{
            "title":"Approved by ID",
            "type":"integer",
            "description":"The unique identifier of the user who approved the MDF claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CurrencyConversionDate":{
            "title":"Currency Conversion Date",
            "type":"string",
            "description":"The date of currency exchange rate for the claim against the corporate currency.",
            "format":"date",
            "nullable":true
        },
        "FundRequestCode":{
            "title":"Fund Request Code",
            "maxLength":"100",
            "type":"string",
            "description":"Public Unique Identifier for the marketing fund request.",
            "nullable":false
        },
        "RejectedBy":{
            "title":"Rejected By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who rejected the MDF claim.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            }
        },
        "SubmittedDate":{
            "title":"Submitted Date",
            "type":"string",
            "description":"The date when the MDF claim was submitted.",
            "format":"date",
            "nullable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"30",
            "type":"string",
            "description":"The currency code associated with the claim. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "="
                ]
            }
        },
        "FrExchangeRate":{
            "title":"Fund Request Exchange Rate",
            "type":"number",
            "description":"The exchange rate of the fund request associated with the claim.",
            "nullable":true,
            "default":"0"
        },
        "ClaimAmount":{
            "title":"Requested Amount",
            "type":"number",
            "description":"The amount requested in the MDF claim.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">="
                ]
            }
        },
        "FundRequestName":{
            "title":"MDF Request",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the fund request associated with the claim.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "="
                ],
                "dependencies":[
                    "BudgetId",
                    "BudgetName"
                ]
            }
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of the owner of the MDF claim.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            }
        },
        "ConvExchangeRate":{
            "title":"Conversion Exchange Rate",
            "type":"number",
            "description":"The currency exchange rate for the claim against the corporate currency.",
            "nullable":true
        },
        "ActivityOutcome":{
            "title":"Activity Outcome",
            "maxLength":"1000",
            "type":"string",
            "description":"Partner Activity Out come.",
            "nullable":true
        },
        "ClaimCode":{
            "title":"Code",
            "maxLength":"100",
            "type":"string",
            "description":"The user-defined or system generated code for the MDF claim.",
            "nullable":false
        },
        "OutstngClaimLiabilityAmount":{
            "title":"Liability Amount",
            "type":"number",
            "description":"The approved claim amount pending to be paid.",
            "nullable":true,
            "default":"0",
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">="
                ]
            }
        },
        "BgtExchangeRate":{
            "title":"Conversion Rate to Budget",
            "type":"number",
            "description":"The exchange rate of the MDF budget which is associated with the MDF claim. MDF budget is associated to the claim through fund request.",
            "nullable":false,
            "default":"0",
            "x-queryable":false
        },
        "ApprovedDate":{
            "title":"Approved Date",
            "type":"string",
            "description":"The date when the MDF claim was approved.",
            "format":"date",
            "nullable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"1000",
            "type":"string",
            "description":"The additional comments on the MDF claim.",
            "nullable":true,
            "x-queryable":false
        },
        "ApprovalActionComments":{
            "title":"Approver Comments",
            "type":"string",
            "description":"The comments entered during approval action on the claim.",
            "nullable":true,
            "x-queryable":false
        },
        "SubmittedBy":{
            "title":"Submitted By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who submitted the claim.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            }
        },
        "SubmittedById":{
            "title":"Submitted by ID",
            "type":"integer",
            "description":"The unique identifier of the user who submitted the MDF claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ReturnReasonCode":{
            "title":"Return Reason",
            "type":"string",
            "description":"The reason code for returning the claim back to the submitter.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FundRequestId":{
            "title":"Fund Request ID",
            "type":"integer",
            "description":"The unique identifier of the MDF request associated with the MDF claim.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "dependencies":[
                    "BudgetId"
                ]
            }
        },
        "ClaimName":{
            "title":"Name",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the MDF claim.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            }
        },
        "RejectReasonCode":{
            "title":"Reject Reason",
            "type":"string",
            "description":"The reason code for rejecting the claim.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ApprovedAmount":{
            "title":"Approved Amount",
            "type":"number",
            "description":"The amount approved for the claim.",
            "nullable":true,
            "default":"0"
        },
        "ApprovalTaskStatusCode":{
            "title":"Status",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "ApprovedBy":{
            "title":"Approvers",
            "maxLength":"64",
            "type":"string",
            "description":"The user who approved the MDF claim.",
            "nullable":true
        },
        "ChannelMgrName":{
            "title":"Channel Manager",
            "type":"string",
            "description":"The name of the channel manager of the MDF claim.",
            "nullable":true,
            "x-queryable":false
        },
        "RejectedById":{
            "title":"Rejected by ID",
            "type":"integer",
            "description":"The unique identifier of the user who rejected the MDF claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "BudgetName":{
            "title":"Budget",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the MDF request budget associated with the MDF claim.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "="
                ]
            }
        }
    }
}

Back to Top

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.

Body ()

Root Schema : mdfRequests-Claim-item-response

Type: object

Show Source

• ActivityOutcome: string
  Title: Activity Outcome

  Maximum Length: 1000

  Partner Activity Out come.
• Age: number
  Title: Claim Age

  Read Only: true

  The number of days since the creation of the claim.
• ApprovalActionComments: string
  Title: Approver Comments

  The comments entered during approval action on the claim.
• ApprovalTaskStatusCode: string
  Title: Status

  The code indicating the approval action that can be taken in the MDF Claim. The accepted values are Approve, Reject, Return, Withdraw, Terminate, and HtOutcmeReturnReturnAction.
• ApprovedAmount: number
  Title: Approved Amount

  Default Value: 0

  The amount approved for the claim.
• ApprovedBy: string
  Title: Approvers

  Maximum Length: 64

  The user who approved the MDF claim.
• ApprovedById: integer (int64)
  Title: Approved by ID

  The unique identifier of the user who approved the MDF claim.
• ApprovedDate: string (date)
  Title: Approved Date

  The date when the MDF claim was approved.
• BgtExchangeRate: number
  Title: Conversion Rate to Budget

  Default Value: 0

  The exchange rate of the MDF budget which is associated with the MDF claim. MDF budget is associated to the claim through fund request.
• BudgetCurrency: string
  Title: Budget Currency

  Read Only: true

  Maximum Length: 30

  The currency code associated with the MDF budget. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• BudgetEndDate: string (date)
  Title: Budget End Date

  Read Only: true

  The date when the budget ends.
• BudgetName: string
  Title: Budget

  Maximum Length: 250

  The name of the MDF request budget associated with the MDF claim.
• BudgetStartDate: string (date)
  Title: Start Date

  Read Only: true

  The date when the budget starts.
• CanApprove: boolean
  Title: Can Approve

  Read Only: true

  Indicates if the user can approve the claim or an MDF request. If the user has access to approve a claim or an MDF request, then the default value is true, else false.
• CanReject: boolean
  Title: Can Reject

  Read Only: true

  Indicates if the user can reject the claim or an MDF request. If the user has access to reject a claim or an MDF request, then the default value is true, else false.
• CanReturn: boolean
  Title: Can Return

  Read Only: true

  Indicates if the user can return the claim or an MDF request. If the user has access to return a claim or an MDF request, then the default value is true, else false.
• CanSubmit: boolean
  Title: Can Submit

  Read Only: true

  Indicates whether the user has access to submit the claim.
• CanTerminate: boolean
  Title: Can Terminate

  Read Only: true

  Indicates whether the user has access to terminate the claim.
• CanWithdraw: boolean
  Title: Can Withdraw

  Read Only: true

  Indicates if the user can withdraw the claim or an MDF request. If the user has access to withdraw a claim or an MDF request, then the default value is true, else false.
• ChannelManagerId: integer (int64)
  Title: Account Director ID

  Read Only: true

  The unique identifier of the channel manager of the MDF claim.
• ChannelMgrName: string
  Title: Channel Manager

  The name of the channel manager of the MDF claim.
• ClaimAmount: number
  Title: Requested Amount

  The amount requested in the MDF claim.
• ClaimCode: string
  Title: Code

  Maximum Length: 100

  The user-defined or system generated code for the MDF claim.
• ClaimId: integer (int64)
  Title: Claim ID

  The unique identifier of the claim. This is a system-generated value.
• ClaimName: string
  Title: Name

  Maximum Length: 250

  The name of the MDF claim.
• ClaimStatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: DRAFT

  The code indicating the status of the MDF claim. A list of valid values is defined in the lookup ClaimStatusCode. The valid values are Approved, Draft, Failed, Pending Approval, Rejected, Returned, Terminated, or Withdrawn.
• Comments: string
  Title: Comments

  Maximum Length: 1000

  The additional comments on the MDF claim.
• ConversionCurrencyCode: string
  Title: Conversion Currency Code

  Read Only: true

  Maximum Length: 30

  The currency code associated with the claim.
• ConversionRateType: string
  Title: Conversion Rate Type

  Read Only: true

  Maximum Length: 30

  The currency conversion rate type used to derive the exchange rate between the MDF claim user entered currency and the CRM corporate currency code.
• ConvExchangeRate: number
  Title: Conversion Exchange Rate

  The currency exchange rate for the claim against the corporate currency.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the MDF claim.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the MDF claim was created.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 30

  The currency code associated with the claim. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• CurrencyConversionDate: string (date)
  Title: Currency Conversion Date

  The date of currency exchange rate for the claim against the corporate currency.
• DeleteFlag: boolean
  Title: Delete Indicator

  Read Only: true

  Indicates whether the user has access to delete the record.
• Description: string
  Title: Description

  Maximum Length: 4000

  A brief description of the MDF claim.
• FrExchangeRate: number
  Title: Fund Request Exchange Rate

  Default Value: 0

  The exchange rate of the fund request associated with the claim.
• FundRequestApprovedAmount: number
  Title: MDF Request Approved Amount

  Read Only: true

  The approved amount of the MDF request against the MDF claim.
• FundRequestCode: string
  Title: Fund Request Code

  Maximum Length: 100

  Public Unique Identifier for the marketing fund request.
• FundRequestCurrency: string
  Title: Currency

  Read Only: true

  Maximum Length: 30

  The currency code associated with the MDF request. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• FundRequestId: integer (int64)
  Title: Fund Request ID

  The unique identifier of the MDF request associated with the MDF claim.
• FundRequestName: string
  Title: MDF Request

  Maximum Length: 250

  The name of the fund request associated with the claim.
• FundRequestType: string
  Title: MDF Request Type

  Read Only: true

  Maximum Length: 30

  The type of the MDF request.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the claim was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the MDF claim.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the claim.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OutstngClaimLiabilityAmount: number
  Title: Liability Amount

  Default Value: 0

  The approved claim amount pending to be paid.
• OwnerEmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The email address of the MDF claim owner.
• OwnerFormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The formatted phone number of the owner of the claim.
• OwnerId: integer (int64)
  Title: Owner ID

  The unique identifier of the owner of the MDF claim.
• OwnerName: string
  Title: Owner

  Maximum Length: 360

  The name of the MDF claim owner.
• OwnerPartyNumber: string
  Title: Owner Party Number

  Read Only: true

  Maximum Length: 30

  Public Unique Identifier for the Resource.
• OwnerPrimaryPhoneNumber: string
  Title: Phone

  Read Only: true

  Maximum Length: 40

  The phone number of the owner of the MDF claim.
• PartnerPartyUniqueName: string
  Title: Partner

  Read Only: true

  Maximum Length: 360

  The name of the partner associated with the MDF claim.
• RecordSet: string
  Title: Record Set

  Read Only: true

  The record set values for claim.
• RejectedBy: string
  Title: Rejected By

  Maximum Length: 64

  The user who rejected the MDF claim.
• RejectedById: integer (int64)
  Title: Rejected by ID

  The unique identifier of the user who rejected the MDF claim.
• RejectedDate: string (date)
  Title: Rejected Date

  The date when the MDF claim was rejected.
• RejectReasonCode: string
  Title: Reject Reason

  The reason code for rejecting the claim.
• ReturnReasonCode: string
  Title: Return Reason

  The reason code for returning the claim back to the submitter.
• SubmitClaimsBy: string (date)
  Title: Claim Deadline

  Read Only: true

  The last date to submit a claim against the MDF request.
• SubmittedBy: string
  Title: Submitted By

  Maximum Length: 64

  The user who submitted the claim.
• SubmittedById: integer (int64)
  Title: Submitted by ID

  The unique identifier of the user who submitted the MDF claim.
• SubmittedDate: string (date)
  Title: Submitted Date

  The date when the MDF claim was submitted.
• UpdateFlag: boolean
  Title: Update Indicator

  Read Only: true

  Indicates whether the user has access to update the record.

{
    "type":"object",
    "properties":{
        "RejectedDate":{
            "title":"Rejected Date",
            "type":"string",
            "description":"The date when the MDF claim was rejected.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the MDF claim was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CanSubmit":{
            "title":"Can Submit",
            "type":"boolean",
            "description":"Indicates whether the user has access to submit the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FundRequestCode":{
            "title":"Fund Request Code",
            "maxLength":"100",
            "type":"string",
            "description":"Public Unique Identifier for the marketing fund request.",
            "nullable":false,
            "x-queryable":true
        },
        "BudgetCurrency":{
            "title":"Budget Currency",
            "maxLength":"30",
            "type":"string",
            "description":"The currency code associated with the MDF budget. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RejectedBy":{
            "title":"Rejected By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who rejected the MDF claim.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "CanTerminate":{
            "title":"Can Terminate",
            "type":"boolean",
            "description":"Indicates whether the user has access to terminate the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"30",
            "type":"string",
            "description":"The currency code associated with the claim. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "FundRequestName":{
            "title":"MDF Request",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the fund request associated with the claim.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "="
                ],
                "dependencies":[
                    "BudgetId",
                    "BudgetName"
                ]
            },
            "x-queryable":true
        },
        "ConvExchangeRate":{
            "title":"Conversion Exchange Rate",
            "type":"number",
            "description":"The currency exchange rate for the claim against the corporate currency.",
            "nullable":true,
            "x-queryable":true
        },
        "SubmitClaimsBy":{
            "title":"Claim Deadline",
            "type":"string",
            "description":"The last date to submit a claim against the MDF request.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "BudgetId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecordSet":{
            "title":"Record Set",
            "type":"string",
            "description":"The record set values for claim.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the MDF claim.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the MDF claim.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "ApprovedDate":{
            "title":"Approved Date",
            "type":"string",
            "description":"The date when the MDF claim was approved.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CanApprove":{
            "title":"Can Approve",
            "type":"boolean",
            "description":"Indicates if the user can approve the claim or an MDF request. If the user has access to approve a claim or an MDF request, then the default value is true, else false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SubmittedBy":{
            "title":"Submitted By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who submitted the claim.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "SubmittedById":{
            "title":"Submitted by ID",
            "type":"integer",
            "description":"The unique identifier of the user who submitted the MDF claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReturnReasonCode":{
            "title":"Return Reason",
            "type":"string",
            "description":"The reason code for returning the claim back to the submitter.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ClaimName":{
            "title":"Name",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the MDF claim.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "ApprovedBy":{
            "title":"Approvers",
            "maxLength":"64",
            "type":"string",
            "description":"The user who approved the MDF claim.",
            "nullable":true,
            "x-queryable":true
        },
        "ChannelMgrName":{
            "title":"Channel Manager",
            "type":"string",
            "description":"The name of the channel manager of the MDF claim.",
            "nullable":true,
            "x-queryable":false
        },
        "ConversionCurrencyCode":{
            "title":"Conversion Currency Code",
            "maxLength":"30",
            "type":"string",
            "description":"The currency code associated with the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CanReject":{
            "title":"Can Reject",
            "type":"boolean",
            "description":"Indicates if the user can reject the claim or an MDF request. If the user has access to reject a claim or an MDF request, then the default value is true, else false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerEmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the MDF claim owner.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ],
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "BudgetName":{
            "title":"Budget",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the MDF request budget associated with the MDF claim.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CanWithdraw":{
            "title":"Can Withdraw",
            "type":"boolean",
            "description":"Indicates if the user can withdraw the claim or an MDF request. If the user has access to withdraw a claim or an MDF request, then the default value is true, else false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FundRequestType":{
            "title":"MDF Request Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the MDF request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "ClaimId":{
            "title":"Claim ID",
            "type":"integer",
            "description":"The unique identifier of the claim. This is a system-generated value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OwnerName":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the MDF claim owner.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "BudgetEndDate":{
            "title":"Budget End Date",
            "type":"string",
            "description":"The date when the budget ends.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"A brief description of the MDF claim.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerPartyNumber":{
            "title":"Owner Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"Public Unique Identifier for the Resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimStatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the status of the MDF claim. A list of valid values is defined in the lookup ClaimStatusCode. The valid values are Approved, Draft, Failed, Pending Approval, Rejected, Returned, Terminated, or Withdrawn.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "ApprovedById":{
            "title":"Approved by ID",
            "type":"integer",
            "description":"The unique identifier of the user who approved the MDF claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyConversionDate":{
            "title":"Currency Conversion Date",
            "type":"string",
            "description":"The date of currency exchange rate for the claim against the corporate currency.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SubmittedDate":{
            "title":"Submitted Date",
            "type":"string",
            "description":"The date when the MDF claim was submitted.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ConversionRateType":{
            "title":"Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type used to derive the exchange rate between the MDF claim user entered currency and the CRM corporate currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FrExchangeRate":{
            "title":"Fund Request Exchange Rate",
            "type":"number",
            "description":"The exchange rate of the fund request associated with the claim.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ClaimAmount":{
            "title":"Requested Amount",
            "type":"number",
            "description":"The amount requested in the MDF claim.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">="
                ]
            },
            "x-queryable":true
        },
        "BudgetStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the budget starts.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "BudgetId"
                ]
            },
            "x-queryable":true
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of the owner of the MDF claim.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActivityOutcome":{
            "title":"Activity Outcome",
            "maxLength":"1000",
            "type":"string",
            "description":"Partner Activity Out come.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimCode":{
            "title":"Code",
            "maxLength":"100",
            "type":"string",
            "description":"The user-defined or system generated code for the MDF claim.",
            "nullable":false,
            "x-queryable":true
        },
        "OutstngClaimLiabilityAmount":{
            "title":"Liability Amount",
            "type":"number",
            "description":"The approved claim amount pending to be paid.",
            "nullable":true,
            "default":"0",
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">="
                ]
            },
            "x-queryable":true
        },
        "CanReturn":{
            "title":"Can Return",
            "type":"boolean",
            "description":"Indicates if the user can return the claim or an MDF request. If the user has access to return a claim or an MDF request, then the default value is true, else false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BgtExchangeRate":{
            "title":"Conversion Rate to Budget",
            "type":"number",
            "description":"The exchange rate of the MDF budget which is associated with the MDF claim. MDF budget is associated to the claim through fund request.",
            "nullable":false,
            "default":"0",
            "x-queryable":false
        },
        "FundRequestApprovedAmount":{
            "title":"MDF Request Approved Amount",
            "type":"number",
            "description":"The approved amount of the MDF request against the MDF claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Age":{
            "title":"Claim Age",
            "type":"number",
            "description":"The number of days since the creation of the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ChannelManagerId":{
            "title":"Account Director ID",
            "type":"integer",
            "description":"The unique identifier of the channel manager of the MDF claim.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartnerPartyUniqueName":{
            "title":"Partner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the partner associated with the MDF claim.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "OwnerPrimaryPhoneNumber":{
            "title":"Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The phone number of the owner of the MDF claim.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ],
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"1000",
            "type":"string",
            "description":"The additional comments on the MDF claim.",
            "nullable":true,
            "x-queryable":false
        },
        "ApprovalActionComments":{
            "title":"Approver Comments",
            "type":"string",
            "description":"The comments entered during approval action on the claim.",
            "nullable":true,
            "x-queryable":false
        },
        "FundRequestId":{
            "title":"Fund Request ID",
            "type":"integer",
            "description":"The unique identifier of the MDF request associated with the MDF claim.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "dependencies":[
                    "BudgetId"
                ]
            }
        },
        "FundRequestCurrency":{
            "title":"Currency",
            "maxLength":"30",
            "type":"string",
            "description":"The currency code associated with the MDF request. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RejectReasonCode":{
            "title":"Reject Reason",
            "type":"string",
            "description":"The reason code for rejecting the claim.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ApprovedAmount":{
            "title":"Approved Amount",
            "type":"number",
            "description":"The amount approved for the claim.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "ApprovalTaskStatusCode":{
            "title":"Status",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":false
        },
        "RejectedById":{
            "title":"Rejected by ID",
            "type":"integer",
            "description":"The unique identifier of the user who rejected the MDF claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the claim was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerFormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the owner of the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

BudgetLOVVA

Operation: /crmRestApi/resources/11.13.18.05/mdfBudgets

Parameters:

• finder: MdfRestActiveBudgetFinder%3BbindStatus%3DACTIVE

A marketing budget contains details pertaining to monetary incentives for partners to execute marketing activities.

ClaimStatusLOVVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKT_MDF_FUNDREQ_STATUS%2CBindLookupCode%3D{ClaimStatusCode}

The lookups resource is used to view standard lookup codes.

CurrencyLOVVA

Operation: /crmRestApi/resources/11.13.18.05/ratedCurrencies

The rated currencies resource is used to view details of currency codes for CRM. It gives a list of accepted values that are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.

FundRequestLOVVA_WithoutBudget

Operation: /crmRestApi/resources/11.13.18.05/mdfRequests

Parameters:

• finder: MdfRequestsRestFinder%3BbindStatus_1%3DAPPROVED

The market development fund requests resource is used to view, create, update, and delete an MDF Request. An MDF request is a request for resources to develop and maintain sales and marketing activities.

RecordSetVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_MDF_CLAIM_RECORD_SET%2CBindLookupCode%3D{RecordSet}

The lookups resource is used to view standard lookup codes.

RejectReasonCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{RejectReasonCode}%2CBindLookupType%3DORA_MKT_MDFCLAIM_REJECT

The lookups resource is used to view standard lookup codes.

ResourceVOVA

Operation: /crmRestApi/resources/11.13.18.05/resources

A front office person. For example, sales persons or partner members can be tagged as resources.

ReturnReasonCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{ReturnReasonCode}%2CBindLookupType%3DORA_MKT_MDFCLAIM_RETURN

The lookups resource is used to view standard lookup codes.

Back to Top