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

# Create Journal API

> Create a manual journal in Breezing for accruals, corrections, or revaluations, saved as a draft or posted straight to the books.



## OpenAPI

````yaml POST /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:
    post:
      tags:
        - Journals
      summary: Create a manual journal
      description: >-
        Create a manual journal in the company currency, as a draft or (post:
        true) straight into the books. Use it for entries no transaction or
        invoice produces: accruals (with a reversalDate, so the accrual releases
        itself), corrections, revaluing a foreign currency balance, clearing a
        residual. The journal gets the next per company number (MJ-0007). Posted
        lines appear in account reports, the financial statements, the general
        ledger and the journal export. Journals never ride a transaction sync;
        publishing one to Xero or QuickBooks is a dashboard action.
      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
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateJournalBody'
      responses:
        '200':
          description: The journal
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    $ref: '#/components/schemas/JournalSummary'
                required:
                  - success
                  - data
        '400':
          description: >-
            Invalid day or reversal date, unknown account or tax rate, a tax
            rate without the VAT account its line needs, or a journal that does
            not balance
          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:
    CreateJournalBody:
      type: object
      properties:
        date:
          type: string
          maxLength: 10
          description: >-
            The journal day, yyyy-MM-dd (UTC). The journal takes effect at the
            first second of that day.
          example: '2026-03-31'
        reference:
          type: string
          nullable: true
          maxLength: 100
          description: Free-text reference, printed next to the journal number.
          example: ACCR-2026-03
        description:
          type: string
          nullable: true
          maxLength: 500
          description: The narration.
          example: Accrue March hosting
        reversalDate:
          type: string
          nullable: true
          maxLength: 10
          description: >-
            Optional: the day the journal reverses itself, yyyy-MM-dd (UTC),
            after `date`. Once posted the journal is in the books on its date
            and again, with debits and credits swapped, on this day (an accrual
            booked at month end and released on the first of the next month).
            The reversal is part of this journal: voiding or editing the journal
            takes it along. null clears it.
          example: '2026-04-01'
        amountsAre:
          type: string
          enum:
            - noTax
            - exclusive
            - inclusive
          description: >-
            How the amounts relate to the tax rates on the lines. "noTax"
            (default): nothing is calculated. "exclusive": for every line
            carrying a tax rate above 0, the VAT (amount x rate, rounded to 2
            decimals) is booked ON TOP of the amount, on the same side, on the
            VAT account of the rate (its output VAT account for a revenue or
            other income account, its input VAT account otherwise). "inclusive":
            the VAT (amount x rate / (100 + rate)) is carved OUT of the amount.
            Debits and credits are compared INCLUDING the calculated VAT.
            Posting 400s when the rate has no VAT account on the side the line
            needs.
        lines:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
                maxLength: 127
                description: >-
                  GL account CODE from the chart of accounts (GET /accounts).
                  Matched case-insensitively; an unknown code 400s.
                example: '6500'
              debit:
                type: string
                maxLength: 40
                description: >-
                  Debit amount in the company currency: a positive decimal
                  string with up to 10 decimals. A line carries a debit OR a
                  credit, never both.
                example: '75.00'
              credit:
                type: string
                maxLength: 40
                description: Credit amount, same shape as debit.
                example: '75.00'
              description:
                type: string
                maxLength: 500
                description: Line description; the journal narration is the fallback.
              tax:
                type: string
                maxLength: 127
                description: >-
                  Tax rate NAME from GET /taxes. Files the line on the VAT
                  report (a line on the rate's VAT account counts as VAT, any
                  other line as the net base). With amountsAre "noTax" (the
                  default) it calculates nothing: write the VAT line yourself.
                  With "exclusive" or "inclusive" Breezing calculates the VAT of
                  the line and books it on the rate's VAT account, so do NOT add
                  a VAT line of your own for it.
              taxAmount:
                type: string
                maxLength: 40
                description: >-
                  Override of the VAT Breezing calculates for this line, for a
                  supplier invoice whose VAT differs by rounding (8.03 where the
                  calculation gives 8.00). Honored ONLY together with
                  taxOverride: true; without the flag it is ignored and the VAT
                  is calculated, so the lines of a GET can be sent back
                  unchanged. A positive decimal with up to 2 decimals, at most
                  the amount of the line, and only on a line that calculates VAT
                  (amountsAre "exclusive" or "inclusive" with a tax rate above
                  0); anything else 400s. It books on the same VAT account as
                  the calculated amount.
                example: '8.03'
              taxOverride:
                type: boolean
                description: >-
                  true = book taxAmount in place of the calculated VAT. An
                  override equal to the calculated amount is stored as a plain
                  calculation. A PATCH that changes amountsAre without sending
                  lines drops the stored overrides and calculates the VAT again
                  under the new mode.
              contactId:
                type: integer
                nullable: true
                minimum: 0
                exclusiveMinimum: true
                description: >-
                  Who the line is about: the id of a contact of this company
                  (GET /contacts). The contact name is stored on the line when
                  the journal is saved and shows as the counterparty of the line
                  in the general ledger. An id that is not a contact of this
                  company 400s. It never changes what the line books.
                example: 42
              xeroTrackingCategory:
                type: string
                nullable: true
                maxLength: 127
                description: >-
                  Xero tracking option id for the line: an `id` from the company
                  xeroTrackingCategories list (GET /company, refreshed by POST
                  /xero/categories/refresh). An id that is not in the list 400s.
              qboClass:
                type: string
                nullable: true
                maxLength: 127
                description: >-
                  QuickBooks class id for the line: an `id` from the company
                  qboClasses list (GET /company, refreshed by POST
                  /qbo/classes/refresh). An id that is not in the list 400s.
            required:
              - code
          maxItems: 200
          description: >-
            The journal lines. To POST a journal needs two or more lines, each
            with an account and exactly one side, and total debits EQUAL to
            total credits exactly (calculated VAT included): Breezing never adds
            a balancing line. A draft may be incomplete.
        post:
          type: boolean
          description: >-
            true = post the journal into the books in the same call (the posting
            rules apply). Default false: the journal is saved as a draft.
      required:
        - date
        - lines
    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.