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

> List the manual journals and the opening balances journal of a Breezing company, with status filters, totals, and publish state.



## OpenAPI

````yaml GET /journals
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:
  /journals:
    get:
      tags:
        - Journals
      summary: List journals
      description: >-
        List the native journals of the company: the manual journals plus the
        take-on journal that carries the opening balances. Rows carry totals and
        counts; fetch one journal for its lines. ONLY journals with status
        "posted" are part of the books (account reports, financial statements,
        general ledger, journal export). Journals never ride a transaction sync;
        a posted journal can be published to Xero or QuickBooks from the
        dashboard, and xeroPublishState / qboPublishState say whether that copy
        is current.
      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
            enum:
              - active
              - draft
              - posted
              - voided
            description: >-
              Default "active": drafts, posted and voided journals (superseded
              versions are history and never listed).
          required: false
          description: >-
            Default "active": drafts, posted and voided journals (superseded
            versions are history and never listed).
          name: status
          in: query
        - schema:
            type: string
            maxLength: 200
            description: >-
              Substring match over the reference, the narration and the number
              label (MJ-0007).
          required: false
          description: >-
            Substring match over the reference, the narration and the number
            label (MJ-0007).
          name: search
          in: query
        - schema:
            type: string
            default: '50'
            description: Rows per page (1-200, default 50).
          required: false
          description: Rows per page (1-200, default 50).
          name: limit
          in: query
        - schema:
            type: string
            default: '0'
            description: Rows to skip (default 0).
          required: false
          description: Rows to skip (default 0).
          name: offset
          in: query
        - schema:
            type: string
            enum:
              - date
              - number
              - status
              - reference
              - createdAt
            description: Sort column (default date).
          required: false
          description: Sort column (default date).
          name: orderBy
          in: query
        - schema:
            type: string
            enum:
              - asc
              - desc
            description: Sort direction (default desc).
          required: false
          description: Sort direction (default desc).
          name: sorting
          in: query
      responses:
        '200':
          description: Journals retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/JournalSummary'
                  pagination:
                    type: object
                    properties:
                      limit:
                        type: integer
                      offset:
                        type: integer
                      total:
                        type: integer
                      hasMore:
                        type: boolean
                    required:
                      - limit
                      - offset
                      - total
                      - hasMore
                required:
                  - success
                  - data
                  - pagination
        '400':
          description: Invalid query parameters
          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:
    JournalSummary:
      type: object
      properties:
        id:
          type: number
        kind:
          type: string
          enum:
            - manual
            - opening
          description: >-
            "manual" = a manual journal; "opening" = the take-on journal that
            carries opening balances (read only through this API).
        status:
          type: string
          description: >-
            draft | posted | voided (and replaced for superseded versions). ONLY
            posted journals are in the books.
        number:
          type: number
          nullable: true
        numberLabel:
          type: string
          nullable: true
          example: MJ-0007
        date:
          type: string
          nullable: true
          description: The journal day, yyyy-MM-dd (UTC).
          example: '2026-03-31'
        reversalDate:
          type: string
          nullable: true
          description: >-
            The day the journal reverses itself, yyyy-MM-dd (UTC), null when it
            never does. A posted journal with a reversal date is in the books
            twice: on its date and, with debits and credits swapped, on this
            day.
          example: '2026-04-01'
        amountsAre:
          type: string
          enum:
            - noTax
            - exclusive
            - inclusive
          description: >-
            "noTax" = no VAT is calculated (a tax rate only files its line on
            the VAT report); "exclusive" = the VAT of every taxed line is booked
            on top of its amount; "inclusive" = the VAT is carved out of its
            amount.
        reference:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
          description: The narration; the fallback description of every line.
        lineCount:
          type: integer
        totalDebit:
          type: string
          description: What the journal books on the debit side, calculated VAT included.
        totalCredit:
          type: string
          description: What the journal books on the credit side, calculated VAT included.
        balanced:
          type: boolean
        attachmentCount:
          type: integer
          description: >-
            How many supporting files are attached to the journal (GET
            /journals/{id}/attachments lists them).
        replacesId:
          type: number
          nullable: true
          description: >-
            The posted version this one superseded, when the journal was edited
            after posting.
        postedAt:
          type: number
          nullable: true
          description: unix ms
        voidedAt:
          type: number
          nullable: true
          description: unix ms
        xeroPublishState:
          type: string
          enum:
            - none
            - published
            - outdated
          description: >-
            The copy at the provider (Xero or QuickBooks), published from the
            dashboard: none = never published; published = up to date; outdated
            = the journal changed since (an edit returns a new version), publish
            again from the dashboard.
        qboPublishState:
          type: string
          enum:
            - none
            - published
            - outdated
          description: >-
            The copy at the provider (Xero or QuickBooks), published from the
            dashboard: none = never published; published = up to date; outdated
            = the journal changed since (an edit returns a new version), publish
            again from the dashboard.
        createdAt:
          type: number
          description: unix ms
        updatedAt:
          type: number
          description: unix ms
      required:
        - id
        - kind
        - status
        - number
        - numberLabel
        - date
        - reversalDate
        - amountsAre
        - reference
        - description
        - lineCount
        - totalDebit
        - totalCredit
        - balanced
        - attachmentCount
        - replacesId
        - postedAt
        - voidedAt
        - xeroPublishState
        - qboPublishState
        - createdAt
        - updatedAt

````

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