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.
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
application/json
application/json
curl -X POST "https://example.com/companies/string/categorization_suggestions/apply" \ -H "Content-Type: application/json" \ -d '{ "suggestions": [ { "categoryId": "string", "usingDateRule": { "type": "transactionDate" }, "plSplit": {}, "transactionIds": [ "string" ] } ] }'{ "appliedSuggestions": 0, "appliedTransactions": 0, "skippedTransactions": 0, "createdVendors": [ { "tempId": "string", "id": "string", "name": "string" } ], "createdCustomers": [ { "tempId": "string", "id": "string", "name": "string" } ]}Retrieve version
Retrieve one superseded report version with its full document, for reading what an earlier run of the same report actually said. Returns 404 if the version does not exist or does not belong to this report.
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.