Jump to

• Request
• Response
• Examples

Get all MDF budgets

get

/crmRestApi/resources/11.13.18.05/mdfBudgets

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:
  
  

  • BudgetVOAltKey: Finds a MDF budget with the specified alternate key.
    Finder Variables:
    • BudgetCode; string; The unique alternate identifier of the MDF budget.
  • MdfRestActiveBudgetFinder: Finds a MDF budget with the specified status code.
    Finder Variables:
    • bindStatus; string; The bind status of the MDF budget.
  • PrimaryKey: Finds a MDF budget with the specified primary key identifier.
    Finder Variables:
    • BudgetId; integer; The unique identifier of the MDF budget.
• 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:
  

  • ActivatedBy; string; The user who activated the MDF budget.
  • ActivatedById; integer; The user ID of the user who activated the MDF budget.
  • ActivationDate; string; The date on which the MDF budget was activated.
  • BudgetCode; string; The unique alternate identifier of the MDF budget.
  • BudgetId; integer; The unique identifier of the MDF budget.
  • BudgetName; string; The display name for the MDF budget.
  • BudgetType; string; The type of MDF budget.
  • CategoryCode; string; The category of the MDF budget.
  • ConvExchangeRate; number; The currency exchange rate for the MDF budget against the corporate currency.
  • ConversionCurrencyCode; string; The currency code used for conversion in the MDF budget.
  • ConversionRateType; string; The rate type applied against the MDF budget currency.
  • CreatedBy_FN; string; The name of the user who created the MDF budget.
  • CurrencyCode; string; The currency used of the MDF budgeted amount.
  • Description; string; The description of the MDF budget.
  • EndDate; string; The end date for the MDF budget.
  • InactivatedBy; string; The user who inactivated the MDF budget.
  • InactivatedById; integer; The user ID of the user who inactivated the MDF budget.
  • InactivationDate; string; The date on which the MDF budget was or will be inactivated.
  • InitialBudgetAmount; number; The original or initial MDF budget amount.
  • LastUpdateDate; string; The date when the MDF budget was last updated.
  • LastUpdatedBy_FN; string; The name of the user who last updated the MDF budget.
  • NumberClaimsPendingApproval; number; The number of claims pending approval.
  • NumberFundRequestPendingApproval; number; The number of fund requests pending approval.
  • OwnerId; integer; The resource who manages the MDF budget.
  • OwnerNameTrans; string; The owner name of the MDF budget.
  • OwnerPartyNumber; string; Public Unique Identifier for the Resource.
  • PartnerCompanyNumber; string; Public Unique Identifier for the Partner.
  • PartnerId; integer; The unique identifier of the partner company that the MDF budget is assigned to.
  • PartnerNameTrans; string; The partner name of the MDF budget.
  • RecordSet; string; The record set values for MDF budget.
  • StartDate; string; The start date of the MDF budget.
  • StatusCode; string; The activation status of the MDF budget.
  • SubmitClaimsBy; string; The last date on which a MDF budget claim will be accepted for reimbursement.
  • SubmitFundRequestBy; string; The last date on which a MDF budget fund request will be accepted.
  • TotalApprovedClaimAmount; number; The total amount of approved claims for expense reimbursements against the MDF budget.
  • TotalApprovedRequestAmount; number; The total approved fund requests for a MDF budget.
  • TotalAvailableBudgetAmount; number; The MDF budget amount available for fund requests and claims.
  • TotalClaimSettledAmount; number; The total amount of MDF budget claims for reimbursement that are financially settled.
  • TotalOutstandingClaimLiabilityAmount; number; The total amount of MDF budget claims for reimbursement that are approved but not settled.
  • TotalPendingClaimAmount; number; The total amount of claims that are submitted or pending approval.
  • TotalPendingFundRequestAmount; number; The total amount of fund requests that are submitted or pending approval.
  • TotalRejectedClaimAmount; number; The total amount of claims for reimbursement that are rejected.
  • TotalRejectedFundRequestAmount; number; The total amount of fund requests that are rejected.
  • TotalUnclaimedFundRequestAmount; number; The total approved fund requests less the total approved claims.
• 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 : mdfBudgets

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/mdfBudgets-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 mdfBudgets-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/mdfBudgets-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 : mdfBudgets-item-response

Type: object

Show Source

• ActivatedBy: string
  Title: Activated By

  Read Only: true

  Maximum Length: 64

  The user who activated the MDF budget.
• ActivatedBy_FN: string
  Title: Activated By

  Read Only: true

  The name of the user who activated the budget.
• ActivatedById: integer (int64)
  Title: Activated by ID

  The user ID of the user who activated the MDF budget.
• ActivationDate: string (date)
  Title: Activation Date

  Read Only: true

  The date on which the MDF budget was activated.
• Attachments: array Attachments
  Title: Attachments

  The attachments resource is used to view, create, and update attachments.
• BudgetCode: string
  Title: Code

  Maximum Length: 100

  The unique alternate identifier of the MDF budget.
• BudgetCountries: array Budget Countries
  Title: Budget Countries

  The budget countries resource is used to view, create, and update the list of partner countries to which budget can be allocated to.
• BudgetId: integer (int64)
  Title: Budget ID

  The unique identifier of the MDF budget.
• BudgetName: string
  Title: Name

  Maximum Length: 250

  The display name for the MDF budget.
• BudgetNote: array Notes
  Title: Notes

  The note resource is used to capture comments, information, or instructions for an MDF budget.
• BudgetTeam: array MDF Budget Teams
  Title: MDF Budget Teams

  The MDF budget team resource is used to view, create, and update MDF budget team members. A budget team member is a resource who is assigned to the MDF budget team and who has the appropriate visibility and access to the MDF budget record.
• BudgetType: string
  Title: Type

  Maximum Length: 30

  The type of MDF budget.
• BudgetTypeMeaning: string
  Title: Type

  Read Only: true

  The budget type of the MDF budget.
• CategoryCode: string
  Title: Category

  Maximum Length: 30

  The category of the MDF budget.
• CategoryCodeMeaning: string
  Title: Category

  Read Only: true

  The category of the MDF budget.
• Claim: array Claims
  Title: Claims

  The claim resource is used to view, create, and update a claim. A claim is a request for reimbursement of marketing expenses submitted by a partner.
• ConversionCurrencyCode: string
  Title: Conversion Currency Code

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 30

  The rate type applied against the MDF budget currency.
• ConvExchangeRate: number
  Title: Conversion Exchange Rate

  The currency exchange rate for the MDF budget against the corporate currency.
• Country: string
  Title: Country

  Maximum Length: 2

  The country value used to categorize MDF budgets by geographical countries.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the MDF budget.
• CreatedBy_FN: string
  Title: Created By

  Read Only: true

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

  Read Only: true

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

  Maximum Length: 30

  The currency used of the MDF budgeted amount.
• DeleteFlag: boolean
  Title: Delete Indicator

  Read Only: true

  Indicates whether the MDF budget record can be deleted.
• Description: string
  Title: Description

  Maximum Length: 4000

  The description of the MDF budget.
• EndDate: string (date)
  Title: End Date

  The end date for the MDF budget.
• FundRequest: array Fund Requests
  Title: Fund Requests

  The fund request resource is used view, create, and update fund requests. A fund request is a request for a portion of the budget to be allocated towards execution of certain marketing activities.
• InactivatedBy: string
  Title: Inactivated By

  Read Only: true

  Maximum Length: 64

  The user who inactivated the MDF budget.
• InactivatedById: integer (int64)
  Title: Inactivated by ID

  The user ID of the user who inactivated the MDF budget.
• InactivationDate: string (date)
  Title: Inactivation Date

  Read Only: true

  The date on which the MDF budget was or will be inactivated.
• InitialBudgetAmount: number
  Title: Initial Amount

  The original or initial MDF budget amount.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the MDF budget.
• LastUpdatedBy_FN: string
  Title: Last Updated By

  Read Only: true

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

  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• NumberClaimsPendingApproval: number
  Title: Pending MDF Claim Count

  Read Only: true

  Default Value: 0

  The number of claims pending approval.
• NumberFundRequestPendingApproval: number
  Title: Pending MDF Request Count

  Read Only: true

  Default Value: 0

  The number of fund requests pending approval.
• OwnerId: integer (int64)
  Title: Owner ID

  The resource who manages the MDF budget.
• OwnerNameTrans: string
  Title: Owner

  Maximum Length: 360

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

  Read Only: true

  Maximum Length: 30

  Public Unique Identifier for the Resource.
• PartnerCompanyNumber: string
  Title: Partner Company Number

  Maximum Length: 30

  Public Unique Identifier for the Partner.
• PartnerId: integer (int64)
  Title: Partner ID

  The unique identifier of the partner company that the MDF budget is assigned to.
• PartnerNameTrans: string
  Title: Partner

  Maximum Length: 360

  The partner name of the MDF budget.
• RecordSet: string
  Title: Record Set

  Read Only: true

  The record set values for MDF budget.
• StartDate: string (date)
  Title: Start Date

  The start date of the MDF budget.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: DRAFT

  The activation status of the MDF budget.
• StatusMeaning: string
  Title: Status

  Read Only: true

  The status value of the MDF budget.
• SubmitClaimsBy: string (date)
  Title: Claim Deadline

  The last date on which a MDF budget claim will be accepted for reimbursement.
• SubmitFundRequestBy: string (date)
  Title: Request Deadline

  The last date on which a MDF budget fund request will be accepted.
• TotalApprovedClaimAmount: number
  Title: Approved MDF Claims

  Read Only: true

  Default Value: 0

  The total amount of approved claims for expense reimbursements against the MDF budget.
• TotalApprovedRequestAmount: number
  Title: Approved MDF Requests

  Read Only: true

  Default Value: 0

  The total approved fund requests for a MDF budget.
• TotalAvailableBudgetAmount: number
  Title: Available Budget

  Read Only: true

  The MDF budget amount available for fund requests and claims.
• TotalBudgetAmount: number
  Title: Total Budget

  Default Value: 0

  The total MDF budget amount based on the initial MDF budget along with adjustments.
• TotalClaimAmount: number
  Title: Submitted Claims

  Read Only: true

  Default Value: 0

  The total amount of MDF budget claims for reimbursement that are submitted, pending approval, approved, or rejected.
• TotalClaimSettledAmount: number
  Title: Total Settled Claims

  Read Only: true

  Default Value: 0

  The total amount of MDF budget claims for reimbursement that are financially settled.
• TotalOutstandingClaimLiabilityAmount: number
  Title: Total Outstanding Claims

  Read Only: true

  Default Value: 0

  The total amount of MDF budget claims for reimbursement that are approved but not settled.
• TotalPendingClaimAmount: number
  Title: Pending MDF Claim Amount

  Read Only: true

  Default Value: 0

  The total amount of claims that are submitted or pending approval.
• TotalPendingFundRequestAmount: number
  Title: Pending MDF Request Amount

  Read Only: true

  Default Value: 0

  The total amount of fund requests that are submitted or pending approval.
• TotalRejectedClaimAmount: number
  Title: Rejected MDF Claims

  Read Only: true

  Default Value: 0

  The total amount of claims for reimbursement that are rejected.
• TotalRejectedFundRequestAmount: number
  Title: Rejected Fund Requests

  Read Only: true

  Default Value: 0

  The total amount of fund requests that are rejected.
• TotalRequestedAmount: number
  Title: Total Requests

  Read Only: true

  Default Value: 0

  The total amount from all fund requests that are submitted, pending approval, approved, or rejected.
• TotalUnclaimedFundRequestAmount: number
  Title: Total Unclaimed Requests

  Read Only: true

  Default Value: 0

  The total approved fund requests less the total approved claims.
• UpdateFlag: boolean
  Title: Update Indicator

  Read Only: true

  Indicates whether the budget can be updated.

{
    "type":"object",
    "properties":{
        "TotalRejectedClaimAmount":{
            "title":"Rejected MDF Claims",
            "type":"number",
            "description":"The total amount of claims for reimbursement that are rejected.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">="
                ]
            },
            "x-queryable":true
        },
        "CategoryCode":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The category of the MDF budget.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the MDF budget was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The unique identifier of the partner company that the MDF budget is assigned to.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "dependencies":[
                    "PartnerNameTrans",
                    "PartyName"
                ]
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The activation status of the MDF budget.",
            "nullable":false,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>"
                ]
            },
            "x-queryable":true
        },
        "BudgetType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of MDF budget.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"30",
            "type":"string",
            "description":"The currency used of the MDF budgeted amount.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the MDF budget.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ActivatedBy_FN":{
            "title":"Activated By",
            "type":"string",
            "description":"The name of the user who activated the budget.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ConvExchangeRate":{
            "title":"Conversion Exchange Rate",
            "type":"number",
            "description":"The currency exchange rate for the MDF budget against the corporate currency.",
            "nullable":true,
            "x-queryable":true
        },
        "FundRequest":{
            "title":"Fund Requests",
            "type":"array",
            "description":"The fund request resource is used view, create, and update fund requests. A fund request is a request for a portion of the budget to be allocated towards execution of certain marketing activities.",
            "items":{
                "$ref":"#/components/schemas/mdfBudgets-FundRequest-item-response"
            }
        },
        "TotalClaimSettledAmount":{
            "title":"Total Settled Claims",
            "type":"number",
            "description":"The total amount of MDF budget claims for reimbursement that are financially settled.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "PartnerNameTrans":{
            "title":"Partner",
            "maxLength":"360",
            "type":"string",
            "description":"The partner name of the MDF budget.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "SubmitClaimsBy":{
            "title":"Claim Deadline",
            "type":"string",
            "description":"The last date on which a MDF budget claim will be accepted for reimbursement.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "=",
                    "<>",
                    "BEFORE",
                    "AFTER",
                    "ONORBEFORE",
                    "ONORAFTER",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "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 MDF budget.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "ActivationDate":{
            "title":"Activation Date",
            "type":"string",
            "description":"The date on which the MDF budget was activated.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalApprovedRequestAmount":{
            "title":"Approved MDF Requests",
            "type":"number",
            "description":"The total approved fund requests for a MDF budget.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">="
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last  updated the MDF budget.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TotalAvailableBudgetAmount":{
            "title":"Available Budget",
            "type":"number",
            "description":"The MDF budget amount available for fund requests and claims.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN"
                ],
                "dependencies":[
                    "InitialBudgetAmount",
                    "TotalApprovedRequestAmount",
                    "TotalBudgetAmount"
                ]
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the  MDF budget.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TotalPendingClaimAmount":{
            "title":"Pending MDF Claim Amount",
            "type":"number",
            "description":"The total amount of claims that are submitted or pending approval.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "BudgetId":{
            "title":"Budget ID",
            "type":"integer",
            "description":"The unique identifier of the MDF budget.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TotalClaimAmount":{
            "title":"Submitted Claims",
            "type":"number",
            "description":"The total amount of MDF budget claims for reimbursement that are submitted, pending approval, approved, or rejected.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":false
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the MDF budget record can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberFundRequestPendingApproval":{
            "title":"Pending MDF Request Count",
            "type":"number",
            "description":"The number of fund requests pending approval.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "ConversionCurrencyCode":{
            "title":"Conversion Currency Code",
            "maxLength":"30",
            "type":"string",
            "description":"The currency code used for conversion in the MDF budget.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "Country":{
            "title":"Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country value used to categorize MDF budgets by geographical countries.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "BudgetName":{
            "title":"Name",
            "maxLength":"250",
            "type":"string",
            "description":"The display name for the MDF budget.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the MDF budget.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InactivatedById":{
            "title":"Inactivated by ID",
            "type":"integer",
            "description":"The user ID of the user who inactivated the MDF budget.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActivatedById":{
            "title":"Activated by ID",
            "type":"integer",
            "description":"The user ID of the user who activated the MDF budget.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"The description of the MDF budget.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "OwnerPartyNumber":{
            "title":"Owner Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"Public Unique Identifier for the Resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalUnclaimedFundRequestAmount":{
            "title":"Total Unclaimed Requests",
            "type":"number",
            "description":"The total approved fund requests less the total approved claims.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "TotalRequestedAmount":{
            "title":"Total Requests",
            "type":"number",
            "description":"The total amount from all fund requests that are submitted, pending approval, approved, or rejected.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":false
        },
        "TotalBudgetAmount":{
            "title":"Total Budget",
            "type":"number",
            "description":"The total MDF budget amount based on the initial MDF budget along with adjustments.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "Attachments":{
            "title":"Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, and update attachments.",
            "items":{
                "$ref":"#/components/schemas/mdfBudgets-Attachments-item-response"
            }
        },
        "TotalRejectedFundRequestAmount":{
            "title":"Rejected Fund Requests",
            "type":"number",
            "description":"The total amount of fund requests that are rejected.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">="
                ]
            },
            "x-queryable":true
        },
        "ConversionRateType":{
            "title":"Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The rate type applied against the MDF budget currency.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "InactivationDate":{
            "title":"Inactivation Date",
            "type":"string",
            "description":"The date on which the MDF budget was or will be inactivated.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy_FN":{
            "title":"Created By",
            "type":"string",
            "description":"The name of the user who created the MDF budget.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the budget can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BudgetTeam":{
            "title":"MDF Budget Teams",
            "type":"array",
            "description":"The MDF budget team resource is used to view, create, and update MDF budget team members. A budget team member is a resource who is assigned to the MDF budget team and who has the appropriate visibility and access to the MDF budget record.",
            "items":{
                "$ref":"#/components/schemas/mdfBudgets-BudgetTeam-item-response"
            }
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The resource who manages the MDF budget.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18"
            },
            "x-queryable":true
        },
        "TotalApprovedClaimAmount":{
            "title":"Approved MDF Claims",
            "type":"number",
            "description":"The total amount of approved claims for expense reimbursements against the MDF budget.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">="
                ]
            },
            "x-queryable":true
        },
        "NumberClaimsPendingApproval":{
            "title":"Pending MDF Claim Count",
            "type":"number",
            "description":"The number of claims pending approval.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "BudgetNote":{
            "title":"Notes",
            "type":"array",
            "description":"The note resource is used to capture comments, information, or instructions for an MDF budget.",
            "items":{
                "$ref":"#/components/schemas/mdfBudgets-BudgetNote-item-response"
            }
        },
        "BudgetCode":{
            "title":"Code",
            "maxLength":"100",
            "type":"string",
            "description":"The unique alternate identifier of the MDF budget.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "CategoryCodeMeaning":{
            "title":"Category",
            "type":"string",
            "description":"The category of the MDF budget.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "TotalPendingFundRequestAmount":{
            "title":"Pending MDF Request Amount",
            "type":"number",
            "description":"The total amount of fund requests that are submitted or pending approval.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "TotalOutstandingClaimLiabilityAmount":{
            "title":"Total Outstanding Claims",
            "type":"number",
            "description":"The total amount of MDF budget claims for reimbursement that are approved but not settled.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "ActivatedBy":{
            "title":"Activated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who activated the MDF budget.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "BudgetCountries":{
            "title":"Budget Countries",
            "type":"array",
            "description":"The budget countries resource is used to view, create, and update the list of partner countries to which budget can be allocated to.",
            "items":{
                "$ref":"#/components/schemas/mdfBudgets-BudgetCountries-item-response"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date for the MDF budget.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "InitialBudgetAmount":{
            "title":"Initial Amount",
            "type":"number",
            "description":"The original or initial MDF budget amount.",
            "nullable":false,
            "x-queryable":true
        },
        "StatusMeaning":{
            "title":"Status",
            "type":"string",
            "description":"The status value of the MDF budget.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerNameTrans":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The owner name of the MDF budget.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "InactivatedBy":{
            "title":"Inactivated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who inactivated the MDF budget.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "PartnerCompanyNumber":{
            "title":"Partner Company Number",
            "maxLength":"30",
            "type":"string",
            "description":"Public Unique Identifier for the Partner.",
            "nullable":false,
            "x-queryable":true
        },
        "SubmitFundRequestBy":{
            "title":"Request Deadline",
            "type":"string",
            "description":"The last date on which a MDF budget fund request will be accepted.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "BudgetTypeMeaning":{
            "title":"Type",
            "type":"string",
            "description":"The budget type of the MDF budget.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy_FN":{
            "title":"Last Updated By",
            "type":"string",
            "description":"The name of the user who last updated the MDF budget.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "Claim":{
            "title":"Claims",
            "type":"array",
            "description":"The claim resource is used to view, create, and update a claim. A claim is a request for reimbursement of marketing expenses submitted by a partner.",
            "items":{
                "$ref":"#/components/schemas/mdfBudgets-Claim-item-response"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the MDF budget was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Attachments

Type: array

Title: Attachments

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

Show Source

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

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

Nested Schema : Budget Countries

Type: array

Title: Budget Countries

The budget countries resource is used to view, create, and update the list of partner countries to which budget can be allocated to.

Show Source

• Array of: object mdfBudgets-BudgetCountries-item-response

{
    "title":"Budget Countries",
    "type":"array",
    "description":"The budget countries resource is used to view, create, and update the list of partner countries to which budget can be allocated to.",
    "items":{
        "$ref":"#/components/schemas/mdfBudgets-BudgetCountries-item-response"
    }
}

Nested Schema : Notes

Type: array

Title: Notes

The note resource is used to capture comments, information, or instructions for an MDF budget.

Show Source

• Array of: object mdfBudgets-BudgetNote-item-response

{
    "title":"Notes",
    "type":"array",
    "description":"The note resource is used to capture comments, information, or instructions for an MDF budget.",
    "items":{
        "$ref":"#/components/schemas/mdfBudgets-BudgetNote-item-response"
    }
}

Nested Schema : MDF Budget Teams

Type: array

Title: MDF Budget Teams

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

Show Source

• Array of: object mdfBudgets-BudgetTeam-item-response

{
    "title":"MDF Budget Teams",
    "type":"array",
    "description":"The MDF budget team resource is used to view, create, and update MDF budget team members. A budget team member is a resource who is assigned to the MDF budget team and who has the appropriate visibility and access to the MDF budget record.",
    "items":{
        "$ref":"#/components/schemas/mdfBudgets-BudgetTeam-item-response"
    }
}

Nested Schema : Claims

Type: array

Title: Claims

The claim resource is used to view, create, and update a claim. A claim is a request for reimbursement of marketing expenses submitted by a partner.

Show Source

• Array of: object mdfBudgets-Claim-item-response

{
    "title":"Claims",
    "type":"array",
    "description":"The claim resource is used to view, create, and update a claim. A claim is a request for reimbursement of marketing expenses submitted by a partner.",
    "items":{
        "$ref":"#/components/schemas/mdfBudgets-Claim-item-response"
    }
}

Nested Schema : Fund Requests

Type: array

Title: Fund Requests

The fund request resource is used view, create, and update fund requests. A fund request is a request for a portion of the budget to be allocated towards execution of certain marketing activities.

Show Source

• Array of: object mdfBudgets-FundRequest-item-response

{
    "title":"Fund Requests",
    "type":"array",
    "description":"The fund request resource is used view, create, and update fund requests. A fund request is a request for a portion of the budget to be allocated towards execution of certain marketing activities.",
    "items":{
        "$ref":"#/components/schemas/mdfBudgets-FundRequest-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 : mdfBudgets-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 : mdfBudgets-BudgetCountries-item-response

Type: object

Show Source

• BudgetCountryId: integer (int64)
  Read Only: true

  The unique identifier of the MDF budget country.
• BudgetId: integer (int64)
  Title: Budget ID

  Read Only: true

  The unique identifier of the budget.
• CountryCode: string
  Maximum Length: 2

  The country code associated to of MDF budget.
• CountryName: string
  Title: Territory Name

  Read Only: true

  Maximum Length: 80

  The country associated to of MDF budget.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date when the MDF budget country was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• TerritoryCode: string
  Title: Territory Code

  Read Only: true

  Maximum Length: 2

  The unique territory code of the country associated to MDF budget.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the MDF budget country.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the MDF budget country was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the MDF budget country.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CountryName":{
            "title":"Territory Name",
            "maxLength":"80",
            "type":"string",
            "description":"The country associated to of MDF budget.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BudgetCountryId":{
            "type":"integer",
            "description":"The unique identifier of the MDF budget country.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BudgetId":{
            "title":"Budget ID",
            "type":"integer",
            "description":"The unique identifier of the budget.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TerritoryCode":{
            "title":"Territory Code",
            "maxLength":"2",
            "type":"string",
            "description":"The unique territory code of the country associated to MDF budget.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CountryCode":{
            "maxLength":"2",
            "type":"string",
            "description":"The country code associated to of MDF budget.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the note 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 record.",
            "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 : mdfBudgets-BudgetNote-item-response

Type: object

Show Source

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

  The unique identifier of the relationship when the note is associated with a MDF budget user.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the note associated with the MDF budget 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 record.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  The unique identifier of the party who created the note.
• 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 record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• 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 budget.
• 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

  The code to categorize notes.
• 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 MDF budget to which the note is associated.
• PartyName: string
  Title: Author

  Read Only: true

  Maximum Length: 360

  The name of the party associated with the MDF budget.
• SourceObjectCode: string
  Title: Related Object Type

  Maximum Length: 30

  The code of the source object as defined in OBJECTS metadata.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  The unique 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 visibility level of the note.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the note record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the party associated with the MDF budget.",
            "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 visibility level of the note.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the relationship when the note is associated with a MDF budget 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 of the source object  as defined in OBJECTS metadata.",
            "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 budget 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 record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "NoteId":{
            "title":"Note ID",
            "type":"integer",
            "description":"The unique identifier of the note associated with the MDF budget.",
            "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 record.",
            "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 who created the note.",
            "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":"The code to categorize notes.",
            "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 unique 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 MDF budget to which the note is associated.",
            "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 record.",
            "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 : mdfBudgets-BudgetTeam-item-response

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Maximum Length: 30

  The access level code of the resource on the MDF budget team.
• BudgetCode: string
  Title: Code

  Maximum Length: 100

  Public Unique Identifier for the marketing Budget.
• BudgetId: integer (int64)
  Title: Budget ID

  The unique alternate identifier of the MDF budget.
• BudgetTeamId: integer (int64)
  Title: Budget Team ID

  The unique identifier of the resource on the MDF budget team.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 320

  The e-mail address of the MDF budget team member associated with the MDF budget.
• FormattedPhoneNumber: string
  Title: Phone

  Read Only: true

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

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

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

  The link relations associated with the resource instance.
• OwnerFlag: boolean
  Title: Owner

  Read Only: true

  Indicates if the MDF budget team member is the owner of the MDF budget.
• PartyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The party name of the MDF budget team member associated with the MDF budget.
• PhoneNumber: string
  Title: Phone

  The phone number of the team member associated with the MDF budget.
• ResourceId: integer (int64)
  Title: Resource ID

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

  Read Only: true

  Maximum Length: 30

  Public Unique Identifier for the Resource.
• UserFunction: string
  Title: Function

  Read Only: true

  The function display name of the team member associated with the MDF budget.
• UserFunctionCode: string
  Title: Function

  Maximum Length: 30

  The function code of the MDF budget team member.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The name of the user who last updated the MDF budget.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Membership Date",
            "type":"string",
            "description":"The date when the resource on the MDF budget team was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the resource on the MDF budget team.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The access level code of the resource on the MDF budget team.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BudgetId":{
            "title":"Budget ID",
            "type":"integer",
            "description":"The unique alternate identifier of the MDF budget.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates if the MDF budget team member is the owner of the MDF budget.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "EmailAddress1":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the MDF budget team member associated with the MDF budget.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The party name of the MDF budget  team member associated with the MDF budget.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BudgetTeamId":{
            "title":"Budget Team ID",
            "type":"integer",
            "description":"The unique identifier of the resource on the MDF budget team.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the team member associated with the MDF budget.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "UserFunction":{
            "title":"Function",
            "type":"string",
            "description":"The function display name of the team member associated with the MDF budget.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UserFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The function code of the MDF budget team member.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Resource Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"Public Unique Identifier for the Resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the team member associated with the MDF budget.",
            "nullable":true,
            "x-queryable":false
        },
        "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 budget team member associated with the MDF budget.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BudgetCode":{
            "title":"Code",
            "maxLength":"100",
            "type":"string",
            "description":"Public Unique Identifier for the marketing Budget.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the MDF budget 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 MDF budget.",
            "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 : mdfBudgets-Claim-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 creation of the MDF claim.
• 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 on which the MDF claim was approved.
• 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 start 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 end 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 partner owner associated to the claim.
• ChannelMgrName: string
  Title: Channel Manager

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

  The amount submitted for the MDF claim.
• ClaimCode: string
  Title: Code

  Maximum Length: 100

  The unique alternate identifier of 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.
• ClaimStatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: DRAFT

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

  Maximum Length: 1000

  The 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 conversion rate type used for 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 on which the MDF claim was created.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 30

  The ISO currency code entered for the MDF claim amount.
• 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

  The description for the MDF claim.
• FrExchangeRate: number
  Title: Fund Request Exchange Rate

  Default Value: 0

  The currency exchange rate for the claim against the fund request currency.
• FundRequestApprovedAmount: number
  Title: MDF Request Approved Amount

  Read Only: true

  The approved amount of the fund request associated with the claim.
• 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 used for the fund request associated with the claim.
• FundRequestId: integer (int64)
  Title: Fund Request ID

  The MDF fund request associated to 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 the 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 marketing budget.
• 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.
• OutstngClaimLiabilityAmount: number
  Title: Liability Amount

  Default Value: 0

  The outstanding claim liability amount that is pending for the budget claim.
• OwnerEmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The e-mail address of the owner of the claim.
• OwnerFormattedPhoneNumber: string
  Title: Phone

  Read Only: true

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

  The unique identifier of the user who owns the MDF claim.
• OwnerName: string
  Title: Owner

  Maximum Length: 360

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

  Read Only: true

  Maximum Length: 30

  Public Unique Identifier for the Resource.
• OwnerPrimaryPhoneNumber: string
  Title: Phone

  Read Only: true

  Maximum Length: 40

  The primary phone number of the owner of the claim.
• 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 of the 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 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 on which 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 on which 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 ISO currency code entered for the MDF claim amount.",
            "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 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 of the 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 marketing budget.",
            "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 on which 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 of 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
        },
        "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 e-mail address of the owner of the claim.",
            "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 the 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 the MDF claim owner.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "BudgetEndDate":{
            "title":"Budget End 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":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"The description for the MDF claim.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerPartyNumber":{
            "title":"Owner Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"Public Unique Identifier for the Resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimStatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status code 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 on which the MDF claim was submitted.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ConversionRateType":{
            "title":"Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The conversion rate type used for the MDF claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FrExchangeRate":{
            "title":"Fund Request Exchange Rate",
            "type":"number",
            "description":"The currency exchange rate for the claim against the fund request currency.",
            "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 submitted for the MDF claim.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "=",
                    "<",
                    "<=",
                    ">",
                    ">="
                ]
            },
            "x-queryable":true
        },
        "BudgetStartDate":{
            "title":"Start 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":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "BudgetId"
                ]
            },
            "x-queryable":true
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of the user who owns 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 unique alternate identifier of the MDF claim.",
            "nullable":false,
            "x-queryable":true
        },
        "OutstngClaimLiabilityAmount":{
            "title":"Liability Amount",
            "type":"number",
            "description":"The outstanding claim liability amount that is pending for the budget claim.",
            "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 of the fund request associated with the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Age":{
            "title":"Claim Age",
            "type":"number",
            "description":"The number of days since the creation of the MDF claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ChannelManagerId":{
            "title":"Account Director ID",
            "type":"integer",
            "description":"The unique identifier of the partner owner associated to 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 primary phone number of the owner of the claim.",
            "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":"The 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
        },
        "FundRequestId":{
            "title":"Fund Request ID",
            "type":"integer",
            "description":"The MDF fund request associated to 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 used for the fund request associated with the claim.",
            "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 number of the owner of the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 : mdfBudgets-FundRequest-item-response

Type: object

Show Source

• ActivityEndDate: string (date)
  Title: End Date

  The date when the fund request activity was completed.
• ActivityStartDate: string (date)
  Title: Start Date

  The date when the fund request activity was started.
• Age: number
  Title: Request Age

  Read Only: true

  The number of days since the creation of the MDF request.
• ApprovalActionComments: string
  Title: Approver Comments

  The comments entered during approval action on the fund request.
• 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 request.
• ApprovedAmountPercent: number
  Title: Approved Percent

  Default Value: 100

  The percentage of amount approved of the total fund request.
• ApprovedBy: string
  Title: Approved By

  Maximum Length: 64

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

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

  The date on which the MDF request was approved.
• AvailableFundRequestAmount: number
  Title: Available Amount

  Read Only: true

  Default Value: 0

  The difference between total approved marketing MDF request and total approved claim amounts, which is available to new claims.
• BgtExchangeRate: number
  Title: Budget Exchange Rate

  Default Value: 0

  The exchange rate of the MDF budget which is associated with the fund request.
• BudgetCode: string
  Title: Budget Code

  Read Only: true

  Maximum Length: 100

  Public Unique Identifier for the marketing Budget.
• BudgetCurrency: string
  Title: Budget Currency

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  The end date for the MDF budget associated with the fund request.
• BudgetId: integer (int64)
  Title: Budget ID

  The parent budget associated with the marketing MDF request.
• BudgetName: string
  Title: Budget

  The name of the MDF budget associated with the fund request.
• BudgetStartDate: string (date)
  Title: Budget Start Date

  Read Only: true

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

  Read Only: true

  Indicates whether a request can be approved by the user.
• CanReject: boolean
  Title: Can Reject

  Read Only: true

  Indicates whether a request can be rejected by the user.
• CanReturn: boolean
  Title: Can Return

  Read Only: true

  Indicates whether a request can be returned by the user.
• CanSubmit: boolean
  Title: Can Submit

  Read Only: true

  Indicates whether a request can be submitted by the user.
• CanTerminate: boolean
  Title: Can Terminate

  Read Only: true

  Indicates whether a request can be terminated by the user.
• CanWithdraw: boolean
  Title: Can Withdraw

  Read Only: true

  Indicates whether a request can be withdrawn by the user.
• ChannelManager: string
  Title: Channel Manager

  Read Only: true

  Maximum Length: 450

  The user who is the channel manager for the fund request.
• ChannelManagerId: integer (int64)
  Title: Channel Manager ID

  Read Only: true

  The unique identifier of the resource who is the channel manager for the fund request.
• Comments: string
  Title: Comments

  Maximum Length: 1000

  The additional comments for the marketing MDF request.
• ConversionCurrencyCode: string
  Title: Conversion Currency Code

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 30

  The currency conversion rate type for the MDF fund request. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.
• ConvExchangeRate: number
  Title: Conversion Exchange Rate

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who created the marketing MDF request.
• CreatedBy_FN: string
  Title: Created By

  Read Only: true

  The name of the creator of the fund request.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  Maximum Length: 30

  The currency code for the MDF request. 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 request against the corporate currency.
• DeleteFlag: boolean
  Title: Delete Indicator

  Read Only: true

  Indicates whether the request can be deleted. If the user has access to delete the request then the default value is true, else false.
• Description: string
  Title: Description

  Maximum Length: 4000

  The description for the marketing MDF request.
• FundRequestCode: string
  Title: Code

  Maximum Length: 100

  The unique alternate identifier of the marketing MDF request.
• FundRequestId: integer (int64)
  Title: Fund Request ID

  The unique identifier of the MDF request.
• FundRequestName: string
  Title: Name

  Maximum Length: 250

  The display name for the MDF request.
• FundRequestStatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: DRAFT

  The status code of the marketing MDF request.
• FundRequestType: string
  Title: Type

  Maximum Length: 30

  The type of the fund request.
• Justification: string
  Title: Justification

  Maximum Length: 1000

  The justification for the fund request.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  Maximum Length: 32

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

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

  Read Only: true

  Maximum Length: 320

  The e-mail address of the owner of the fund request.
• OwnerFormattedPhoneNumber: string
  Title: Phone

  Read Only: true

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

  The internal resource who manages the marketing budget.
• OwnerName: string
  Title: Owner

  Maximum Length: 360

  The owner of the fund request.
• OwnerPartyNumber: string
  Title: Owner Party Number

  Read Only: true

  Maximum Length: 30

  Public Unique Identifier for the Resource.
• PartnerCompanyNumber: string
  Title: Partner Company Number

  Maximum Length: 30

  Public Unique Identifier for the Partner.
• PartnerCountry: string
  Title: Partner Country

  Read Only: true

  Maximum Length: 2

  The country of the partner associated with the fund request.
• PartnerId: integer (int64)
  Title: Partner ID

  The unique identifier of the partner account associated to the marketing MDF request.
• PartnerName: string
  Title: Partner

  Maximum Length: 360

  The partner account identifier name associated to the marketing MDF request.
• PartnerPartyUniqueName: string
  Title: Partner

  Read Only: true

  Maximum Length: 360

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

  Read Only: true

  Finds MDF request based on the filter criteria.
• RejectedBy: string
  Title: Rejected By

  Maximum Length: 64

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

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

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

  The reason code for rejecting the fund request.
• RequestedAmount: number
  Title: Requested Amount

  The amount submitted for the MDF request. The amount is displayed in the currency code associated with the MDF claim.
• RequestStatusMeaning: string
  Title: Status

  The status of the MDF request.
• ReturnReasonCode: string
  Title: Return Reason

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

  Read Only: true

  The date by which associated claim needs to be submitted.
• SubmitFundReqBy: string (date)
  Title: Request Deadline

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

  Maximum Length: 64

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

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

  The date when the marketing MDF request was submitted.
• TotalApprovedClaimAmount: number
  Title: Approved Claim Amount

  Read Only: true

  Default Value: 0

  The total amount of all approved claims for the marketing MDF request.
• UpdateFlag: boolean
  Title: Update Indicator

  Read Only: true

  Indicates whether the request can be updated. If the user has access to update the request then the default value is true, else false.

{
    "type":"object",
    "properties":{
        "RejectedDate":{
            "title":"Rejected Date",
            "type":"string",
            "description":"The date when the marketing MDF request was rejected.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the MDF request was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CanSubmit":{
            "title":"Can Submit",
            "type":"boolean",
            "description":"Indicates whether a request can be submitted by the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The unique identifier of the partner account associated to the marketing MDF request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":"18",
                "dependencies":[
                    "PartnerPartyUniqueName",
                    "PartnerName"
                ]
            },
            "x-queryable":true
        },
        "FundRequestCode":{
            "title":"Code",
            "maxLength":"100",
            "type":"string",
            "description":"The unique alternate identifier of the marketing MDF 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 fund request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "RejectedBy":{
            "title":"Rejected By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who rejected the marketing MDF request.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "AvailableFundRequestAmount":{
            "title":"Available Amount",
            "type":"number",
            "description":"The difference between total approved marketing MDF request and total approved claim amounts, which is available to new claims.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "CanTerminate":{
            "title":"Can Terminate",
            "type":"boolean",
            "description":"Indicates whether a request can be terminated by the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"30",
            "type":"string",
            "description":"The currency code for the MDF request. 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
        },
        "ConvExchangeRate":{
            "title":"Conversion Exchange Rate",
            "type":"number",
            "description":"The currency exchange rate for the request against the corporate currency.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FundRequestName":{
            "title":"Name",
            "maxLength":"250",
            "type":"string",
            "description":"The display name for the MDF request.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "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-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Justification":{
            "title":"Justification",
            "maxLength":"1000",
            "type":"string",
            "description":"The justification for the fund request.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "RecordSet":{
            "title":"Record Set",
            "type":"string",
            "description":"Finds MDF request based on the filter criteria.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "PartnerCountry":{
            "title":"Partner Country",
            "maxLength":"2",
            "type":"string",
            "description":"The country of the partner associated with the fund request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the marketing MDF request.",
            "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 marketing MDF request.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "ChannelManager":{
            "title":"Channel Manager",
            "maxLength":"450",
            "type":"string",
            "description":"The user who is the channel manager for the fund request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ],
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            },
            "x-queryable":true
        },
        "ApprovedDate":{
            "title":"Approved Date",
            "type":"string",
            "description":"The date on which the  MDF request was approved.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CanApprove":{
            "title":"Can Approve",
            "type":"boolean",
            "description":"Indicates whether a request can be approved by the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BudgetId":{
            "title":"Budget ID",
            "type":"integer",
            "description":"The parent budget associated with the marketing MDF request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ApprovedAmountPercent":{
            "title":"Approved Percent",
            "type":"number",
            "description":"The percentage of amount approved of the total fund request.",
            "nullable":true,
            "default":"100",
            "x-queryable":true
        },
        "RequestedAmount":{
            "title":"Requested Amount",
            "type":"number",
            "description":"The amount submitted for the MDF request. The amount is displayed in the currency code associated with the MDF claim.",
            "nullable":false,
            "x-queryable":true
        },
        "SubmittedBy":{
            "title":"Submitted By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who submitted the marketing MDF request.",
            "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 request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReturnReasonCode":{
            "title":"Return Reason",
            "type":"string",
            "description":"The reason code for returning the fund request back to the submitter.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PartnerName":{
            "title":"Partner",
            "maxLength":"360",
            "type":"string",
            "description":"The partner account identifier name associated to the marketing MDF request.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "DeleteFlag":{
            "title":"Delete Indicator",
            "type":"boolean",
            "description":"Indicates whether the request can be deleted. If the user has access to delete the request then the default value is true, else false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ApprovedBy":{
            "title":"Approved By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who approved the MDF request.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "ConversionCurrencyCode":{
            "title":"Conversion Currency Code",
            "maxLength":"30",
            "type":"string",
            "description":"The currency code used for conversion in the request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CanReject":{
            "title":"Can Reject",
            "type":"boolean",
            "description":"Indicates whether a request can be rejected by the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerEmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the owner of the fund request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "BudgetName":{
            "title":"Budget",
            "type":"string",
            "description":"The name of the MDF budget associated with the fund request.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "SubmitFundReqBy":{
            "title":"Request Deadline",
            "type":"string",
            "description":"The date by which fund request needs to be submitted.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the fund request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CanWithdraw":{
            "title":"Can Withdraw",
            "type":"boolean",
            "description":"Indicates whether a request can be withdrawn by the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FundRequestType":{
            "title":"Type",
            "maxLength":"30",
            "type":"string",
            "description":"The type of the fund request.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "OwnerName":{
            "title":"Owner",
            "maxLength":"360",
            "type":"string",
            "description":"The owner of the fund request.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "BudgetEndDate":{
            "title":"Budget End Date",
            "type":"string",
            "description":"The end date for the MDF budget associated with the fund request.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"4000",
            "type":"string",
            "description":"The description for the marketing MDF request.",
            "nullable":true,
            "x-queryable":false
        },
        "OwnerPartyNumber":{
            "title":"Owner Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"Public Unique Identifier for the Resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActivityStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the fund request activity was started.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ApprovedById":{
            "title":"Approved by ID",
            "type":"integer",
            "description":"The unique identifier of the user who approved the marketing MDF request.",
            "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 request against the corporate currency.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SubmittedDate":{
            "title":"Submitted Date",
            "type":"string",
            "description":"The date when the marketing MDF request was submitted.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ConversionRateType":{
            "title":"Conversion Rate Type",
            "maxLength":"30",
            "type":"string",
            "description":"The currency conversion rate type for the MDF fund request. A list of valid values are defined in the lookup ZCA_COMMON_RATE_TYPE. Review and update the profile option using the Setup and Maintenance work area, Manage Currency Profile Options task.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RequestStatusMeaning":{
            "title":"Status",
            "type":"string",
            "description":"The status of the MDF request.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy_FN":{
            "title":"Created By",
            "type":"string",
            "description":"The name of the creator of the fund request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "title":"Update Indicator",
            "type":"boolean",
            "description":"Indicates whether the request can be updated. If the user has access to update the request then the default value is true, else false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FundRequestStatusCode":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"The status code of the marketing MDF request.",
            "nullable":true,
            "default":"DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "BudgetStartDate":{
            "title":"Budget Start Date",
            "type":"string",
            "description":"The start date for the MDF budget associated with the fund request.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The internal resource who manages the marketing budget.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TotalApprovedClaimAmount":{
            "title":"Approved Claim Amount",
            "type":"number",
            "description":"The total amount of all approved claims for the marketing MDF request.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "CanReturn":{
            "title":"Can Return",
            "type":"boolean",
            "description":"Indicates whether a request can be returned by the user.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "BudgetCode":{
            "title":"Budget Code",
            "maxLength":"100",
            "type":"string",
            "description":"Public Unique Identifier for the marketing Budget.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BgtExchangeRate":{
            "title":"Budget Exchange Rate",
            "type":"number",
            "description":"The exchange rate of the MDF budget which is associated with the fund request.",
            "nullable":true,
            "default":"0",
            "x-queryable":false
        },
        "Age":{
            "title":"Request Age",
            "type":"number",
            "description":"The number of days since the creation of the MDF request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ChannelManagerId":{
            "title":"Channel Manager ID",
            "type":"integer",
            "description":"The unique identifier of the resource who is the channel manager for the fund request.",
            "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 fund request.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":"1000",
            "type":"string",
            "description":"The additional comments for the marketing MDF request.",
            "nullable":true,
            "x-queryable":false
        },
        "ApprovalActionComments":{
            "title":"Approver Comments",
            "type":"string",
            "description":"The comments entered during approval action on the fund request.",
            "nullable":true,
            "x-queryable":false
        },
        "FundRequestId":{
            "title":"Fund Request ID",
            "type":"integer",
            "description":"The unique identifier of the MDF request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActivityEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the fund request activity was completed.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "RejectReasonCode":{
            "title":"Reject Reason",
            "type":"string",
            "description":"The reason code for rejecting the fund request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ApprovedAmount":{
            "title":"Approved Amount",
            "type":"number",
            "description":"The amount approved for the MDF request.",
            "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
        },
        "PartnerCompanyNumber":{
            "title":"Partner Company Number",
            "maxLength":"30",
            "type":"string",
            "description":"Public Unique Identifier for the Partner.",
            "nullable":false,
            "x-queryable":true
        },
        "RejectedById":{
            "title":"Rejected by ID",
            "type":"integer",
            "description":"The unique identifier of the user who rejected the MDF request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the fund request was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerFormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The formatted phone number of the owner of the fund request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

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 budgets by submitting a get request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/mdfBudgets

Example of Response Body

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

{
    "items": [
        {
            "RecordSet": null,
            "BudgetId": 300100543257793,
            "BudgetName": "BudgetActive_64d02762383",
            "BudgetCode": "BudgetActive_64d02762383",
            "BudgetType": null,
            "CategoryCode": null,
            "CreatedBy": "CHANNEL_OPERATIONS_MANAGER",
            "CreationDate": "2021-06-17T04:06:13+00:00",
            "StatusCode": "ACTIVE",
            "CurrencyCode": "USD",
            "TotalAvailableBudgetAmount": 900000,
            "Description": null,
            "EndDate": null,
            "InitialBudgetAmount": 1000000,
            "LastUpdateDate": "2021-06-17T04:06:27.616+00:00",
            "LastUpdateLogin": "C4D7BB6A111A0941E0533CFDF40A0E6A",
            "LastUpdatedBy": "CHANNEL_OPERATIONS_MANAGER",
            "StartDate": "2021-06-17",
            "SubmitClaimsBy": "2021-06-24",
            "SubmitFundRequestBy": "2021-06-24",
            "StatusMeaning": "Active",
            "OwnerId": 100010038017885,
            "OwnerNameTrans": "Channel_OPS_Mgr_ENT1 COM",
            "CategoryCodeMeaning": null,
            "BudgetTypeMeaning": null,
            "PartnerId": null,
            "InactivationDate": null,
            "InactivatedBy": null,
            "ActivatedBy": "CHANNEL_OPERATIONS_MANAGER",
            "ActivationDate": "2021-06-17",
            "PartnerNameTrans": null,
            "TotalApprovedClaimAmount": 0,
            "TotalApprovedRequestAmount": 100000,
            "TotalBudgetAmount": 1000000,
            "TotalClaimAmount": 0,
            "TotalClaimSettledAmount": 0,
            "TotalOutstandingClaimLiabilityAmount": 0,
            "TotalRequestedAmount": 100000,
            "TotalUnclaimedFundRequestAmount": 100000,
            "TotalPendingFundRequestAmount": 0,
            "TotalRejectedClaimAmount": 0,
            "TotalRejectedFundRequestAmount": 0,
            "TotalPendingClaimAmount": 0,
            "NumberFundRequestPendingApproval": 0,
            "NumberClaimsPendingApproval": 0,
            "Country": null,
            "CreatedBy_FN": "Channel_OPS_Mgr_ENT1 COM",
            "LastUpdatedBy_FN": "Channel_OPS_Mgr_ENT1 COM",
            "ActivatedBy_FN": "Channel_OPS_Mgr_ENT1 COM",
            "ConversionCurrencyCode": "USD",
            "ConversionRateType": "Corporate",
            "ActivatedById": 100010038017885,
            "InactivatedById": null,
            "ConvExchangeRate": 1,
            "UpdateFlag": true,
            "DeleteFlag": false,
            "OwnerPartyNumber": "100010038017885",
            "PartnerCompanyNumber": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383",
                    "name": "mdfBudgets",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383",
                    "name": "mdfBudgets",
                    "kind": "item"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/lov/FndTerritoriesPVO1",
                    "name": "FndTerritoriesPVO1",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/lov/BudgetCurrencyPVOVA",
                    "name": "BudgetCurrencyPVOVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/lov/BudgetStatusLOVVA",
                    "name": "BudgetStatusLOVVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/lov/ResourceVOVA",
                    "name": "ResourceVOVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/lov/CategoryLOVVA",
                    "name": "CategoryLOVVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/lov/PartnerPickerVA",
                    "name": "PartnerPickerVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/lov/BudgetTypeLOVVA",
                    "name": "BudgetTypeLOVVA",
                    "kind": "collection"
                },
                {
                    "rel": "lov",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/lov/RecordSetVA",
                    "name": "RecordSetVA",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/Attachments",
                    "name": "Attachments",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/BudgetCountries",
                    "name": "BudgetCountries",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/BudgetNote",
                    "name": "BudgetNote",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/BudgetTeam",
                    "name": "BudgetTeam",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/Claim",
                    "name": "Claim",
                    "kind": "collection"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/mdfBudgets/BudgetActive_64d02762383/child/FundRequest",
                    "name": "FundRequest",
                    "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/mdfBudgets",
            "name": "mdfBudgets",
            "kind": "collection"
        }
    ]
}

Back to Top