Jump to

• Request
• Response
• Examples

Get a MDF request associated to the budget

get

/crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/FundRequest/{FundRequestCode}

Request

Path Parameters

• BudgetCode(required): string
  The unique alternate identifier of the MDF budget.
• FundRequestCode(required): string
  The unique alternate identifier of the marketing MDF request.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to 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 : mdfBudgets-FundRequest-item-response

Type: object

Show Source

• ActivityEndDate: string (date)
  Title: End Date

  The date when the fund request activity was completed.
• ActivityStartDate: string (date)
  Title: Start Date

  The date when the fund request activity was started.
• Age: number
  Title: Request Age

  Read Only: true

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

  The comments entered during approval action on the fund request.
• 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 request.
• ApprovedAmountPercent: number
  Title: Approved Percent

  Default Value: 100

  The percentage of amount approved of the total fund request.
• ApprovedBy: string
  Title: Approved By

  Maximum Length: 64

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

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

  The date on which the MDF request was approved.
• AvailableFundRequestAmount: number
  Title: Available Amount

  Read Only: true

  Default Value: 0

  The difference between total approved marketing MDF request and total approved claim amounts, which is available to new claims.
• BgtExchangeRate: number
  Title: Budget Exchange Rate

  Default Value: 0

  The exchange rate of the MDF budget which is associated with the fund request.
• BudgetCode: string
  Title: Budget Code

  Read Only: true

  Maximum Length: 100

  Public Unique Identifier for the marketing Budget.
• BudgetCurrency: string
  Title: Budget Currency

  Read Only: true

  Maximum Length: 30

  The currency used for the MDF budget associated with the fund request.
• BudgetEndDate: string (date)
  Title: Budget End Date

  Read Only: true

  The end date for the MDF budget associated with the fund request.
• BudgetId: integer (int64)
  Title: Budget ID

  The parent budget associated with the marketing MDF request.
• BudgetName: string
  Title: Budget

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

  Read Only: true

  The start date for the MDF budget associated with the fund request.
• CanApprove: boolean
  Title: Can Approve

  Read Only: true

  Indicates whether a request can be approved by the user.
• CanReject: boolean
  Title: Can Reject

  Read Only: true

  Indicates whether a request can be rejected by the user.
• CanReturn: boolean
  Title: Can Return

  Read Only: true

  Indicates whether a request can be returned by the user.
• CanSubmit: boolean
  Title: Can Submit

  Read Only: true

  Indicates whether a request can be submitted by the user.
• CanTerminate: boolean
  Title: Can Terminate

  Read Only: true

  Indicates whether a request can be terminated by the user.
• CanWithdraw: boolean
  Title: Can Withdraw

  Read Only: true

  Indicates whether a request can be withdrawn by the user.
• ChannelManager: string
  Title: Channel Manager

  Read Only: true

  Maximum Length: 450

  The user who is the channel manager for the fund request.
• ChannelManagerId: integer (int64)
  Title: Channel Manager ID

  Read Only: true

  The unique identifier of the resource who is the channel manager for the fund request.
• Comments: string
  Title: Comments

  Maximum Length: 1000

  The additional comments for the marketing MDF request.
• ConversionCurrencyCode: string
  Title: Conversion Currency Code

  Read Only: true

  Maximum Length: 30

  The currency code used for conversion in the request.
• ConversionRateType: string
  Title: Conversion Rate Type

  Read Only: true

  Maximum Length: 30

  The currency conversion rate type for the MDF fund request. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• ConvExchangeRate: number
  Title: Conversion Exchange Rate

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who created the marketing MDF request.
• CreatedBy_FN: string
  Title: Created By

  Read Only: true

  The name of the creator of the fund request.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Maximum Length: 30

  The currency code for the MDF request. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. 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 request against the corporate currency.
• DeleteFlag: boolean
  Title: Delete Indicator

  Read Only: true

  Indicates whether the request can be deleted. If the user has access to delete the request then the default value is true, else false.
• Description: string
  Title: Description

  Maximum Length: 4000

  The description for the marketing MDF request.
• FundRequestCode: string
  Title: Code

  Maximum Length: 100

  The unique alternate identifier of the marketing MDF request.
• FundRequestId: integer (int64)
  Title: Fund Request ID

  The unique identifier of the MDF request.
• FundRequestName: string
  Title: Name

  Maximum Length: 250

  The display name for the MDF request.
• FundRequestStatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: DRAFT

  The status code of the marketing MDF request.
• FundRequestType: string
  Title: Type

  Maximum Length: 30

  The type of the fund request.
• Justification: string
  Title: Justification

  Maximum Length: 1000

  The justification for the fund request.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• ManageApprovalDataFlag: boolean
  Read Only: true

  Indicates whether user can modify fund request attributes while the fund request is awaiting approval.
• ManageGeneralDataFlag: boolean
  Read Only: true

  Indicates whether user can modify fund request attributes when the fund request is either in draft or returned or withdrawn status.
• ManagePartnerDataFlag: boolean
  Read Only: true

  Indicates that partner users are restricted from modifying the partner field. It indicates whether channel users can update the partner field when the fund request is in draft, return, or withdrawn status.
• ManageTeamDataFlag: boolean
  Read Only: true

  Indicates whether the logged in user has full access on the fund request record.
• OwnerEmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The e-mail address of the owner of the fund request.
• OwnerFormattedPhoneNumber: string
  Title: Phone

  Read Only: true

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

  The internal resource who manages the marketing budget.
• OwnerName: string
  Title: Owner

  Maximum Length: 360

  The owner of the fund request.
• OwnerPartyNumber: string
  Title: Owner Party Number

  Read Only: true

  Maximum Length: 30

  Public Unique Identifier for the Resource.
• PartnerCompanyNumber: string
  Title: Partner Company Number

  Maximum Length: 30

  Public Unique Identifier for the Partner.
• PartnerCountry: string
  Title: Partner Country

  Read Only: true

  Maximum Length: 2

  The country of the partner associated with the fund request.
• PartnerId: integer (int64)
  Title: Partner ID

  The unique identifier of the partner account associated to the marketing MDF request.
• PartnerName: string
  Title: Partner

  Maximum Length: 360

  The partner account identifier name associated to the marketing MDF request.
• PartnerPartyUniqueName: string
  Title: Partner

  Read Only: true

  Maximum Length: 360

  The name of the partner associated with the fund request.
• RecordSet: string
  Title: Record Set

  Read Only: true

  Finds MDF request based on the filter criteria.
• RejectedBy: string
  Title: Rejected By

  Maximum Length: 64

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

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

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

  The reason code for rejecting the fund request.
• RequestedAmount: number
  Title: Requested Amount

  The amount submitted for the MDF request. The amount is displayed in the currency code associated with the MDF claim.
• RequestStatusMeaning: string
  Title: Status

  The status of the MDF request.
• ReturnReasonCode: string
  Title: Return Reason

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

  Read Only: true

  The date by which associated claim needs to be submitted.
• SubmitFundReqBy: string (date)
  Title: Request Deadline

  The date by which fund request needs to be submitted.
• SubmittedBy: string
  Title: Submitted By

  Maximum Length: 64

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

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

  The date when the marketing MDF request was submitted.
• TotalApprovedClaimAmount: number
  Title: Approved Claim Amount

  Read Only: true

  Default Value: 0

  The total amount of all approved claims for the marketing MDF request.
• UpdateFlag: boolean
  Title: Update Indicator

  Read Only: true

  Indicates whether the request can be updated. If the user has access to update the request then the default value is true, else false.

{
    "type":"object",
    "properties":{
        "ActivityEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the fund request activity was completed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ActivityStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the fund request activity was started.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Age":{
            "title":"Request Age",
            "type":"number",
            "description":"The number of days since the creation of the MDF request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ApprovalActionComments":{
            "title":"Approver Comments",
            "type":"string",
            "description":"The comments entered during approval action on the fund request.",
            "nullable":true,
            "x-queryable":false
        },
        "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
        },
        "ApprovedAmount":{
            "title":"Approved Amount",
            "type":"number",
            "description":"The amount approved for the MDF request.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "ApprovedAmountPercent":{
            "title":"Approved Percent",
            "type":"number",
            "description":"The percentage of amount approved of the total fund request.",
            "nullable":true,
            "default":100,
            "x-queryable":true
        },
        "ApprovedBy":{
            "title":"Approved By",
            "maxLength":64,
            "type":"string",
            "description":"The user who approved the MDF request.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "ApprovedById":{
            "title":"Approved by ID",
            "type":"integer",
            "description":"The unique identifier of the user who approved the marketing MDF request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ApprovedDate":{
            "title":"Approved Date",
            "type":"string",
            "description":"The date on which the  MDF request was approved.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AvailableFundRequestAmount":{
            "title":"Available Amount",
            "type":"number",
            "description":"The difference between total approved marketing MDF request and total approved claim amounts, which is available to new claims.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "BgtExchangeRate":{
            "title":"Budget Exchange Rate",
            "type":"number",
            "description":"The exchange rate of the MDF budget which is associated with the fund request.",
            "nullable":true,
            "default":0,
            "x-queryable":false
        },
        "BudgetCode":{
            "title":"Budget Code",
            "maxLength":100,
            "type":"string",
            "description":"Public Unique Identifier for the marketing Budget.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BudgetCurrency":{
            "title":"Budget Currency",
            "maxLength":30,
            "type":"string",
            "description":"The currency used for the MDF budget associated with the fund request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "BudgetEndDate":{
            "title":"Budget End Date",
            "type":"string",
            "description":"The end date for the MDF budget associated with the fund request.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BudgetId":{
            "title":"Budget ID",
            "type":"integer",
            "description":"The parent budget associated with the marketing MDF request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BudgetName":{
            "title":"Budget",
            "type":"string",
            "description":"The name of the MDF budget associated with the fund request.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "BudgetStartDate":{
            "title":"Budget Start Date",
            "type":"string",
            "description":"The start date for the MDF budget associated with the fund request.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CanApprove":{
            "title":"Can Approve",
            "type":"boolean",
            "description":"Indicates whether a request can be approved by the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CanReject":{
            "title":"Can Reject",
            "type":"boolean",
            "description":"Indicates whether a request can be rejected by the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CanReturn":{
            "title":"Can Return",
            "type":"boolean",
            "description":"Indicates whether a request can be returned by the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CanSubmit":{
            "title":"Can Submit",
            "type":"boolean",
            "description":"Indicates whether a request can be submitted by the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CanTerminate":{
            "title":"Can Terminate",
            "type":"boolean",
            "description":"Indicates whether a request can be terminated by the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CanWithdraw":{
            "title":"Can Withdraw",
            "type":"boolean",
            "description":"Indicates whether a request can be withdrawn by the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ChannelManager":{
            "title":"Channel Manager",
            "maxLength":450,
            "type":"string",
            "description":"The user who is the channel manager for the fund request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ],
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "ChannelManagerId":{
            "title":"Channel Manager ID",
            "type":"integer",
            "description":"The unique identifier of the resource who is the channel manager for the fund request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":1000,
            "type":"string",
            "description":"The additional comments for the marketing MDF request.",
            "nullable":true,
            "x-queryable":false
        },
        "ConvExchangeRate":{
            "title":"Conversion Exchange Rate",
            "type":"number",
            "description":"The currency exchange rate for the request against the corporate currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ConversionCurrencyCode":{
            "title":"Conversion Currency Code",
            "maxLength":30,
            "type":"string",
            "description":"The currency code used for conversion in the request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ConversionRateType":{
            "title":"Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type for the MDF fund request. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the marketing MDF request.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy_FN":{
            "title":"Created By",
            "type":"string",
            "description":"The name of the creator of the fund request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the MDF request was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":30,
            "type":"string",
            "description":"The currency code for 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,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "CurrencyConversionDate":{
            "title":"Currency Conversion Date",
            "type":"string",
            "description":"The date of currency exchange rate for the request against the corporate currency.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the request can be deleted. If the user has access to delete the request then the default value is true, else false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":4000,
            "type":"string",
            "description":"The description for the marketing MDF request.",
            "nullable":true,
            "x-queryable":false
        },
        "FundRequestCode":{
            "title":"Code",
            "maxLength":100,
            "type":"string",
            "description":"The unique alternate identifier of the marketing MDF request.",
            "nullable":false,
            "x-queryable":true
        },
        "FundRequestId":{
            "title":"Fund Request ID",
            "type":"integer",
            "description":"The unique identifier of the MDF request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FundRequestName":{
            "title":"Name",
            "maxLength":250,
            "type":"string",
            "description":"The display name for the MDF request.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "FundRequestStatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the marketing MDF request.",
            "nullable":true,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "FundRequestType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the fund request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "Justification":{
            "title":"Justification",
            "maxLength":1000,
            "type":"string",
            "description":"The justification for the fund request.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the fund request was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the fund request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the marketing MDF request.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "ManageApprovalDataFlag":{
            "type":"boolean",
            "description":"Indicates whether user can modify fund request attributes while the fund request is awaiting approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ManageGeneralDataFlag":{
            "type":"boolean",
            "description":"Indicates whether user can modify fund request attributes when the fund request is either in draft or returned or withdrawn status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ManagePartnerDataFlag":{
            "type":"boolean",
            "description":"Indicates that partner users are restricted from modifying the partner field. It indicates whether channel users can update the partner field when the fund request is in draft, return, or withdrawn status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ManageTeamDataFlag":{
            "type":"boolean",
            "description":"Indicates whether the logged in user has full access on the fund request record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OwnerEmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address of the owner of the fund request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "OwnerFormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the owner of the fund request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The internal resource who manages the marketing budget.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnerName":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"The owner of the fund request.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "OwnerPartyNumber":{
            "title":"Owner Party Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier for the Resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerCompanyNumber":{
            "title":"Partner Company Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier for the Partner.",
            "nullable":false,
            "x-queryable":true
        },
        "PartnerCountry":{
            "title":"Partner Country",
            "maxLength":2,
            "type":"string",
            "description":"The country of the partner associated with the fund request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The unique identifier of the partner account associated to the marketing MDF request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "PartnerPartyUniqueName",
                    "PartnerName"
                ]
            },
            "x-queryable":true
        },
        "PartnerName":{
            "title":"Partner",
            "maxLength":360,
            "type":"string",
            "description":"The partner account identifier name associated to the marketing MDF request.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PartnerPartyUniqueName":{
            "title":"Partner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the partner associated with the fund request.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "RecordSet":{
            "title":"Record Set",
            "type":"string",
            "description":"Finds MDF request based on the filter criteria.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "RejectReasonCode":{
            "title":"Reject Reason",
            "type":"string",
            "description":"The reason code for rejecting the fund request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RejectedBy":{
            "title":"Rejected By",
            "maxLength":64,
            "type":"string",
            "description":"The user who rejected the marketing MDF request.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "RejectedById":{
            "title":"Rejected by ID",
            "type":"integer",
            "description":"The unique identifier of the user who rejected the MDF request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RejectedDate":{
            "title":"Rejected Date",
            "type":"string",
            "description":"The date when the marketing MDF request was rejected.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RequestStatusMeaning":{
            "title":"Status",
            "type":"string",
            "description":"The status of the MDF request.",
            "nullable":true,
            "x-queryable":false
        },
        "RequestedAmount":{
            "title":"Requested Amount",
            "type":"number",
            "description":"The amount submitted for the MDF request. The amount is displayed in the currency code associated with the MDF claim.",
            "nullable":false,
            "x-queryable":true
        },
        "ReturnReasonCode":{
            "title":"Return Reason",
            "type":"string",
            "description":"The reason code for returning the fund request back to the submitter.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SubmitClaimsBy":{
            "title":"Claim Deadline",
            "type":"string",
            "description":"The date by which associated claim needs to be submitted.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitFundReqBy":{
            "title":"Request Deadline",
            "type":"string",
            "description":"The date by which fund request needs to be submitted.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SubmittedBy":{
            "title":"Submitted By",
            "maxLength":64,
            "type":"string",
            "description":"The user who submitted the marketing MDF request.",
            "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 request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubmittedDate":{
            "title":"Submitted Date",
            "type":"string",
            "description":"The date when the marketing MDF request was submitted.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "TotalApprovedClaimAmount":{
            "title":"Approved Claim Amount",
            "type":"number",
            "description":"The total amount of all approved claims for the marketing MDF request.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the request can be updated. If the user has access to update the request then the default value is true, else false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

The list of values to indicate the budget name associated to fund request.

The following properties are defined on the LOV link relation:

• Source Attribute: BudgetName; Target Attribute: BudgetName
• Display Attribute: BudgetName, PartnerNameTrans

CurrencyPVA

Operation: /crmRestApi/resources/11.13.18.05/ratedCurrencies

The list of values to indicate the currency code for the MDF Request such as USD, CAD, or Euro.

The following properties are defined on the LOV link relation:

• Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
• Display Attribute: CurrencyCode

FundRequestPartnerPartySearchVA

Operation: /crmRestApi/resources/11.13.18.05/partnersLOV

The list of values to indicate the partners associated with the MDF request.

The following properties are defined on the LOV link relation:

• Source Attribute: PartnerId; Target Attribute: PartyId
• Display Attribute: PartyId

FundRequestTypeLOVVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_MDFREQUEST_TYPE%2CBindLookupCode%3D{FundRequestType}

The list of values to indicate the types of the MDF requests.

The following properties are defined on the LOV link relation:

• Source Attribute: FundRequestType; Target Attribute: LookupCode
• Display Attribute: Meaning

RecordSetVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_MDF_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

RejectReasonCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

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

The list of values to indicate the reject reason of the fund request.

The following properties are defined on the LOV link relation:

• Source Attribute: RejectReasonCode; Target Attribute: LookupCode
• Display Attribute: Meaning

RequestStatusLOVVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

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

The list of values to indicate the status of the MDF request.

The following properties are defined on the LOV link relation:

• Source Attribute: FundRequestStatusCode; Target Attribute: LookupCode
• Display Attribute: Meaning

ResourceVOVA

Operation: /crmRestApi/resources/11.13.18.05/resources

The list of values to indicate the name of the owner associated with the MDF request.

The following properties are defined on the LOV link relation:

• Source Attribute: OwnerName; Target Attribute: PartyName
• Display Attribute: PartyName

ReturnReasonCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

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

The list of values to indicate the return reason of the fund request.

The following properties are defined on the LOV link relation:

• Source Attribute: ReturnReasonCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top

Examples

The following example shows how to get a mdf request associated to the budget by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/FundRequest/{FundRequestCode}

Example of Response Body

The following shows an example of the response body in JSON format.

 {
            "RecordSet": null,
            "FundRequestId": 300100543257820,
            "FundRequestName": "RequestApp_0b602762412",
            "CurrencyCode": "USD",
            "RequestedAmount": 100000,
            "ApprovedAmount": 100000,
            "CreationDate": "2021-06-17T04:06:25+00:00",
            "RequestStatusMeaning": "Approved",
            "Age": 123,
            "ApprovedBy": "Account_MgrENT1 CAM",
            "ApprovedDate": "2021-06-17",
            "BudgetName": "BudgetActive_64d02762383",
            "Description": null,
            "FundRequestCode": "RequestApp_0b602762412",
            "LastUpdatedBy": "Channel_OPS_Mgr_ENT1 COM",
            "LastUpdateDate": "2021-06-17T04:06:51.202+00:00",
            "PartnerName": "Stryker Corp.",
            "RejectedBy": null,
            "RejectedDate": null,
            "SubmittedDate": null,
            "CreatedBy": "CHANNEL_OPERATIONS_MANAGER",
            "LastUpdateLogin": "C4774F721408A0D0E0533DFDF40A851E",
            "BudgetId": 300100543257793,
            "FundRequestStatusCode": "APPROVED",
            "PartnerId": 100000016934002,
            "SubmittedBy": null,
            "TotalApprovedClaimAmount": 100,
            "AvailableFundRequestAmount": 99900,
            "SubmitFundReqBy": "2021-06-24",
            "Comments": null,
            "CreatedBy_FN": "Channel_OPS_Mgr_ENT1 COM",
            "ConversionRateType": "Corporate",
            "ConversionCurrencyCode": "USD",
            "BgtExchangeRate": 1,
            "ApprovedAmountPercent": 100,
            "FundRequestType": null,
            "Justification": null,
            "OwnerId": 100010038017885,
            "ActivityEndDate": null,
            "ChannelManager": "Account_MgrENT1 CAM",
            "ActivityStartDate": null,
            "OwnerName": "Channel_OPS_Mgr_ENT1 COM",
            "ChannelManagerId": 100010038017873,
            "PartnerPartyUniqueName": "Stryker Corp.",
            "PartnerCountry": "US",
            "OwnerEmailAddress": "[e-mail]",
            "ApprovedById": 100010038017873,
            "CurrencyConversionDate": "2021-06-17",
            "RejectedById": null,
            "SubmittedById": null,
            "CanSubmit": "false",
            "CanTerminate": "true",
            "OwnerFormattedPhoneNumber": "[phone]",
            "CanApprove": "false",
            "CanReject": "false",
            "CanReturn": "false",
            "CanWithdraw": "false",
            "ReturnReasonCode": null,
            "RejectReasonCode": null,
            "ApprovalActionComments": null,
            "ConvExchangeRate": 1,
            "UpdateFlag": false,
            "DeleteFlag": false,
            "ApprovalTaskStatusCode": null,
            "OwnerPartyNumber": "100010038017885",
            "PartnerCompanyNumber": "100001",
            "SubmitClaimsBy": "2021-06-24",
            "BudgetCurrency": "USD",
            "BudgetStartDate": "2021-06-17",
            "BudgetEndDate": null,
            "BudgetCode": "BudgetActive_64d02762383",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/FundRequest/RequestApp_0b602762412",
                    "name": "FundRequest",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/FundRequest/RequestApp_0b602762412",
                    "name": "FundRequest",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383",
                    "name": "mdfBudgets",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/FundRequest/RequestApp_0b602762412/lov/FundRequestTypeLOVVA",
                    "name": "FundRequestTypeLOVVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/FundRequest/RequestApp_0b602762412/lov/ReturnReasonCodeVA",
                    "name": "ReturnReasonCodeVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/FundRequest/RequestApp_0b602762412/lov/RequestStatusLOVVA",
                    "name": "RequestStatusLOVVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/FundRequest/RequestApp_0b602762412/lov/FundRequestPartnerPartySearchVA",
                    "name": "FundRequestPartnerPartySearchVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/FundRequest/RequestApp_0b602762412/lov/ResourceVOVA",
                    "name": "ResourceVOVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/FundRequest/RequestApp_0b602762412/lov/CurrencyPVA",
                    "name": "CurrencyPVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/FundRequest/RequestApp_0b602762412/lov/RejectReasonCodeVA",
                    "name": "RejectReasonCodeVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/FundRequest/RequestApp_0b602762412/lov/BudgetLOVVA",
                    "name": "BudgetLOVVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/FundRequest/RequestApp_0b602762412/lov/RecordSetVA",
                    "name": "RecordSetVA",
                    "kind": "collection"
                }
            ]
 }

Back to Top