Get a List of Sales Opportunities

This web service will return a full list of all sales opportunities if none of the below filters are passed.

Query String Parameters

Name	Type	Description	Required
Action	String	SalesOpportunityList	Required
Reference	String	The sales opportunity reference.	Optional
CreatedFrom	DateTime	The date the sales opportunity was created. If specifying CreatedFrom, you must also include CreatedTo.	Optional
CreatedTo	DateTime	The date the sales opportunity was created. If specifying CreatedTo, you must also include CreatedFrom.	Optional
ClosedFrom	DateTime	The date the sales opportunity was closed.	Optional
ClosedTo	DateTime	The date the sales opportunity was closed.	Optional
SalesStatus	String	The sales status. See Notes.	Optional
SalesStage	String	The sales stages that have been defined in BigChange. This is a the name of the sales stage that you have setup in BigChange	Optional
SalesProbability	String	The sales probability that have been defined in BigChange.	Optional
ContactGroupId	Int	The contact group Id.	Optional
ContactId	Int	The contact Id.	Optional
OwnerId	Int	The owner Id used to create the sales opportunity.	Optional
StartRow	Int	The page start.	Optional
RowCount	Int	The number of sales opportunities.	Optional
SortCol	String	The sorting column. Defaults to the salesOpportunityId	Optional
SortDir	String	The sorting direction. Defaults to ASC.	Optional
ResultCount	Int	The total number of rows.	Optional
IncludeCustomFields	Bool	If set to true, the sales opportunities will include all custom fields. Defaults to false	Optional

Notes

SalesStatus

• New
• OnHold
• CompletedWon
• CompletedLost

Response Codes

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=SalesOpportunityList&Reference=SO/2579

Response

Response Data

{
  "Code": 0,
  "Result": [
    {
      "SalesOpportunityId": 2135467,
      "SalesOpportunityReference": "SO/2579",
      "SalesOpportunityContactId": 30966833,
      "SalesOpportunityContactUserId": null,
      "SalesOpportunityContactName": "Joe Bloggs",
      "SalesOpportunitySOStageId": 26,
      "SalesOpportunitySOStageName": "Quotation",
      "SalesOpportunitySOProbabilityId": 19,
      "SalesOpportunitySOProbabilityName": "Test",
      "SalesOpportunitySOProbabilityColor": "plum",
      "SalesOpportunityStatus": 1,
      "SalesOpportunityTitle": "Test Sales Opp",
      "SalesOpportunityNote": "",
      "SalesOpportunityCloseDate": "2024-09-30 01:00:00",
      "SalesOpportunityCurrency": "GBP",
      "SalesOpportunityCost": 3,
      "SalesOpportunityTotalExclTax": 6,
      "SalesOpportunityTotalInclTax": 6.3,
      "SalesOpportunityCreationDate": "2024-09-27 15:07:39",
      "SalesOpportunityOwnerId": 25193,
      "SalesOpportunityOwnerName": "Joe Bloggs (Admin)",
      "SalesOpportunityCurrentTagId": null
    }
  ]
}