# List price lists

Endpoint: GET /api/pricing/pricelist
Version: v1

## Query parameters:

  - `filter` (string)
    "open" filters on active and coming price lists that has not ended. "active" filters on all active pricelists within start/end dates. "inactive" filters on inactive or ended price lists. Default is "open"

  - `search` (string)
    Search for price lists on name or code

  - `page` (integer)
    Sets the page to return. Default is null which will return all price lists

  - `pageSize` (integer)
    Sets the page size when page is set

## Response 200 fields (application/json):

  - `Id` (integer)

  - `Name` (string)

  - `Description` (string)

  - `Code` (string)

  - `ImageKey` (string)
    Example: "00000000-0000-0000-0000-000000000000"

  - `ImageUrl` (string)

  - `TypeId` (integer)

  - `TypeName` (string)

  - `PriceRuleName` (string)

  - `StartDate` (string)

  - `EndDate` (string)

  - `CurrencyId` (integer)

  - `CurrencyCode` (string)

  - `CurrencyName` (string)

  - `SalesAreaId` (integer)

  - `SalesAreaName` (string)

  - `SalesAreaIdIsInherited` (boolean)

  - `InheritedSalesAreaName` (string)

  - `DefaultPriceRuleId` (integer)

  - `DefaultPriceRuleValue` (number)

  - `DefaultSupplementChargePercentage` (number)

  - `DefaultSupplementCharge` (number)

  - `DefaultMinimumProductMarginPercentage` (number)

  - `DefaultLimitToPriceRecommended` (boolean)

  - `InheritStructureCalculationRule` (integer)

  - `ParentPriceListId` (integer)

  - `ParentPriceListName` (string)

  - `PopulationRuleId` (integer)

  - `PopulationRuleName` (string)

  - `ChosenWarehouseId` (integer)

  - `ChosenLocationId` (integer)

  - `IsPrimary` (boolean)

  - `IsPublic` (boolean)

  - `IsNotStarted` (boolean)

  - `IsEnded` (boolean)

  - `IsVirtual` (boolean)

  - `IsLimitedToStock` (boolean)

  - `IsFavorite` (boolean)

  - `IsActive` (boolean)

  - `Changed` (string)

  - `ChangedBy` (string)