SaaSFlow
DevelopersAPIReferenceplanned_transactions

Update planned transaction

Update a planned transaction. Only the fields you send change. Edits apply to the whole rule, so changing the amount or the recurrence rewrites every…

Authentication

Checking whether you're signed in…
PUT
/companies/{companyId}/planned_transactions/{plannedTransactionId}

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
plannedTransactionId*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X PUT "https://example.com/companies/string/planned_transactions/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "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": 1,    "lastDayOfMonth": true,    "end": {      "type": "date",      "date": "2019-08-24"    }  },  "overrides": {    "property1": null,    "property2": null  },  "source": "string",  "externalId": "string",  "externalSubscriptionId": "string",  "externalInvoiceId": "string",  "invoiceDate": "string",  "serviceStartDate": "string",  "serviceEndDate": "string",  "externalData": {    "invoiceNumber": "string",    "invoiceUrl": "string",    "collectionMethod": "charge_automatically",    "attempted": true,    "attemptCount": 0,    "nextPaymentAttemptDate": "string",    "dueDate": "string"  },  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

Delete planned transaction

Delete a planned transaction and every occurrence it would have produced, past and future, which changes the cash flow forecast for all of them.

List planned transaction occurrences

List individual dated occurrences of planned transactions within a date range, expanded from recurrence rules.