> ## Documentation Index
> Fetch the complete documentation index at: https://api-doc.fidly.be/llms.txt
> Use this file to discover all available pages before exploring further.

# List Journals



## OpenAPI

````yaml /openapi.json get /journals
openapi: 3.1.0
info:
  title: Fidly API
  version: 1.0.0
servers:
  - url: https://api.fidly.be
    description: Production
security: []
paths:
  /journals:
    get:
      tags:
        - journals
      summary: List Journals
      operationId: list_journals_journals_get
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            maximum: 100
            minimum: 1
            description: Max items returned (1-100).
            default: 50
            title: Limit
          description: Max items returned (1-100).
        - name: offset
          in: query
          required: false
          schema:
            type: integer
            maximum: 10000
            minimum: 0
            description: Number of items to skip (pagination). Capped at 10000.
            default: 0
            title: Offset
          description: Number of items to skip (pagination). Capped at 10000.
        - name: category
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            description: >-
              Filter by category: `sales_invoice`, `sales_credit`,
              `purchases_invoice`, `purchases_credit`, `incoming_sales`,
              `incoming_purchases` or `incoming`.
            title: Category
          description: >-
            Filter by category: `sales_invoice`, `sales_credit`,
            `purchases_invoice`, `purchases_credit`, `incoming_sales`,
            `incoming_purchases` or `incoming`.
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_JournalOut_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    Page_JournalOut_:
      properties:
        items:
          items:
            $ref: '#/components/schemas/JournalOut'
          type: array
          title: Items
        total:
          type: integer
          title: Total
        limit:
          type: integer
          title: Limit
        offset:
          type: integer
          title: Offset
      type: object
      required:
        - items
        - total
        - limit
        - offset
      title: Page[JournalOut]
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    JournalOut:
      properties:
        id:
          type: string
          title: Id
          description: Opaque unique identifier of the journal.
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
          description: Name of the journal.
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: Short code of the journal, used as a prefix in the numbering.
        category:
          type: string
          title: Category
          description: >-
            What the journal holds. One of: `sales_invoice`, `sales_credit`,
            `purchases_invoice`, `purchases_credit`, `incoming_sales`,
            `incoming_purchases`. A few legacy incoming journals with no
            direction are returned as plain `incoming`.
        is_default:
          type: boolean
          title: Is Default
          description: '`true` when this is the journal used by default for its category.'
        active:
          type: boolean
          title: Active
          description: '`false` when the journal is disabled and no longer used.'
        start_number:
          anyOf:
            - type: integer
            - type: 'null'
          title: Start Number
          description: First number of the numbering sequence.
        numbering_format:
          anyOf:
            - type: string
            - type: 'null'
          title: Numbering Format
          description: Template applied when numbering a document of this journal.
        sequence_scope:
          type: string
          title: Sequence Scope
          description: >-
            How often the numbering restarts: `never`, `monthly`,
            `calendar-year` or `fiscal-year`. A legacy journal carrying a value
            the numbering does not recognise comes out as `unknown` (and is
            numbered as `never`).
        bank_account_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Bank Account Id
          description: >-
            Opaque id of the bank account tied to this journal, resolvable
            through `GET /bank-accounts/{id}`. `null` when the journal has no
            bank account.
      additionalProperties: true
      type: object
      required:
        - id
        - name
        - code
        - category
        - is_default
        - active
        - start_number
        - numbering_format
        - sequence_scope
        - bank_account_id
      title: JournalOut
      description: >-
        An accounting journal of the company, identified by an opaque `id`.


        A journal groups documents of one kind and drives their numbering.
        `bank_account_id` only

        carries a value on the journals it applies to, and is `null` elsewhere.
    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
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````