SaaSFlow
DevelopersAPIReferenceplanned_transaction_occurrences

List planned transaction occurrences

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

Authentication

Checking whether you're signed in…
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
Range1 <= value <= 500
Default100
offset?|
Range0 <= value
Default0
accountIds?string

Comma-separated account ids to restrict to. Omit the parameter for no filter; pass it empty to match none of them.

categoryIds?string

Comma-separated category ids to restrict to. Omit the parameter for no filter; pass it empty to match none of them, which combined with showUncategorized=true returns only the occurrences that have none assigned.

showUncategorized?string

Value in

  • "0"
  • "1"
  • "true"
  • "false"
counterpartyIds?string

Comma-separated customer / vendor ids to restrict to. Omit the parameter for no filter; pass it empty to match none of them, which combined with showUnassignedCounterparty=true returns only the occurrences that have none assigned.

showUnassignedCounterparty?string

Value in

  • "0"
  • "1"
  • "true"
  • "false"
customerId?string
vendorId?string
direction?string

Restrict to money coming in (inflow) or going out (outflow), judged on the gross amount amount.value + passThroughTaxAmount. Omit for both.

Value in

  • "inflow"
  • "outflow"
invoicedOnly?string

When true, only occurrences backed by an issued invoice are returned (those with a non-null invoice), skipping predicted occurrences. Useful for listing overdue invoices in a past date range without dragging in stale predictions.

Value in

  • "0"
  • "1"
  • "true"
  • "false"

Response Body

application/json

curl -X GET "https://example.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": {        "frequency": "day",        "interval": 1,        "lastDayOfMonth": true,        "end": {          "type": "date",          "date": "2019-08-24"        }      },      "overrides": {        "property1": null,        "property2": null      },      "source": "string",      "invoice": {        "date": "string",        "externalId": "string",        "number": "string",        "url": "string",        "collectionStalled": "string"      }    }  ],  "totalCount": 0}

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…

Recurring transactions

Detect recurring spend across the whole transaction history and return the series grouped by vendor id. Recurrence is inferred from the transactions…