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
id
stringThe Rutter generated unique ID of the cash flow statement.
start_date
stringThe ISO 8601 timestamp for the start date of the cash flow statement.
end_date
stringThe ISO 8601 timestamp for the end date of the cash flow statement.
currency_code
stringThe ISO 4217 currency code of the cash flow statement.
ending_balance
stringnullableThe amount of cash and cash equivalents at the end of the given period.
starting_balance
stringnullableThe amount of cash and cash equivalents at the start of the given period.
total_financing
stringnullableThe total amount of Financing Activities.
total_investing
stringnullableThe total amount of Investing Activities.
total_operating
stringnullableThe total amount of Operating Activities.
gross_cash_in_flow
stringnullableoptionalgross_cash_out_flow
stringnullableoptionalfinancing_activities
objectfinancing_activities
attributesinvesting_activities
objectinvesting_activities
attributesoperating_activities
objectoperating_activities
attributescreated_at
stringnullableThe ISO 8601 timestamp that the cash flow statement was created.
updated_at
stringnullableThe ISO 8601 timestamp that the cash flow statement was last updated.
platform_data
objectoptionalThe raw platform data corresponding to the Rutter object.
platform_data
attributes{
"id": "5b3c1341-a20f-4e51-b72c-f3830a16c97b",
"start_date": "2021-09-31T00:00:00Z",
"end_date": "2022-09-31T00:00:00Z",
"currency_code": "USD",
"ending_balance": "4063.52",
"starting_balance": "4063.52",
"total_financing": "1000",
"total_investing": "1000",
"total_operating": "1000",
"financing_activities": {
"account_id": "2",
"name": "Financing Activities",
"value": "1000",
"items": []
},
"investing_activities": {
"account_id": "1",
"name": "Investing Activities",
"value": "1000",
"items": []
},
"operating_activities": {
"account_id": "4",
"name": "Operating Activities",
"value": "1000",
"items": []
},
"created_at": "2022-01-01T08:00:00.000Z",
"updated_at": "2022-01-09T08:00:00.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
List Cash Flow Statements
GET /accounting/cash_flow_statementsRequest Parameters
access_token
stringqueryThe access token of the connection.
cursor
stringoptionalqueryThe cursor to use for pagination. This value is passed in from next_cursor
field in a previous request.
end_date
stringoptionalqueryThe 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.
expand
enumoptionalqueryOptionally, include raw external platform data when fetching data.
force_fetch
enumoptionalqueryForce a response even if the underlying connection hasn't finished the initial sync.
limit
integeroptionalqueryThe limit on the number of entities returned.
start_date
stringoptionalqueryThe 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.
Response Body
connection
objectconnection
attributescash_flows
arraycash_flows
attributesnext_cursor
stringnullableoptional{
"connection": {
"id": "00000000-0000-0000-0000-000000000000",
"orgId": "00000000-0000-0000-0000-000000000000",
"platform": "NETSUITE"
},
"cash_flows": [
{
"id": "5b3c1341-a20f-4e51-b72c-f3830a16c97b",
"start_date": "2021-09-31T00:00:00Z",
"end_date": "2022-09-31T00:00:00Z",
"currency_code": "USD",
"ending_balance": "4063.52",
"starting_balance": "4063.52",
"total_financing": "1000",
"total_investing": "1000",
"total_operating": "1000",
"financing_activities": {
"account_id": "2",
"name": "Financing Activities",
"value": "1000",
"items": []
},
"investing_activities": {
"account_id": "1",
"name": "Investing Activities",
"value": "1000",
"items": []
},
"operating_activities": {
"account_id": "4",
"name": "Operating Activities",
"value": "1000",
"items": []
},
"created_at": "2022-01-01T08:00:00.000Z",
"updated_at": "2022-01-09T08:00:00.000Z",
"platform_data": {
"id": 123,
"data": "Varies by platform"
}
}
],
"next_cursor": "MTY3NDgzMTk0Ml82MDY4ZDI0ZC02NGRmLTRmN2EtYTM0Ny0zN2ZmNjY5MGVmMjU="
}