Show / Hide Table of Contents

Class NSQuoteEntity

Quote methods.

Syntax

Constructors

NSQuoteEntity()

Initializes a new instance of the NSQuoteEntity class.

Declaration
NSQuoteEntity

Methods

GetAcceptedQuoteAlternativeId()

Quote methods.

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
NSQuoteEntity thing;
Integer acceptedQuoteAlternativeId = thing.GetAcceptedQuoteAlternativeId();

GetActiveQuoteVersionId()

Quote methods.

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
NSQuoteEntity thing;
Integer activeQuoteVersionId = thing.GetActiveQuoteVersionId();

GetDocumentId()

Quote methods.

Declaration
Integer GetDocumentId()
Returns
Type Description
Integer

The ID of the main Quote Document.

Examples
NSQuoteEntity thing;
Integer documentId = thing.GetDocumentId();

GetERPOrderKey()

Quote methods.

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
NSQuoteEntity thing;
String eRPOrderKey = thing.GetERPOrderKey();

GetERPQuoteKey()

Quote methods.

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
NSQuoteEntity thing;
String eRPQuoteKey = thing.GetERPQuoteKey();

GetOrderComment()

Quote methods.

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
NSQuoteEntity thing;
String orderComment = thing.GetOrderComment();

GetPoNumber()

Quote methods.

Declaration
String GetPoNumber()
Returns
Type Description
String

Customer's Purchase order number.

Examples
NSQuoteEntity thing;
String poNumber = thing.GetPoNumber();

GetPreferredEmailCulture()

Quote methods.

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
NSQuoteEntity thing;
String preferredEmailCulture = thing.GetPreferredEmailCulture();

GetQuoteConnectionId()

Quote methods.

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
NSQuoteEntity thing;
Integer quoteConnectionId = thing.GetQuoteConnectionId();

GetQuoteId()

Quote methods.

Declaration
Integer GetQuoteId()
Returns
Type Description
Integer

Primary key.

Examples
NSQuoteEntity thing;
Integer quoteId = thing.GetQuoteId();

GetQuoteVersions()

Quote methods.

Declaration
NSQuoteVersion[] GetQuoteVersions()
Returns
Type Description
NSQuoteVersion[]

Array og QuoteVersions connected to the quote.

Examples
NSQuoteEntity thing;
NSQuoteVersion[] quoteVersions = thing.GetQuoteVersions();

GetSaleId()

Quote methods.

Declaration
Integer GetSaleId()
Returns
Type Description
Integer

The foreign key to the corresponding sale.

Examples
NSQuoteEntity thing;
Integer saleId = thing.GetSaleId();

GetUseValuesFromQuote()

Quote methods.

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
NSQuoteEntity thing;
Integer useValuesFromQuote = thing.GetUseValuesFromQuote();

SetAcceptedQuoteAlternativeId(Integer)

Quote methods.

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. Set when the user is marking a quote as accepted.

Returns
Type Description
Void
Examples
NSQuoteEntity thing;
Integer acceptedQuoteAlternativeId;
thing.SetAcceptedQuoteAlternativeId(acceptedQuoteAlternativeId);

SetActiveQuoteVersionId(Integer)

Quote methods.

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
NSQuoteEntity thing;
Integer activeQuoteVersionId;
thing.SetActiveQuoteVersionId(activeQuoteVersionId);

SetDocumentId(Integer)

Quote methods.

Declaration
Void SetDocumentId(Integer documentId)
Parameters
Type Name Description
Integer documentId

The ID of the main Quote Document.

Returns
Type Description
Void
Examples
NSQuoteEntity thing;
Integer documentId;
thing.SetDocumentId(documentId);

SetERPOrderKey(String)

Quote methods.

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
NSQuoteEntity thing;
String eRPOrderKey;
thing.SetERPOrderKey(eRPOrderKey);

SetERPQuoteKey(String)

Quote methods.

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
NSQuoteEntity thing;
String eRPQuoteKey;
thing.SetERPQuoteKey(eRPQuoteKey);

SetOrderComment(String)

Quote methods.

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
NSQuoteEntity thing;
String orderComment;
thing.SetOrderComment(orderComment);

SetPoNumber(String)

Quote methods.

Declaration
Void SetPoNumber(String poNumber)
Parameters
Type Name Description
String poNumber

Customer's Purchase order number.

Returns
Type Description
Void
Examples
NSQuoteEntity thing;
String poNumber;
thing.SetPoNumber(poNumber);

SetPreferredEmailCulture(String)

Quote methods.

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
NSQuoteEntity thing;
String preferredEmailCulture;
thing.SetPreferredEmailCulture(preferredEmailCulture);

SetQuoteConnectionId(Integer)

Quote methods.

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
NSQuoteEntity thing;
Integer quoteConnectionId;
thing.SetQuoteConnectionId(quoteConnectionId);

SetQuoteId(Integer)

Quote methods.

Declaration
Void SetQuoteId(Integer quoteId)
Parameters
Type Name Description
Integer quoteId

Primary key.

Returns
Type Description
Void
Examples
NSQuoteEntity thing;
Integer quoteId;
thing.SetQuoteId(quoteId);

SetQuoteVersions(NSQuoteVersion[])

Quote methods.

Declaration
Void SetQuoteVersions(NSQuoteVersion[] quoteVersions)
Parameters
Type Name Description
NSQuoteVersion[] quoteVersions

Array og QuoteVersions connected to the quote.

Returns
Type Description
Void
Examples
NSQuoteEntity thing;
NSQuoteVersion[] quoteVersions;
thing.SetQuoteVersions(quoteVersions);

SetSaleId(Integer)

Quote methods.

Declaration
Void SetSaleId(Integer saleId)
Parameters
Type Name Description
Integer saleId

The foreign key to the corresponding sale.

Returns
Type Description
Void
Examples
NSQuoteEntity thing;
Integer saleId;
thing.SetSaleId(saleId);

SetUseValuesFromQuote(Integer)

Quote methods.

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
NSQuoteEntity thing;
Integer useValuesFromQuote;
thing.SetUseValuesFromQuote(useValuesFromQuote);
In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top