Issue credit note
Issue a credit note for a paid or partially paid invoice. Use this instead of void for invoices that have received payment.
Related endpoints
PUT /invoices/external/batch— Batch upsert invoices by external IDGET /invoices— List invoicesPOST /invoices— Create invoiceGET /invoices/{id}— Get invoicePATCH /invoices/{id}— Update invoiceDELETE /invoices/{id}— Delete invoicePOST /invoices/{id}/refund— Refund invoicePOST /invoices/{id}/reject— Reject invoice
Common errors
400 invalid_request— malformed payload or failed validation.404 resource_missing— the referenced resource does not exist or is not visible to your key.409 conflict— Idempotency-Key collision with a different body, or a concurrent state-transition conflict.
Idempotency
Pass an Idempotency-Key header (UUID v4 recommended) to make retries safe. Keys are valid for 24 hours; see the idempotency guide.
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
uuidRequest Body
application/json
Credit note details
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://api.revkeen.com/v2/invoices/00000000-0000-0000-0000-000000000000/credit-note" \ -H "x-api-key: $REVKEEN_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "amount_minor": 5000, "reason": "Service issue - partial refund for outage" }'{
"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"
},
"requestId": "string"
}