tools

Propose category change

Use this when the user asks to correct the category of selected transactions. Prepare a durable category correction for selected transaction IDs. This saves a pending proposal and changes no financial records. The user must open the authenticated review link and explicitly choose selected payments or matching and future payments. Never report a proposal as applied.

post/v1/tools/betteroff_propose_category_change

Request

  • Base URL: https://api.betteroff.finance
  • URL: https://api.betteroff.finance/v1/tools/betteroff_propose_category_change
  • Auth: one of:
    • OpenID Connect (https://app.betteroff.finance/api/auth/.well-known/openid-configuration, scopes: transactions:read, corrections:prepare)
    • HTTP bearer

Request body

transactionIdsstring[] required
category'FOOD_AND_DRINK' | 'RENT_AND_UTILITIES' | 'ENTERTAINMENT' | 'GENERAL_MERCHANDISE' | 'GENERAL_SERVICES' | 'PEER_PAYMENTS' | 'TRANSPORTATION' | 'TRAVEL' | 'PERSONAL_CARE' | 'MEDICAL' | 'EDUCATION' | 'INSURANCE' | 'GIFTS_AND_DONATIONS' | 'PETS' | 'SUBSCRIPTIONS' | 'REAL_ESTATE' | 'INCOME' | 'LOAN_PAYMENTS' | 'TRANSFER_IN' | 'TRANSFER_OUT' | 'BANK_FEES' | 'GOVERNMENT_AND_NON_PROFIT' | 'HOME_IMPROVEMENT' | 'OTHER' required

Response

Tool result

OR

Changes

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