Get a claim

get

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

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : mdfRequests-Claim-item-response
Type: object
Show Source
  • Title: Activity Outcome
    Maximum Length: 1000
    Partner Activity Out come.
  • Title: Claim Age
    Read Only: true
    The number of days since the creation of the claim.
  • Title: Approver Comments
    The comments entered during approval action on the claim.
  • 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.
  • Title: Approved Amount
    Default Value: 0
    The amount approved for the claim.
  • Title: Approvers
    Maximum Length: 64
    The user who approved the MDF claim.
  • Title: Approved by ID
    The unique identifier of the user who approved the MDF claim.
  • Title: Approved Date
    The date when the MDF claim was approved.
  • Title: Conversion Rate to Budget
    Default Value: 0
    The exchange rate of the MDF budget which is associated with the MDF claim. MDF budget is associated to the claim through fund request.
  • Title: Budget Currency
    Read Only: true
    Maximum Length: 30
    The currency code associated with the MDF budget. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Budget End Date
    Read Only: true
    The date when the budget ends.
  • Title: Budget
    Maximum Length: 250
    The name of the MDF request budget associated with the MDF claim.
  • Title: Start Date
    Read Only: true
    The date when the budget starts.
  • Title: Can Approve
    Read Only: true
    Indicates if the user can approve the claim or an MDF request. If the user has access to approve a claim or an MDF request, then the default value is true, else false.
  • Title: Can Reject
    Read Only: true
    Indicates if the user can reject the claim or an MDF request. If the user has access to reject a claim or an MDF request, then the default value is true, else false.
  • Title: Can Return
    Read Only: true
    Indicates if the user can return the claim or an MDF request. If the user has access to return a claim or an MDF request, then the default value is true, else false.
  • Title: Can Submit
    Read Only: true
    Indicates whether the user has access to submit the claim.
  • Title: Can Terminate
    Read Only: true
    Indicates whether the user has access to terminate the claim.
  • Title: Can Withdraw
    Read Only: true
    Indicates if the user can withdraw the claim or an MDF request. If the user has access to withdraw a claim or an MDF request, then the default value is true, else false.
  • Title: Account Director ID
    Read Only: true
    The unique identifier of the channel manager of the MDF claim.
  • Title: Channel Manager
    The name of the channel manager of the MDF claim.
  • Title: Requested Amount
    The amount requested in the MDF claim.
  • Title: Code
    Maximum Length: 100
    The user-defined or system generated code for the MDF claim.
  • Title: Claim ID
    The unique identifier of the claim. This is a system-generated value.
  • Title: Name
    Maximum Length: 250
    The name of the MDF claim.
  • Title: Status
    Maximum Length: 30
    Default Value: DRAFT
    The code indicating the status of the MDF claim. A list of valid values is defined in the lookup ClaimStatusCode. The valid values are Approved, Draft, Failed, Pending Approval, Rejected, Returned, Terminated, or Withdrawn.
  • Title: Comments
    Maximum Length: 1000
    The additional comments on the MDF claim.
  • Title: Conversion Currency Code
    Read Only: true
    Maximum Length: 30
    The currency code associated with the claim.
  • Title: Conversion Rate Type
    Read Only: true
    Maximum Length: 30
    The currency conversion rate type used to derive the exchange rate between the MDF claim user entered currency and the CRM corporate currency code.
  • Title: Conversion Exchange Rate
    The currency exchange rate for the claim against the corporate currency.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the MDF claim.
  • Title: Creation Date
    Read Only: true
    The date when the MDF claim was created.
  • Title: Currency
    Maximum Length: 30
    The currency code associated with the claim. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Currency Conversion Date
    The date of currency exchange rate for the claim against the corporate currency.
  • Title: Delete Indicator
    Read Only: true
    Indicates whether the user has access to delete the record.
  • Title: Description
    Maximum Length: 4000
    A brief description of the MDF claim.
  • Title: Fund Request Exchange Rate
    Default Value: 0
    The exchange rate of the fund request associated with the claim.
  • Title: MDF Request Approved Amount
    Read Only: true
    The approved amount of the MDF request against the MDF claim.
  • Title: Fund Request Code
    Maximum Length: 100
    Public Unique Identifier for the marketing fund request.
  • Title: Currency
    Read Only: true
    Maximum Length: 30
    The currency code associated with the MDF request. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
  • Title: Fund Request ID
    The unique identifier of the MDF request associated with the MDF claim.
  • Title: MDF Request
    Maximum Length: 250
    The name of the fund request associated with the claim.
  • Title: MDF Request Type
    Read Only: true
    Maximum Length: 30
    The type of the MDF request.
  • Title: Last Update Date
    Read Only: true
    The date when the claim was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the MDF claim.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the claim.
  • Links
  • Title: Liability Amount
    Default Value: 0
    The approved claim amount pending to be paid.
  • Title: Email
    Read Only: true
    Maximum Length: 320
    The email address of the MDF claim owner.
  • Title: Phone
    Read Only: true
    The formatted phone number of the owner of the claim.
  • Title: Owner ID
    The unique identifier of the owner of the MDF claim.
  • Title: Owner
    Maximum Length: 360
    The name of the MDF claim owner.
  • Title: Owner Party Number
    Read Only: true
    Maximum Length: 30
    Public Unique Identifier for the Resource.
  • Title: Phone
    Read Only: true
    Maximum Length: 40
    The phone number of the owner of the MDF claim.
  • Title: Partner
    Read Only: true
    Maximum Length: 360
    The name of the partner associated with the MDF claim.
  • Title: Record Set
    Read Only: true
    The record set values for claim.
  • Title: Rejected By
    Maximum Length: 64
    The user who rejected the MDF claim.
  • Title: Rejected by ID
    The unique identifier of the user who rejected the MDF claim.
  • Title: Rejected Date
    The date when the MDF claim was rejected.
  • Title: Reject Reason
    The reason code for rejecting the claim.
  • Title: Return Reason
    The reason code for returning the claim back to the submitter.
  • Title: Claim Deadline
    Read Only: true
    The last date to submit a claim against the MDF request.
  • Title: Submitted By
    Maximum Length: 64
    The user who submitted the claim.
  • Title: Submitted by ID
    The unique identifier of the user who submitted the MDF claim.
  • Title: Submitted Date
    The date when the MDF claim was submitted.
  • Title: Update Indicator
    Read Only: true
    Indicates whether the user has access to update the record.
Back to Top