Class NSQuote

Quote carrier with the active quote version and favorite alternative.

Syntax

Constructors

NSQuote()

Initializes a new instance of the NSQuote class.

Declaration

NSQuote

Methods

GetAcceptedQuoteAlternativeId()

Quote carrier with the active quote version and favorite alternative.

Declaration

Integer GetAcceptedQuoteAlternativeId()

Returns

Type	Description
Integer	The primary key of the Quote Alternative which was finally accepted by the customer.

Remarks

Set when the user is marking a quote as accepted.

Examples

NSQuote thing;
Integer acceptedQuoteAlternativeId = thing.GetAcceptedQuoteAlternativeId();

GetActiveQuoteVersion()

Quote carrier with the active quote version and favorite alternative.

Declaration

NSQuoteVersion GetActiveQuoteVersion()

Returns

Type	Description
NSQuoteVersion	The active quote version for the quote.

Examples

NSQuote thing;
NSQuoteVersion activeQuoteVersion = thing.GetActiveQuoteVersion();

GetActiveQuoteVersionId()

Quote carrier with the active quote version and favorite alternative.

Declaration

Integer GetActiveQuoteVersionId()

Returns

Type	Description
Integer	The primary key of the Quote Version that is currently active.

Remarks

The active version will always be the latest version.

Examples

NSQuote thing;
Integer activeQuoteVersionId = thing.GetActiveQuoteVersionId();

GetDocumentId()

Quote carrier with the active quote version and favorite alternative.

Declaration

Integer GetDocumentId()

Returns

Type	Description
Integer	The ID of the main Quote Document.

Examples

NSQuote thing;
Integer documentId = thing.GetDocumentId();

GetERPOrderKey()

Quote carrier with the active quote version and favorite alternative.

Declaration

String GetERPOrderKey()

Returns

Type	Description
String	The key in the ERP system that identifies this sale's Order, as transferred and possibly later edited in the ERP system.

Remarks

Only filled out if there exists a corresponding order representation of the quote in the ERP system.

Examples

NSQuote thing;
String eRPOrderKey = thing.GetERPOrderKey();

GetERPQuoteKey()

Quote carrier with the active quote version and favorite alternative.

Declaration

String GetERPQuoteKey()

Returns

Type	Description
String	Foreign key of quote (if available). The key in the ERP system that identifies this sale's Quote (as opposed to the later Order information).

Examples

NSQuote thing;
String eRPQuoteKey = thing.GetERPQuoteKey();

GetFavoriteQuoteAlternative()

Quote carrier with the active quote version and favorite alternative.

Declaration

NSQuoteAlternative GetFavoriteQuoteAlternative()

Returns

Type	Description
NSQuoteAlternative	The favorite quote alternative for the quote and active quote version.

Examples

NSQuote thing;
NSQuoteAlternative favoriteQuoteAlternative = thing.GetFavoriteQuoteAlternative();

GetOrderComment()

Quote carrier with the active quote version and favorite alternative.

Declaration

String GetOrderComment()

Returns

Type	Description
String	A comment that is intended for the Invoice, Order, Packing list and similar stages AFTER the quote has become an order and goes to ERP for processing.

Examples

NSQuote thing;
String orderComment = thing.GetOrderComment();

GetPoNumber()

Quote carrier with the active quote version and favorite alternative.

Declaration

String GetPoNumber()

Returns

Type	Description
String	Customer's Purchase order number.

Examples

NSQuote thing;
String poNumber = thing.GetPoNumber();

GetPreferredEmailCulture()

Quote carrier with the active quote version and favorite alternative.

Declaration

String GetPreferredEmailCulture()

Returns

Type	Description
String	When emails are sent (offer or confirmation), a language can be chosen in the GUI; this field saves the most recent choice and can be used to default the next such choice. Default-default is user's current language.

Examples

NSQuote thing;
String preferredEmailCulture = thing.GetPreferredEmailCulture();

GetQuoteConnectionId()

Quote carrier with the active quote version and favorite alternative.

Declaration

Integer GetQuoteConnectionId()

Returns

Type	Description
Integer	The connection in the CRM system to where this quote came from. Identifies the ERP connection used for this quote. Each quote is bound to one and only one connection.

Examples

NSQuote thing;
Integer quoteConnectionId = thing.GetQuoteConnectionId();

GetQuoteId()

Quote carrier with the active quote version and favorite alternative.

Declaration

Integer GetQuoteId()

Returns

Type	Description
Integer	Primary key.

Examples

NSQuote thing;
Integer quoteId = thing.GetQuoteId();

GetSaleId()

Quote carrier with the active quote version and favorite alternative.

Declaration

Integer GetSaleId()

Returns

Type	Description
Integer	The foreign key to the corresponding sale.

Examples

NSQuote thing;
Integer saleId = thing.GetSaleId();

GetUseValuesFromQuote()

Quote carrier with the active quote version and favorite alternative.

Declaration

Integer GetUseValuesFromQuote()

Returns

Type	Description
Integer	If true, then the Earning, Earning_Percent and Amount fields are populated from the QuoteVersion.QuoteAlternative (current revision, most-likely alternative).

Examples

NSQuote thing;
Integer useValuesFromQuote = thing.GetUseValuesFromQuote();

SetAcceptedQuoteAlternativeId(Integer)

Quote carrier with the active quote version and favorite alternative.

Declaration

Void SetAcceptedQuoteAlternativeId(Integer acceptedQuoteAlternativeId)

Parameters

Type	Name	Description
Integer	acceptedQuoteAlternativeId	The primary key of the Quote Alternative which was finally accepted by the customer.

Returns

Type	Description
Void

Remarks

Set when the user is marking a quote as accepted.

Examples

NSQuote thing;
Integer acceptedQuoteAlternativeId;
thing.SetAcceptedQuoteAlternativeId(acceptedQuoteAlternativeId);

SetActiveQuoteVersion(NSQuoteVersion)

Quote carrier with the active quote version and favorite alternative.

Declaration

Void SetActiveQuoteVersion(NSQuoteVersion activeQuoteVersion)

Parameters

Type	Name	Description
NSQuoteVersion	activeQuoteVersion	The active quote version for the quote.

Returns

Type	Description
Void

Examples

NSQuote thing;
NSQuoteVersion activeQuoteVersion;
thing.SetActiveQuoteVersion(activeQuoteVersion);

SetActiveQuoteVersionId(Integer)

Quote carrier with the active quote version and favorite alternative.

Declaration

Void SetActiveQuoteVersionId(Integer activeQuoteVersionId)

Parameters

Type	Name	Description
Integer	activeQuoteVersionId	The primary key of the Quote Version that is currently active.

Returns

Type	Description
Void

Remarks

The active version will always be the latest version.

Examples

NSQuote thing;
Integer activeQuoteVersionId;
thing.SetActiveQuoteVersionId(activeQuoteVersionId);

SetDocumentId(Integer)

Quote carrier with the active quote version and favorite alternative.

Declaration

Void SetDocumentId(Integer documentId)

Parameters

Type	Name	Description
Integer	documentId	The ID of the main Quote Document.

Returns

Type	Description
Void

Examples

NSQuote thing;
Integer documentId;
thing.SetDocumentId(documentId);

SetERPOrderKey(String)

Quote carrier with the active quote version and favorite alternative.

Declaration

Void SetERPOrderKey(String eRPOrderKey)

Parameters

Type	Name	Description
String	eRPOrderKey	The key in the ERP system that identifies this sale's Order, as transferred and possibly later edited in the ERP system. Only filled out if there exists a corresponding order representation of the quote in the ERP system.

Returns

Type	Description
Void

Examples

NSQuote thing;
String eRPOrderKey;
thing.SetERPOrderKey(eRPOrderKey);

SetERPQuoteKey(String)

Quote carrier with the active quote version and favorite alternative.

Declaration

Void SetERPQuoteKey(String eRPQuoteKey)

Parameters

Type	Name	Description
String	eRPQuoteKey	Foreign key of quote (if available). The key in the ERP system that identifies this sale's Quote (as opposed to the later Order information).

Returns

Type	Description
Void

Examples

NSQuote thing;
String eRPQuoteKey;
thing.SetERPQuoteKey(eRPQuoteKey);

SetFavoriteQuoteAlternative(NSQuoteAlternative)

Quote carrier with the active quote version and favorite alternative.

Declaration

Void SetFavoriteQuoteAlternative(NSQuoteAlternative favoriteQuoteAlternative)

Parameters

Type	Name	Description
NSQuoteAlternative	favoriteQuoteAlternative	The favorite quote alternative for the quote and active quote version.

Returns

Type	Description
Void

Examples

NSQuote thing;
NSQuoteAlternative favoriteQuoteAlternative;
thing.SetFavoriteQuoteAlternative(favoriteQuoteAlternative);

SetOrderComment(String)

Quote carrier with the active quote version and favorite alternative.

Declaration

Void SetOrderComment(String orderComment)

Parameters

Type	Name	Description
String	orderComment	A comment that is intended for the Invoice, Order, Packing list and similar stages AFTER the quote has become an order and goes to ERP for processing.

Returns

Type	Description
Void

Examples

NSQuote thing;
String orderComment;
thing.SetOrderComment(orderComment);

SetPoNumber(String)

Quote carrier with the active quote version and favorite alternative.

Declaration

Void SetPoNumber(String poNumber)

Parameters

Type	Name	Description
String	poNumber	Customer's Purchase order number.

Returns

Type	Description
Void

Examples

NSQuote thing;
String poNumber;
thing.SetPoNumber(poNumber);

SetPreferredEmailCulture(String)

Quote carrier with the active quote version and favorite alternative.

Declaration

Void SetPreferredEmailCulture(String preferredEmailCulture)

Parameters

Type	Name	Description
String	preferredEmailCulture	When emails are sent (offer or confirmation), a language can be chosen in the GUI; this field saves the most recent choice and can be used to default the next such choice. Default-default is user's current language.

Returns

Type	Description
Void

Examples

NSQuote thing;
String preferredEmailCulture;
thing.SetPreferredEmailCulture(preferredEmailCulture);

SetQuoteConnectionId(Integer)

Quote carrier with the active quote version and favorite alternative.

Declaration

Void SetQuoteConnectionId(Integer quoteConnectionId)

Parameters

Type	Name	Description
Integer	quoteConnectionId	The connection in the CRM system to where this quote came from. Identifies the ERP connection used for this quote. Each quote is bound to one and only one connection.

Returns

Type	Description
Void

Examples

NSQuote thing;
Integer quoteConnectionId;
thing.SetQuoteConnectionId(quoteConnectionId);

SetQuoteId(Integer)

Quote carrier with the active quote version and favorite alternative.

Declaration

Void SetQuoteId(Integer quoteId)

Parameters

Type	Name	Description
Integer	quoteId	Primary key.

Returns

Type	Description
Void

Examples

NSQuote thing;
Integer quoteId;
thing.SetQuoteId(quoteId);

SetSaleId(Integer)

Quote carrier with the active quote version and favorite alternative.

Declaration

Void SetSaleId(Integer saleId)

Parameters

Type	Name	Description
Integer	saleId	The foreign key to the corresponding sale.

Returns

Type	Description
Void

Examples

NSQuote thing;
Integer saleId;
thing.SetSaleId(saleId);

SetUseValuesFromQuote(Integer)

Quote carrier with the active quote version and favorite alternative.

Declaration

Void SetUseValuesFromQuote(Integer useValuesFromQuote)

Parameters

Type	Name	Description
Integer	useValuesFromQuote	If true, then the Earning, Earning_Percent and Amount fields are populated from the QuoteVersion.QuoteAlternative (current revision, most-likely alternative).

Returns

Type	Description
Void

Examples

NSQuote thing;
Integer useValuesFromQuote;
thing.SetUseValuesFromQuote(useValuesFromQuote);