<a id=“SuperOffice_WebApi_Agents_SaleAgent”></a> Class SaleAgent
Namespace: SuperOffice.WebApi.AgentsAssembly: SuperOffice.WebApi.dll Sale data services
Inheritance
object ← AgentBase ← SaleAgentImplements
ISaleAgent, IAgentBase, IDisposableInherited Members
AgentBase._json, AgentBase._binary, AgentBase._config, AgentBase._client, AgentBase._disposeClient, AgentBase.Merge(RequestOptions), AgentBase.BuildRequestFromObject(HttpMethod, string, object, WebApiOptions, string), AgentBase.BuildRequestFromStream(HttpMethod, string, Stream, WebApiOptions, string), AgentBase.BuildRequestFromObjectWithStream(HttpMethod, string, object, Stream, WebApiOptions, string), AgentBase.ParseAuthorization(IAuthorization), AgentBase.CancelRequest(), AgentBase.SendRequestObject(HttpMethod, string, object, WebApiOptions, string), AgentBase.SendRequestObjectWithStream(HttpMethod, string, object, Stream, WebApiOptions, string), AgentBase.SendRequest(HttpRequestMessage, RequestOptions), AgentBase.ThrowOnResponseErrorAsync(HttpRequestMessage, HttpResponseMessage), AgentBase.ParseResponse<T>(HttpResponseMessage), AgentBase.Finally(RequestOptions), AgentBase.Dispose(), AgentBase.Configuration, AgentBase.Client, AgentBase.HasRunningRequest, AgentBase.ClientCancellationTokenSource, AgentBase.ProgressListener, AgentBase.UploadProgressListener, object.ToString(), object.Equals(object), object.Equals(object, object), object.ReferenceEquals(object, object), object.GetHashCode(), object.GetType(), object.MemberwiseClone()Examples
<pre><code class=“lang-csharp”>using SuperOffice.WebApi; using SuperOffice.WebApi.Agents; var mySession = new WebApiOptions(“http://example.com/super/api”); mySession.Authorization = new AuthorizationUsernamePassword(“user”, “pass”); using (SaleAgent agent = new SaleAgent(mySession)) { // call methods on agent here… }</code></pre>Constructors
<a id=“SuperOffice_WebApi_Agents_SaleAgent__ctor_System_Net_Http_HttpClient_”></a> SaleAgent(HttpClient)
Constructor: Sale data servicesParameters
httpClient HttpClient
Use this HTTP client instead of making own HttpClient instance.
<a id=“SuperOffice_WebApi_Agents_SaleAgent__ctor_SuperOffice_WebApi_WebApiOptions_System_Net_Http_HttpClient_”></a> SaleAgent(WebApiOptions, HttpClient)
Constructor: Sale data servicesParameters
options WebApiOptions
Base URL and authentication values.
httpClient HttpClient
Optional: Use this HTTP client instead of making a new one.
Methods
<a id=“SuperOffice_WebApi_Agents_SaleAgent_AddSaleStakeholdersAsync_System_Int32_SuperOffice_WebApi_Data_SaleStakeholder___SuperOffice_WebApi_RequestOptions_”></a> AddSaleStakeholdersAsync(int, SaleStakeholder[], RequestOptions)
Parameters
saleId int
saleStakeholders SaleStakeholder[]
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_SaleAgent_BatchUpdateNextDueDateAsync_SuperOffice_WebApi_RequestOptions_”></a> BatchUpdateNextDueDateAsync(RequestOptions)
Re-calculate all the next due datesParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_SaleAgent_CreateDefaultSaleEntityAsync_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultSaleEntityAsync(RequestOptions)
Set default values into a new SaleEntity. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleEntity> A blank SaleEntity<a id=“SuperOffice_WebApi_Agents_SaleAgent_CreateDefaultSaleStakeholderAsync_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultSaleStakeholderAsync(RequestOptions)
Set default values into a new SaleStakeholder. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleStakeholder> A blank SaleStakeholder<a id=“SuperOffice_WebApi_Agents_SaleAgent_CreateDefaultSaleSummaryAsync_SuperOffice_WebApi_RequestOptions_”></a> CreateDefaultSaleSummaryAsync(RequestOptions)
Set default values into a new SaleSummary. NetServer calculates default values on the entity, which is required when creating/storing a new instanceParameters
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleSummary> A blank SaleSummary<a id=“SuperOffice_WebApi_Agents_SaleAgent_DeleteSaleEntityAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> DeleteSaleEntityAsync(int, RequestOptions)
Deletes the SaleEntityParameters
saleEntityId int
The identity of the SaleEntity
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_SaleAgent_DeleteSaleStakeholderAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> DeleteSaleStakeholderAsync(int, RequestOptions)
Deletes the SaleStakeholderParameters
saleStakeholderId int
The identity of the SaleStakeholder
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_SaleAgent_DeleteSaleStakeholdersAsync_System_Int32___SuperOffice_WebApi_RequestOptions_”></a> DeleteSaleStakeholdersAsync(int[], RequestOptions)
Parameters
saleStakeholderIds int[]
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_SaleAgent_GetMyOpportunitiesAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetMyOpportunitiesAsync(int, RequestOptions)
Returning the opportunities (open sales) belonging to the user currently logged onParameters
count int
The number of sales that is returned. -1 returns all.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Sale[]> Array of open sales (opportunities).<a id=“SuperOffice_WebApi_Agents_SaleAgent_GetNextDueDateAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetNextDueDateAsync(int, RequestOptions)
Gets the next due date for a sale. The next due date is the next future appointment that is not completed.Parameters
saleId int
Sale id
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<DateTime> Next due date for the given sale.<a id=“SuperOffice_WebApi_Agents_SaleAgent_GetNextSaleStageAsync_System_Int32_System_Boolean_SuperOffice_WebApi_RequestOptions_”></a> GetNextSaleStageAsync(int, bool, RequestOptions)
Gets the next (not deleted) sale stage id if the current stage is deleted. If the current stage is not deleted, the CurrentStageId is returnedParameters
saleId int
includeCurrentStage bool
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<int><a id=“SuperOffice_WebApi_Agents_SaleAgent_GetOpenSalesForContactAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetOpenSalesForContactAsync(int, RequestOptions)
Returns all open sales for the contact provided.Parameters
contactId int
The ID of the contact whose sales we want.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Sale[]> Aray of sales.<a id=“SuperOffice_WebApi_Agents_SaleAgent_GetProbabilityFromStageAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetProbabilityFromStageAsync(int, RequestOptions)
Get the probability percentage for a given sale stageParameters
stageId int
Probability list id
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<int> Probability percentage<a id=“SuperOffice_WebApi_Agents_SaleAgent_GetRecentSalesAsync_System_Int32_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetRecentSalesAsync(int, int, RequestOptions)
Returns the latest sales (that are sold) limited by their amount. The result is sorted descending with the latest first. If the amount is -1, the amount restriction is omitted.Parameters
amountLimit int
The amount limit in the local currency.
count int
The maximum number of items to return. If -1 all are returned.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Sale[]> Array of all recent sales.<a id=“SuperOffice_WebApi_Agents_SaleAgent_GetSaleAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetSaleAsync(int, RequestOptions)
Gets a specific Sale object.Parameters
saleId int
The identifier of the Sale object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Sale> Sale<a id=“SuperOffice_WebApi_Agents_SaleAgent_GetSaleEntityAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetSaleEntityAsync(int, RequestOptions)
Gets a specific SaleEntity object.Parameters
saleEntityId int
The identifier of the SaleEntity object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleEntity> SaleEntity<a id=“SuperOffice_WebApi_Agents_SaleAgent_GetSaleListAsync_System_Int32___SuperOffice_WebApi_RequestOptions_”></a> GetSaleListAsync(int[], RequestOptions)
Gets an array of specific Sale objects.Parameters
saleIds int[]
The identifiers of the Sale object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Sale[]> Array of Sale objects<a id=“SuperOffice_WebApi_Agents_SaleAgent_GetSaleStakeholderAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetSaleStakeholderAsync(int, RequestOptions)
Gets a specific SaleStakeholder object.Parameters
saleStakeholderId int
The identifier of the SaleStakeholder object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleStakeholder> SaleStakeholder<a id=“SuperOffice_WebApi_Agents_SaleAgent_GetSaleStakeholderByIdAsync_System_Int32___SuperOffice_WebApi_RequestOptions_”></a> GetSaleStakeholderByIdAsync(int[], RequestOptions)
Parameters
saleStakeholderIds int[]
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleStakeholder[]><a id=“SuperOffice_WebApi_Agents_SaleAgent_GetSaleStakeholderListAsync_System_Int32___SuperOffice_WebApi_RequestOptions_”></a> GetSaleStakeholderListAsync(int[], RequestOptions)
Gets an array of specific SaleStakeholder objects.Parameters
saleStakeholderIds int[]
The identifiers of the SaleStakeholder object
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleStakeholder[]> Array of SaleStakeholder objects<a id=“SuperOffice_WebApi_Agents_SaleAgent_GetSaleStakeholdersAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetSaleStakeholdersAsync(int, RequestOptions)
Parameters
saleId int
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleStakeholder[]><a id=“SuperOffice_WebApi_Agents_SaleAgent_GetSalesByDateAsync_System_DateTime_System_DateTime_System_Int32_SuperOffice_WebApi_Data_SaleStatus_SuperOffice_WebApi_RequestOptions_”></a> GetSalesByDateAsync(DateTime, DateTime, int, SaleStatus, RequestOptions)
Returns all sales within a time period. The sales array can be limited by amount and status.Parameters
fromDate DateTime
The beginning of the time interval.
toDate DateTime
The end of the time interval.
amountLimit int
The amount limit in the local currency. -1 means no amount limit
status SaleStatus
The sale status (Lost, Open, Sold, Unknown). SaleStatus.Unknown means no status filtering.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Sale[]> Array of sales.<a id=“SuperOffice_WebApi_Agents_SaleAgent_GetSalesFromContactAsync_System_Int32_System_Boolean_SuperOffice_WebApi_RequestOptions_”></a> GetSalesFromContactAsync(int, bool, RequestOptions)
Returns all sales for the contact provided.Parameters
contactId int
The ID of the contact whose sales we want.
onlyOpenSales bool
If true, only get open sales.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Sale[]> List of sales matching query<a id=“SuperOffice_WebApi_Agents_SaleAgent_GetSalesFromPersonAsync_System_Int32_System_Boolean_SuperOffice_WebApi_RequestOptions_”></a> GetSalesFromPersonAsync(int, bool, RequestOptions)
Returns all sales for the person provided.Parameters
personId int
The ID of the person whose sales we want.
onlyOpenSales bool
If true, only get open sales.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Sale[]> List of sales matching query<a id=“SuperOffice_WebApi_Agents_SaleAgent_GetSummaryByAssociateAsync_System_Int32_System_DateTime_System_DateTime_SuperOffice_WebApi_RequestOptions_”></a> GetSummaryByAssociateAsync(int, DateTime, DateTime, RequestOptions)
Parameters
associateId int
fromDate DateTime
toDate DateTime
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleSummary><a id=“SuperOffice_WebApi_Agents_SaleAgent_GetSummaryByContactAsync_System_Int32_System_DateTime_System_DateTime_SuperOffice_WebApi_RequestOptions_”></a> GetSummaryByContactAsync(int, DateTime, DateTime, RequestOptions)
Parameters
contactId int
fromDate DateTime
toDate DateTime
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleSummary><a id=“SuperOffice_WebApi_Agents_SaleAgent_GetSummaryByGroupAsync_System_Int32_System_DateTime_System_DateTime_SuperOffice_WebApi_RequestOptions_”></a> GetSummaryByGroupAsync(int, DateTime, DateTime, RequestOptions)
Parameters
groupId int
fromDate DateTime
toDate DateTime
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleSummary><a id=“SuperOffice_WebApi_Agents_SaleAgent_GetUpcomingSalesAsync_System_Int32_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> GetUpcomingSalesAsync(int, int, RequestOptions)
Returns all open sales, sorted descending with the latest first. If the weigthed amount is -1, the amount restriction is omitted.Parameters
weightedAmountLimit int
The amount weighted by the probability that the sale is closed (amount * probability).
count int
The maximum number of items to return. If -1 all are returned.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<Sale[]> Array of upcoming sales.<a id=“SuperOffice_WebApi_Agents_SaleAgent_HasGuideActivitiesAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> HasGuideActivitiesAsync(int, RequestOptions)
Parameters
saleId int
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<bool><a id=“SuperOffice_WebApi_Agents_SaleAgent_HasGuideAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> HasGuideAsync(int, RequestOptions)
Does this sale have a sale guide associated with its sale type?Parameters
saleId int
Sale id
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<bool> True if the sale has a guide<a id=“SuperOffice_WebApi_Agents_SaleAgent_HasStakeholderSettingAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> HasStakeholderSettingAsync(int, RequestOptions)
Parameters
saleId int
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<bool><a id=“SuperOffice_WebApi_Agents_SaleAgent_IsNumberValidAsync_System_Int32_System_String_SuperOffice_WebApi_RequestOptions_”></a> IsNumberValidAsync(int, string, RequestOptions)
Checks if the number is unique or required. The setting is configured from admin under system options.Parameters
contactId int
SaleId
number string
Number value to check for uniqueness/required
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<bool> True if the number is valid<a id=“SuperOffice_WebApi_Agents_SaleAgent_OfferAutoNextStageOnApppointmentCompletedAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> OfferAutoNextStageOnApppointmentCompletedAsync(int, RequestOptions)
Parameters
appointmentId int
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<bool><a id=“SuperOffice_WebApi_Agents_SaleAgent_SaleHasQuoteAsync_System_Int32_SuperOffice_WebApi_RequestOptions_”></a> SaleHasQuoteAsync(int, RequestOptions)
Returns true is the sale has a quoteParameters
saleId int
The id of the sale
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<bool> True if the sale has a quote<a id=“SuperOffice_WebApi_Agents_SaleAgent_SaveSaleEntityAsync_SuperOffice_WebApi_Data_SaleEntity_SuperOffice_WebApi_RequestOptions_”></a> SaveSaleEntityAsync(SaleEntity, RequestOptions)
Updates the existing SaleEntity or creates a new SaleEntity if the id parameter is 0.Parameters
saleEntity SaleEntity
The SaleEntity that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleEntity> New or updated SaleEntity<a id=“SuperOffice_WebApi_Agents_SaleAgent_SaveSaleStakeholderAsync_SuperOffice_WebApi_Data_SaleStakeholder_SuperOffice_WebApi_RequestOptions_”></a> SaveSaleStakeholderAsync(SaleStakeholder, RequestOptions)
Updates the existing SaleStakeholder or creates a new SaleStakeholder if the id parameter is 0.Parameters
saleStakeholder SaleStakeholder
The SaleStakeholder that is saved.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleStakeholder> New or updated SaleStakeholder<a id=“SuperOffice_WebApi_Agents_SaleAgent_SetAsLostAsync_System_Int32___SuperOffice_WebApi_RequestOptions_”></a> SetAsLostAsync(int[], RequestOptions)
Change the status of one or more sales to Lost. Note that this does not affect the Completed state of the sale.Parameters
saleIds int[]
Array of sale ids to be marked as lost. All normal write access rules apply.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_SaleAgent_SetAsLostWithReasonAsync_System_Int32___System_Int32_SuperOffice_WebApi_RequestOptions_”></a> SetAsLostWithReasonAsync(int[], int, RequestOptions)
Change the status of one or more sales to Lost. Note that this does not affect the Completed state of the sale.Parameters
saleIds int[]
Array of sale ids to be marked as lost. All normal write access rules apply.
reasonId int
The ID of the lost reason.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_SaleAgent_SetAsSoldAsync_System_Int32___SuperOffice_WebApi_RequestOptions_”></a> SetAsSoldAsync(int[], RequestOptions)
Change the status of one or more Sales to Sold. Note that this does not mark them as Completed.Parameters
saleIds int[]
Array of sale ids to be marked as lost. All the normal write access rules apply.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_SaleAgent_SetAsSoldWithReasonAsync_System_Int32___System_Int32_SuperOffice_WebApi_RequestOptions_”></a> SetAsSoldWithReasonAsync(int[], int, RequestOptions)
Change the status of one or more Sales to Sold. Note that this does not mark them as Completed.Parameters
saleIds int[]
Array of sale ids to be marked as lost. All the normal write access rules apply.
reasonId int
The ID of the sold reason.
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<a id=“SuperOffice_WebApi_Agents_SaleAgent_UpdateSaleStakeholdersAsync_SuperOffice_WebApi_Data_SaleStakeholder___SuperOffice_WebApi_RequestOptions_”></a> UpdateSaleStakeholdersAsync(SaleStakeholder[], RequestOptions)
Parameters
stakeholders SaleStakeholder[]
requestOptions RequestOptions
Override language/culture codes on this request.
Returns
Task<SaleStakeholder[]><a id=“SuperOffice_WebApi_Agents_SaleAgent_ValidateSaleEntityAsync_SuperOffice_WebApi_Data_SaleEntity_SuperOffice_WebApi_RequestOptions_”></a> ValidateSaleEntityAsync(SaleEntity, RequestOptions)
Check that entity is ready for saving, return error messages by field.Parameters
saleEntity SaleEntity
Entity to be checked for errors.
requestOptions RequestOptions
Override language/culture codes on this request.