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

Authorization<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.

In: header

Path Parameters

companyId*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X POST "https://example.com/companies/string/accounts/remove_history_preview" \  -H "Content-Type: application/json" \  -d '{}'
{  "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"}