Delete credit note
/documents/credit_notes/{id}Costs 2 rate-limit points · Rate limits
Deletes a credit note permanently, as the dashboard does. The credited invoice is untouched and a new credit note can be raised for it afterwards. (An invoice created by mistake has its own permanent delete: DELETE /documents/invoices/:id/permanent.)
Permanent: the document, its PDF and its history are removed. Cannot be undone. Send it first without confirm: nothing changes and the 409 confirmation_required says what would. Tell the merchant, ask, and resend with confirm: true (?confirm=true on a DELETE) only after they agree.
Also searched asdelete credit noteremove credit notediscard credit noteundo credit notecancel credit noteerase credit note
Path parameters
idstringRequired
Query parameters
confirmbooleanSend true only after the merchant agreed. Without it nothing is deleted and the 409 says what would be.
Returns
idintegerExample:980190964deletedbooleanExample:true
Errors
Missing or unknown X-Auth-Token, or the shop uninstalled the app.
v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.
The resource does not exist for this shop, or no action is registered at this path.
The request failed validation. Nothing was saved.
Rate limited: cost-weighted per key (reads cost less than writes). Wait Retry-After seconds; see X-RateLimit-* headers.
Every error has the same shape: see Errors.
curl -X DELETE "https://app.invoicefalcon.com/api/v3/external/documents/credit_notes/980191059" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/documents/credit_notes/980191059", {
method: "DELETE",
headers: {
"X-Auth-Token": process.env.INVOICE_FALCON_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.delete(
"https://app.invoicefalcon.com/api/v3/external/documents/credit_notes/980191059",
headers={"X-Auth-Token": os.environ["INVOICE_FALCON_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.invoicefalcon.com/api/v3/external/documents/credit_notes/980191059")
req = Net::HTTP::Delete.new(uri, "X-Auth-Token" => ENV["INVOICE_FALCON_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"id": 980190964,
"deleted": true
}{
"errors": [
"Invalid API key"
],
"code": "unauthorized"
}{
"errors": [
"API access requires a paid plan"
],
"code": "paid_plan_required"
}{
"errors": [
"Resource not found"
],
"code": "not_found"
}{
"errors": [
"id is missing"
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited"
}