Class NSSaleAgent

Sale data services.

Syntax

Examples

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

Constructors

NSSaleAgent()

Sale data services.

Introduced or updated in version: 7

Declaration

NSSaleAgent

Examples

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

Methods

AddSaleStakeholders(Integer,NSSaleStakeholder[])

Introduced or updated in version: 7.1.1

Declaration

Void AddSaleStakeholders(Integer saleId, NSSaleStakeholder[] saleStakeholders)

Parameters

Type	Name	Description
Integer	saleId
NSSaleStakeholder[]	saleStakeholders

Returns

Type	Description
Void

BatchUpdateNextDueDate()

Re-calculates all the next due dates

Introduced or updated in version: 7

Declaration

Void BatchUpdateNextDueDate()

Returns

Type	Description
Void

CreateDefaultSaleEntity()

Sets default values into a new NSSaleEntity.

Introduced or updated in version: 7

Declaration

NSSaleEntity CreateDefaultSaleEntity()

Returns

Type	Description
NSSaleEntity

Remarks

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

Examples

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

CreateDefaultSaleStakeholder()

Sets default values into a new NSSaleStakeholder.

Introduced or updated in version: 8.2

Declaration

NSSaleStakeholder CreateDefaultSaleStakeholder()

Returns

Type	Description
NSSaleStakeholder

Remarks

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

Examples

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

CreateDefaultSaleSummary()

Sets default values into a new NSSaleSummary.

Introduced or updated in version: 7

Declaration

NSSaleSummary CreateDefaultSaleSummary()

Returns

Type	Description
NSSaleSummary

Remarks

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

Examples

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

DeleteSaleEntity(Integer)

Deletes the NSSaleEntity

Introduced or updated in version: 7

Declaration

DeleteSaleEntity(Integer saleEntity)

Parameters

Type	Name	Description
Integer	saleEntity

Returns

Type	Description
Void

Examples

NSSaleAgent agent;
agent.DeleteSaleEntity(123);

DeleteSaleStakeholder(Integer)

Deletes the NSSaleStakeholder

Introduced or updated in version: 8.2

Declaration

DeleteSaleStakeholder(Integer saleStakeholder)

Parameters

Type	Name	Description
Integer	saleStakeholder

Returns

Type	Description
Void

Examples

NSSaleAgent agent;
agent.DeleteSaleStakeholder(123);

DeleteSaleStakeholders(Integer[])

Introduced or updated in version: 7.1.1

Declaration

Void DeleteSaleStakeholders(Integer[] saleStakeholderIds)

Parameters

Type	Name	Description
Integer[]	saleStakeholderIds

Returns

Type	Description
Void

GetMyOpportunities(Integer)

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

Introduced or updated in version: 7

Declaration

NSSale[] GetMyOpportunities(Integer count)

Parameters

Type	Name	Description
Integer	count

Returns

Type	Description
NSSale[]

Examples

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

GetNextDueDate(Integer)

Gets the next due date for a sale.

Introduced or updated in version: 7

Declaration

DateTime GetNextDueDate(Integer saleId)

Parameters

Type	Name	Description
Integer	saleId

Returns

Type	Description
DateTime

Remarks

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

Examples

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.

Introduced or updated in version: 7

Declaration

Integer GetNextSaleStage(Integer saleId, Bool includeCurrentStage)

Parameters

Type	Name	Description
Integer	saleId
Bool	includeCurrentStage

Returns

Type	Description
Integer

GetOpenSalesForContact(Integer)

Returns all open sales for the contact provided.

Introduced or updated in version: 7.5

Declaration

NSSale[] GetOpenSalesForContact(Integer contactId)

Parameters

Type	Name	Description
Integer	contactId

Returns

Type	Description
NSSale[]

Examples

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

GetProbabilityFromStage(Integer)

Gets the probability percentage for a given sale stage

Introduced or updated in version: 7

Declaration

Integer GetProbabilityFromStage(Integer stageId)

Parameters

Type	Name	Description
Integer	stageId

Returns

Type	Description
Integer

Examples

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

GetRecentSales(Integer,Integer)

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

Introduced or updated in version: 7

Declaration

NSSale[] GetRecentSales(Integer amountLimit, Integer count)

Parameters

Type	Name	Description
Integer	amountLimit	If the amount is -1, the amount restriction is omitted.
Integer	count

Returns

Type	Description
NSSale[]	The result is sorted descending with the latest first.

Examples

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

GetSale(Integer)

Gets an NSSale object.

Introduced or updated in version: 7

Declaration

NSSale GetSale(Integer saleId)

Parameters

Type	Name	Description
Integer	saleId

Returns

Type	Description
NSSale

Examples

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

GetSaleEntity(Integer)

Gets an NSSaleEntity object.

Introduced or updated in version: 7

Declaration

NSSaleEntity GetSaleEntity(Integer saleEntityId)

Parameters

Type	Name	Description
Integer	saleEntityId

Returns

Type	Description
NSSaleEntity

Examples

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

GetSaleList(Integer[])

Gets an array of Sale objects.

Introduced or updated in version: 7

Declaration

NSSale[] GetSaleList(Integer[]  saleIds)

Parameters

Type	Name	Description
Integer[]	saleIds

Returns

Type	Description
NSSale[]

Examples

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.

Introduced or updated in version: 7

Declaration

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

Parameters

Type	Name	Description
DateTime	fromDate
DateTime	toDate
Integer	amountLimit
Integer	status

Returns

Type	Description
NSSale[]

Examples

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.

Introduced or updated in version: 7

Declaration

NSSale[] GetSalesFromContact(Integer contactId, Bool onlyOpenSales)

Parameters

Type	Name	Description
Integer	contactId
Bool	onlyOpenSales

Returns

Type	Description
NSSale[]

Examples

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

GetSalesFromPerson(Integer,Bool)

Returns all sales for the person provided.

Introduced or updated in version: 7

Declaration

NSSale[] GetSalesFromPerson(Integer personId, Bool onlyOpenSales)

Parameters

Type	Name	Description
Integer	personId
Bool	onlyOpenSales

Returns

Type	Description
NSSale[]

Examples

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

GetSaleStakeholder(Integer)

Gets an NSSaleStakeholder object.

Introduced or updated in version: 7.1.1

Declaration

NSSaleStakeholder GetSaleStakeholder(Integer saleStakeholderId)

Parameters

Type	Name	Description
Integer	saleStakeholderId

Returns

Type	Description
NSSaleStakeholder

Examples

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

GetSaleStakeholderById(Integer[])

Introduced or updated in version: 7.1.1

Declaration

NSSaleStakeholder[] GetSaleStakeholderById(Integer[] saleStakeholderIds)

Parameters

Type	Name	Description
Integer[]	saleStakeholderIds

Returns

Type	Description
NSSaleStakeholder[]

GetSaleStakeholderList(Integer[])

Gets an array of SaleStakeholder objects.

Introduced or updated in version: 7.1.1

Declaration

NSSaleStakeholder[] GetSaleStakeholderList(Integer[]  saleStakeholderIds)

Parameters

Type	Name	Description
Integer[]	saleStakeholderIds

Returns

Type	Description
NSSaleStakeholder[]

Examples

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

GetSaleStakeholders(Integer)

Introduced or updated in version: 7.1.1

Declaration

NSSaleStakeholder[] GetSaleStakeholders(Integer saleId)

Parameters

Type	Name	Description
Integer	saleId

Returns

Type	Description
NSSaleStakeholder[]

GetSummaryByAssociate(Integer,DateTime,DateTime)

Introduced or updated in version: 7

Declaration

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

Parameters

Type	Name	Description
Integer	associateId
DateTime	fromDate
DateTime	toDate

Returns

Type	Description
NSSaleSummary

GetSummaryByContact(Integer,DateTime,DateTime)

Introduced or updated in version: 7

Declaration

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

Parameters

Type	Name	Description
Integer	contactId
DateTime	fromDate
DateTime	toDate

Returns

Type	Description
NSSaleSummary

GetSummaryByGroup(Integer,DateTime,DateTime)

Introduced or updated in version: 7

Declaration

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

Parameters

Type	Name	Description
Integer	groupId
DateTime	fromDate
DateTime	toDate

Returns

Type	Description
NSSaleSummary

GetUpcomingSales(Integer,Integer)

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

Introduced or updated in version: 7

Declaration

NSSale[] GetUpcomingSales(Integer weightedAmountLimit, Integer count)

Parameters

Type	Name	Description
Integer	weightedAmountLimit	If the weighted amount is -1, the amount restriction is omitted.
Integer	count

Returns

Type	Description
NSSale[]

Examples

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?

Introduced or updated in version: 7

Declaration

Bool HasGuide(Integer saleId)

Parameters

Type	Name	Description
Integer	saleId

Returns

Type	Description
Bool

Examples

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

HasGuideActivities(Integer)

Introduced or updated in version: 7

Declaration

Bool HasGuideActivities(Integer saleId)

Parameters

Type	Name	Description
Integer	saleId

Returns

Type	Description
Bool

HasStakeholderSetting(Integer)

Introduced or updated in version: 7.1.1

Declaration

Bool HasStakeholderSetting(Integer saleId)

Parameters

Type	Name	Description
Integer	saleId

Returns

Type	Description
Bool

IsNumberValid(Integer,String)

Checks if the number is unique or required.

Introduced or updated in version: 7

Declaration

Bool IsNumberValid(Integer contactId, String number)

Parameters

Type	Name	Description
Integer	contactId
String	number

Returns

Type	Description
Bool

Remarks

The setting is configured from admin under system options.

Examples

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

OfferAutoNextStageOnApppointmentCompleted(Integer)

Introduced or updated in version: 7

Declaration

Bool OfferAutoNextStageOnApppointmentCompleted(Integer appointmentId)

Parameters

Type	Name	Description
Integer	appointmentId

Returns

Type	Description
Bool

SaveSaleEntity(NSSaleEntity)

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

Introduced or updated in version: 7

Declaration

NSSaleEntity SaveSaleEntity(NSSaleEntity saleEntity)

Parameters

Type	Name	Description
NSSaleEntity	saleEntity

Returns

Type	Description
NSSaleEntity	The new or updated NSSaleEntity.

Examples

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

Introduced or updated in version: 8.2

Declaration

NSSaleStakeholder SaveSaleStakeholder(NSSaleStakeholder saleStakeholder)

Parameters

Type	Name	Description
NSSaleStakeholder	saleStakeholder	The NSSaleStakeholder to save.

Returns

Type	Description
NSSaleStakeholder

Examples

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

SetAsLost(Integer[])

Changes the status of one or more sales to Lost.

Introduced or updated in version: 7

Declaration

Void SetAsLost(Integer[] saleIds)

Parameters

Type	Name	Description
Integer[]	saleIds

Returns

Type	Description
Void

Remarks

This does not affect the Completed state of the sale.

SetAsSold(Integer[])

Changes the status of one or more Sales to Sold.

Introduced or updated in version: 7

Declaration

Void SetAsSold(Integer[] saleIds)

Parameters

Type	Name	Description
Integer[]	saleIds

Returns

Type	Description
Void

Remarks

This does not mark them as Completed.

UpdateSaleStakeholders(NSSaleStakeholder[])

Introduced or updated in version: 7.1.1

Declaration

NSSaleStakeholder[] UpdateSaleStakeholders(NSSaleStakeholder[] stakeholders)

Parameters

Type	Name	Description
NSSaleStakeholder[]	stakeholders

Returns

Type	Description
NSSaleStakeholder[]

ValidateSaleEntity(NSSaleEntity)

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

Introduced or updated in version: 7

Declaration

Map ValidateSaleEntity(NSSaleEntity saleEntity)

Parameters

Type	Name	Description
NSSaleEntity	saleEntity

Returns

Type	Description
Map

Examples

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