Herald
OpenapiBilling invoice

Create_credit_note

POST
/api/bill/{realmId}/invoices/{invoiceId}/credit-notes

Authorization

bearer_auth
AuthorizationBearer <token>

In: header

Path Parameters

realmId*string

Realm ID

invoiceId*string

Invoice ID

Formatuuid

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount*integer

Refund amount in the smallest currency unit (must be a positive integer).

Formatint64
memo*string

Admin-provided refund reason (free text, 1-500 chars).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/bill/string/invoices/497f6eca-6276-4993-bfeb-53cbbbba6f08/credit-notes" \  -H "Content-Type: application/json" \  -d '{    "amount": 0,    "memo": "string"  }'
{  "amount": 0,  "createdAt": "string",  "createdByUserId": "4d2aef9a-17b0-44e6-902e-616812033620",  "currency": "string",  "externalCreditNoteId": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "memo": "string",  "source": "string",  "status": "string"}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}