SaaSFlow
DevelopersAPIReferencedata

Recurring transactions

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}/data/recurring-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
Length1 <= length

Response Body

application/json

curl -X GET "https://example.com/companies/string/data/recurring-transactions"
{
  "property1": [
    {
      "id": "string",
      "vendorId": "string",
      "amount": {
        "value": 0,
        "currency": "string"
      },
      "frequency": "daily",
      "status": "active",
      "earliestItem": {
        "id": "string",
        "transactionId": "string",
        "categorizationId": "string",
        "date": "string",
        "vendorId": "string",
        "amount": {
          "value": 0,
          "currency": "string"
        }
      },
      "latestItem": {
        "id": "string",
        "transactionId": "string",
        "categorizationId": "string",
        "date": "string",
        "vendorId": "string",
        "amount": {
          "value": 0,
          "currency": "string"
        }
      },
      "items": [
        {
          "id": "string",
          "transactionId": "string",
          "categorizationId": "string",
          "date": "string",
          "vendorId": "string",
          "amount": {
            "value": 0,
            "currency": "string"
          }
        }
      ]
    }
  ],
  "property2": [
    {
      "id": "string",
      "vendorId": "string",
      "amount": {
        "value": 0,
        "currency": "string"
      },
      "frequency": "daily",
      "status": "active",
      "earliestItem": {
        "id": "string",
        "transactionId": "string",
        "categorizationId": "string",
        "date": "string",
        "vendorId": "string",
        "amount": {
          "value": 0,
          "currency": "string"
        }
      },
      "latestItem": {
        "id": "string",
        "transactionId": "string",
        "categorizationId": "string",
        "date": "string",
        "vendorId": "string",
        "amount": {
          "value": 0,
          "currency": "string"
        }
      },
      "items": [
        {
          "id": "string",
          "transactionId": "string",
          "categorizationId": "string",
          "date": "string",
          "vendorId": "string",
          "amount": {
            "value": 0,
            "currency": "string"
          }
        }
      ]
    }
  ]
}

List planned transaction occurrences

List individual dated occurrences of planned transactions within a date range, expanded from recurrence rules. Each item represents one expected cash event on a specific date. Amount semantics: `amount.value` is the **net** amount excluding pass-through taxes (e.g. VAT). When the underlying planned transaction has VAT, the tax portion is returned **separately** as `passThroughTaxAmount` — it is **not** included in `amount.value`. To compute the total gross cash inflow / outflow for a period (e.g. for a cash flow forecast that matches what hits the bank account), sum `amount.value + (passThroughTaxAmount?.value ?? 0)` over all items. To compute net planned revenue / cost (excluding VAT, matching P&L), sum only `amount.value`. Use pagination (`limit`, `offset`) to fetch all items — `totalCount` is the unpaginated total.

Batch

Next Page