NSSaleAgent - SuperOffice

Sale data services.

Constructors

NSSaleAgent()

NSSaleAgent

Sale data services.

Methods

AddSaleStakeholders(Integer,NSSaleStakeholder[])

Void AddSaleStakeholders(Integer saleId, NSSaleStakeholder[] saleStakeholders)

Returns: CRMScript.Global.Void

BatchUpdateNextDueDate()

Re-calculates all the next due dates

Void BatchUpdateNextDueDate()

Returns: CRMScript.Global.Void

CreateDefaultSaleEntity()

Sets default values into a new NSSaleEntity.

NSSaleEntity CreateDefaultSaleEntity()

Returns: CRMScript.NetServer.NSSaleEntity

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Example:

NSSaleAgent agent;
NSSaleEntity thing = agent.CreateDefaultSaleEntity();
thing = agent.SaveSaleEntity(thing);

CreateDefaultSaleStakeholder()

Sets default values into a new NSSaleStakeholder.

NSSaleStakeholder CreateDefaultSaleStakeholder()

Returns: CRMScript.NetServer.NSSaleStakeholder

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Example:

NSSaleAgent agent;
NSSaleStakeholder thing = agent.CreateDefaultSaleStakeholder();
thing = agent.SaveSaleStakeholder(thing);

CreateDefaultSaleSummary()

Sets default values into a new NSSaleSummary.

NSSaleSummary CreateDefaultSaleSummary()

Returns: CRMScript.NetServer.NSSaleSummary

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Example:

NSSaleAgent agent;
NSSaleSummary thing = agent.CreateDefaultSaleSummary();
thing = agent.SaveSaleSummary(thing);

DeleteSaleEntity(Integer)

Deletes the NSSaleEntity

DeleteSaleEntity(Integer saleEntity)

Returns: CRMScript.Global.Void Example:

NSSaleAgent agent;
agent.DeleteSaleEntity(123);

DeleteSaleStakeholder(Integer)

Deletes the NSSaleStakeholder

DeleteSaleStakeholder(Integer saleStakeholder)

Returns: CRMScript.Global.Void Example:

NSSaleAgent agent;
agent.DeleteSaleStakeholder(123);

DeleteSaleStakeholders(Integer[])

Void DeleteSaleStakeholders(Integer[] saleStakeholderIds)

Returns: CRMScript.Global.Void

GetMyOpportunities(Integer)

Returns opportunities (open sales) belonging to the user currently logged on

NSSale[] GetMyOpportunities(Integer count)

Returns: CRMScript.NetServer.NSSale[] Example:

NSSaleAgent agent;
Integer count;
NSSale[] res = agent.GetMyOpportunities(count);

GetNextDueDate(Integer)

Gets the next due date for a sale.

DateTime GetNextDueDate(Integer saleId)

Returns: CRMScript.Global.DateTime

The next due date is the next future appointment that is not completed.

Example:

NSSaleAgent agent;
Integer saleId;
DateTime res = agent.GetNextDueDate(saleId);

GetNextSaleStage(Integer,Bool)

Gets the next (not deleted) sale stage ID if the current stage is deleted. If the current stage is not deleted, the CurrentStageId is returned.

Integer GetNextSaleStage(Integer saleId, Bool includeCurrentStage)

Returns: CRMScript.Global.Integer

GetOpenSalesForContact(Integer)

Returns all open sales for the contact provided.

NSSale[] GetOpenSalesForContact(Integer contactId)

Returns: CRMScript.NetServer.NSSale[] Example:

NSSaleAgent agent;
Integer contactId;
NSSale[] res = agent.GetOpenSalesForContact(contactId);

GetProbabilityFromStage(Integer)

Gets the probability percentage for a given sale stage

Integer GetProbabilityFromStage(Integer stageId)

Returns: CRMScript.Global.Integer Example:

NSSaleAgent agent;
Integer stageId;
Integer res = agent.GetProbabilityFromStage(stageId);

GetRecentSales(Integer,Integer)

Returns the latest sales (that are sold) limited by their amount.

NSSale[] GetRecentSales(Integer amountLimit, Integer count)

Returns: CRMScript.NetServer.NSSale[] - The result is sorted descending with the latest first. Example:

NSSaleAgent agent;
Integer amountLimit;
Integer count;
NSSale[] res = agent.GetRecentSales(amountLimit, count);

GetSale(Integer)

Gets an NSSale object.

NSSale GetSale(Integer saleId)

Returns: CRMScript.NetServer.NSSale Example:

NSSaleAgent agent;
NSSale thing = agent.GetSale(123);

GetSaleEntity(Integer)

Gets an NSSaleEntity object.

NSSaleEntity GetSaleEntity(Integer saleEntityId)

Returns: CRMScript.NetServer.NSSaleEntity Example:

NSSaleAgent agent;
NSSaleEntity thing = agent.GetSaleEntity(123);

GetSaleList(Integer[])

Gets an array of Sale objects.

NSSale[] GetSaleList(Integer[]  saleIds)

Returns: CRMScript.NetServer.NSSale[] Example:

Integer[] ids;
NSSaleAgent agent;
agent.GetSaleList(ids);

GetSalesByDate(DateTime,DateTime,Integer,Integer)

Returns all sales within a time period. The sales array can be limited by amount and status.

NSSale[] GetSalesByDate(DateTime fromDate, DateTime toDate, Integer amountLimit, Integer status)

Returns: CRMScript.NetServer.NSSale[] Example:

NSSaleAgent agent;
DateTime fromDate;
DateTime toDate;
Integer amountLimit;
Integer status;
NSSale[] res = agent.GetSalesByDate(fromDate, toDate, amountLimit, status);

GetSalesFromContact(Integer,Bool)

Returns all sales for the contact provided.

NSSale[] GetSalesFromContact(Integer contactId, Bool onlyOpenSales)

Returns: CRMScript.NetServer.NSSale[] Example:

NSSaleAgent agent;
Integer contactId;
Bool onlyOpenSales;
NSSale[] res = agent.GetSalesFromContact(contactId, onlyOpenSales);

GetSalesFromPerson(Integer,Bool)

Returns all sales for the person provided.

NSSale[] GetSalesFromPerson(Integer personId, Bool onlyOpenSales)

Returns: CRMScript.NetServer.NSSale[] Example:

NSSaleAgent agent;
Integer personId;
Bool onlyOpenSales;
NSSale[] res = agent.GetSalesFromPerson(personId, onlyOpenSales);

GetSaleStakeholder(Integer)

Gets an NSSaleStakeholder object.

NSSaleStakeholder GetSaleStakeholder(Integer saleStakeholderId)

Returns: CRMScript.NetServer.NSSaleStakeholder Example:

NSSaleAgent agent;
NSSaleStakeholder thing = agent.GetSaleStakeholder(123);

GetSaleStakeholderById(Integer[])

NSSaleStakeholder[] GetSaleStakeholderById(Integer[] saleStakeholderIds)

Returns: CRMScript.NetServer.NSSaleStakeholder[]

GetSaleStakeholderList(Integer[])

Gets an array of SaleStakeholder objects.

NSSaleStakeholder[] GetSaleStakeholderList(Integer[]  saleStakeholderIds)

Returns: CRMScript.NetServer.NSSaleStakeholder[] Example:

Integer[] ids;
NSSaleAgent agent;
agent.GetSaleStakeholderList(ids);

GetSaleStakeholders(Integer)

NSSaleStakeholder[] GetSaleStakeholders(Integer saleId)

Returns: CRMScript.NetServer.NSSaleStakeholder[]

GetSummaryByAssociate(Integer,DateTime,DateTime)

NSSaleSummary GetSummaryByAssociate(Integer associateId, DateTime fromDate, DateTime toDate)

Returns: CRMScript.NetServer.NSSaleSummary

GetSummaryByContact(Integer,DateTime,DateTime)

NSSaleSummary GetSummaryByContact(Integer contactId, DateTime fromDate, DateTime toDate)

Returns: CRMScript.NetServer.NSSaleSummary

GetSummaryByGroup(Integer,DateTime,DateTime)

NSSaleSummary GetSummaryByGroup(Integer groupId, DateTime fromDate, DateTime toDate)

Returns: CRMScript.NetServer.NSSaleSummary

GetUpcomingSales(Integer,Integer)

Returns all open sales, sorted descending with the latest first.

NSSale[] GetUpcomingSales(Integer weightedAmountLimit, Integer count)

Returns: CRMScript.NetServer.NSSale[] Example:

NSSaleAgent agent;
Integer weightedAmountLimit;
Integer count;
NSSale[] res = agent.GetUpcomingSales(weightedAmountLimit, count);

HasGuide(Integer)

Does this sale have a sale guide associated with its sale type?

Bool HasGuide(Integer saleId)

Returns: CRMScript.Global.Bool Example:

NSSaleAgent agent;
Integer saleId;
Bool res = agent.HasGuide(saleId);

HasGuideActivities(Integer)

Bool HasGuideActivities(Integer saleId)

Returns: CRMScript.Global.Bool

HasStakeholderSetting(Integer)

Bool HasStakeholderSetting(Integer saleId)

Returns: CRMScript.Global.Bool

IsNumberValid(Integer,String)

Checks if the number is unique or required.

Bool IsNumberValid(Integer contactId, String number)

Returns: CRMScript.Global.Bool

The setting is configured from admin under system options.

Example:

NSSaleAgent agent;
Integer contactId;
String number;
Bool res = agent.IsNumberValid(contactId, number);

OfferAutoNextStageOnApppointmentCompleted(Integer)

Bool OfferAutoNextStageOnApppointmentCompleted(Integer appointmentId)

Returns: CRMScript.Global.Bool

SaveSaleEntity(NSSaleEntity)

Updates the existing NSSaleEntity or creates a new NSSaleEntity if the ID parameter is 0.

NSSaleEntity SaveSaleEntity(NSSaleEntity saleEntity)

Returns: CRMScript.NetServer.NSSaleEntity - The new or updated NSSaleEntity. Example:

NSSale  agent;
NSSaleEntity thing = agent.CreateDefaultSaleEntity();
thing = agent.SaveSaleEntity(thing);

SaveSaleStakeholder(NSSaleStakeholder)

Updates the existing NSSaleStakeholder or creates a new NSSaleStakeholder if the id parameter is 0

NSSaleStakeholder SaveSaleStakeholder(NSSaleStakeholder saleStakeholder)

Returns: CRMScript.NetServer.NSSaleStakeholder Example:

NSSale  agent;
NSSaleStakeholder thing = agent.CreateDefaultSaleStakeholder();
thing = agent.SaveSaleStakeholder(thing);

SetAsLost(Integer[])

Changes the status of one or more sales to Lost.

Void SetAsLost(Integer[] saleIds)

Returns: CRMScript.Global.Void

This does not affect the Completed state of the sale.

SetAsSold(Integer[])

Changes the status of one or more Sales to Sold.

Void SetAsSold(Integer[] saleIds)

Returns: CRMScript.Global.Void

This does not mark them as Completed.

UpdateSaleStakeholders(NSSaleStakeholder[])

NSSaleStakeholder[] UpdateSaleStakeholders(NSSaleStakeholder[] stakeholders)

Returns: CRMScript.NetServer.NSSaleStakeholder[]

ValidateSaleEntity(NSSaleEntity)

Checks that entity is ready for saving, return error messages by field.

Map ValidateSaleEntity(NSSaleEntity saleEntity)

Returns: CRMScript.Native.Map Example:

NSSaleAgent agent;
NSSaleEntity saleEntity;
Map res = agent.ValidateSaleEntity(saleEntity);

​Constructors

​NSSaleAgent()

​Methods

​AddSaleStakeholders(Integer,NSSaleStakeholder[])

​BatchUpdateNextDueDate()

​CreateDefaultSaleEntity()

​CreateDefaultSaleStakeholder()

​CreateDefaultSaleSummary()

​DeleteSaleEntity(Integer)

​DeleteSaleStakeholder(Integer)

​DeleteSaleStakeholders(Integer[])

​GetMyOpportunities(Integer)

​GetNextDueDate(Integer)

​GetNextSaleStage(Integer,Bool)

​GetOpenSalesForContact(Integer)

​GetProbabilityFromStage(Integer)

​GetRecentSales(Integer,Integer)

​GetSale(Integer)

​GetSaleEntity(Integer)

​GetSaleList(Integer[])

​GetSalesByDate(DateTime,DateTime,Integer,Integer)

​GetSalesFromContact(Integer,Bool)

​GetSalesFromPerson(Integer,Bool)

​GetSaleStakeholder(Integer)

​GetSaleStakeholderById(Integer[])

​GetSaleStakeholderList(Integer[])

​GetSaleStakeholders(Integer)

​GetSummaryByAssociate(Integer,DateTime,DateTime)

​GetSummaryByContact(Integer,DateTime,DateTime)

​GetSummaryByGroup(Integer,DateTime,DateTime)

​GetUpcomingSales(Integer,Integer)

​HasGuide(Integer)

​HasGuideActivities(Integer)

​HasStakeholderSetting(Integer)

​IsNumberValid(Integer,String)

​OfferAutoNextStageOnApppointmentCompleted(Integer)

​SaveSaleEntity(NSSaleEntity)

​SaveSaleStakeholder(NSSaleStakeholder)

​SetAsLost(Integer[])

​SetAsSold(Integer[])

​UpdateSaleStakeholders(NSSaleStakeholder[])

​ValidateSaleEntity(NSSaleEntity)

Constructors

NSSaleAgent()

Methods

AddSaleStakeholders(Integer,NSSaleStakeholder[])

BatchUpdateNextDueDate()

CreateDefaultSaleEntity()

CreateDefaultSaleStakeholder()

CreateDefaultSaleSummary()

DeleteSaleEntity(Integer)

DeleteSaleStakeholder(Integer)

DeleteSaleStakeholders(Integer[])

GetMyOpportunities(Integer)

GetNextDueDate(Integer)

GetNextSaleStage(Integer,Bool)

GetOpenSalesForContact(Integer)

GetProbabilityFromStage(Integer)

GetRecentSales(Integer,Integer)

GetSale(Integer)

GetSaleEntity(Integer)

GetSaleList(Integer[])

GetSalesByDate(DateTime,DateTime,Integer,Integer)

GetSalesFromContact(Integer,Bool)

GetSalesFromPerson(Integer,Bool)

GetSaleStakeholder(Integer)

GetSaleStakeholderById(Integer[])

GetSaleStakeholderList(Integer[])

GetSaleStakeholders(Integer)

GetSummaryByAssociate(Integer,DateTime,DateTime)

GetSummaryByContact(Integer,DateTime,DateTime)

GetSummaryByGroup(Integer,DateTime,DateTime)

GetUpcomingSales(Integer,Integer)

HasGuide(Integer)

HasGuideActivities(Integer)

HasStakeholderSetting(Integer)

IsNumberValid(Integer,String)

OfferAutoNextStageOnApppointmentCompleted(Integer)

SaveSaleEntity(NSSaleEntity)

SaveSaleStakeholder(NSSaleStakeholder)

SetAsLost(Integer[])

SetAsSold(Integer[])

UpdateSaleStakeholders(NSSaleStakeholder[])

ValidateSaleEntity(NSSaleEntity)