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

# Get vat codes

> Get vat codes existing in the accounting system



## OpenAPI

````yaml get /consumers/{consumer_id}/accounting/vat-codes
openapi: 3.1.0
info:
  title: Chift API
  description: >-
    The Chift API is a universal API giving you access to financial data from
    the software of your clients. It helps software companies to offer native
    integrations to their clients without the effort needed to maintain those
    native integrations. By using the APIs (Accounting, POS, eCommerce) of
    Chift, you connect once and allow your clients to use their software
    packages.
  version: 1.0.0
servers:
  - url: https://api.chift.eu
    description: Chift
security:
  - bearerAuth: []
paths:
  /consumers/{consumer_id}/accounting/vat-codes:
    get:
      tags:
        - Accounting
        - VAT codes
      summary: Get vat codes
      description: Get vat codes existing in the accounting system
      operationId: accounting_get_vat_codes
      parameters:
        - name: consumer_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Consumer Id
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            title: Page
          description: Page number
        - name: size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 50
            title: Size
          description: Page size
        - name: folder_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Folder Id
          description: >-
            Id of the accounting folder instance. A folder represents a legal
            entity within the system. Required when the multiple folders feature
            is enabled.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChiftPage_AccountingVatCode_'
        '400':
          content:
            application/json:
              example:
                message: Error while trying to perform your request
                status: error
              schema:
                $ref: '#/components/schemas/ChiftError'
          description: Bad Request
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - mcp_auth:
            - accounting
            - accounting.read
            - accounting.vat_codes
            - accounting.vat_codes.read
components:
  schemas:
    ChiftPage_AccountingVatCode_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/AccountingVatCode'
          type: array
          title: Items
        total:
          type: integer
          minimum: 0
          title: Total
        page:
          type: integer
          minimum: 1
          title: Page
        size:
          type: integer
          minimum: 1
          title: Size
      type: object
      required:
        - items
        - total
        - page
        - size
      title: ChiftPage[AccountingVatCode]
    ChiftError:
      properties:
        message:
          type: string
          title: Message
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
          default: error
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
          default: ''
      type: object
      required:
        - message
      title: ChiftError
    HTTPValidationError:
      title: Validation Error
      required:
        - message
      type: object
      properties:
        message:
          title: Message
          type: string
          default: Validation error
        status:
          title: Status
          type: string
          default: error
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    AccountingVatCode:
      properties:
        id:
          type: string
          title: Id
          description: Unique id of the VAT Code instance in the accounting system.
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Short code (sometimes also used as id) for the VAT code, as defined
            in the accounting system. This code is typically used for internal
            referencing, mapping, or selection of VAT codes
        active:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Active
          description: >-
            Flag indicating whether the vat code is active. If True, the vat
            code is active and can be used in entries/invoices. If False, the
            vat code is inactive and cannot be used in entries/invoices.
          default: true
        label:
          type: string
          title: Label
          description: >-
            Label of the VAT code as it appears in the accounting system. This
            is the human-readable name used to identify the VAT code.
        scope:
          anyOf:
            - $ref: '#/components/schemas/VatCodeScope'
            - type: 'null'
          description: >-
            Scope of the VAT code, indicating its applicability. Use 'nat' for
            VAT codes that apply to local/domestic sales or purchases, 'eu' for
            cross-border transactions within the EU, and 'int' for transactions
            with countries outside the EU.
          default: unknown
        rate:
          type: number
          title: Rate
          description: >-
            VAT rate associated with the VAT code. This is the percentage rate
            applied to the amount when this VAT code is used.
        type:
          $ref: '#/components/schemas/VatCodeType'
          description: >-
            Type of the VAT code, indicating whether it is a sales tax or
            purchase tax. This helps in understanding how the VAT code is
            applied in transactions.
        deductible_account:
          anyOf:
            - type: string
            - type: 'null'
          title: Deductible Account
          description: >-
            Ledger account number used for the deductible part of the VAT code.
            This is typically used for purchase transactions where VAT can be
            deducted.
        payable_account:
          anyOf:
            - type: string
            - type: 'null'
          title: Payable Account
          description: >-
            Ledger account number used for the payable part of the VAT code.
            This is typically used for sales transactions where VAT is collected
            from customers.
        reversed:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Reversed
          description: >-
            Indicates whether the VAT code is reversed. A reversed VAT code is
            used in specific scenarios, such as reverse charge mechanisms, where
            the responsibility for reporting VAT shifts from the seller to the
            buyer.
          default: false
        withholding_tax:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Withholding Tax
          description: >-
            Indicates whether the VAT code is a withholding tax. This is used to
            indicate that the VAT code is a withholding tax and should be
            treated as such.
          default: false
        country:
          anyOf:
            - type: string
            - type: 'null'
          title: Country
          description: Country of the VAT code. This is the ISO 3166-1 code of the country.
      type: object
      required:
        - id
        - label
        - rate
        - type
      title: AccountingVatCode
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    VatCodeScope:
      type: string
      enum:
        - nat
        - eu
        - int
        - unknown
      title: VatCodeScope
    VatCodeType:
      type: string
      enum:
        - sale
        - purchase
        - both
        - unknown
      title: VatCodeType
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        This access token needs to be included in each of your request to the
        Chift API.

````