Opportunity/COMIT Automatic Create (Rest API Data Dictionary from Orion Team)

kathycobb

 Adding content that is provided on the link: 

http://kmc-confluence.sas.com/pages/viewpage.action?pageId=9144985

 

Opportunity/COMIT Automatic Create

  

• Created by Neal Haggard, last modified on Feb 16, 2017

This service was created to allow systems to automatically create an Opportunity without milestone requirements and move it to won, and create a COMIT Sale record for it.

Request information

POST <server>/rest/opportunities

 Content-Type: application/vnd.sas.orion.autoCreate+json

Accept: application/hal+json;v=30

Other headers as per our Authentication documentation.

Requirements

• Must provide a valid salesGroup. 
• The salesGroup provided must match the salesGroup of the user submitting the request
• Let me know if you need a list of these or how to map these to country.
• For the opportunity object::
  • Must provide either an accountId or cdhubId.
  • Must provide a description.
  • Must provide an amount.
  • Must provide a currencyCodeId, and it must be appropriate to the salesGroup.
  • Must provide at least one record in ips.
  • • Let me know if you need help finding employeeId, territoryId or roleId.
    •  Valid ownerType:
    • • P â€“ Primary
      • S â€“ Secondary
      • N â€“ Not Owner
    • One, and only one must have an ownerType of (P)
    • Do not provide duplicate employeeIds.
    • One, and only one must be marked with the finder as true.
  • Must provide a customerBusinessObjectiveId, this is a list value.
  • Must provide type, valid values include: 
  • • Consulting
    • Education
    • Software (Field Sales)
    • SoftwareIS (Inside Sales)
  • Must provide a likelihoodToCloseId, this is a list value.
  • Must provide a inputSourceType if:
  • • salesGroup is SA, CA, LN or LS and type is Software or SoftwareIS.
    • salesGroup is not SA, CA, LN or LS and type is SoftwareIS

To also create a COMIT record:

• Must specify a comit object.
  
  • Must provide at least one record in ips.
    • One, and only one must be marked owner.
    • Do not provide duplicate employeeIds. (See Search Employees)
  • Must provide one true value for the options in form.
• Must provide at least one record in contacts.
  
• Must provide at least one record in offerings.
• Must provide at least one record in sites.
• Must provide a non-null value for opportunity.multinationalDeal.
  • Valid options are Y or N.

Sample Input

?

<FONT face="Courier New" size="3">{</FONT> &nbsp;&nbsp;"cdhubId": 123, &nbsp;&nbsp;"opportunity": { &nbsp;&nbsp;&nbsp;&nbsp;"accountId": 53545, &nbsp;&nbsp;&nbsp;&nbsp;"amount": 3423245534, &nbsp;&nbsp;&nbsp;&nbsp;"autoCreated": true, &nbsp;&nbsp;&nbsp;&nbsp;"currencyCodeId": 87535, &nbsp;&nbsp;&nbsp;&nbsp;"description": "description", &nbsp;&nbsp;&nbsp;&nbsp;"estimatedServicesStartDate": "2013-11-17", &nbsp;&nbsp;&nbsp;&nbsp;"estimatedServicesEndDate": "2013-11-17", &nbsp;&nbsp;&nbsp;&nbsp;"eval": true, &nbsp;&nbsp;&nbsp;&nbsp;"evalConversion": true, &nbsp;&nbsp;&nbsp;&nbsp;"inputSourceType": "inputSourceType", &nbsp;&nbsp;&nbsp;&nbsp;"ips": [ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"employeeId": 65325, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"roleId": 23456, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"territoryId": 82348923, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"finder": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"ownerType": "ownerType", &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"splitPercentage": 123 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;], &nbsp;&nbsp;&nbsp;&nbsp;"leadSourceId": 123, &nbsp;&nbsp;&nbsp;&nbsp;"licenseBeginDate": "2013-11-17", &nbsp;&nbsp;&nbsp;&nbsp;"localName": "localName", &nbsp;&nbsp;&nbsp;&nbsp;"markedPrivate": true, &nbsp;&nbsp;&nbsp;&nbsp;"multinationalDeal": "no", &nbsp;&nbsp;&nbsp;&nbsp;"opportunityToCopyId": 123, &nbsp;&nbsp;&nbsp;&nbsp;"renewalType": "renewalType", &nbsp;&nbsp;&nbsp;&nbsp;"customerBusinessObjectiveId": 123, &nbsp;&nbsp;&nbsp;&nbsp;"customerBusinessObjectiveGroupCode": "cboGroupCode", &nbsp;&nbsp;&nbsp;&nbsp;"type": "type", &nbsp;&nbsp;&nbsp;&nbsp;"upgrade": true, &nbsp;&nbsp;&nbsp;&nbsp;"likelihoodToCloseId": 123, &nbsp;&nbsp;&nbsp;&nbsp;"evaluationTerm": "evaluationTerm" &nbsp;&nbsp;}, &nbsp;&nbsp;"salesGroup": "salesGroup", &nbsp;&nbsp;"contacts": [ &nbsp;&nbsp;&nbsp;&nbsp;{ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"contactId": 456, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"opportunityId": 789, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"role": "Role Value", &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"origin": "Origin Value", &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"pain": "Pain", &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"reasons": "Reasons", &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"impact": "Impact", &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"buyingVision": "Buying Vision", &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"value": "Value", &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"pathToPower": "Path to Power", &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"nextStep": "Next Step", &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"comments": "Comments" &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;], &nbsp;&nbsp;"sites": [ &nbsp;&nbsp;&nbsp;&nbsp;{ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"site": "site", &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"active": true &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;], &nbsp;&nbsp;"offerings": [ &nbsp;&nbsp;&nbsp;&nbsp;{ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"offeringId": 123, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"opportunityId": 234, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"sbo": "sbo" &nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;], &nbsp;&nbsp;"comit": { &nbsp;&nbsp;&nbsp;&nbsp;"firstPeriodTerm": "12 Months", &nbsp;&nbsp;&nbsp;&nbsp;"dealLength": 123, &nbsp;&nbsp;&nbsp;&nbsp;"urgentTypes": [ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"Software" &nbsp;&nbsp;&nbsp;&nbsp;], &nbsp;&nbsp;&nbsp;&nbsp;"contractNumber": "contractNumber", &nbsp;&nbsp;&nbsp;&nbsp;"followUpContactId": 123, &nbsp;&nbsp;&nbsp;&nbsp;"followUpEmployeeId": 123, &nbsp;&nbsp;&nbsp;&nbsp;"followUpComment": "followUpComment", &nbsp;&nbsp;&nbsp;&nbsp;"followUpDate": "2013-11-17", &nbsp;&nbsp;&nbsp;&nbsp;"poNumber": "poNumber", &nbsp;&nbsp;&nbsp;&nbsp;"renewalFee": { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"amount": 1.0, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"adjustedAmount": 1.0, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"percentage": { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"uplift": 1.0, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"margin": 1.0 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;}, &nbsp;&nbsp;&nbsp;&nbsp;"standardDeal": true, &nbsp;&nbsp;&nbsp;&nbsp;"customSolutionName": "customSolutionName", &nbsp;&nbsp;&nbsp;&nbsp;"salesCreditNote": "salesCreditNote", &nbsp;&nbsp;&nbsp;&nbsp;"growthValue": 1.0, &nbsp;&nbsp;&nbsp;&nbsp;"globalAppliedToFyf": 1.0, &nbsp;&nbsp;&nbsp;&nbsp;"globalAllocation": 1.0, &nbsp;&nbsp;&nbsp;&nbsp;"globalPercentage": 1.0, &nbsp;&nbsp;&nbsp;&nbsp;"softwareSaleCredits": 1.0, &nbsp;&nbsp;&nbsp;&nbsp;"educationSaleCredits": 1.0, &nbsp;&nbsp;&nbsp;&nbsp;"servicesSaleCredits": 1.0, &nbsp;&nbsp;&nbsp;&nbsp;"expectedInvoiceDate": "2013-11-17", &nbsp;&nbsp;&nbsp;&nbsp;"opportunityId": 123, &nbsp;&nbsp;&nbsp;&nbsp;"ownedBy": "ownedBy", &nbsp;&nbsp;&nbsp;&nbsp;"saleType": "saleType", &nbsp;&nbsp;&nbsp;&nbsp;"form": { &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"evaluationConversion": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"mlaNeeded": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"supplementNeeded": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cciNeeded": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"evaluationAgreementNeeded": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"jmpSupplementNeeded": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"thirdPartyPayment": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"asp": "ASP", &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"rdFeeWaivedSupplement": true, <FONT size="3">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</FONT><FONT size="3">"longTermDemoAgreement"</FONT>: true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"shortTermDemoAgreement": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"teamingAgreement": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"cooperationAgreement": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"findersFeeAgreement": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"nonDisclosureAgreement": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"hostedAgreement": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"systemsIntegratorAmendmentAgreement": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"allianceLocalCountryAgreement": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"allianceExhibitBTeamingAgreement": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"allianceDevelopmentDemonstrationSoftwareSupplement": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"eptoOnlyForm": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"onlineOrder": true, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"storeOrderNum": "storeOrderNum", &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"language": [ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;123, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;123 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;] &nbsp;&nbsp;&nbsp;&nbsp;}, &nbsp;&nbsp;&nbsp;&nbsp;"dealTypeId": 123, &nbsp;&nbsp;&nbsp;&nbsp;"ips": [ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;{ &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"employeeId": 123, &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"owner": true &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;} &nbsp;&nbsp;&nbsp;&nbsp;] &nbsp;&nbsp;} <FONT face="Courier New" size="3">}</FONT>