Get credit note by ID

Retrieve a single credit note by its UUID.

Related endpoints

• GET /credit_notes — List credit notes
• POST /credit_notes — Create a credit note
• POST /credit_notes/{id}/void — Void a credit note
• GET /credit_notes/invoice/{invoice_id}/eligibility — Check credit note eligibility for an invoice
• GET /credit_notes/transaction/{transaction_id}/reversal-eligibility — Check reversal eligibility for a transaction
• GET /credit_notes/{id}/lines — List line items on a credit note
• POST /credit_notes/preview — Preview a credit note without creating it

Common errors

• 401 unauthenticated — missing, malformed, or revoked API key.
• 404 resource_missing — the referenced resource does not exist or is not visible to your key.

curl "https://api.revkeen.com/v2/credit_notes/00000000-0000-0000-0000-000000000000" \  -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"
  }
}