Jump to

• Request
• Response
• Examples

Create a deal registration

post

/crmRestApi/resources/11.13.18.05/deals

Request

Header Parameters

• Effective-Of:
  This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
• 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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ApprovalTaskStatusCode: string
  Title: Approval Task Status Code

  Indicates the approval status of the deal registration. The accepted values are: Approve, Reject, Return, and Withdraw.
• ApprovedDate: string (date)
  Title: Approved Date

  The date and time when the deal registration was approved.
• CloseDate: string (date)
  Title: Close Date

  The date and time when the deal registration is estimated to close.
• ConPrPhoneAreaCode: string
  Title: Contact Primary Phone Area Code

  Maximum Length: 10

  The contact primary phone area code associated with the deal registration.
• ConPrPhoneCountryCode: string
  Title: Contact Primary Phone Country Code

  Maximum Length: 10

  The contact primary phone country code associated with the deal registration.
• ConPrPhoneNumber: string
  Title: Phone

  Maximum Length: 40

  The contact primary phone number associated with the deal registration.
• ContactEmailAddress: string
  Title: Contact Email

  Maximum Length: 320

  The contact email address associated with the deal registration.
• ContactFirstName: string
  Title: Contact First Name

  Maximum Length: 150

  The first name of the contact.
• ContactId: integer (int64)
  Title: Contact ID

  The unique identifier of the contact associated with the deal registration.
• ContactJobTitle: string
  Title: Job Title

  Maximum Length: 100

  The contact job title associated with the deal registration.
• ContactLastName: string
  Title: Contact Last Name

  Maximum Length: 150

  The last name of the contact.
• ContactName: string
  Title: Existing Contact

  Maximum Length: 900

  The name of the contact associated with the deal registration.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 20

  The currency code. This attribute is used by CRM Extensibility framework. 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.
• CustomerFormattedAddress: string
  Title: Customer Address

  The formatted address of the customer.
• CustomerId: integer (int64)
  Title: Customer ID

  The unique identifier of the customer associated with the deal registration.
• CustomerLocationAddrElementAttribute1: string
  Title: Customer Location Address Element Attribute 1

  The account address element attribute 1 associated with the deal registration.
• CustomerLocationAddrElementAttribute2: string
  Title: Customer Location Address Element Attribute 2

  The account address element attribute 2 associated with the deal registration.
• CustomerLocationAddrElementAttribute3: string
  Title: Customer Location Address Element Attribute 3

  The account address element attribute 3 associated with the deal registration.
• CustomerLocationAddrElementAttribute4: string
  Title: Customer Location Address Element Attribute 4

  The account address element attribute 4 associated with the deal registration.
• CustomerLocationAddrElementAttribute5: string
  Title: Customer Location Address Element Attribute 5

  The account address element attribute 5 associated with the deal registration.
• CustomerLocationAddress1: string
  Title: Customer Location Address 1

  The account address line 1 associated with the deal registration.
• CustomerLocationAddress2: string
  Title: Customer Location Address 2

  The account address line 2 associated to the deal registration.
• CustomerLocationAddress3: string
  Title: Customer Location Address 3

  The account address line 3 associated with the deal registration.
• CustomerLocationAddress4: string
  Title: Customer Location Address 4

  The account address line 4 associated with the deal registration.
• CustomerLocationAddressLinesPhonetic: string
  Title: Customer Location Address Lines Phonetic

  The account address phonetic address line associated with the deal registration.
• CustomerLocationBuilding: string
  Title: Location Building

  The account address building associated with the deal registration.
• CustomerLocationCity: string
  Title: Account City

  The account address city associated with the deal registration.
• CustomerLocationCountry: string
  Title: Account Country

  The account address country associated with the deal registration.
• CustomerLocationCounty: string
  Title: Customer Location County

  The account address county associated with the deal registration.
• CustomerLocationFloorNumber: string
  Title: Customer Location Floor Number

  The account address floor number associated with the deal registration.
• CustomerLocationPostalCode: string
  Title: Account Postal Code

  The code indicating the account address postal associated with the deal registration. A list of valid values is defined in the lookup Z_PHONE_COUNTRY_CODES.
• CustomerLocationPostalPlus4Code: string
  Title: Customer Location Postal Plus 4 Code

  The account address postal code plus the four code associated to the deal registration.
• CustomerLocationProvince: string
  Title: Customer Location Province

  The account address province associated with the deal registration.
• CustomerLocationState: string
  Title: Account State

  The account address state associated with the deal registration.
• CustomerName: string
  Title: Existing Account

  Maximum Length: 900

  The name of the customer associated with the deal registration.
• DealApprovalHistory: array Deal Approval Histories
  Title: Deal Approval Histories

  The deal registration approval history lets you access a comprehensive record of approval-related information associated with the deal, encompassing the names of approvers, action dates, and the specific actions taken.
• DealApprovedBy: string
  Title: Approved By

  The unique identifier of the person who approved the deal registration.
• DealAttachments: array Deal Attachments
  Title: Deal Attachments

  The attachments resource is used to view, create, update, and delete attachments of a deal. An attachment includes additional information about a deal.
• DealContactName: string
  Title: New Contact

  Maximum Length: 360

  The name of the contact associated with the deal registration.
• DealCustomerName: string
  Title: New Account

  Maximum Length: 360

  The name of the customer associated with the deal registration.
• DealExpirationDate: string (date)
  Title: Expiration Date

  The date and time when the deal registration expires.
• DealId: integer (int64)
  Title: Deal ID

  The unique identifier of the deal registration.
• DealName: string
  Title: Name

  Maximum Length: 250

  The name of the deal registration.
• DealNumber: string
  Title: Registration Number

  Maximum Length: 30

  The alternate identifier of the deal registration.
• DealProduct: array Deal Products
  Title: Deal Products

  The deal products resource is used to view, create, update, and delete a deal product. The deal product is a product or product family associated with the deal registration that the customer is interested in.
• DealRejectedBy: string
  Title: Rejected By

  The unique identifier of the person who rejected the deal registration.
• DealRejectedComments: string
  Title: Rejected Comments

  Maximum Length: 250

  The comments added when rejecting a deal registration.
• DealRejectedReasonCode: string
  Title: Rejected Reason

  Maximum Length: 30

  The code indicating the reason for the rejection of a deal. For example, Duplicate, Ineligible Customer, or Ineligible Partner. A list of valid values is defined in the lookup ORA_MKL_DEAL_REJECT_REASON.
• DealResources: array Deal Team Members
  Title: Deal Team Members

  The deal team member resource is used to view, create, update, and delete a deal team member. A deal team member is a resource who is assigned to the deal registration team and who has the appropriate visibility and access to the deal registration record.
• DealReturnComments: string
  Title: Returned Comments

  Maximum Length: 250

  The comments added when returning a deal registration.
• DealReturnedBy: string
  Title: Returned By

  The unique identifier of the person who returned the deal registration.
• DealReturnReasonCode: string
  Title: Returned Reason

  Maximum Length: 30

  The code indicating the reason for the return of a deal registration. For example, Incomplete Customer Information, or Insufficient Quantity. A list of valid values is defined in the lookup ORA_MKL_DEAL_RETURN_REASON.
• DealSize: number
  Title: Deal Size

  The monetary amount that the customer is expected to spend.
• DealType: string
  Title: Deal Type

  Maximum Length: 30

  Default Value: ORA_NEW

  The type of deal registration that the partner submits for registration.
• DealWithdrawnBy: string
  Title: Withdrawn By

  The unique identifier of the person who withdrew the deal registration.
• LeadId: integer (int64)
  Title: Lead ID

  The unique identifier of the lead associated with the deal registration.
• LeadNumber: string
  Title: Lead Number

  Maximum Length: 30

  Public Unique Identifier of Lead associated to the Deal Registration
• MatchedAccountPartyId: integer (int64)
  Title: Matched Account Party ID

  The identifier of the customer account associated with the deal registration after the completion of the account duplicate check process.
• MatchedContactPartyId: integer (int64)
  Title: Matched Contact Party ID

  The identifier of the contact associated with the deal registration after the completion of the account duplicate check process.
• MatchedOpportunity: array Opportunities
  Title: Opportunities

  The opportunity resource is used to view the opportunities associated with a deal registration. An opportunity is used by a sales organization to track information about a potential sale, such as the sales account, key contacts, product interests, and potential revenues. A matched opportunity is an opportunity that matches the deal registration based on the duplicate check process.
• Note: array Notes
  Title: Notes

  The note resource is used to view, create, update, and delete notes associated with a deal. A note captures comments, information, or instructions related to a deal.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the opportunity associated with the deal registration.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  Public Unique Identifier of Opportunity associated to the Deal Registration
• OwnerId: integer (int64)
  Title: Owner ID

  The unique identifier of the owner of the deal registration.
• OwnerPartyName: string
  Title: Owner

  Maximum Length: 360

  The name of the deal registration owner.
• PartnerCompanyNumber: string
  Title: Partner Number

  Maximum Length: 30

  Public Unique Identifier of Partner company associated to the Deal Registration
• PartnerId: integer (int64)
  Title: Partner ID

  The unique identifier of the partner who submits the deal registration.
• PartnerOwnerPicker: array Partner Owner Picker
  Title: Partner Owner Picker

  The partner owner picker resource is used to create a list of partners that is used to select the partner owner.
• PartnerPartyName: string
  Title: Partner

  Maximum Length: 360

  The name of the deal registration partner.
• PartnerType: string
  Title: Partner Type

  Maximum Length: 30

  The type of the partner who submits the deal registration.
• productGroups: array Product Groups
  Title: Product Groups

  The product group resource is used to view information about related products. A product group is a business object that groups related products so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.
• products: array Products
  Title: Products

  The product resource is used to view product information. A product is an item that an organization or company intends to sell.
• ProgramEnrollmentId: integer (int64)
  Title: Program

  The unique identifier of the partner program enrollment in the context of the deal registration.
• RejectedDate: string (date)
  Title: Rejected Date

  The date and time when the deal registration was rejected.
• ReturnedDate: string (date)
  Title: Returned Date

  The date and time when the deal registration was returned.
• SearchKey: string
  The place holder for any one of the following three attributes: Partner Name, Deal Number, and Account Name.
• smartActions: array Smart Actions
  Title: Smart Actions

  The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_DRAFT

  The status of the deal registration during its life cycle. For example, Draft, Pending Approval, Returned, Approved, Rejected, or Expired. A list of valid values is defined in the lookup ORA_MKL_DEAL_REG_STATUS.
• WithdrawnDate: string (date)
  Title: Withdrawn Date

  The date and time when the deal registration was withdrawn.

{
    "type":"object",
    "properties":{
        "PartnerType":{
            "title":"Partner Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the partner who submits the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RejectedDate":{
            "title":"Rejected Date",
            "type":"string",
            "description":"The date and time when the deal registration was rejected.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DealFinalApprDecisionDate",
                    "StatusCode"
                ]
            }
        },
        "DealId":{
            "title":"Deal ID",
            "type":"integer",
            "description":"The unique identifier of the deal registration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DealApprovedBy":{
            "title":"Approved By",
            "type":"string",
            "description":"The unique identifier of the person who approved the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "StatusCode"
                ]
            }
        },
        "WithdrawnDate":{
            "title":"Withdrawn Date",
            "type":"string",
            "description":"The date and time when the deal registration was withdrawn.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DealFinalApprDecisionDate",
                    "StatusCode"
                ]
            }
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The unique identifier of the partner who submits the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the deal registration during its life cycle. For example, Draft, Pending Approval, Returned, Approved, Rejected, or Expired. A list of valid values is defined in the lookup ORA_MKL_DEAL_REG_STATUS.",
            "nullable":true,
            "default":"ORA_DRAFT",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CloseDate":{
            "title":"Close Date",
            "type":"string",
            "description":"The date and time when the deal registration is estimated to close.",
            "format":"date",
            "nullable":true
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/deals-smartActions-item-post-request"
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":20,
            "type":"string",
            "description":"The currency code. This attribute is used by CRM Extensibility framework. 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":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SearchKey":{
            "type":"string",
            "description":"The place holder for any one of the following three attributes:  Partner Name, Deal Number, and Account Name.",
            "nullable":true,
            "x-queryable":false
        },
        "DealReturnComments":{
            "title":"Returned Comments",
            "maxLength":250,
            "type":"string",
            "description":"The comments added when returning a deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerLocationFloorNumber":{
            "title":"Customer Location Floor Number",
            "type":"string",
            "description":"The account address floor number associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier of Opportunity associated to the Deal Registration",
            "nullable":false
        },
        "DealRejectedBy":{
            "title":"Rejected By",
            "type":"string",
            "description":"The unique identifier of the person who rejected the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "StatusCode"
                ]
            }
        },
        "CustomerLocationAddressLinesPhonetic":{
            "title":"Customer Location Address Lines Phonetic",
            "type":"string",
            "description":"The account address phonetic address line associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerLocationCountry":{
            "title":"Account Country",
            "type":"string",
            "description":"The account address country associated with the deal registration.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DealType":{
            "title":"Deal Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of deal registration that the partner submits for registration.",
            "nullable":true,
            "default":"ORA_NEW",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ApprovedDate":{
            "title":"Approved Date",
            "type":"string",
            "description":"The date and time when the deal registration was approved.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DealFinalApprDecisionDate",
                    "StatusCode"
                ]
            }
        },
        "OwnerPartyName":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the deal registration owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "DealCustomerName":{
            "title":"New Account",
            "maxLength":360,
            "type":"string",
            "description":"The name of the customer associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "DealContactName":{
            "title":"New Contact",
            "maxLength":360,
            "type":"string",
            "description":"The name of the contact associated with the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier of Lead associated to the Deal Registration",
            "nullable":false
        },
        "CustomerId":{
            "title":"Customer ID",
            "type":"integer",
            "description":"The unique identifier of the customer associated with the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "DealExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date and time when the deal registration expires.",
            "format":"date",
            "nullable":true
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity associated with the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ContactLastName":{
            "title":"Contact Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            }
        },
        "DealRejectedReasonCode":{
            "title":"Rejected Reason",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the reason for the rejection of a deal. For example, Duplicate, Ineligible Customer, or Ineligible Partner. A list of valid values is defined in the lookup ORA_MKL_DEAL_REJECT_REASON.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DealProduct":{
            "title":"Deal Products",
            "type":"array",
            "description":"The deal products resource is used to view, create, update, and delete a deal product. The deal product is a product or product family associated with the deal registration that the customer is interested in.",
            "items":{
                "$ref":"#/components/schemas/deals-DealProduct-item-post-request"
            }
        },
        "ConPrPhoneCountryCode":{
            "title":"Contact Primary Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The contact primary phone country code associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "ConPrPhoneAreaCode":{
            "title":"Contact Primary Phone Area Code",
            "maxLength":10,
            "type":"string",
            "description":"The contact primary phone area code associated with the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            }
        },
        "Note":{
            "title":"Notes",
            "type":"array",
            "description":"The note resource is used to view, create, update, and delete notes associated with a deal. A note captures comments, information, or instructions related to a deal.",
            "items":{
                "$ref":"#/components/schemas/deals-Note-item-post-request"
            }
        },
        "CustomerLocationPostalCode":{
            "title":"Account Postal Code",
            "type":"string",
            "description":"The code indicating the account address postal associated with the deal registration. A list of valid values is defined in the lookup Z_PHONE_COUNTRY_CODES.",
            "nullable":true
        },
        "DealAttachments":{
            "title":"Deal Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, update, and delete attachments of a deal. An attachment includes additional information about a deal.",
            "items":{
                "$ref":"#/components/schemas/deals-DealAttachments-item-post-request"
            }
        },
        "productGroups":{
            "title":"Product Groups",
            "type":"array",
            "description":"The product group resource is used to view information about related products. A product group is a business object that groups related products so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.",
            "items":{
                "$ref":"#/components/schemas/deals-productGroups-item-post-request"
            }
        },
        "ProgramEnrollmentId":{
            "title":"Program",
            "type":"integer",
            "description":"The unique identifier of the partner program enrollment in the context of the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "PartnerOwnerPicker":{
            "title":"Partner Owner Picker",
            "type":"array",
            "description":"The partner owner picker resource is used to create a list of partners that is used to select the partner owner.",
            "items":{
                "$ref":"#/components/schemas/deals-PartnerOwnerPicker-item-post-request"
            }
        },
        "DealResources":{
            "title":"Deal Team Members",
            "type":"array",
            "description":"The deal team member resource is used to view, create, update, and delete a deal team member. A deal team member is a resource who is assigned to the deal registration team and who has the appropriate visibility and access to the deal registration record.",
            "items":{
                "$ref":"#/components/schemas/deals-DealResources-item-post-request"
            }
        },
        "DealReturnedBy":{
            "title":"Returned By",
            "type":"string",
            "description":"The unique identifier of the person who returned the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "StatusCode"
                ]
            }
        },
        "DealReturnReasonCode":{
            "title":"Returned Reason",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the reason for the return of a deal registration. For example, Incomplete Customer Information, or Insufficient Quantity. A list of valid values is defined in the lookup ORA_MKL_DEAL_RETURN_REASON.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CustomerLocationCounty":{
            "title":"Customer Location County",
            "type":"string",
            "description":"The account address county associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerFormattedAddress":{
            "title":"Customer Address",
            "type":"string",
            "description":"The formatted address of the customer.",
            "nullable":true,
            "x-queryable":false
        },
        "DealNumber":{
            "title":"Registration Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the deal registration.",
            "nullable":false
        },
        "CustomerLocationAddrElementAttribute5":{
            "title":"Customer Location Address Element Attribute 5",
            "type":"string",
            "description":"The account address element attribute 5 associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact associated with the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "ConPrPhoneNumber":{
            "title":"Phone",
            "maxLength":40,
            "type":"string",
            "description":"The contact primary phone number associated with the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            }
        },
        "CustomerLocationAddrElementAttribute4":{
            "title":"Customer Location Address Element Attribute 4",
            "type":"string",
            "description":"The account address element attribute 4 associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "DealRejectedComments":{
            "title":"Rejected Comments",
            "maxLength":250,
            "type":"string",
            "description":"The comments added when rejecting a deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerLocationAddress2":{
            "title":"Customer Location Address 2",
            "type":"string",
            "description":"The account address line 2 associated to the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerLocationAddress1":{
            "title":"Customer Location Address 1",
            "type":"string",
            "description":"The account address line 1 associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerLocationAddress4":{
            "title":"Customer Location Address 4",
            "type":"string",
            "description":"The account address line 4 associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerLocationAddress3":{
            "title":"Customer Location Address 3",
            "type":"string",
            "description":"The account address line 3 associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "products":{
            "title":"Products",
            "type":"array",
            "description":"The product resource is used to view product information. A product is an item that an organization or company intends to sell.",
            "items":{
                "$ref":"#/components/schemas/deals-products-item-post-request"
            }
        },
        "ContactJobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"The contact job title associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "PartnerPartyName":{
            "title":"Partner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the deal registration partner.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of the owner of the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "MatchedContactPartyId":{
            "title":"Matched Contact Party ID",
            "type":"integer",
            "description":"The identifier of the contact associated with the deal registration after the completion of the account duplicate check process.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CustomerLocationAddrElementAttribute3":{
            "title":"Customer Location Address Element Attribute 3",
            "type":"string",
            "description":"The account address element attribute 3 associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "DealWithdrawnBy":{
            "title":"Withdrawn By",
            "type":"string",
            "description":"The unique identifier of the person who withdrew the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "StatusCode"
                ]
            }
        },
        "CustomerLocationAddrElementAttribute2":{
            "title":"Customer Location Address Element Attribute 2",
            "type":"string",
            "description":"The account address element attribute 2 associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerLocationAddrElementAttribute1":{
            "title":"Customer Location Address Element Attribute 1",
            "type":"string",
            "description":"The account address element attribute 1 associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerLocationCity":{
            "title":"Account City",
            "type":"string",
            "description":"The account address city associated with the deal registration.",
            "nullable":true
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the lead associated with the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CustomerName":{
            "title":"Existing Account",
            "maxLength":900,
            "type":"string",
            "description":"The name of the customer associated with the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ContactFirstName":{
            "title":"Contact First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            }
        },
        "MatchedAccountPartyId":{
            "title":"Matched Account Party ID",
            "type":"integer",
            "description":"The identifier of the customer account associated with the deal registration after the completion of the account duplicate check process.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ReturnedDate":{
            "title":"Returned Date",
            "type":"string",
            "description":"The date and time when the deal registration was returned.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DealFinalApprDecisionDate",
                    "StatusCode"
                ]
            }
        },
        "CustomerLocationState":{
            "title":"Account State",
            "type":"string",
            "description":"The account address state associated with the deal registration.",
            "nullable":true
        },
        "CustomerLocationProvince":{
            "title":"Customer Location Province",
            "type":"string",
            "description":"The account address province associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "DealSize":{
            "title":"Deal Size",
            "type":"number",
            "description":"The monetary amount that the customer is expected to spend.",
            "nullable":true
        },
        "DealApprovalHistory":{
            "title":"Deal Approval Histories",
            "type":"array",
            "description":"The deal registration approval history lets you access a comprehensive record of approval-related information associated with the deal, encompassing the names of approvers, action dates, and the specific actions taken.",
            "items":{
                "$ref":"#/components/schemas/deals-DealApprovalHistory-item-post-request"
            }
        },
        "MatchedOpportunity":{
            "title":"Opportunities",
            "type":"array",
            "description":"The opportunity resource is used to view the opportunities associated with a deal registration. An opportunity is used by a sales organization to track information about a potential sale, such as the sales account, key contacts, product interests, and potential revenues. A matched opportunity is an opportunity that matches the deal registration based on the duplicate check process.",
            "items":{
                "$ref":"#/components/schemas/deals-MatchedOpportunity-item-post-request"
            }
        },
        "ContactEmailAddress":{
            "title":"Contact Email",
            "maxLength":320,
            "type":"string",
            "description":"The contact email address associated with the deal registration.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "DealName":{
            "title":"Name",
            "maxLength":250,
            "type":"string",
            "description":"The name of the deal registration.",
            "nullable":true
        },
        "ApprovalTaskStatusCode":{
            "title":"Approval Task Status Code",
            "type":"string",
            "description":"Indicates the approval status of the deal registration. The accepted values are: Approve, Reject, Return, and Withdraw.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerLocationPostalPlus4Code":{
            "title":"Customer Location Postal Plus 4 Code",
            "type":"string",
            "description":"The account address postal code plus the four code associated to the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "PartnerCompanyNumber":{
            "title":"Partner Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier of Partner company associated to the Deal Registration",
            "nullable":false
        },
        "CustomerLocationBuilding":{
            "title":"Location Building",
            "type":"string",
            "description":"The account address building associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactName":{
            "title":"Existing Contact",
            "maxLength":900,
            "type":"string",
            "description":"The name of the contact associated with the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        }
    }
}

Nested Schema : Deal Approval Histories

Type: array

Title: Deal Approval Histories

The deal registration approval history lets you access a comprehensive record of approval-related information associated with the deal, encompassing the names of approvers, action dates, and the specific actions taken.

Show Source

• Array of: object deals-DealApprovalHistory-item-post-request

{
    "title":"Deal Approval Histories",
    "type":"array",
    "description":"The deal registration approval history lets you access a comprehensive record of approval-related information associated with the deal, encompassing the names of approvers, action dates, and the specific actions taken.",
    "items":{
        "$ref":"#/components/schemas/deals-DealApprovalHistory-item-post-request"
    }
}

Nested Schema : Deal Attachments

Type: array

Title: Deal Attachments

The attachments resource is used to view, create, update, and delete attachments of a deal. An attachment includes additional information about a deal.

Show Source

• Array of: object schema

{
    "title":"Deal Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, update, and delete attachments of a deal. An attachment includes additional information about a deal.",
    "items":{
        "$ref":"#/components/schemas/deals-DealAttachments-item-post-request"
    }
}

Nested Schema : Deal Products

Type: array

Title: Deal Products

The deal products resource is used to view, create, update, and delete a deal product. The deal product is a product or product family associated with the deal registration that the customer is interested in.

Show Source

• Array of: object schema

{
    "title":"Deal Products",
    "type":"array",
    "description":"The deal products resource is used to view, create, update, and delete a deal product. The deal product is a product or product family associated with the deal registration that the customer is interested in.",
    "items":{
        "$ref":"#/components/schemas/deals-DealProduct-item-post-request"
    }
}

Nested Schema : Deal Team Members

Type: array

Title: Deal Team Members

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

Show Source

• Array of: object schema

{
    "title":"Deal Team Members",
    "type":"array",
    "description":"The deal team member resource is used to view, create, update, and delete a deal team member. A deal team member is a resource who is assigned to the deal registration team and who has the appropriate visibility and access to the deal registration record.",
    "items":{
        "$ref":"#/components/schemas/deals-DealResources-item-post-request"
    }
}

Nested Schema : Opportunities

Type: array

Title: Opportunities

The opportunity resource is used to view the opportunities associated with a deal registration. An opportunity is used by a sales organization to track information about a potential sale, such as the sales account, key contacts, product interests, and potential revenues. A matched opportunity is an opportunity that matches the deal registration based on the duplicate check process.

Show Source

• Array of: object deals-MatchedOpportunity-item-post-request

{
    "title":"Opportunities",
    "type":"array",
    "description":"The opportunity resource is used to view the opportunities associated with a deal registration. An opportunity is used by a sales organization to track information about a potential sale, such as the sales account, key contacts, product interests, and potential revenues. A matched opportunity is an opportunity that matches the deal registration based on the duplicate check process.",
    "items":{
        "$ref":"#/components/schemas/deals-MatchedOpportunity-item-post-request"
    }
}

Nested Schema : Notes

Type: array

Title: Notes

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

Show Source

• Array of: object schema

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

Nested Schema : Partner Owner Picker

Type: array

Title: Partner Owner Picker

The partner owner picker resource is used to create a list of partners that is used to select the partner owner.

Show Source

• Array of: object schema

{
    "title":"Partner Owner Picker",
    "type":"array",
    "description":"The partner owner picker resource is used to create a list of partners that is used to select the partner owner.",
    "items":{
        "$ref":"#/components/schemas/deals-PartnerOwnerPicker-item-post-request"
    }
}

Nested Schema : Product Groups

Type: array

Title: Product Groups

The product group resource is used to view information about related products. A product group is a business object that groups related products so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.

Show Source

• Array of: object deals-productGroups-item-post-request

{
    "title":"Product Groups",
    "type":"array",
    "description":"The product group resource is used to view information about related products. A product group is a business object that groups related products so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.",
    "items":{
        "$ref":"#/components/schemas/deals-productGroups-item-post-request"
    }
}

Nested Schema : Products

Type: array

Title: Products

The product resource is used to view product information. A product is an item that an organization or company intends to sell.

Show Source

• Array of: object deals-products-item-post-request

{
    "title":"Products",
    "type":"array",
    "description":"The product resource is used to view product information. A product is an item that an organization or company intends to sell.",
    "items":{
        "$ref":"#/components/schemas/deals-products-item-post-request"
    }
}

Nested Schema : Smart Actions

Type: array

Title: Smart Actions

The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object deals-smartActions-item-post-request

{
    "title":"Smart Actions",
    "type":"array",
    "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/deals-smartActions-item-post-request"
    }
}

Nested Schema : deals-DealApprovalHistory-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : schema

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  The unique identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

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

  Maximum Length: 30

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

  Indicates whether the attachment is shared.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  The code indicating the type of attachment. For example, File, URL, and so on.
• Description: string
  Title: Description

  Maximum Length: 255

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

  The unique document ID of the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The current version number of the attachment.
• 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 code indicating the type of error, 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 date when the contents in the attachment expire.
• 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 URL of the attachment.
• 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 length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of the attachment.

{
    "type":"object",
    "properties":{
        "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"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique document ID of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"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"
            }
        },
        "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"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length 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 current version number of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"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"
            }
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of attachment. For example, File, URL, and so on.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"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"
            }
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the 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 URL of the attachment.",
            "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 date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of error, 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 of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the 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 name of the category of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"The unique identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• Amount: number
  Title: Amount

  The amount associated with the product line. The amount equals quantity times the registered price.
• ConvCurrencyCode: string
  Maximum Length: 15

  The currency code to which the currency on the deal registration must be converted to. For example, the corporate currency code.
• ConvExchangeRate: number
  The exchange rate for converting the entered currency to the standard CRM corporate currency.
• ConvRateType: string
  Maximum Length: 30

  The currency conversion rate type used to derive the exchange rate between the user entered currency and the CRM corporate currency code associated with the deal registration.
• CurrencyCode: string
  Maximum Length: 15

  The currency code. This attribute is used by CRM Extensibility framework. 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.
• DealId: integer (int64)
  The unique identifier of the parent deal registration.
• DealNumber: string
  Title: Registration Number

  Maximum Length: 30

  The alternate unique identifier of the deal registration.
• DealProdId: integer (int64)
  The unique identifier of the deal registration product.
• DealProdNumber: string
  Maximum Length: 30

  The alternate unique identifier of the deal registration product.
• InventoryItemId: integer (int64)
  The unique identifier of the product inventory item associated with the deal registration.
• InvOrgId: integer (int64)
  The unique identifier of the inventory organization.
• ItemName: string
  Title: Item Description

  Maximum Length: 240

  The name of the product associated with the deal registration.
• ProductGroupId: integer (int64)
  The unique identifier of the product group associated with the deal registration.
• ProductGroupName: string
  Title: Name

  Maximum Length: 250

  The name of the product group associated with the deal registration.
• ProductGroupNumber: string
  Title: Product Group Number

  Maximum Length: 50

  Public Unique Identifier for Product Group in Deal Registration
• ProductType: string
  Title: Type

  The product line type, such as product or product group.
• Quantity: number
  Title: Quantity

  The quantity of the product or product group.
• RegisteredPrice: number
  Title: Registered Price

  The registered price of the product.
• UOMCode: string
  Title: UOM

  Maximum Length: 3

  The unit of measure of the product quantity.

{
    "type":"object",
    "properties":{
        "DealId":{
            "type":"integer",
            "description":"The unique identifier of the parent deal registration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProductGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group associated with the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ConvCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code to which the currency on the deal registration must be converted to. For example, the corporate currency code.",
            "nullable":true
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The unique identifier of the inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DealNumber":{
            "title":"Registration Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the deal registration.",
            "nullable":false
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount associated with the product line. The amount equals quantity times the registered price.",
            "nullable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the product inventory item associated with the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ProductType":{
            "title":"Type",
            "type":"string",
            "description":"The product line type, such as product or product group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type used to derive the exchange rate between the user entered currency and the CRM corporate currency code associated with the deal registration.",
            "nullable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the product or product group.",
            "nullable":true
        },
        "DealProdId":{
            "type":"integer",
            "description":"The unique identifier of the deal registration product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ProductGroupName":{
            "title":"Name",
            "maxLength":250,
            "type":"string",
            "description":"The name of the product group associated with the deal registration.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "DealProdNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the deal registration product.",
            "nullable":false
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code. This attribute is used by CRM Extensibility framework. 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":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "ConvExchangeRate":{
            "type":"number",
            "description":"The exchange rate for converting the entered currency to the standard CRM corporate currency.",
            "nullable":true
        },
        "ItemName":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"The name of the product associated with the deal registration.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "RegisteredPrice":{
            "title":"Registered Price",
            "type":"number",
            "description":"The registered price of the product.",
            "nullable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of the product quantity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProductGroupNumber":{
            "title":"Product Group Number",
            "maxLength":50,
            "type":"string",
            "description":"Public Unique Identifier for Product Group in Deal Registration",
            "nullable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Maximum Length: 30

  The code indicating the access level of the deal team member. For example, View Only,Edit, or Full. A list of valid values is defined in the lookup ORA_MKL_DEAL_ACCESS_LEVEL.
• DealId: integer (int64)
  The unique identifier of the deal registration.
• DealNumber: string
  Title: Registration Number

  Maximum Length: 30

  Public Unique Identifier of Deal Registration on the Deal Resource Team
• DealResourceId: integer (int64)
  The unique identifier of the deal team member.
• MemberFunctionCode: string
  Title: Function

  Maximum Length: 30

  The code indicating the function of a deal team member. For example, Channel Manager, engineering Owner, Executive Sponsor, Primary Salesperson, Product Specialist, Support Account manager, Technical Account Manager, Technical Marketing Manager, or Technical Specialist. A list of valid values is defined in the lookup ZCA_RESOURCE_FUNCTION.
• OwnerFlag: boolean
  Title: Owner

  Indicates whether the deal team member is the owner of the deal registration.
• PartnerOrgId: integer (int64)
  The unique identifier of the partner organization.
• ResourceId: integer (int64)
  The unique identifier of the employee resource.
• ResourceUsername: string
  Title: User Name

  The login username of the deal team member associated with the deal registration.

{
    "type":"object",
    "properties":{
        "DealId":{
            "type":"integer",
            "description":"The unique identifier of the deal registration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the access level of the deal team member. For example, View Only,Edit, or Full. A list of valid values is defined in the lookup ORA_MKL_DEAL_ACCESS_LEVEL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceId":{
            "type":"integer",
            "description":"The unique identifier of the employee resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DealResourceId":{
            "type":"integer",
            "description":"The unique identifier of the deal team member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DealNumber":{
            "title":"Registration Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier of Deal Registration on the Deal Resource Team",
            "nullable":false
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the deal team member is the owner of the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceId"
                ]
            }
        },
        "PartnerOrgId":{
            "type":"integer",
            "description":"The unique identifier of the partner organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the function of a deal team member. For example, Channel Manager, engineering Owner, Executive Sponsor, Primary Salesperson, Product Specialist, Support Account manager, Technical Account Manager, Technical Marketing Manager, or Technical Specialist. A list of valid values is defined in the lookup ZCA_RESOURCE_FUNCTION.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceUsername":{
            "title":"User Name",
            "type":"string",
            "description":"The login username of the deal team member associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : deals-MatchedOpportunity-item-post-request

Type: object

Show Source

• AssetId: integer (int64)
  The unique identifier of the asset associated with the opportunity.
• AssetNumber: string
  Title: Asset Number

  Maximum Length: 100

  The alternate key identifier of the asset associated with the opportunity.
• AssetProduct: string
  Title: Asset

  The asset product associated with the opportunity.
• AssignmentMode: string
  Title: Assignment Mode

  Maximum Length: 30

  Specifies the types of assignment mode options available for controlling auto assignment default behavior for opportunity record updates.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  The batch tag of the opportunity.
• BdgtAmount: number
  Title: Budget Amount

  Budget amount from the sales account.
• BdgtAmtCurcyCd: string
  Title: Budget Amount Currency

  Maximum Length: 15

  The currency code for budget amount from the sales account.
• BudgetAvailableDate: string (date)
  Title: Date Budget Available

  The date and time when the opportunity budget was made available.
• BudgetedFlag: boolean
  Title: Budgeted

  Maximum Length: 1

  Default Value: false

  Indicates if the opportunity sales account has the budget approved for the potential purchase. If the value is true, then the sales account has the budget approved for the purchase. The default value is False.
• ChampionFlag: boolean
  Title: Key Internal Sponsor

  Maximum Length: 1

  Default Value: false

  Indicates if the opportunity has an internal sponsor. If the value is true, then the opportunity has an internal sponsor. The default value is False.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The user-provided comments for the opportunity.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  Disconnected Mobile: this value is used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server).
• CrmConversionRate: number
  Title: Conversion Rate

  This rate is used for the conversion of the revenue amount to the CRM common currency to facilitate the computation of the revenue forecast metrics. This is the amount that one currency can be exchanged for, at a specific point of time.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code of the matched opportunity. This attribute is used by CRM Extensibility framework. 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.
• CustomerAccountId: integer (int64)
  Title: Billing Account

  The unique identifier of the customer billing account associated with the opportunity.
• DealHorizonCode: string
  Title: Estimated Deal Duration

  Maximum Length: 30

  The estimated time, in days, required to close the deal. A list of valid values is defined in the lookup MOO_SETID_DEAL_HORIZION. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• DecisionLevelCode: string
  Title: Decision Level

  Maximum Length: 30

  The job level of the person who takes the final decision for the opportunity. A list of valid values is defined in the lookup MOO_SETID_DECISION_LEVEL. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• Description: string
  Title: Sales Objective

  Maximum Length: 2000

  The description of the opportunity, including the sales objective.
• DownsideAmount: number
  Title: Worst Case

  Default Value: 0

  The minimum amount of revenue for the opportunity.
• EffectiveDate: string (date)
  Title: Close Date

  The date and time when the opportunity was closed.
• ExpectAmount: number
  Title: Expected Revenue

  Default Value: 0

  The expected revenue from the opportunity.
• ForecastCategory: string
  Title: Forecast Category

  Maximum Length: 30

  Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely and so on.
• ForecastOverrideCode: string
  Title: Include in Forecast

  Maximum Length: 30

  The code that indicates if the revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.
• IBAssetId: integer (int64)
  Title: Installed Base Asset

  Identifier of the installed base asset of the opportunity.
• KeyContactId: integer (int64)
  Title: Primary Contact

  The unique identifier of the primary contact associated with the opportunity.
• LastUpdateLogin: string
  Title: Last Update Login

  Maximum Length: 32

  The login of the user who last updated the opportunity record.
• LineOfBusinessCode: string
  Title: Line of Business

  Maximum Length: 30

  The code indicating which line of business owns the opportunity.
• Name: string
  Title: Name

  Maximum Length: 275

  The name of the opportunity.
• OpportunityOrigin: string
  Title: Opportunity Origin

  Maximum Length: 30

  Default Value: SALES_OPTY

  The value for the origin of the opportunity.
• OpportunityTypeCode: string
  Title: Opportunity Type

  Maximum Length: 30

  Display the different types of opportunity such as new, renewal and expansion.
• OptyCreatedBy: string
  Title: Opportunity Created By

  Maximum Length: 64

  The user who created the opportunity.
• OptyCreationDate: string (date-time)
  Title: Opportunity Creation Date

  The date and time when the opportunity was created.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the opportunity.
• OptyLastUpdateDate: string (date-time)
  Title: Opportunity Last Updated Date

  The date when the opportunity was last updated.
• OptyLastUpdatedBy: string
  Title: Opportunity Last Updated By

  Maximum Length: 64

  The user who last updated the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The unique alternate identifier for the opportunity.
• OwnerResourcePartyId: integer (int64)
  Title: Owner

  The unique identifier of a valid employee resource who owns and manages the opportunity.
• PrimaryCampaignId: integer (int64)
  Title: Primary Campaign ID

  The unique identifier of the primary campaign associated with the matched opportunity.
• PrimaryCampaignName: string
  Title: Primary Campaign

  The name of the primary campaign associated with the matched opportunity.
• PrimaryCampaignNumber: string
  Title: Primary Campaign Number

  Maximum Length: 30

  The alternate unique identifier of the primary campaign associated with the matched opportunity.
• PrimaryCompetitorId: integer (int64)
  Title: Primary Competitor

  The unique identifier of the primary competitor associated with the opportunity.
• PrimaryOrganizationId: integer (int64)
  Title: Business Unit ID

  The unique identifier of the business unit associated with the opportunity.
• PrimaryPartnerCompanyNumber: string
  Title: Primary Partner Number

  Maximum Length: 30

  The party number of the primary partner associated with the opportunity.
• PrimaryPartnerId: integer (int64)
  Title: Primary Partner

  The unique identifier of the primary partner associated with the opportunity.
• PrimaryPartnerOrgPartyName: string
  Title: Primary Partner

  Maximum Length: 360

  The organization party name of the primary partner associated with the opportunity.
• PrimaryRevenueId: integer (int64)
  Title: Summary Revenue Line ID

  The unique identifier of the summary revenue line associated with the opportunity.
• PrimarySubscriptionId: integer (int64)
  Title: Primary Subscription Id

  The unique identifier of the primary subscription of the opportunity.
• PrSrcNumber: string
  Title: Primary Source Number

  Maximum Length: 100

  The unique identifier of the primary marketing source or campaign that generated the opportunity.
• QuotedFlag: boolean
  Title: Quoted

  Maximum Length: 1

  Default Value: false

  Indicates that a quote has been created for this Opportunity.
• ReasonWonLostCode: string
  Title: Win/Loss Reason

  Maximum Length: 30

  The reason for winning or losing the opportunity. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• Registered: string
  Title: Registered

  Maximum Length: 30

  Indicates whether the opportunity was registered. The valid values are Expired, Yes, and No.
• RegistrationStatus: string
  Title: Registration Status

  Maximum Length: 30

  The registration status of the opportunity.
• RegistrationType: string
  Title: Registration Type

  Maximum Length: 30

  The registration type used by the partner to create the opportunity.
• RenewalProcess: string
  Title: Renewal Process

  Maximum Length: 30

  The renewal process can be manual, do not renew or automatic renewal.
• Revenue: number
  Title: Amount

  Default Value: 0

  The revenue amount of the opportunity.
• RiskLevelCode: string
  Title: Level of Risk

  Maximum Length: 30

  The risk level code of the opportunity. A list of valid values is defined in the lookup MOO_SETID_RISK_LEVE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• SalesChannelCd: string
  Title: Sales Channel

  Maximum Length: 50

  The code indicating the sales channel for the opportunity.
• SalesMethodId: integer (int64)
  Title: Sales Method

  The unique identifier of the sales method associated with the opportunity.
• SalesStageId: integer (int64)
  Title: Sales Stage

  The unique identifier of the sales stage associated with the opportunity.
• Selected: boolean
  Indicates if the matched opportunity is selected.
• SetupRefCode: string
  Maximum Length: 80

  The public unique identifier for the CPQ configuration setup.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  The status of the opportunity. A list of valid values is defined in the lookup MOO_OPTY_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• StrategicLevelCode: string
  Title: Strategic Value

  Maximum Length: 30

  The strategic value that the opportunity has for the sales account. A list of valid values is defined in the lookup MOO_SETID_STRATEGIC_VALUE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• TargetPartyId: integer (int64)
  Title: Account

  The unique identifier of the sales account associated with the opportunity.
• UpsideAmount: number
  Title: Best Case

  Default Value: 0

  The maximum amount of revenue for the opportunity.
• WinProb: integer (int32)
  Title: Win Probability

  The estimated probability of winning the opportunity.

{
    "type":"object",
    "properties":{
        "SalesMethodId":{
            "title":"Sales Method",
            "type":"integer",
            "description":"The unique identifier of the sales method associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "OptyLastUpdateDate":{
            "title":"Opportunity Last Updated Date",
            "type":"string",
            "description":"The date when the opportunity was last updated.",
            "format":"date-time",
            "nullable":true
        },
        "UpsideAmount":{
            "title":"Best Case",
            "type":"number",
            "description":"The maximum amount of revenue for the opportunity.",
            "nullable":true,
            "default":0,
            "x-queryable":false
        },
        "PrimaryCampaignNumber":{
            "title":"Primary Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the primary campaign associated with the matched opportunity.",
            "nullable":false
        },
        "ForecastCategory":{
            "title":"Forecast Category",
            "maxLength":30,
            "type":"string",
            "description":"Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely and so on.",
            "nullable":true
        },
        "ExpectAmount":{
            "title":"Expected Revenue",
            "type":"number",
            "description":"The expected revenue from the opportunity.",
            "nullable":true,
            "default":0,
            "x-queryable":false
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the opportunity. A list of valid values is defined in the lookup MOO_OPTY_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "AttributeType":"Picklist",
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":100,
            "type":"string",
            "description":"The alternate key identifier of the asset associated with the opportunity.",
            "nullable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"Disconnected Mobile: this value is used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server).",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            }
        },
        "Name":{
            "title":"Name",
            "maxLength":275,
            "type":"string",
            "description":"The name of the opportunity.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code of the matched opportunity. This attribute is used by CRM Extensibility framework. 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":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "PrimaryCompetitorId":{
            "title":"Primary Competitor",
            "type":"integer",
            "description":"The unique identifier of the primary competitor associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"Competitor",
                "RecentItemEntityName":"competitors",
                "dependencies":[
                    "PriCompPartyUniqueName1",
                    "PrimaryCompetitorName"
                ]
            }
        },
        "PrimaryPartnerId":{
            "title":"Primary Partner",
            "type":"integer",
            "description":"The unique identifier of the primary partner associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"Partner",
                "RecentItemEntityName":"partners"
            }
        },
        "IBAssetId":{
            "title":"Installed Base Asset",
            "type":"integer",
            "description":"Identifier of the installed base asset of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "IBAssetNumber"
                ]
            }
        },
        "RiskLevelCode":{
            "title":"Level of Risk",
            "maxLength":30,
            "type":"string",
            "description":"The risk level code of the opportunity. A list of valid values is defined in the lookup MOO_SETID_RISK_LEVE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "AssignmentMode":{
            "title":"Assignment Mode",
            "maxLength":30,
            "type":"string",
            "description":"Specifies the types of assignment mode options available for controlling auto assignment default behavior for opportunity record updates.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique alternate identifier for the opportunity.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "PrimaryPartnerCompanyNumber":{
            "title":"Primary Partner Number",
            "maxLength":30,
            "type":"string",
            "description":"The party number of the primary partner associated with the opportunity.",
            "nullable":false
        },
        "TargetPartyId":{
            "title":"Account",
            "type":"integer",
            "description":"The unique identifier of the sales account associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"Account",
                "RecentItemEntityName":"accounts"
            }
        },
        "OptyCreatedBy":{
            "title":"Opportunity Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            }
        },
        "PrSrcNumber":{
            "title":"Primary Source Number",
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the primary marketing source or campaign that generated the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ReasonWonLostCode":{
            "title":"Win/Loss Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for winning or losing the opportunity. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "SalesStageId":{
            "title":"Sales Stage",
            "type":"integer",
            "description":"The unique identifier of the sales stage associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "precision":18,
                "Dependencies":"SalesMethodId,PrimaryOrganizationId"
            }
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WinProb":{
            "title":"Win Probability",
            "type":"integer",
            "description":"The estimated probability of winning the opportunity.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "precision":5
            }
        },
        "OptyCreationDate":{
            "title":"Opportunity Creation Date",
            "type":"string",
            "description":"The date and time when the opportunity was created.",
            "format":"date-time",
            "nullable":true
        },
        "OptyLastUpdatedBy":{
            "title":"Opportunity Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the opportunity.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            }
        },
        "KeyContactId":{
            "title":"Primary Contact",
            "type":"integer",
            "description":"The unique identifier of the primary contact associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"Contact",
                "RecentItemEntityName":"contacts",
                "dependencies":[
                    "PriContactPartyNameTransientForLOV",
                    "PriContactPartyName1"
                ]
            }
        },
        "BdgtAmount":{
            "title":"Budget Amount",
            "type":"number",
            "description":"Budget amount from the sales account.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryPartnerOrgPartyName":{
            "title":"Primary Partner",
            "maxLength":360,
            "type":"string",
            "description":"The organization party name of the primary partner associated with the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SetupRefCode":{
            "maxLength":80,
            "type":"string",
            "description":"The public unique identifier for the CPQ configuration setup.",
            "nullable":true
        },
        "Revenue":{
            "title":"Amount",
            "type":"number",
            "description":"The revenue amount of the opportunity.",
            "nullable":true,
            "default":0,
            "x-queryable":false
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the asset associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"Asset",
                "RecentItemEntityName":"assets",
                "dependencies":[
                    "AssetProduct",
                    "AssetNumber",
                    "AssetProductForExtnLOV"
                ]
            }
        },
        "OpportunityOrigin":{
            "title":"Opportunity Origin",
            "maxLength":30,
            "type":"string",
            "description":"The value for the origin of the opportunity.",
            "nullable":true,
            "default":"SALES_OPTY",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the opportunity record.",
            "nullable":true,
            "x-queryable":false
        },
        "BudgetAvailableDate":{
            "title":"Date Budget Available",
            "type":"string",
            "description":"The date and time when the opportunity budget was made available.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Sales Objective",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the opportunity, including the sales objective.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "OpportunityTypeCode":{
            "title":"Opportunity Type",
            "maxLength":30,
            "type":"string",
            "description":"Display the different types of opportunity such as new, renewal and expansion.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "PrimarySubscriptionId":{
            "title":"Primary Subscription Id",
            "type":"integer",
            "description":"The unique identifier of the primary subscription of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DealHorizonCode":{
            "title":"Estimated Deal Duration",
            "maxLength":30,
            "type":"string",
            "description":"The estimated time, in days, required to close the deal. A list of valid values is defined in the lookup MOO_SETID_DEAL_HORIZION. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "RenewalProcess":{
            "title":"Renewal Process",
            "maxLength":30,
            "type":"string",
            "description":"The renewal process can be manual, do not renew or automatic renewal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "DecisionLevelCode":{
            "title":"Decision Level",
            "maxLength":30,
            "type":"string",
            "description":"The job level of the person who takes the final decision for the opportunity. A list of valid values is defined in the lookup MOO_SETID_DECISION_LEVEL. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "OwnerResourcePartyId":{
            "title":"Owner",
            "type":"integer",
            "description":"The unique identifier of a valid employee resource who owns and manages the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"resources"
            }
        },
        "CustomerAccountId":{
            "title":"Billing Account",
            "type":"integer",
            "description":"The unique identifier of the customer billing account associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "BdgtAmtCurcyCd":{
            "title":"Budget Amount Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code for budget amount from the sales account.",
            "nullable":true,
            "x-queryable":false
        },
        "RegistrationType":{
            "title":"Registration Type",
            "maxLength":30,
            "type":"string",
            "description":"The registration type used by the partner to create the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "PrimaryOrganizationId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "precision":18
            }
        },
        "PrimaryCampaignName":{
            "title":"Primary Campaign",
            "type":"string",
            "description":"The name of the primary campaign associated with the matched opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PrimaryCampaignName1"
                ]
            }
        },
        "DownsideAmount":{
            "title":"Worst Case",
            "type":"number",
            "description":"The minimum amount of revenue for the opportunity.",
            "nullable":true,
            "default":0,
            "x-queryable":false
        },
        "Selected":{
            "type":"boolean",
            "description":"Indicates if the matched opportunity is selected.",
            "nullable":true,
            "x-queryable":false
        },
        "StrategicLevelCode":{
            "title":"Strategic Value",
            "maxLength":30,
            "type":"string",
            "description":"The strategic value that the opportunity has for the sales account.  A list of valid values is defined in the lookup MOO_SETID_STRATEGIC_VALUE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "AssetProduct":{
            "title":"Asset",
            "type":"string",
            "description":"The asset product associated with the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "PrimaryCampaignId":{
            "title":"Primary Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the primary campaign associated with the matched opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"campaigns"
            }
        },
        "BudgetedFlag":{
            "title":"Budgeted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the opportunity sales account has the budget approved for the potential purchase. If the value is true, then the sales account has the budget approved for the purchase. The default value is False.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "QuotedFlag":{
            "title":"Quoted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that a quote has been created for this Opportunity.",
            "nullable":true,
            "default":false
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The user-provided comments for the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "RegistrationStatus":{
            "title":"Registration Status",
            "maxLength":30,
            "type":"string",
            "description":"The registration status of the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "CrmConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"This rate is used for the conversion of the revenue amount to the CRM common currency to facilitate the computation of the revenue forecast metrics. This is the amount that one currency can be exchanged for, at a specific point of time.",
            "nullable":true
        },
        "LineOfBusinessCode":{
            "title":"Line of Business",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating which line of business owns the opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "SalesChannelCd":{
            "title":"Sales Channel",
            "maxLength":50,
            "type":"string",
            "description":"The code indicating the sales channel for the opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ForecastOverrideCode":{
            "title":"Include in Forecast",
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates if the revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ChampionFlag":{
            "title":"Key Internal Sponsor",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the opportunity has an internal sponsor. If the value is true, then the opportunity has an internal sponsor. The default value is False.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "PrimaryRevenueId":{
            "title":"Summary Revenue Line ID",
            "type":"integer",
            "description":"The unique identifier of the summary revenue line associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Registered":{
            "title":"Registered",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the opportunity was registered. The valid values are Expired, Yes, and No.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EffectiveDate":{
            "title":"Close Date",
            "type":"string",
            "description":"The date and time when the opportunity was closed.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "BETWEEN"
                ]
            }
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":30,
            "type":"string",
            "description":"The batch tag of the opportunity.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Nested Schema : schema

Type: object

Show Source

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

  The unique identifier of the relationship between a contact and a note. This value is populated when the note is associated with a contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the note associated with the note. This attribute is used by CRM Extensibility framework. 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.
• CreatorPartyId: integer (int64)
  Title: Creator Party ID

  The unique identifier of the person who created or authored the note.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type used to derive the exchange rate between the user-entered currency and the CRM corporate currency code associated with the note.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code. This attribute is used by CRM Extensibility framework. 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.
• 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 column to store the note text.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  The code indicating the type of the note. For example, General or Reference.
• ParentNoteId: integer (int64)
  Title: Parent Note ID

  The unique identifier of the parent note.
• SourceObjectCode: string
  Title: Related Object Type

  Maximum Length: 30

  The source object code for the source object as defined in the object's metadata.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  The unique identifier of the source objects as defined in the object's metadata, such as activities and opportunities.
• VisibilityCode: string
  Title: Private

  Maximum Length: 30

  Default Value: INTERNAL

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

{
    "type":"object",
    "properties":{
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique identifier of the person who created or authored the note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "NoteTypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of the note. For example, General or Reference.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "SourceObjectCode"
                ]
            }
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type used to derive the exchange rate between the user-entered currency and the CRM corporate currency code associated with the note.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the visibility level of the note, such as private, internal, or external.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the relationship between a contact and a note. This value is populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code. This attribute is used by CRM Extensibility framework. 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":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
        },
        "SourceObjectId":{
            "title":"Related Object",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the source objects as defined in the object's metadata, such as activities and opportunities.",
            "nullable":false
        },
        "SourceObjectCode":{
            "title":"Related Object Type",
            "maxLength":30,
            "type":"string",
            "description":"The source object code for the source object as defined in the object's metadata.",
            "nullable":false
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"The unique identifier of the parent note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code of the note associated with the note. This attribute is used by CRM Extensibility framework. 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 column to store the note text.",
            "format":"byte",
            "nullable":false,
            "x-hints":{
                "protectionKey":"NoteEO.NoteTxt",
                "protectionObjectTitle":"Note",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Note Text"
            }
        },
        "NoteTitle":{
            "title":"Title",
            "maxLength":500,
            "type":"string",
            "description":"The title of the note entered by the user.",
            "nullable":true
        }
    }
}

Nested Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : deals-productGroups-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : deals-products-item-post-request

Type: object

Show Source

• Text: string
  Title: Keyword

  The text or keywords associated with the product.

{
    "type":"object",
    "properties":{
        "Text":{
            "title":"Keyword",
            "type":"string",
            "description":"The text or keywords associated with the product.",
            "nullable":true,
            "x-hints":{
                "operators":[
                ]
            }
        }
    }
}

Nested Schema : deals-smartActions-item-post-request

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The media type of the smart action REST operation.
• DisplayLabel(required): string
  Title: Action Name

  Maximum Length: 256

  The display name of the smart action.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object.
• Href: string
  Title: REST Endpoint

  Maximum Length: 150

  The relative path of the smart action REST resource. The path can include path parameters.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  The client applications that the smart action is associated with.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  Indicates whether an action is designed to operate on multiple object instances selected by an end user.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  The HTTP method of the smart action REST operation.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function for smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates whether the smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  System assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  The object attribute to be updated as a result of using a data entry form. Used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique system assigned identifier of the smart action definition.
• UserActionName(required): string
  Title: Action Name

  Maximum Length: 256

  The unique system assigned smart action name.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  UI navigation metadata striped by app usage.
• UserActionRank: integer (int64)
  Title: Priority

  The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  Title: Smart Action REST Payload Definitions

  If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.
• UserActionURLBinding: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  Binding metadata for a variable in the URL.

{
    "required":[
        "DisplayLabel",
        "UserActionName"
    ],
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the smart suggest is enabled for the action.",
            "nullable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object.",
            "nullable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The media type of the smart action REST operation.",
            "nullable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"Binding metadata for a variable in the URL.",
            "items":{
                "$ref":"#/components/schemas/deals-smartActions-UserActionURLBinding-item-post-request"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an action is designed to operate on multiple object instances selected by an end user.",
            "nullable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"The client applications that the smart action is associated with.",
            "nullable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"UI navigation metadata striped by app usage.",
            "items":{
                "$ref":"#/components/schemas/deals-smartActions-UserActionNavigation-item-post-request"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":150,
            "type":"string",
            "description":"The relative path of the smart action REST resource. The path can include path parameters.",
            "nullable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"The HTTP method of the smart action REST operation.",
            "nullable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The display name of the smart action.",
            "nullable":false
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The unique system assigned smart action name.",
            "nullable":false
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique system assigned identifier of the smart action definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The number defining the relative position of the smart action in the list of smart actions displayed in a client application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"System assigned value indicating whether the smart action is seeded or custom.  True indicates the smart action is seeded.",
            "nullable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":4000,
            "type":"string",
            "description":"The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.",
            "nullable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
            "items":{
                "$ref":"#/components/schemas/deals-smartActions-UserActionRequestPayload-item-post-request"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"The object attribute to be updated as a result of using a data entry form. Used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.",
            "nullable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function for smart action.",
            "nullable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":true
        }
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

UI navigation metadata striped by app usage.

Show Source

• Array of: object deals-smartActions-UserActionNavigation-item-post-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"UI navigation metadata striped by app usage.",
    "items":{
        "$ref":"#/components/schemas/deals-smartActions-UserActionNavigation-item-post-request"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.

Show Source

• Array of: object deals-smartActions-UserActionRequestPayload-item-post-request

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"If an LOV required for constructing a request payload needs to post data, the payload metadata is stored here.",
    "items":{
        "$ref":"#/components/schemas/deals-smartActions-UserActionRequestPayload-item-post-request"
    }
}

Nested Schema : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

Binding metadata for a variable in the URL.

Show Source

• Array of: object deals-smartActions-UserActionURLBinding-item-post-request

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"Binding metadata for a variable in the URL.",
    "items":{
        "$ref":"#/components/schemas/deals-smartActions-UserActionURLBinding-item-post-request"
    }
}

Nested Schema : deals-smartActions-UserActionNavigation-item-post-request

Type: object

Show Source

• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  The metadata definition of the smart action user interface endpoint.
• UserActionNavId: integer (int64)
  Title: Primary Key

  The unique system assigned identifier of a smart action user interface definition.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  The text value used by applications to determine which user interface to launch.

{
    "type":"object",
    "properties":{
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded.  The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action user interface definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"The text value used by applications to determine which user interface to launch.",
            "nullable":false
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"The metadata definition of the smart action user interface endpoint.",
            "nullable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.",
            "nullable":false
        }
    }
}

Nested Schema : deals-smartActions-UserActionRequestPayload-item-post-request

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  Indicates the classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
• RequestPayloadId: integer (int64)
  The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The value assigned to the name property of a name-value pair.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value assigned to the value property of a name-value pair.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"Indicates the classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.",
            "nullable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{\"name\":\"leadId\",\"Value\":\"LeadId\",\"MandatoryFlag\":true,\"Binding\":\"RUNTIME\"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.",
            "nullable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.",
            "nullable":true
        }
    }
}

Nested Schema : deals-smartActions-UserActionURLBinding-item-post-request

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• URLBindingId: integer (int64)
  The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 50

  The value assigned to the name property of a name-value pair.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 80

  The value assigned to the value property of a name-value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.",
            "nullable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":80,
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST path parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded.  The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":50,
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false
        }
    }
}

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

Type: object

Show Source

• AccountPartyNumber: string
  Title: Account Number

  Read Only: true

  Maximum Length: 30

  Public Unique Identifier of Account Party on the Deal Registration
• ApprovalTaskStatusCode: string
  Title: Approval Task Status Code

  Indicates the approval status of the deal registration. The accepted values are: Approve, Reject, Return, and Withdraw.
• ApprovedByPartyName: string
  Title: Approved By

  Read Only: true

  Maximum Length: 255

  The name of the employee resource that approved the deal registration.
• ApprovedDate: string (date)
  Title: Approved Date

  The date and time when the deal registration was approved.
• canApprove: boolean
  Title: Approve Deal Registration

  Read Only: true

  Indicates whether the user is authorised to approve the claim.
• canCopyDeal: boolean
  Title: Copy Deal Registration

  Read Only: true

  Indicates whether the user is authorised to copy the Deal Registration record.
• canReject: boolean
  Title: Reject Deal Registration

  Read Only: true

  Indicates whether the user is authorised to reject the claim.
• canReturn: boolean
  Title: Return Deal Registration

  Read Only: true

  Indicates whether the user is authorised to return the claim.
• canSubmit: boolean
  Title: Submit Deal Registration

  Read Only: true

  Indicates whether the user is authorised to submit the deal.
• canWithdraw: boolean
  Title: Withdraw Deal Registration

  Read Only: true

  Indicates whether the user is authorised to withdraw the claim.
• CloseDate: string (date)
  Title: Close Date

  The date and time when the deal registration is estimated to close.
• CombinedConPrPhone: string
  Title: Contact Phone

  Read Only: true

  Maximum Length: 255

  The formatted contact primary phone number associated with the deal registration.
• ConPrPhoneAreaCode: string
  Title: Contact Primary Phone Area Code

  Maximum Length: 10

  The contact primary phone area code associated with the deal registration.
• ConPrPhoneCountryCode: string
  Title: Contact Primary Phone Country Code

  Maximum Length: 10

  The contact primary phone country code associated with the deal registration.
• ConPrPhoneNumber: string
  Title: Phone

  Maximum Length: 40

  The contact primary phone number associated with the deal registration.
• ContactEmailAddress: string
  Title: Contact Email

  Maximum Length: 320

  The contact email address associated with the deal registration.
• ContactFirstName: string
  Title: Contact First Name

  Maximum Length: 150

  The first name of the contact.
• ContactId: integer (int64)
  Title: Contact ID

  The unique identifier of the contact associated with the deal registration.
• ContactJobTitle: string
  Title: Job Title

  Maximum Length: 100

  The contact job title associated with the deal registration.
• ContactLastName: string
  Title: Contact Last Name

  Maximum Length: 150

  The last name of the contact.
• ContactName: string
  Title: Existing Contact

  Maximum Length: 900

  The name of the contact associated with the deal registration.
• ContactPartyNumber: string
  Title: Contact Number

  Read Only: true

  Maximum Length: 30

  Public Unique Identifier of Contact Party on the Deal Registration
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the deal registration record was created.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 20

  The currency code. This attribute is used by CRM Extensibility framework. 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.
• CustomerFormattedAddress: string
  Title: Customer Address

  The formatted address of the customer.
• CustomerId: integer (int64)
  Title: Customer ID

  The unique identifier of the customer associated with the deal registration.
• CustomerLocationAddrElementAttribute1: string
  Title: Customer Location Address Element Attribute 1

  The account address element attribute 1 associated with the deal registration.
• CustomerLocationAddrElementAttribute2: string
  Title: Customer Location Address Element Attribute 2

  The account address element attribute 2 associated with the deal registration.
• CustomerLocationAddrElementAttribute3: string
  Title: Customer Location Address Element Attribute 3

  The account address element attribute 3 associated with the deal registration.
• CustomerLocationAddrElementAttribute4: string
  Title: Customer Location Address Element Attribute 4

  The account address element attribute 4 associated with the deal registration.
• CustomerLocationAddrElementAttribute5: string
  Title: Customer Location Address Element Attribute 5

  The account address element attribute 5 associated with the deal registration.
• CustomerLocationAddress1: string
  Title: Customer Location Address 1

  The account address line 1 associated with the deal registration.
• CustomerLocationAddress2: string
  Title: Customer Location Address 2

  The account address line 2 associated to the deal registration.
• CustomerLocationAddress3: string
  Title: Customer Location Address 3

  The account address line 3 associated with the deal registration.
• CustomerLocationAddress4: string
  Title: Customer Location Address 4

  The account address line 4 associated with the deal registration.
• CustomerLocationAddressLinesPhonetic: string
  Title: Customer Location Address Lines Phonetic

  The account address phonetic address line associated with the deal registration.
• CustomerLocationBuilding: string
  Title: Location Building

  The account address building associated with the deal registration.
• CustomerLocationCity: string
  Title: Account City

  The account address city associated with the deal registration.
• CustomerLocationCountry: string
  Title: Account Country

  The account address country associated with the deal registration.
• CustomerLocationCounty: string
  Title: Customer Location County

  The account address county associated with the deal registration.
• CustomerLocationFloorNumber: string
  Title: Customer Location Floor Number

  The account address floor number associated with the deal registration.
• CustomerLocationPostalCode: string
  Title: Account Postal Code

  The code indicating the account address postal associated with the deal registration. A list of valid values is defined in the lookup Z_PHONE_COUNTRY_CODES.
• CustomerLocationPostalPlus4Code: string
  Title: Customer Location Postal Plus 4 Code

  The account address postal code plus the four code associated to the deal registration.
• CustomerLocationProvince: string
  Title: Customer Location Province

  The account address province associated with the deal registration.
• CustomerLocationState: string
  Title: Account State

  The account address state associated with the deal registration.
• CustomerName: string
  Title: Existing Account

  Maximum Length: 900

  The name of the customer associated with the deal registration.
• CustomerPartyType: string
  Title: Customer Party Type

  Read Only: true

  Maximum Length: 30

  The party type of the customer associated with the deal registration.
• DealApprovalHistory: array Deal Approval Histories
  Title: Deal Approval Histories

  The deal registration approval history lets you access a comprehensive record of approval-related information associated with the deal, encompassing the names of approvers, action dates, and the specific actions taken.
• DealApprovedBy: string
  Title: Approved By

  The unique identifier of the person who approved the deal registration.
• DealAttachments: array Deal Attachments
  Title: Deal Attachments

  The attachments resource is used to view, create, update, and delete attachments of a deal. An attachment includes additional information about a deal.
• DealContactName: string
  Title: New Contact

  Maximum Length: 360

  The name of the contact associated with the deal registration.
• DealCustomerName: string
  Title: New Account

  Maximum Length: 360

  The name of the customer associated with the deal registration.
• DealExpirationDate: string (date)
  Title: Expiration Date

  The date and time when the deal registration expires.
• DealId: integer (int64)
  Title: Deal ID

  The unique identifier of the deal registration.
• DealName: string
  Title: Name

  Maximum Length: 250

  The name of the deal registration.
• DealNumber: string
  Title: Registration Number

  Maximum Length: 30

  The alternate identifier of the deal registration.
• DealProduct: array Deal Products
  Title: Deal Products

  The deal products resource is used to view, create, update, and delete a deal product. The deal product is a product or product family associated with the deal registration that the customer is interested in.
• DealRejectedBy: string
  Title: Rejected By

  The unique identifier of the person who rejected the deal registration.
• DealRejectedComments: string
  Title: Rejected Comments

  Maximum Length: 250

  The comments added when rejecting a deal registration.
• DealRejectedReasonCode: string
  Title: Rejected Reason

  Maximum Length: 30

  The code indicating the reason for the rejection of a deal. For example, Duplicate, Ineligible Customer, or Ineligible Partner. A list of valid values is defined in the lookup ORA_MKL_DEAL_REJECT_REASON.
• DealResources: array Deal Team Members
  Title: Deal Team Members

  The deal team member resource is used to view, create, update, and delete a deal team member. A deal team member is a resource who is assigned to the deal registration team and who has the appropriate visibility and access to the deal registration record.
• DealReturnComments: string
  Title: Returned Comments

  Maximum Length: 250

  The comments added when returning a deal registration.
• DealReturnedBy: string
  Title: Returned By

  The unique identifier of the person who returned the deal registration.
• DealReturnReasonCode: string
  Title: Returned Reason

  Maximum Length: 30

  The code indicating the reason for the return of a deal registration. For example, Incomplete Customer Information, or Insufficient Quantity. A list of valid values is defined in the lookup ORA_MKL_DEAL_RETURN_REASON.
• DealSize: number
  Title: Deal Size

  The monetary amount that the customer is expected to spend.
• DealSubmittedBy: integer (int64)
  Title: Submitted By

  Read Only: true

  The user who submitted the deal registration.
• DealType: string
  Title: Deal Type

  Maximum Length: 30

  Default Value: ORA_NEW

  The type of deal registration that the partner submits for registration.
• DealWithdrawnBy: string
  Title: Withdrawn By

  The unique identifier of the person who withdrew the deal registration.
• isApproverFlag: boolean
  Read Only: true

  Indicates whether the logged-in user is the approver of the deal registration.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

  The user who last updated the deal registration record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the deal registration record.
• LeadId: integer (int64)
  Title: Lead ID

  The unique identifier of the lead associated with the deal registration.
• LeadName: string
  Title: Lead

  Read Only: true

  Maximum Length: 250

  The name of the lead associated with the deal registration.
• LeadNumber: string
  Title: Lead Number

  Maximum Length: 30

  Public Unique Identifier of Lead associated to the Deal Registration
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManageApprovalDataFlag: boolean
  Read Only: true

  Indicates whether user can modify deal attributes while the deal is awaiting approval.
• ManageGeneralDataFlag: boolean
  Read Only: true

  Indicates whether user can modify deal attributes when the deal is either in draft or returned or withdrawn status.
• ManageOpptyDataFlag: boolean
  Read Only: true

  Indicates whether user can modify deal attributes when the deal is in either pending approval or approved status.
• ManagePartnerDataFlag: boolean
  Read Only: true

  Indicates that partner users are restricted from modifying the partner field. It indicates whether channel users can update the partner field when the deal is in draft, return, or withdrawn status.
• ManageTeamDataFlag: boolean
  Read Only: true

  Indicates whether the logged in user has full access on the Deal record.
• MatchedAccountPartyId: integer (int64)
  Title: Matched Account Party ID

  The identifier of the customer account associated with the deal registration after the completion of the account duplicate check process.
• MatchedAccountPartyNumber: string
  Title: Opportunity Account Number

  Read Only: true

  Maximum Length: 30

  Public Unique Identifier of Matched Account Party on the Deal Registration
• MatchedAccountPartyUniqueName: string
  Title: Opportunity Account

  Read Only: true

  Maximum Length: 900

  The name of the customer account associated with the deal registration after the completion of the customer duplicate check process.
• MatchedContactPartyId: integer (int64)
  Title: Matched Contact Party ID

  The identifier of the contact associated with the deal registration after the completion of the account duplicate check process.
• MatchedContactPartyName: string
  Title: Opportunity Contact

  Read Only: true

  Maximum Length: 360

  The name of the contact associated with the deal registration after the completion of the customer duplicate check process.
• MatchedContactPartyNumber: string
  Title: Opportunity Contact Number

  Read Only: true

  Maximum Length: 30

  Public Unique Identifier of Matched Contact Party on the Deal Registration
• MatchedOpportunity: array Opportunities
  Title: Opportunities

  The opportunity resource is used to view the opportunities associated with a deal registration. An opportunity is used by a sales organization to track information about a potential sale, such as the sales account, key contacts, product interests, and potential revenues. A matched opportunity is an opportunity that matches the deal registration based on the duplicate check process.
• Note: array Notes
  Title: Notes

  The note resource is used to view, create, update, and delete notes associated with a deal. A note captures comments, information, or instructions related to a deal.
• NotesSourceObjectCode: string
  Read Only: true

  The source object code for the source object as defined in the object's metadata.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the opportunity associated with the deal registration.
• OptyName: string
  Title: Opportunity

  Read Only: true

  Maximum Length: 275

  The name of the opportunity associated with the deal registration.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  Public Unique Identifier of Opportunity associated to the Deal Registration
• OwnerId: integer (int64)
  Title: Owner ID

  The unique identifier of the owner of the deal registration.
• OwnerPartyName: string
  Title: Owner

  Maximum Length: 360

  The name of the deal registration owner.
• OwnerPartyNumber: string
  Title: Owner Number

  Read Only: true

  Maximum Length: 30

  Public Unique Identifier of Owner Party on the Deal Registration
• PartnerCompanyNumber: string
  Title: Partner Number

  Maximum Length: 30

  Public Unique Identifier of Partner company associated to the Deal Registration
• PartnerId: integer (int64)
  Title: Partner ID

  The unique identifier of the partner who submits the deal registration.
• PartnerLevel: string
  Title: Partner Level

  Read Only: true

  Maximum Length: 50

  The relative tier of the partner associated with the deal registration.
• PartnerOwnerId: integer (int64)
  Read Only: true

  The unique identifier of the partner owner.
• PartnerOwnerName: string
  Title: Channel Manager

  Read Only: true

  Maximum Length: 450

  The name of the channel manager who owns the partner associated with the deal registration.
• PartnerOwnerPicker: array Partner Owner Picker
  Title: Partner Owner Picker

  The partner owner picker resource is used to create a list of partners that is used to select the partner owner.
• PartnerPartyName: string
  Title: Partner

  Maximum Length: 360

  The name of the deal registration partner.
• PartnerType: string
  Title: Partner Type

  Maximum Length: 30

  The type of the partner who submits the deal registration.
• productGroups: array Product Groups
  Title: Product Groups

  The product group resource is used to view information about related products. A product group is a business object that groups related products so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.
• products: array Products
  Title: Products

  The product resource is used to view product information. A product is an item that an organization or company intends to sell.
• ProgramEnrollmentId: integer (int64)
  Title: Program

  The unique identifier of the partner program enrollment in the context of the deal registration.
• ProgramEnrollmentNumber: string
  Title: Program Number

  Read Only: true

  Maximum Length: 30

  Public Unique Identifier of Partner Program associated to the Deal Registration
• RejectedByPartyName: string
  Title: Rejected By

  Read Only: true

  Maximum Length: 255

  The name of the employee resource that rejected the deal registration.
• RejectedDate: string (date)
  Title: Rejected Date

  The date and time when the deal registration was rejected.
• ReturnedByPartyName: string
  Title: Returned By

  Read Only: true

  Maximum Length: 255

  The name of the employee resource that returned the deal registration.
• ReturnedDate: string (date)
  Title: Returned Date

  The date and time when the deal registration was returned.
• SearchKey: string
  The place holder for any one of the following three attributes: Partner Name, Deal Number, and Account Name.
• smartActions: array Smart Actions
  Title: Smart Actions

  The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  Default Value: ORA_DRAFT

  The status of the deal registration during its life cycle. For example, Draft, Pending Approval, Returned, Approved, Rejected, or Expired. A list of valid values is defined in the lookup ORA_MKL_DEAL_REG_STATUS.
• SubmittedByPartyName: string
  Title: Submitted By

  Read Only: true

  Maximum Length: 360

  The name of the employee resource who submitted the deal registration.
• SubmittedDate: string (date)
  Title: Submitted Date

  Read Only: true

  The date and time when the deal registration was submitted.
• UpdateFlag: boolean
  Read Only: true

  Indicates if the user has access to update the record.
• WithdrawnByPartyName: string
  Title: Withdrawn By

  Read Only: true

  Maximum Length: 255

  The name of the employee resource that withdrew the deal registration.
• WithdrawnDate: string (date)
  Title: Withdrawn Date

  The date and time when the deal registration was withdrawn.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the deal registration record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "isApproverFlag":{
            "type":"boolean",
            "description":"Indicates whether the logged-in user is the approver of the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DealId":{
            "title":"Deal ID",
            "type":"integer",
            "description":"The unique identifier of the deal registration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DealApprovedBy":{
            "title":"Approved By",
            "type":"string",
            "description":"The unique identifier of the person who approved the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "StatusCode"
                ]
            }
        },
        "WithdrawnDate":{
            "title":"Withdrawn Date",
            "type":"string",
            "description":"The date and time when the deal registration was withdrawn.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DealFinalApprDecisionDate",
                    "StatusCode"
                ]
            }
        },
        "OptyName":{
            "title":"Opportunity",
            "maxLength":275,
            "type":"string",
            "description":"The name of the opportunity associated with the deal registration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CloseDate":{
            "title":"Close Date",
            "type":"string",
            "description":"The date and time when the deal registration is estimated to close.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ReturnedByPartyName":{
            "title":"Returned By",
            "maxLength":255,
            "type":"string",
            "description":"The name of the employee resource that returned the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":20,
            "type":"string",
            "description":"The currency code. This attribute is used by CRM Extensibility framework. 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":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SearchKey":{
            "type":"string",
            "description":"The place holder for any one of the following three attributes:  Partner Name, Deal Number, and Account Name.",
            "nullable":true,
            "x-queryable":false
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier of Opportunity associated to the Deal Registration",
            "nullable":false,
            "x-queryable":true
        },
        "SubmittedByPartyName":{
            "title":"Submitted By",
            "maxLength":360,
            "type":"string",
            "description":"The name of the employee resource who submitted the deal registration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the deal registration record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "MatchedAccountPartyNumber":{
            "title":"Opportunity Account Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier of Matched Account Party on the Deal Registration",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the deal registration record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "canCopyDeal":{
            "title":"Copy Deal Registration",
            "type":"boolean",
            "description":"Indicates whether the user is authorised to copy the Deal Registration record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MatchedAccountPartyUniqueName":{
            "title":"Opportunity Account",
            "maxLength":900,
            "type":"string",
            "description":"The name of the customer account associated with the deal registration after the completion of the customer duplicate check process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DealCustomerName":{
            "title":"New Account",
            "maxLength":360,
            "type":"string",
            "description":"The name of the customer associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "LeadNumber":{
            "title":"Lead Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier of Lead associated to the Deal Registration",
            "nullable":false,
            "x-queryable":true
        },
        "CustomerId":{
            "title":"Customer ID",
            "type":"integer",
            "description":"The unique identifier of the customer associated with the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity associated with the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ContactPartyNumber":{
            "title":"Contact Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier of Contact Party on the Deal Registration",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContactLastName":{
            "title":"Contact Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name"
            }
        },
        "DealRejectedReasonCode":{
            "title":"Rejected Reason",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the reason for the rejection of a deal. For example, Duplicate, Ineligible Customer, or Ineligible Partner. A list of valid values is defined in the lookup ORA_MKL_DEAL_REJECT_REASON.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConPrPhoneCountryCode":{
            "title":"Contact Primary Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The contact primary phone country code associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "ConPrPhoneAreaCode":{
            "title":"Contact Primary Phone Area Code",
            "maxLength":10,
            "type":"string",
            "description":"The contact primary phone area code associated with the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            }
        },
        "ManageTeamDataFlag":{
            "type":"boolean",
            "description":"Indicates whether the logged in user has full access on the Deal record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Note":{
            "title":"Notes",
            "type":"array",
            "description":"The note resource is used to view, create, update, and delete notes associated with a deal. A note captures comments, information, or instructions related to a deal.",
            "items":{
                "$ref":"#/components/schemas/deals-Note-item-response"
            }
        },
        "CustomerLocationPostalCode":{
            "title":"Account Postal Code",
            "type":"string",
            "description":"The code indicating the account address postal associated with the deal registration. A list of valid values is defined in the lookup Z_PHONE_COUNTRY_CODES.",
            "nullable":true,
            "x-queryable":true
        },
        "DealAttachments":{
            "title":"Deal Attachments",
            "type":"array",
            "description":"The attachments resource is used to view, create, update, and delete attachments of a deal. An attachment includes additional information about a deal.",
            "items":{
                "$ref":"#/components/schemas/deals-DealAttachments-item-response"
            }
        },
        "productGroups":{
            "title":"Product Groups",
            "type":"array",
            "description":"The product group resource is used to view information about related products. A product group is a business object that groups related products so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.",
            "items":{
                "$ref":"#/components/schemas/deals-productGroups-item-response"
            }
        },
        "PartnerOwnerPicker":{
            "title":"Partner Owner Picker",
            "type":"array",
            "description":"The partner owner picker resource is used to create a list of partners that is used to select the partner owner.",
            "items":{
                "$ref":"#/components/schemas/deals-PartnerOwnerPicker-item-response"
            }
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the deal registration record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ManageApprovalDataFlag":{
            "type":"boolean",
            "description":"Indicates whether user can modify deal attributes while the deal is awaiting approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DealResources":{
            "title":"Deal Team Members",
            "type":"array",
            "description":"The deal team member resource is used to view, create, update, and delete a deal team member. A deal team member is a resource who is assigned to the deal registration team and who has the appropriate visibility and access to the deal registration record.",
            "items":{
                "$ref":"#/components/schemas/deals-DealResources-item-response"
            }
        },
        "NotesSourceObjectCode":{
            "type":"string",
            "description":"The source object code for the source object as defined in the object's metadata.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DealReturnReasonCode":{
            "title":"Returned Reason",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the reason for the return of a deal registration. For example, Incomplete Customer Information, or Insufficient Quantity. A list of valid values is defined in the lookup ORA_MKL_DEAL_RETURN_REASON.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "OwnerPartyNumber":{
            "title":"Owner Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier of Owner Party on the Deal Registration",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerFormattedAddress":{
            "title":"Customer Address",
            "type":"string",
            "description":"The formatted address of the customer.",
            "nullable":true,
            "x-queryable":false
        },
        "DealNumber":{
            "title":"Registration Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate identifier of the deal registration.",
            "nullable":false,
            "x-queryable":true
        },
        "canReturn":{
            "title":"Return Deal Registration",
            "type":"boolean",
            "description":"Indicates whether the user is authorised to return the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WithdrawnByPartyName":{
            "title":"Withdrawn By",
            "maxLength":255,
            "type":"string",
            "description":"The name of the employee resource that withdrew the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CustomerLocationAddrElementAttribute5":{
            "title":"Customer Location Address Element Attribute 5",
            "type":"string",
            "description":"The account address element attribute 5 associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "ConPrPhoneNumber":{
            "title":"Phone",
            "maxLength":40,
            "type":"string",
            "description":"The contact primary phone number associated with the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneNumber",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Phone"
            }
        },
        "CustomerLocationAddrElementAttribute4":{
            "title":"Customer Location Address Element Attribute 4",
            "type":"string",
            "description":"The account address element attribute 4 associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerLocationAddress2":{
            "title":"Customer Location Address 2",
            "type":"string",
            "description":"The account address line 2 associated to the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerLocationAddress1":{
            "title":"Customer Location Address 1",
            "type":"string",
            "description":"The account address line 1 associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerLocationAddress4":{
            "title":"Customer Location Address 4",
            "type":"string",
            "description":"The account address line 4 associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "AccountPartyNumber":{
            "title":"Account Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier of Account Party on the Deal Registration",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerLocationAddress3":{
            "title":"Customer Location Address 3",
            "type":"string",
            "description":"The account address line 3 associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "products":{
            "title":"Products",
            "type":"array",
            "description":"The product resource is used to view product information. A product is an item that an organization or company intends to sell.",
            "items":{
                "$ref":"#/components/schemas/deals-products-item-response"
            }
        },
        "canApprove":{
            "title":"Approve Deal Registration",
            "type":"boolean",
            "description":"Indicates whether the user is authorised to approve the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerId":{
            "title":"Owner ID",
            "type":"integer",
            "description":"The unique identifier of the owner of the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerLocationAddrElementAttribute3":{
            "title":"Customer Location Address Element Attribute 3",
            "type":"string",
            "description":"The account address element attribute 3 associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "DealWithdrawnBy":{
            "title":"Withdrawn By",
            "type":"string",
            "description":"The unique identifier of the person who withdrew the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "StatusCode"
                ]
            }
        },
        "CustomerLocationAddrElementAttribute2":{
            "title":"Customer Location Address Element Attribute 2",
            "type":"string",
            "description":"The account address element attribute 2 associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerLocationAddrElementAttribute1":{
            "title":"Customer Location Address Element Attribute 1",
            "type":"string",
            "description":"The account address element attribute 1 associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "ProgramEnrollmentNumber":{
            "title":"Program Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier of Partner Program associated to the Deal Registration",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerLocationCity":{
            "title":"Account City",
            "type":"string",
            "description":"The account address city associated with the deal registration.",
            "nullable":true,
            "x-queryable":true
        },
        "ContactFirstName":{
            "title":"Contact First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the contact.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonFirstName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"First Name"
            }
        },
        "RejectedByPartyName":{
            "title":"Rejected By",
            "maxLength":255,
            "type":"string",
            "description":"The name of the employee resource that rejected the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CustomerPartyType":{
            "title":"Customer Party Type",
            "maxLength":30,
            "type":"string",
            "description":"The party type of the customer associated with the deal registration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "DealName":{
            "title":"Name",
            "maxLength":250,
            "type":"string",
            "description":"The name of the deal registration.",
            "nullable":true,
            "x-queryable":true
        },
        "PartnerCompanyNumber":{
            "title":"Partner Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier of Partner company associated to the Deal Registration",
            "nullable":false,
            "x-queryable":true
        },
        "ContactName":{
            "title":"Existing Contact",
            "maxLength":900,
            "type":"string",
            "description":"The name of the contact associated with the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the deal registration record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerType":{
            "title":"Partner Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of the partner who submits the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RejectedDate":{
            "title":"Rejected Date",
            "type":"string",
            "description":"The date and time when the deal registration was rejected.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DealFinalApprDecisionDate",
                    "StatusCode"
                ]
            }
        },
        "PartnerOwnerId":{
            "type":"integer",
            "description":"The unique identifier of the partner owner.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "canWithdraw":{
            "title":"Withdraw Deal Registration",
            "type":"boolean",
            "description":"Indicates whether the user is authorised to withdraw the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartnerId":{
            "title":"Partner ID",
            "type":"integer",
            "description":"The unique identifier of the partner who submits the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartnerOwnerName":{
            "title":"Channel Manager",
            "maxLength":450,
            "type":"string",
            "description":"The name of the channel manager who owns the partner associated with the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD",
                "dependencies":[
                    "PartnerId"
                ]
            },
            "x-queryable":true
        },
        "ManageGeneralDataFlag":{
            "type":"boolean",
            "description":"Indicates whether user can modify deal attributes when the deal is either in draft or returned or withdrawn status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the deal registration during its life cycle. For example, Draft, Pending Approval, Returned, Approved, Rejected, or Expired. A list of valid values is defined in the lookup ORA_MKL_DEAL_REG_STATUS.",
            "nullable":true,
            "default":"ORA_DRAFT",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ManagePartnerDataFlag":{
            "type":"boolean",
            "description":"Indicates that partner users are restricted from modifying the partner field. It indicates whether channel users can update the partner field when the deal is in draft, return, or withdrawn status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "smartActions":{
            "title":"Smart Actions",
            "type":"array",
            "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/deals-smartActions-item-response"
            }
        },
        "ManageOpptyDataFlag":{
            "type":"boolean",
            "description":"Indicates whether user can modify deal attributes when the deal is in either pending approval or approved status.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "DealReturnComments":{
            "title":"Returned Comments",
            "maxLength":250,
            "type":"string",
            "description":"The comments added when returning a deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CustomerLocationFloorNumber":{
            "title":"Customer Location Floor Number",
            "type":"string",
            "description":"The account address floor number associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "DealSubmittedBy":{
            "title":"Submitted By",
            "type":"integer",
            "description":"The user who submitted the deal registration.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DealRejectedBy":{
            "title":"Rejected By",
            "type":"string",
            "description":"The unique identifier of the person who rejected the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "StatusCode"
                ]
            }
        },
        "CustomerLocationAddressLinesPhonetic":{
            "title":"Customer Location Address Lines Phonetic",
            "type":"string",
            "description":"The account address phonetic address line associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerLocationCountry":{
            "title":"Account Country",
            "type":"string",
            "description":"The account address country associated with the deal registration.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "DealType":{
            "title":"Deal Type",
            "maxLength":30,
            "type":"string",
            "description":"The type of deal registration that the partner submits for registration.",
            "nullable":true,
            "default":"ORA_NEW",
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ApprovedDate":{
            "title":"Approved Date",
            "type":"string",
            "description":"The date and time when the deal registration was approved.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DealFinalApprDecisionDate",
                    "StatusCode"
                ]
            }
        },
        "OwnerPartyName":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the deal registration owner.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "DealContactName":{
            "title":"New Contact",
            "maxLength":360,
            "type":"string",
            "description":"The name of the contact associated with the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Name",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "DealExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The date and time when the deal registration expires.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "DealProduct":{
            "title":"Deal Products",
            "type":"array",
            "description":"The deal products resource is used to view, create, update, and delete a deal product. The deal product is a product or product family associated with the deal registration that the customer is interested in.",
            "items":{
                "$ref":"#/components/schemas/deals-DealProduct-item-response"
            }
        },
        "ProgramEnrollmentId":{
            "title":"Program",
            "type":"integer",
            "description":"The unique identifier of the partner program enrollment in the context of the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "DealReturnedBy":{
            "title":"Returned By",
            "type":"string",
            "description":"The unique identifier of the person who returned the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "StatusCode"
                ]
            }
        },
        "CustomerLocationCounty":{
            "title":"Customer Location County",
            "type":"string",
            "description":"The account address county associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactId":{
            "title":"Contact ID",
            "type":"integer",
            "description":"The unique identifier of the contact associated with the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "SubmittedDate":{
            "title":"Submitted Date",
            "type":"string",
            "description":"The date and time when the deal registration was submitted.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "DealRejectedComments":{
            "title":"Rejected Comments",
            "maxLength":250,
            "type":"string",
            "description":"The comments added when rejecting a deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "ContactJobTitle":{
            "title":"Job Title",
            "maxLength":100,
            "type":"string",
            "description":"The contact job title associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the user has access to update the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PartnerPartyName":{
            "title":"Partner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the deal registration partner.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ApprovedByPartyName":{
            "title":"Approved By",
            "maxLength":255,
            "type":"string",
            "description":"The name of the employee resource that approved the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MatchedContactPartyId":{
            "title":"Matched Contact Party ID",
            "type":"integer",
            "description":"The identifier of the contact associated with the deal registration after the completion of the account duplicate check process.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LeadId":{
            "title":"Lead ID",
            "type":"integer",
            "description":"The unique identifier of the lead associated with the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CustomerName":{
            "title":"Existing Account",
            "maxLength":900,
            "type":"string",
            "description":"The name of the customer associated with the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "MatchedAccountPartyId":{
            "title":"Matched Account Party ID",
            "type":"integer",
            "description":"The identifier of the customer account associated with the deal registration after the completion of the account duplicate check process.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ReturnedDate":{
            "title":"Returned Date",
            "type":"string",
            "description":"The date and time when the deal registration was returned.",
            "format":"date",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DealFinalApprDecisionDate",
                    "StatusCode"
                ]
            }
        },
        "PartnerLevel":{
            "title":"Partner Level",
            "maxLength":50,
            "type":"string",
            "description":"The relative tier of the partner associated with the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CustomerLocationState":{
            "title":"Account State",
            "type":"string",
            "description":"The account address state associated with the deal registration.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerLocationProvince":{
            "title":"Customer Location Province",
            "type":"string",
            "description":"The account address province associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "MatchedContactPartyNumber":{
            "title":"Opportunity Contact Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier of Matched Contact Party on the Deal Registration",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DealSize":{
            "title":"Deal Size",
            "type":"number",
            "description":"The monetary amount that the customer is expected to spend.",
            "nullable":true,
            "x-queryable":true
        },
        "DealApprovalHistory":{
            "title":"Deal Approval Histories",
            "type":"array",
            "description":"The deal registration approval history lets you access a comprehensive record of approval-related information associated with the deal, encompassing the names of approvers, action dates, and the specific actions taken.",
            "items":{
                "$ref":"#/components/schemas/deals-DealApprovalHistory-item-response"
            }
        },
        "MatchedOpportunity":{
            "title":"Opportunities",
            "type":"array",
            "description":"The opportunity resource is used to view the opportunities associated with a deal registration. An opportunity is used by a sales organization to track information about a potential sale, such as the sales account, key contacts, product interests, and potential revenues. A matched opportunity is an opportunity that matches the deal registration based on the duplicate check process.",
            "items":{
                "$ref":"#/components/schemas/deals-MatchedOpportunity-item-response"
            }
        },
        "canReject":{
            "title":"Reject Deal Registration",
            "type":"boolean",
            "description":"Indicates whether the user is authorised to reject the claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MatchedContactPartyName":{
            "title":"Opportunity Contact",
            "maxLength":360,
            "type":"string",
            "description":"The name of the contact associated with the deal registration after the completion of the customer duplicate check process.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "ContactEmailAddress":{
            "title":"Contact Email",
            "maxLength":320,
            "type":"string",
            "description":"The contact email address associated with the deal registration.",
            "nullable":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ApprovalTaskStatusCode":{
            "title":"Approval Task Status Code",
            "type":"string",
            "description":"Indicates the approval status of the deal registration. The accepted values are: Approve, Reject, Return, and Withdraw.",
            "nullable":true,
            "x-queryable":false
        },
        "CustomerLocationPostalPlus4Code":{
            "title":"Customer Location Postal Plus 4 Code",
            "type":"string",
            "description":"The account address postal code plus the four code associated to the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "CombinedConPrPhone":{
            "title":"Contact Phone",
            "maxLength":255,
            "type":"string",
            "description":"The formatted contact primary phone number associated with the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CustomerLocationBuilding":{
            "title":"Location Building",
            "type":"string",
            "description":"The account address building associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "LeadName":{
            "title":"Lead",
            "maxLength":250,
            "type":"string",
            "description":"The name of the lead associated with the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "canSubmit":{
            "title":"Submit Deal Registration",
            "type":"boolean",
            "description":"Indicates whether the user is authorised to submit the deal.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        }
    }
}

Nested Schema : Deal Approval Histories

Type: array

Title: Deal Approval Histories

The deal registration approval history lets you access a comprehensive record of approval-related information associated with the deal, encompassing the names of approvers, action dates, and the specific actions taken.

Show Source

• Array of: object deals-DealApprovalHistory-item-response

{
    "title":"Deal Approval Histories",
    "type":"array",
    "description":"The deal registration approval history lets you access a comprehensive record of approval-related information associated with the deal, encompassing the names of approvers, action dates, and the specific actions taken.",
    "items":{
        "$ref":"#/components/schemas/deals-DealApprovalHistory-item-response"
    }
}

Nested Schema : Deal Attachments

Type: array

Title: Deal Attachments

The attachments resource is used to view, create, update, and delete attachments of a deal. An attachment includes additional information about a deal.

Show Source

• Array of: object deals-DealAttachments-item-response

{
    "title":"Deal Attachments",
    "type":"array",
    "description":"The attachments resource is used to view, create, update, and delete attachments of a deal. An attachment includes additional information about a deal.",
    "items":{
        "$ref":"#/components/schemas/deals-DealAttachments-item-response"
    }
}

Nested Schema : Deal Products

Type: array

Title: Deal Products

The deal products resource is used to view, create, update, and delete a deal product. The deal product is a product or product family associated with the deal registration that the customer is interested in.

Show Source

• Array of: object deals-DealProduct-item-response

{
    "title":"Deal Products",
    "type":"array",
    "description":"The deal products resource is used to view, create, update, and delete a deal product. The deal product is a product or product family associated with the deal registration that the customer is interested in.",
    "items":{
        "$ref":"#/components/schemas/deals-DealProduct-item-response"
    }
}

Nested Schema : Deal Team Members

Type: array

Title: Deal Team Members

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

Show Source

• Array of: object deals-DealResources-item-response

{
    "title":"Deal Team Members",
    "type":"array",
    "description":"The deal team member resource is used to view, create, update, and delete a deal team member. A deal team member is a resource who is assigned to the deal registration team and who has the appropriate visibility and access to the deal registration record.",
    "items":{
        "$ref":"#/components/schemas/deals-DealResources-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 : Opportunities

Type: array

Title: Opportunities

The opportunity resource is used to view the opportunities associated with a deal registration. An opportunity is used by a sales organization to track information about a potential sale, such as the sales account, key contacts, product interests, and potential revenues. A matched opportunity is an opportunity that matches the deal registration based on the duplicate check process.

Show Source

• Array of: object deals-MatchedOpportunity-item-response

{
    "title":"Opportunities",
    "type":"array",
    "description":"The opportunity resource is used to view the opportunities associated with a deal registration. An opportunity is used by a sales organization to track information about a potential sale, such as the sales account, key contacts, product interests, and potential revenues. A matched opportunity is an opportunity that matches the deal registration based on the duplicate check process.",
    "items":{
        "$ref":"#/components/schemas/deals-MatchedOpportunity-item-response"
    }
}

Nested Schema : Notes

Type: array

Title: Notes

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

Show Source

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

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

Nested Schema : Partner Owner Picker

Type: array

Title: Partner Owner Picker

The partner owner picker resource is used to create a list of partners that is used to select the partner owner.

Show Source

• Array of: object deals-PartnerOwnerPicker-item-response

{
    "title":"Partner Owner Picker",
    "type":"array",
    "description":"The partner owner picker resource is used to create a list of partners that is used to select the partner owner.",
    "items":{
        "$ref":"#/components/schemas/deals-PartnerOwnerPicker-item-response"
    }
}

Nested Schema : Product Groups

Type: array

Title: Product Groups

The product group resource is used to view information about related products. A product group is a business object that groups related products so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.

Show Source

• Array of: object deals-productGroups-item-response

{
    "title":"Product Groups",
    "type":"array",
    "description":"The product group resource is used to view information about related products. A product group is a business object that groups related products so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.",
    "items":{
        "$ref":"#/components/schemas/deals-productGroups-item-response"
    }
}

Nested Schema : Products

Type: array

Title: Products

The product resource is used to view product information. A product is an item that an organization or company intends to sell.

Show Source

• Array of: object deals-products-item-response

{
    "title":"Products",
    "type":"array",
    "description":"The product resource is used to view product information. A product is an item that an organization or company intends to sell.",
    "items":{
        "$ref":"#/components/schemas/deals-products-item-response"
    }
}

Nested Schema : Smart Actions

Type: array

Title: Smart Actions

The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object deals-smartActions-item-response

{
    "title":"Smart Actions",
    "type":"array",
    "description":"The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/deals-smartActions-item-response"
    }
}

Nested Schema : deals-DealApprovalHistory-item-response

Type: object

Show Source

• ActionBy: string
  Read Only: true

  Maximum Length: 255

  User name of the user who has taken the action.
• ActionByDisplay: string
  Read Only: true

  Maximum Length: 255

  Party name of the user who has taken the action.
• ActionCode: string
  Read Only: true

  Maximum Length: 255

  Action taken by the user. This will be non-translatable value.
• ActionDate: string (date-time)
  Read Only: true

  Date when the action was taken.
• Assignee: string
  Read Only: true

  Maximum Length: 255

  User name of the user to whom deal is assigned.
• AssigneeDisplayName: string
  Read Only: true

  Maximum Length: 255

  Party name of the user to whom the deal is assigned.
• AssigneeType: string
  Read Only: true

  Maximum Length: 255

  Type of assignee. It can be a user or a role.
• CommentText: string
  Read Only: true

  Maximum Length: 255

  Comments provided by the user for each action taken. For submit action there won't be any comments.
• IdentificationKey: string
  Read Only: true

  Maximum Length: 255

  The unique identifier for which approval history records needs to be shown.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ReasonDisplay: string
  Read Only: true

  Maximum Length: 255

  Reason provided by the user for any action taken. This is displayed only when the deal is either rejected or returned.
• Version: string
  Read Only: true

  Maximum Length: 255

  Version of each row of approval history.
• VersionKey: string
  Read Only: true

  Maximum Length: 255

  The primary key identifier of the approval history.

{
    "type":"object",
    "properties":{
        "ReasonDisplay":{
            "maxLength":255,
            "type":"string",
            "description":"Reason provided by the user for any action taken. This is displayed only when the deal is either rejected or returned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeDisplayName":{
            "maxLength":255,
            "type":"string",
            "description":"Party name of the user to whom the deal is assigned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Assignee":{
            "maxLength":255,
            "type":"string",
            "description":"User name of the user to whom deal is assigned.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CommentText":{
            "maxLength":255,
            "type":"string",
            "description":"Comments provided by the user for each action taken. For submit action there won't be any comments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":255,
            "type":"string",
            "description":"Action taken by the user. This will be non-translatable value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionByDisplay":{
            "maxLength":255,
            "type":"string",
            "description":"Party name of the user who has taken the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IdentificationKey":{
            "maxLength":255,
            "type":"string",
            "description":"The unique identifier for which approval history records needs to be shown.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionBy":{
            "maxLength":255,
            "type":"string",
            "description":"User name of the user who has taken the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionDate":{
            "type":"string",
            "description":"Date when the action was taken.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeType":{
            "maxLength":255,
            "type":"string",
            "description":"Type of assignee. It can be a user or a role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Version":{
            "maxLength":255,
            "type":"string",
            "description":"Version of each row of approval history.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "VersionKey":{
            "maxLength":255,
            "type":"string",
            "description":"The primary key identifier of the approval history.",
            "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 : 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 : deals-DealAttachments-item-response

Type: object

Show Source

• AsyncTrackerId: string
  Title: Asynchronous Upload Tracker Id

  The unique identifier used for tracking the uploaded files.
• AttachedDocumentId: integer (int64)
  Title: Attached Document Id

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

  Maximum Length: 30

  The name of 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 attachment.
• 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 attachment record was created.
• DatatypeCode: string
  Title: Type

  Maximum Length: 30

  Default Value: FILE

  The code indicating the type of attachment. For example, File, URL, and so on.
• Description: string
  Title: Description

  Maximum Length: 255

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

  The unique document ID of the attachment.
• DmFolderPath: string
  Title: Dm Folder Path

  Maximum Length: 1000

  The folder path of the attachment.
• DmVersionNumber: string
  Maximum Length: 255

  The current version number of the attachment.
• 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 code indicating the type of error, 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 date when the contents in the attachment expire.
• 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 URL of the attachment.
• 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 length of the attachment file.
• UploadedFileName: string
  Title: Uploaded File Name

  The name of the attachment file.
• UploadedText: string
  Title: Uploaded Text

  The text of the attachment.
• Uri: string
  Title: Uri

  Maximum Length: 4000

  The URI of the attachment.
• Url: string
  Title: Url

  Maximum Length: 4000

  The URL of the attachment.
• UserName: string
  Title: User Name

  Read Only: true

  Maximum Length: 255

  The login associated with the attachment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the attachment 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 the 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 the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The unique document ID of the attachment.",
            "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 length 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 current version number of the attachment.",
            "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 associated with 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 attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the type of attachment. For example, File, URL, and so on.",
            "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 of the 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 URL of the attachment.",
            "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 date when the contents in the attachment expire.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The code indicating the type of error, 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 of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text of the 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 name of 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":"The unique identifier used for tracking the uploaded 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 : deals-DealProduct-item-response

Type: object

Show Source

• Amount: number
  Title: Amount

  The amount associated with the product line. The amount equals quantity times the registered price.
• ConvCurrencyCode: string
  Maximum Length: 15

  The currency code to which the currency on the deal registration must be converted to. For example, the corporate currency code.
• ConvExchangeRate: number
  The exchange rate for converting the entered currency to the standard CRM corporate currency.
• ConvRateType: string
  Maximum Length: 30

  The currency conversion rate type used to derive the exchange rate between the user entered currency and the CRM corporate currency code associated with the deal registration.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the deal product record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the deal product record was created.
• CurrencyCode: string
  Maximum Length: 15

  The currency code. This attribute is used by CRM Extensibility framework. 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.
• DealId: integer (int64)
  The unique identifier of the parent deal registration.
• DealNumber: string
  Title: Registration Number

  Maximum Length: 30

  The alternate unique identifier of the deal registration.
• DealProdId: integer (int64)
  The unique identifier of the deal registration product.
• DealProdNumber: string
  Maximum Length: 30

  The alternate unique identifier of the deal registration product.
• InventoryItemId: integer (int64)
  The unique identifier of the product inventory item associated with the deal registration.
• InvOrgId: integer (int64)
  The unique identifier of the inventory organization.
• ItemDescription: string
  Title: Long Description

  Read Only: true

  Maximum Length: 4000

  The description of the product associated with the deal registration.
• ItemName: string
  Title: Item Description

  Maximum Length: 240

  The name of the product associated with the deal registration.
• ItemNumber: string
  Title: Item Number

  Read Only: true

  Maximum Length: 300

  Public Unique Identifier for Item in Deal Registration
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the deal product record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the deal product record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

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

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

  Read Only: true

  Maximum Length: 1000

  The description of the product group associated with the deal registration.
• ProductGroupId: integer (int64)
  The unique identifier of the product group associated with the deal registration.
• ProductGroupName: string
  Title: Name

  Maximum Length: 250

  The name of the product group associated with the deal registration.
• ProductGroupNumber: string
  Title: Product Group Number

  Maximum Length: 50

  Public Unique Identifier for Product Group in Deal Registration
• ProductType: string
  Title: Type

  The product line type, such as product or product group.
• Quantity: number
  Title: Quantity

  The quantity of the product or product group.
• RegisteredPrice: number
  Title: Registered Price

  The registered price of the product.
• UOMCode: string
  Title: UOM

  Maximum Length: 3

  The unit of measure of the product quantity.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the deal product record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DealId":{
            "type":"integer",
            "description":"The unique identifier of the parent deal registration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InvOrgId":{
            "type":"integer",
            "description":"The unique identifier of the inventory organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DealNumber":{
            "title":"Registration Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the deal registration.",
            "nullable":false,
            "x-queryable":true
        },
        "ProductGroupDescription":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The description of the product group associated with the deal registration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DealProdId":{
            "type":"integer",
            "description":"The unique identifier of the deal registration product.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductGroupName":{
            "title":"Name",
            "maxLength":250,
            "type":"string",
            "description":"The name of the product group associated with the deal registration.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Long Description",
            "maxLength":4000,
            "type":"string",
            "description":"The description of the product associated with the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DealProdNumber":{
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the deal registration product.",
            "nullable":false,
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code. This attribute is used by CRM Extensibility framework. 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":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":300,
            "type":"string",
            "description":"Public Unique Identifier for Item in Deal Registration",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConvExchangeRate":{
            "type":"number",
            "description":"The exchange rate for converting the entered currency to the standard CRM corporate currency.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemName":{
            "title":"Item Description",
            "maxLength":240,
            "type":"string",
            "description":"The name of the product associated with the deal registration.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"The unit of measure of the product quantity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the deal product record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group associated with the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ConvCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"The currency code to which the currency on the deal registration must be converted to. For example, the corporate currency code.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the deal product record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Amount":{
            "title":"Amount",
            "type":"number",
            "description":"The amount associated with the product line. The amount equals quantity times the registered price.",
            "nullable":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the product inventory item associated with the deal registration.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProductType":{
            "title":"Type",
            "type":"string",
            "description":"The product line type, such as product or product group.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConvRateType":{
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type used to derive the exchange rate between the user entered currency and the CRM corporate currency code associated with the deal registration.",
            "nullable":true,
            "x-queryable":true
        },
        "Quantity":{
            "title":"Quantity",
            "type":"number",
            "description":"The quantity of the product or product group.",
            "nullable":true,
            "x-queryable":true
        },
        "RegisteredPrice":{
            "title":"Registered Price",
            "type":"number",
            "description":"The registered price of the product.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupNumber":{
            "title":"Product Group Number",
            "maxLength":50,
            "type":"string",
            "description":"Public Unique Identifier for Product Group in Deal Registration",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the deal product record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the deal product 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 : deals-DealResources-item-response

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Maximum Length: 30

  The code indicating the access level of the deal team member. For example, View Only,Edit, or Full. A list of valid values is defined in the lookup ORA_MKL_DEAL_ACCESS_LEVEL.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the deal team member record.
• CreationDate: string (date-time)
  Read Only: true

  The date and time when the deal team member record was created.
• DealId: integer (int64)
  The unique identifier of the deal registration.
• DealNumber: string
  Title: Registration Number

  Maximum Length: 30

  Public Unique Identifier of Deal Registration on the Deal Resource Team
• DealResourceId: integer (int64)
  The unique identifier of the deal team member.
• EmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

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

  Read Only: true

  The phone number of the deal team member associated with the deal registration.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date and time when the deal team member record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the deal team member record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

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

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

  Maximum Length: 30

  The code indicating the function of a deal team member. For example, Channel Manager, engineering Owner, Executive Sponsor, Primary Salesperson, Product Specialist, Support Account manager, Technical Account Manager, Technical Marketing Manager, or Technical Specialist. A list of valid values is defined in the lookup ZCA_RESOURCE_FUNCTION.
• OwnerFlag: boolean
  Title: Owner

  Indicates whether the deal team member is the owner of the deal registration.
• PartnerOrgId: integer (int64)
  The unique identifier of the partner organization.
• ResourceId: integer (int64)
  The unique identifier of the employee resource.
• ResourceName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the deal team member associated with the deal registration.
• ResourcePartyNumber: string
  Title: Resource Number

  Read Only: true

  Maximum Length: 30

  Public Unique Identifier of Resource Party on the Deal Resource Team
• ResourceUsername: string
  Title: User Name

  The login username of the deal team member associated with the deal registration.
• RoleName: string
  Read Only: true

  Maximum Length: 255

  The login username of the deal team member associated with the deal registration.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the deal team member record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date and time when the deal team member record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DealId":{
            "type":"integer",
            "description":"The unique identifier of the deal registration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the deal team member record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the access level of the deal team member. For example, View Only,Edit, or Full. A list of valid values is defined in the lookup ORA_MKL_DEAL_ACCESS_LEVEL.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the deal team member associated with the deal registration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DealNumber":{
            "title":"Registration Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier of Deal Registration on the Deal Resource Team",
            "nullable":false,
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the deal team member is the owner of the deal registration.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "ResourceId"
                ]
            }
        },
        "ResourceUsername":{
            "title":"User Name",
            "type":"string",
            "description":"The login username of the deal team member associated with the deal registration.",
            "nullable":true,
            "x-queryable":false
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address of the deal team member associated with the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "RoleName":{
            "maxLength":255,
            "type":"string",
            "description":"The login username of the deal team member associated with the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceId":{
            "type":"integer",
            "description":"The unique identifier of the employee resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DealResourceId":{
            "type":"integer",
            "description":"The unique identifier of the deal team member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Resource Number",
            "maxLength":30,
            "type":"string",
            "description":"Public Unique Identifier of Resource Party on the Deal Resource Team",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartnerOrgId":{
            "type":"integer",
            "description":"The unique identifier of the partner organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the function of a deal team member. For example, Channel Manager, engineering Owner, Executive Sponsor, Primary Salesperson, Product Specialist, Support Account manager, Technical Account Manager, Technical Marketing Manager, or Technical Specialist. A list of valid values is defined in the lookup ZCA_RESOURCE_FUNCTION.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the deal team member associated with the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PrimaryPhoneCountryCode",
                    "PrimaryPhoneAreaCode",
                    "PrimaryPhoneNumber",
                    "PrimaryPhoneExtension",
                    "PrimaryPhoneLineType",
                    "PrimaryPhonePurpose",
                    "PrimaryPhoneContactPtId"
                ]
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date and time when the deal team member record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the deal team member 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 : deals-MatchedOpportunity-item-response

Type: object

Show Source

• AccountPartyNumber: string
  Title: Account Number

  Read Only: true

  Maximum Length: 30

  The party number of the account associated with the matched opportunity.
• AssetId: integer (int64)
  The unique identifier of the asset associated with the opportunity.
• AssetNumber: string
  Title: Asset Number

  Maximum Length: 100

  The alternate key identifier of the asset associated with the opportunity.
• AssetProduct: string
  Title: Asset

  The asset product associated with the opportunity.
• AssetSerialNumber: string
  Title: Asset Serial Number

  Read Only: true

  Maximum Length: 100

  The asset serial number associated with the opportunity.
• AssignmentMode: string
  Title: Assignment Mode

  Maximum Length: 30

  Specifies the types of assignment mode options available for controlling auto assignment default behavior for opportunity record updates.
• AverageDaysAtStage: integer (int64)
  Title: Duration

  Read Only: true

  The average duration, in number of days, that the opportunity remains in the current sales stage.
• BatchTag: string
  Title: Batch Tag

  Maximum Length: 30

  The batch tag of the opportunity.
• BdgtAmount: number
  Title: Budget Amount

  Budget amount from the sales account.
• BdgtAmtCurcyCd: string
  Title: Budget Amount Currency

  Maximum Length: 15

  The currency code for budget amount from the sales account.
• BudgetAvailableDate: string (date)
  Title: Date Budget Available

  The date and time when the opportunity budget was made available.
• BudgetedFlag: boolean
  Title: Budgeted

  Maximum Length: 1

  Default Value: false

  Indicates if the opportunity sales account has the budget approved for the potential purchase. If the value is true, then the sales account has the budget approved for the purchase. The default value is False.
• ChampionFlag: boolean
  Title: Key Internal Sponsor

  Maximum Length: 1

  Default Value: false

  Indicates if the opportunity has an internal sponsor. If the value is true, then the opportunity has an internal sponsor. The default value is False.
• ClosePeriod: string
  Title: Close Period

  Read Only: true

  The close period of the opportunity.
• Comments: string
  Title: Comments

  Maximum Length: 2000

  The user-provided comments for the opportunity.
• ConflictId: integer (int64)
  Title: Conflict ID

  Default Value: 0

  Disconnected Mobile: this value is used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server).
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

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

  Read Only: true

  The date and time when the opportunity record was created.
• CrmConversionRate: number
  Title: Conversion Rate

  This rate is used for the conversion of the revenue amount to the CRM common currency to facilitate the computation of the revenue forecast metrics. This is the amount that one currency can be exchanged for, at a specific point of time.
• CrmCurrencyCode: string
  Title: CRM Common Currency

  Read Only: true

  Maximum Length: 15

  CRM common currency code.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code of the matched opportunity. This attribute is used by CRM Extensibility framework. 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.
• CustomerAccountId: integer (int64)
  Title: Billing Account

  The unique identifier of the customer billing account associated with the opportunity.
• DealHorizonCode: string
  Title: Estimated Deal Duration

  Maximum Length: 30

  The estimated time, in days, required to close the deal. A list of valid values is defined in the lookup MOO_SETID_DEAL_HORIZION. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• DecisionLevelCode: string
  Title: Decision Level

  Maximum Length: 30

  The job level of the person who takes the final decision for the opportunity. A list of valid values is defined in the lookup MOO_SETID_DECISION_LEVEL. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• DeleteFlag: boolean
  Read Only: true

  Indicates whether the opportunity can be deleted.
• Description: string
  Title: Sales Objective

  Maximum Length: 2000

  The description of the opportunity, including the sales objective.
• DescriptionText: string
  Title: Description

  Read Only: true

  Maximum Length: 255

  The description of the sales objective of the opportunity.
• DownsideAmount: number
  Title: Worst Case

  Default Value: 0

  The minimum amount of revenue for the opportunity.
• EffectiveDate: string (date)
  Title: Close Date

  The date and time when the opportunity was closed.
• EmailAddress: string
  Title: Owner Email

  Read Only: true

  Maximum Length: 320

  The e-mail address of the employee resource that owns the opportunity.
• ExpectAmount: number
  Title: Expected Revenue

  Default Value: 0

  The expected revenue from the opportunity.
• ForecastCategory: string
  Title: Forecast Category

  Maximum Length: 30

  Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely and so on.
• ForecastOverrideCode: string
  Title: Include in Forecast

  Maximum Length: 30

  The code that indicates if the revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.
• HintCode: string
  Title: Hint Code

  Read Only: true

  Maximum Length: 10

  AI hint code.
• IBAssetId: integer (int64)
  Title: Installed Base Asset

  Identifier of the installed base asset of the opportunity.
• IBAssetNumber: string
  Title: Installed Base Asset Number

  Read Only: true

  Maximum Length: 80

  Asset number of the installed base asset of the opportunity.
• IBAssetSerialNumber: string
  Title: Installed Base Asset Serial Number

  Read Only: true

  Maximum Length: 80

  The associated installed base Asset's Serial number
• KeyContactId: integer (int64)
  Title: Primary Contact

  The unique identifier of the primary contact associated with the opportunity.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

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

  Read Only: true

  Maximum Length: 64

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

  Maximum Length: 32

  The login of the user who last updated the opportunity record.
• LineOfBusinessCode: string
  Title: Line of Business

  Maximum Length: 30

  The code indicating which line of business owns the opportunity.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LookupCategory: string
  Title: Status Category

  Read Only: true

  Maximum Length: 30

  The status category of the opportunity status.
• ManageGeneralProfileDataFlag: boolean
  Title: Manage General Profile Data

  Read Only: true

  Allows management of general opportunity information such as competitors, lead, source, contacts, references, interactions, and assessments.
• ManageRestrictedProfileDataFlag: boolean
  Title: Manage Restricted Profile Data

  Read Only: true

  Allows management of restricted opportunity information such as sales method, sales stage, sales account, primary contact, and partners.
• ManageRevenueDataFlag: boolean
  Title: Manage Revenue Data

  Read Only: true

  Allows management of revenue data, such as products and recurring revenue information.
• ManageTeamDataFlag: boolean
  Title: Manage Team Data

  Read Only: true

  Allows management of opportunity sales team data.
• MaximumDaysInStage: integer (int64)
  Title: Stalled Deal Limit

  Read Only: true

  The maximum duration, in number of days, that the opportunity can remain in the sales stage before it is considered stalled.
• Name: string
  Title: Name

  Maximum Length: 275

  The name of the opportunity.
• OpportunityOrigin: string
  Title: Opportunity Origin

  Maximum Length: 30

  Default Value: SALES_OPTY

  The value for the origin of the opportunity.
• OpportunityTypeCode: string
  Title: Opportunity Type

  Maximum Length: 30

  Display the different types of opportunity such as new, renewal and expansion.
• OptyCreatedBy: string
  Title: Opportunity Created By

  Maximum Length: 64

  The user who created the opportunity.
• OptyCreationDate: string (date-time)
  Title: Opportunity Creation Date

  The date and time when the opportunity was created.
• OptyId: integer (int64)
  Title: Opportunity ID

  The unique identifier of the opportunity.
• OptyLastUpdateDate: string (date-time)
  Title: Opportunity Last Updated Date

  The date when the opportunity was last updated.
• OptyLastUpdatedBy: string
  Title: Opportunity Last Updated By

  Maximum Length: 64

  The user who last updated the opportunity.
• OptyNumber: string
  Title: Opportunity Number

  Maximum Length: 30

  The unique alternate identifier for the opportunity.
• OwnerPartyNumber: string
  Title: Owner Number

  Read Only: true

  Maximum Length: 30

  The owner party number of the opportunity.
• OwnerResourcePartyId: integer (int64)
  Title: Owner

  The unique identifier of a valid employee resource who owns and manages the opportunity.
• PartyName1: string
  Title: Owner

  Read Only: true

  Maximum Length: 360

  The name of the opportunity owner.
• PartyUniqueName1: string
  Title: Primary Competitor

  Read Only: true

  Maximum Length: 900

  The unique name of the primary competitor for the opportunity.
• PhaseCd: string
  Title: Phase

  Read Only: true

  Maximum Length: 30

  Default Value: "B - Working the Deal"

  The code indicating the current phase of the opportunity sales stage.
• PredWinProb: number
  Title: Predicted Win Probability

  Read Only: true

  AI predicted win probability percent.
• PrimaryCampaignId: integer (int64)
  Title: Primary Campaign ID

  The unique identifier of the primary campaign associated with the matched opportunity.
• PrimaryCampaignName: string
  Title: Primary Campaign

  The name of the primary campaign associated with the matched opportunity.
• PrimaryCampaignNumber: string
  Title: Primary Campaign Number

  Maximum Length: 30

  The alternate unique identifier of the primary campaign associated with the matched opportunity.
• PrimaryCompetitorId: integer (int64)
  Title: Primary Competitor

  The unique identifier of the primary competitor associated with the opportunity.
• PrimaryCompetitorPartyNumber: string
  Title: Primary Competitor Party Number

  Read Only: true

  Maximum Length: 30

  The party number of the primary competitor associated with the opportunity.
• PrimaryContactEmailAddress: string
  Title: Primary Contact Email

  Read Only: true

  Maximum Length: 320

  The e-mail address of the primary contact associated with the opportunity.
• PrimaryContactEmailPref: string
  Title: Primary Contact Email Preference

  Read Only: true

  Maximum Length: 255

  Indicates if the primary contact has an email preference of do not email, ok to email, or no value.
• PrimaryContactFormattedPhoneNumber: string
  Title: Primary Contact Phone

  Read Only: true

  The phone number of the primary contact associated with the opportunity.
• PrimaryContactPartyName: string
  Title: Primary Contact

  Read Only: true

  Maximum Length: 360

  The name of the primary contact associated with the opportunity.
• PrimaryContactPartyNumber: string
  Title: Primary Contact Party Number

  Read Only: true

  Maximum Length: 30

  The party number of the primary contact associated with the opportunity.
• PrimaryContactPhonePref: string
  Title: Primary Contact Phone Preference

  Read Only: true

  Maximum Length: 255

  Indicates if the primary contact has a phone preference of do not call, ok to call, or no value.
• PrimaryOrganizationId: integer (int64)
  Title: Business Unit ID

  The unique identifier of the business unit associated with the opportunity.
• PrimaryPartnerCompanyNumber: string
  Title: Primary Partner Number

  Maximum Length: 30

  The party number of the primary partner associated with the opportunity.
• PrimaryPartnerId: integer (int64)
  Title: Primary Partner

  The unique identifier of the primary partner associated with the opportunity.
• PrimaryPartnerOrgPartyName: string
  Title: Primary Partner

  Maximum Length: 360

  The organization party name of the primary partner associated with the opportunity.
• PrimaryRevenueId: integer (int64)
  Title: Summary Revenue Line ID

  The unique identifier of the summary revenue line associated with the opportunity.
• PrimarySubscriptionId: integer (int64)
  Title: Primary Subscription Id

  The unique identifier of the primary subscription of the opportunity.
• PrimarySubscriptionNumber: string
  Title: Subscription Number

  Read Only: true

  Maximum Length: 120

  The alternate identifier of primary subscription of the opportunity.
• PrSrcNumber: string
  Title: Primary Source Number

  Maximum Length: 100

  The unique identifier of the primary marketing source or campaign that generated the opportunity.
• QuotaFactor: number
  Title: Quota Factor

  Read Only: true

  The quota factor of the opportunity sales stage.
• QuotedFlag: boolean
  Title: Quoted

  Maximum Length: 1

  Default Value: false

  Indicates that a quote has been created for this Opportunity.
• RcmndWinProb: number
  Title: Win Probability

  Read Only: true

  Default Value: 0

  The recommended probability of winning the opportunity in the sales stage.
• ReasonWonLostCode: string
  Title: Win/Loss Reason

  Maximum Length: 30

  The reason for winning or losing the opportunity. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• RecommendedAction: string
  Title: Recommended Action

  Read Only: true

  Maximum Length: 180

  AI recommended action.
• RecordSet: string
  Read Only: true

  The record set of the opportunity.
• Registered: string
  Title: Registered

  Maximum Length: 30

  Indicates whether the opportunity was registered. The valid values are Expired, Yes, and No.
• RegistrationStatus: string
  Title: Registration Status

  Maximum Length: 30

  The registration status of the opportunity.
• RegistrationType: string
  Title: Registration Type

  Maximum Length: 30

  The registration type used by the partner to create the opportunity.
• RenewalProcess: string
  Title: Renewal Process

  Maximum Length: 30

  The renewal process can be manual, do not renew or automatic renewal.
• Revenue: number
  Title: Amount

  Default Value: 0

  The revenue amount of the opportunity.
• RiskLevelCode: string
  Title: Level of Risk

  Maximum Length: 30

  The risk level code of the opportunity. A list of valid values is defined in the lookup MOO_SETID_RISK_LEVE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• SalesAccountUniqueName: string
  Title: Customer Account

  Read Only: true

  Maximum Length: 900

  The unique name of the sales account that owns the opportunity.
• SalesChannelCd: string
  Title: Sales Channel

  Maximum Length: 50

  The code indicating the sales channel for the opportunity.
• SalesMethod: string
  Title: Sales Method

  Read Only: true

  Maximum Length: 50

  The sales method associated with the opportunity.
• SalesMethodId: integer (int64)
  Title: Sales Method

  The unique identifier of the sales method associated with the opportunity.
• SalesStage: string
  Title: Sales Stage

  Read Only: true

  Maximum Length: 50

  The current sales stage of the opportunity.
• SalesStageId: integer (int64)
  Title: Sales Stage

  The unique identifier of the sales stage associated with the opportunity.
• Selected: boolean
  Indicates if the matched opportunity is selected.
• SetupRefCode: string
  Maximum Length: 80

  The public unique identifier for the CPQ configuration setup.
• SourceType: string
  Title: Source Type

  Read Only: true

  The source type of the opportunity.
• StageStatusCd: string
  Title: Status

  Read Only: true

  Maximum Length: 30

  Default Value: "Open"

  The code indicating the default status of the sales stage associated with the opportunity.
• StatusCode: string
  Title: Status

  Maximum Length: 30

  The status of the opportunity. A list of valid values is defined in the lookup MOO_OPTY_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• StgOrder: number
  Title: Order

  Read Only: true

  The order of the opportunity's sales stage in the sales method.
• StrategicLevelCode: string
  Title: Strategic Value

  Maximum Length: 30

  The strategic value that the opportunity has for the sales account. A list of valid values is defined in the lookup MOO_SETID_STRATEGIC_VALUE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.
• TargetPartyId: integer (int64)
  Title: Account

  The unique identifier of the sales account associated with the opportunity.
• TargetPartyName: string
  Title: Account

  Read Only: true

  Maximum Length: 360

  The name of the sales account associated with the opportunity.
• TargetPartyPrimaryAddressCountry: string
  Title: Account Country

  Read Only: true

  Maximum Length: 2

  Country of the primary account's primary address.
• UpdateFlag: boolean
  Read Only: true

  Indicates whether the opportunity can be updated.
• UpsideAmount: number
  Title: Best Case

  Default Value: 0

  The maximum amount of revenue for the opportunity.
• WinProb: integer (int32)
  Title: Win Probability

  The estimated probability of winning the opportunity.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the opportunity record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OptyLastUpdateDate":{
            "title":"Opportunity Last Updated Date",
            "type":"string",
            "description":"The date when the opportunity was last updated.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ConflictId":{
            "title":"Conflict ID",
            "type":"integer",
            "description":"Disconnected Mobile: this value is used to guarantee the uniqueness of the row when duplicates are created in different databases (i.e. mobile databases or the server).",
            "format":"int64",
            "nullable":false,
            "default":0,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "QuotaFactor":{
            "title":"Quota Factor",
            "type":"number",
            "description":"The quota factor of the opportunity sales stage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":22,
                "scale":7
            }
        },
        "PredWinProb":{
            "title":"Predicted Win Probability",
            "type":"number",
            "description":"AI predicted win probability percent.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code of the matched opportunity. This attribute is used by CRM Extensibility framework. 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":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrimaryCompetitorId":{
            "title":"Primary Competitor",
            "type":"integer",
            "description":"The unique identifier of the primary competitor associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"Competitor",
                "RecentItemEntityName":"competitors",
                "dependencies":[
                    "PriCompPartyUniqueName1",
                    "PrimaryCompetitorName"
                ]
            },
            "x-queryable":true
        },
        "PrimaryPartnerId":{
            "title":"Primary Partner",
            "type":"integer",
            "description":"The unique identifier of the primary partner associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"Partner",
                "RecentItemEntityName":"partners"
            },
            "x-queryable":true
        },
        "IBAssetId":{
            "title":"Installed Base Asset",
            "type":"integer",
            "description":"Identifier of the installed base asset of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "dependencies":[
                    "IBAssetNumber"
                ]
            }
        },
        "PrimaryContactEmailAddress":{
            "title":"Primary Contact Email",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address of the primary contact associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "RecommendedAction":{
            "title":"Recommended Action",
            "maxLength":180,
            "type":"string",
            "description":"AI recommended action.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LookupCategory":{
            "title":"Status Category",
            "maxLength":30,
            "type":"string",
            "description":"The status category of the opportunity status.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "OptyNumber":{
            "title":"Opportunity Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique alternate identifier for the opportunity.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrimaryPartnerCompanyNumber":{
            "title":"Primary Partner Number",
            "maxLength":30,
            "type":"string",
            "description":"The party number of the primary partner associated with the opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetPartyId":{
            "title":"Account",
            "type":"integer",
            "description":"The unique identifier of the sales account associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"Account",
                "RecentItemEntityName":"accounts"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the opportunity record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyCreatedBy":{
            "title":"Opportunity Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            }
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the opportunity record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PrSrcNumber":{
            "title":"Primary Source Number",
            "maxLength":100,
            "type":"string",
            "description":"The unique identifier of the primary marketing source or campaign that generated the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "EmailAddress":{
            "title":"Owner Email",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address of the employee resource that owns the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates whether the opportunity can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "OptyId":{
            "title":"Opportunity ID",
            "type":"integer",
            "description":"The unique identifier of the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OptyCreationDate":{
            "title":"Opportunity Creation Date",
            "type":"string",
            "description":"The date and time when the opportunity was created.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "OptyLastUpdatedBy":{
            "title":"Opportunity Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the opportunity.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "PrimaryContactPartyNumber":{
            "title":"Primary Contact Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The party number of the primary contact associated with the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "KeyContactId":{
            "title":"Primary Contact",
            "type":"integer",
            "description":"The unique identifier of the primary contact associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"Contact",
                "RecentItemEntityName":"contacts",
                "dependencies":[
                    "PriContactPartyNameTransientForLOV",
                    "PriContactPartyName1"
                ]
            },
            "x-queryable":true
        },
        "ManageTeamDataFlag":{
            "title":"Manage Team Data",
            "type":"boolean",
            "description":"Allows management of opportunity sales team data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "Revenue":{
            "title":"Amount",
            "type":"number",
            "description":"The revenue amount of the opportunity.",
            "nullable":true,
            "default":0,
            "x-queryable":false
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the asset associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18,
                "SmartPickerEntityName":"Asset",
                "RecentItemEntityName":"assets",
                "dependencies":[
                    "AssetProduct",
                    "AssetNumber",
                    "AssetProductForExtnLOV"
                ]
            }
        },
        "OpportunityOrigin":{
            "title":"Opportunity Origin",
            "maxLength":30,
            "type":"string",
            "description":"The value for the origin of the opportunity.",
            "nullable":true,
            "default":"SALES_OPTY",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the opportunity record.",
            "nullable":true,
            "x-queryable":false
        },
        "IBAssetSerialNumber":{
            "title":"Installed Base Asset Serial Number",
            "maxLength":80,
            "type":"string",
            "description":"The associated installed base Asset's Serial number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BudgetAvailableDate":{
            "title":"Date Budget Available",
            "type":"string",
            "description":"The date and time when the opportunity budget was made available.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Sales Objective",
            "maxLength":2000,
            "type":"string",
            "description":"The description of the opportunity, including the sales objective.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "OwnerPartyNumber":{
            "title":"Owner Number",
            "maxLength":30,
            "type":"string",
            "description":"The owner party number of the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TargetPartyPrimaryAddressCountry":{
            "title":"Account Country",
            "maxLength":2,
            "type":"string",
            "description":"Country of the primary account's primary address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AverageDaysAtStage":{
            "title":"Duration",
            "type":"integer",
            "description":"The average duration, in number of days, that the opportunity remains in the current sales stage.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":10
            }
        },
        "OpportunityTypeCode":{
            "title":"Opportunity Type",
            "maxLength":30,
            "type":"string",
            "description":"Display the different types of opportunity such as new, renewal and expansion.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "StgOrder":{
            "title":"Order",
            "type":"number",
            "description":"The order of the opportunity's sales stage in the sales method.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":22,
                "scale":7
            }
        },
        "AccountPartyNumber":{
            "title":"Account Number",
            "maxLength":30,
            "type":"string",
            "description":"The party number of the account associated with the matched opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StageStatusCd":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the default status of the sales stage associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "default":"\"Open\"",
            "x-queryable":false
        },
        "DealHorizonCode":{
            "title":"Estimated Deal Duration",
            "maxLength":30,
            "type":"string",
            "description":"The estimated time, in days, required to close the deal. A list of valid values is defined in the lookup MOO_SETID_DEAL_HORIZION. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "DecisionLevelCode":{
            "title":"Decision Level",
            "maxLength":30,
            "type":"string",
            "description":"The job level of the person who takes the final decision for the opportunity. A list of valid values is defined in the lookup MOO_SETID_DECISION_LEVEL. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "OwnerResourcePartyId":{
            "title":"Owner",
            "type":"integer",
            "description":"The unique identifier of a valid employee resource who owns and manages the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"resources"
            },
            "x-queryable":true
        },
        "BdgtAmtCurcyCd":{
            "title":"Budget Amount Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code for budget amount from the sales account.",
            "nullable":true,
            "x-queryable":false
        },
        "PrimaryCompetitorPartyNumber":{
            "title":"Primary Competitor Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The party number of the primary competitor associated with the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryCampaignName":{
            "title":"Primary Campaign",
            "type":"string",
            "description":"The name of the primary campaign associated with the matched opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"combo_lov",
                "dependencies":[
                    "PrimaryCampaignName1"
                ]
            },
            "x-queryable":true
        },
        "DownsideAmount":{
            "title":"Worst Case",
            "type":"number",
            "description":"The minimum amount of revenue for the opportunity.",
            "nullable":true,
            "default":0,
            "x-queryable":false
        },
        "Selected":{
            "type":"boolean",
            "description":"Indicates if the matched opportunity is selected.",
            "nullable":true,
            "x-queryable":false
        },
        "AssetProduct":{
            "title":"Asset",
            "type":"string",
            "description":"The asset product associated with the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "IBAssetNumber":{
            "title":"Installed Base Asset Number",
            "maxLength":80,
            "type":"string",
            "description":"Asset number of the installed base asset of the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryCampaignId":{
            "title":"Primary Campaign ID",
            "type":"integer",
            "description":"The unique identifier of the primary campaign associated with the matched opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18,
                "RecentItemEntityName":"campaigns"
            },
            "x-queryable":true
        },
        "QuotedFlag":{
            "title":"Quoted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates that a quote has been created for this Opportunity.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "RcmndWinProb":{
            "title":"Win Probability",
            "type":"number",
            "description":"The recommended probability of winning the opportunity in the sales stage.",
            "nullable":true,
            "readOnly":true,
            "default":0,
            "x-queryable":false,
            "x-hints":{
                "precision":22,
                "scale":7
            }
        },
        "RegistrationStatus":{
            "title":"Registration Status",
            "maxLength":30,
            "type":"string",
            "description":"The registration status of the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ManageRevenueDataFlag":{
            "title":"Manage Revenue Data",
            "type":"boolean",
            "description":"Allows management of revenue data, such as products and recurring revenue information.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "CrmConversionRate":{
            "title":"Conversion Rate",
            "type":"number",
            "description":"This rate is used for the conversion of the revenue amount to the CRM common currency to facilitate the computation of the revenue forecast metrics. This is the amount that one currency can be exchanged for, at a specific point of time.",
            "nullable":true,
            "x-queryable":true
        },
        "ManageGeneralProfileDataFlag":{
            "title":"Manage General Profile Data",
            "type":"boolean",
            "description":"Allows management of general opportunity information such as competitors, lead, source, contacts, references, interactions, and assessments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "SalesChannelCd":{
            "title":"Sales Channel",
            "maxLength":50,
            "type":"string",
            "description":"The code indicating the sales channel for the opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "DescriptionText":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the sales objective of the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "ChampionFlag":{
            "title":"Key Internal Sponsor",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the opportunity has an internal sponsor. If the value is true, then the opportunity has an internal sponsor. The default value is False.",
            "nullable":false,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"check_box"
            }
        },
        "ClosePeriod":{
            "title":"Close Period",
            "type":"string",
            "description":"The close period of the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "DefaultQueryValue":"CURR_QTR",
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "AttributeType":"Picklist"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the opportunity record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SalesMethodId":{
            "title":"Sales Method",
            "type":"integer",
            "description":"The unique identifier of the sales method associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18,
                "Dependencies":"PrimaryOrganizationId"
            },
            "x-queryable":true
        },
        "SourceType":{
            "title":"Source Type",
            "type":"string",
            "description":"The source type of the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "UpsideAmount":{
            "title":"Best Case",
            "type":"number",
            "description":"The maximum amount of revenue for the opportunity.",
            "nullable":true,
            "default":0,
            "x-queryable":false
        },
        "PrimaryCampaignNumber":{
            "title":"Primary Campaign Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the primary campaign associated with the matched opportunity.",
            "nullable":false,
            "x-queryable":true
        },
        "ForecastCategory":{
            "title":"Forecast Category",
            "maxLength":30,
            "type":"string",
            "description":"Specifies the categories used to represent the commitment level for sales forecasting such as pipeline, best case, most likely and so on.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectAmount":{
            "title":"Expected Revenue",
            "type":"number",
            "description":"The expected revenue from the opportunity.",
            "nullable":true,
            "default":0,
            "x-queryable":false
        },
        "PartyName1":{
            "title":"Owner",
            "maxLength":360,
            "type":"string",
            "description":"The name of the opportunity owner.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "maxLength":30,
            "type":"string",
            "description":"The status of the opportunity. A list of valid values is defined in the lookup MOO_OPTY_STATUS. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "AttributeType":"Picklist",
                "Dependencies":"PrimaryOrganizationId"
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":100,
            "type":"string",
            "description":"The alternate key identifier of the asset associated with the opportunity.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "title":"Name",
            "maxLength":275,
            "type":"string",
            "description":"The name of the opportunity.",
            "nullable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrimaryContactFormattedPhoneNumber":{
            "title":"Primary Contact Phone",
            "type":"string",
            "description":"The phone number of the primary contact associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPartyId"
                ]
            }
        },
        "RiskLevelCode":{
            "title":"Level of Risk",
            "maxLength":30,
            "type":"string",
            "description":"The risk level code of the opportunity. A list of valid values is defined in the lookup MOO_SETID_RISK_LEVE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecordSet":{
            "type":"string",
            "description":"The record set of the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "="
                ]
            },
            "x-queryable":true
        },
        "AssignmentMode":{
            "title":"Assignment Mode",
            "maxLength":30,
            "type":"string",
            "description":"Specifies the types of assignment mode options available for controlling auto assignment default behavior for opportunity record updates.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "sortable":false
            }
        },
        "SalesAccountUniqueName":{
            "title":"Customer Account",
            "maxLength":900,
            "type":"string",
            "description":"The unique name of the sales account that owns the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            }
        },
        "MaximumDaysInStage":{
            "title":"Stalled Deal Limit",
            "type":"integer",
            "description":"The maximum duration, in number of days, that the opportunity can remain in the sales stage before it is considered stalled.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":10
            }
        },
        "ReasonWonLostCode":{
            "title":"Win/Loss Reason",
            "maxLength":30,
            "type":"string",
            "description":"The reason for winning or losing the opportunity. A list of valid values is defined in the lookup MOO_SETID_WIN_LOSS_REASON. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            },
            "x-queryable":true
        },
        "SalesMethod":{
            "title":"Sales Method",
            "maxLength":50,
            "type":"string",
            "description":"The sales method associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "SalesStageId":{
            "title":"Sales Stage",
            "type":"integer",
            "description":"The unique identifier of the sales stage associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "precision":18,
                "Dependencies":"SalesMethodId,PrimaryOrganizationId"
            },
            "x-queryable":true
        },
        "WinProb":{
            "title":"Win Probability",
            "type":"integer",
            "description":"The estimated probability of winning the opportunity.",
            "format":"int32",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "precision":5
            },
            "x-queryable":true
        },
        "AssetSerialNumber":{
            "title":"Asset Serial Number",
            "maxLength":100,
            "type":"string",
            "description":"The asset serial number associated with the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BdgtAmount":{
            "title":"Budget Amount",
            "type":"number",
            "description":"Budget amount from the sales account.",
            "nullable":true,
            "x-queryable":false
        },
        "TargetPartyName":{
            "title":"Account",
            "maxLength":360,
            "type":"string",
            "description":"The name of the sales account associated with the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryPartnerOrgPartyName":{
            "title":"Primary Partner",
            "maxLength":360,
            "type":"string",
            "description":"The organization party name of the primary partner associated with the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "SetupRefCode":{
            "maxLength":80,
            "type":"string",
            "description":"The public unique identifier for the CPQ configuration setup.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimarySubscriptionId":{
            "title":"Primary Subscription Id",
            "type":"integer",
            "description":"The unique identifier of the primary subscription of the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "HintCode":{
            "title":"Hint Code",
            "maxLength":10,
            "type":"string",
            "description":"AI hint code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates whether the opportunity can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryContactPartyName":{
            "title":"Primary Contact",
            "maxLength":360,
            "type":"string",
            "description":"The name of the primary contact associated with the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PrimaryContactPhonePref":{
            "title":"Primary Contact Phone Preference",
            "maxLength":255,
            "type":"string",
            "description":"Indicates if the primary contact has a phone preference of do not call, ok to call, or no value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPartyId"
                ]
            }
        },
        "CrmCurrencyCode":{
            "title":"CRM Common Currency",
            "maxLength":15,
            "type":"string",
            "description":"CRM common currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RenewalProcess":{
            "title":"Renewal Process",
            "maxLength":30,
            "type":"string",
            "description":"The renewal process can be manual, do not renew or automatic renewal.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CustomerAccountId":{
            "title":"Billing Account",
            "type":"integer",
            "description":"The unique identifier of the customer billing account associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":18
            }
        },
        "RegistrationType":{
            "title":"Registration Type",
            "maxLength":30,
            "type":"string",
            "description":"The registration type used by the partner to create the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "PrimaryOrganizationId":{
            "title":"Business Unit ID",
            "type":"integer",
            "description":"The unique identifier of the business unit associated with the opportunity.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "="
                ],
                "precision":18
            }
        },
        "StrategicLevelCode":{
            "title":"Strategic Value",
            "maxLength":30,
            "type":"string",
            "description":"The strategic value that the opportunity has for the sales account.  A list of valid values is defined in the lookup MOO_SETID_STRATEGIC_VALUE. Review and update the codes using the Setup and Maintenance work area, Manage Standard Lookups task.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "Dependencies":"PrimaryOrganizationId"
            }
        },
        "PartyUniqueName1":{
            "title":"Primary Competitor",
            "maxLength":900,
            "type":"string",
            "description":"The unique name of the primary competitor for the opportunity.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "BudgetedFlag":{
            "title":"Budgeted",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the opportunity sales account has the budget approved for the potential purchase. If the value is true, then the sales account has the budget approved for the purchase. The default value is False.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "SalesStage":{
            "title":"Sales Stage",
            "maxLength":50,
            "type":"string",
            "description":"The current sales stage of the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "=",
                    "CONTAINS"
                ]
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":2000,
            "type":"string",
            "description":"The user-provided comments for the opportunity.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "PhaseCd":{
            "title":"Phase",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the current phase of the opportunity sales stage.",
            "nullable":false,
            "readOnly":true,
            "default":"\"B - Working the Deal\"",
            "x-queryable":false
        },
        "ManageRestrictedProfileDataFlag":{
            "title":"Manage Restricted Profile Data",
            "type":"boolean",
            "description":"Allows management of restricted opportunity information such as sales method, sales stage, sales account, primary contact, and partners.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "sortable":false
            }
        },
        "PrimarySubscriptionNumber":{
            "title":"Subscription Number",
            "maxLength":120,
            "type":"string",
            "description":"The alternate identifier of primary subscription of the opportunity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LineOfBusinessCode":{
            "title":"Line of Business",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating which line of business owns the opportunity.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ForecastOverrideCode":{
            "title":"Include in Forecast",
            "maxLength":30,
            "type":"string",
            "description":"The code that indicates if the revenue forecast should be overridden. The valid values are ALWAYS, NEVER, and CRITERIA.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            }
        },
        "PrimaryContactEmailPref":{
            "title":"Primary Contact Email Preference",
            "maxLength":255,
            "type":"string",
            "description":"Indicates if the primary contact has an email preference of do not email, ok to email, or no value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PrimaryContactPartyId"
                ]
            }
        },
        "PrimaryRevenueId":{
            "title":"Summary Revenue Line ID",
            "type":"integer",
            "description":"The unique identifier of the summary revenue line associated with the opportunity.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Registered":{
            "title":"Registered",
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether the opportunity was registered. The valid values are Expired, Yes, and No.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EffectiveDate":{
            "title":"Close Date",
            "type":"string",
            "description":"The date and time when the opportunity was closed.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "BETWEEN"
                ]
            },
            "x-queryable":true
        },
        "BatchTag":{
            "title":"Batch Tag",
            "maxLength":30,
            "type":"string",
            "description":"The batch tag of the opportunity.",
            "nullable":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 : deals-Note-item-response

Type: object

Show Source

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

  The unique identifier of the relationship between a contact and a note. This value is populated when the note is associated with a contact.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Maximum Length: 15

  The corporate currency code of the note associated with the note. This attribute is used by CRM Extensibility framework. 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 unique identifier of the user who created the note.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

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

  The unique identifier of the person who created or authored the note.
• CurcyConvRateType: string
  Title: Currency Conversion Rate Type

  Maximum Length: 30

  The currency conversion rate type used to derive the exchange rate between the user-entered currency and the CRM corporate currency code associated with the note.
• CurrencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code. This attribute is used by CRM Extensibility framework. 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.
• 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 row 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.
• 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 column to store the note text.
• NoteTypeCode: string
  Title: Type

  Maximum Length: 30

  The code indicating the type of the note. For example, General or Reference.
• 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 person who created or authored the note.
• PartyName: string
  Title: Author

  Read Only: true

  Maximum Length: 360

  The name of the author of the note.
• SourceObjectCode: string
  Title: Related Object Type

  Maximum Length: 30

  The source object code for the source object as defined in the object's metadata.
• SourceObjectId: string
  Title: Related Object

  Maximum Length: 64

  The unique identifier of the source objects as defined in the object's metadata, such as activities and opportunities.
• UpdateFlag: boolean
  Title: Update Indicator

  Read Only: true

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

  Maximum Length: 30

  Default Value: INTERNAL

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time of when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyName":{
            "title":"Author",
            "maxLength":360,
            "type":"string",
            "description":"The name of the author of the note.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CurcyConvRateType":{
            "title":"Currency Conversion Rate Type",
            "maxLength":30,
            "type":"string",
            "description":"The currency conversion rate type used to derive the exchange rate between the user-entered currency and the CRM corporate currency code associated with the note.",
            "nullable":true,
            "x-queryable":false
        },
        "VisibilityCode":{
            "title":"Private",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the visibility level of the note, such as private, internal, or external.",
            "nullable":false,
            "default":"INTERNAL",
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ContactRelationshipId":{
            "title":"Contact Relationship ID",
            "type":"integer",
            "description":"The unique identifier of the relationship between a contact and a note. This value is populated when the note is associated with a contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code. This attribute is used by CRM Extensibility framework. 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":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 source object code for the source object as defined in the object's 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 note. This attribute is used by CRM Extensibility framework. 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 column to store the 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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the user who created the note.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"date"
            },
            "x-queryable":true
        },
        "CreatorPartyId":{
            "title":"Creator Party ID",
            "type":"integer",
            "description":"The unique identifier of the person who created or authored 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 indicating the type of the note. For example, General or Reference.",
            "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 objects as defined in the object's metadata, such as activities and opportunities.",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the person who created or authored the note.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParentNoteId":{
            "title":"Parent Note ID",
            "type":"integer",
            "description":"The unique identifier of the parent note.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the row 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 : deals-PartnerOwnerPicker-item-response

Type: object

Show Source

• DenormLevel: number
  Read Only: true
• DenormMgrId: integer (int64)
  Read Only: true
• EmailAddress: string
  Title: E-Mail

  Read Only: true

  Maximum Length: 320
• EndDateActive: string (date)
  Read Only: true
• FilterManager: string
  Read Only: true

  Maximum Length: 255
• FormattedPhoneNumber: string
  Title: Primary Phone

  Read Only: true
• GroupId: integer (int64)
  Read Only: true
• HierarchyType: string
  Read Only: true

  Maximum Length: 30
• IncludeManager: string
  Read Only: true

  Maximum Length: 255
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManagerFirstName: string
  Title: Manager First Name

  Read Only: true

  Maximum Length: 150
• ManagerLastName: string
  Title: Manager Last Name

  Read Only: true

  Maximum Length: 150
• ManagerName: string
  Read Only: true

  Maximum Length: 360
• OrganizationName: string
  Title: Organization

  Read Only: true

  Maximum Length: 240
• ParentOrgId: integer (int64)
  Read Only: true
• ParentResourceId: number
  Read Only: true
• PartyId: integer (int64)
  Title: Party ID

  Read Only: true
• PartyNumber: string
  Title: Registry ID

  Read Only: true

  Maximum Length: 30
• PartyType: string
  Title: Type

  Read Only: true

  Maximum Length: 30
• PrimaryPhoneAreaCode: string
  Title: Primary Phone Area Code

  Read Only: true

  Maximum Length: 20
• PrimaryPhoneContactPtId: integer (int64)
  Read Only: true
• PrimaryPhoneCountryCode: string
  Title: Primary Phone Country Code

  Read Only: true

  Maximum Length: 10
• PrimaryPhoneExtension: string
  Title: Extension

  Read Only: true

  Maximum Length: 20
• PrimaryPhoneLineType: string
  Title: Phone Line Type

  Read Only: true

  Maximum Length: 30
• PrimaryPhoneNumber: string
  Title: Primary Phone

  Read Only: true

  Maximum Length: 40
• PrimaryPhonePurpose: string
  Title: Role

  Read Only: true

  Maximum Length: 30
• ReportsTo: string
  Title: Manager

  Read Only: true

  Maximum Length: 255
• ResourceFirstName: string
  Title: First Name

  Read Only: true

  Maximum Length: 150
• ResourceId: integer (int64)
  Read Only: true
• ResourceLastName: string
  Title: Last Name

  Read Only: true

  Maximum Length: 150
• ResourceName: string
  Title: Resource Name

  Read Only: true

  Maximum Length: 450
• ResourceProfileId: integer (int64)
  Read Only: true
• ResourceSearchFilter: string
  Read Only: true

  Maximum Length: 1
• RoleName: string
  Title: Role

  Read Only: true

  Maximum Length: 60
• StartDateActive: string (date)
  Read Only: true
• Status: string
  Read Only: true

  Maximum Length: 10
• TreeCode: string
  Read Only: true

  Maximum Length: 30
• TreeName: string
  Title: Hierarchy

  Read Only: true

  Maximum Length: 80
• TreeStructureCode: string
  Read Only: true

  Maximum Length: 30
• TreeVersionId: string
  Read Only: true

  Maximum Length: 32
• UserGuid: string
  Read Only: true

  Maximum Length: 64

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization",
            "maxLength":240,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DenormMgrId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "HierarchyType":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Resource Name",
            "maxLength":450,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerName":{
            "maxLength":360,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceProfileId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FilterManager":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DenormLevel":{
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StartDateActive":{
            "type":"string",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhoneExtension":{
            "title":"Extension",
            "maxLength":20,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneExtension",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Extension"
            },
            "x-queryable":true
        },
        "TreeVersionId":{
            "maxLength":32,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerLastName":{
            "title":"Manager Last Name",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportsTo":{
            "title":"Manager",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":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":"Primary Phone",
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "IncludeManager":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyType":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TreeName":{
            "title":"Hierarchy",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":10,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryPhoneAreaCode":{
            "title":"Primary Phone Area Code",
            "maxLength":20,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"PhoneEO.PhoneAreaCode",
                "protectionObjectTitle":"Phone",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Area Code"
            },
            "x-queryable":true
        },
        "UserGuid":{
            "maxLength":64,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhoneLineType":{
            "title":"Phone Line Type",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhoneContactPtId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"E-Mail",
            "maxLength":320,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GroupId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryPhoneCountryCode":{
            "title":"Primary Phone Country Code",
            "maxLength":10,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceSearchFilter":{
            "maxLength":1,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role",
            "maxLength":60,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "EndDateActive":{
            "type":"string",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentResourceId":{
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManagerFirstName":{
            "title":"Manager First Name",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResourceId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PrimaryPhoneNumber":{
            "title":"Primary Phone",
            "maxLength":40,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TreeStructureCode":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TreeCode":{
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PrimaryPhonePurpose":{
            "title":"Role",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentOrgId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "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 : deals-productGroups-item-response

Type: object

Show Source

• Description: string
  Title: Description

  Read Only: true

  Maximum Length: 1000

  The user-defined description of the product group.
• DisplayName: string
  Title: Name

  Read Only: true

  Maximum Length: 255

  The name of the product group.
• LastUpdateDate: string
  Title: Last Updated Date

  Read Only: true

  The date and time when the product group record was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ModelConfigAttributes: string
  Read Only: true

  The attributes of the product group model.
• ModelName: string
  Read Only: true

  The name of the product group model.
• ProdGroupId: integer
  Title: Product Group ID

  Read Only: true

  The unique identifier of the product group.
• QuotableFlag: boolean
  Title: Quotable

  Read Only: true

  Indicates whether the product group is quotable. This is applicable if CPQ is configured.
• ReferenceNumber: string
  Title: Reference Number

  Read Only: true

  The product group reference number.

{
    "type":"object",
    "properties":{
        "ProdGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":1000,
            "type":"string",
            "description":"The user-defined description of the product group.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ModelName":{
            "type":"string",
            "description":"The name of the product group model.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ModelConfigAttributes":{
            "type":"string",
            "description":"The attributes of the product group model.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferenceNumber":{
            "title":"Reference Number",
            "type":"string",
            "description":"The product group reference number.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "QuotableFlag":{
            "title":"Quotable",
            "type":"boolean",
            "description":"Indicates whether the product group is quotable. This is applicable if CPQ is configured.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the product group record was last updated.",
            "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 : deals-products-item-response

Type: object

Show Source

• ActiveFlag: boolean
  Title: Active

  Read Only: true

  Indicates if the product is active.
• CSSEnabled: string
  Read Only: true

  Indicates if the product is enabled for customer self-service. The default value is No.
• Description: string
  Title: Name

  Read Only: true

  Maximum Length: 255

  The description of the product associated with the deal registration.
• EndDate: string (date-time)
  Title: Effective to Date

  Read Only: true

  The date and time when the product becomes inactive.
• InventoryItemId: integer
  Title: Inventory Item ID

  Read Only: true

  The unique identifier of the product inventory item associated with the deal registration.
• InvOrgId: integer
  Title: Inventory Organization ID

  Read Only: true

  The unique identifier of the inventory organization.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the product record was last updated.
• links: array Links
  Title: Links

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

  Read Only: true

  Maximum Length: 4000

  The description for the product.
• ProdGroupId: integer
  Title: Product Group ID

  Read Only: true

  The unique identifier of the product group.
• ProductNum: string
  Title: Product Number

  Read Only: true

  The unique alternate identifier of the product.
• ProductType: string
  Title: Product Type

  Read Only: true

  The type of the product.
• ServiceRequestEnabledCode: string
  Read Only: true

  Indicates if service requests are enabled for the associated product.
• StartDate: string (date-time)
  Title: Effective from Date

  Read Only: true

  The date and time when the product becomes active.
• Text: string
  Title: Keyword

  The text or keywords associated with the product.

{
    "type":"object",
    "properties":{
        "ProdGroupId":{
            "title":"Product Group ID",
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Name",
            "maxLength":255,
            "type":"string",
            "description":"The description of the product associated with the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "InvOrgId":{
            "title":"Inventory Organization ID",
            "type":"integer",
            "description":"The unique identifier of the inventory organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InventoryItemId":{
            "title":"Inventory Item ID",
            "type":"integer",
            "description":"The unique identifier of the product inventory item associated with the deal registration.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ProductType":{
            "title":"Product Type",
            "type":"string",
            "description":"The type of the product.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "Text":{
            "title":"Keyword",
            "type":"string",
            "description":"The text or keywords associated with the product.",
            "nullable":true,
            "x-hints":{
                "operators":[
                ]
            },
            "x-queryable":true
        },
        "CSSEnabled":{
            "type":"string",
            "description":"Indicates if the product is enabled for customer self-service. The default value is No.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDate":{
            "title":"Effective to Date",
            "type":"string",
            "description":"The date and time when the product becomes inactive.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ActiveFlag":{
            "title":"Active",
            "type":"boolean",
            "description":"Indicates if the product is active.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "StartDate":{
            "title":"Effective from Date",
            "type":"string",
            "description":"The date and time when the product becomes active.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LongDescription":{
            "title":"Description",
            "maxLength":4000,
            "type":"string",
            "description":"The description for the product.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "ServiceRequestEnabledCode":{
            "type":"string",
            "description":"Indicates if service requests are enabled for the associated product.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductNum":{
            "title":"Product Number",
            "type":"string",
            "description":"The unique alternate identifier of the product.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the product record was last updated.",
            "format":"date-time",
            "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 : deals-smartActions-item-response

Type: object

Show Source

• ActionIntent: string (byte)
  Title: Action Intent

  JSON object that describes what an action does and what context data can be passed to the action.
• ConfirmationMessage: string
  Title: Confirmation Message

  Maximum Length: 4000

  The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.
• ContentType: string
  Title: Content Type

  Maximum Length: 50

  The media type of the smart action REST operation.
• DisplayLabel: string
  Title: Action Name

  Maximum Length: 256

  The display name of the smart action.
• Entity: string
  Title: Parent Entity

  Maximum Length: 150

  The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object.
• Href: string
  Title: REST Endpoint

  Maximum Length: 150

  The relative path of the smart action REST resource. The path can include path parameters.
• IncludedInApplication: string
  Title: Included in Application

  Maximum Length: 512

  The client applications that the smart action is associated with.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassActionFlag: boolean
  Title: Mass Action

  Maximum Length: 1

  Indicates whether an action is designed to operate on multiple object instances selected by an end user.
• Method: string
  Title: HTTP Method

  Maximum Length: 15

  The HTTP method of the smart action REST operation.
• ObjectFunctionName: string
  Title: Object Function

  Maximum Length: 64

  The object function for smart action.
• PageType: string
  Title: Page Type

  Maximum Length: 256

  The list of pages that this action can be used in.
• SmartSuggestFlag: boolean
  Title: Smart Suggest

  Maximum Length: 1

  Indicates whether the smart suggest is enabled for the action.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  System assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded.
• UpdateOfAttributes: string
  Title: Attributes to Update

  Maximum Length: 512

  The object attribute to be updated as a result of using a data entry form. Used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.
• UserActionId: integer (int64)
  Title: User Action ID

  The unique system assigned identifier of the smart action definition.
• UserActionName: string
  Title: Action Name

  Maximum Length: 256

  The unique system assigned smart action name.
• UserActionNavigation: array Smart Action User Interface Definitions
  Title: Smart Action User Interface Definitions

  The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• UserActionRank: integer (int64)
  Title: Priority

  The number defining the relative position of the smart action in the list of smart actions displayed in a client application.
• UserActionRequestPayload: array Smart Action REST Payload Definitions
  Title: Smart Action REST Payload Definitions

  The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.
• UserActionURLBinding: array Smart Action REST Path Parameter Definitions
  Title: Smart Action REST Path Parameter Definitions

  The path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

{
    "type":"object",
    "properties":{
        "SmartSuggestFlag":{
            "title":"Smart Suggest",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the smart suggest is enabled for the action.",
            "nullable":true,
            "x-queryable":true
        },
        "Entity":{
            "title":"Parent Entity",
            "maxLength":150,
            "type":"string",
            "description":"The primary object the smart action is associated with. For example if the smart action creates an appointment for a lead, lead is the primary object.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "maxLength":50,
            "type":"string",
            "description":"The media type of the smart action REST operation.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionURLBinding":{
            "title":"Smart Action REST Path Parameter Definitions",
            "type":"array",
            "description":"The path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/deals-smartActions-UserActionURLBinding-item-response"
            }
        },
        "MassActionFlag":{
            "title":"Mass Action",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether an action is designed to operate on multiple object instances selected by an end user.",
            "nullable":true,
            "x-queryable":true
        },
        "IncludedInApplication":{
            "title":"Included in Application",
            "maxLength":512,
            "type":"string",
            "description":"The client applications that the smart action is associated with.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavigation":{
            "title":"Smart Action User Interface Definitions",
            "type":"array",
            "description":"The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/deals-smartActions-UserActionNavigation-item-response"
            }
        },
        "Href":{
            "title":"REST Endpoint",
            "maxLength":150,
            "type":"string",
            "description":"The relative path of the smart action REST resource. The path can include path parameters.",
            "nullable":true,
            "x-queryable":true
        },
        "Method":{
            "title":"HTTP Method",
            "maxLength":15,
            "type":"string",
            "description":"The HTTP method of the smart action REST operation.",
            "nullable":true,
            "x-queryable":true
        },
        "DisplayLabel":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The display name of the smart action.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionName":{
            "title":"Action Name",
            "maxLength":256,
            "type":"string",
            "description":"The unique system assigned smart action name.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionId":{
            "title":"User Action ID",
            "type":"integer",
            "description":"The unique system assigned identifier of the smart action definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionRank":{
            "title":"Priority",
            "type":"integer",
            "description":"The number defining the relative position of the smart action in the list of smart actions displayed in a client application.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":10
            },
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"System assigned value indicating whether the smart action is seeded or custom.  True indicates the smart action is seeded.",
            "nullable":true,
            "x-queryable":true
        },
        "ConfirmationMessage":{
            "title":"Confirmation Message",
            "maxLength":4000,
            "type":"string",
            "description":"The confirmation message displayed before the smart action runs. An affirmative response allows the smart action to run.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionRequestPayload":{
            "title":"Smart Action REST Payload Definitions",
            "type":"array",
            "description":"The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
            "items":{
                "$ref":"#/components/schemas/deals-smartActions-UserActionRequestPayload-item-response"
            }
        },
        "UpdateOfAttributes":{
            "title":"Attributes to Update",
            "maxLength":512,
            "type":"string",
            "description":"The object attribute to be updated as a result of using a data entry form. Used by applications to determine which form to use. The value is object scoped and must be unique across all smart actions for an object.",
            "nullable":true,
            "x-queryable":true
        },
        "ActionIntent":{
            "title":"Action Intent",
            "type":"string",
            "description":"JSON object that describes what an action does and what context data can be passed to the action.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectFunctionName":{
            "title":"Object Function",
            "maxLength":64,
            "type":"string",
            "description":"The object function for smart action.",
            "nullable":true,
            "x-queryable":true
        },
        "PageType":{
            "title":"Page Type",
            "maxLength":256,
            "type":"string",
            "description":"The list of pages that this action can be used in.",
            "nullable":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 : Smart Action User Interface Definitions

Type: array

Title: Smart Action User Interface Definitions

The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object deals-smartActions-UserActionNavigation-item-response

{
    "title":"Smart Action User Interface Definitions",
    "type":"array",
    "description":"The user interface definitions resource is used to view user interfaces associated with a smart action. Each user interface can be mapped to a client application. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/deals-smartActions-UserActionNavigation-item-response"
    }
}

Nested Schema : Smart Action REST Payload Definitions

Type: array

Title: Smart Action REST Payload Definitions

The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object deals-smartActions-UserActionRequestPayload-item-response

{
    "title":"Smart Action REST Payload Definitions",
    "type":"array",
    "description":"The payload definitions resource is used to view the REST request payload name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/deals-smartActions-UserActionRequestPayload-item-response"
    }
}

Nested Schema : Smart Action REST Path Parameter Definitions

Type: array

Title: Smart Action REST Path Parameter Definitions

The path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Show Source

• Array of: object deals-smartActions-UserActionURLBinding-item-response

{
    "title":"Smart Action REST Path Parameter Definitions",
    "type":"array",
    "description":"The path parameters resource is used to view the REST request path parameter name-value pair definitions of a smart action. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.",
    "items":{
        "$ref":"#/components/schemas/deals-smartActions-UserActionURLBinding-item-response"
    }
}

Nested Schema : deals-smartActions-UserActionNavigation-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• UserActionNavAppUsage: string
  Title: Application Usage

  Maximum Length: 50

  The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.
• UserActionNavBody: string
  Title: Navigation Metadata

  Maximum Length: 1000

  The metadata definition of the smart action user interface endpoint.
• UserActionNavId: integer (int64)
  Title: Primary Key

  The unique system assigned identifier of a smart action user interface definition.
• UserActionNavType: string
  Title: Navigation Type

  Maximum Length: 100

  The text value used by applications to determine which user interface to launch.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded.  The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "UserActionNavId":{
            "title":"Primary Key",
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action user interface definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "UserActionNavType":{
            "title":"Navigation Type",
            "maxLength":100,
            "type":"string",
            "description":"The text value used by applications to determine which user interface to launch.",
            "nullable":false,
            "x-queryable":true
        },
        "UserActionNavBody":{
            "title":"Navigation Metadata",
            "maxLength":1000,
            "type":"string",
            "description":"The metadata definition of the smart action user interface endpoint.",
            "nullable":true,
            "x-queryable":true
        },
        "UserActionNavAppUsage":{
            "title":"Application Usage",
            "maxLength":50,
            "type":"string",
            "description":"The client application associated with a smart action user interface endpoint definition identified by UserActionNavId.",
            "nullable":false,
            "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 : deals-smartActions-UserActionRequestPayload-item-response

Type: object

Show Source

• Binding: string
  Title: Payload Value Binding Type

  Maximum Length: 64

  Indicates the classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MandatoryFlag: boolean
  Title: Mandatory

  Maximum Length: 1

  Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.
• RequestPayloadId: integer (int64)
  The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.
• RequestPayloadName: string
  Title: Request Payload Attribute Name

  Maximum Length: 256

  The value assigned to the name property of a name-value pair.
• SmartSuggestPath: string
  Title: Smart Suggest Path

  Maximum Length: 2048

  The path used for smart suggest.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• Value: string
  Title: Request Payload Attribute Value

  Maximum Length: 1000

  The value assigned to the value property of a name-value pair.
• ValueStruct: string
  Title: Payload Value Structure

  Maximum Length: 20

  A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{"name":"leadId","Value":"LeadId","MandatoryFlag":true,"Binding":"RUNTIME"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"Payload Value Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"Indicates the classification of the value property of a name-value pair. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute. A value of STATIC indicates the value to be assigned is a simple string. A null value indicates that the value type is JSON_ARRAY_STRING.",
            "nullable":true,
            "x-queryable":true
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ValueStruct":{
            "title":"Payload Value Structure",
            "maxLength":20,
            "type":"string",
            "description":"A value of JSON_ARRAY_STRING indicates that the value property of a name-value pair represents an array of data rather than a single entity such as an object attribute name or simple text string. The array string is a definition of the name-value pair and the Binding and Mandatory properties. The array string follows specific pattern, for example [{\"name\":\"leadId\",\"Value\":\"LeadId\",\"MandatoryFlag\":true,\"Binding\":\"RUNTIME\"}]. A null value indicates the value property represents a simple, single entity such as an object attribute name or simple text string.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"Request Payload Attribute Value",
            "maxLength":1000,
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SmartSuggestPath":{
            "title":"Smart Suggest Path",
            "maxLength":2048,
            "type":"string",
            "description":"The path used for smart suggest.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestPayloadId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST payload body parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RequestPayloadName":{
            "title":"Request Payload Attribute Name",
            "maxLength":256,
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false,
            "x-queryable":true
        },
        "MandatoryFlag":{
            "title":"Mandatory",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a REST payload body parameter value is mandatory. If True, runtime validation ensures that the value is defined.",
            "nullable":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 : deals-smartActions-UserActionURLBinding-item-response

Type: object

Show Source

• Binding: string
  Title: URL Binding Type

  Maximum Length: 64

  The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SystemActionFlag: boolean
  Title: System Action

  Maximum Length: 1

  Default Value: false

  The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded. The value is automatically derived from smartActions.SystemActionFlag.
• URLBindingId: integer (int64)
  The unique system assigned identifier of a smart action REST path parameter name-value pair definition.
• URLBindingName: string
  Title: URL Binding Parameter Name

  Maximum Length: 50

  The value assigned to the name property of a name-value pair.
• Value: string
  Title: URL Binding Parameter Value

  Maximum Length: 80

  The value assigned to the value property of a name-value pair.

{
    "type":"object",
    "properties":{
        "Binding":{
            "title":"URL Binding Type",
            "maxLength":64,
            "type":"string",
            "description":"The classification of the value property of a name-value pair. The binding value of a UserActionURLBinding instance must be RUNTIME. A binding value of RUNTIME indicates the value to be assigned is the runtime value of an object attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "Value":{
            "title":"URL Binding Parameter Value",
            "maxLength":80,
            "type":"string",
            "description":"The value assigned to the value property of a name-value pair.",
            "nullable":true,
            "x-queryable":true
        },
        "URLBindingId":{
            "type":"integer",
            "description":"The unique system assigned identifier of a smart action REST path parameter name-value pair definition.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SystemActionFlag":{
            "title":"System Action",
            "maxLength":1,
            "type":"boolean",
            "description":"The system assigned value indicating whether the smart action is seeded or custom. True indicates the smart action is seeded.  The value is automatically derived from smartActions.SystemActionFlag.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "URLBindingName":{
            "title":"URL Binding Parameter Name",
            "maxLength":50,
            "type":"string",
            "description":"The value assigned to the name property of a name-value pair.",
            "nullable":false,
            "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"
    }
}

Links

CountryVA

Operation: /crmRestApi/resources/11.13.18.05/fndTerritories

Parameters:

• finder: ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN

The territories resource is used to get a list of ISO standard territories.

CurrencyCodeVA

Operation: /crmRestApi/resources/11.13.18.05/ratedCurrencies

The rated currencies resource is used to view details of currency codes for CRM. It gives a list of accepted values that are defined in the lookup ZCA_COMMON_CORPORATE_CURRENCY.

DealApprovalHistory

Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealApprovalHistory

Parameters:

• dealsUniqID: $request.path.dealsUniqID

The deal registration approval history lets you access a comprehensive record of approval-related information associated with the deal, encompassing the names of approvers, action dates, and the specific actions taken.

DealAttachments

Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealAttachments

Parameters:

• dealsUniqID: $request.path.dealsUniqID

The attachments resource is used to view, create, update, and delete attachments of a deal. An attachment includes additional information about a deal.

DealProduct

Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealProduct

Parameters:

• dealsUniqID: $request.path.dealsUniqID

The deal products resource is used to view, create, update, and delete a deal product. The deal product is a product or product family associated with the deal registration that the customer is interested in.

DealRejectedReasonCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKL_DEAL_REJECT_REASON%2CBindLookupCode%3D{DealRejectedReasonCode}

The lookups resource is used to view standard lookup codes.

DealResources

Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/DealResources

Parameters:

• dealsUniqID: $request.path.dealsUniqID

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

DealReturnReasonCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKL_DEAL_RETURN_REASON%2CBindLookupCode%3D{DealReturnReasonCode}

The lookups resource is used to view standard lookup codes.

DealTypeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKL_DEALREG_DEAL_TYPE%2CBindLookupCode%3D{DealType}

The lookups resource is used to view standard lookup codes.

MatchedOpportunity

Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/MatchedOpportunity

Parameters:

• dealsUniqID: $request.path.dealsUniqID

The opportunity resource is used to view the opportunities associated with a deal registration. An opportunity is used by a sales organization to track information about a potential sale, such as the sales account, key contacts, product interests, and potential revenues. A matched opportunity is an opportunity that matches the deal registration based on the duplicate check process.

Note

Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/Note

Parameters:

• dealsUniqID: $request.path.dealsUniqID

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

OwnerPicker

Operation: /crmRestApi/resources/11.13.18.05/resources

Parameters:

• finder: FilterByManagerReportsFlagRF

A front office person. For example, sales persons or partner members can be tagged as resources.

PartnerEnrolledProgramVA

Operation: /crmRestApi/resources/11.13.18.05/partnerEnrolledProgramsLOV

Parameters:

• finder: PartnerEnrolledProgramsFinderByPartner%3BPartnerPartyId%3D{PartnerId}

The partner enrolled programs list of values resource is used to view a list of the partner programs a partner is enrolled in.

PartnerOwnerPicker

Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/PartnerOwnerPicker

Parameters:

• dealsUniqID: $request.path.dealsUniqID

The partner owner picker resource is used to create a list of partners that is used to select the partner owner.

PartnerPickerVA

Operation: /crmRestApi/resources/11.13.18.05/partnersLOV

The partner list of values resource is used to view a list of partners.

PartnerTypeVA

Operation: /crmRestApi/resources/11.13.18.05/partnerTypesLOV

Parameters:

• finder: PartnerTypesFinder%3BOwnerId%3D{PartnerId}

A list of business relationships shared with a partner.

PhoneCountryCodePVOVA

Operation: /crmRestApi/resources/11.13.18.05/countryCodes

The country codes resource is used to get the country codes for phone numbers. All responses for the country codes resource will include a response header Cache-Control. The Cache-Control header indicates the amount of time for which the results are cached in the browser. For example, Cache-Control: "private, max-age=3600" indicates that the response is cached in the browser for 1 hour (3600 seconds). You need to have PER_MANAGE_PERSON_PHONE_PRIV.

StatusCodeVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

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

The lookups resource is used to view standard lookup codes.

autoSyncDealSizeAndProductAmountTotal

Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/action/autoSyncDealSizeAndProductAmountTotal

Parameters:

• dealsUniqID: $request.path.dealsUniqID

This method lets you calculate total of all product line amounts.

calculateProductAmountTotal

Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/action/calculateProductAmountTotal

Parameters:

• dealsUniqID: $request.path.dealsUniqID

This method lets you calculate total of all product line amounts.

convertDealToOpportunity

Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/action/convertDealToOpportunity

Parameters:

• dealsUniqID: $request.path.dealsUniqID

This method lets you convert a deal to an opportunity.

copyDeal

Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/action/copyDeal

Parameters:

• dealsUniqID: $request.path.dealsUniqID

This method lets you make copy of current deal.

dealSizeOrProductAmountTotalChanged

Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/action/dealSizeOrProductAmountTotalChanged

Parameters:

• dealsUniqID: $request.path.dealsUniqID

This method lets you check if the deal or product amount changed.

performApprovalAction

Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/action/performApprovalAction

Parameters:

• dealsUniqID: $request.path.dealsUniqID

This method lets you perform approval action on a deal registration.

productGroups

Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/productGroups

Parameters:

• dealsUniqID: $request.path.dealsUniqID

The product group resource is used to view information about related products. A product group is a business object that groups related products so that you can work with them together. You can use product groups to create a multilevel hierarchy that can be used as a sales catalog, a rollup hierarchy, or a promotion catalog. For example, you might create a product group named Consumer Electronics that includes all of your consumer electronics products so that customers can browse through all the products in this group in your product catalog.

products

Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/products

Parameters:

• dealsUniqID: $request.path.dealsUniqID

The product resource is used to view product information. A product is an item that an organization or company intends to sell.

refreshContactRow

Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/action/refreshContactRow

Parameters:

• dealsUniqID: $request.path.dealsUniqID

This method lets you refresh a contact field. - Not Supported

refreshCustomerRow

Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/action/refreshCustomerRow

Parameters:

• dealsUniqID: $request.path.dealsUniqID

This method lets you refresh customer field. - Not Supported

smartActions

Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/child/smartActions

Parameters:

• dealsUniqID: $request.path.dealsUniqID

The smart actions resource is used to view the name, security, context object, REST operation, confirmation message, and other global properties of smart actions. Smart action item or collection links returned in response payloads are valid at the moment the REST request is processed. Any change to the parent object context can invalidate a previously valid smart action.

Back to Top

Examples

The following example shows how to create a deal registration by submitting a post request on the REST resource using cURL.

cURL Command

curl -u <username:password> \ -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/deals

Example of Request Body

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

{
  "CloseDate": "2015-09-30",
  "ContactId":12443,
  "CustomerId":999997550054894,
  "DealSize":9999,
  "DealType": "ORA_EXISTING"
 }

Example of Response Body

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

{
  StatusCode: "ORA_DRAFT"
  CloseDate: "2015-09-30"
  ContactId: 12443
  CurrencyCode: "USD"
  CustomerId: 999997550054894
  DealId: 300100071394174
  DealNumber: "CDRM_2002"
  DealSize: 9999
  DealType: "ORA_EXISTING"
  OwnerId: 100000016934102
  PartnerId: 100000016934002
  PartnerLevel: "SILVER"
  PartnerOwnerName: "Account_MgrENT1 CAM"
  DealContactName: "VP of Sales Alan D Adams "
  DealCustomerName: "Advantage Corp (Columbus, US)"
  CustomerPartyType: "ORGANIZATION"
  ...
}

Back to Top