Skip to main content
GET
/
v1
/
platform
/
businesses
/
{business_id}
/
reports
/
cash-flow
Get cash flow statement
curl --request GET \
  --url https://sandbox.thredfi.com/v1/platform/businesses/{business_id}/reports/cash-flow/ \
  --header 'Authorization: Bearer <token>'
[
  {
    "business_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "start_date": "2023-12-25",
    "end_date": "2023-12-25",
    "currency": "<string>",
    "detail_level": "summary",
    "summary": {
      "net_cash_from_operating_cents": 123,
      "net_cash_from_investing_cents": 123,
      "net_cash_from_financing_cents": 123,
      "net_change_in_cash_cents": 123,
      "opening_cash_cents": 123,
      "closing_cash_cents": 123
    },
    "cash_reconciliation": {
      "opening_cash_cents": 123,
      "net_change_cents": 123,
      "calculated_closing_cents": 123,
      "actual_closing_cents": 123,
      "reconciles": true
    },
    "operating_activities": {
      "net_profit_cents": 123,
      "non_cash_adjustments": {
        "display_name": "<string>",
        "total_cents": 123,
        "line_items": [
          {
            "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "account_code": "<string>",
            "account_name": "<string>",
            "value_cents": 123
          }
        ]
      },
      "working_capital_changes": {
        "display_name": "<string>",
        "total_cents": 123,
        "line_items": [
          {
            "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "account_code": "<string>",
            "account_name": "<string>",
            "value_cents": 123
          }
        ]
      }
    },
    "investing_activities": {
      "display_name": "<string>",
      "total_cents": 123,
      "line_items": [
        {
          "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "account_code": "<string>",
          "account_name": "<string>",
          "value_cents": 123
        }
      ]
    },
    "financing_activities": {
      "display_name": "<string>",
      "total_cents": 123,
      "line_items": [
        {
          "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "account_code": "<string>",
          "account_name": "<string>",
          "value_cents": 123
        }
      ]
    }
  }
]

Authorizations

Authorization
string
header
required

Partner-level JWT token (unscoped). Token payload includes partner_id. Business access is validated via partner ownership. Format: Bearer <your-jwt-token>

Use this for: Multi-business operations where the business_id is specified in the URL and partner has access to multiple businesses.

Path Parameters

business_id
string<uuid>
required

Business UUID

Query Parameters

detail_level
enum<string>
default:summary

Level of detail: 'summary' or 'detailed'

Available options:
detailed,
summary
end_date
string<date>
required

Report period end date (YYYY-MM-DD)

start_date
string<date>
required

Report period start date (YYYY-MM-DD)

Response

business_id
string<uuid>
required

Business UUID

start_date
string<date>
required

Report period start date

end_date
string<date>
required

Report period end date

currency
string
required

Business base currency (ISO 4217)

detail_level
enum<string>
required

'summary' or 'detailed'

  • summary - summary
  • detailed - detailed
Available options:
summary,
detailed
summary
object
required

Cash flow summary metrics

cash_reconciliation
object
required

Cash reconciliation check (Opening + Change = Closing)

operating_activities
object

Operating activities breakdown (detailed view only)

investing_activities
object

Investing activities by account (detailed view only)

financing_activities
object

Financing activities by account (detailed view only)