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
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.
companyId*stringuuidplannedTransactionId*stringuuidapplication/json- body
name?string1 <= lengthstartDate?string1 <= lengthamountValue?stringamountCurrency?string1 <= lengthaccountId?string|nullcategoryId?string|nullcounterparty?|nullusingDateRule?||||Rules for determining the effective/accrual date range of a transaction.
recurrence?|Recurrence configuration of a planned transaction: how often it repeats and when it stops. null for a one-off.
passThroughTaxAmount?string|nulloverrides?Updated planned transaction
application/json- response
id*stringuuidcompanyId*stringuuidaccountId*string|nullname*stringThe name of the planned transaction.
startDate*stringThe start date of the planned transaction.
amountValue*stringThe numerical value of the planned amount.
amountCurrency*stringThe currency of the planned amount.
"EUR""AUD""BRL""CAD""CHF""CNY""CZK""DKK""GBP""HKD""HUF""IDR""ILS""INR""ISK""JPY""KRW""MXN""MYR""NOK""NZD""PHP""PLN""RON""SEK""SGD""THB""TRY""USD""ZAR"passThroughTaxAmount*|The pass-through tax amount (e.g., VAT).
categoryId*string|nullcounterparty*|nullusingDateRule*||||Rules for determining the effective/accrual date range of a transaction.
recurrence*|Recurrence configuration (frequency, interval, end condition).
overrides*|nullsource*|The source of the planned transaction (e.g., Stripe, HubSpot).
externalId*string|nullexternalSubscriptionId*string|nullexternalInvoiceId*|The invoice id in the source system, for issued invoices.
invoiceDate*|The date an invoice was issued for this amount. Set only when the row represents an invoice that has been issued but not yet paid; null for predicted amounts.
serviceStartDate*|Start of the service period the issued invoice bills for.
serviceEndDate*|End of the service period the issued invoice bills for.
externalData*|nullcreatedTime*|date-timecreatedUserId*string|nulllastUpdatedTime*|date-timelastUpdatedUserId*string|nullcurl -X PUT 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/planned_transactions/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -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.