Skip to main content

Add or Update a Sales Opportunity

Should be used in conjunction with the add sales opportunity financial line service.

Query String Parameters

NameTypeDescriptionRequired
ActionStringSalesOpportunityRequired
SalesOpportunityContactIdIntContactId to associate the sales opportunity with. ContactId’s can be retrieved using services described in the Contacts section.Required
SalesOpportunitySOStageIdIntStageId to set against sales opportunity. StageId’s can be retrieved using the SalesOpStages service.Required
SalesOpportunityProbabilityIdIntProbability Id to set against sales opportunity. Probability Id’s can be retrieved using the SalesOpProbabilities service.Required
SalesOpportunityTitleString(50)Title of the sales opportunity.Required
SalesOpportunityStatusStringStatus to set against sales opportunity. Statuses can be retrieved using the SalesOpStatuses service.Required
SalesOpportunityIdIntId of the sales opportunity to update. If the SalesOpportunityId does not exist a new sales opportunity will not be added.Required, when updating
SalesOpportunityReferenceStringThe reference of the sales opportunity to update. Only required if SalesOpportunityId is not suppliedRequired, when updating
SalesOpportunityNoteStringThe description of the sales opportunity.Optional
SalesOpportunityCompletionNoteStringSales Opportunity completion details.Optional
SalesOpportunityCloseDateTimeDateTimeDue Date for the sales opportunity. Format: yyyy-MM-ddOptional
SalesOpportunityCurrencyStringA valid currency code. If none passed defaults to "GBP".Optional
SalesOpportunityCostDoubleCost of the sales opportunity. Generally calculated from financial lines added when a document is created.Optional
SalesOpportunityTotalExclTaxDoubleTotal, before tax, payable on the sales opportunity. Generally calculated from financial lines added when a document is created.Optional
SalesOpportunityTotalInclTaxDoubleTotal, including tax, payable on the sales opportunity. Generally calculated from financial lines added when a document is created.Optional
cust_custom field nameString(500)Pass cust_ followed by the caption of an existing custom field.Optional
SalesOpportunityOwnerIdIntId of an existing user. Assigns the Id and name to this opportunity. If no user exists with the specified Id, the details will be taken from the credentials of used for the web service.Optional
SalesOpportunityContactUserIdIntId of an existing contact user. Assigns a contact user to the opportunity.Optional
SalesOpportunityContactReferenceStringReference of contact to associate Sales opportunity with.Optional

Response Codes

CodeMessageInformation
0Response DataSee 'Response' example tab

Example

Request URL

https://webservice.bigchange.com/v01/services.ashx?action=SalesOpportunity&SalesOpportunityContactId=30966833&SalesOpportunitySOStageId=26&SalesOpportunityProbabilityId=19&SalesOpportunityTitle=Test Sales Opp&SalesOpportunityStatus=1&SalesOpportunityCloseDateTime=2024-09-30