BusinessOpportunities

Queryable, Introduced in version 25.9

GET https://localhost:8001/sv/001.1/api/v1/Sales/BusinessOpportunities

Represents a business opportunity.

GUID

6502c4f7-2fe6-49f1-9a75-4232ff9029eb

Required permission

Show business opportunity

Properties

Name	Type	Summary	Introduced in
Id	Int64	The business key identifier of the business opportunity.
OpportunityNumber	String	The human readable identifier of the business opportunity. Max length is 15 Unique
StartDate	DateTimeOffset	The start date of the business opportunity.
PlannedEndDate	DateTimeOffset?	The planned end date of the business opportunity.
ActualEndDate	DateTimeOffset?	The actual end date of the business opportunity.
BusinessOpportunityGroupId	Int64?	The business key identifier of the business opportunity's group. References BusinessOpportunityGroups
BusinessOpportunityGroup	BusinessOpportunityGroups	The business opportunity's group. Expandable
BusinessOpportunityCategory	String	The category of the business opportunity. Max length is 20
SalesProcessTemplateId	Int64?	The business key identifier of the business opportunity's sales process template. References SalesProcessTemplates
SalesProcessTemplate	SalesProcessTemplates	The business opportunity's sales process template. Expandable
OurReferenceId	Int64?	The business key identifier of the business opportunity's our reference. References Persons
OurReference	Persons	The business opportunity's our reference. Expandable
Description	String	The description of the business opportunity. Max length is 400
Status	Int32	The status of the business opportunity. Registered: 1 InProgress: 3 Finished: 4 Cancelled: 5 Pending: 6 Historical: 9
Priority	Int32	The priority of the business opportunity.
BusinessOpportunityTypeId	Int64?	The business key identifier of the business opportunity's type. References BusinessOpportunityTypes
BusinessOpportunityType	BusinessOpportunityTypes	The business opportunity's type. Expandable
CommentId	Int64?	The business key identifier of the business opportunity's comment. References Comments
Comment	Comments	The business opportunity's comment. Expandable
ReasonLostCommentId	Int64?	The business key identifier of the business opportunity's comment on lost opportunity. References Comments
ReasonLostComment	Comments	The business opportunity's comment on lost opportunity. Expandable
TotalValue	Decimal?	The total value of the business opportunity.
SellerId	Int64?	The business key identifier of the business opportunity's seller. References Persons
Seller	Persons	The business opportunity's seller. Expandable
Name	String	The translated name of the business opportunity.
ReferenceName	String	The reference name of the business opportunity. Max length is 80
ReasonCodeLostQuoteId	Int64?	The business key identifier of the business opportunity's reason code for lost quote. References ReasonCodeLostQuotes
ReasonCodeLostQuote	ReasonCodeLostQuotes	The business opportunity's reason code for lost quote. Expandable
BusinessContactNoteHistories	BusinessContactNoteHistories[]	The business contact note history entries for the business opportunity. Expandable
Customers	Customers[]	The customers on the business opportunity. Expandable

Example

{
  "Id": 0,
  "OpportunityNumber": null,
  "StartDate": "0001-01-01T00:00:00+00:00",
  "PlannedEndDate": null,
  "ActualEndDate": null,
  "BusinessOpportunityGroupId": null,
  "BusinessOpportunityGroup": null,
  "BusinessOpportunityCategory": null,
  "SalesProcessTemplateId": null,
  "SalesProcessTemplate": null,
  "OurReferenceId": null,
  "OurReference": null,
  "Description": null,
  "Status": 0,
  "Priority": 0,
  "BusinessOpportunityTypeId": null,
  "BusinessOpportunityType": null,
  "CommentId": null,
  "Comment": null,
  "ReasonLostCommentId": null,
  "ReasonLostComment": null,
  "TotalValue": null,
  "SellerId": null,
  "Seller": null,
  "Name": null,
  "ReferenceName": null,
  "ReasonCodeLostQuoteId": null,
  "ReasonCodeLostQuote": null,
  "BusinessContactNoteHistories": null,
  "Customers": null
}