Show / Hide Table of Contents

Class PriceList

A pricelist is basically a collection of products. It can be valid in a time period, and outright deactivated. All prices in the product list is in a specific currency. We have decieded not to separate prices and products, which means that we get a simpler data model, but some redundancy.

Carrier object for PriceList. Services for the PriceList Carrier is available from the Quote Agent.
Inheritance
object
PriceList
Namespace: SuperOffice.CRM.Services
Assembly: SuperOffice.Services.dll
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.6.0.0")]
public class PriceList : Carrier
Examples

Get PriceList 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new QuoteAgent();
   var priceList = agent.GetPriceList( 123 );
}

Find all PriceList, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("PriceList", "...", null, "getAllRows eq 1", null, 0, 100 );
var products = archive.GetArchiveListByColumns2("Product", "...", null, "priceListId eq 123", null, 0, 100 );

Constructors

PriceList()

Default constructor

Declaration
public PriceList()
See Also
IQuoteAgent

Properties

Currency

The iso currency code, like 'USD' or 'NOK'.

Declaration
[DataMember]
public virtual string Currency { get; set; }
Property Value
Type Description
string
See Also
IQuoteAgent

CurrencyName

The name to use in the user interface, like perhaps 'US dollar' or '$'

Declaration
[DataMember]
public virtual string CurrencyName { get; set; }
Property Value
Type Description
string
See Also
IQuoteAgent

Description

Description of this pricelist , will be used as tool-tip in the user interface.

Declaration
[DataMember]
public virtual string Description { get; set; }
Property Value
Type Description
string
See Also
IQuoteAgent

ERPPriceListKey

The key that uniquely identifies this pricelist in the ERP system

Declaration
[DataMember]
public virtual string ERPPriceListKey { get; set; }
Property Value
Type Description
string
See Also
IQuoteAgent

IsActive

Is the list active (as opposed to being worked on, suddenly canceled, etc.

Declaration
[DataMember]
public virtual bool IsActive { get; set; }
Property Value
Type Description
bool
See Also
IQuoteAgent

Name

Name of this pricelist to use in the user interface.

Declaration
[DataMember]
public virtual string Name { get; set; }
Property Value
Type Description
string
See Also
IQuoteAgent

PriceListId

Primary key

Declaration
[DataMember]
public virtual int PriceListId { get; set; }
Property Value
Type Description
int
See Also
IQuoteAgent

QuoteConnectionId

(Reserved for future use) The connection to the ERP system used for this pricelist

Declaration
[DataMember]
public virtual int QuoteConnectionId { get; set; }
Property Value
Type Description
int
See Also
IQuoteAgent

ValidFrom

The date (inclusive) the pricelist start to be valid. This can be DateTime.MinValue to signal that it doesn't have a specific start date.

Declaration
[DataMember]
public virtual DateTime ValidFrom { get; set; }
Property Value
Type Description
DateTime
See Also
IQuoteAgent

ValidTo

The date (inclusive) the pricelist ends to be valid. This can be DateTime.MaxValue to signal that it doesn't have a specific end date.

Declaration
[DataMember]
public virtual DateTime ValidTo { get; set; }
Property Value
Type Description
DateTime
See Also
IQuoteAgent

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.

See Also
IQuoteAgent

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)

Returns
Type Description
string

The carrier contents.

See Also
IQuoteAgent

See Also

IQuoteAgent
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top