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

# General ledger

> Paginated chronological ledger of all posted journal legs across the business — the complete double-entry audit trail. Filter by account name, contact, transaction type, or date range. Each row includes debit/credit amounts in both transaction and base currency.



## OpenAPI

````yaml /openapi/adam-v1.json get /reports/general-ledger
openapi: 3.0.3
info:
  title: Tyms Developer API
  version: 1.0.0
  description: >-
    REST API for Tyms — the AI-Native Accounting Platform for small and
    medium-sized businesses across service, consulting, retail, and
    manufacturing. Paths are appended to the server URL.


    **Business key** (`tyms_sk_...`): all routes except partner distributor
    routes and OAuth authorization steps that document their own auth. **Partner
    key** (`adam_partner_sk_...` or equivalent): `POST /register-business`, `GET
    /referred-businesses`, billing status, and seat/credit grants on referred
    businesses. **OAuth**: integration apps use `tyms_pk_...` / `tyms_sk_...`
    plus user Bearer tokens — see the OAuth guide.


    Financial reports match what you see in the Tyms app. AI create endpoints
    accept optional attachment objects (`name`, `file`, `type`) — see the
    Attachments page in this docs site.
servers:
  - url: https://staging-api.usetyms.com/v1/adam
    description: Sandbox (pre-production). Request credentials at developer@usetyms.com.
  - url: https://api.usetyms.com/v1/adam
    description: Production
security:
  - apiKey: []
tags:
  - name: Partners
    description: >-
      Referral partner (distributor) flows — partner API key only. Register
      businesses, list referrals, read billing, and grant Plus seats or AI
      credits from partner holding.
  - name: Authentication
    description: Validate a business Developer API key.
  - name: OAuth
    description: >-
      Third-party integration authorization — connect Tyms users to your app
      without sharing their business secret keys.
  - name: Chart of accounts
    description: COA and bank-linked accounts.
  - name: Invoices
    description: Invoice CRUD and payments.
  - name: Bills
    description: Bill CRUD and payments.
  - name: Expenses
    description: Expense CRUD.
  - name: Income
    description: Income record CRUD.
  - name: Journals
    description: Journal entry CRUD.
  - name: Contacts
    description: Contact CRUD.
  - name: Banks
    description: Bank accounts.
  - name: Bank transactions
    description: Statement lines and AI-assisted upload.
  - name: Reports
    description: Financial statements (aligned with in-app reports).
  - name: Inventory
    description: Product and service catalog; stock tracking, sell, and restock.
  - name: Fixed Assets
    description: Capital asset acquisition and tracking.
  - name: Quotes
    description: >-
      Sales proposals that can be converted to invoices, income, or prepaid
      income.
  - name: Purchase Orders
    description: Vendor buying commitments that convert to inventory restocks.
  - name: Departments
    description: Reporting dimension for cost/profit allocation within a branch.
  - name: Projects
    description: Job costing and project tracking dimension attached to transactions.
  - name: Branches
    description: Multi-location dimension; reports and lists can filter by branch.
paths:
  /reports/general-ledger:
    get:
      tags:
        - Reports
      summary: General ledger
      description: >-
        Paginated chronological ledger of all posted journal legs across the
        business — the complete double-entry audit trail. Filter by account
        name, contact, transaction type, or date range. Each row includes
        debit/credit amounts in both transaction and base currency.
      operationId: getGeneralLedger
      parameters:
        - name: from
          in: query
          schema:
            type: string
            format: date
          description: 'Period start date (`Y-m-d`). Alias: `from_date`.'
        - name: from_date
          in: query
          schema:
            type: string
            format: date
          description: Alias for `from`.
        - name: to
          in: query
          schema:
            type: string
            format: date
          description: 'Period end date (`Y-m-d`). Alias: `to_date`.'
        - name: to_date
          in: query
          schema:
            type: string
            format: date
          description: Alias for `to`.
        - name: list
          in: query
          schema:
            type: integer
            enum:
              - 1
          description: >-
            Pass `1` to return raw `data` only without the `status`/`message`
            wrapper.
        - name: search
          in: query
          schema:
            type: string
          description: Match narration, journal no, contact name, or account name.
        - name: transaction_type
          in: query
          schema:
            type: string
          description: >-
            Filter by transaction type (e.g. `invoice`, `expenses`,
            `sales_receipt`).
        - name: account
          in: query
          schema:
            type: string
          description: Filter by account name.
        - name: contact
          in: query
          schema:
            type: string
          description: Filter by contact identifier.
        - name: branch
          in: query
          schema:
            type: string
          description: Filter by branch.
        - name: limit
          in: query
          schema:
            type: integer
          description: Page size (default `100`).
        - name: page
          in: query
          schema:
            type: integer
          description: Page number.
      responses:
        '200':
          description: Paginated general ledger
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdamSuccessResponse'
              example:
                status: success
                message: General ledger retrieved successfully
                data:
                  current_page: 1
                  data:
                    - uuid: gl111111111111111111111111111111
                      date: '2026-03-01T00:00:00.000000Z'
                      journal_no: JNL-1001
                      narration: Invoice INV-1042 — Website design services
                      account: Accounts Receivable
                      account_type: Assets
                      account_sub_type: Accounts receivable
                      transaction_type: Invoice
                      debit_amount: 150000
                      credit_amount: 0
                      main_debit_amount: 150000
                      main_credit_amount: 0
                      currency: NGN
                      contact: a1b2c3d4e5f6478990a1b2c3d4e5f678
                      contact_name: John Smith
                      branch: null
                      department: null
                      project: null
                  per_page: 100
                  total: 1
components:
  schemas:
    AdamSuccessResponse:
      type: object
      required:
        - status
        - message
      properties:
        status:
          type: string
          example: success
        message:
          type: string
        data:
          description: >-
            Single resource, array of resources, statement sections, or async
            job metadata — see each operation's example.
        meta:
          type: object
          additionalProperties: true
          description: >-
            Pagination (`page`, `limit`, `total`) and/or report range (`from`,
            `to`). Cash flow may include `previous_period_end`.
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        Business secret `tyms_sk_...` for business-scoped routes. Partner secret
        for register-business and referred-business distributor routes.
      x-default: your_tyms_sk_or_partner_key

````