Create a claim settlement

post

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

Request

Path Parameters
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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • 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.
  • Title: Code
    Maximum Length: 100
    The user-defined, unique label for the marketing claim.
  • Title: Claim ID
    The unique identifier of the MDF claim.
  • Title: Amount
    The amount settled in the MDF claim settlement.
  • Title: Code
    Maximum Length: 100
    The user-defined, unique label for the MDF claim settlement.
  • Title: Claim Settlement ID
    The unique identifier of the MDF claim settlement.
  • Title: Type
    Maximum Length: 30
    The type of the MDF claim settlement, for example deduction or payment.
  • 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.
  • Title: Description
    Maximum Length: 1000
    A brief description of the marketing claim settlement.
  • Title: Transaction Reference
    Maximum Length: 100
    The reference identifier of the invoice to be settled with the MDF claim settlement.
  • Title: Status
    Maximum Length: 30
    Default Value: INCOMPLETE
    The code indicating the completion status of the marketing claim settlement.
  • Title: Transaction Date
    The date when the claim settlement was processed or marked as complete.
  • Title: Transaction Method
    Maximum Length: 30
    The method by which the claim settlement transaction was processed.
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 : mdfClaims-ClaimSettlements-item-response
Type: object
Show Source
  • 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.
  • 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.
  • 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.
  • Title: Budget ID
    Read Only: true
    The unique identifier of the parent budget associated with the MDF claim.
  • 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.
  • Title: Code
    Maximum Length: 100
    The user-defined, unique label for the marketing claim.
  • 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.
  • Title: Claim ID
    The unique identifier of the MDF claim.
  • Title: Name
    Read Only: true
    Maximum Length: 250
    The name of the claim associated with the claim settlement.
  • Title: Amount
    The amount settled in the MDF claim settlement.
  • Title: Code
    Maximum Length: 100
    The user-defined, unique label for the MDF claim settlement.
  • Title: Claim Settlement ID
    The unique identifier of the MDF claim settlement.
  • Title: Type
    Maximum Length: 30
    The type of the MDF claim settlement, for example deduction or payment.
  • Title: Type
    Read Only: true
    The type of marketing claim settlement, for example deduction or payment.
  • Title: Status
    Read Only: true
    Maximum Length: 30
    The status of the claim settlement.
  • Title: Conversion Currency Code
    Read Only: true
    Maximum Length: 30
    The currency code associated with the claim settlement.
  • Title: Conversion Rate Type
    Read Only: true
    Maximum Length: 30
    The conversion rate type associated with the claim settlement.
  • Title: Conversion Exchange Rate
    Read Only: true
    The currency exchange rate for the claim settlement against the corporate currency.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    The user who created the MDF claim settlement.
  • Title: Created by ID
    Read Only: true
    The unique identifier of the creator of the claim settlement.
  • Title: Creation Date
    Read Only: true
    The date when the claim settlement was created.
  • 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.
  • Title: Currency Conversion Date
    Read Only: true
    The date of currency exchange rate for the claim settlement against the corporate currency.
  • Title: Description
    Maximum Length: 1000
    A brief description of the marketing claim settlement.
  • Title: Transaction Reference
    Maximum Length: 100
    The reference identifier of the invoice to be settled with the MDF claim settlement.
  • Title: Last Update Date
    Read Only: true
    The date when the settlement was last updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    The user who last updated the marketing claim settlement.
  • Title: Last Update Login
    Read Only: true
    Maximum Length: 32
    The login of the user who last updated the settlement.
  • Links
  • Title: Liability Amount
    Read Only: true
    Default Value: 0
    The outstanding claim liability amount.
  • Title: Partner ID
    Read Only: true
    The unique identifier of the party.
  • Title: Partner
    Read Only: true
    The name of the party.
  • Title: Status
    Maximum Length: 30
    Default Value: INCOMPLETE
    The code indicating the completion status of the marketing claim settlement.
  • Title: Status
    Read Only: true
    The completion status of the marketing claim settlement.
  • Title: Transaction Date
    The date when the claim settlement was processed or marked as complete.
  • Title: Transaction Method
    Maximum Length: 30
    The method by which the claim settlement transaction was processed.
  • Title: Transaction Method
    Read Only: true
    The method by which claim settlement transaction is processed.
Back to Top