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

> Retrieve Breezing company accounting settings, chart of accounts, currency, and integration status for crypto accounting workflows.



## OpenAPI

````yaml GET /company
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:
  /company:
    get:
      tags:
        - Company
      summary: Get company accounting configuration
      description: >-
        Returns the company's accounting configuration: base currency,
        cost-basis method (FIFO, weighted average, LIFO, or HIFO), chart of
        accounts, default fee/gain/loss account mappings, and integration status
        (Xero, QuickBooks, Bexio).


        CRITICAL: "balanceSheetSetup" determines how asset accounts are managed:

        • "token" → Token View: one GL account per token, global across all
        wallets (e.g. all ETH rolls into "Crypto Assets - ETH"). Token-level
        mappings are managed via assets_list / assets_update. On transactions,
        assetAccount and feeAssetAccount will typically show "(auto)", meaning
        Breezing resolves them from the token mapping at sync time. You can
        leave "(auto)" or override with a specific code.

        • "wallet" → Wallet View: one GL account per custody location (e.g.
        "Treasury Wallet Asset"). Set assetAccount and feeAssetAccount
        per-transaction, typically automated with Rules.

        • "wallet-token" → Combined View: one GL account per wallet+token pair
        (e.g. "Treasury Wallet - ETH"). Set assetAccount and feeAssetAccount
        per-transaction, typically using Rules with multiple conditions.

        • null / undefined / "(auto)" → the user should create or apply a Rule
        in Breezing to automate asset-account assignment. Rules are Breezing's
        automation engine; they auto-assign accounts based on conditions like
        wallet, token, direction, and counterparty.


        IMPORTANT: assetAccount and feeAssetAccount exist on every transaction
        regardless of balanceSheetSetup. The setup only changes how they get
        populated (token-level mapping vs per-transaction rules vs manual).


        The "accounts" array is the chart of accounts. Each entry has a "name"
        and a numeric "code". Always use the "code" when setting account,
        assetAccount, or feeAssetAccount on transactions or assets.
      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
      responses:
        '200':
          description: Company retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - true
                  data:
                    $ref: '#/components/schemas/Company'
                required:
                  - success
                  - data
        '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:
    Company:
      type: object
      properties:
        id:
          type: number
          description: Company ID
        name:
          type: string
          description: Company name
        orgId:
          type: number
          description: Organization ID
        currency:
          type: string
          description: Base fiat currency (3 chars)
          example: USD
        accounts:
          nullable: true
          description: Chart of accounts (JSON)
        balanceSheetSetup:
          type: string
          nullable: true
          description: Balance sheet configuration
        accountingMethod:
          type: string
          description: Cost basis method (average, fifo, lifo, hifo)
          example: average
        accountingIsPerWallet:
          type: boolean
          description: >-
            When true, cost-basis (net gain/loss) is calculated separately per
            wallet rather than pooled across all wallets for each token. Affects
            NGL calculation only; does not change which accounts to assign.
        feeAccount:
          $ref: '#/components/schemas/SpecialAccount'
        netGainAccount:
          allOf:
            - $ref: '#/components/schemas/SpecialAccount'
            - description: Default net gain account mapping
        netLossAccount:
          allOf:
            - $ref: '#/components/schemas/SpecialAccount'
            - description: Default net loss account mapping
        isControlAccount:
          type: boolean
          description: Whether control account is enabled
        isCompact:
          type: boolean
          description: >-
            TomDeFi Mode: when true, advanced journals are generated in a
            compact, consolidated format
        xeroLinked:
          type: boolean
          description: Whether Xero is connected
        xeroOrgName:
          type: string
          nullable: true
          description: Linked Xero organization name
        xeroTrackingCategories:
          nullable: true
          description: Xero tracking categories (JSON)
        xeroSyncJournalsAsPosted:
          type: boolean
          description: >-
            Xero journal posting status. When true, journals synced to Xero are
            pushed as POSTED; when false (default), they are created as DRAFT
            for review in Xero before posting. Affects the Xero integration
            only.
        qboLinked:
          type: boolean
          description: Whether QuickBooks is connected
        qboOrgName:
          type: string
          nullable: true
          description: Linked QuickBooks organization name
        qboEntities:
          nullable: true
          description: QuickBooks entities (JSON)
        qboClasses:
          nullable: true
          description: QuickBooks classes (JSON)
        bexioLinked:
          type: boolean
          description: Whether Bexio is connected
        bexioOrgName:
          type: string
          nullable: true
          description: Linked Bexio organization name
        createdAt:
          type: number
          description: Created timestamp (unix ms)
        updatedAt:
          type: number
          description: Updated timestamp (unix ms)
      required:
        - id
        - name
        - orgId
        - currency
        - balanceSheetSetup
        - accountingMethod
        - accountingIsPerWallet
        - feeAccount
        - netGainAccount
        - netLossAccount
        - isControlAccount
        - isCompact
        - xeroLinked
        - xeroOrgName
        - xeroSyncJournalsAsPosted
        - qboLinked
        - qboOrgName
        - bexioLinked
        - bexioOrgName
        - createdAt
        - updatedAt
    SpecialAccount:
      type: object
      nullable: true
      properties:
        type:
          type: string
          nullable: true
        name:
          type: string
          nullable: true
        code:
          type: string
          nullable: true
      required:
        - type
        - name
        - code
      description: Default fee account mapping

````