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

# List ledger accounts

> List accounting ledger accounts with optional balances.



## OpenAPI

````yaml get /v1/accounting/accounts
openapi: 3.1.0
info:
  title: Hyperline API
  version: 0.0.0
servers:
  - url: https://api.hyperline.co
  - url: https://sandbox.api.hyperline.co
security: []
paths:
  /v1/accounting/accounts:
    get:
      tags:
        - Accounting > Accounts
      summary: List ledger accounts
      description: List accounting ledger accounts with optional balances.
      operationId: listLedgerAccounts
      parameters:
        - schema:
            type:
              - number
              - 'null'
            minimum: 0
            maximum: 100
            default: 50
          required: false
          name: take
          in: query
        - schema:
            type:
              - number
              - 'null'
            minimum: 0
            default: 0
          required: false
          name: skip
          in: query
        - schema:
            type: string
            description: Filter by account ID.
          required: false
          description: Filter by account ID.
          name: id
          in: query
        - schema:
            type: string
            description: Filter by ledger ID.
          required: false
          description: Filter by ledger ID.
          name: ledger_id
          in: query
        - schema:
            type: string
            description: Filter by invoicing entity ID.
          required: false
          description: Filter by invoicing entity ID.
          name: invoicing_entity_id
          in: query
        - schema:
            type: string
            description: Filter by exact account code.
          required: false
          description: Filter by exact account code.
          name: code
          in: query
        - schema:
            type: string
            description: Filter by exact account name.
          required: false
          description: Filter by exact account name.
          name: name
          in: query
        - schema:
            type: string
            enum:
              - asset
              - contra_asset
              - liability
              - contra_liability
              - equity
              - revenue
              - contra_revenue
              - expense
            description: Filter by account type.
          required: false
          description: Filter by account type.
          name: type
          in: query
        - schema:
            type: string
            description: Filter by connected provider ID.
          required: false
          description: Filter by connected provider ID.
          name: client_provider_id
          in: query
        - schema:
            type: string
            description: Search account name or code.
          required: false
          description: Search account name or code.
          name: search
          in: query
        - schema:
            type:
              - integer
              - 'null'
            minimum: 2000
            maximum: 2100
            description: Year used to calculate period balances.
          required: false
          description: Year used to calculate period balances.
          name: year
          in: query
        - schema:
            type:
              - integer
              - 'null'
            minimum: 1
            maximum: 4
            description: Quarter used to calculate period balances.
          required: false
          description: Quarter used to calculate period balances.
          name: quarter
          in: query
        - schema:
            type:
              - string
              - 'null'
            enum:
              - name
              - code
            description: Field used to sort accounts.
          required: false
          description: Field used to sort accounts.
          name: sort_by
          in: query
        - schema:
            type:
              - string
              - 'null'
            enum:
              - asc
              - desc
            description: Sort direction.
          required: false
          description: Sort direction.
          name: order
          in: query
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountingLedgerAccountPaginated'
      security:
        - bearer: []
components:
  schemas:
    AccountingLedgerAccountPaginated:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/AccountingPaginationMeta'
        data:
          type: array
          items:
            $ref: '#/components/schemas/AccountingLedgerAccount'
          description: Ledger accounts returned by the request.
      required:
        - meta
        - data
    AccountingPaginationMeta:
      type: object
      properties:
        total:
          type: number
          description: Total number of matching resources.
        taken:
          type: number
          description: Number of resources returned.
        skipped:
          type: number
          description: Number of resources skipped.
      required:
        - total
        - taken
        - skipped
      description: Pagination metadata.
    AccountingLedgerAccount:
      type: object
      properties:
        id:
          type: string
          description: Unique ledger account identifier.
        ledger_id:
          type: string
          description: Owning ledger identifier.
        code:
          type: string
          description: Accounting code of the account.
        type:
          type: string
          enum:
            - asset
            - contra_asset
            - liability
            - contra_liability
            - equity
            - revenue
            - contra_revenue
            - expense
          description: Accounting type of the account.
        is_default:
          type: boolean
          description: Whether the account is a system default.
        name:
          type: string
          description: Display name of the account.
        description:
          type:
            - string
            - 'null'
          description: Optional account description.
        currency:
          type: string
          description: ISO 4217 account currency.
        provider_account_id:
          type:
            - string
            - 'null'
          description: Matching account identifier at the provider.
        client_provider_id:
          type:
            - string
            - 'null'
          description: Connected provider identifier.
        last_refreshed_at:
          type:
            - string
            - 'null'
          format: date
          description: Timestamp of the last provider refresh.
        balance:
          type: string
          description: Lifetime account balance when requested by a list endpoint.
        period_balance:
          type:
            - string
            - 'null'
          description: Quarter balance when a year and quarter are supplied.
        created_at:
          type:
            - string
            - 'null'
          format: date
          description: Timestamp when the account was created.
        updated_at:
          type:
            - string
            - 'null'
          format: date
          description: Timestamp when the account was last updated.
      required:
        - id
        - ledger_id
        - code
        - type
        - is_default
        - name
        - description
        - currency
        - provider_account_id
        - client_provider_id
        - last_refreshed_at
        - created_at
        - updated_at
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````