SaaSFlow
DevelopersAPIReferenceplanned_transactions

Create planned transaction

Create a planned transaction with the SaaSFlow REST API. Request parameters, response fields, and an interactive playground.

Authentication

You're not signed in. Either sign in at app.saasflow.com and reload (then pick sessionCookie), or paste a SaaSFlow sf_… API key in the bearerAuth field below.
POST
/companies/{companyId}/planned_transactions

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

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/planned_transactions" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "startDate": "string",    "amountValue": "string",    "amountCurrency": "string"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "accountId": "string",  "name": "string",  "startDate": "string",  "amountValue": "string",  "amountCurrency": "EUR",  "passThroughTaxAmount": "string",  "categoryId": "string",  "counterparty": {    "type": "customer",    "id": "string"  },  "usingDateRule": {    "type": "transactionDate"  },  "recurrence": {    "frequency": "day",    "interval": 0,    "lastDayOfMonth": true,    "end": {      "type": "date",      "date": "string"    }  },  "overrides": {    "property1": null,    "property2": null  },  "source": "string",  "externalId": "string",  "externalSubscriptionId": "string",  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

List planned transactions

List planned transactions for a company. Each row is a recurrence rule — to get individual dated occurrences (and to compute totals for a date range), use the `planned_transaction_occurrences` endpoint instead. Amount semantics: `amountValue` is the **net** amount excluding pass-through taxes (e.g. VAT). When `passThroughTaxAmount` is non-null, the **gross cash impact** on the bank account is `amountValue + passThroughTaxAmount`. For "planned cash inflow / outflow" questions, sum the gross amount; for "planned revenue / cost net of VAT", sum `amountValue` only.

Retrieve planned transaction

Retrieve a single planned transaction by ID with the SaaSFlow REST API. Request parameters, response fields, and an interactive playground.