Jump to

• Request
• Response
• Examples

Get all MDF claims

get

/crmRestApi/resources/11.13.18.05/mdfClaims

Request

Query Parameters

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

  • ClaimVOAltKey: Finds an MDF claim with the specified alternate key.
    Finder Variables:
    • ClaimCode; string; The alternate key identifier of the MDF claim.
  • PrimaryKey: Finds an MDF claim with the specified primary key.
    Finder Variables:
    • ClaimId; integer; The unique identifier of the MDF claim.
• 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:
  

  • 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 when 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 end 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 start 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 account director associated with the claim.
  • ClaimAmount; number; The amount of reimbursement requested in the MDF claim.
  • ClaimCode; string; The user-defined, unique label for the MDF claim.
  • ClaimId; integer; The unique identifier of the MDF claim.
  • ClaimName; string; The display name of the MDF claim.
  • ClaimStatusCode; string; The code indicating the status 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 when the MDF claim was created.
  • CurrencyCode; string; The currency code. 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; The date of currency exchange rate for the claim against the corporate currency.
  • FrExchangeRate; number; The exchange rate of the fund request associated with the claim.
  • FundRequestApprovedAmount; number; The approved amount on the associated fund request.
  • 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 fund request associated with the claim.
  • LastUpdateDate; string; The date when the claim was last updated.
  • LastUpdatedBy; string; The user who last updated the MDF claim.
  • OutstngClaimLiabilityAmount; number; The outstanding claim liability amount.
  • OwnerEmailAddress; string; The email address of the owner.
  • OwnerId; integer; The unique identifier of the owner of the MDF claim.
  • OwnerName; string; The name of owner of the MDF claim.
  • OwnerPartyNumber; string; The alternate key identifier of the owner party.
  • OwnerPrimaryPhoneNumber; string; The phone number of the owner.
  • PartnerPartyUniqueName; string; The name of the partner associated with the claim.
  • RecordSet; string; The record set values for 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 associated 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 when the MDF claim was submitted.
• 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 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

Type: object

Show Source

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

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/mdfClaims-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject",
        "group":"OEC"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object mdfClaims-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/mdfClaims-item-response"
    }
}

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 : mdfClaims-item-response

Type: object

Show Source

• ActivityOutcome: string
  Title: Activity Outcome

  Maximum Length: 1000

  Partner Activity Out come.
• Age: number
  Title: Claim Age

  Read Only: true

  The number of days since the MDF claim was created.
• ApprovalActionComments: string
  Title: Approver Comments

  The comments entered during approval action on the claim.
• ApprovalTaskStatusCode: string
  Title: Status

  The code indicating the approval action that can be taken in the MDF Claim. The accepted values are Approve, Reject, Return, Withdraw, Terminate, and HtOutcmeReturnReturnAction.
• ApprovedAmount: number
  Title: Approved Amount

  Default Value: 0

  The amount approved for the MDF claim.
• ApprovedBy: string
  Title: Approvers

  Maximum Length: 64

  The user who approved the MDF claim.
• ApprovedById: integer (int64)
  Title: Approved by ID

  The unique identifier of the user who approved the MDF claim.
• ApprovedDate: string (date)
  Title: Approved Date

  The date when the MDF claim was approved.
• Attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• BgtExchangeRate: number
  Title: Conversion Rate to Budget

  Default Value: 0

  The exchange rate of the MDF budget which is associated with the claim. MDF budget is associated to the claim through fund request.
• BudgetCurrency: string
  Title: Budget Currency

  Read Only: true

  Maximum Length: 30

  The currency used for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request.
• BudgetEndDate: string (date)
  Title: Budget End Date

  Read Only: true

  The end date for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request.
• BudgetName: string
  Title: Budget

  Maximum Length: 250

  The display name of the marketing budget associated to the MDF claim.
• BudgetStartDate: string (date)
  Title: Start Date

  Read Only: true

  The start date for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request.
• CanApprove: boolean
  Title: Can Approve

  Read Only: true

  Indicates whether the user can approve the MDF Claim. If the user has access to approve an MDF claim then the default value is true, else false.
• CanReject: boolean
  Title: Can Reject

  Read Only: true

  Indicates whether the user has access to reject the claim.
• CanReturn: boolean
  Title: Can Return

  Read Only: true

  Indicates whether the user has access to return the claim.
• CanSubmit: boolean
  Title: Can Submit

  Read Only: true

  Indicates whether the user has access to submit the claim.
• CanTerminate: boolean
  Title: Can Terminate

  Read Only: true

  Indicates whether the user has access to terminate the claim.
• CanWithdraw: boolean
  Title: Can Withdraw

  Read Only: true

  Indicates whether the user has access to withdraw the claim.
• ChannelManagerId: integer (int64)
  Title: Account Director ID

  Read Only: true

  The unique identifier of the account director associated with the claim.
• ChannelMgrName: string
  Title: Channel Manager

  The name of the channel manager on the claim.
• ClaimAmount: number
  Title: Requested Amount

  The amount of reimbursement requested in the MDF claim.
• ClaimCode: string
  Title: Code

  Maximum Length: 100

  The user-defined, unique label for the MDF claim.
• ClaimId: integer (int64)
  Title: Claim ID

  The unique identifier of the MDF claim.
• ClaimName: string
  Title: Name

  Maximum Length: 250

  The display name of the MDF claim.
• ClaimResource: array Claim Team Members
  Title: Claim Team Members

  The claim team members resource is used to view, create, update, and delete a claim team member. A claim team member is a resource who is assigned to the MDF claim team, and who has the appropriate visibility and access to the MDF Claim record.
• ClaimSettlements: array Claim Settlements
  Title: Claim Settlements

  The claim settlements resource is used to view, create, update, and delete the payments made to partners as reimbursement for the marketing expenses incurred by that partner.
• ClaimStatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: DRAFT

  The code indicating the status of the MDF claim.
• Comments: string
  Title: Comments

  Maximum Length: 1000

  Any additional comments for the MDF claim.
• ConversionCurrencyCode: string
  Title: Conversion Currency Code

  Read Only: true

  Maximum Length: 30

  The currency code used for conversion in the claim.
• ConversionRateType: string
  Title: Conversion Rate Type

  Read Only: true

  Maximum Length: 30

  The currency conversion rate type associated with the MDF claim.
• ConvExchangeRate: number
  Title: Conversion Exchange Rate

  The currency exchange rate for the claim against the corporate currency.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the MDF claim.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the MDF claim was created.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 30

  The currency code. 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

  The date of currency exchange rate for the claim against the corporate currency.
• DeleteFlag: boolean
  Title: Delete Indicator

  Read Only: true

  Indicates whether the user has access to delete the record.
• Description: string
  Title: Description

  Maximum Length: 4000

  A brief description of the MDF claim.
• FrExchangeRate: number
  Title: Fund Request Exchange Rate

  Default Value: 0

  The exchange rate of the fund request associated with the claim.
• FundRequestApprovedAmount: number
  Title: MDF Request Approved Amount

  Read Only: true

  The approved amount on the associated fund request.
• FundRequestCode: string
  Title: Fund Request Code

  Maximum Length: 100

  Public Unique Identifier for the marketing fund request.
• FundRequestCurrency: string
  Title: Currency

  Read Only: true

  Maximum Length: 30

  The currency code on the associated fund request.
• FundRequestId: integer (int64)
  Title: Fund Request ID

  The unique identifier of the MDF fund request associated with the MDF claim.
• FundRequestName: string
  Title: MDF Request

  Maximum Length: 250

  The name of the fund request associated with the claim.
• FundRequestType: string
  Title: MDF Request Type

  Read Only: true

  Maximum Length: 30

  The type of fund request associated with the claim.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the claim was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the MDF claim.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the claim.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Note: array Notes
  Title: Notes

  The notes resource is used to view, create, update, and delete notes associated with a claim. A note captures comments, information, or instructions related to a claim.
• OutstngClaimLiabilityAmount: number
  Title: Liability Amount

  Default Value: 0

  The outstanding claim liability amount.
• OwnerEmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The email address of the owner.
• OwnerFormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The formatted phone of the owner.
• OwnerId: integer (int64)
  Title: Owner ID

  The unique identifier of the owner of the MDF claim.
• OwnerName: string
  Title: Owner

  Maximum Length: 360

  The name of owner of the MDF claim.
• OwnerPartyNumber: string
  Title: Owner Party Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the owner party.
• OwnerPrimaryPhoneNumber: string
  Title: Phone

  Read Only: true

  Maximum Length: 40

  The phone number of the owner.
• PartnerPartyUniqueName: string
  Title: Partner

  Read Only: true

  Maximum Length: 360

  The name of the partner associated with the claim.
• RecordSet: string
  Title: Record Set

  Read Only: true

  The record set values for claim.
• RejectedBy: string
  Title: Rejected By

  Maximum Length: 64

  The user who rejected the MDF claim.
• RejectedById: integer (int64)
  Title: Rejected by ID

  The unique identifier of the user who rejected the MDF claim.
• RejectedDate: string (date)
  Title: Rejected Date

  The date when the MDF claim was rejected.
• RejectReasonCode: string
  Title: Reject Reason

  The reason code for rejecting the claim.
• ReturnReasonCode: string
  Title: Return Reason

  The reason code for returning the claim back to the submitter.
• SubmitClaimsBy: string (date)
  Title: Claim Deadline

  Read Only: true

  The date by which associated claim needs to be submitted.
• SubmittedBy: string
  Title: Submitted By

  Maximum Length: 64

  The user who submitted the MDF claim.
• SubmittedById: integer (int64)
  Title: Submitted by ID

  The unique identifier of the user who submitted the MDF claim.
• SubmittedDate: string (date)
  Title: Submitted Date

  The date when the MDF claim was submitted.
• UpdateFlag: boolean
  Title: Update Indicator

  Read Only: true

  Indicates whether the user has access to update the record.

{
    "type":"object",
    "properties":{
        "RejectedDate":{
            "title":"Rejected Date",
            "type":"string",
            "description":"The date when the MDF claim was rejected.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the  MDF claim was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CanSubmit":{
            "title":"Can Submit",
            "type":"boolean",
            "description":"Indicates whether the user has access to submit the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FundRequestCode":{
            "title":"Fund Request Code",
            "maxLength":"100",
            "type":"string",
            "description":"Public Unique Identifier for the marketing fund request.",
            "nullable":false,
            "x-queryable":true
        },
        "BudgetCurrency":{
            "title":"Budget Currency",
            "maxLength":"30",
            "type":"string",
            "description":"The currency used for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RejectedBy":{
            "title":"Rejected By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who rejected the MDF claim.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "CanTerminate":{
            "title":"Can Terminate",
            "type":"boolean",
            "description":"Indicates whether the user has access to terminate the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"30",
            "type":"string",
            "description":"The currency code. 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-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "FundRequestName":{
            "title":"MDF Request",
            "maxLength":"250",
            "type":"string",
            "description":"The name of the fund request associated with the claim.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "="
                ],
                "dependencies":[
                    "BudgetId",
                    "BudgetName"
                ]
            },
            "x-queryable":true
        },
        "ConvExchangeRate":{
            "title":"Conversion Exchange Rate",
            "type":"number",
            "description":"The currency exchange rate for the claim against the corporate currency.",
            "nullable":true,
            "x-queryable":true
        },
        "SubmitClaimsBy":{
            "title":"Claim Deadline",
            "type":"string",
            "description":"The date by which associated claim needs to be submitted.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "BudgetId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecordSet":{
            "title":"Record Set",
            "type":"string",
            "description":"The record set values for claim.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the MDF claim.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the MDF claim.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "ApprovedDate":{
            "title":"Approved Date",
            "type":"string",
            "description":"The date when the  MDF claim was approved.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CanApprove":{
            "title":"Can Approve",
            "type":"boolean",
            "description":"Indicates whether the user can approve the MDF Claim. If the user has access to approve an MDF claim then the default value is true, else false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SubmittedBy":{
            "title":"Submitted By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who submitted the MDF claim.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "SubmittedById":{
            "title":"Submitted by ID",
            "type":"integer",
            "description":"The unique identifier of the user who submitted the MDF claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReturnReasonCode":{
            "title":"Return Reason",
            "type":"string",
            "description":"The reason code for returning the claim back to the submitter.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the user has access to delete the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ClaimName":{
            "title":"Name",
            "maxLength":"250",
            "type":"string",
            "description":"The display name of the MDF claim.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "ApprovedBy":{
            "title":"Approvers",
            "maxLength":"64",
            "type":"string",
            "description":"The user who approved the MDF claim.",
            "nullable":true,
            "x-queryable":true
        },
        "ChannelMgrName":{
            "title":"Channel Manager",
            "type":"string",
            "description":"The name of the channel manager on the claim.",
            "nullable":true,
            "x-queryable":false
        },
        "ConversionCurrencyCode":{
            "title":"Conversion Currency Code",
            "maxLength":"30",
            "type":"string",
            "description":"The currency code used for conversion in the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Note":{
            "title":"Notes",
            "type":"array",
            "description":"The notes resource is used to view, create, update, and delete notes associated with a claim. A note captures comments, information, or instructions related to a claim.",
            "items":{
                "$ref":"#/components/schemas/mdfClaims-Note-item-response"
            }
        },
        "CanReject":{
            "title":"Can Reject",
            "type":"boolean",
            "description":"Indicates whether the user has access to reject the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerEmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the owner.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ],
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "BudgetName":{
            "title":"Budget",
            "maxLength":"250",
            "type":"string",
            "description":"The display name of the marketing budget associated to the MDF claim.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CanWithdraw":{
            "title":"Can Withdraw",
            "type":"boolean",
            "description":"Indicates whether the user has access to withdraw the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FundRequestType":{
            "title":"MDF Request Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of fund request associated with the claim.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "ClaimId":{
            "title":"Claim ID",
            "type":"integer",
            "description":"The unique identifier of the MDF claim.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OwnerName":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of owner of the MDF claim.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "BudgetEndDate":{
            "title":"Budget End Date",
            "type":"string",
            "description":"The end date for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"A brief description of the MDF claim.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerPartyNumber":{
            "title":"Owner Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the owner party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimStatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the status of the MDF claim.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "ApprovedById":{
            "title":"Approved by ID",
            "type":"integer",
            "description":"The unique identifier of the user who approved the MDF claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyConversionDate":{
            "title":"Currency Conversion Date",
            "type":"string",
            "description":"The date of currency exchange rate for the claim against the corporate currency.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "SubmittedDate":{
            "title":"Submitted Date",
            "type":"string",
            "description":"The date when the MDF claim was submitted.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/mdfClaims-Attachments-item-response"
            }
        },
        "ConversionRateType":{
            "title":"Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type associated with the MDF claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FrExchangeRate":{
            "title":"Fund Request Exchange Rate",
            "type":"number",
            "description":"The exchange rate of the fund request associated with the claim.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ClaimAmount":{
            "title":"Requested Amount",
            "type":"number",
            "description":"The amount of reimbursement requested in the  MDF claim.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">="
                ]
            },
            "x-queryable":true
        },
        "ClaimSettlements":{
            "title":"Claim Settlements",
            "type":"array",
            "description":"The claim settlements resource is used to view, create, update, and delete the payments made to partners as reimbursement for the marketing expenses incurred by that partner.",
            "items":{
                "$ref":"#/components/schemas/mdfClaims-ClaimSettlements-item-response"
            }
        },
        "BudgetStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date for the MDF budget associated with the claim. MDF budget is associated to the claim through fund request.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "BudgetId"
                ]
            },
            "x-queryable":true
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of the owner of the MDF claim.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActivityOutcome":{
            "title":"Activity Outcome",
            "maxLength":"1000",
            "type":"string",
            "description":"Partner Activity Out come.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimCode":{
            "title":"Code",
            "maxLength":"100",
            "type":"string",
            "description":"The user-defined, unique label for the MDF claim.",
            "nullable":false,
            "x-queryable":true
        },
        "OutstngClaimLiabilityAmount":{
            "title":"Liability Amount",
            "type":"number",
            "description":"The outstanding claim liability amount.",
            "nullable":true,
            "default":"0",
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">="
                ]
            },
            "x-queryable":true
        },
        "CanReturn":{
            "title":"Can Return",
            "type":"boolean",
            "description":"Indicates whether the user has access to return the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BgtExchangeRate":{
            "title":"Conversion Rate to Budget",
            "type":"number",
            "description":"The exchange rate of the MDF budget which is associated with the claim. MDF budget is associated to the claim through fund request.",
            "nullable":false,
            "default":"0",
            "x-queryable":false
        },
        "FundRequestApprovedAmount":{
            "title":"MDF Request Approved Amount",
            "type":"number",
            "description":"The approved amount on the associated fund request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Age":{
            "title":"Claim Age",
            "type":"number",
            "description":"The number of days since the MDF claim was created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ChannelManagerId":{
            "title":"Account Director ID",
            "type":"integer",
            "description":"The unique identifier of the account director associated with the claim.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartnerPartyUniqueName":{
            "title":"Partner",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the partner associated with the claim.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "OwnerPrimaryPhoneNumber":{
            "title":"Phone",
            "maxLength":"40",
            "type":"string",
            "description":"The phone number of the owner.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ],
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"1000",
            "type":"string",
            "description":"Any additional comments for the MDF claim.",
            "nullable":true,
            "x-queryable":false
        },
        "ApprovalActionComments":{
            "title":"Approver Comments",
            "type":"string",
            "description":"The comments entered during approval action on the claim.",
            "nullable":true,
            "x-queryable":false
        },
        "ClaimResource":{
            "title":"Claim Team Members",
            "type":"array",
            "description":"The claim team members resource is used to view, create, update, and delete a claim team member. A claim team member is a resource who is assigned to the MDF claim team, and who has the appropriate visibility and access to the MDF Claim record.",
            "items":{
                "$ref":"#/components/schemas/mdfClaims-ClaimResource-item-response"
            }
        },
        "FundRequestId":{
            "title":"Fund Request ID",
            "type":"integer",
            "description":"The unique identifier of the MDF fund request associated with the MDF claim.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "dependencies":[
                    "BudgetId"
                ]
            }
        },
        "FundRequestCurrency":{
            "title":"Currency",
            "maxLength":"30",
            "type":"string",
            "description":"The currency code on the associated fund request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RejectReasonCode":{
            "title":"Reject Reason",
            "type":"string",
            "description":"The reason code for rejecting the claim.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ApprovedAmount":{
            "title":"Approved Amount",
            "type":"number",
            "description":"The amount approved for the MDF claim.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "ApprovalTaskStatusCode":{
            "title":"Status",
            "type":"string",
            "description":"The code indicating the approval action that can be taken in the MDF Claim. The accepted values are Approve, Reject, Return, Withdraw, Terminate, and HtOutcmeReturnReturnAction.",
            "nullable":true,
            "x-queryable":false
        },
        "RejectedById":{
            "title":"Rejected by ID",
            "type":"integer",
            "description":"The unique identifier of the user who rejected the MDF claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the claim was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerFormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone of the owner.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

The attachments resource is used to view, create, and update attachments.

Show Source

• Array of: object mdfClaims-Attachments-item-response

{
    "title":"Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, and update attachments.",
    "items":{
        "$ref":"#/components/schemas/mdfClaims-Attachments-item-response"
    }
}

Nested Schema : Claim Team Members

Type: array

Title: Claim Team Members

The claim team members resource is used to view, create, update, and delete a claim team member. A claim team member is a resource who is assigned to the MDF claim team, and who has the appropriate visibility and access to the MDF Claim record.

Show Source

• Array of: object mdfClaims-ClaimResource-item-response

{
    "title":"Claim Team Members",
    "type":"array",
    "description":"The claim team members resource is used to view, create, update, and delete a claim team member. A claim team member is a resource who is assigned to the MDF claim team, and who has the appropriate visibility and access to the MDF Claim record.",
    "items":{
        "$ref":"#/components/schemas/mdfClaims-ClaimResource-item-response"
    }
}

Nested Schema : Claim Settlements

Type: array

Title: Claim Settlements

The claim settlements resource is used to view, create, update, and delete the payments made to partners as reimbursement for the marketing expenses incurred by that partner.

Show Source

• Array of: object mdfClaims-ClaimSettlements-item-response

{
    "title":"Claim Settlements",
    "type":"array",
    "description":"The claim settlements resource is used to view, create, update, and delete the payments made to partners as reimbursement for the marketing expenses incurred by that partner.",
    "items":{
        "$ref":"#/components/schemas/mdfClaims-ClaimSettlements-item-response"
    }
}

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 : Notes

Type: array

Title: Notes

The notes resource is used to view, create, update, and delete notes associated with a claim. A note captures comments, information, or instructions related to a claim.

Show Source

• Array of: object mdfClaims-Note-item-response

{
    "title":"Notes",
    "type":"array",
    "description":"The notes resource is used to view, create, update, and delete notes associated with a claim. A note captures comments, information, or instructions related to a claim.",
    "items":{
        "$ref":"#/components/schemas/mdfClaims-Note-item-response"
    }
}

Nested Schema : mdfClaims-Attachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

  The unique identifier of the attached document.
• CategoryName: string
  Title: Category

  Maximum Length: 30

  The category of the attachment.
• ContentRepositoryFileShared: boolean
  Title: Shared

  Indicates whether the attachment is shared
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 255

  The user who created the record.
• CreatedByUserName: string
  Title: Created By User Name

  Read Only: true

  The user name who created the record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  A value that indicates the data type.
• Description: string
  Title: Description

  Maximum Length: 255

  The description of the attachment.
• DmDocumentId: string
  Maximum Length: 255

  The document ID from which the attachment is created.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path from which the attachment is created.
• DmVersionNumber: string
  Maximum Length: 255

  The document version number from which the attachment is created.
• DownloadInfo: string
  Title: DownloadInfo

  JSON object represented as a string containing information used to programmatically retrieve a file attachment.
• ErrorStatusCode: string
  Title: Error Status Code

  The error code, if any, for the attachment.
• ErrorStatusMessage: string
  Title: Error Status Message

  The error message, if any, for the attachment.
• ExpirationDate: string (date-time)
  Title: Expiration Date

  The expiration date of the contents in the attachment.
• FileContents: string (byte)
  Title: File Contents

  The contents of the attachment.
• FileName: string
  Title: File Name

  Maximum Length: 2048

  The file name of the attachment.
• FileUrl: string
  Title: File Url

  The URI of the file.
• FileWebImage: string (byte)
  Title: File Web Image

  Read Only: true

  The base64 encoded image of the file displayed in .png format if the source is a convertible image.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 255

  The user who last updated the record.
• LastUpdatedByUserName: string
  Title: Last Updated By User

  Read Only: true

  The user name who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PostProcessingAction: string
  Title: PostProcessingAction

  The name of the action that can be performed after an attachment is uploaded.
• Title: string
  Title: Title

  The title of the attachment.
• UploadedFileContentType: string
  Title: Uploaded File Content Type

  The content type of the attachment.
• UploadedFileLength: integer
  Title: File Size

  The size of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name to assign to a new attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text content for a new text attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of a Topology Manager type attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of a web page type attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login credentials of the user who created the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"255",
            "type":"string",
            "description":"The description of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"The file name of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":"4000",
            "type":"string",
            "description":"The URI of a Topology Manager type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":"4000",
            "type":"string",
            "description":"The URL of a web page type attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":"255",
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name who created the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The size of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":"255",
            "type":"string",
            "description":"The login credentials of the user who created the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"255",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"A value that indicates the data type.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "PostProcessingAction":{
            "title":"PostProcessingAction",
            "type":"string",
            "description":"The name of the action that can be performed after an attachment is uploaded.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name to assign to a new attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URI of the file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates whether the attachment is shared",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":"1000",
            "type":"string",
            "description":"The folder path from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text content for a new text attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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."
        }
    }
}

Nested Schema : mdfClaims-ClaimResource-item-response

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Maximum Length: 30

  The code indicating the level of access of a MDF claim team member.
• ClaimCode: string
  Title: Code

  Maximum Length: 100

  The user-defined, unique label for the marketing claim.
• ClaimId: integer (int64)
  Title: Claim ID

  The unique identifier of the MDF claim associated with the resource.
• ClaimResourceId: integer (int64)
  Title: Claim Resource ID

  The unique identifier of a member of the MDF request team.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the resource on the MDF claim team.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the resource was created on the MDF claim team.
• EmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The email address of the MDF claim team member associated with the MDF claim.
• FormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The phone number of the MDF claim team member associated with the MDF claim.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date when the resource was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the MDF claim team member.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the resource.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemberFunctionCode: string
  Title: Function

  Maximum Length: 30

  The code indicating the function of the MDF claim team member.
• OwnerFlag: boolean
  Title: Owner

  Read Only: true

  Indicates whether the MDF claim team member is the owner of the MDF claim.
• PartyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the MDF claim team member associated with the MDF claim.
• ResourceId: integer (int64)
  Title: Resource ID

  The unique identifier of the MDF claim team member.
• ResourcePartyNumber: string
  Title: Resource Party Number

  Read Only: true

  Maximum Length: 30

  The alternate key identifier of the resource party.
• ResourceUsername: string
  Title: Resource User Name

  Read Only: true

  The username of the MDF claim team member associated with the MDF claim.
• UserLastUpdateDate: string (date-time)
  Title: Last Update Date

  The date and time when the MDF claim team member record was last updated.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the MDF claim team member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the resource was created on the MDF claim team.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimId":{
            "title":"Claim ID",
            "type":"integer",
            "description":"The unique identifier of the MDF claim associated with the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the resource on the MDF claim team.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the level of access of a MDF claim team member.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the MDF claim team member is the owner of the MDF claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the MDF claim team member associated with the MDF claim.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceUsername":{
            "title":"Resource User Name",
            "type":"string",
            "description":"The username of the MDF claim team member associated with the MDF claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserLastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the MDF claim team member record was last updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the MDF claim team member associated with the MDF claim.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the MDF claim team member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Resource Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The alternate key identifier of the resource party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimResourceId":{
            "title":"Claim Resource ID",
            "type":"integer",
            "description":"The unique identifier of a member of the MDF request team.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "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
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the function of the MDF claim team member.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the MDF claim team member associated with the MDF claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the resource was last updated.",
            "format":"date-time",
            "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 resource.",
            "nullable":true,
            "readOnly":true,
            "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 : 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 : mdfClaims-Note-item-response

Type: object

Show Source

• ContactRelationshipId: integer (int64)
  Title: Contact Relationship ID

  The unique identifier of the contact relationship. This attribute is populated when the note is associated with an MDF claim user.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the note associated with the MDF claim. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the note.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the note was created.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  The unique identifier of the party that the note creator belongs to.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.
• DeleteFlag: boolean
  Title: Delete Indicator

  Read Only: true

  Indicates whether the note is to be deleted. If the value is Y, then the note has to be deleted. The default value is N.
• EmailAddress: string
  Title: Primary Email

  Read Only: true

  Maximum Length: 320

  The email address of the user who created the note.
• FormattedAddress: string
  Title: Primary Address

  Read Only: true

  The address of the user who created the note.
• FormattedPhoneNumber: string
  Title: Primary Phone

  Read Only: true

  The phone number of the user who created the note.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date and time when the note data was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the note.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the note.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NoteId: integer (int64)
  Title: Note ID

  Read Only: true

  The unique identifier of the note associated with the MDF claim. This is the primary key of the notes table.
• NoteNumber: string
  Maximum Length: 30

  The alternate unique identifier of the note. A user key that's system generated or from an external system.
• NoteTitle: string
  Title: Title

  Maximum Length: 500

  The title of the note entered by the user.
• NoteTxt: string (byte)
  Title: Note

  The actual note text.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  This is the note type code for categorization of note. A list of valid values is defined in the lookup NoteSourceTypeVA.
• ParentNoteId: integer (int64)
  Title: Parent Note ID

  The unique identifier of the parent note.
• PartyId: integer (int64)
  Title: Party ID

  Read Only: true

  The unique identifier of the party associated with the note.
• PartyName: string
  Title: Author

  Read Only: true

  Maximum Length: 360

  The name of an MDF claim party.
• SourceObjectCode: string
  Title: Related Object Type

  Maximum Length: 30

  The code indicating the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, Sales Business Plan, and so on.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  The primary key identifier of the source object as defined in OBJECTS Metadata.
• UpdateFlag: boolean
  Title: Update Indicator

  Read Only: true

  Indicates whether the note can be updated. If the value is Y, then the note can be updated. The default value is N.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

  The code indicating the visibility level of the note, such as internal or external.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the note was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":"360",
            "type":"string",
            "description":"The name of an MDF claim party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the visibility level of the note, such as internal or external.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the contact relationship. This attribute is populated when the note is associated with an MDF claim user.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"15",
            "type":"string",
            "description":"The currency code associated with the note. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the value for this attribute using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the note can be updated. If the value is Y, then the note can be updated. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"The alternate unique identifier of the note. A user key that's system generated or from an external system.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the source object as defined in OBJECTS Metadata, such as Activities, Opportunities, Sales Business Plan, and so on.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Primary Phone",
            "type":"string",
            "description":"The phone number of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":"15",
            "type":"string",
            "description":"The corporate currency code of the note associated with the MDF claim. A list of accepted values is defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY. Review and update the profile option using the Setup and Maintenance work area, Manage Trading Community Common Lookups task.",
            "nullable":true,
            "x-queryable":false
        },
        "NoteTxt":{
            "title":"Note",
            "type":"string",
            "description":"The actual note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            },
            "x-queryable":true
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":"500",
            "type":"string",
            "description":"The title of the note entered by the user.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the note.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"The unique identifier of the note associated with the MDF claim. This is the primary key of the notes table.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the note.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique identifier of the party that the note creator belongs to.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FormattedAddress":{
            "title":"Primary Address",
            "type":"string",
            "description":"The address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"This is the note type code for categorization of note. A list of valid values is defined in the lookup NoteSourceTypeVA.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":"320",
            "type":"string",
            "description":"The email address of the user who created the note.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the note is to be deleted. If the value is Y, then the note has to be deleted. The default value is N.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":"64",
            "type":"string",
            "description":"The primary key identifier of the source object as defined in OBJECTS Metadata.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party associated with the note.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"The unique identifier of the parent note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the note data was last updated.",
            "format":"date-time",
            "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 note.",
            "nullable":true,
            "readOnly":true,
            "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"
    }
}

Back to Top

Examples

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

Example of Response Body

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

{
    "items": [
        {
            "RecordSet": null,
            "ClaimId": 300100546858159,
            "FundRequestId": 300100546853936,
            "ClaimName": "ClaimNamecde88948189_06b88966262",
            "Description": null,
            "CurrencyCode": "USD",
            "Age": 70,
            "ClaimAmount": 100,
            "ApprovedAmount": 0,
            "ClaimCode": "CDRM_1013",
            "ClaimStatusCode": "DRAFT",
            "ApprovedBy": null,
            "ApprovedDate": null,
            "RejectedBy": null,
            "RejectedDate": null,
            "SubmittedDate": null,
            "CreatedBy": "CHANNEL_OPERATIONS_MANAGER",
            "CreationDate": "2021-08-09T06:02:45+00:00",
            "LastUpdatedBy": "Channel_OPS_Mgr_ENT1 COM",
            "LastUpdateLogin": "C9167DF80A0BBE79E0533AFDF40A9FF3",
            "LastUpdateDate": "2021-08-09T06:02:47.207+00:00",
            "FundRequestName": "RequestApp_f5388896644",
            "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": "[e-mail]",
            "ApprovedById": null,
            "CurrencyConversionDate": "2021-08-09",
            "RejectedById": null,
            "SubmittedById": null,
            "CanSubmit": "true",
            "CanTerminate": "false",
            "OwnerFormattedPhoneNumber": "[phone]",
            "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_f5388896644",
            "OwnerPartyNumber": "100010038017885",
            "SubmitClaimsBy": "2021-08-16",
            "BudgetName": "BudgetActive_e1688896615",
            "BudgetCurrency": "USD",
            "BudgetStartDate": "2021-08-09",
            "BudgetEndDate": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CDRM_1013",
                    "name": "mdfClaims",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CDRM_1013",
                    "name": "mdfClaims",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CDRM_1013/lov/ClaimStatusLOVVA",
                    "name": "ClaimStatusLOVVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CDRM_1013/lov/CurrencyLOVVA",
                    "name": "CurrencyLOVVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CDRM_1013/lov/ReturnReasonCodeVA",
                    "name": "ReturnReasonCodeVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CDRM_1013/lov/ResourceVOVA",
                    "name": "ResourceVOVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CDRM_1013/lov/FundRequestLOVVA_WithoutBudget",
                    "name": "FundRequestLOVVA_WithoutBudget",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CDRM_1013/lov/RejectReasonCodeVA",
                    "name": "RejectReasonCodeVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CDRM_1013/lov/BudgetLOVVA",
                    "name": "BudgetLOVVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CDRM_1013/lov/RecordSetVA",
                    "name": "RecordSetVA",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CDRM_1013/child/Attachments",
                    "name": "Attachments",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CDRM_1013/child/ClaimResource",
                    "name": "ClaimResource",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CDRM_1013/child/ClaimSettlements",
                    "name": "ClaimSettlements",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims/CDRM_1013/child/Note",
                    "name": "Note",
                    "kind": "collection"
                }
            ]
        },
        .....
    ],
    "count": 25,
    "hasMore": true,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfClaims",
            "name": "mdfClaims",
            "kind": "collection"
        }
    ]
}

Back to Top