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	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": "333457b8-5658-46f3-b3df-337bfc25a705",
    "Name": "sample string 2",
    "Expire": "4/16/2026 1:25:52 PM",
    "CurrencyId": 3,
    "CurrencyName": "sample string 4",
    "IncludeVat": true,
    "PriceListLines": [
      {
        "ArticleNo": 1,
        "Price": 2.0,
        "DiscountFactor": 3.0,
        "ArticlePackageId": "07a6037b-6c9a-457b-bb19-a5ec11009867"
      },
      {
        "ArticleNo": 1,
        "Price": 2.0,
        "DiscountFactor": 3.0,
        "ArticlePackageId": "07a6037b-6c9a-457b-bb19-a5ec11009867"
      }
    ]
  },
  {
    "Id": "333457b8-5658-46f3-b3df-337bfc25a705",
    "Name": "sample string 2",
    "Expire": "4/16/2026 1:25:52 PM",
    "CurrencyId": 3,
    "CurrencyName": "sample string 4",
    "IncludeVat": true,
    "PriceListLines": [
      {
        "ArticleNo": 1,
        "Price": 2.0,
        "DiscountFactor": 3.0,
        "ArticlePackageId": "07a6037b-6c9a-457b-bb19-a5ec11009867"
      },
      {
        "ArticleNo": 1,
        "Price": 2.0,
        "DiscountFactor": 3.0,
        "ArticlePackageId": "07a6037b-6c9a-457b-bb19-a5ec11009867"
      }
    ]
  }
]

application/xml, text/xml