Api reference
Void a credit note
Void a credit note that has been issued but not yet fully applied. This is an accounting void — it reverses the credit without creating a new financial transaction.
Related endpoints
GET /credit_notes— List credit notesPOST /credit_notes— Create a credit noteGET /credit_notes/{id}— Get credit note by IDGET /credit_notes/invoice/{invoice_id}/eligibility— Check credit note eligibility for an invoiceGET /credit_notes/transaction/{transaction_id}/reversal-eligibility— Check reversal eligibility for a transactionGET /credit_notes/{id}/lines— List line items on a credit notePOST /credit_notes/preview— Preview a credit note without creating it
Common errors
400 invalid_request— malformed payload or failed validation.401 unauthenticated— missing, malformed, or revoked API key.404 resource_missing— the referenced resource does not exist or is not visible to your key.
Idempotency
Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.
x-api-key<token>
Your RevKeen API key (powered by Unkey). Get it from Dashboard > Settings > API Keys. Use rk_sandbox_* for test mode and rk_live_* for production.
In: header
Path Parameters
id*string
Credit note UUID
Format
uuidResponse Body
application/json
curl -X POST "https://api.revkeen.com/v2/credit_notes/00000000-0000-0000-0000-000000000000/void" \ -H "x-api-key: $REVKEEN_API_KEY"{
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"credit_note_number": "string",
"invoice_id": "f4c4edb8-11e0-4b33-bcc1-482dc59ebb32",
"customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",
"amount_minor": 0,
"tax_amount_minor": 0,
"currency": "string",
"status": "string",
"reason": "string",
"reason_code": "string",
"credit_method": "string",
"pdf_url": "string",
"issued_at": "string",
"created_at": "string",
"updated_at": "string"
}
}Empty
Empty
Empty
Empty