Get Cash Flow Statement

curl --request POST \
  --url https://api.rootfi.dev/accounting/cash_flow_statement/all \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "take": 10,
  "skip": 0,
  "orderBy": {
    "period_end": "asc"
  },
  "filter": {
    "period": {
      "gt": 4000
    }
  }
}'

{
  "data": {
    "data": [
      {
        "platform_id": "2023-08-01_2023-08-31",
        "period_start": "2023-10-01T00:00:00.000Z",
        "period_end": "2023-10-01T00:00:00.000Z",
        "operating_activities": [
          {
            "name": "Operating Activities",
            "value": 0,
            "line_items": [
              {
                "name": "Net Income",
                "value": 0,
                "account_id": "3770712000000000391"
              },
              {
                "name": "Depreciation",
                "value": 0,
                "account_id": "3770712000000000391"
              }
            ]
          }
        ],
        "investing_activities": [
          {
            "name": "Investing Activities",
            "value": 0,
            "line_items": [
              {
                "name": "Purchase of Fixed Assets",
                "value": 0,
                "account_id": "3770712000000000391"
              },
              {
                "name": "Sale of Fixed Assets",
                "value": 0,
                "account_id": "3770712000000000391"
              }
            ]
          }
        ],
        "financing_activities": [
          {
            "name": "Financing Activities",
            "value": 0,
            "line_items": [
              {
                "name": "Sale of Equity",
                "value": 0,
                "account_id": "3770712000000000391"
              },
              {
                "name": "Sale of Debt",
                "value": 0,
                "account_id": "3770712000000000391"
              }
            ]
          }
        ],
        "cash_at_beginning_of_period": 0,
        "cash_at_end_of_period": 0,
        "updated_at": "2000-12-31T18:30:00.000Z"
      }
    ],
    "total_count": 123
  },
  "request_timestamp": "2000-12-31T18:30:00.000Z",
  "response_timestamp": "2021-06-01T00:00:00.000Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

POST

accounting

cash_flow_statement

all

curl --request POST \
  --url https://api.rootfi.dev/accounting/cash_flow_statement/all \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "take": 10,
  "skip": 0,
  "orderBy": {
    "period_end": "asc"
  },
  "filter": {
    "period": {
      "gt": 4000
    }
  }
}'

{
  "data": {
    "data": [
      {
        "platform_id": "2023-08-01_2023-08-31",
        "period_start": "2023-10-01T00:00:00.000Z",
        "period_end": "2023-10-01T00:00:00.000Z",
        "operating_activities": [
          {
            "name": "Operating Activities",
            "value": 0,
            "line_items": [
              {
                "name": "Net Income",
                "value": 0,
                "account_id": "3770712000000000391"
              },
              {
                "name": "Depreciation",
                "value": 0,
                "account_id": "3770712000000000391"
              }
            ]
          }
        ],
        "investing_activities": [
          {
            "name": "Investing Activities",
            "value": 0,
            "line_items": [
              {
                "name": "Purchase of Fixed Assets",
                "value": 0,
                "account_id": "3770712000000000391"
              },
              {
                "name": "Sale of Fixed Assets",
                "value": 0,
                "account_id": "3770712000000000391"
              }
            ]
          }
        ],
        "financing_activities": [
          {
            "name": "Financing Activities",
            "value": 0,
            "line_items": [
              {
                "name": "Sale of Equity",
                "value": 0,
                "account_id": "3770712000000000391"
              },
              {
                "name": "Sale of Debt",
                "value": 0,
                "account_id": "3770712000000000391"
              }
            ]
          }
        ],
        "cash_at_beginning_of_period": 0,
        "cash_at_end_of_period": 0,
        "updated_at": "2000-12-31T18:30:00.000Z"
      }
    ],
    "total_count": 123
  },
  "request_timestamp": "2000-12-31T18:30:00.000Z",
  "response_timestamp": "2021-06-01T00:00:00.000Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}

Cash flow statements are financial statements that show the inflow and outflow of cash and cash equivalents from a company’s operations, investments, and financing activities over a specific period of time.

curl --request POST \
  --url https://api.rootfi.dev/accounting/cash_flow_statement/all \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "take": 10,
  "skip": 0,
  "orderBy": {
    "period_end": "asc"
  },
  "filter": {
    "period": {
      "gt": 4000
    }
  }
}'

Authorizations

api_key

string

header

required

Body

application/json

take

integer | null

skip

integer | null

orderBy

accountingCashFlowOrderByFields · object

Show child attributes

orderBy.rootfi_updated_at

enum<string> | null

Available options:

asc,

desc

orderBy.rootfi_created_at

enum<string> | null

Available options:

asc,

desc

orderBy.period_start

enum<string> | null

Available options:

asc,

desc

orderBy.period_end

enum<string> | null

Available options:

asc,

desc

orderBy.updated_at

enum<string> | null

Available options:

asc,

desc

orderBy.cash_at_beginning_of_period

enum<string> | null

Available options:

asc,

desc

orderBy.cash_at_end_of_period

enum<string> | null

Available options:

asc,

desc

filter

accountingCashFlowFilterFields · object

Show child attributes

filter.rootfi_id

numberOperator · object

Show child attributes

filter.rootfi_id.gt

number<double> | null

filter.rootfi_id.lt

number<double> | null

filter.rootfi_id.eq

number<double> | null

filter.rootfi_id.in

number<double> | null

filter.rootfi_company_id

numberOperator · object

Show child attributes

filter.rootfi_company_id.gt

number<double> | null

filter.rootfi_company_id.lt

number<double> | null

filter.rootfi_company_id.eq

number<double> | null

filter.rootfi_company_id.in

number<double> | null

filter.rootfi_updated_at

dateOperator · object

Show child attributes

filter.rootfi_updated_at.eq

string<date-time> | null

filter.rootfi_updated_at.gt

string<date-time> | null

filter.rootfi_updated_at.lt

string<date-time> | null

filter.rootfi_created_at

dateOperator · object

Show child attributes

filter.rootfi_created_at.eq

string<date-time> | null

filter.rootfi_created_at.gt

string<date-time> | null

filter.rootfi_created_at.lt

string<date-time> | null

filter.platform_id

stringOperator · object

Show child attributes

filter.platform_id.eq

string | null

filter.platform_id.ne

string | null

filter.rootfi_integration_type

stringOperator · object

Show child attributes

filter.rootfi_integration_type.eq

string | null

filter.rootfi_integration_type.ne

string | null

filter.period_start

dateOperator · object

Show child attributes

filter.period_start.eq

string<date-time> | null

filter.period_start.gt

string<date-time> | null

filter.period_start.lt

string<date-time> | null

filter.period_end

dateOperator · object

Show child attributes

filter.period_end.eq

string<date-time> | null

filter.period_end.gt

string<date-time> | null

filter.period_end.lt

string<date-time> | null

filter.interval

numberOperator · object

Show child attributes

filter.interval.gt

number<double> | null

filter.interval.lt

number<double> | null

filter.interval.eq

number<double> | null

filter.interval.in

number<double> | null

filter.period

numberOperator · object

Show child attributes

filter.period.gt

number<double> | null

filter.period.lt

number<double> | null

filter.period.eq

number<double> | null

filter.period.in

number<double> | null

filter.cash_at_beginning_of_period

numberOperator · object

Show child attributes

filter.cash_at_beginning_of_period.gt

number<double> | null

filter.cash_at_beginning_of_period.lt

number<double> | null

filter.cash_at_beginning_of_period.eq

number<double> | null

filter.cash_at_beginning_of_period.in

number<double> | null

filter.cash_at_end_of_period

numberOperator · object

Show child attributes

filter.cash_at_end_of_period.gt

number<double> | null

filter.cash_at_end_of_period.lt

number<double> | null

filter.cash_at_end_of_period.eq

number<double> | null

filter.cash_at_end_of_period.in

number<double> | null

filter.updated_at

dateOperator · object

Show child attributes

filter.updated_at.eq

string<date-time> | null

filter.updated_at.gt

string<date-time> | null

filter.updated_at.lt

string<date-time> | null

Response

200 - application/json

data

accountingtypesgetCashFlowStatementResponseData · object

required

Show child attributes

data.data

accountingtypesFinalCashFlowStatement · object[]

required

List of Cash Flow Statement

Show child attributes

data.data.platform_id

string

required

The accounting platforms ID for this item

data.data.period_start

string<date-time> | null

start date of the cash flow statement report

data.data.period_end

string<date-time> | null

end date of the cash flow statement report

data.data.operating_activities

accountingtypesCashFlowObjectType · object[] | null

line_items for operating activities of income statement report

Show child attributes

data.data.operating_activities.line_items

object[]

required

List of line items for the statement.

data.data.operating_activities.name

string | null

Name of the line item

data.data.operating_activities.value

number<double> | null

Total value of the statement.

data.data.investing_activities

accountingtypesCashFlowObjectType · object[] | null

line_items for investing activities of income statement report

Show child attributes

data.data.investing_activities.line_items

object[]

required

List of line items for the statement.

data.data.investing_activities.name

string | null

Name of the line item

data.data.investing_activities.value

number<double> | null

Total value of the statement.

data.data.financing_activities

accountingtypesCashFlowObjectType · object[] | null

line_items for financing activities of income statement report

Show child attributes

data.data.financing_activities.line_items

object[]

required

List of line items for the statement.

data.data.financing_activities.name

string | null

Name of the line item

data.data.financing_activities.value

number<double> | null

Total value of the statement.

data.data.cash_at_beginning_of_period

number<double> | null

total amount at the beginning of the period

data.data.cash_at_end_of_period

number<double> | null

total amount at the end of the period

data.data.updated_at

string<date-time> | null

The last ISO 8601 timestamp that the data was updated at

data.total_count

integer

required

Total Count of response object

request_timestamp

string<date-time>

required

The time at which the request was received by the server

response_timestamp

string<date-time>

required

The time at which the response was sent by the server

request_id

string

required

The unique ID of the request

Get Cash Flow Statement Overview

⌘I

General

Server Side SDKs

Core API

Unified API

Get Cash Flow Statement

Authorizations

Body

Response