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

> Retrieve one Breezing journal with its lines, attachments, and version trail to review a manual entry in the company's books.



## OpenAPI

````yaml GET /journals/{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:
  /journals/{id}:
    get:
      tags:
        - Journals
      summary: Get a journal
      description: >-
        Get one journal with its lines, its attachments (each with a signed read
        link valid 10 minutes) and, for a manual journal, its version trail
        (every version shares the number; the newest posted one is the journal
        in the books).
      parameters:
        - schema:
            type: string
            description: Journal ID
            example: '12'
          required: true
          description: Journal 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: Journal retrieved
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    $ref: '#/components/schemas/Journal'
                required:
                  - success
                  - data
        '400':
          description: Invalid journal 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: Journal 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:
    Journal:
      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
        lines:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                description: >-
                  GL account code from the chart of accounts. Empty on a line a
                  DRAFT parked without an account yet; posting refuses the
                  journal until the line has one.
                example: '6500'
              name:
                type: string
                description: The account name at save time.
              debit:
                type: string
                description: Decimal string AS ENTERED, "0" when none.
              credit:
                type: string
                description: Decimal string AS ENTERED, "0" when none.
              description:
                type: string
              tax:
                type: string
                description: >-
                  Tax rate NAME from the tax rate catalog. Files the line on the
                  VAT report; under amountsAre "exclusive" or "inclusive" it
                  also calculates the VAT of the line.
              taxAmount:
                type: string
                description: >-
                  The VAT this line books (amountsAre "exclusive": on top of the
                  amount; "inclusive": carved out of it): the amount calculated
                  when the journal was saved, or the override when taxOverride
                  is true. Absent when the line books no VAT.
              taxCode:
                type: string
                description: The VAT GL account code the VAT of the line books on.
              taxAccountName:
                type: string
              taxOverride:
                type: boolean
                description: >-
                  true when taxAmount is an override a person entered in place
                  of the calculated VAT. Absent on a calculated amount.
              contactId:
                type: number
                description: >-
                  The contact the line is about (GET /contacts). Absent when the
                  line names none.
              contactName:
                type: string
                description: >-
                  The name of that contact as it read when the journal was saved
                  (its address when it has no name).
              xeroTrackingCategory:
                type: string
                description: >-
                  Xero tracking option id the line belongs to, an id from the
                  company xeroTrackingCategories list. Absent when none.
              qboClass:
                type: string
                description: >-
                  QuickBooks class id the line belongs to, an id from the
                  company qboClasses list. Absent when none.
            required:
              - code
              - name
              - debit
              - credit
        attachments:
          type: array
          items:
            $ref: '#/components/schemas/JournalAttachment'
          description: >-
            The supporting files attached to the journal, oldest first. A
            superseded version has none: they moved to the version that replaced
            it.
        versions:
          type: array
          items:
            type: object
            properties:
              id:
                type: number
              status:
                type: string
              date:
                type: string
                nullable: true
              replacesId:
                type: number
                nullable: true
              postedAt:
                type: number
                nullable: true
              voidedAt:
                type: number
                nullable: true
              updatedAt:
                type: number
            required:
              - id
              - status
              - date
              - replacesId
              - postedAt
              - voidedAt
              - updatedAt
      required:
        - id
        - kind
        - status
        - number
        - numberLabel
        - date
        - reversalDate
        - amountsAre
        - reference
        - description
        - lineCount
        - totalDebit
        - totalCredit
        - balanced
        - attachmentCount
        - replacesId
        - postedAt
        - voidedAt
        - xeroPublishState
        - qboPublishState
        - createdAt
        - updatedAt
        - lines
        - attachments
        - versions
    JournalAttachment:
      type: object
      properties:
        id:
          type: number
        name:
          type: string
          description: The original file name.
        extension:
          type: string
          example: pdf
        contentType:
          type: string
          example: application/pdf
        createdAt:
          type: number
          description: unix ms
        url:
          type: string
          nullable: true
          description: >-
            A signed link to read the file, valid 10 minutes. Fetch the journal
            or its attachments again for a fresh one.
      required:
        - id
        - name
        - extension
        - contentType
        - createdAt
        - url

````

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