expenditures

Start Auto Categorise

Start an AI auto-categorisation run over the selected items and return a job to poll.

Admin-only: AI categorisation is an internal review tool, so regular users (customers) are blocked at the API (get_admin_user → 403), not just in the UI. get_admin_user checks the real session user, so an admin impersonating a customer can still run it.

Classified rows get a category (and, when include_eligibility, an R&D eligibility) and are flagged auto_categorised — the AI path never sets manual_override and never assigns a project/activity. Synthetic salary ids and ids not resolving to a live item on this claim are dropped (the claim-scoped query is the authorization boundary), so total reflects only real, processable rows.

post/claims/{claim_id}/expenditures/auto-categorise

Request

  • Base URL
    https://api.claimkit.co (the document declares no server; this is the origin it was published from)
  • URL
    https://api.claimkit.co/claims/{claim_id}/expenditures/auto-categorise
  • Auth
    none declared

Path parameters

claim_idinteger required

Request body

item_idsinteger[] required
include_eligibilityboolean

Response

Successful Response

job_idinteger required
statusstring required
totalinteger required
processedinteger required
updated_countinteger required
failed_countinteger required
errorstring nullable
item_idsinteger[]

Changes

No recorded changes to this operation across all 1 revision of this API.