> ## 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.

# Income statement



## OpenAPI

````yaml /openapi/adam-v1.json get /reports/income-statement
openapi: 3.0.3
info:
  title: Adam Developer API
  version: 1.0.0
  description: >-
    REST API for useadam.io — Adam, the AI accounting agent for small
    businesses. Paths are appended to the server URL.


    **Business key** (`tyms_sk_...`): all routes except `POST
    /register-business` and OAuth authorization steps that document their own
    auth. **Partner key** (`adam_partner_sk_...` or equivalent): only `POST
    /register-business`. **OAuth**: integration apps use `tyms_pk_...` /
    `tyms_sk_...` plus user Bearer tokens — see the OAuth guide.


    Financial reports match what you see in the Adam app. AI create endpoints
    accept optional attachment objects (`name`, `file`, `type`) — see the
    Attachments page in this docs site.
servers:
  - url: https://api.useadam.io/v1/adam
    description: Production
security:
  - apiKey: []
tags:
  - name: Partners
    description: Referral partner (distributor) flows — partner API key only.
  - 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).
paths:
  /reports/income-statement:
    get:
      tags:
        - Reports
      summary: Income statement
      operationId: getIncomeStatement
      parameters:
        - name: from_date
          in: query
          schema:
            type: string
            format: date
        - name: to_date
          in: query
          schema:
            type: string
            format: date
        - name: from
          in: query
          schema:
            type: string
        - name: to
          in: query
          schema:
            type: string
        - name: currency
          in: query
          schema:
            type: string
        - name: transaction_type
          in: query
          schema:
            type: string
        - name: contact
          in: query
          schema:
            type: string
        - name: employee
          in: query
          schema:
            type: string
        - name: creator
          in: query
          schema:
            type: string
        - name: department
          in: query
          schema:
            type: string
        - name: branch
          in: query
          schema:
            type: string
        - name: project
          in: query
          schema:
            type: string
        - name: account
          in: query
          schema:
            type: string
        - name: cut_off_date
          in: query
          schema:
            type: string
      responses:
        '200':
          description: Profit and loss (same basis as in-app reports)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdamSuccessResponse'
              example:
                status: success
                message: Income statement generated successfully
                data:
                  headings:
                    - label: Revenue
                      level: 1
                  content:
                    - label: Sales
                      amount: 12500.5
                      children: []
                  totals:
                    net_income: 4200
                meta:
                  from: '2024-01-01'
                  to: '2024-03-31'
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 all routes except **Register
        business**, which expects your **partner** secret.
      x-default: your_tyms_sk_or_partner_key

````