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.
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 <= lengthResponse Body
application/json
curl -X GET "https://example.com/companies/string/plan_items"[ { "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" }]Apply
Apply a reviewed batch of categorization suggestions in one call. Counterparties that do not exist yet go in `vendorsToCreate` and `customersToCreate` with a `tempId`; suggestions reference that same `tempId`, and the response maps each one to the real id it was created as. A suggestion pointing at a `tempId` that was never declared fails the whole request with 400. Creating counterparties needs `vendors:write` or `customers:write` on top of `transactions:write`. The result counts what landed and what was skipped. A transaction is skipped when it is unknown to this company, still pending, or already categorized, including by an earlier suggestion in the same request, so overlapping suggestions never silently overwrite each other.
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.