PUT /v1/creditmemos/{creditMemoKey}/apply

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.

Applies a posted credit memo to one or more invoices and debit memos.

You can apply a credit memo to an invoice or a debit memo only if you have the user permission. See Billing Roles for more information.

When you apply a credit memo, the total number of credit memo items and the items that credit memo items to be applied to must be less than or equal to 15,000.

If the limit is hit, you can follow the following instructions:

If you want to apply one credit memo to multiple invoices or debit memos, decrease the number of invoices or debit memos in the request.
If you want to apply one credit memo to a single invoice or debit memo with a large volume of items, you have to specify invoice items or debit memo items in the request. The maximum number of invoice items or debit memo items that you can specify in the request is 1,000.
If a credit memo has a large volume of items, you have to specify credit memo items in the request. The maximum number of credit memo items that you can specify in the request is 1,000.

If the Proration application rule is used, when applying credit memos, the following quantity must be less than or equal to 15,000:

(number of invoice items + number of debit memo items) * number of credit memo items

Otherwise, the First In First Out rule will be used instead of the Proration rule.

Servers

https://rest.test.zuora.com
https://rest.sandbox.na.zuora.com
https://rest.apisandbox.zuora.com
https://rest.na.zuora.com
https://rest.zuora.com
https://rest.test.eu.zuora.com
https://rest.sandbox.eu.zuora.com
https://rest.eu.zuora.com

Path parameters

Name	Type	Required	Description
`creditMemoKey`	String	Yes	The unique ID or number of a credit memo. For example, 8a8082e65b27f6c3015ba45ff82c7172.

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"
`Content-Encoding`	String	No	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.
`Zuora-Track-Id`	String	No	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 (`'`).
`Authorization`	String	No	The value is in the `Bearer {token}` format where {token} is a valid OAuth token generated by calling Create an OAuth token.
`Zuora-Entity-Ids`	String	No	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	No	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.
`Accept-Encoding`	String	No	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.

Request body fields

Name	Type	Required	Description
`effectiveDate`	String	No	The date when the credit memo is applied.
`debitMemos[]`	Array	No	Container for debit memos that the credit memo is applied to. The maximum number of debit memos is 1,000.
`debitMemos[].debitMemoId`	String	Yes	The unique ID of the debit memo that the credit memo is applied to.
`debitMemos[].amount`	Number	Yes	The credit memo amount to be applied to the debit memo.
`debitMemos[].items[]`	Array	No	Container for items. The maximum number of items is 1,000. If `creditMemoItemId` is the source, then it should be accompanied by a target `debitMemoItemId`. If `creditTaxItemId` is the source, then it should be accompanied by a target `taxItemId`.
`debitMemos[].items[].debitMemoItemId`	String	No	The ID of the debit memo item that the credit memo item is applied to.
`debitMemos[].items[].amount`	Number	Yes	The amount that is applied to the specific item.
`debitMemos[].items[].taxItemId`	String	No	The ID of the debit memo taxation item that the credit memo taxation item is applied to.
`debitMemos[].items[].creditTaxItemId`	String	No	The ID of the credit memo taxation item.
`debitMemos[].items[].creditMemoItemId`	String	No	The ID of the credit memo item.
`invoices[]`	Array	No	Container for invoices that the credit memo is applied to. The maximum number of invoices is 1,000.
`invoices[].amount`	Number	Yes	The credit memo amount to be applied to the invoice.
`invoices[].items[]`	Array	No	Container for items. The maximum number of items is 1,000. If `creditMemoItemId` is the source, then it should be accompanied by a target `invoiceItemId`. If `creditTaxItemId` is the source, then it should be accompanied by a target `taxItemId`.
`invoices[].items[].invoiceItemId`	String	No	The ID of the invoice item that the credit memo item is applied to.
`invoices[].items[].amount`	Number	Yes	The amount that is applied to the specific item.
`invoices[].items[].taxItemId`	String	No	The ID of the invoice taxation item that the credit memo taxation item is applied to.
`invoices[].items[].creditTaxItemId`	String	No	The ID of the credit memo taxation item.
`invoices[].items[].creditMemoItemId`	String	No	The ID of the credit memo item.
`invoices[].invoiceId`	String	Yes	The unique ID of the invoice that the credit memo is applied to.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.