Get all claims
get
/crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/Claim
Request
Path Parameters
-
FundRequestCode(required): string
The code indicating the user-defined, unique label for the MDF request.
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 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- ClaimVOAltKey: Finds an MDFClaim with the specified alternate key.
Finder Variables:- ClaimCode; string; The user-defined or system generated code for the MDF claim.
- PrimaryKey: Finds the MDF claim with the specified primary key.
Finder Variables:- ClaimId; integer; The unique identifier of the MDF claim.
- ClaimVOAltKey: Finds an MDFClaim with the specified alternate key.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
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 -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ActivityOutcome; string; Partner Activity Out come.
- ApprovedAmount; number; The amount approved for the claim.
- ApprovedBy; string; The user who approved the MDF claim.
- ApprovedById; integer; The unique identifier of the user who approved the MDF claim.
- ApprovedDate; string; The date when the MDF claim was approved.
- BudgetCurrency; string; The currency code associated with the MDF budget. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
- BudgetEndDate; string; The date when the budget ends.
- BudgetName; string; The name of the MDF request budget associated with the MDF claim.
- BudgetStartDate; string; The date when the budget starts.
- ChannelManagerId; integer; The unique identifier of the channel manager of the MDF claim.
- ClaimAmount; number; The amount requested in the MDF claim.
- ClaimCode; string; The user-defined or system generated code for the MDF claim.
- ClaimId; integer; The unique identifier of the claim. This is a system-generated value.
- ClaimName; string; The name of the MDF claim.
- ClaimStatusCode; string; 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.
- ConvExchangeRate; number; The currency exchange rate for the claim against the corporate currency.
- CreatedBy; string; The user who created the MDF claim.
- CreationDate; string; The date when the MDF claim was created.
- CurrencyCode; string; The currency code associated with the claim. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
- CurrencyConversionDate; string; The date of currency exchange rate for the claim against the corporate currency.
- FrExchangeRate; number; The exchange rate of the fund request associated with the claim.
- FundRequestApprovedAmount; number; The approved amount of the MDF request against the MDF claim.
- FundRequestCode; string; Public Unique Identifier for the marketing fund request.
- FundRequestName; string; The name of the fund request associated with the claim.
- FundRequestType; string; The type of the MDF request.
- LastUpdateDate; string; The date when the claim was last updated.
- LastUpdatedBy; string; The user who last updated the MDF claim.
- OutstngClaimLiabilityAmount; number; The approved claim amount pending to be paid.
- OwnerEmailAddress; string; The email address of the MDF claim owner.
- OwnerId; integer; The unique identifier of the owner of the MDF claim.
- OwnerName; string; The name of the MDF claim owner.
- OwnerPartyNumber; string; Public Unique Identifier for the Resource.
- OwnerPrimaryPhoneNumber; string; The phone number of the owner of the MDF claim.
- PartnerPartyUniqueName; string; The name of the partner associated with the MDF claim.
- RecordSet; string; The record set values for claim.
- RejectedBy; string; The user who rejected the MDF claim.
- RejectedById; integer; The unique identifier of the user who rejected the MDF claim.
- RejectedDate; string; The date when the MDF claim was rejected.
- SubmitClaimsBy; string; The last date to submit a claim against the MDF request.
- SubmittedBy; string; The user who submitted the claim.
- SubmittedById; integer; The unique identifier of the user who submitted the MDF claim.
- SubmittedDate; string; The date when the MDF claim was submitted.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : mdfRequests-Claim
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : mdfRequests-Claim-item-response
Type:
Show Source
object
-
ActivityOutcome: string
Title:
Activity Outcome
Maximum Length:1000
Partner Activity Out come. -
Age: number
Title:
Claim Age
Read Only:true
The number of days since the creation of the claim. -
ApprovalActionComments: string
Title:
Approver Comments
The comments entered during approval action on the claim. -
ApprovalTaskStatusCode: string
Title:
Status
The code indicating the approval action that can be taken in the MDF Claim. The accepted values are Approve, Reject, Return, Withdraw, Terminate, and HtOutcmeReturnReturnAction. -
ApprovedAmount: number
Title:
Approved Amount
Default Value:0
The amount approved for the claim. -
ApprovedBy: string
Title:
Approvers
Maximum Length:64
The user who approved the MDF claim. -
ApprovedById: integer
(int64)
Title:
Approved by ID
The unique identifier of the user who approved the MDF claim. -
ApprovedDate: string
(date)
Title:
Approved Date
The date when the MDF claim was approved. -
BgtExchangeRate: number
Title:
Conversion Rate to Budget
Default Value:0
The exchange rate of the MDF budget which is associated with the MDF claim. MDF budget is associated to the claim through fund request. -
BudgetCurrency: string
Title:
Budget Currency
Read Only:true
Maximum Length:30
The currency code associated with the MDF budget. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
BudgetEndDate: string
(date)
Title:
Budget End Date
Read Only:true
The date when the budget ends. -
BudgetName: string
Title:
Budget
Maximum Length:250
The name of the MDF request budget associated with the MDF claim. -
BudgetStartDate: string
(date)
Title:
Start Date
Read Only:true
The date when the budget starts. -
CanApprove: boolean
Title:
Can Approve
Read Only:true
Indicates if the user can approve the claim or an MDF request. If the user has access to approve a claim or an MDF request, then the default value is true, else false. -
CanReject: boolean
Title:
Can Reject
Read Only:true
Indicates if the user can reject the claim or an MDF request. If the user has access to reject a claim or an MDF request, then the default value is true, else false. -
CanReturn: boolean
Title:
Can Return
Read Only:true
Indicates if the user can return the claim or an MDF request. If the user has access to return a claim or an MDF request, then the default value is true, else false. -
CanSubmit: boolean
Title:
Can Submit
Read Only:true
Indicates whether the user has access to submit the claim. -
CanTerminate: boolean
Title:
Can Terminate
Read Only:true
Indicates whether the user has access to terminate the claim. -
CanWithdraw: boolean
Title:
Can Withdraw
Read Only:true
Indicates if the user can withdraw the claim or an MDF request. If the user has access to withdraw a claim or an MDF request, then the default value is true, else false. -
ChannelManagerId: integer
(int64)
Title:
Account Director ID
Read Only:true
The unique identifier of the channel manager of the MDF claim. -
ChannelMgrName: string
Title:
Channel Manager
The name of the channel manager of the MDF claim. -
ClaimAmount: number
Title:
Requested Amount
The amount requested in the MDF claim. -
ClaimCode: string
Title:
Code
Maximum Length:100
The user-defined or system generated code for the MDF claim. -
ClaimId: integer
(int64)
Title:
Claim ID
The unique identifier of the claim. This is a system-generated value. -
ClaimName: string
Title:
Name
Maximum Length:250
The name of the MDF claim. -
ClaimStatusCode: string
Title:
Status
Maximum Length:30
Default Value:DRAFT
The code indicating the status of the MDF claim. A list of valid values is defined in the lookup ClaimStatusCode. The valid values are Approved, Draft, Failed, Pending Approval, Rejected, Returned, Terminated, or Withdrawn. -
Comments: string
Title:
Comments
Maximum Length:1000
The additional comments on the MDF claim. -
ConversionCurrencyCode: string
Title:
Conversion Currency Code
Read Only:true
Maximum Length:30
The currency code associated with the claim. -
ConversionRateType: string
Title:
Conversion Rate Type
Read Only:true
Maximum Length:30
The currency conversion rate type used to derive the exchange rate between the MDF claim user entered currency and the CRM corporate currency code. -
ConvExchangeRate: number
Title:
Conversion Exchange Rate
The currency exchange rate for the claim against the corporate currency. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the MDF claim. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the MDF claim was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:30
The currency code associated with the claim. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
CurrencyConversionDate: string
(date)
Title:
Currency Conversion Date
The date of currency exchange rate for the claim against the corporate currency. -
DeleteFlag: boolean
Title:
Delete Indicator
Read Only:true
Indicates whether the user has access to delete the record. -
Description: string
Title:
Description
Maximum Length:4000
A brief description of the MDF claim. -
FrExchangeRate: number
Title:
Fund Request Exchange Rate
Default Value:0
The exchange rate of the fund request associated with the claim. -
FundRequestApprovedAmount: number
Title:
MDF Request Approved Amount
Read Only:true
The approved amount of the MDF request against the MDF claim. -
FundRequestCode: string
Title:
Fund Request Code
Maximum Length:100
Public Unique Identifier for the marketing fund request. -
FundRequestCurrency: string
Title:
Currency
Read Only:true
Maximum Length:30
The currency code associated with the MDF request. A list of valid values are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task. -
FundRequestId: integer
(int64)
Title:
Fund Request ID
The unique identifier of the MDF request associated with the MDF claim. -
FundRequestName: string
Title:
MDF Request
Maximum Length:250
The name of the fund request associated with the claim. -
FundRequestType: string
Title:
MDF Request Type
Read Only:true
Maximum Length:30
The type of the MDF request. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the claim was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the MDF claim. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the claim. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OutstngClaimLiabilityAmount: number
Title:
Liability Amount
Default Value:0
The approved claim amount pending to be paid. -
OwnerEmailAddress: string
Title:
Email
Read Only:true
Maximum Length:320
The email address of the MDF claim owner. -
OwnerFormattedPhoneNumber: string
Title:
Phone
Read Only:true
The formatted phone number of the owner of the claim. -
OwnerId: integer
(int64)
Title:
Owner ID
The unique identifier of the owner of the MDF claim. -
OwnerName: string
Title:
Owner
Maximum Length:360
The name of the MDF claim owner. -
OwnerPartyNumber: string
Title:
Owner Party Number
Read Only:true
Maximum Length:30
Public Unique Identifier for the Resource. -
OwnerPrimaryPhoneNumber: string
Title:
Phone
Read Only:true
Maximum Length:40
The phone number of the owner of the MDF claim. -
PartnerPartyUniqueName: string
Title:
Partner
Read Only:true
Maximum Length:360
The name of the partner associated with the MDF claim. -
RecordSet: string
Title:
Record Set
Read Only:true
The record set values for claim. -
RejectedBy: string
Title:
Rejected By
Maximum Length:64
The user who rejected the MDF claim. -
RejectedById: integer
(int64)
Title:
Rejected by ID
The unique identifier of the user who rejected the MDF claim. -
RejectedDate: string
(date)
Title:
Rejected Date
The date when the MDF claim was rejected. -
RejectReasonCode: string
Title:
Reject Reason
The reason code for rejecting the claim. -
ReturnReasonCode: string
Title:
Return Reason
The reason code for returning the claim back to the submitter. -
SubmitClaimsBy: string
(date)
Title:
Claim Deadline
Read Only:true
The last date to submit a claim against the MDF request. -
SubmittedBy: string
Title:
Submitted By
Maximum Length:64
The user who submitted the claim. -
SubmittedById: integer
(int64)
Title:
Submitted by ID
The unique identifier of the user who submitted the MDF claim. -
SubmittedDate: string
(date)
Title:
Submitted Date
The date when the MDF claim was submitted. -
UpdateFlag: boolean
Title:
Update Indicator
Read Only:true
Indicates whether the user has access to update the record.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.