import ParameterTypes from "@site/src/components/ParameterTypes"

# FilterablePriceListProps

Filters to apply on price lists.

## Properties

<ParameterTypes parameters={[
  {
    "name": "$and",
    "type": "([FilterablePriceListProps](types.FilterablePriceListProps.mdx) \\| [BaseFilterable](../../DAL/interfaces/types.DAL.BaseFilterable.mdx)&#60;[FilterablePriceListProps](types.FilterablePriceListProps.mdx)&#62;)[]",
    "description": "An array of filters to apply on the entity, where each item in the array is joined with an \"and\" condition.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "$or",
    "type": "([FilterablePriceListProps](types.FilterablePriceListProps.mdx) \\| [BaseFilterable](../../DAL/interfaces/types.DAL.BaseFilterable.mdx)&#60;[FilterablePriceListProps](types.FilterablePriceListProps.mdx)&#62;)[]",
    "description": "An array of filters to apply on the entity, where each item in the array is joined with an \"or\" condition.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "ends_at",
    "type": "`string`[]",
    "description": "The end dates to filter price lists by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "id",
    "type": "`string`[]",
    "description": "The IDs to filter price lists by",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "number_rules",
    "type": "`number`[]",
    "description": "The number of rules to filter price lists by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "starts_at",
    "type": "`string`[]",
    "description": "The start dates to filter price lists by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": []
  },
  {
    "name": "status",
    "type": "[PriceListStatus](../enums/types.PriceListStatus.mdx)[]",
    "description": "The statuses to filter price lists by.",
    "optional": true,
    "defaultValue": "",
    "expandable": false,
    "children": [
      {
        "name": "ACTIVE",
        "type": "`\"active\"`",
        "description": "The price list is enabled and its prices can be used.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      },
      {
        "name": "DRAFT",
        "type": "`\"draft\"`",
        "description": "The price list is disabled, meaning its prices can't be used yet.",
        "optional": true,
        "defaultValue": "",
        "expandable": false,
        "children": []
      }
    ]
  }
]} />
