FreeAgent API
PUT /v2/credit_notes/{id}/transitions/mark_as_cancelled endpoint removal
Stopped workingSubscribe to FreeAgent APIShare
On October 2, 2024, the FreeAgent API removed the PUT /v2/credit_notes/{id}/transitions/mark_as_cancelled endpoint. Requests sent to this endpoint fail. The change directly affects any integration attempting to transition credit notes using this cancelled status.
Calls it hits
PUT /v2/credit_notes/{id}/transitions/mark_as_cancelled
What to use instead of these calls
Use the remaining transitions, mark_as_draft and mark_as_sent, or call DELETE /v2/credit_notes/{id}. Because no direct cancel transition replaces it, moving away from this endpoint requires a decision on whether to delete the credit note or keep it as a draft.
No cancel transition replaces it: whether to delete the credit note or keep it as a draft is the team's call.
In FreeAgent API's words
Remove deprecated mark_as_cancelled endpoint for Credit Notes
Facts
- API
- FreeAgent API
api.freeagent.com - Kind
- Endpoint removal
- Announced
- October 2, 2024
- Takes effect
- October 2, 2024
- Calls after that day
- Fail
- Source
- Announcement
- Last updated
- Verified
- , against FreeAgent API's own pages
Questions
When does this change take effect?
Calls to PUT /v2/credit_notes/{id}/transitions/mark_as_cancelled on FreeAgent API stopped working on October 2, 2024.
What happens to calls after October 2, 2024?
They have failed since October 2, 2024.
How do I find the calls this hits in my code?
Okapi reads your repository, finds the calls this change hits and opens a pull request with the fix. It never commits to your branches: every change comes as a pull request you review.
More from FreeAgent API 2
-
No date
/v2/bills*Parameter removal Deprecated, no date -
No date
/v2/expenses*Parameter removal Deprecated, no date
You fixed this one by hand.
Okapi opens the pull request with the fix before the next breaking change reaches your code.