SaaSFlow
DevelopersAPIReferenceplanned_transaction_occurrences

List planned transaction occurrences

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.
GET
/companies/{companyId}/planned_transaction_occurrences

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

Query Parameters

startDate*string
Length1 <= length
endDate*string
Length1 <= length
limit?integer
Default100
Range1 <= value <= 500
offset?|
Default0
Range0 <= value
accountIds?string
categoryIds?string
showUncategorized?string
Value in"0" | "1" | "true" | "false"
counterpartyIds?string
showUnassignedCounterparty?string
Value in"0" | "1" | "true" | "false"
customerId?string
vendorId?string

Response Body

application/json

curl -X GET "https://api.saasflow.com/companies/string/planned_transaction_occurrences?startDate=string&endDate=string"
{
  "items": [
    {
      "id": "string",
      "plannedTransactionId": "string",
      "date": "string",
      "computedStartDate": "string",
      "computedEndDate": "string",
      "usingPeriodDays": 0,
      "amount": {
        "value": 0,
        "currency": "string"
      },
      "passThroughTaxAmount": {
        "value": 0,
        "currency": "string"
      },
      "accountId": "string",
      "categoryId": "string",
      "counterparty": {
        "type": "customer",
        "id": "string"
      },
      "counterpartyName": "string",
      "counterpartyLogoUrl": "string",
      "name": "string",
      "startDate": "string",
      "recurrence": null,
      "overrides": {
        "property1": null,
        "property2": null
      },
      "source": "string"
    }
  ],
  "totalCount": 0
}