Jump to

• Request
• Response

Get a claim settlement

get

/crmRestApi/resources/11.13.18.05/mdfClaims/{ClaimCode}/child/ClaimSettlements/{ClaimSettlementCode}

Request

Path Parameters

• ClaimCode(required): string
  The user-defined, unique label for the MDF claim.
• ClaimSettlementCode(required): string
  The user-defined, unique label for the MDF claim settlement.

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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 Top

Response

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.

Body ()

Root Schema : mdfClaims-ClaimSettlements-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AccountingType":{
            "title":"Accounting Type",
            "maxLength":"30",
            "type":"string",
            "description":"The accounting type of the MDF claim settlement, which represents credit or debit in the back-end financial system.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the claim settlement was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InvoiceReference":{
            "title":"Transaction Reference",
            "maxLength":"100",
            "type":"string",
            "description":"The reference identifier of the invoice to be settled with the MDF claim settlement.",
            "nullable":true,
            "x-queryable":true
        },
        "BudgetCurrencyExchangeRate":{
            "title":"Conversion Rate to Budget",
            "type":"number",
            "description":"The exchange rate used to convert the marketing claim settlement currency to the parent budget currency.",
            "nullable":false,
            "readOnly":true,
            "default":"1",
            "x-queryable":true
        },
        "ClaimId":{
            "title":"Claim ID",
            "type":"number",
            "description":"The unique identifier of the MDF claim.",
            "nullable":false,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"A brief description of the marketing claim settlement.",
            "nullable":true,
            "x-queryable":true
        },
        "OutstandingClaimLiabilityAmount":{
            "title":"Liability Amount",
            "type":"number",
            "description":"The outstanding claim liability amount.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "ClaimStatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status of the claim settlement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CurrencyConversionDate":{
            "title":"Currency Conversion Date",
            "type":"string",
            "description":"The date of currency exchange rate for the claim settlement against the corporate currency.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the completion status of the marketing claim settlement.",
            "nullable":false,
            "default":"INCOMPLETE",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConversionRateType":{
            "title":"Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The conversion rate type associated with the claim settlement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ClaimSettlementCode":{
            "title":"Code",
            "maxLength":"100",
            "type":"string",
            "description":"The user-defined, unique label for the MDF claim settlement.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedById":{
            "title":"Created by ID",
            "type":"integer",
            "description":"The unique identifier of the creator of the claim settlement.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ConvExchangeRate":{
            "title":"Conversion Exchange Rate",
            "type":"number",
            "description":"The currency exchange rate for the claim settlement against the corporate currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimSettlementType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the MDF claim settlement, for example deduction or payment.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ClaimCode":{
            "title":"Code",
            "maxLength":"100",
            "type":"string",
            "description":"The user-defined, unique label for the marketing claim.",
            "nullable":false,
            "x-queryable":true
        },
        "AccountingTypeMeaning":{
            "title":"Accounting Type",
            "type":"string",
            "description":"The accounting type of the marketing claim settlement, which represents a credit or debit in the back-end financial system.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TransactionMethodMeaning":{
            "title":"Transaction Method",
            "type":"string",
            "description":"The method by which claim settlement transaction is processed.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "TransactionMethod"
                ]
            },
            "x-queryable":true
        },
        "TransactionDate":{
            "title":"Transaction Date",
            "type":"string",
            "description":"The date when the claim settlement was processed or marked as complete.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the marketing claim settlement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the MDF claim settlement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BudgetId":{
            "title":"Budget ID",
            "type":"number",
            "description":"The unique identifier of the parent budget associated with the MDF claim.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PartnerName":{
            "title":"Partner",
            "type":"string",
            "description":"The name of the party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionMethod":{
            "title":"Transaction Method",
            "maxLength":"30",
            "type":"string",
            "description":"The method by which the claim settlement transaction was processed.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ClaimName":{
            "title":"Name",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the claim associated with the claim settlement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status",
            "type":"string",
            "description":"The completion status of the marketing claim settlement.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "StatusCode"
                ]
            },
            "x-queryable":true
        },
        "ClaimSettlmntTypeMeaning":{
            "title":"Type",
            "type":"string",
            "description":"The type of marketing claim settlement, for example deduction or payment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ConversionCurrencyCode":{
            "title":"Conversion Currency Code",
            "maxLength":"30",
            "type":"string",
            "description":"The currency code associated with the claim settlement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimSettlementId":{
            "title":"Claim Settlement ID",
            "type":"integer",
            "description":"The unique identifier of the MDF claim settlement.",
            "nullable":false,
            "x-queryable":true
        },
        "ClaimSettlementAmount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount settled in the MDF claim settlement.",
            "nullable":false,
            "x-queryable":true
        },
        "BudgetName":{
            "title":"Name",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the MDF budget associated with the claim. MDF budget is associated to the claim through fund request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the settlement.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the settlement was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimCurrencyExchangeRate":{
            "title":"Conversion Rate to Claim",
            "type":"number",
            "description":"The exchange rate used to convert the marketing claim settlement currency to the parent marketing claim currency.",
            "nullable":false,
            "readOnly":true,
            "default":"1",
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

AccountingTypeLOVVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKT_MDF_CLAIM_STLMNT_ACC_TYPE%2CBindLookupCode%3D{AccountingType}

The list of values indicating the claim settlement accounting type.

The following properties are defined on the LOV link relation:

• Source Attribute: AccountingType; Target Attribute: LookupCode
• Display Attribute: Meaning

ClaimStlmntTypeLOVVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKT_MDF_CLAIM_STLMNT_TYPE%2CBindLookupCode%3D{ClaimSettlementType}

The list of values indicating the claim settlement type.

The following properties are defined on the LOV link relation:

• Source Attribute: ClaimSettlementType; Target Attribute: LookupCode
• Display Attribute: Meaning

CurrencyLOVVA

Operation: /crmRestApi/resources/11.13.18.05/ratedCurrencies

The list of values indicating the currency code associated with the MDF claim settlement, such as USD, CAD, or Euro.

The following properties are defined on the LOV link relation:

• Source Attribute: CurrencyCode; Target Attribute: CurrencyCode
• Display Attribute: CurrencyCode

StatusLOVVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DMKT_MDF_CLAIM_STLMNT_STATUS%2CBindLookupCode%3D{StatusCode}

The list of values indicating the status of the MDF claim settlement.

The following properties are defined on the LOV link relation:

• Source Attribute: StatusCode; Target Attribute: LookupCode
• Display Attribute: Meaning

TransactionMethodVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_MDFCLAIMSETT_TRANS%2CBindLookupCode%3D{TransactionMethod}

The list of values indicating the claim settlement transaction methods.

The following properties are defined on the LOV link relation:

• Source Attribute: TransactionMethod; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top