> ## Documentation Index
> Fetch the complete documentation index at: https://help.vori.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List tax rates

> Lists the tax rates configured for the banner, newest first.



## OpenAPI

````yaml /api/openapi.json get /v1/tax-rates
openapi: 3.0.0
info:
  title: Vori API
  description: ''
  version: 1.0.0
  contact: {}
servers:
  - url: https://api.vori.com
    description: production
security: []
tags: []
paths:
  /v1/tax-rates:
    get:
      tags:
        - Tax rates
      summary: List tax rates
      description: Lists the tax rates configured for the banner, newest first.
      operationId: listTaxRates
      parameters:
        - name: active
          required: false
          in: query
          description: Whether the rate is charged at checkout.
          schema:
            type: boolean
        - name: category
          required: false
          in: query
          style: form
          explode: true
          description: >-
            The kind of tax the rate represents. Repeat to match any of up to 20
            values.
          schema:
            type: array
            items:
              type: string
              enum:
                - other
                - sales
        - name: ending_before
          required: false
          in: query
          description: Return records that precede the record with this ID, in list order.
          schema:
            type: string
            pattern: ^[0-9]+$
        - name: limit
          required: false
          in: query
          description: Maximum number of records to return.
          schema:
            minimum: 1
            maximum: 100
            default: 20
            type: integer
        - name: starting_after
          required: false
          in: query
          description: Return records that follow the record with this ID, in list order.
          schema:
            type: string
            pattern: ^[0-9]+$
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TaxRateList'
        '400':
          description: ''
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/ConflictingListParametersError'
                  - $ref: '#/components/schemas/InvalidListCursorError'
        '403':
          description: ''
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/InsufficientPermissionsError'
                  - $ref: '#/components/schemas/NoBannerAssociationError'
      security:
        - bearer: []
components:
  schemas:
    TaxRateList:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TaxRate'
        has_more:
          type: boolean
          description: Whether more records follow this page.
      required:
        - data
        - has_more
    ConflictingListParametersError:
      type: object
      properties:
        error_code:
          type: string
          enum:
            - conflicting_list_parameters
      required:
        - error_code
    InvalidListCursorError:
      type: object
      properties:
        error_code:
          type: string
          enum:
            - invalid_list_cursor
      required:
        - error_code
    InsufficientPermissionsError:
      type: object
      properties:
        error_code:
          type: string
          enum:
            - insufficient_permissions
        error_details:
          $ref: '#/components/schemas/InsufficientPermissionsErrorDetails'
      required:
        - error_code
        - error_details
    NoBannerAssociationError:
      type: object
      properties:
        error_code:
          type: string
          enum:
            - no_banner_association
      required:
        - error_code
    TaxRate:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the record.
        active:
          type: boolean
          description: >-
            Whether the rate is charged at checkout. An inactive rate stays
            configured but is not applied.
        category:
          description: The kind of tax this rate represents.
          allOf:
            - $ref: '#/components/schemas/TaxRateCategory'
        created_at:
          type: string
          description: When the record was created.
          format: date-time
        name:
          type: string
          description: >-
            Name of the tax rate, such as the jurisdiction that levies it or the
            category it covers.
        updated_at:
          type: string
          description: When the record was last changed.
          format: date-time
        value:
          type: string
          description: >-
            The rate charged. When `value_type` is `percentage`, this is a
            percentage of the taxable amount — `8.25` means 8.25%. When it is
            `amount`, this is a fixed amount of currency charged per unit sold.
          example: '8.25'
          pattern: ^[0-9]+(\.[0-9]+)?$
        value_type:
          description: 'How `value` is applied: a fixed amount or a percentage.'
          allOf:
            - $ref: '#/components/schemas/TaxRateValueType'
      description: >-
        A tax applied to products at a store, charged as a flat amount or a
        percentage.
      required:
        - id
        - active
        - category
        - created_at
        - name
        - updated_at
        - value
        - value_type
    InsufficientPermissionsErrorDetails:
      type: object
      properties:
        action:
          allOf:
            - $ref: '#/components/schemas/Action'
        resource:
          allOf:
            - $ref: '#/components/schemas/Resource'
      required:
        - action
        - resource
    TaxRateCategory:
      type: string
      description: The kind of tax a rate represents.
      enum:
        - other
        - sales
    TaxRateValueType:
      type: string
      description: >-
        How a tax rate applies its value: a fixed amount per unit sold, or a
        percentage of the taxable amount.
      enum:
        - amount
        - percentage
    Action:
      type: string
      enum:
        - '*'
        - cancel
        - check_in
        - create
        - delete
        - read
        - record_events
        - refund
        - restart
        - update
        - void
    Resource:
      type: string
      enum:
        - '*'
        - accounting_integration
        - agent_chats
        - api_clients
        - asynchronous_tasks
        - banners
        - blackhawk_transactions
        - capabilities
        - coupons
        - custom_quick_actions
        - datacap_transactions
        - departments
        - discounts
        - ditto_auth_tokens
        - edge_agents
        - electronic_shelf_labels
        - employees
        - files
        - food_modifiers
        - gift_cards
        - gl_code_mappings
        - house_accounts
        - inventory
        - inventory_sessions
        - invoices
        - item_modifiers
        - label_dimension_sets
        - label_sheet_profiles
        - label_stock_products
        - lanes
        - loyalty_bonuses
        - loyalty_campaigns
        - loyalty_rewards
        - notification_templates
        - offers
        - order_guides
        - pos_banner_configurations
        - pos_orders
        - pos_tills
        - price_tags
        - product_ranges
        - products
        - promotions
        - purchase_orders
        - receiving
        - reporting
        - revision_sessions
        - revisions
        - roles
        - shopper_tags
        - shoppers
        - store_product_inventory_counts
        - store_product_lots
        - store_product_rules
        - store_product_tag_templates
        - store_snap_incentive_program_coupons
        - store_vendor_merge_requests
        - store_vendor_product_merge_requests
        - store_vendor_products
        - store_vendors
        - stores
        - tag_printings
        - tag_template_presets
        - tag_templates
        - tax_rates
        - users
        - variable_weights
        - vendor_merge_requests
        - vendor_product_merge_requests
        - vendors
        - wallet_payments
        - wic_products
  securitySchemes:
    bearer:
      type: http
      scheme: bearer

````

## Related topics

- [The tax rate object](/api/tax-rates/object.md)
- [Retrieve a tax rate](/api-reference/tax-rates/retrieve-a-tax-rate.md)
- [Create a tax rate](/api-reference/tax-rates/create-a-tax-rate.md)
