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

# Bulk Unlock Transactions API

> Unlock every locked Breezing transaction matching a filter in one background task to reopen an accounting period for corrections.



## OpenAPI

````yaml POST /transactions/bulk-unlock
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:
  /transactions/bulk-unlock:
    post:
      tags:
        - Transactions
      summary: Unlock every transaction matching a filter (background task)
      description: >-
        Filter-scoped twin of the id based endpoint: targets every transaction
        matching `filters` instead of an explicit id list, so it covers any
        number of rows. Runs in the background and returns `{ taskId, count }`;
        poll GET /tasks?id=<taskId>. Returns 409 TASK_IN_PROGRESS while the same
        kind of batch task is running for this company.


        Unlocks every matching LOCKED row (the dashboard select-all "Unlock"),
        reopening them to edits and recalculations. Refused with 409 when any
        matching row is dated on or before the books lock date (narrow the
        filter with dateFrom after the lock date, or move the lock date back in
        PATCH /company). Only call it when the user explicitly asks to reopen a
        period.
      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/BulkFiltersBody'
      responses:
        '200':
          description: Background task created
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    type: object
                    properties:
                      taskId:
                        type: number
                        description: >-
                          The background task. Poll GET /tasks?id=<taskId> until
                          it leaves "pending"/"progress"; a "done" task
                          disappears from that list.
                      count:
                        type: number
                        nullable: true
                        description: >-
                          Rows the task will process, as counted when it was
                          created.
                    required:
                      - taskId
                      - count
                required:
                  - success
                  - data
        '400':
          description: Invalid body
          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
        '409':
          description: >-
            The same kind of task is already running for this company
            (TASK_IN_PROGRESS)
          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:
    BulkFiltersBody:
      type: object
      properties:
        filters:
          allOf:
            - $ref: '#/components/schemas/BulkTransactionFilters'
            - description: >-
                Which transactions the action targets. Same filters as GET
                /transactions. An empty object targets every transaction of the
                company (spam excluded by default). Lock state is not a filter
                here: update, lock and automatic repricing only ever touch
                unlocked rows, unlock only touches locked rows.
      required:
        - filters
    BulkTransactionFilters:
      type: object
      properties:
        walletId:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          description: Only transactions of this wallet. Use GET /wallets to find IDs.
        status:
          type: string
          enum:
            - notStarted
            - reviewRequired
            - reconciled
            - manuallyReconciled
            - paid
            - synced
          description: Only transactions in this status.
        account:
          type: string
          description: Only transactions with exactly this contra account code.
        hasAccount:
          type: boolean
          description: >-
            false = only transactions without a contra account (uncategorized),
            true = only categorized ones. Ignored when account is set.
        isSpam:
          type: string
          enum:
            - 'true'
            - 'false'
            - all
          default: 'false'
          description: >-
            Spam filter (default "false"). "all" includes spam rows, "true"
            targets only spam rows.
        dateFrom:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          description: Start of the date window (unix seconds).
        dateTo:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          description: >-
            End of the date window (unix seconds). Defaults to now when only
            dateFrom is set.

````

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