insightsCash-flow forecast

Cash-flow forecast

curl -X GET "https://api.403fin.io/v1/insights/cash-flow-forecast?days_ahead=42&account_id=123e4567-e89b-12d3-a456-426614174000" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "X-API-Key: YOUR_API_KEY"
{
  "data": {
    "points": [
      {
        "date": "2024-12-25",
        "projected_balance": "example_string",
        "income": "example_string",
        "expenses": "example_string"
      }
    ],
    "starting_balance": "example_string",
    "projected_end_balance": "example_string",
    "starting_balance_available": true,
    "currency": "example_string",
    "projections": [
      {
        "period_days": 42,
        "expected_income": "example_string",
        "expected_expenses": "example_string",
        "net_cash_flow": "example_string",
        "projected_balance": "example_string"
      }
    ],
    "recurring_items": [
      {
        "merchant": "example_string",
        "amount": "example_string",
        "frequency": "example_string",
        "stream_type": "example_string",
        "next_expected": "2024-12-25"
      }
    ]
  },
  "pagination": {
    "next_cursor": "example_string",
    "has_more": true
  },
  "redacted_fields": [
    "example_string"
  ],
  "filtered": true
}
GET
/v1/insights/cash-flow-forecast
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.

An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.
API Key (header: X-API-Key)
X-API-Keystring
Required

An opaque ff_ credential presented in the X-API-Key header.

An opaque ff_ credential presented in the X-API-Key header.
query
days_aheadinteger

How many days ahead to project.

Format: int32 • Min: 1
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. An opaque ff_ credential (ff_ak_ / ff_at_) presented as a Bearer token.

header
X-API-Keystring
Required

API Key for authentication. An opaque ff_ credential presented in the X-API-Key header.

Query Parameters

days_aheadinteger

How many days ahead to project.

Responses

dataobject
Required
paginationstring

Cursor pagination state, present on list endpoints.

redacted_fieldsstring[]

Field ids stripped from the payload by connection scope.

filteredboolean

True when row or aggregate filtering is in effect for this response.