Skip to content

Delete credit note

DELETE/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

  • confirmboolean

    Send true only after the merchant agreed. Without it nothing is deleted and the 409 says what would be.

Returns

  • idinteger
    Example: 980190964
  • deletedboolean
    Example: true

Errors

401

Missing or unknown X-Auth-Token, or the shop uninstalled the app.

403

v3_required: the shop still runs the previous dashboard. paid_plan_required: API access needs a paid plan.

404

The resource does not exist for this shop, or no action is registered at this path.

422

The request failed validation. Nothing was saved.

429

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.

DELETE/documents/credit_notes/{id}
curl -X DELETE "https://app.invoicefalcon.com/api/v3/external/documents/credit_notes/980191059" \
  -H "X-Auth-Token: $INVOICE_FALCON_API_KEY"
Response
{
  "id": 980190964,
  "deleted": true
}