Destroy invoice
/documents/invoices/{id}/permanentCosts 2 rate-limit points · Rate limits
Deletes an invoice permanently so its number can be used again. For an invoice created by mistake (an order opened by accident) that was never emailed. When the invoice holds the latest sequential number, rewind_counter: true also sets the template's next invoice number back to it. Refused for an invoice that was emailed, has a credit note or has an e-invoice: raise a credit note for those instead. Paid plans only.
Permanent: the document, its PDF and its history are removed. Cannot be undone. Opening the order again creates a new invoice. Send it first without confirm: nothing changes and the 409 confirmation_required says what would, including whether the counter can be rewound. Tell the merchant, ask, and resend with confirm: true (?confirm=true on a DELETE) only after they agree. To hide an invoice without freeing its number, trash it instead (DELETE /documents/invoices/:id).
Also searched asdelete invoice permanentlypermanently delete invoiceerase invoicefree up invoice numberreuse invoice numberundo invoiceremove accidental invoicedelete invoice and reset numbering
Path parameters
idstringRequired
Query parameters
confirmbooleanSend true only after the merchant agreed. Without it nothing is deleted and the 409 says what would be.
rewind_counterstringtrue also sets the numbering template's next invoice number back to this invoice's number. Only honoured when the invoice holds the latest number; otherwise rewinding would hand that number out twice.
Returns
idintegerExample:980191001numberstringExample:A26-1deletedbooleanExample:truenext_invoice_numberstringExample:1
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/invoices/980191059/permanent" \
-H "X-Auth-Token: $INVOICE_FALCON_API_KEY"const res = await fetch("https://app.invoicefalcon.com/api/v3/external/documents/invoices/980191059/permanent", {
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/invoices/980191059/permanent",
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/invoices/980191059/permanent")
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": 980191001,
"number": "A26-1",
"deleted": true,
"next_invoice_number": "1"
}{
"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"
}