[Breaking Change Notice] Credit note `mark_as_cancelled` API to be removed

Announcements
1

Hello,

FreeAgent is planning to remove the following Credit Notes API:

PUT https://api.freeagent.com/v2/credit_notes/:id/transitions/mark_as_cancelled

Cancelling a credit note is an unsupported operation in the FreeAgent software, so this API shouldn’t be used. If you have an API client that uses it, you will need to remove these calls from your application.

Please note that:

  • Invoice cancellation/write-offs are still fully supported (/v2/invoices/:id/transitions/mark_as_cancelled).
  • Other credit note APIs are unaffected and remain fully supported.

The change will take place in August 2024 and we’ll update here when it’s being removed.

If you have any concerns or questions about this change, please post on the FreeAgent API Discussion Forum and we’ll do our best to help.

1 Like
2

Hello,

We can confirm that the deprecated mark_as_cancelled endpoint for the Credit Note API has now been removed (changelog).

If you have any trouble with this change, please post to this API Discussion forum for help.