Reverse a credit memo

Note: This operation is only available if you have Invoice Settlement enabled. The Invoice Settlement feature is generally available as of Zuora Billing Release 296 (March 2021). This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.

Reverses a posted credit memo. See Reverse credit memos for more information.

You can reverse a credit memo only if you have the user permission. See Billing Roles for more information.

Restrictions

You cannot reverse credit memos if any of the following conditions is met:

  • A credit memo's applied amount is not 0.
  • A credit memo is not in Posted status.
  • A credit memo contains more than 2,000 items in total, including credit memo items, discount items, and taxation items.
Request
path Parameters
creditMemoKey
required
string

The ID or number of the credit memo. For example, 2c92c8955bd63cc1015bd7c151af02ab or CM00000001.

header Parameters
Accept-Encoding
string

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encoding
string

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
string <= 64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Ids
string

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you should not set this header.

Zuora-Org-Ids
string

Comma separated IDs. If you have Zuora Multi-Org enabled, you can use this header to specify which orgs to perform the operation in. If you do not have Zuora Multi-Org enabled, you should not set this header.

The IDs must be a sub-set of the user's accessible orgs. If you specify an org that the user does not have access to, the operation fails.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Request Body schema: application/json
required
applyEffectiveDate
string <date>

The date when the to-be-reversed credit memo is applied to the newly generated debit memo, in yyyy-mm-dd format. The effective date must be later than or equal to the memo date.

The default value is the date when you reverse the credit memo and create the debit memo.

comment
string [ 0 .. 255 ] characters

Comments about the reversal. The comment is used as the comment of the debit memo generated by reversing the specified credit memo.

memoDate
string <date>

The date when the debit memo is created, in yyyy-mm-dd format. The memo date must be later than or equal to the credit memo's memo date.

The default value is the date when you reverse the credit memo and create the debit memo.

reasonCode
string

A code identifying the reason for the reversal. The value must be an existing reason code or empty. The code is used as the reason code of the debit memo generated by reversing the specified credit memo.

If you do not specify a value, Zuora uses the default reason code Credit memo reversal for the debit memo.

Responses
200
500

Internal Server Error

4XX

Request Errors

put/v1/creditmemos/{creditMemoKey}/reverse
Request samples
application/json
{
  • "applyEffectiveDate": "2017-02-20",
  • "memoDate": "2017-02-20"
}
Response samples
application/json
{
  • "debitMemo": {
    },
  • "success": true
}