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 IQuoteAgent.

Inheritance

Object

PriceList

Namespace: SuperOffice.CRM.Services

Assembly: SuperOffice.Services.dll

Syntax

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()

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 );

See Also

QuoteAgent

IQuoteAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Properties

Currency

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

Declaration

public virtual string Currency { get; set; }

Property Value

Type	Description
String

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 );

See Also

QuoteAgent

IQuoteAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

CurrencyName

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

Declaration

public virtual string CurrencyName { get; set; }

Property Value

Type	Description
String

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 );

See Also

QuoteAgent

IQuoteAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Description

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

Declaration

public virtual string Description { get; set; }

Property Value

Type	Description
String

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 );

See Also

QuoteAgent

IQuoteAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

ERPPriceListKey

The key that uniquely identifies this pricelist in the ERP system

Declaration

public virtual string ERPPriceListKey { get; set; }

Property Value

Type	Description
String

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 );

See Also

QuoteAgent

IQuoteAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

IsActive

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

Declaration

public virtual bool IsActive { get; set; }

Property Value

Type	Description
Boolean

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 );

See Also

QuoteAgent

IQuoteAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Name

Name of this pricelist to use in the user interface.

Declaration

public virtual string Name { get; set; }

Property Value

Type	Description
String

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 );

See Also

QuoteAgent

IQuoteAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

PriceListId

Primary key

Declaration

public virtual int PriceListId { get; set; }

Property Value

Type	Description
Int32

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 );

See Also

QuoteAgent

IQuoteAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

QuoteConnectionId

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

Declaration

public virtual int QuoteConnectionId { get; set; }

Property Value

Type	Description
Int32

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 );

See Also

QuoteAgent

IQuoteAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

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

public virtual DateTime ValidFrom { get; set; }

Property Value

Type	Description
DateTime

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 );

See Also

QuoteAgent

IQuoteAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

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

public virtual DateTime ValidTo { get; set; }

Property Value

Type	Description
DateTime

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 );

See Also

QuoteAgent

IQuoteAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration

public override string ToString()

Returns

Type	Description
String	The carrier contents.

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 );

See Also

QuoteAgent

IQuoteAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

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.

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 );

See Also

QuoteAgent

IQuoteAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)

See Also

QuoteAgent

IQuoteAgent

ArchiveAgent

GetArchiveListByColumns2(String, String, String, String, String, Int32, Int32)