PUT /v1/payments/{paymentKey}/unapply

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.

Unapplies an applied payment from invoices and debit memos.

When you unapply a payment, the total number of invoice items and debit memo items that the payment will unapply from must be less than or equal to 15,000.

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

If you want to unapply one payment without specifying invoices or debit memos, you have to specify the invoices or debit memos in the request.
If you want to unapply one payment from multiple specified invoices or debit memos, decrease the number of invoices or debit memos in the request.
If you want to unapply one payment from a single invoice or debit memo with a large volume of items, you have to specify invoice items in the request. The maximum number of invoice items that you can specify in the request is 1,000.

For more information, see Unapply Payments from Invoices and Debit Memos.

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
`paymentKey`	String	Yes	The unique ID or number of an unapplied payment. For example, `8a8082e65b27f6c3015b89e4344c16b1`, or `P-00000001`.

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 payment is unapplied, in `yyyy-mm-dd` format. The effective date must be later than or equal to the maximum effective date of the payment.
`debitMemos[]`	Array	No	Container for debit memos. The maximum number of debit memos is 1,000.
`debitMemos[].debitMemoNumber`	String	No	The number of the debit memo that the payment is unapplied from.
`debitMemos[].debitMemoId`	String	No	The unique ID of the debit memo that the payment is unapplied from.
`debitMemos[].amount`	Number	Yes	The amount of the payment that is unapplied from the debit memo.
`debitMemos[].items[]`	Array	No	Container for debit memo items. The maximum number of items is 1,000. Note: This field is only available if you have the Invoice Item Settlement feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos). If you wish to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.
`debitMemos[].items[].debitMemoItemId`	String	No	The ID of the specific debit memo item.
`debitMemos[].items[].amount`	Number	Yes	The amount of the payment that is unapplied from the specific debit mem or taxation item.
`debitMemos[].items[].taxItemId`	String	No	The ID of the specific taxation item.
`invoices[]`	Array	No	Container for invoices. The maximum number of invoice is 1,000.
`invoices[].invoiceNumber`	String	No	The number of the invoice that the payment is unapplied from. For example, `INV00000001`. Note: When both the `invoiceNumber` and `invoiceId` fields are specified, the two fields must match with each other.
`invoices[].amount`	Number	Yes	The amount of the payment that is unapplied from the invoice.
`invoices[].items[]`	Array	No	Container for invoice items. The maximum number of items is 1,000. Note: This field is only available if you have the Invoice Item Settlement feature enabled. Invoice Item Settlement must be used together with other Invoice Settlement features (Unapplied Payments, and Credit and Debit memos). If you wish to enable Invoice Settlement, see Invoice Settlement Enablement and Checklist Guide for more information.
`invoices[].items[].invoiceItemId`	String	No	The ID of the specific invoice item.
`invoices[].items[].amount`	Number	Yes	The amount of the payment that is unapplied from the specific invoice or taxation item.
`invoices[].items[].taxItemId`	String	No	The ID of the specific taxation item.
`invoices[].invoiceId`	String	No	The unique ID of the invoice that the payment is unapplied from.

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.