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.
Authentication
sf_… API key in the bearerAuth field below.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
1 <= lengthRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/companies/string/plan_items" \ -H "Content-Type: application/json" \ -d '{ "month": "string", "plType": "string", "categoryId": "string", "frequency": 0 }'{ "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"}List plan items
List every plan item for a company. A plan item is one budgeted line in the financial plan: a P&L type, a category, a starting `month` (YYYY-MM), and an amount rule. The rule is one of three shapes: `fixed` (an explicit amount, optionally growing by `relativeChange` each period), `average` (derived from the last `referencePeriod` months of actuals), or `reference` (a `share` of another planned category). `frequency` is how many months apart the item repeats and `duration` is how many times it repeats, with null meaning open-ended.
Retrieve plan item
Retrieve a single plan item by id. Returns 404 if the item does not exist or belongs to another company.