Cancels one or more credit memos.

This endpoint allows bulk cancellation of credit memos. Each credit memo is processed independently,
enabling partial success scenarios where some credit memos may be cancelled while others fail validation.

Conditions:

  • Only credit memos with status 'Approved' and payment status 'Uncredited' can be cancelled.

Effects of Cancellation:

  • Credit memo status is updated to 'Cancelled'.
  • All related Credit Memo Line Items are Cancelled.
  • Billing Header Rollup - Total Credit Memo Amount and Total Pending Amount are updated.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The request containing the list of credit memo IDs to cancel.

Represents a request to cancel one or more credit memos.

Ids
array of strings | null

Gets or sets the list of credit memo IDs to cancel.

Ids
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json