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

# Get VAT Report API

> Retrieve the Breezing VAT report for a period, with output and input VAT per tax rate from transactions, invoices, and journals.



## OpenAPI

````yaml GET /vat-report
openapi: 3.1.0
info:
  title: Breezing Public API
  version: 1.0.0
  description: >-
    Crypto accounting API for programmatic access and AI agents. Authenticate
    with an API key using the Authorization header: `Bearer brz_...`
servers:
  - url: https://api.breezing.io/v1
security:
  - BearerAuth: []
paths:
  /vat-report:
    get:
      tags:
        - VAT Report
      summary: Get the VAT report of a period
      description: >-
        The VAT report covers a period of two inclusive UTC days on an ACCRUAL
        basis (transaction date, invoice impact date, journal date) in the
        company currency. It reads plain in/out transactions naming a tax rate
        (trade legs, internal transfers and spam never count), approved received
        invoices that are in the books (the scanned VAT amount, credit notes
        negative) and posted manual journal lines carrying a tax rate. Amounts
        are signed so the normal direction of each side is positive. Rows naming
        a rate that cannot split (not in the tax rate catalog, or no VAT GL
        account on that side) are listed apart under `notSplit` with their
        gross, never guessed into the totals. Issued invoices are NOT in the
        books, so they are returned for information only and never summed.


        Returns output VAT (sales) and input VAT (purchases) per tax rate, each
        rate broken down by GL account and by source, the net VAT, and what
        could not split.
      parameters:
        - schema:
            type: string
            description: >-
              Organization ID. Use GET /v1/companies to discover available
              org/company pairs.
            example: '1'
          required: true
          description: >-
            Organization ID. Use GET /v1/companies to discover available
            org/company pairs.
          name: orgId
          in: query
        - schema:
            type: string
            description: >-
              Company ID. Use GET /v1/companies to discover available companies
              and their access levels.
            example: '1'
          required: true
          description: >-
            Company ID. Use GET /v1/companies to discover available companies
            and their access levels.
          name: companyId
          in: query
        - schema:
            type: string
            description: First day of the period, yyyy-MM-dd (UTC), inclusive.
            example: '2026-01-01'
          required: true
          description: First day of the period, yyyy-MM-dd (UTC), inclusive.
          name: dateFrom
          in: query
        - schema:
            type: string
            description: Last day of the period, yyyy-MM-dd (UTC), inclusive.
            example: '2026-03-31'
          required: true
          description: Last day of the period, yyyy-MM-dd (UTC), inclusive.
          name: dateTo
          in: query
      responses:
        '200':
          description: VAT report
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    $ref: '#/components/schemas/VatReportSummary'
                required:
                  - success
                  - data
        '400':
          description: Invalid period
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '401':
          description: Invalid or missing API key
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '403':
          description: >-
            API key has no access to this company, has read-only access where
            write was required, or the company subscription is inactive
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
      security:
        - BearerAuth: []
components:
  schemas:
    VatReportSummary:
      type: object
      properties:
        period:
          type: object
          properties:
            dateFrom:
              type: string
            dateTo:
              type: string
          required:
            - dateFrom
            - dateTo
        currency:
          type: string
        sales:
          type: object
          properties:
            rates:
              type: array
              items:
                $ref: '#/components/schemas/VatReportRate'
            totals:
              type: object
              properties:
                net:
                  type: string
                  description: Net base, decimal string.
                vat:
                  type: string
                  description: VAT amount, decimal string.
                gross:
                  type: string
                  description: Net plus VAT, decimal string.
                count:
                  type: integer
                  description: Records behind the figure.
              required:
                - net
                - vat
                - gross
                - count
          required:
            - rates
            - totals
          description: Output VAT.
        purchases:
          type: object
          properties:
            rates:
              type: array
              items:
                $ref: '#/components/schemas/VatReportRate'
            totals:
              type: object
              properties:
                net:
                  type: string
                  description: Net base, decimal string.
                vat:
                  type: string
                  description: VAT amount, decimal string.
                gross:
                  type: string
                  description: Net plus VAT, decimal string.
                count:
                  type: integer
                  description: Records behind the figure.
              required:
                - net
                - vat
                - gross
                - count
          required:
            - rates
            - totals
          description: Input VAT.
        netVat:
          type: string
          description: >-
            Output VAT minus input VAT: positive is payable, negative
            receivable.
        notSplit:
          type: array
          items:
            type: object
            properties:
              side:
                type: string
                enum:
                  - sales
                  - purchases
              rateKey:
                type: string
              rateLabel:
                type: string
              reason:
                type: string
                enum:
                  - unknownRate
                  - unmappedSide
                  - noVatAmount
                description: >-
                  unknownRate = the rate is not in the tax rate catalog;
                  unmappedSide = the rate has no VAT GL account on this side;
                  noVatAmount = a received invoice without a usable scanned VAT
                  amount.
              net:
                type: string
                description: Net base, decimal string.
              vat:
                type: string
                description: VAT amount, decimal string.
              gross:
                type: string
                description: Net plus VAT, decimal string.
              count:
                type: integer
                description: Records behind the figure.
            required:
              - side
              - rateKey
              - rateLabel
              - reason
              - net
              - vat
              - gross
              - count
        counts:
          type: object
          properties:
            transactions:
              type: integer
            invoices:
              type: integer
            journalLines:
              type: integer
          required:
            - transactions
            - invoices
            - journalLines
        invoicesInBooks:
          type: boolean
          description: >-
            false = the company has no Accounts Payable account, so approved
            invoices are not in the books and not in this report.
        invoicesOutOfBooks:
          type: integer
          description: >-
            Approved invoices of the period left out for that reason (0 while
            invoicesInBooks is true).
      required:
        - period
        - currency
        - sales
        - purchases
        - netVat
        - notSplit
        - counts
        - invoicesInBooks
        - invoicesOutOfBooks
    VatReportRate:
      type: object
      properties:
        rateKey:
          type: string
          description: >-
            The rate name, trimmed and lowercased: pass it as `rate` to the
            transactions read.
        name:
          type: string
        rate:
          type: string
          description: Percentage, decimal string.
        vatAccount:
          type: string
          nullable: true
          description: The VAT GL account of this side of the rate.
        xeroTaxType:
          type: string
          nullable: true
        qboTaxCode:
          type: string
          nullable: true
        net:
          type: string
          description: Net base, decimal string.
        vat:
          type: string
          description: VAT amount, decimal string.
        gross:
          type: string
          description: Net plus VAT, decimal string.
        count:
          type: integer
          description: Records behind the figure.
        bySource:
          type: object
          properties:
            transaction:
              type: object
              properties:
                net:
                  type: string
                  description: Net base, decimal string.
                vat:
                  type: string
                  description: VAT amount, decimal string.
                gross:
                  type: string
                  description: Net plus VAT, decimal string.
                count:
                  type: integer
                  description: Records behind the figure.
              required:
                - net
                - vat
                - gross
                - count
            invoice:
              type: object
              properties:
                net:
                  type: string
                  description: Net base, decimal string.
                vat:
                  type: string
                  description: VAT amount, decimal string.
                gross:
                  type: string
                  description: Net plus VAT, decimal string.
                count:
                  type: integer
                  description: Records behind the figure.
              required:
                - net
                - vat
                - gross
                - count
            journal:
              type: object
              properties:
                net:
                  type: string
                  description: Net base, decimal string.
                vat:
                  type: string
                  description: VAT amount, decimal string.
                gross:
                  type: string
                  description: Net plus VAT, decimal string.
                count:
                  type: integer
                  description: Records behind the figure.
              required:
                - net
                - vat
                - gross
                - count
          required:
            - transaction
            - invoice
            - journal
        accounts:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              name:
                type: string
              net:
                type: string
                description: Net base, decimal string.
              vat:
                type: string
                description: VAT amount, decimal string.
              gross:
                type: string
                description: Net plus VAT, decimal string.
              count:
                type: integer
                description: Records behind the figure.
            required:
              - code
              - name
              - net
              - vat
              - gross
              - count
      required:
        - rateKey
        - name
        - rate
        - vatAccount
        - xeroTaxType
        - qboTaxCode
        - net
        - vat
        - gross
        - count
        - bySource
        - accounts

````

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