Get a Sales Opportunity

Provides the details of the specified sales opportunity.

Name	Type	Description	Required
Action	String	SalesOpportunityDetail	Required
SalesOpportunityId	Int	Id of Sales Opportunity to be retrieved.	Required, if reference not supplied
SalesOpportunityReference	String	Reference of Sales Opportunity to be retrieved.	Required, if Id not supplied
IncludeCustomFields	Bool	Defaults to false.	Optional

Response Codes

Example

Request

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=SalesOpportunityDetail&SalesOpportunityId=2135467

Response

Response Data

{
  "Code": 0,
  "Result": {
    "SalesOpportunity": {
      "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)"
    },
    "SalesOpportunityLines": {
      "SalesOpportunityLine 1": {
        "LineId": 107040163,
        "Quantity": 1,
        "NominalCode": "4001",
        "Description": "2 Deliverable Items",
        "ItemCost": 3,
        "UnitPrice": 6,
        "TaxRate": 5,
        "TaxAmount": 0.3,
        "TaxCode": "V3",
        "TaxDescription": null,
        "NetPrice": 6.3,
        "Currency": "GBP",
        "DepartmentCode": null,
        "DiscountedPercentage": null,
        "DiscountedValue": null,
        "LineType": "Predefined"
      }
    }
  }
}