Api reference
Check credit eligibility
Check if an invoice is eligible for credit notes and get the maximum creditable amount.
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
404 resource_missing— the referenced resource does not exist or is not visible to your key.
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
Format
uuidResponse Body
application/json
curl "https://api.revkeen.com/v2/invoices/00000000-0000-0000-0000-000000000000/credit-eligibility" \ -H "x-api-key: $REVKEEN_API_KEY"{
"data": {
"can_credit": true,
"max_creditable_minor": 0,
"total_credited_minor": 0,
"invoice_total_minor": 0,
"reason": "string"
},
"requestId": "string"
}Empty