> ## 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 Invoice API

> Retrieve one received invoice from Breezing with its payment matches, vendor suggestion, books eligibility, and scanned field data.



## OpenAPI

````yaml GET /invoices/{id}
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:
  /invoices/{id}:
    get:
      tags:
        - Invoices
      summary: Get a received invoice
      description: >-
        Get one received invoice with its payment matches (the linked
        transactions), the possible-duplicate sibling, the vendor entity
        suggestion with default coding, the books eligibility, and the full scan
        payload (rawExtraction). Returns 404 if not found in this company.
      parameters:
        - schema:
            type: string
            description: Invoice ID
            example: '42'
          required: true
          description: Invoice ID
          name: id
          in: path
        - 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
      responses:
        '200':
          description: Invoice retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    $ref: '#/components/schemas/InvoiceDetail'
                required:
                  - success
                  - data
        '400':
          description: Invalid invoice ID
          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
        '404':
          description: Invoice not found
          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:
    InvoiceDetail:
      allOf:
        - $ref: '#/components/schemas/Invoice'
        - type: object
          properties:
            rawExtraction:
              nullable: true
              description: >-
                The full validated scan payload (line items, VAT breakdown,
                flags), kept immutably for audit. Null when the scan failed or
                has not run.
            matches:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: number
                  trxId:
                    type: number
                  appliedAmountFiat:
                    type: string
                    nullable: true
                    description: >-
                      The allocation: how much of the invoice this transaction
                      settles, in the company currency. Computed once when the
                      invoice is settled (approval, or a link to an approved
                      invoice). Null in review, in clearing mode, and for a
                      match that was not applied.
                  differenceFiat:
                    type: string
                    nullable: true
                    description: >-
                      Applied amount minus the transaction fiat it consumed:
                      positive is a gain, negative a loss. It posts to the FX
                      gain or loss account.
                  xeroPaymentId:
                    type: string
                    nullable: true
                    description: >-
                      The Xero payment recorded for this match (direct
                      settlement), null otherwise.
                  trx:
                    $ref: '#/components/schemas/InvoiceMatchTransaction'
                required:
                  - id
                  - trxId
                  - appliedAmountFiat
                  - differenceFiat
                  - xeroPaymentId
                  - trx
            settlement:
              type: object
              properties:
                mode:
                  type: string
                  enum:
                    - direct
                    - clearing
                    - none
                  description: >-
                    direct = paying transactions are coded to the Accounts
                    Payable account and a Xero bill is paid from the wallet
                    account of each transaction; clearing = they are coded to
                    the AP Clearing account and one provider payment is recorded
                    from it (the QuickBooks loop); none = the company has no
                    Accounts Payable account, so nothing is re-coded and the
                    invoice posts no journal.
                accountCode:
                  type: string
                  nullable: true
                  description: >-
                    The GL account the paying transactions are coded to. Once
                    the invoice is settled this is its own stamp, which wins
                    over the company settings.
                appliedAmountFiat:
                  type: string
                  nullable: true
                  description: >-
                    What the allocations applied so far, null when no match
                    carries one.
                xeroPayments:
                  type: array
                  nullable: true
                  items:
                    type: object
                    properties:
                      trxId:
                        type: number
                      action:
                        type: string
                        enum:
                          - pay
                          - done
                          - skip
                        description: >-
                          pay = publish (or record-payment) records a Xero
                          payment for this match; done = already recorded; skip
                          = left out, see reason.
                      accountCode:
                        type: string
                        nullable: true
                      accountName:
                        type: string
                        nullable: true
                      amount:
                        type: string
                        nullable: true
                        description: >-
                          Two-decimal payment amount, null until the invoice is
                          approved.
                      date:
                        type: string
                        nullable: true
                      paymentId:
                        type: string
                        nullable: true
                      reason:
                        type: string
                        nullable: true
                    required:
                      - trxId
                      - action
                      - accountCode
                      - accountName
                      - amount
                      - date
                      - paymentId
                      - reason
                  description: >-
                    Xero companies outside clearing mode: how each matched
                    transaction pays the bill, null otherwise.
              required:
                - mode
                - accountCode
                - appliedAmountFiat
                - xeroPayments
              description: How this invoice settles against its payments.
            duplicateOf:
              type: object
              nullable: true
              properties:
                id:
                  type: number
                vendorName:
                  type: string
                  nullable: true
                invoiceNumber:
                  type: string
                  nullable: true
                totalAmount:
                  type: string
                  nullable: true
                status:
                  type: string
              required:
                - id
                - vendorName
                - invoiceNumber
                - totalAmount
                - status
            vendorSuggestion:
              type: object
              nullable: true
              properties:
                contactId:
                  type: number
                name:
                  type: string
                  nullable: true
                defaultAccount:
                  type: string
                  nullable: true
                defaultVat:
                  type: string
                  nullable: true
              required:
                - contactId
                - name
                - defaultAccount
                - defaultVat
              description: >-
                The vendor entity contact the vendor name resolves to, with its
                default coding. Read-only suggestion; approval runs the same
                ladder and creates the entity when missing.
            books:
              type: object
              properties:
                eligible:
                  type: boolean
                reasons:
                  type: array
                  items:
                    type: string
              required:
                - eligible
                - reasons
          required:
            - matches
            - settlement
            - duplicateOf
            - vendorSuggestion
            - books
    Invoice:
      type: object
      properties:
        id:
          type: number
        status:
          type: string
          enum:
            - processing
            - review
            - approved
            - failed
          description: >-
            processing = the Scan is running, review = extracted and waiting for
            a human, approved = in the books (immutable on journal fields),
            failed = the Scan failed (fill in manually and approve, or rescan).
        documentType:
          type: string
          nullable: true
          description: invoice | receipt | credit_note | other (from the scan).
        name:
          type: string
          description: Original file name.
        extension:
          type: string
        contentType:
          type: string
        pageCount:
          type: number
          nullable: true
        vendorName:
          type: string
          nullable: true
        vendorVatId:
          type: string
          nullable: true
        vendorIban:
          type: string
          nullable: true
        vendorContactId:
          type: number
          nullable: true
          description: >-
            The vendor entity contact resolved at approval (see the contacts
            isEntity flag), null before approval or when ambiguous.
        invoiceNumber:
          type: string
          nullable: true
        invoiceDate:
          type: string
          nullable: true
          description: Calendar day as yyyy-MM-dd (UTC), null when unknown.
          example: '2026-03-14'
        dueDate:
          type: string
          nullable: true
          description: Calendar day as yyyy-MM-dd (UTC), null when unknown.
          example: '2026-03-14'
        glImpactDate:
          type: string
          nullable: true
          description: >-
            Optional GL posting day override. The native accrual journal posts
            at glImpactDate, else invoiceDate.
          example: '2026-03-14'
        currency:
          type: string
          nullable: true
        totalAmount:
          type: string
          nullable: true
          description: Decimal string in the invoice currency, null when unknown.
        netAmount:
          type: string
          nullable: true
          description: Decimal string in the invoice currency, null when unknown.
        vatAmount:
          type: string
          nullable: true
          description: Decimal string in the invoice currency, null when unknown.
        totalAmountFiat:
          type: string
          nullable: true
          description: >-
            Company-currency total stamped at approval (the amount every report
            reads). Null before approval.
        netAmountFiat:
          type: string
          nullable: true
          description: Decimal string in the invoice currency, null when unknown.
        vatAmountFiat:
          type: string
          nullable: true
          description: Decimal string in the invoice currency, null when unknown.
        exchangeRate:
          nullable: true
          description: >-
            FX audit artifact stamped at approval: { base, target, rate, date,
            source: "same" | "manual" | "fxratesapi" }. Before approval a manual
            rate set via PATCH shows as { rate, source: "manual" }.
        account:
          type: string
          nullable: true
          description: GL account code (chart of accounts code) the expense books to.
        vat:
          type: string
          nullable: true
          description: >-
            Tax rate NAME from the company tax rate catalog (GET /taxes), or
            "no-vat".
        note:
          type: string
          nullable: true
        scanError:
          type: string
          nullable: true
        isPossibleDuplicate:
          type: boolean
        duplicateOfId:
          type: number
          nullable: true
        multiInvoiceSuspected:
          type: boolean
        reviewedBy:
          type: number
          nullable: true
        reviewedAt:
          type: number
          nullable: true
          description: unix ms
        xeroBillId:
          type: string
          nullable: true
        xeroPaymentId:
          type: string
          nullable: true
        qboBillId:
          type: string
          nullable: true
        qboPaymentId:
          type: string
          nullable: true
        bexioBillId:
          type: string
          nullable: true
        bexioPaymentId:
          type: string
          nullable: true
        publishedAt:
          type: number
          nullable: true
          description: unix ms
        inBooks:
          type: boolean
          description: >-
            True when the invoice is approved AND eligible for the native
            accrual journal (bookable document type, invoice date, currency,
            positive total, GL account, stamped fiat total).
        booksReasons:
          type: array
          items:
            type: string
          description: Why an APPROVED invoice is not in the books (empty otherwise).
        paymentStatus:
          type: string
          nullable: true
          enum:
            - paid
            - partial
            - unpaid
            - overdue
            - null
          description: >-
            Approved invoices only. Direct settlement: paid = the allocations of
            the matched transactions apply the invoice total within 1%, partial
            = they apply less, and a linked transaction that was not applied
            pays nothing. Clearing mode (the invoice was settled through the AP
            clearing account): paid = a matched transaction exists. A provider
            payment also means paid. Otherwise overdue = unpaid past the due
            date, else unpaid. Null before approval.
        previewUrl:
          type: string
          nullable: true
          description: >-
            Short-lived signed URL (about 10 minutes) to read the original
            document. Mint a fresh one by re-reading the invoice.
        createdAt:
          type: number
          description: unix ms
        updatedAt:
          type: number
          description: unix ms
      required:
        - id
        - status
        - documentType
        - name
        - extension
        - contentType
        - pageCount
        - vendorName
        - vendorVatId
        - vendorIban
        - vendorContactId
        - invoiceNumber
        - invoiceDate
        - dueDate
        - glImpactDate
        - currency
        - totalAmount
        - netAmount
        - vatAmount
        - totalAmountFiat
        - netAmountFiat
        - vatAmountFiat
        - account
        - vat
        - note
        - scanError
        - isPossibleDuplicate
        - duplicateOfId
        - multiInvoiceSuspected
        - reviewedBy
        - reviewedAt
        - xeroBillId
        - xeroPaymentId
        - qboBillId
        - qboPaymentId
        - bexioBillId
        - bexioPaymentId
        - publishedAt
        - inBooks
        - booksReasons
        - paymentStatus
        - previewUrl
        - createdAt
        - updatedAt
    InvoiceMatchTransaction:
      type: object
      nullable: true
      properties:
        id:
          type: number
        date:
          type: number
          description: Transaction time (unix ms)
        direction:
          type: string
          nullable: true
        token:
          type: string
          nullable: true
        amount:
          type: string
          nullable: true
        amountFiat:
          type: string
          nullable: true
        walletId:
          type: number
          nullable: true
        transactionId:
          type: string
          nullable: true
          description: External reference (chain hash, exchange id).
        exchangeId:
          type: number
          nullable: true
          description: Set when the transaction is one leg of an exchange trade.
        isLocked:
          type: boolean
        counterparty:
          type: string
          description: >-
            Resolved counterparty (contact name, else address) on the side the
            money went to for an out row.
      required:
        - id
        - date
        - direction
        - token
        - amount
        - amountFiat
        - walletId
        - transactionId
        - exchangeId
        - isLocked
        - counterparty
      description: The linked transaction, null when it has since been deleted.

````

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