> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Data.PriceList

# <a id="SuperOffice_WebApi_Data_PriceList" /> Class PriceList

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for 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.

```csharp theme={null}
public class PriceList : Carrier
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[Carrier](SuperOffice.WebApi.Data.Carrier.md) ←
[PriceList](SuperOffice.WebApi.Data.PriceList.md)

#### Inherited Members

[Carrier.TableRight](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_TableRight),
[Carrier.FieldProperties](SuperOffice.WebApi.Data.Carrier.md#SuperOffice_WebApi_Data_Carrier_FieldProperties),
[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Examples

Get PriceList 123 using the WebApi client:
<pre><code class="lang-csharp">var configuration = new WebApiConfiguration(url);
var agent = new QuoteAgent(configuration);
var priceList = agent.GetPriceList( 123 );</code></pre>

## Remarks

Use <xref href="SuperOffice.CRM.Services.ArchiveAgent?text=Archive+agent" data-throw-if-not-resolved="false" />:
All PriceList: <pre><code class="lang-csharp">"PriceList"</code></pre>
Products: <pre><code class="lang-csharp">"Product"</code></pre> with restriction <pre><code class="lang-csharp">"priceListId eq " + id</code></pre>.

## Constructors

### <a id="SuperOffice_WebApi_Data_PriceList__ctor" /> PriceList()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public PriceList()
```

## Properties

### <a id="SuperOffice_WebApi_Data_PriceList_Currency" /> Currency

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

```csharp theme={null}
public virtual string Currency { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_PriceList_CurrencyName" /> CurrencyName

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

```csharp theme={null}
public virtual string CurrencyName { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_PriceList_Description" /> Description

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

```csharp theme={null}
public virtual string Description { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_PriceList_ERPPriceListKey" /> ERPPriceListKey

The key that uniquely identifies this pricelist in the ERP system

```csharp theme={null}
public virtual string ERPPriceListKey { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_PriceList_IsActive" /> IsActive

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

```csharp theme={null}
public virtual bool IsActive { get; set; }
```

#### Property Value

[bool](https://learn.microsoft.com/dotnet/api/system.boolean)

### <a id="SuperOffice_WebApi_Data_PriceList_Name" /> Name

Name of this pricelist to use in the user interface.

```csharp theme={null}
public virtual string Name { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_PriceList_PriceListId" /> PriceListId

Primary key

```csharp theme={null}
public virtual int PriceListId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_PriceList_QuoteConnectionId" /> QuoteConnectionId

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

```csharp theme={null}
public virtual int QuoteConnectionId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_PriceList_ValidFrom" /> 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.

```csharp theme={null}
public virtual DateTime ValidFrom { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

### <a id="SuperOffice_WebApi_Data_PriceList_ValidTo" /> 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.

```csharp theme={null}
public virtual DateTime ValidTo { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

## See Also

[QuoteAgent](SuperOffice.WebApi.Agents.QuoteAgent.md),
[ArchiveAgent](SuperOffice.WebApi.Agents.ArchiveAgent.md),


## Related topics

- [SuperOffice.WebApi.Data.QuoteConnection](/en/api/reference/webapi/SuperOffice.WebApi.Data.QuoteConnection.md)
- [SuperOffice.WebApi.Data.Product](/en/api/reference/webapi/SuperOffice.WebApi.Data.Product.md)
- [SuperOffice.WebApi.Agents.QuoteAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.QuoteAgent.md)
- [SuperOffice.WebApi.Agents.IQuoteAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IQuoteAgent.md)
- [pricelist](/en/api/mdo-providers/reference/pricelist.md)
- [PriceList](/en/api/archive-providers/reference/pricelist.md)