Jump to

• Request
• Response
• Examples

Get a MDF claim associated to the budget

get

/crmRestApi/resources/11.13.18.05/mdfBudgets/{BudgetCode}/child/Claim/{ClaimCode}

Request

Path Parameters

• BudgetCode(required): string
  The unique alternate identifier of the MDF budget.
• ClaimCode(required): string
  The unique alternate identifier of the MDF claim.

Query Parameters

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

Header Parameters

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

There's no request body for this operation.

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

  Maximum Length: 64

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

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

  The date on which 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 claim. MDF budget is associated to the claim through fund request.
• BudgetCurrency: string
  Title: Budget Currency

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  The start date for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request.
• BudgetId: integer (int64)
  Title: Budget ID

  The parent budget associated to the marketing claim.
• BudgetName: string
  Title: Budget

  Maximum Length: 250

  The display name of the marketing budget associated to the MDF claim.
• BudgetStartDate: string (date)
  Title: Start Date

  Read Only: true

  The end date for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request.
• CanApprove: boolean
  Title: Can Approve

  Read Only: true

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

  Read Only: true

  Indicates whether the user has access to reject the claim.
• CanReturn: boolean
  Title: Can Return

  Read Only: true

  Indicates whether the user has access to return the claim.
• CanSubmit: boolean
  Title: Can Submit

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Indicates whether the user has access to withdraw the claim.
• ChannelManagerId: integer (int64)
  Title: Account Director ID

  Read Only: true

  The unique identifier of the partner owner associated to the claim.
• ChannelMgrName: string
  Title: Channel Manager

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

  The amount submitted for the MDF claim.
• ClaimCode: string
  Title: Code

  Maximum Length: 100

  The unique alternate identifier of the MDF claim.
• ClaimId: integer (int64)
  Title: Claim ID

  The unique identifier of the MDF claim.
• ClaimName: string
  Title: Name

  Maximum Length: 250

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

  Maximum Length: 30

  Default Value: DRAFT

  The status code of the MDF claim.
• Comments: string
  Title: Comments

  Maximum Length: 1000

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

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 30

  The conversion rate type used for the MDF claim.
• ConvExchangeRate: number
  Title: Conversion Exchange Rate

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Maximum Length: 30

  The ISO currency code entered for the MDF claim amount.
• 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

  The description for the MDF claim.
• FrExchangeRate: number
  Title: Fund Request Exchange Rate

  Default Value: 0

  The currency exchange rate for the claim against the fund request currency.
• FundRequestApprovedAmount: number
  Title: MDF Request Approved Amount

  Read Only: true

  The approved amount 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.
• FundRequestCurrency: string
  Title: Currency

  Read Only: true

  Maximum Length: 30

  The currency code used for the fund request associated with the claim.
• FundRequestId: integer (int64)
  Title: Fund Request ID

  The MDF fund request associated to 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 fund request associated with the claim.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the marketing budget.
• 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.
• ManageApprovalDataFlag: boolean
  Read Only: true

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

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

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

  Indicates whether the logged in user has full access on the claim record.
• OutstngClaimLiabilityAmount: number
  Title: Liability Amount

  Default Value: 0

  The outstanding claim liability amount that is pending for the budget claim.
• OwnerEmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The e-mail address of the owner of the claim.
• 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 user who owns 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 primary phone number of the owner of the claim.
• PartnerCompanyNumber: string
  Title: Partner Company Number

  Maximum Length: 30

  Public Unique Identifier for the Partner.
• PartnerId: integer (int64)
  Title: Partner ID

  The partner account associated to the marketing claim.
• PartnerPartyUniqueName: string
  Title: Partner

  Read Only: true

  Maximum Length: 360

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

  Read Only: true

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

  Maximum Length: 64

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

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

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

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

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

  Read Only: true

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

  Maximum Length: 64

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

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

  The date on which 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":{
        "ActivityOutcome":{
            "title":"Activity Outcome",
            "maxLength":1000,
            "type":"string",
            "description":"Partner Activity Out come.",
            "nullable":true,
            "x-queryable":true
        },
        "Age":{
            "title":"Claim Age",
            "type":"number",
            "description":"The number of days since the creation of the MDF claim.",
            "nullable":true,
            "readOnly":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
        },
        "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 claim.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "ApprovedBy":{
            "title":"Approvers",
            "maxLength":64,
            "type":"string",
            "description":"The user who approved the MDF claim.",
            "nullable":true,
            "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
        },
        "ApprovedDate":{
            "title":"Approved Date",
            "type":"string",
            "description":"The date on which the  MDF claim was approved.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "BgtExchangeRate":{
            "title":"Conversion Rate to Budget",
            "type":"number",
            "description":"The exchange rate of the MDF budget which is associated with the claim. MDF budget is associated to the claim through fund request.",
            "nullable":false,
            "default":0,
            "x-queryable":false
        },
        "BudgetCurrency":{
            "title":"Budget Currency",
            "maxLength":30,
            "type":"string",
            "description":"The currency used for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BudgetEndDate":{
            "title":"Budget End Date",
            "type":"string",
            "description":"The start date for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BudgetId":{
            "title":"Budget ID",
            "type":"integer",
            "description":"The parent budget associated to the marketing claim.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BudgetName":{
            "title":"Budget",
            "maxLength":250,
            "type":"string",
            "description":"The display name of the marketing budget associated to the MDF claim.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "BudgetStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The end date for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "BudgetId"
                ]
            },
            "x-queryable":true
        },
        "CanApprove":{
            "title":"Can Approve",
            "type":"boolean",
            "description":"Indicates whether the user can approve the MDF Claim. If the user has access to approve an MDF claim, then the default value is true, else false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CanReject":{
            "title":"Can Reject",
            "type":"boolean",
            "description":"Indicates whether the user has access to reject the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CanReturn":{
            "title":"Can Return",
            "type":"boolean",
            "description":"Indicates whether the user has access to return the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CanSubmit":{
            "title":"Can Submit",
            "type":"boolean",
            "description":"Indicates whether the user has access to submit the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CanTerminate":{
            "title":"Can Terminate",
            "type":"boolean",
            "description":"Indicates whether the user has access to terminate the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CanWithdraw":{
            "title":"Can Withdraw",
            "type":"boolean",
            "description":"Indicates whether the user has access to withdraw the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ChannelManagerId":{
            "title":"Account Director ID",
            "type":"integer",
            "description":"The unique identifier of the partner owner associated to the claim.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ChannelMgrName":{
            "title":"Channel Manager",
            "type":"string",
            "description":"The name of the channel manager of the claim.",
            "nullable":true,
            "x-queryable":false
        },
        "ClaimAmount":{
            "title":"Requested Amount",
            "type":"number",
            "description":"The amount submitted for the MDF claim.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">="
                ]
            },
            "x-queryable":true
        },
        "ClaimCode":{
            "title":"Code",
            "maxLength":100,
            "type":"string",
            "description":"The unique alternate identifier of the MDF claim.",
            "nullable":false,
            "x-queryable":true
        },
        "ClaimId":{
            "title":"Claim ID",
            "type":"integer",
            "description":"The unique identifier of the MDF claim.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClaimName":{
            "title":"Name",
            "maxLength":250,
            "type":"string",
            "description":"The display name of the MDF claim.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "ClaimStatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status code of the MDF claim.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":1000,
            "type":"string",
            "description":"The additional comments for the MDF claim.",
            "nullable":true,
            "x-queryable":false
        },
        "ConvExchangeRate":{
            "title":"Conversion Exchange Rate",
            "type":"number",
            "description":"The currency exchange rate for the claim against the corporate currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ConversionCurrencyCode":{
            "title":"Conversion Currency Code",
            "maxLength":30,
            "type":"string",
            "description":"The currency code used for conversion in the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ConversionRateType":{
            "title":"Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The conversion rate type used for the MDF claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "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
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the MDF claim was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":30,
            "type":"string",
            "description":"The ISO currency code entered for the MDF claim amount.",
            "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 claim against the corporate currency.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":4000,
            "type":"string",
            "description":"The description for the MDF claim.",
            "nullable":true,
            "x-queryable":false
        },
        "FrExchangeRate":{
            "title":"Fund Request Exchange Rate",
            "type":"number",
            "description":"The currency exchange rate for the claim against the fund request currency.",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "FundRequestApprovedAmount":{
            "title":"MDF Request Approved Amount",
            "type":"number",
            "description":"The approved amount of the fund request associated with the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FundRequestCode":{
            "title":"Fund Request Code",
            "maxLength":100,
            "type":"string",
            "description":"Public Unique Identifier for the marketing fund request.",
            "nullable":false,
            "x-queryable":true
        },
        "FundRequestCurrency":{
            "title":"Currency",
            "maxLength":30,
            "type":"string",
            "description":"The currency code used for the fund request associated with the claim.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "FundRequestId":{
            "title":"Fund Request ID",
            "type":"integer",
            "description":"The MDF fund request associated to the MDF claim.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "dependencies":[
                    "BudgetId"
                ]
            },
            "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
        },
        "FundRequestType":{
            "title":"MDF Request Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the fund request associated with the claim.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "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
        },
        "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
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the marketing budget.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "ManageApprovalDataFlag":{
            "type":"boolean",
            "description":"Indicates whether user can modify claim attributes while the claim is awaiting approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "ManageGeneralDataFlag":{
            "type":"boolean",
            "description":"Indicates whether user can modify claim attributes when the claim 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 whether the partner users are restricted from modifying the partner field. It indicates whether channel users can update the partner field when the claim is in draft, return, or withdrawn status.",
            "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 claim record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "OutstngClaimLiabilityAmount":{
            "title":"Liability Amount",
            "type":"number",
            "description":"The outstanding claim liability amount that is pending for the budget claim.",
            "nullable":true,
            "default":0,
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">="
                ]
            },
            "x-queryable":true
        },
        "OwnerEmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address of the owner of the claim.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ],
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "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
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of the user who owns the MDF claim.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "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
        },
        "OwnerPartyNumber":{
            "title":"Owner Party Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier for the Resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerPrimaryPhoneNumber":{
            "title":"Phone",
            "maxLength":40,
            "type":"string",
            "description":"The primary phone number of the owner of the claim.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ],
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            },
            "x-queryable":true
        },
        "PartnerCompanyNumber":{
            "title":"Partner Company Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier for the Partner.",
            "nullable":false,
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The partner account associated to the marketing claim.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "PartnerPartyUniqueName":{
            "title":"Partner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the partner associated with the claim.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "RecordSet":{
            "title":"Record Set",
            "type":"string",
            "description":"The record set values of the claim.",
            "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 claim.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
        },
        "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
        },
        "RejectedDate":{
            "title":"Rejected Date",
            "type":"string",
            "description":"The date when the MDF claim was rejected.",
            "format":"date",
            "nullable":true,
            "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"
            }
        },
        "SubmitClaimsBy":{
            "title":"Claim Deadline",
            "type":"string",
            "description":"The date by which claim needs to be submitted.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "BudgetId"
                ]
            },
            "x-queryable":true
        },
        "SubmittedBy":{
            "title":"Submitted By",
            "maxLength":64,
            "type":"string",
            "description":"The user who submitted the MDF 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
        },
        "SubmittedDate":{
            "title":"Submitted Date",
            "type":"string",
            "description":"The date on which the MDF claim was submitted.",
            "format":"date",
            "nullable":true,
            "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
        },
        "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 the claim.

The following properties are defined on the LOV link relation:

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

ClaimStatusLOVVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

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

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

The following properties are defined on the LOV link relation:

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

CurrencyLOVVA

Operation: /crmRestApi/resources/11.13.18.05/ratedCurrencies

The following properties are defined on the LOV link relation:

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

FundRequestLOVVA_WithoutBudget

Operation: /crmRestApi/resources/11.13.18.05/mdfRequests

Parameters:

• finder: MdfRequestsRestFinder%3BbindStatus_1%3DAPPROVED

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

The following properties are defined on the LOV link relation:

• Source Attribute: FundRequestName; Target Attribute: FundRequestName
• Display Attribute: FundRequestName

FundRequestTypeMeaningVA

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 fund request type for associated fund request with the claim.

The following properties are defined on the LOV link relation:

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

PartnerNameVA

Operation: /crmRestApi/resources/11.13.18.05/partnersLOV

The list of values to indicate the partners associated with the claim.

The following properties are defined on the LOV link relation:

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

RecordSetVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

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

The list of values that lets you to select the record set.

The following properties are defined on the LOV link relation:

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

RejectReasonCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

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

The list of values to indicate the reject reason of the claim.

The following properties are defined on the LOV link relation:

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

ResourceVOVA

Operation: /crmRestApi/resources/11.13.18.05/resources

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

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_MDFCLAIM_RETURN

The list of values to indicate the return reason of the claim.

The following properties are defined on the LOV link relation:

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

Back to Top

Examples

The following example shows how to get a mdf claim 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/Claim/{ClaimCode}

Example of Response Body

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

{
    "RecordSet": null,
    "ClaimId": 300100543257888,
    "FundRequestId": 300100543257820,
    "ClaimName": "[CLAIMNAME]",
    "Description": null,
    "CurrencyCode": "USD",
    "Age": 123,
    "ClaimAmount": 100,
    "ApprovedAmount": 100,
    "ClaimCode": "ClaimCode19702792276_4bd02801966",
    "ClaimStatusCode": "APPROVED",
    "ApprovedBy": "Account_MgrENT1 CAM",
    "ApprovedDate": "2021-06-17",
    "RejectedBy": null,
    "RejectedDate": null,
    "SubmittedDate": null,
    "CreatedBy": "CHANNEL_OPERATIONS_MANAGER",
    "CreationDate": "2021-06-17T04:06:41+00:00",
    "LastUpdatedBy": "Channel_OPS_Mgr_ENT1 COM",
    "LastUpdateLogin": "C4774F721408A0D0E0533DFDF40A851E",
    "LastUpdateDate": "2021-06-17T04:06:49.974+00:00",
    "FundRequestName": "RequestApp_0b602762412",
    "SubmittedBy": null,
    "FundRequestCurrency": "USD",
    "Comments": null,
    "ConversionRateType": "Corporate",
    "ConversionCurrencyCode": "USD",
    "OutstngClaimLiabilityAmount": 100,
    "OwnerId": 100010038017885,
    "OwnerName": "Channel_OPS_Mgr_ENT1 COM",
    "ChannelMgrName": "Account_MgrENT1 CAM",
    "FundRequestType": null,
    "ActivityOutcome": null,
    "FundRequestApprovedAmount": 100000,
    "ChannelManagerId": 100010038017873,
    "PartnerPartyUniqueName": "Stryker Corp.",
    "OwnerPrimaryPhoneNumber": "6338437",
    "OwnerEmailAddress": "[e-mail]",
    "ApprovedById": 100010038017873,
    "CurrencyConversionDate": "2021-06-17",
    "RejectedById": null,
    "SubmittedById": null,
    "CanSubmit": "false",
    "CanTerminate": "true",
    "OwnerFormattedPhoneNumber": "[phone]",
    "CanApprove": "false",
    "CanReject": "false",
    "CanWithdraw": "false",
    "CanReturn": "false",
    "FrExchangeRate": 1,
    "ReturnReasonCode": null,
    "RejectReasonCode": null,
    "ApprovalActionComments": null,
    "ConvExchangeRate": 1,
    "UpdateFlag": false,
    "DeleteFlag": false,
    "ApprovalTaskStatusCode": null,
    "BgtExchangeRate": 1,
    "FundRequestCode": "RequestApp_0b602762412",
    "OwnerPartyNumber": "100010038017885",
    "SubmitClaimsBy": "2021-06-24",
    "BudgetName": "BudgetActive_64d02762383",
    "BudgetCurrency": "USD",
    "BudgetStartDate": "2021-06-17",
    "BudgetEndDate": null,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/Claim/ClaimCode19702792276_4bd02801966",
            "name": "Claim",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/Claim/ClaimCode19702792276_4bd02801966",
            "name": "Claim",
            "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/Claim/ClaimCode19702792276_4bd02801966/lov/ClaimStatusLOVVA",
            "name": "ClaimStatusLOVVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/Claim/ClaimCode19702792276_4bd02801966/lov/CurrencyLOVVA",
            "name": "CurrencyLOVVA",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/Claim/ClaimCode19702792276_4bd02801966/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/Claim/ClaimCode19702792276_4bd02801966/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/Claim/ClaimCode19702792276_4bd02801966/lov/FundRequestLOVVA_WithoutBudget",
            "name": "FundRequestLOVVA_WithoutBudget",
            "kind": "collection"
        },
        {
            "rel": "lov",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/Claim/ClaimCode19702792276_4bd02801966/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/Claim/ClaimCode19702792276_4bd02801966/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/Claim/ClaimCode19702792276_4bd02801966/lov/RecordSetVA",
            "name": "RecordSetVA",
            "kind": "collection"
        }
    ]
}

Back to Top