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

# Cash flow statement

> Direct-method cash flow in base currency, bucketed by month, quarter, or year: per-bucket gross inflow/outflow across the organization's bank-backed accounts, plus per-bucket category breakdowns attributing the cash to the non-cash leg of each moving entry. Includes DRAFT and POSTED bank-feed entries (cash moved before confirmation); bank-to-bank transfers are excluded.



## OpenAPI

````yaml /openapi.json get /api/reports/cash-flow
openapi: 3.1.0
info:
  title: Equated API
  version: 1.0.0
  description: >-
    Agent-facing accounting API. Authenticate with a bearer token issued from
    Settings → API Tokens, or via the in-app session cookie when called from the
    web client.
servers:
  - url: https://app.equated.co
    description: API server
security: []
paths:
  /api/reports/cash-flow:
    get:
      tags:
        - Reports
      summary: Cash flow statement
      description: >-
        Direct-method cash flow in base currency, bucketed by month, quarter, or
        year: per-bucket gross inflow/outflow across the organization's
        bank-backed accounts, plus per-bucket category breakdowns attributing
        the cash to the non-cash leg of each moving entry. Includes DRAFT and
        POSTED bank-feed entries (cash moved before confirmation); bank-to-bank
        transfers are excluded.
      parameters:
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
            maximum: 24
            description: >-
              Number of trailing buckets to return. Defaults to 12 months / 8
              quarters / 5 years by `period`.
          required: false
          description: >-
            Number of trailing buckets to return. Defaults to 12 months / 8
            quarters / 5 years by `period`.
          name: buckets
          in: query
        - schema:
            type: integer
            minimum: 0
            exclusiveMinimum: true
            maximum: 24
            description: Legacy alias for `buckets`.
          required: false
          description: Legacy alias for `buckets`.
          name: months
          in: query
        - schema:
            type: string
            minLength: 3
            maxLength: 3
          required: false
          name: currency
          in: query
        - schema:
            type: string
            enum:
              - month
              - quarter
              - year
          required: false
          name: period
          in: query
        - schema:
            type: string
            description: >-
              Comma-separated ledger account ids of bank-backed cash accounts to
              scope the report to. Defaults to all.
          required: false
          description: >-
            Comma-separated ledger account ids of bank-backed cash accounts to
            scope the report to. Defaults to all.
          name: accountIds
          in: query
      responses:
        '200':
          description: The bucketed cash-flow report
          content:
            application/json:
              schema:
                type: object
                properties:
                  report:
                    $ref: '#/components/schemas/CashFlowReport'
                required:
                  - report
      security:
        - bearerAuth: []
components:
  schemas:
    CashFlowReport:
      type: object
      properties:
        currency:
          type: string
        period:
          type: string
          enum:
            - month
            - quarter
            - year
        buckets:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
              label:
                type: string
              income:
                type: number
              expenses:
                type: number
            required:
              - key
              - label
              - income
              - expenses
        breakdowns:
          type: array
          items:
            type: object
            properties:
              key:
                type: string
              categories:
                type: array
                items:
                  type: object
                  properties:
                    accountId:
                      type: number
                    label:
                      type: string
                    emoji:
                      type: string
                      nullable: true
                    color:
                      type: string
                      nullable: true
                    type:
                      type: string
                      enum:
                        - INCOME
                        - EXPENSE
                      description: >-
                        Cash direction (inflow/outflow), independent of the
                        ledger account type.
                    amount:
                      type: number
                  required:
                    - accountId
                    - label
                    - type
                    - amount
            required:
              - key
              - categories
      required:
        - currency
        - period
        - buckets
        - breakdowns
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API token issued from the Equated app under Settings → API Tokens.

````