Suggest transaction category

POSThttps://app.speybooks.com/api/v1/transactions/{id}/suggest-category

Runs the categorisation rules against a transaction and returns a suggested account if a matching rule is found. The rules are evaluated in priority order using the transaction description, reference, and Suspense line amount.

If matched, returns the suggested account details and the rule name. If no match is found, returns matched: false with the reason and evaluation evidence for debugging.

This is a read-only operation. It does not modify the transaction. Use the categorise endpoint to apply the suggestion.

Path parameters

idstringrequired
Transaction ID (e.g. txn_42). Must use the transaction prefix.

Response

200Returns a category suggestion with matched account and rule name, or indicates no match with the reason.
Show response fields
evidenceobject
Show child attributes
confidencestring
matchedOnstring
ruleTypestring
matchedboolean
suggestionobject
Show child attributes
accountCodestring
accountIdstring
accountNamestring
ruleNamestring

Error codes

404Transaction not found.