SaaSFlow
DevelopersAPIReferenceplan_items

Retrieve plan item

Retrieve a single plan item by id. Returns 404 if the item does not exist or belongs to another company.

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}/plan_items/{planItemId}

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

Response Body

application/json

application/json

curl -X GET "https://example.com/companies/string/plan_items/string"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "month": "string",  "plType": "revenue",  "categoryId": "string",  "amount": {    "type": "fixed",    "amount": {      "value": 0,      "currency": "EUR"    },    "relativeChange": 0  },  "duration": -2147483648,  "frequency": -2147483648,  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

Create plan item

Add a line to the financial plan. Set `month` to the first month it applies (YYYY-MM), `plType` and `categoryId` to where it lands in the P&L, and `amount` to one of the three rule shapes (`fixed`, `average`, `reference`). Planned figures are separate from planned transactions: plan items drive the P&L plan, planned transactions drive the cash flow forecast.

Delete plan item

Delete a plan item, removing it from every month it covered. Deletion is not blocked by other plan items whose `reference` rule points at this item's category, so check those before removing a line other plan items are derived from.