Class NSSaleAgent

NSSaleAgent()

Sale data services.

Declaration

NSSaleAgent

NSSaleAgent agent;
agent.callMethod(arg1, arg2);

AddSaleStakeholders(Integer,NSSaleStakeholder[])

Declaration

Void AddSaleStakeholders(Integer saleId, NSSaleStakeholder[] saleStakeholders)

Parameters

Returns

BatchUpdateNextDueDate()

Re-calculates all the next due dates

Declaration

Void BatchUpdateNextDueDate()

Returns

CreateDefaultSaleEntity()

Sets default values into a new NSSaleEntity.

Declaration

NSSaleEntity CreateDefaultSaleEntity()

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

Returns

CreateDefaultSaleStakeholder()

Sets default values into a new NSSaleStakeholder.

Declaration

NSSaleStakeholder CreateDefaultSaleStakeholder()

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

Returns

CreateDefaultSaleSummary()

Sets default values into a new NSSaleSummary.

Declaration

NSSaleSummary CreateDefaultSaleSummary()

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

Returns

DeleteSaleEntity(Integer)

Deletes the NSSaleEntity

Declaration

DeleteSaleEntity(Integer saleEntity)

NSSaleAgent agent;
agent.DeleteSaleEntity(123);

Parameters

Returns

DeleteSaleStakeholder(Integer)

Deletes the NSSaleStakeholder

Declaration

DeleteSaleStakeholder(Integer saleStakeholder)

NSSaleAgent agent;
agent.DeleteSaleStakeholder(123);

Parameters

Returns

DeleteSaleStakeholders(Integer[])

Declaration

Void DeleteSaleStakeholders(Integer[] saleStakeholderIds)

Parameters

Returns

GetMyOpportunities(Integer)

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

Declaration

NSSale[] GetMyOpportunities(Integer count)

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

Parameters

Returns

GetNextDueDate(Integer)

Gets the next due date for a sale.

Declaration

DateTime GetNextDueDate(Integer saleId)

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

Parameters

Returns

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.

Declaration

Integer GetNextSaleStage(Integer saleId, Bool includeCurrentStage)

Parameters

Returns

GetOpenSalesForContact(Integer)

Returns all open sales for the contact provided.

Declaration

NSSale[] GetOpenSalesForContact(Integer contactId)

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

Parameters

Returns

GetProbabilityFromStage(Integer)

Gets the probability percentage for a given sale stage

Declaration

Integer GetProbabilityFromStage(Integer stageId)

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

Parameters

Returns

GetRecentSales(Integer,Integer)

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

Declaration

NSSale[] GetRecentSales(Integer amountLimit, Integer count)

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

Parameters

Returns

GetSale(Integer)

Gets an NSSale object.

Declaration

NSSale GetSale(Integer saleId)

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

Parameters

Returns

GetSaleEntity(Integer)

Gets an NSSaleEntity object.

Declaration

NSSaleEntity GetSaleEntity(Integer saleEntityId)

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

Parameters

Returns

GetSaleList(Integer[])

Gets an array of Sale objects.

Declaration

NSSale[] GetSaleList(Integer[]  saleIds)

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

Parameters

Returns

GetSalesByDate(DateTime,DateTime,Integer,Integer)

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

Declaration

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

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

Parameters

Returns

GetSalesFromContact(Integer,Bool)

Returns all sales for the contact provided.

Declaration

NSSale[] GetSalesFromContact(Integer contactId, Bool onlyOpenSales)

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

Parameters

Returns

GetSalesFromPerson(Integer,Bool)

Returns all sales for the person provided.

Declaration

NSSale[] GetSalesFromPerson(Integer personId, Bool onlyOpenSales)

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

Parameters

Returns

GetSaleStakeholder(Integer)

Gets an NSSaleStakeholder object.

Declaration

NSSaleStakeholder GetSaleStakeholder(Integer saleStakeholderId)

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

Parameters

Returns

GetSaleStakeholderById(Integer[])

Declaration

NSSaleStakeholder[] GetSaleStakeholderById(Integer[] saleStakeholderIds)

Parameters

Returns

GetSaleStakeholderList(Integer[])

Gets an array of SaleStakeholder objects.

Declaration

NSSaleStakeholder[] GetSaleStakeholderList(Integer[]  saleStakeholderIds)

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

Parameters

Returns

GetSaleStakeholders(Integer)

Declaration

NSSaleStakeholder[] GetSaleStakeholders(Integer saleId)

Parameters

Returns

GetSummaryByAssociate(Integer,DateTime,DateTime)

Declaration

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

Parameters

Returns

GetSummaryByContact(Integer,DateTime,DateTime)

Declaration

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

Parameters

Returns

GetSummaryByGroup(Integer,DateTime,DateTime)

Declaration

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

Parameters

Returns

GetUpcomingSales(Integer,Integer)

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

Declaration

NSSale[] GetUpcomingSales(Integer weightedAmountLimit, Integer count)

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

Parameters

Returns

HasGuide(Integer)

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

Declaration

Bool HasGuide(Integer saleId)

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

Parameters

Returns

HasGuideActivities(Integer)

Declaration

Bool HasGuideActivities(Integer saleId)

Parameters

Returns

HasStakeholderSetting(Integer)

Declaration

Bool HasStakeholderSetting(Integer saleId)

Parameters

Returns

IsNumberValid(Integer,String)

Checks if the number is unique or required.

Declaration

Bool IsNumberValid(Integer contactId, String number)

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

Parameters

Returns

OfferAutoNextStageOnApppointmentCompleted(Integer)

Declaration

Bool OfferAutoNextStageOnApppointmentCompleted(Integer appointmentId)

Parameters

Returns

SaveSaleEntity(NSSaleEntity)

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

Declaration

NSSaleEntity SaveSaleEntity(NSSaleEntity saleEntity)

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

Parameters

Returns

SaveSaleStakeholder(NSSaleStakeholder)

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

Declaration

NSSaleStakeholder SaveSaleStakeholder(NSSaleStakeholder saleStakeholder)

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

Parameters

Returns

SetAsLost(Integer[])

Changes the status of one or more sales to Lost.

Declaration

Void SetAsLost(Integer[] saleIds)

Parameters

Returns

SetAsSold(Integer[])

Changes the status of one or more Sales to Sold.

Declaration

Void SetAsSold(Integer[] saleIds)

Parameters

Returns

UpdateSaleStakeholders(NSSaleStakeholder[])

Declaration

NSSaleStakeholder[] UpdateSaleStakeholders(NSSaleStakeholder[] stakeholders)

Parameters

Returns

ValidateSaleEntity(NSSaleEntity)

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

Declaration

Map ValidateSaleEntity(NSSaleEntity saleEntity)

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

Parameters

Returns