added
New v3 API endpoints for credit memos
April 11th, 2025
We have introduced a set of API endpoints for credit memo operations. You can now create credit memos for adjusting the invoice amount owed by customers.
| Operation | API endpoint |
|---|---|
| Create a credit memo | POST /v3/credit-memos |
| Get list of credit memos | GET /v3/credit-memos |
| Get credit memo details | GET /v3/credit-memos/{creditMemoId} |
| Update a credit memo | PATCH /v3/credit-memos/{creditMemoId} |
| Replace a credit memo | PUT /v3/credit-memos/{creditMemoId} |
| Archive a credit memo | POST /v3/credit-memos/{creditMemoId}/archive |
| Restore a credit memo | POST /v3/credit-memos/{creditMemoId}/restore |
| Create multiple credit memos | POST /v3/credit-memos/bulk |
| Update multiple credit memos | PATCH v3/credit-memos/bulk |
| Replace multiple credit memos | PUT v3/credit-memos/bulk |
| Archive multiple credit memos | POST /v3/credit-memos/bulk/archive |
| Restore multiple credit memos | POST /v3/credit-memos/bulk/restore |
In addition, you can apply credit memo amounts to invoices. In the create and update invoice operations, you can now set the new creditAmount field in your request as the credit amount applied to an invoice.