Forwardly Short-Term Cash Flow API

The Short-Term Cash Flow API from Forwardly — 4 operation(s) for short-term cash flow.

Documentation GitHub OpenAPI

Operations 4

GET /v2/business/{businessId}/accounting/shortTermCashflow/details Fetch cash flow overview of a business #

GET /v2/business/{businessId}/accounting/shortTermCashflow/summary Fetch cash flow report of a business #

GET /v2/business/{businessId}/accounting/shortTermCashflow/topInflowHeads Fetch top inflow heads report of a business #

GET /v2/business/{businessId}/accounting/shortTermCashflow/topOutflowHeads Fetch top outflow heads report of a business #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/forwardai/openapi/forwardai-short-term-cash-flow-api-openapi.yml

Schemas & Data

📊

JSONSchema

https://artifacts.apis.io/forwardai/json-schema/forwardai-cash-flow-summary-details-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/forwardai:forwardai-short-term-cash-flow-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: ForwardAI Precise Short-Term Cash Flow API
  version: 2.0.0
  description: ForwardAI Precise APIs
  contact:
    name: ForwardAI
    url: https://www.forwardai.com
servers:
- url: https://api.forwardai.com
  description: ForwardAI Precise APIs URL (US Region)
- url: https://api.4wdai.com
  description: ForwardAI Precise APIs URL (Sandbox)
tags:
- name: Short-Term Cash Flow
paths:
  /v2/business/{businessId}/accounting/shortTermCashflow/details:
    get:
      summary: Fetch cash flow overview of a business
      tags:
      - Short-Term Cash Flow
      description: ''
      security:
      - basicAuth: []
      parameters:
      - $ref: '#/components/parameters/businessId'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: success
                  data:
                    $ref: '#/components/schemas/CashflowSummary'
                  metadata:
                    $ref: '#/components/schemas/DailyDateWiseMetaData'
        '400':
          description: Bad Request Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '401':
          description: Unauthorized Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '403':
          description: Permission Access Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionError'
        '500':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getV2BusinessByBusinessIdAccountingShortTermCashflowDetails
      x-operation-id-source: derived
  /v2/business/{businessId}/accounting/shortTermCashflow/summary:
    get:
      summary: Fetch cash flow report of a business
      tags:
      - Short-Term Cash Flow
      description: ''
      security:
      - basicAuth: []
      parameters:
      - $ref: '#/components/parameters/businessId'
      - $ref: '#/components/parameters/viewType'
      - $ref: '#/components/parameters/startDateRequired'
      - $ref: '#/components/parameters/endDateRequired'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Success
                  data:
                    $ref: '#/components/schemas/CashFlowSummaryDetails'
                  metadata:
                    $ref: '#/components/schemas/DailyDateWiseIncludeForcastingMetaData'
        '400':
          description: Bad Request Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '401':
          description: Unauthorized Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '403':
          description: Permission Access Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionError'
        '500':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getV2BusinessByBusinessIdAccountingShortTermCashflowSummary
      x-operation-id-source: derived
  /v2/business/{businessId}/accounting/shortTermCashflow/topInflowHeads:
    get:
      summary: Fetch top inflow heads report of a business
      tags:
      - Short-Term Cash Flow
      description: ''
      security:
      - basicAuth: []
      parameters:
      - $ref: '#/components/parameters/businessId'
      - $ref: '#/components/parameters/startDateRequired'
      - $ref: '#/components/parameters/endDateRequired'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: inflow transactions
                  data:
                    $ref: '#/components/schemas/InflowOutFlowTrend'
                  metadata:
                    $ref: '#/components/schemas/DailyDateWiseMetaData'
        '400':
          description: Bad Request Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '401':
          description: Unauthorized Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '403':
          description: Permission Access Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionError'
        '500':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getV2BusinessByBusinessIdAccountingShortTermCashflowTopInflowHeads
      x-operation-id-source: derived
  /v2/business/{businessId}/accounting/shortTermCashflow/topOutflowHeads:
    get:
      summary: Fetch top outflow heads report of a business
      tags:
      - Short-Term Cash Flow
      description: ''
      security:
      - basicAuth: []
      parameters:
      - $ref: '#/components/parameters/businessId'
      - $ref: '#/components/parameters/startDateRequired'
      - $ref: '#/components/parameters/endDateRequired'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: outflow transactions
                  data:
                    $ref: '#/components/schemas/InflowOutFlowTrend'
                  metadata:
                    $ref: '#/components/schemas/DailyDateWiseMetaData'
        '400':
          description: Bad Request Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadRequestError'
        '401':
          description: Unauthorized Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UnauthorizedError'
        '403':
          description: Permission Access Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PermissionError'
        '500':
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      operationId: getV2BusinessByBusinessIdAccountingShortTermCashflowTopOutflowHeads
      x-operation-id-source: derived
components:
  parameters:
    viewType:
      in: query
      name: type
      schema:
        type: string
        enum:
        - DAILY
        - WEEKLY
        - MONTHLY
      required: true
    businessId:
      in: path
      name: businessId
      schema:
        type: string
      required: true
    endDateRequired:
      in: query
      name: endDate
      description: Valid date format 'YYYY-MM-DD'
      schema:
        type: string
      required: true
    startDateRequired:
      in: query
      name: startDate
      description: Valid date format 'YYYY-MM-DD'
      schema:
        type: string
      required: true
  schemas:
    Error:
      type: object
      properties:
        status:
          type: boolean
          example: false
        message:
          type: string
          example: Error
        error:
          type: object
          properties:
            type:
              type: string
              example: InternalServerError
            smTraceId:
              type: string
              example: 5fd77529a859933f504527e1
            message:
              type: string
              example: error message
            errorCode:
              type: number
              example: 1001
            serviceCode:
              type: number
              example: 1002
    PermissionError:
      type: object
      properties:
        status:
          type: boolean
          example: false
        message:
          type: string
          example: Error
        error:
          type: object
          properties:
            type:
              type: string
              example: httpException
            message:
              type: string
              example: No Permission to access the resources
            errorCode:
              type: number
              example: 1005
            serviceCode:
              type: number
              example: 1040
    InflowOutFlowTrend:
      type: array
      items:
        type: object
        properties:
          account:
            type: object
            properties:
              id:
                type: string
                example: '7'
              name:
                type: string
                example: 1000 Checking
          amount:
            type: number
            example: -36198
          contribution:
            type: string
            example: '21.05'
          variance:
            type: string
            example: '21.05'
    CashflowSummary:
      type: object
      properties:
        cashToday:
          type: number
          example: 11124.37
        cashOnHand:
          type: number
          example: 102
          format: nullable
        invoices:
          type: number
          example: 55191.18
        bills:
          type: number
          example: 66935.99
        workingCapital:
          type: number
          example: 16973.47
    DailyDateWiseMetaData:
      type: object
      properties:
        businessId:
          type: string
          example: 61383a7e462e85067ab34f9e
        startDate:
          type: string
          format: date
          example: '2019-12-01'
        endDate:
          type: string
          format: date
          example: '2020-11-30'
        instituteId:
          type: string
          example: 5fb657984670bc3baa71c6e7
        firstAvailableDate:
          type: string
          format: date
          example: '2019-12-01'
        lastAvailableDate:
          type: string
          format: date
          example: '2020-11-30'
    CashFlowSummaryDetails:
      type: array
      items:
        type: object
        properties:
          fromDate:
            type: string
            example: '2022-01-01'
          toDate:
            type: string
            example: '2022-01-01'
          openingBalance:
            type: number
            example: 60601.98
          cashIn:
            properties:
              total:
                type: number
                example: 3714.28
              invoices:
                properties:
                  total:
                    type: number
                    example: 2214.28
                  transactions:
                    type: array
                    items:
                      type: object
                      properties:
                        head:
                          properties:
                            id:
                              type: number
                              example: 1
                            name:
                              type: string
                              example: Invoices
                          type: object
                        id:
                          type: string
                          example: '10077'
                        type:
                          type: string
                          example: INVOICE_PAYMENT
                        refNumber:
                          type: string
                          example: ''
                        contact:
                          properties:
                            id:
                              type: string
                              example: '62'
                            name:
                              type: string
                              example: Donald Howell
                          type: object
                        dueDate:
                          type: string
                          example: '2022-01-01'
                        account:
                          properties:
                            id:
                              type: string
                              example: '33'
                            name:
                              type: string
                              example: AR -Receivables
                          type: object
                        memo:
                          type: string
                          example: ''
                        amount:
                          type: number
                          example: 490.27
                type: object
              income:
                properties:
                  total:
                    type: number
                    example: 1500
                  transactions:
                    type: array
                    items:
                      type: object
                      properties:
                        head:
                          properties:
                            id:
                              type: number
                              example: 2
                            name:
                              type: string
                              example: Income
                          type: object
                        id:
                          type: string
                          example: '9104'
                        type:
                          type: string
                          example: DEPOSIT
                        refNumber:
                          type: string
                          example: ''
                        contact:
                          properties:
                            id:
                              type: string
                              example: '66'
                            name:
                              type: string
                              example: Amy Crawford
                          type: object
                        dueDate:
                          type: string
                          example: '2022-01-01'
                        account:
                          properties:
                            id:
                              type: string
                              example: '92'
                            name:
                              type: string
                              example: Rental Income
                          type: object
                        memo:
                          type: string
                          example: ''
                        amount:
                          type: number
                          example: 1000
                type: object
              other:
                properties:
                  total:
                    type: number
                    example: 0
                  transactions:
                    type: array
                    items:
                      type: object
                      properties:
                        head:
                          properties:
                            id:
                              type: number
                              example: 3
                            name:
                              type: string
                              example: Other Income
                          type: object
                        id:
                          type: string
                          example: '9104'
                        type:
                          type: string
                          example: DEPOSIT
                        refNumber:
                          type: string
                          example: ''
                        contact:
                          properties:
                            id:
                              type: string
                              example: '66'
                            name:
                              type: string
                              example: Amy Crawford
                          type: object
                        dueDate:
                          type: string
                          example: '2022-01-01'
                        account:
                          properties:
                            id:
                              type: string
                              example: '92'
                            name:
                              type: string
                              example: Other Income
                          type: object
                        memo:
                          type: string
                          example: ''
                        amount:
                          type: number
                          example: 1000
                type: object
            type: object
          cashOut:
            properties:
              total:
                type: number
                example: 22655.67
              bills:
                properties:
                  total:
                    type: number
                    example: 0
                  transactions:
                    type: array
                    items:
                      type: object
                      properties:
                        head:
                          properties:
                            id:
                              type: number
                              example: 4
                            name:
                              type: string
                              example: Bills
                          type: object
                        id:
                          type: string
                          example: '9099'
                        type:
                          type: string
                          example: BILL_PAYMENT
                        refNumber:
                          type: string
                          example: ''
                        contact:
                          properties:
                            id:
                              type: string
                              example: '150'
                            name:
                              type: string
                              example: ABD Insurance Ltd.
                          type: object
                        dueDate:
                          type: string
                          example: '2022-01-01'
                        account:
                          properties:
                            id:
                              type: string
                              example: '107'
                            name:
                              type: string
                              example: Advertising Expenses
                          type: object
                        memo:
                          type: string
                          example: ''
                        amount:
                          type: number
                          example: 1500
                type: object
              expenses:
                properties:
                  total:
                    type: number
                    example: 10740
                  transactions:
                    type: array
                    items:
                      type: object
                      properties:
                        head:
                          properties:
                            id:
                              type: number
                              example: 5
                            name:
                              type: string
                              example: Expenses
                          type: object
                        id:
                          type: string
                          example: '9099'
                        type:
                          type: string
                          example: EXPENSE
                        refNumber:
                          type: string
                          example: ''
                        contact:
                          properties:
                            id:
                              type: string
                              example: '150'
                            name:
                              type: string
                              example: ABD Insurance Ltd.
                          type: object
                        dueDate:
                          type: string
                          example: '2022-01-01'
                        account:
                          properties:
                            id:
                              type: string
                              example: '107'
                            name:
                              type: string
                              example: Advertising Expenses
                          type: object
                        memo:
                          type: string
                          example: ''
                        amount:
                          type: number
                          example: 1500
                type: object
              other:
                properties:
                  total:
                    type: number
                    example: 0
                  transactions:
                    type: array
                    items:
                      type: object
                      properties:
                        head:
                          properties:
                            id:
                              type: number
                              example: 6
                            name:
                              type: string
                              example: Other Expenses
                          type: object
                        id:
                          type: string
                          example: '9099'
                        type:
                          type: string
                          example: JOURNAL_ENTRY
                        refNumber:
                          type: string
                          example: ''
                        contact:
                          properties:
                            id:
                              type: string
                              example: '150'
                            name:
                              type: string
                              example: ABD Insurance Ltd.
                          type: object
                        dueDate:
                          type: string
                          example: '2022-01-01'
                        account:
                          properties:
                            id:
                              type: string
                              example: '107'
                            name:
                              type: string
                              example: Other Expenses
                          type: object
                        memo:
                          type: string
                          example: ''
                        amount:
                          type: number
                          example: 1500
                type: object
            type: object
          closingBalance:
            type: number
            example: 53576
    BadRequestError:
      type: object
      properties:
        status:
          type: boolean
          example: false
        message:
          type: string
          example: Error
        error:
          type: object
          properties:
            type:
              type: string
              example: RequestValidationError
            message:
              type: string
              example: Invalid Request Parameters
            errorCode:
              type: number
              example: 1002
            serviceCode:
              type: number
              example: 1002
    UnauthorizedError:
      type: object
      properties:
        status:
          type: boolean
          example: false
        message:
          type: string
          example: Error
        error:
          type: object
          properties:
            type:
              type: string
              example: HttpException
            message:
              type: string
              example: Missing authorization details
            errorCode:
              type: number
              example: 1006
            serviceCode:
              type: number
              example: 1040
    DailyDateWiseIncludeForcastingMetaData:
      type: object
      properties:
        businessId:
          type: string
          example: 61383a7e462e85067ab34f9e
        startDate:
          type: string
          format: date
          example: '2019-12-01'
        endDate:
          type: string
          format: date
          example: '2020-11-30'
        instituteId:
          type: string
          example: 5fb657984670bc3baa71c6e7
        firstAvailableDate:
          type: string
          format: date
          example: '2019-12-01'
        lastAvailableDate:
          type: string
          format: date
          example: '2020-11-30'
        includeForcasting:
          type: boolean
          example: true
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
x-provenance:
  method: searched
  source: https://docs.forwardai.com/reference
  harvested: '2026-10-20'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-accounts-id.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-accounts.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-attributes-ratios.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-billpayments-id.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-billpayments.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-bills-id-attachment-download.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-bills-id.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-bills.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-creditnotes-id.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-creditnotes.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-customeranalysis-id-dueoverduetrend.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-customeranalysis-id-insights.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-customers-id.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-customers.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-debitnotes-id.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-debitnotes.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-employees-id.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-employees.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-expenses-recurringexpenses.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-income-recurringincome.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-invoicepayments-id.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-invoicepayments.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-invoicepdf-id.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-invoices-id-attachment-download.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-invoices-id.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-invoices.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-items-id.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-items.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-journals-id.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-journals.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-kpi-ebitda.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-purchaseorders-id.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-purchaseorders.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-reports-apaging.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-reports-araging.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-reports-balancesheet.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-reports-cashflowstatement.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-reports-generalledger-id.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-reports-profitandloss.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-reports-trialbalance.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-shorttermcashflow-details.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-shorttermcashflow-summary.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-shorttermcashflow-topinflowheads.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-shorttermcashflow-topoutflowheads.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-taxrates-id.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-taxrates.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-vendors-id.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-accounting-vendors.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-connections-accounting-verify.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid-connections.md
  - https://docs.forwardai.com/reference/get_v2-business-businessid.md
  - https://docs.forwardai.com/reference/get_v2-business.md
  - https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-accounts.md
  - https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-billpayments.md
  - https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-bills-id-attachment.md
  - https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-bills.md
  - https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-creditnotes.md
  - https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-customers.md
  - https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-debitnotes.md
  - https://docs.forwardai.com/reference/post_v2-business-businessid-accounting-invoicepayments.md


# --- truncated at 32 KB (33 KB total) ---
# Full source: https://artifacts.apis.io/forwardai/openapi/forwardai-short-term-cash-flow-api-openapi.yml