> ## Documentation Index
> Fetch the complete documentation index at: https://docs.chift.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# Get chart of accounts

> Get all accounts in the chart of accounts



## OpenAPI

````yaml get /consumers/{consumer_id}/accounting/chart-of-accounts
openapi: 3.1.0
info:
  title: Chift API
  description: >-
    The Chift API is a universal API giving you access to financial data from
    the software of your clients. It helps software companies to offer native
    integrations to their clients without the effort needed to maintain those
    native integrations. By using the APIs (Accounting, POS, eCommerce) of
    Chift, you connect once and allow your clients to use their software
    packages.
  version: 1.0.0
servers:
  - url: https://api.chift.eu
    description: Chift
security:
  - bearerAuth: []
paths:
  /consumers/{consumer_id}/accounting/chart-of-accounts:
    get:
      tags:
        - Accounting
        - Ledger accounts
      summary: Get chart of accounts
      description: Get all accounts in the chart of accounts
      operationId: accounting_get_chart_of_accounts
      parameters:
        - name: consumer_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
            title: Consumer Id
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
            title: Page
          description: Page number
        - name: size
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            default: 50
            title: Size
          description: Page size
        - name: folder_id
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Folder Id
          description: >-
            Id of the accounting folder instance. A folder represents a legal
            entity within the system. Required when the multiple folders feature
            is enabled.
        - name: classes
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Classes
          description: >-
            Filter based on the class of the account (e.g. 6,7 to retrieve 6 and
            7 account classes). The classes are separated by ','.
        - name: type
          in: query
          required: false
          schema:
            anyOf:
              - $ref: '#/components/schemas/AccountTypeFilter'
              - type: 'null'
            title: Type
          description: >-
            Filter based on the type of the account (e.g. bank, cash, income,
            expense, vat).
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChiftPage_AccountItem_'
        '400':
          content:
            application/json:
              example:
                message: Error while trying to perform your request
                status: error
              schema:
                $ref: '#/components/schemas/ChiftError'
          description: Bad Request
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - mcp_auth:
            - accounting
            - accounting.read
            - accounting.ledger_accounts
            - accounting.ledger_accounts.read
components:
  schemas:
    AccountTypeFilter:
      type: string
      enum:
        - bank
        - cash
        - income
        - expense
        - other_expense
        - vat
      title: AccountTypeFilter
    ChiftPage_AccountItem_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/AccountItem'
          type: array
          title: Items
        total:
          type: integer
          minimum: 0
          title: Total
        page:
          type: integer
          minimum: 1
          title: Page
        size:
          type: integer
          minimum: 1
          title: Size
      type: object
      required:
        - items
        - total
        - page
        - size
      title: ChiftPage[AccountItem]
    ChiftError:
      properties:
        message:
          type: string
          title: Message
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
          default: error
        detail:
          anyOf:
            - type: string
            - type: 'null'
          title: Detail
          default: ''
      type: object
      required:
        - message
      title: ChiftError
    HTTPValidationError:
      title: Validation Error
      required:
        - message
      type: object
      properties:
        message:
          title: Message
          type: string
          default: Validation error
        status:
          title: Status
          type: string
          default: error
        detail:
          title: Detail
          type: array
          items:
            $ref: '#/components/schemas/ValidationError'
    AccountItem:
      properties:
        number:
          type: string
          title: Number
          description: >-
            The account number in the chart of accounts. Must be unique within
            the accounting folder. In some countries (e.g., France, Belgium,
            Spain), the number structure is constrained by local accounting
            rules and must follow official charts of accounts (e.g., Plan
            Comptable Général).
        name:
          type: string
          title: Name
          description: >-
            Name or label of the account as it appears in the accounting system.
            This is typically used for internal referencing and identification
            of the account.
        active:
          anyOf:
            - type: boolean
            - type: 'null'
          title: Active
          description: >-
            Flag indicating whether the account is active. If True, the account
            is active and can be used in transactions. If False, the account is
            inactive and cannot be used for transactions.
          default: true
        type:
          anyOf:
            - $ref: '#/components/schemas/AccountItemType'
            - type: 'null'
          description: >-
            Represents the functional type of the ledger account, used to
            support common accounting operations such as payments, invoicing,
            tax handling, and reporting. The type here is more operational and
            aligned with how accounts are actually used in day-to-day processes
            (e.g., tracking receivables, recording VAT, handling bank
            transactions) 
        scheme_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Scheme Ids
          description: >-
            List of scheme classification IDs linked to this ledger account. A
            scheme (e.g., RGS, SBR) provides a standardized classification
            structure for organizing accounts for reporting purposes. Multiple
            scheme codes can be associated with a single account.
        accounting_category:
          anyOf:
            - type: string
            - type: 'null'
          title: Accounting Category
          description: >-
            Category of the ledger account in the accounting system. This is the
            category of the account as defined in the accounting system.
      type: object
      required:
        - number
        - name
      title: AccountItem
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    AccountItemType:
      type: string
      enum:
        - bank
        - cash
        - other_financial
        - receivable
        - payable
        - income
        - expense
        - other_expense
        - vat
        - other
      title: AccountItemType
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        This access token needs to be included in each of your request to the
        Chift API.

````