docs: resolve contradictory mutation endpoint examples

#52 · open · 1 comments

View on GitHub ↗

damacus

The official API pages currently contain conflicting mutation examples, so the audit has not implemented speculative routes: - Bank transactions: DELETE /bank_transaction/:id uses a singular resource path. - Price-list items: DELETE /price_list_item/:id likewise uses a singular path. - Payroll: mark_as_unpaid is shown as GET despite changing payment status. - Tasks: the delete example points to /users/:id; existing tasks delete uses /tasks/:id. Obtain authoritative clarification, record the evidence, then implement or correct only confirmed routes with dry-run, appropriate deletion confirmation, and request tests. Never try alternate destructive routes on a live account to discover the contract. Update docs/api-coverage.md to distinguish confirmed operations from unresolved examples. Sources: - https://dev.freeagent.com/docs/bank_transactions - https://dev.freeagent.com/docs/price_list_items - https://dev.freeagent.com/docs/payroll - https://dev.freeagent.com/docs/tasks

Comments

damacus

Rechecked all four official documentation pages on 15 September 2026. The conflicting examples remain: singular bank_transaction and price_list_item deletion paths, GET payroll mark_as_unpaid, and the task deletion example pointing at users. No authoritative correction was found. The evidence record is refreshed in the bank attachment follow-up PR. This issue remains open until FreeAgent confirms the methods and paths. No speculative destructive routes or live mutation probes have been added.