Get all claim settlements
get
/crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/ClaimSettlements
Request
Path Parameters
-
ClaimCode(required): string
The user-defined, unique label for 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 -
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:- ClaimCodeAndClaimSettlementCodeRF: Finds a claim settlement with the specified finder variable.
Finder Variables:- ClaimCode; string; The user-defined, unique label for the marketing claim.
- ClaimSettlementCode; string; The code indicating the type of claim settlement.
- ClaimSettlementsVOAltKey: Finds a claim settlement with the specified alternate key.
Finder Variables:- ClaimSettlementCode; string; The code indicating the type of claim settlement.
- PrimaryKey: Finds a claim settlement with the specified primary key.
Finder Variables:- ClaimSettlementId; integer; The unique identifier of the MDF claim settlement.
- ClaimCodeAndClaimSettlementCodeRF: Finds a claim settlement with the specified finder variable.
-
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:- AccountingTypeMeaning; string; The accounting type of the marketing claim settlement, which represents a credit or debit in the back-end financial system.
- BudgetCurrencyExchangeRate; number; The exchange rate used to convert the marketing claim settlement currency to the parent budget currency.
- BudgetName; string; The name of the MDF budget associated with the claim. MDF budget is associated to the claim through fund request.
- ClaimCode; string; The user-defined, unique label for the marketing claim.
- ClaimCurrencyExchangeRate; number; The exchange rate used to convert the marketing claim settlement currency to the parent marketing claim currency.
- ClaimName; string; The name of the claim associated with the claim settlement.
- ClaimSettlementAmount; number; The amount settled in the MDF claim settlement.
- ClaimSettlementCode; string; The user-defined, unique label for the MDF claim settlement.
- ClaimSettlementId; integer; The unique identifier of the MDF claim settlement.
- ClaimSettlementType; string; The type of the MDF claim settlement, for example deduction or payment.
- ClaimSettlmntTypeMeaning; string; The type of marketing claim settlement, for example deduction or payment.
- ClaimStatusCode; string; The status of the claim settlement.
- ConvExchangeRate; number; The currency exchange rate for the claim settlement against the corporate currency.
- ConversionCurrencyCode; string; The currency code associated with the claim settlement.
- ConversionRateType; string; The conversion rate type associated with the claim settlement.
- CreatedBy; string; The user who created the MDF claim settlement.
- CreatedById; integer; The unique identifier of the creator of the claim settlement.
- CreationDate; string; The date when the claim settlement was created.
- CurrencyConversionDate; string; The date of currency exchange rate for the claim settlement against the corporate currency.
- Description; string; A brief description of the marketing claim settlement.
- InvoiceReference; string; The reference identifier of the invoice to be settled with the MDF claim settlement.
- LastUpdateDate; string; The date when the settlement was last updated.
- LastUpdateLogin; string; The login of the user who last updated the settlement.
- LastUpdatedBy; string; The user who last updated the marketing claim settlement.
- OutstandingClaimLiabilityAmount; number; The outstanding claim liability amount.
- PartnerName; string; The name of the party.
- StatusCode; string; The code indicating the completion status of the marketing claim settlement.
- StatusMeaning; string; The completion status of the marketing claim settlement.
- TransactionDate; string; The date when the claim settlement was processed or marked as complete.
- TransactionMethod; string; The method by which the claim settlement transaction was processed.
- TransactionMethodMeaning; string; The method by which claim settlement transaction is processed.
-
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 : mdfClaims-ClaimSettlements
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 : mdfClaims-ClaimSettlements-item-response
Type:
Show Source
object
-
AccountingType: string
Title:
Accounting Type
Maximum Length:30
The accounting type of the MDF claim settlement, which represents credit or debit in the back-end financial system. -
AccountingTypeMeaning: string
Title:
Accounting Type
Read Only:true
The accounting type of the marketing claim settlement, which represents a credit or debit in the back-end financial system. -
BudgetCurrencyExchangeRate: number
Title:
Conversion Rate to Budget
Read Only:true
Default Value:1
The exchange rate used to convert the marketing claim settlement currency to the parent budget currency. -
BudgetId: number
Title:
Budget ID
Read Only:true
The unique identifier of the parent budget associated with the MDF claim. -
BudgetName: string
Title:
Name
Read Only:true
Maximum Length:250
The name of the MDF budget associated with the claim. MDF budget is associated to the claim through fund request. -
ClaimCode: string
Title:
Code
Maximum Length:100
The user-defined, unique label for the marketing claim. -
ClaimCurrencyExchangeRate: number
Title:
Conversion Rate to Claim
Read Only:true
Default Value:1
The exchange rate used to convert the marketing claim settlement currency to the parent marketing claim currency. -
ClaimId: number
Title:
Claim ID
The unique identifier of the MDF claim. -
ClaimName: string
Title:
Name
Read Only:true
Maximum Length:250
The name of the claim associated with the claim settlement. -
ClaimSettlementAmount: number
Title:
Amount
The amount settled in the MDF claim settlement. -
ClaimSettlementCode: string
Title:
Code
Maximum Length:100
The user-defined, unique label for the MDF claim settlement. -
ClaimSettlementId: integer
Title:
Claim Settlement ID
The unique identifier of the MDF claim settlement. -
ClaimSettlementType: string
Title:
Type
Maximum Length:30
The type of the MDF claim settlement, for example deduction or payment. -
ClaimSettlmntTypeMeaning: string
Title:
Type
Read Only:true
The type of marketing claim settlement, for example deduction or payment. -
ClaimStatusCode: string
Title:
Status
Read Only:true
Maximum Length:30
The status of the claim settlement. -
ConversionCurrencyCode: string
Title:
Conversion Currency Code
Read Only:true
Maximum Length:30
The currency code associated with the claim settlement. -
ConversionRateType: string
Title:
Conversion Rate Type
Read Only:true
Maximum Length:30
The conversion rate type associated with the claim settlement. -
ConvExchangeRate: number
Title:
Conversion Exchange Rate
Read Only:true
The currency exchange rate for the claim settlement against the corporate currency. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the MDF claim settlement. -
CreatedById: integer
(int64)
Title:
Created by ID
Read Only:true
The unique identifier of the creator of the claim settlement. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the claim settlement was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:30
The currency code associated with the claim settlement account. 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 claim settlement against the corporate currency. -
Description: string
Title:
Description
Maximum Length:1000
A brief description of the marketing claim settlement. -
InvoiceReference: string
Title:
Transaction Reference
Maximum Length:100
The reference identifier of the invoice to be settled with the MDF claim settlement. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the settlement was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the marketing claim settlement. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the settlement. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OutstandingClaimLiabilityAmount: number
Title:
Liability Amount
Read Only:true
Default Value:0
The outstanding claim liability amount. -
PartnerId: integer
(int64)
Title:
Partner ID
Read Only:true
The unique identifier of the party. -
PartnerName: string
Title:
Partner
Read Only:true
The name of the party. -
StatusCode: string
Title:
Status
Maximum Length:30
Default Value:INCOMPLETE
The code indicating the completion status of the marketing claim settlement. -
StatusMeaning: string
Title:
Status
Read Only:true
The completion status of the marketing claim settlement. -
TransactionDate: string
(date)
Title:
Transaction Date
The date when the claim settlement was processed or marked as complete. -
TransactionMethod: string
Title:
Transaction Method
Maximum Length:30
The method by which the claim settlement transaction was processed. -
TransactionMethodMeaning: string
Title:
Transaction Method
Read Only:true
The method by which claim settlement transaction is processed.
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.