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

# Get cashflow statement report



## OpenAPI

````yaml api-reference/openapi.json get /api/reports/cashflow-statement
openapi: 3.0.0
info:
  title: Bigcapital
  description: Financial accounting software
  version: '1.0'
  contact: {}
servers: []
security: []
tags: []
paths:
  /api/reports/cashflow-statement:
    get:
      tags:
        - Reports
      summary: Get cashflow statement report
      operationId: CashflowController_getCashflow
      parameters:
        - name: Authorization
          in: header
          description: >-
            Value must be 'Bearer <token>' where <token> is an API key prefixed
            with 'bc_' or a JWT token.
          required: true
          schema:
            type: string
            example: Bearer bc_1234567890abcdef
        - name: organization-id
          in: header
          description: >-
            Required if Authorization is a JWT token. The organization ID to
            operate within.
          required: true
          schema:
            type: string
        - name: fromDate
          required: false
          in: query
          description: Start date for the cash flow statement period
          schema:
            format: date-time
            type: string
        - name: toDate
          required: false
          in: query
          description: End date for the cash flow statement period
          schema:
            format: date-time
            type: string
        - name: displayColumnsBy
          required: false
          in: query
          description: Display columns by time period
          schema:
            default: year
            enum:
              - day
              - month
              - year
              - quarter
            type: string
        - name: displayColumnsType
          required: false
          in: query
          description: Type of column display
          schema:
            default: total
            enum:
              - total
              - date_periods
            type: string
        - name: noneZero
          required: false
          in: query
          description: Filter out zero values
          schema:
            default: false
            type: boolean
        - name: noneTransactions
          required: false
          in: query
          description: Filter out transactions
          schema:
            default: false
            type: boolean
        - description: Number of decimal places to display
          required: false
          name: precision
          in: query
          schema:
            example: 2
            type: number
        - description: Whether to divide the number by 1000
          required: false
          name: divideOn1000
          in: query
          schema:
            example: false
            type: boolean
        - description: Whether to show zero values
          required: false
          name: showZero
          in: query
          schema:
            type: boolean
            example: true
        - description: How to format money values
          required: false
          name: formatMoney
          in: query
          schema:
            example: total
            enum:
              - total
              - always
              - none
            type: string
        - description: How to format negative numbers
          required: false
          name: negativeFormat
          in: query
          schema:
            example: parentheses
            enum:
              - parentheses
              - mines
            type: string
        - name: basis
          required: false
          in: query
          description: Basis for the cash flow statement
          schema:
            type: string
        - name: accept
          required: true
          in: header
          schema:
            type: string
      responses:
        '200':
          description: Cashflow statement report
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CashflowStatementResponseDto'
              example:
                data:
                  - id: OPERATING
                    label: OPERATING ACTIVITIES
                    footer_label: Net cash provided by operating activities
                    section_type: AGGREGATE
                    children:
                      - id: NET_INCOME
                        label: Net income
                        total:
                          amount: -113923
                          formatted_amount: '-113,923.00'
                          currency_code: USD
                        section_type: NET_INCOME
                        children: []
                      - section_type: ACCOUNTS
                        id: OPERATING_ACCOUNTS
                        label: Adjustments net income by operating activities.
                        children:
                          - id: 1006
                            code: '10007'
                            label: Accounts Receivable (A/R)
                            account_type: accounts-receivable
                            adjustment_type: mines
                            total:
                              amount: 0
                              formatted_amount: ''
                              currency_code: USD
                            section_type: ACCOUNT
                          - id: 1007
                            code: '10008'
                            label: Inventory Asset
                            account_type: inventory
                            adjustment_type: mines
                            total:
                              amount: -1000
                              formatted_amount: '-1,000.00'
                              currency_code: USD
                            section_type: ACCOUNT
                          - id: 1008
                            code: '20001'
                            label: Accounts Payable (A/P)
                            account_type: accounts-payable
                            adjustment_type: plus
                            total:
                              amount: 1300
                              formatted_amount: 1,300.00
                              currency_code: USD
                            section_type: ACCOUNT
                          - id: 1013
                            code: '20006'
                            label: Tax Payable
                            account_type: tax-payable
                            adjustment_type: plus
                            total:
                              amount: 0
                              formatted_amount: ''
                              currency_code: USD
                            section_type: ACCOUNT
                          - id: 1030
                            code: '100010'
                            label: Prepaid Expenses
                            account_type: other-current-asset
                            adjustment_type: mines
                            total:
                              amount: 123123
                              formatted_amount: 123,123.00
                              currency_code: USD
                            section_type: ACCOUNT
                          - id: 1009
                            code: '20002'
                            label: Owner A Drawings
                            account_type: other-current-liability
                            adjustment_type: plus
                            total:
                              amount: 0
                              formatted_amount: ''
                              currency_code: USD
                            section_type: ACCOUNT
                          - id: 1010
                            code: '20003'
                            label: Loan
                            account_type: other-current-liability
                            adjustment_type: plus
                            total:
                              amount: -10000
                              formatted_amount: '-10,000.00'
                              currency_code: USD
                            section_type: ACCOUNT
                          - id: 1011
                            code: '20004'
                            label: Opening Balance Liabilities
                            account_type: other-current-liability
                            adjustment_type: plus
                            total:
                              amount: 0
                              formatted_amount: ''
                              currency_code: USD
                            section_type: ACCOUNT
                          - id: 1012
                            code: '20005'
                            label: Revenue Received in Advance
                            account_type: other-current-liability
                            adjustment_type: plus
                            total:
                              amount: 0
                              formatted_amount: ''
                              currency_code: USD
                            section_type: ACCOUNT
                          - id: 1029
                            code: '50005'
                            label: Unearned Revenue
                            account_type: other-current-liability
                            adjustment_type: plus
                            total:
                              amount: 0
                              formatted_amount: ''
                              currency_code: USD
                            section_type: ACCOUNT
                        total:
                          amount: 113423
                          formatted_amount: $113,423.00
                          currency_code: USD
                    total:
                      amount: -500
                      formatted_amount: '-$500.00'
                      currency_code: USD
                  - section_type: ACCOUNTS
                    id: INVESTMENT
                    label: INVESTMENT ACTIVITIES
                    footer_label: cash_flow_statement.net_cash_investing
                    children:
                      - id: 1004
                        code: '10005'
                        label: Computer Equipment
                        account_type: fixed-asset
                        adjustment_type: mines
                        total:
                          amount: 0
                          formatted_amount: ''
                          currency_code: USD
                        section_type: ACCOUNT
                      - id: 1005
                        code: '10006'
                        label: Office Equipment
                        account_type: fixed-asset
                        adjustment_type: mines
                        total:
                          amount: 0
                          formatted_amount: ''
                          currency_code: USD
                        section_type: ACCOUNT
                    total:
                      amount: 0
                      formatted_amount: $0.00
                      currency_code: USD
                  - section_type: ACCOUNTS
                    id: FINANCIAL
                    label: FINANCIAL ACTIVITIES
                    footer_label: cash_flow_statement.net_cash_financing
                    children:
                      - id: 1014
                        code: '30001'
                        label: Retained Earnings
                        account_type: equity
                        adjustment_type: plus
                        total:
                          amount: 0
                          formatted_amount: ''
                          currency_code: USD
                        section_type: ACCOUNT
                      - id: 1015
                        code: '30002'
                        label: Opening Balance Equity
                        account_type: equity
                        adjustment_type: plus
                        total:
                          amount: 0
                          formatted_amount: ''
                          currency_code: USD
                        section_type: ACCOUNT
                      - id: 1016
                        code: '30003'
                        label: Owner's Equity
                        account_type: equity
                        adjustment_type: plus
                        total:
                          amount: 0
                          formatted_amount: ''
                          currency_code: USD
                        section_type: ACCOUNT
                      - id: 1017
                        code: '30003'
                        label: Drawings
                        account_type: equity
                        adjustment_type: plus
                        total:
                          amount: 0
                          formatted_amount: ''
                          currency_code: USD
                        section_type: ACCOUNT
                    total:
                      amount: 0
                      formatted_amount: $0.00
                      currency_code: USD
                  - section_type: CASH_AT_BEGINNING
                    id: CASH_BEGINNING_PERIOD
                    label: Cash at beginning of period
                    children:
                      - id: 1002
                        code: '10003'
                        label: Undeposited Funds
                        account_type: cash
                        adjustment_type: plus
                        total:
                          amount: 0
                          formatted_amount: ''
                          currency_code: USD
                        section_type: ACCOUNT
                      - id: 1003
                        code: '10004'
                        label: Petty Cash
                        account_type: cash
                        adjustment_type: plus
                        total:
                          amount: 0
                          formatted_amount: ''
                          currency_code: USD
                        section_type: ACCOUNT
                      - id: 1000
                        code: '10001'
                        label: Bank Account
                        account_type: bank
                        adjustment_type: plus
                        total:
                          amount: 0
                          formatted_amount: ''
                          currency_code: USD
                        section_type: ACCOUNT
                      - id: 1001
                        code: '10002'
                        label: Saving Bank Account
                        account_type: bank
                        adjustment_type: plus
                        total:
                          amount: 0
                          formatted_amount: ''
                          currency_code: USD
                        section_type: ACCOUNT
                      - id: 1034
                        code: ''
                        label: Chase - Plaid Checking
                        account_type: bank
                        adjustment_type: plus
                        total:
                          amount: 0
                          formatted_amount: ''
                          currency_code: USD
                        section_type: ACCOUNT
                    total:
                      amount: 0
                      formatted_amount: $0.00
                      currency_code: USD
                  - section_type: TOTAL
                    id: NET_CASH_INCREASE
                    label: NET CASH INCREASE FOR PERIOD
                    total:
                      amount: -500
                      formatted_amount: '-$500.00'
                      currency_code: USD
                  - section_type: TOTAL
                    id: CASH_END_PERIOD
                    label: CASH AT END OF PERIOD
                    total:
                      amount: -500
                      formatted_amount: '-$500.00'
                      currency_code: USD
                query:
                  display_columns_type: total
                  display_columns_by: year
                  from_date: '2025-01-01'
                  to_date: '2025-06-16'
                  number_format:
                    precision: 2
                    divide_on1000: false
                    show_zero: false
                    format_money: total
                    negative_format: mines
                  none_zero: false
                  none_transactions: false
                  basis: cash
                meta:
                  organization_name: BIGCAPITAL, INC
                  base_currency: USD
                  date_format: DD MMM yyyy
                  is_cost_compute_running: false
                  sheet_name: Statement of Cash Flow
                  formatted_to_date: 2025/06/16
                  formatted_from_date: 2025/01/01
                  formatted_date_range: From 2025/01/01 | To 2025/06/16
            application/json+table:
              schema:
                $ref: '#/components/schemas/CashflowStatementTableResponseDto'
components:
  schemas:
    CashflowStatementResponseDto:
      type: object
      properties:
        query:
          description: Query parameters used to generate the report
          allOf:
            - $ref: '#/components/schemas/CashflowStatementQueryResponseDto'
        data:
          description: Hierarchical cashflow data
          type: array
          items:
            $ref: '#/components/schemas/CashflowStatementDataNodeDto'
        meta:
          description: Report metadata
          allOf:
            - $ref: '#/components/schemas/CashflowStatementMetaDto'
      required:
        - query
        - data
        - meta
    CashflowStatementTableResponseDto:
      type: object
      properties:
        table:
          description: Table data structure
          allOf:
            - $ref: '#/components/schemas/FinancialTableDataDto'
        query:
          description: Query parameters used to generate the report
          allOf:
            - $ref: '#/components/schemas/CashflowStatementQueryResponseDto'
        meta:
          description: Report metadata
          allOf:
            - $ref: '#/components/schemas/CashflowStatementMetaDto'
      required:
        - table
        - query
        - meta
    CashflowStatementQueryResponseDto:
      type: object
      properties:
        displayColumnsType:
          type: string
          description: Column display type
          enum:
            - total
            - date_periods
        displayColumnsBy:
          type: string
          description: Column grouping
          enum:
            - day
            - month
            - year
            - quarter
        fromDate:
          type: string
          description: Start date
        toDate:
          type: string
          description: End date
        numberFormat:
          description: Number format settings
          allOf:
            - $ref: '#/components/schemas/NumberFormatQueryDto'
        noneZero:
          type: boolean
          description: Exclude zero balance accounts
        noneTransactions:
          type: boolean
          description: Exclude accounts with no transactions
        basis:
          type: string
          description: Accounting basis
          enum:
            - cash
            - accrual
        accountIds:
          description: Account IDs to include
          type: array
          items:
            type: number
      required:
        - displayColumnsType
        - displayColumnsBy
        - fromDate
        - toDate
        - numberFormat
        - noneZero
        - noneTransactions
        - basis
        - accountIds
    CashflowStatementDataNodeDto:
      type: object
      properties:
        id:
          type: object
          description: Node identifier (string for aggregates, number for accounts)
        name:
          type: string
          description: Account or category name
        nodeType:
          type: string
          description: Type of node
          enum:
            - AGGREGATE
            - ACCOUNT
            - NET_INCOME
            - TOTAL
        type:
          type: string
          description: Node type alias
        total:
          description: Total amount information
          allOf:
            - $ref: '#/components/schemas/FinancialReportTotalDto'
        horizontalTotals:
          description: Horizontal totals for date periods
          type: array
          items:
            $ref: '#/components/schemas/FinancialReportTotalDto'
        code:
          type: string
          description: Account code
        index:
          type: number
          description: Display index
        children:
          description: Child nodes
          type: array
          items:
            $ref: '#/components/schemas/CashflowStatementDataNodeDto'
      required:
        - id
        - name
        - nodeType
        - total
    CashflowStatementMetaDto:
      type: object
      properties:
        organizationName:
          type: string
          description: Organization name
        baseCurrency:
          type: string
          description: Base currency code
        dateFormat:
          type: string
          description: Date format string
        isCostComputeRunning:
          type: boolean
          description: Whether cost computation is running
        sheetName:
          type: string
          description: Sheet name
        formattedFromDate:
          type: string
          description: Formatted from date
        formattedToDate:
          type: string
          description: Formatted to date
        formattedDateRange:
          type: string
          description: Formatted date range
      required:
        - organizationName
        - baseCurrency
        - dateFormat
        - isCostComputeRunning
        - sheetName
        - formattedFromDate
        - formattedToDate
        - formattedDateRange
    FinancialTableDataDto:
      type: object
      properties:
        columns:
          description: Table column definitions
          type: array
          items:
            $ref: '#/components/schemas/FinancialTableColumnDto'
        rows:
          description: Table row data
          type: array
          items:
            $ref: '#/components/schemas/FinancialTableRowDto'
      required:
        - columns
        - rows
    NumberFormatQueryDto:
      type: object
      properties:
        precision:
          type: number
          description: Number of decimal places to display
          example: 2
        divideOn1000:
          type: boolean
          description: Whether to divide the number by 1000
          example: false
        showZero:
          type: boolean
          description: Whether to show zero values
          example: true
        formatMoney:
          type: string
          description: How to format money values
          example: total
          enum:
            - total
            - always
            - none
        negativeFormat:
          type: string
          description: How to format negative numbers
          example: parentheses
          enum:
            - parentheses
            - mines
    FinancialReportTotalDto:
      type: object
      properties:
        amount:
          type: number
          description: Numeric amount
        formattedAmount:
          type: string
          description: Formatted amount string
        currencyCode:
          type: string
          description: Currency code
        date:
          type: object
          description: Date associated with the total
      required:
        - amount
        - formattedAmount
        - currencyCode
    FinancialTableColumnDto:
      type: object
      properties:
        key:
          type: string
          description: Column key
        label:
          type: string
          description: Column header label
        cellIndex:
          type: number
          description: Cell position index
        children:
          description: Nested column definitions
          type: array
          items:
            $ref: '#/components/schemas/FinancialTableColumnDto'
      required:
        - key
        - label
    FinancialTableRowDto:
      type: object
      properties:
        cells:
          description: Cell data for this row
          type: array
          items:
            $ref: '#/components/schemas/FinancialTableCellDto'
        rowTypes:
          description: Row type classifications
          type: array
          items:
            type: string
        id:
          type: object
          description: Row identifier
        children:
          description: Child rows
          type: array
          items:
            $ref: '#/components/schemas/FinancialTableRowDto'
      required:
        - cells
        - rowTypes
        - id
    FinancialTableCellDto:
      type: object
      properties:
        key:
          type: string
          description: Cell key
        value:
          type: string
          description: Cell value
      required:
        - key
        - value

````