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
Root Schema : schema
Type:
Show Source
object
-
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.
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
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
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
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
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
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
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
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
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
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
Nested Schema : schema
Type:
Show Source
object
-
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
-
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.
Nested Schema : schema
Type:
Show Source
object
-
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.
Nested Schema : schema
Type:
Show Source
object
-
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.
Nested Schema : deals-MatchedOpportunity-item-post-request
Type:
Show Source
object
-
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.
Nested Schema : schema
Type:
Show Source
object
-
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.
Nested Schema : deals-products-item-post-request
Type:
Show Source
object
-
Text: string
Title:
Keyword
The text or keywords associated with the product.
Nested Schema : deals-smartActions-item-post-request
Type:
Show Source
object
-
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
-
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.
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
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
Nested Schema : deals-smartActions-UserActionRequestPayload-item-post-request
Type:
Show Source
object
-
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.
Nested Schema : deals-smartActions-UserActionURLBinding-item-post-request
Type:
Show Source
object
-
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.
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.
Root Schema : deals-item-response
Type:
Show Source
object
-
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.
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
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
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
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
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
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
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
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
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
Nested Schema : deals-DealApprovalHistory-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : deals-DealAttachments-item-response
Type:
Show Source
object
-
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
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : deals-DealProduct-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : deals-DealResources-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : deals-MatchedOpportunity-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : deals-Note-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : deals-PartnerOwnerPicker-item-response
Type:
Show Source
object
-
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
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : deals-productGroups-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : deals-products-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : deals-smartActions-item-response
Type:
Show Source
object
-
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
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
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
Nested Schema : deals-smartActions-UserActionRequestPayload-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : deals-smartActions-UserActionURLBinding-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- CountryVA
-
Parameters:
- finder:
ObsoleteEnabledFlagFinder%3BBindEnabledFlag%3DY%2CBindObsoleteFlag%3DN
The territories resource is used to get a list of ISO standard territories. - finder:
- CurrencyCodeVA
-
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
-
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. - dealsUniqID:
- 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. - dealsUniqID:
- 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. - dealsUniqID:
- DealRejectedReasonCodeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKL_DEAL_REJECT_REASON%2CBindLookupCode%3D{DealRejectedReasonCode}
The lookups resource is used to view standard lookup codes. - finder:
- 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. - dealsUniqID:
- DealReturnReasonCodeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKL_DEAL_RETURN_REASON%2CBindLookupCode%3D{DealReturnReasonCode}
The lookups resource is used to view standard lookup codes. - finder:
- DealTypeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKL_DEALREG_DEAL_TYPE%2CBindLookupCode%3D{DealType}
The lookups resource is used to view standard lookup codes. - finder:
- 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. - dealsUniqID:
- 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. - dealsUniqID:
- OwnerPicker
-
Operation: /crmRestApi/resources/11.13.18.05/resourcesParameters:
- finder:
FilterByManagerReportsFlagRF
A front office person. For example, sales persons or partner members can be tagged as resources. - finder:
- PartnerEnrolledProgramVA
-
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. - finder:
- 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. - dealsUniqID:
- PartnerPickerVA
-
The partner list of values resource is used to view a list of partners.
- PartnerTypeVA
-
Parameters:
- finder:
PartnerTypesFinder%3BOwnerId%3D{PartnerId}
A list of business relationships shared with a partner. - finder:
- PhoneCountryCodePVOVA
-
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
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKL_DEAL_REG_STATUS%2CBindLookupCode%3D{StatusCode}
The lookups resource is used to view standard lookup codes. - finder:
- autoSyncDealSizeAndProductAmountTotal
-
Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/action/autoSyncDealSizeAndProductAmountTotalParameters:
- dealsUniqID:
$request.path.dealsUniqID
This method lets you calculate total of all product line amounts. - dealsUniqID:
- calculateProductAmountTotal
-
Parameters:
- dealsUniqID:
$request.path.dealsUniqID
This method lets you calculate total of all product line amounts. - dealsUniqID:
- convertDealToOpportunity
-
Parameters:
- dealsUniqID:
$request.path.dealsUniqID
This method lets you convert a deal to an opportunity. - dealsUniqID:
- copyDeal
-
Parameters:
- dealsUniqID:
$request.path.dealsUniqID
This method lets you make copy of current deal. - dealsUniqID:
- dealSizeOrProductAmountTotalChanged
-
Operation: /crmRestApi/resources/11.13.18.05/deals/{dealsUniqID}/action/dealSizeOrProductAmountTotalChangedParameters:
- dealsUniqID:
$request.path.dealsUniqID
This method lets you check if the deal or product amount changed. - dealsUniqID:
- performApprovalAction
-
Parameters:
- dealsUniqID:
$request.path.dealsUniqID
This method lets you perform approval action on a deal registration. - dealsUniqID:
- 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. - dealsUniqID:
- 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. - dealsUniqID:
- refreshContactRow
-
Parameters:
- dealsUniqID:
$request.path.dealsUniqID
This method lets you refresh a contact field. - Not Supported - dealsUniqID:
- refreshCustomerRow
-
Parameters:
- dealsUniqID:
$request.path.dealsUniqID
This method lets you refresh customer field. - Not Supported - dealsUniqID:
- 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. - dealsUniqID:
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" ... }