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| Name | Description | Type | Additional 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": "806ef369-9a2a-4ac4-9c57-3504c98f408a",
"Name": "sample string 2",
"Expire": "2026-01-21 22:51:04",
"CurrencyId": 3,
"CurrencyName": "sample string 4",
"IncludeVat": true,
"PriceListLines": [
{
"ArticleNo": 1,
"Price": 2.0,
"DiscountFactor": 3.0,
"ArticlePackageId": "250ced4d-e274-48a4-8d16-55b427b959e0"
},
{
"ArticleNo": 1,
"Price": 2.0,
"DiscountFactor": 3.0,
"ArticlePackageId": "250ced4d-e274-48a4-8d16-55b427b959e0"
}
]
},
{
"Id": "806ef369-9a2a-4ac4-9c57-3504c98f408a",
"Name": "sample string 2",
"Expire": "2026-01-21 22:51:04",
"CurrencyId": 3,
"CurrencyName": "sample string 4",
"IncludeVat": true,
"PriceListLines": [
{
"ArticleNo": 1,
"Price": 2.0,
"DiscountFactor": 3.0,
"ArticlePackageId": "250ced4d-e274-48a4-8d16-55b427b959e0"
},
{
"ArticleNo": 1,
"Price": 2.0,
"DiscountFactor": 3.0,
"ArticlePackageId": "250ced4d-e274-48a4-8d16-55b427b959e0"
}
]
}
]
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>2026-01-21T22:51:04.3926079+01:00</Expire>
<Id>806ef369-9a2a-4ac4-9c57-3504c98f408a</Id>
<IncludeVat>true</IncludeVat>
<Name>sample string 2</Name>
<PriceListLines>
<PricelistLineResponse>
<ArticleNo>1</ArticleNo>
<ArticlePackageId>250ced4d-e274-48a4-8d16-55b427b959e0</ArticlePackageId>
<DiscountFactor>3</DiscountFactor>
<Price>2</Price>
</PricelistLineResponse>
<PricelistLineResponse>
<ArticleNo>1</ArticleNo>
<ArticlePackageId>250ced4d-e274-48a4-8d16-55b427b959e0</ArticlePackageId>
<DiscountFactor>3</DiscountFactor>
<Price>2</Price>
</PricelistLineResponse>
</PriceListLines>
</PricelistHeadResponse>
<PricelistHeadResponse>
<CurrencyId>3</CurrencyId>
<CurrencyName>sample string 4</CurrencyName>
<Expire>2026-01-21T22:51:04.3926079+01:00</Expire>
<Id>806ef369-9a2a-4ac4-9c57-3504c98f408a</Id>
<IncludeVat>true</IncludeVat>
<Name>sample string 2</Name>
<PriceListLines>
<PricelistLineResponse>
<ArticleNo>1</ArticleNo>
<ArticlePackageId>250ced4d-e274-48a4-8d16-55b427b959e0</ArticlePackageId>
<DiscountFactor>3</DiscountFactor>
<Price>2</Price>
</PricelistLineResponse>
<PricelistLineResponse>
<ArticleNo>1</ArticleNo>
<ArticlePackageId>250ced4d-e274-48a4-8d16-55b427b959e0</ArticlePackageId>
<DiscountFactor>3</DiscountFactor>
<Price>2</Price>
</PricelistLineResponse>
</PriceListLines>
</PricelistHeadResponse>
</ArrayOfPricelistHeadResponse>