Get all MDF claims associated to the budget

get

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

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
  • 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 a MDF claim with the specified alternate key.
      Finder Variables:
      • ClaimCode; string; The unique alternate identifier of the MDF claim.
    • PrimaryKey: Finds a MDF claim with the specified primary key identifier.
      Finder Variables:
      • ClaimId; integer; The unique identifier of the MDF claim.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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 MDF 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 on which the MDF claim was approved.
    • BudgetCurrency; string; The currency used for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request.
    • BudgetEndDate; string; The start date for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request.
    • BudgetName; string; The display name of the marketing budget associated to the MDF claim.
    • BudgetStartDate; string; The end date for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request.
    • ChannelManagerId; integer; The unique identifier of the partner owner associated to the claim.
    • ClaimAmount; number; The amount submitted for the MDF claim.
    • ClaimCode; string; The unique alternate identifier of the MDF claim.
    • ClaimId; integer; The unique identifier of the MDF claim.
    • ClaimName; string; The display name of the MDF claim.
    • ClaimStatusCode; string; The status code of the MDF claim.
    • 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 on which the MDF claim was created.
    • CurrencyCode; string; The ISO currency code entered for the MDF claim amount.
    • CurrencyConversionDate; string; The date of currency exchange rate for the claim against the corporate currency.
    • FrExchangeRate; number; The currency exchange rate for the claim against the fund request currency.
    • FundRequestApprovedAmount; number; The approved amount of the fund request associated with the 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 fund request associated with the claim.
    • LastUpdateDate; string; The date when the claim was last updated.
    • LastUpdatedBy; string; The user who last updated the marketing budget.
    • OutstngClaimLiabilityAmount; number; The outstanding claim liability amount that is pending for the budget claim.
    • OwnerEmailAddress; string; The e-mail address of the owner of the claim.
    • OwnerId; integer; The unique identifier of the user who owns the MDF claim.
    • OwnerName; string; The name of the MDF claim owner.
    • OwnerPartyNumber; string; Public Unique Identifier for the Resource.
    • OwnerPrimaryPhoneNumber; string; The primary phone number of the owner of the claim.
    • PartnerPartyUniqueName; string; The name of the partner associated with the claim.
    • RecordSet; string; The record set values of the 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 date by which claim needs to be submitted.
    • SubmittedBy; string; The user who submitted the MDF claim.
    • SubmittedById; integer; The unique identifier of the user who submitted the MDF claim.
    • SubmittedDate; string; The date on which the MDF claim was submitted.
  • 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
  • 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 : mdfBudgets-Claim
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : mdfBudgets-Claim-item-response
Type: object
Show Source
Back to Top

Examples

The following example shows how to get all mdf claims 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

Example of Response Body

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

{
    "items": [
        {
            "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": "sendmail-test-discard@oracle.com",
            "ApprovedById": 100010038017873,
            "CurrencyConversionDate": "2021-06-17",
            "RejectedById": null,
            "SubmittedById": null,
            "CanSubmit": "false",
            "CanTerminate": "true",
            "OwnerFormattedPhoneNumber": "+1 (650) 633-8437",
            "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"
                }
            ]
        },
        {
            "RecordSet": null,
            "ClaimId": 300100543257863,
            "FundRequestId": 300100543257820,
            "ClaimName": "[CLAIMNAME]",
            "Description": null,
            "CurrencyCode": "USD",
            "Age": 123,
            "ClaimAmount": 100,
            "ApprovedAmount": 0,
            "ClaimCode": "CDRM_1",
            "ClaimStatusCode": "DRAFT",
            "ApprovedBy": null,
            "ApprovedDate": null,
            "RejectedBy": null,
            "RejectedDate": null,
            "SubmittedDate": null,
            "CreatedBy": "CHANNEL_OPERATIONS_MANAGER",
            "CreationDate": "2021-06-17T04:06:36+00:00",
            "LastUpdatedBy": "Channel_OPS_Mgr_ENT1 COM",
            "LastUpdateLogin": "C4777C96CF62A0E7E0533DFDF40ACBEE",
            "LastUpdateDate": "2021-06-17T04:06:39.272+00:00",
            "FundRequestName": "RequestApp_0b602762412",
            "SubmittedBy": null,
            "FundRequestCurrency": "USD",
            "Comments": null,
            "ConversionRateType": "Corporate",
            "ConversionCurrencyCode": "USD",
            "OutstngClaimLiabilityAmount": 0,
            "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": "sendmail-test-discard@oracle.com",
            "ApprovedById": null,
            "CurrencyConversionDate": "2021-06-17",
            "RejectedById": null,
            "SubmittedById": null,
            "CanSubmit": "true",
            "CanTerminate": "false",
            "OwnerFormattedPhoneNumber": "+1 (650) 633-8437",
            "CanApprove": "false",
            "CanReject": "false",
            "CanWithdraw": "false",
            "CanReturn": "false",
            "FrExchangeRate": 1,
            "ReturnReasonCode": null,
            "RejectReasonCode": null,
            "ApprovalActionComments": null,
            "ConvExchangeRate": 1,
            "UpdateFlag": true,
            "DeleteFlag": true,
            "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/CDRM_1",
                    "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/CDRM_1",
                    "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/CDRM_1/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/CDRM_1/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/CDRM_1/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/CDRM_1/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/CDRM_1/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/CDRM_1/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/CDRM_1/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/CDRM_1/lov/RecordSetVA",
                    "name": "RecordSetVA",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/Claim",
            "name": "Claim",
            "kind": "collection"
        }
    ]
}
Back to Top