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

# Preview



## OpenAPI

````yaml /openapi.json post /v1/workspaces/{workspaceId}/projects/{projectId}/tax-settings/preview
openapi: 3.1.0
info:
  title: Specurate API
  description: ''
  version: 1.0.0
  contact: {}
servers:
  - url: https://app.specurate.com/api
    description: API Server
security: []
tags: []
paths:
  /v1/workspaces/{workspaceId}/projects/{projectId}/tax-settings/preview:
    post:
      tags:
        - Project Tax Settings
      summary: Preview
      operationId: ProjectTaxSettingsController_preview_v1
      parameters:
        - name: workspaceId
          required: true
          in: path
          schema:
            type: string
        - name: projectId
          required: true
          in: path
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewProjectTaxSettingsDto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectTaxPreviewResponseDto'
components:
  schemas:
    PreviewProjectTaxSettingsDto:
      type: object
      properties:
        limit:
          type: number
          default: 20
          minimum: 1
          maximum: 100
        templateId:
          type:
            - string
            - 'null'
        cursor:
          type: string
      required:
        - templateId
    ProjectTaxPreviewResponseDto:
      type: object
      properties:
        templateId:
          type:
            - string
            - 'null'
        fieldCounts:
          type: object
          additionalProperties:
            type: integer
            minimum: 0
        nextCursor:
          type:
            - string
            - 'null'
        revision:
          type: number
        libraryRevision:
          type: number
        current:
          $ref: '#/components/schemas/EffectiveTaxSettingsResponseDto'
        proposed:
          $ref: '#/components/schemas/EffectiveTaxSettingsResponseDto'
        affectedItemCount:
          type: number
        items:
          type: array
          items:
            $ref: '#/components/schemas/TaxPreviewItemResponseDto'
        hasMore:
          type: boolean
      required:
        - templateId
        - fieldCounts
        - nextCursor
        - revision
        - libraryRevision
        - current
        - proposed
        - affectedItemCount
        - items
        - hasMore
    EffectiveTaxSettingsResponseDto:
      type: object
      properties:
        sources:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/TaxSettingSourceResponseDto'
        values:
          $ref: '#/components/schemas/TaxSettingsValuesResponseDto'
      required:
        - sources
        - values
    TaxPreviewItemResponseDto:
      type: object
      properties:
        itemId:
          type: string
        before:
          $ref: '#/components/schemas/TaxSettingsValuesResponseDto'
        after:
          $ref: '#/components/schemas/TaxSettingsValuesResponseDto'
        changedFields:
          type: array
          items:
            type: string
      required:
        - itemId
        - before
        - after
        - changedFields
    TaxSettingSourceResponseDto:
      type: object
      properties:
        kind:
          enum:
            - item_override
            - project_override
            - applied_template
            - workspace_default
          type: string
        templateId:
          type: string
          description: Present for template-derived values.
        templateName:
          type: string
          description: Present for template-derived values.
      required:
        - kind
    TaxSettingsValuesResponseDto:
      type: object
      properties:
        purchaseTaxRate:
          type:
            - string
            - 'null'
          pattern: ^(?:0\.\d{6}|1\.000000)$
        clientSalesTaxRate:
          type:
            - string
            - 'null'
          pattern: ^(?:0\.\d{6}|1\.000000)$
        purchaseTaxLabel:
          type: string
        clientSalesTaxLabel:
          type: string
        purchaseTaxExempt:
          type: boolean
        listPriceIncludesPurchaseTax:
          type: boolean
        useSameTaxRate:
          type: boolean
      required:
        - purchaseTaxRate
        - clientSalesTaxRate
        - purchaseTaxLabel
        - clientSalesTaxLabel
        - purchaseTaxExempt
        - listPriceIncludesPurchaseTax
        - useSameTaxRate

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.