GET api/Pricelists

Gets all pricelist heads.

Request Information

URI Parameters

None.

Body Parameters

None.

Remarks

This method does not return any pricelist lines. To fetch all lines in a pricelist use /api/pricelists/{id}.

Example

//Gets all pricelists.
http://localhost/api/priceslists

Response Information

Resource Description

Returns all pricelist heads.

Collection of PricelistHeadResponse
NameDescriptionTypeAdditional information
Id

globally unique identifier

Required
Name

string

Required

Max length: 200
Expire

date

None.
CurrencyId

integer

Required
CurrencyName

string

Required
IncludeVat

boolean

Required
PriceListLines

Collection of PricelistLineResponse

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "Id": "54e1b5b0-5a97-4383-b02d-6b79f64447cc",
    "Name": "sample string 2",
    "Expire": "12/21/2025 1:08:10 PM",
    "CurrencyId": 3,
    "CurrencyName": "sample string 4",
    "IncludeVat": true,
    "PriceListLines": [
      {
        "ArticleNo": 1,
        "Price": 2.0,
        "DiscountFactor": 3.0,
        "ArticlePackageId": "f5bc953f-67a0-4d38-9751-a38f2cef9c1d"
      },
      {
        "ArticleNo": 1,
        "Price": 2.0,
        "DiscountFactor": 3.0,
        "ArticlePackageId": "f5bc953f-67a0-4d38-9751-a38f2cef9c1d"
      }
    ]
  },
  {
    "Id": "54e1b5b0-5a97-4383-b02d-6b79f64447cc",
    "Name": "sample string 2",
    "Expire": "12/21/2025 1:08:10 PM",
    "CurrencyId": 3,
    "CurrencyName": "sample string 4",
    "IncludeVat": true,
    "PriceListLines": [
      {
        "ArticleNo": 1,
        "Price": 2.0,
        "DiscountFactor": 3.0,
        "ArticlePackageId": "f5bc953f-67a0-4d38-9751-a38f2cef9c1d"
      },
      {
        "ArticleNo": 1,
        "Price": 2.0,
        "DiscountFactor": 3.0,
        "ArticlePackageId": "f5bc953f-67a0-4d38-9751-a38f2cef9c1d"
      }
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfPricelistHeadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Article">
  <PricelistHeadResponse>
    <CurrencyId>3</CurrencyId>
    <CurrencyName>sample string 4</CurrencyName>
    <Expire>2025-12-21T13:08:10.5626148+00:00</Expire>
    <Id>54e1b5b0-5a97-4383-b02d-6b79f64447cc</Id>
    <IncludeVat>true</IncludeVat>
    <Name>sample string 2</Name>
    <PriceListLines>
      <PricelistLineResponse>
        <ArticleNo>1</ArticleNo>
        <ArticlePackageId>f5bc953f-67a0-4d38-9751-a38f2cef9c1d</ArticlePackageId>
        <DiscountFactor>3</DiscountFactor>
        <Price>2</Price>
      </PricelistLineResponse>
      <PricelistLineResponse>
        <ArticleNo>1</ArticleNo>
        <ArticlePackageId>f5bc953f-67a0-4d38-9751-a38f2cef9c1d</ArticlePackageId>
        <DiscountFactor>3</DiscountFactor>
        <Price>2</Price>
      </PricelistLineResponse>
    </PriceListLines>
  </PricelistHeadResponse>
  <PricelistHeadResponse>
    <CurrencyId>3</CurrencyId>
    <CurrencyName>sample string 4</CurrencyName>
    <Expire>2025-12-21T13:08:10.5626148+00:00</Expire>
    <Id>54e1b5b0-5a97-4383-b02d-6b79f64447cc</Id>
    <IncludeVat>true</IncludeVat>
    <Name>sample string 2</Name>
    <PriceListLines>
      <PricelistLineResponse>
        <ArticleNo>1</ArticleNo>
        <ArticlePackageId>f5bc953f-67a0-4d38-9751-a38f2cef9c1d</ArticlePackageId>
        <DiscountFactor>3</DiscountFactor>
        <Price>2</Price>
      </PricelistLineResponse>
      <PricelistLineResponse>
        <ArticleNo>1</ArticleNo>
        <ArticlePackageId>f5bc953f-67a0-4d38-9751-a38f2cef9c1d</ArticlePackageId>
        <DiscountFactor>3</DiscountFactor>
        <Price>2</Price>
      </PricelistLineResponse>
    </PriceListLines>
  </PricelistHeadResponse>
</ArrayOfPricelistHeadResponse>