> ## 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.

# List VAT Report Documents API

> List the received invoices and manual journal lines behind a Breezing VAT report period to trace the figures back to documents.



## OpenAPI

````yaml GET /vat-report/documents
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/documents:
    get:
      tags:
        - VAT Report
      summary: List the documents behind the VAT report
      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.


        Lists the received invoices and manual journal lines that feed the
        report (open them with GET /invoices/{id} and GET /journals/{id}), plus
        the issued invoices of the period for information.
      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: Documents
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    $ref: '#/components/schemas/VatReportDocuments'
                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:
    VatReportDocuments:
      type: object
      properties:
        invoicesInBooks:
          type: boolean
        invoices:
          type: array
          items:
            type: object
            properties:
              id:
                type: number
              day:
                type: string
              vendorName:
                type: string
                nullable: true
              invoiceNumber:
                type: string
                nullable: true
              documentType:
                type: string
                nullable: true
              currency:
                type: string
                nullable: true
              totalAmount:
                type: string
                nullable: true
              account:
                type: string
              rateKey:
                type: string
              rateName:
                type: string
              side:
                type: string
                enum:
                  - sales
                  - purchases
              net:
                type: string
              vatAmount:
                type: string
              gross:
                type: string
              notSplit:
                type: string
                nullable: true
                enum:
                  - unknownRate
                  - unmappedSide
                  - noVatAmount
                  - null
                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.
            required:
              - id
              - day
              - vendorName
              - invoiceNumber
              - documentType
              - currency
              - totalAmount
              - account
              - rateKey
              - rateName
              - side
              - net
              - vatAmount
              - gross
              - notSplit
        journalLines:
          type: array
          items:
            type: object
            properties:
              journalEntryId:
                type: number
              numberLabel:
                type: string
              reference:
                type: string
                nullable: true
              day:
                type: string
              account:
                type: string
              accountName:
                type: string
              description:
                type: string
              contactName:
                type: string
                nullable: true
                description: >-
                  The contact the journal line is about, null when it names
                  none.
              debit:
                type: string
              credit:
                type: string
              rateKey:
                type: string
              rateName:
                type: string
              side:
                type: string
                enum:
                  - sales
                  - purchases
              kind:
                type: string
                enum:
                  - vat
                  - net
                description: >-
                  vat = the line sits on the VAT account of the rate; net = any
                  other account, a net base.
              net:
                type: string
              vatAmount:
                type: string
              gross:
                type: string
              notSplit:
                type: string
                nullable: true
                enum:
                  - unknownRate
                  - unmappedSide
                  - noVatAmount
                  - null
                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.
            required:
              - journalEntryId
              - numberLabel
              - reference
              - day
              - account
              - accountName
              - description
              - contactName
              - debit
              - credit
              - rateKey
              - rateName
              - side
              - kind
              - net
              - vatAmount
              - gross
              - notSplit
        issuedInvoices:
          type: array
          items:
            type: object
            properties:
              id:
                type: number
              invoiceNumber:
                type: string
              customerName:
                type: string
              status:
                type: string
              day:
                type: string
                nullable: true
              currency:
                type: string
              total:
                type: string
              vatRows:
                type: array
                items:
                  type: object
                  properties:
                    key:
                      type: string
                    label:
                      type: string
                    amount:
                      type: string
                  required:
                    - key
                    - label
                    - amount
            required:
              - id
              - invoiceNumber
              - customerName
              - status
              - day
              - currency
              - total
              - vatRows
          description: >-
            Sent or paid issued invoices of the period, in their OWN currency.
            Information only: they are not in the books and not in the report
            totals.
      required:
        - invoicesInBooks
        - invoices
        - journalLines
        - issuedInvoices

````

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