Create credit memos

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.

Creates multiple credit memos from invoices or product rate plan charges. You can create a maximum of 50 credit memos in one single request.

  • If you set the sourceType request field to Invoice, you can create multiple credit memos from invoices.
  • If you set the sourceType request field to Standalone, you can create multiple credit memos from product rate plan charges.

The credit memos that are created are each in separate database transactions. If the creation of one credit memo fails, other credit memos can still be created successfully.

You can create credit memos only if you have the user permission. See Billing Roles for more information.

Zero-amount memo items are supported in the following scenarios:

  • If you want to correct taxation items only for an invoice, you can set the memo item amount to zero, but the taxation item amount to non-zero.
  • If you want to correct personal data in an invoice, you can set the memo item amount to zero to create a zero-amount credit memo from an invoice.
Request
header Parameters
Idempotency-Key
string <= 255 characters

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

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 do not need to 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.

zuora-version
string

The minor API version. For a list of available minor versions, see API upgrades.

Request Body schema: application/json
required
sourceType
required
string

The type of the source where credit memos are created.

This enum field has the following values:

  • Invoice: By setting this field to Invoice, you can create multiple credit memos from invoices.
  • Standalone: By setting this field to Standalone, you can create multiple credit memos from product rate plan charges.

The specific schema of the memos object field in the request body depends on the value of the sourceType field.

  • To view the memos schema applicable to credit memo creation from invoices, select Invoice from the following drop-down list.
  • To view the memos schema applicable to credit memo creation from product rate plan charges, select Standalone from the following drop-down list.
Array of objects (memos) <= 50 items

The container for a list of credit memos. The maximum number of credit memos is 50.

Responses
200
500

Internal Server Error

4XX

Request Errors

post/v1/creditmemos/bulk
Request samples
application/json
{
  • "sourceType": "Invoice",
  • "memos": [
    ]
}
Response samples
application/json
{
  • "memos": [
    ],
  • "success": true
}