SaaSFlow
DevelopersAPIReferenceaccounts

Remove history preview

Preview what cutting off history before a date would do, without changing anything. Returns per-account transaction counts and date ranges, plus…

Authentication

Checking whether you're signed in…
POST
/companies/{companyId}/accounts/remove_history_preview

Authorization

headerAuthorization<token>

A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.

Path Parameters

companyId*string
Length1 <= length

Request Body

application/json
  1. body
beforeDate?string
Match^\d{4}-\d{2}-\d{2}$

Response Body

Per-account history stats for the remove-history flow. Only accounts that have transactions appear; transit accounts are excluded. suggestedDate is the first date on which every listed account has data, ignoring loan accounts (their data only spans payout to final repayment, so a late loan is not a coverage gap).

application/json
  1. response
accounts*array<>
suggestedDate*string|null
dataStartDate*string|null
Example Request
curl -X POST 'https://api.saasflow.com/companies/string/accounts/remove_history_preview' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response200
{  "accounts": [    {      "accountId": "string",      "accountType": "string",      "earliestDate": "string",      "transactionCount": 0,      "openTransactionCount": 0,      "removeCount": 0,      "openRemoveCount": 0,      "remainingCount": 0,      "remainingOpenCount": 0,      "newStartingBalance": "string",      "hasInitialBalance": true    }  ],  "suggestedDate": "string",  "dataStartDate": "string"}