SaaSFlow
DevelopersAPIReferencecategorization_suggestions

Apply

Apply a reviewed batch of categorization suggestions in one call. Counterparties that do not exist yet go in vendorsToCreate and customersToCreate with a…

Authentication

Checking whether you're signed in…
POST
/companies/{companyId}/categorization_suggestions/apply

Authorization

headerAuthorization<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.

Path Parameters

companyId*string
Length1 <= length

Request Body

application/json
  1. body
suggestions*array<>
vendorsToCreate?array<>
Default[]
customersToCreate?array<>
Default[]

Response Body

Suggestions applied

application/json
  1. response
appliedSuggestions*number
appliedTransactions*number
skippedTransactions*number
createdVendors*array<>
createdCustomers*array<>
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.

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…