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: 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 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:
ItemsThe items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
LinksThe 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:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : mdfClaims-ClaimSettlements-item-response
Type:
Show Source
object-
AccountingType: string
Title:
Accounting TypeMaximum Length:30The accounting type of the MDF claim settlement, which represents credit or debit in the back-end financial system. -
AccountingTypeMeaning: string
Title:
Accounting TypeRead Only:trueThe 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 BudgetRead Only:trueDefault Value:1The exchange rate used to convert the marketing claim settlement currency to the parent budget currency. -
BudgetId: number
Title:
Budget IDRead Only:trueThe unique identifier of the parent budget associated with the MDF claim. -
BudgetName: string
Title:
NameRead Only:trueMaximum Length:250The name of the MDF budget associated with the claim. MDF budget is associated to the claim through fund request. -
ClaimCode: string
Title:
CodeMaximum Length:100The user-defined, unique label for the marketing claim. -
ClaimCurrencyExchangeRate: number
Title:
Conversion Rate to ClaimRead Only:trueDefault Value:1The exchange rate used to convert the marketing claim settlement currency to the parent marketing claim currency. -
ClaimId: number
Title:
Claim IDThe unique identifier of the MDF claim. -
ClaimName: string
Title:
NameRead Only:trueMaximum Length:250The name of the claim associated with the claim settlement. -
ClaimSettlementAmount: number
Title:
AmountThe amount settled in the MDF claim settlement. -
ClaimSettlementCode: string
Title:
CodeMaximum Length:100The user-defined, unique label for the MDF claim settlement. -
ClaimSettlementId: integer
Title:
Claim Settlement IDThe unique identifier of the MDF claim settlement. -
ClaimSettlementType: string
Title:
TypeMaximum Length:30The type of the MDF claim settlement, for example deduction or payment. -
ClaimSettlmntTypeMeaning: string
Title:
TypeRead Only:trueThe type of marketing claim settlement, for example deduction or payment. -
ClaimStatusCode: string
Title:
StatusRead Only:trueMaximum Length:30The status of the claim settlement. -
ConversionCurrencyCode: string
Title:
Conversion Currency CodeRead Only:trueMaximum Length:30The currency code associated with the claim settlement. -
ConversionRateType: string
Title:
Conversion Rate TypeRead Only:trueMaximum Length:30The conversion rate type associated with the claim settlement. -
ConvExchangeRate: number
Title:
Conversion Exchange RateRead Only:trueThe currency exchange rate for the claim settlement against the corporate currency. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the MDF claim settlement. -
CreatedById: integer
(int64)
Title:
Created by IDRead Only:trueThe unique identifier of the creator of the claim settlement. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the claim settlement was created. -
CurrencyCode: string
Title:
CurrencyMaximum Length:30The 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 DateRead Only:trueThe date of currency exchange rate for the claim settlement against the corporate currency. -
Description: string
Title:
DescriptionMaximum Length:1000A brief description of the marketing claim settlement. -
InvoiceReference: string
Title:
Transaction ReferenceMaximum Length:100The reference identifier of the invoice to be settled with the MDF claim settlement. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the settlement was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the marketing claim settlement. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32The login of the user who last updated the settlement. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OutstandingClaimLiabilityAmount: number
Title:
Liability AmountRead Only:trueDefault Value:0The outstanding claim liability amount. -
PartnerId: integer
(int64)
Title:
Partner IDRead Only:trueThe unique identifier of the party. -
PartnerName: string
Title:
PartnerRead Only:trueThe name of the party. -
smartActions: array
Smart Actions
Title:
Smart ActionsThis VO stores the endpoint and security details for every user action. -
StatusCode: string
Title:
StatusMaximum Length:30Default Value:INCOMPLETEThe code indicating the completion status of the marketing claim settlement. -
StatusMeaning: string
Title:
StatusRead Only:trueThe completion status of the marketing claim settlement. -
TransactionDate: string
(date)
Title:
Transaction DateThe date when the claim settlement was processed or marked as complete. -
TransactionMethod: string
Title:
Transaction MethodMaximum Length:30The method by which the claim settlement transaction was processed. -
TransactionMethodMeaning: string
Title:
Transaction MethodRead Only:trueThe method by which claim settlement transaction is processed.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Smart Actions
Type:
arrayTitle:
Smart ActionsThis VO stores the endpoint and security details for every user action.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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.
Nested Schema : mdfClaims-ClaimSettlements-smartActions-item-response
Type:
Show Source
object-
ActionIntent: string
(byte)
Title:
Action IntentJSON object that describes what an action does and what context data can be passed to the action. -
ConfirmationMessage: string
Title:
Confirmation MessageMaximum Length:4000A message to seek confirmation for the action being performed. -
ContentType: string
Title:
Content TypeMaximum Length:50The content type to use when invoking the REST endpoint. -
DisplayLabel: string
Title:
Action NameMaximum Length:256Consumer-friendly action name. -
Entity: string
Title:
Parent EntityMaximum Length:150REST Resources the action belongs to. -
Href: string
Title:
REST EndpointMaximum Length:1024The REST endpoint to perform the action. -
IncludedInApplication: string
Title:
Included in ApplicationMaximum Length:512List of applications that this action can be used in. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MassActionFlag: boolean
Title:
Mass ActionMaximum Length:1Boolean type indicating if this action can be mass processed. -
Method: string
Title:
HTTP MethodMaximum Length:15HTTP method to use with HREF. -
ObjectFunctionName: string
Title:
Object FunctionMaximum Length:64The object function associated with the smart action. -
PageType: string
Title:
Page TypeMaximum Length:256The list of pages that this action can be used in. -
SmartSuggestFlag: boolean
Title:
Smart SuggestMaximum Length:1Indicates if smart suggest is enabled for the action. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Boolean type indicating if the action is seeded or custom. -
UpdateOfAttributes: string
Title:
Attributes to UpdateMaximum Length:512Attributes to be updated when the Actions UI is launched. -
UserActionId: integer
(int64)
Title:
User Action IDUniquely identifies the action. For internal use. -
UserActionName: string
Title:
Action NameMaximum Length:256Uniquely identifies the action with a name. For internal use. - UserActionNavigation: array Smart Action User Interface Definitions
-
UserActionRank: integer
(int64)
Title:
PriorityNumber to indicate priority of the action. -
UserActionRequestPayload: array
Smart Action REST Payload Definitions
Title:
Smart Action REST Payload DefinitionsIf an LOV required for constructing a request payload needs to post data, the payload metadata is stored here. -
UserActionURLBinding: array
Smart Action User Interface Definitions
Title:
Smart Action User Interface DefinitionsBinding metadata for a variable in the URL.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Smart Action REST Payload Definitions
Type:
arrayTitle:
Smart Action REST Payload DefinitionsIf an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
Show Source
Nested Schema : Smart Action User Interface Definitions
Type:
arrayTitle:
Smart Action User Interface DefinitionsBinding metadata for a variable in the URL.
Show Source
Nested Schema : mdfClaims-ClaimSettlements-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object-
Binding: string
Title:
Payload Value Binding TypeMaximum Length:64Indicates the binding type of the value. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MandatoryFlag: boolean
Title:
MandatoryMaximum Length:1Boolean value indicating if the payload is mandatory. -
RequestPayloadId: integer
(int64)
Uniquely identifies the payload for smart actions. For internal use.
-
RequestPayloadName: string
Title:
Request Payload Attribute NameMaximum Length:256The key in the Key Value pair that forms the payload. -
SmartSuggestPath: string
Title:
Smart Suggest PathMaximum Length:2048The path used for smart suggest. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseBoolean value. -
Value: string
Title:
Request Payload Attribute ValueMaximum Length:1000The value in the Key Value pair that forms the payload. -
ValueStruct: string
Title:
Payload Value StructureMaximum Length:20If the value in the Key Value pair isn't a single value, this would be set.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : mdfClaims-ClaimSettlements-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object-
Binding: string
Title:
URL Binding TypeMaximum Length:64This is a hint for processing the Url Binding runtime. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SystemActionFlag: boolean
Title:
System ActionMaximum Length:1Default Value:falseBoolean indicator. -
URLBindingId: integer
(int64)
Uniquely identifies the URL Bind for smart actions. For internal use.
-
URLBindingName: string
Title:
URL Binding Parameter NameMaximum Length:256For action REST endpoints that require runtime binding, this is the key in the key value pair. -
Value: string
Title:
URL Binding Parameter ValueMaximum Length:1000For action REST endpoints that require runtime binding, this is the value in the key value pair.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Examples
The following example shows how to get all claim settlements of an MDF claim by submitting a get request on the REST resource using cURL.
cURL Command
curl -u <username:password> \
'https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/ClaimApp_f7502757995/child/ClaimSettlements'
-X GET
Example of Response Body
The following shows an example of the response body in JSON format.
{
"items": [
{
"ClaimSettlementId": 300100543256892,
"ClaimSettlementCode": "CDRM_1",
"BudgetId": 300100543256783,
"ClaimSettlementType": "DEDUCTION",
"AccountingType": "DEBIT",
"ClaimId": 300100543256801,
"CurrencyCode": "USD",
"ClaimSettlementAmount": 1,
"InvoiceReference": null,
"CreatedBy": "CHANNEL_OPERATIONS_MANAGER",
"CreationDate": "2021-06-17T04:06:50+00:00",
"LastUpdatedBy": "CHANNEL_OPERATIONS_MANAGER",
"LastUpdateLogin": "C4777AF2A730A0DEE0533DFDF40AE1D5",
"LastUpdateDate": "2021-06-17T04:07:16.109+00:00",
"StatusCode": "INCOMPLETE",
"Description": "ClaimDescrip81d02807068_11402834693",
"ClaimName": "AUTOMDFRESTC1_QAforsett2021-06-17 04:06:28",
"ClaimStatusCode": "APPROVED",
"StatusMeaning": "Incomplete",
"ClaimSettlmntTypeMeaning": "Deduction",
"AccountingTypeMeaning": "Debit",
"BudgetCurrencyExchangeRate": 1,
"ClaimCurrencyExchangeRate": 1,
"PartnerId": 100000016934002,
"PartnerName": "Stryker Corp.",
"OutstandingClaimLiabilityAmount": 10,
"ConversionRateType": "Corporate",
"ConversionCurrencyCode": "USD",
"TransactionDate": null,
"TransactionMethod": null,
"CreatedById": 100010038017885,
"CurrencyConversionDate": "2021-06-17",
"TransactionMethodMeaning": null,
"ConvExchangeRate": 1,
"ClaimCode": "ClaimApp_f7502757995",
"BudgetName": "BudgetActive_cc102757938",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/ClaimApp_f7502757995/child/ClaimSettlements/CDRM_1",
"name": "ClaimSettlements",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/ClaimApp_f7502757995/child/ClaimSettlements/CDRM_1",
"name": "ClaimSettlements",
"kind": "item"
},
{
"rel": "parent",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/ClaimApp_f7502757995",
"name": "mdfClaims",
"kind": "item"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/ClaimApp_f7502757995/child/ClaimSettlements/CDRM_1/lov/TransactionMethodVA",
"name": "TransactionMethodVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/ClaimApp_f7502757995/child/ClaimSettlements/CDRM_1/lov/CurrencyLOVVA",
"name": "CurrencyLOVVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/ClaimApp_f7502757995/child/ClaimSettlements/CDRM_1/lov/StatusLOVVA",
"name": "StatusLOVVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/ClaimApp_f7502757995/child/ClaimSettlements/CDRM_1/lov/AccountingTypeLOVVA",
"name": "AccountingTypeLOVVA",
"kind": "collection"
},
{
"rel": "lov",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/ClaimApp_f7502757995/child/ClaimSettlements/CDRM_1/lov/ClaimStlmntTypeLOVVA",
"name": "ClaimStlmntTypeLOVVA",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/ClaimApp_f7502757995/child/ClaimSettlements/CDRM_1/child/smartActions",
"name": "smartActions",
"kind": "collection"
}
]
}
],
"count": 1,
"hasMore": false,
"limit": 25,
"offset": 0,
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/ClaimApp_f7502757995/child/ClaimSettlements",
"name": "ClaimSettlements",
"kind": "collection"
}
]
}