Cash Flow Statements

The CashFlowStatement Object

A Rutter Cash Flow Statement represents the amount of cash and cash equivalents entering and leaving a business entity for a specific. Accounting statements are presented on a monthly basis.

Properties

idstring

The Rutter generated unique ID of the cash flow statement.

start_datestringfilterable

The ISO 8601 timestamp for the start date of the cash flow statement.

end_datestringfilterable

The ISO 8601 timestamp for the end date of the cash flow statement.

currency_codestring

The ISO 4217 currency code of the cash flow statement.

ending_balancestringnullable

The amount of cash and cash equivalents at the end of the given period.

starting_balancestringnullable

The amount of cash and cash equivalents at the start of the given period.

total_financingstringnullable

The total amount of Financing Activities.

total_investingstringnullable

The total amount of Investing Activities.

total_operatingstringnullable

The total amount of Operating Activities.

gross_cash_in_flowstringnullableOptional
gross_cash_out_flowstringnullableOptional
financing_activitiesobject
Show financing_activities attributes
investing_activitiesobject
Show investing_activities attributes
operating_activitiesobject
Show operating_activities attributes
created_atstringnullable

The ISO 8601 timestamp that the cash flow statement was created.

updated_atstringnullable

The ISO 8601 timestamp that the cash flow statement was last updated.

platform_dataobjectOptional

The raw platform data corresponding to the Rutter object.

Endpoints
GET
/accounting/cash_flow_statements

List Cash Flow Statements

GEThttps://production.rutterapi.com/versioned/accounting/cash_flow_statements

Request Parameters

    access_tokenstringqueryRequired

    The access token of the connection.

    start_datestringfilterablequeryOptional

    Deprecated - use filter instead. The first date that you will receive a financial statement for. This means if you set a start date a year ago, you will receive 13 financial statements, one for each month.

    end_datestringfilterablequeryOptional

    Deprecated - use filter instead. The last date that you will receive a financial statement for. If you set a start date of Jan 1 2021 and an end date of Jan 1 2022, you will receive the 13 months between those dates, inclusive.

    expandenumqueryOptional

    Include platform specific data (includes additional fields not provided by the Rutter object).

    Must beplatform_data.
    response_modeenumqueryOptional

    The response mode for our async endpoints. prefer_sync allows calling the API in a best-effort, synchronous fashion and wait for the response. If this takes too long we will instead return the asynchronous response. This is the default behavior. async makes the API respond with the asynchronous response. See Asynchronous Operations.

    One ofasync or prefer_sync.
    force_fetchenumqueryOptional

    Used to force a response even if the underlying connection has not finished its initial sync.

    One oftrue or false.

Response Body

Support by integration
  • QuickBooks
    QuickBooks
  • Xero
    Xero
  • NetSuite
    NetSuite
  • Zoho Books
    Zoho Books
200
Example Response Body
JSON
1
{


2
  "cash_flows": [


3
    {


4
      "id": "5b3c1341-a20f-4e51-b72c-f3830a16c97b",


5
      "start_date": "2021-09-31T00:00:00Z",


6
      "end_date": "2022-09-31T00:00:00Z",


7
      "currency_code": "USD",


8
      "ending_balance": "4063.52",


9
      "starting_balance": "4063.52",


10
      "total_financing": "1000",


11
      "total_investing": "1000",


12
      "total_operating": "1000",


13
      "financing_activities": {


14
        "account_id": "2",


15
        "name": "Financing Activities",


16
        "value": "1000",


17
        "items": []


18
      },


19
      "investing_activities": {


20
        "account_id": "1",


21
        "name": "Investing Activities",


22
        "value": "1000",


23
        "items": []


24
      },


25
      "operating_activities": {


26
        "account_id": "4",


27
        "name": "Operating Activities",


28
        "value": "1000",


29
        "items": []


30
      },


31
      "created_at": "2022-01-01T08:00:00.000Z",


32
      "updated_at": "2022-01-09T08:00:00.000Z",


33
      "platform_data": {


34
        "id": 123,


35
        "data": "Varies by platform"


36
      }


37
    }


38
  ],


39
  "next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU=",


40
  "connection": {


41
    "id": "00000000-0000-0000-0000-000000000000",


42
    "orgId": "00000000-0000-0000-0000-000000000000",


43
    "platform": "NETSUITE"


44
  }


45
}

Have questions?

Contact support for personalized guidance.

Contact support
Next
Financial Report