Sign in
Invoices

Reverse an invoice

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 invoice. The reversal operation is performed asynchronously when the invoice contains more than 2,000 items in total.

If the specified invoice was created through invoice splitting, reversing that invoice also reverses all split invoices that were generated from the same original invoice. The original parent invoice remains in Split status and is not reversed.

Restrictions

You are not allowed to reverse an invoice if any of the following restrictions is met:

  • Payments and credit memos are applied to the invoice.
  • The invoice is split.
  • The invoice is not in Posted status.
  • The total amount of the invoice is less than 0 (a negative invoice).
  • Using Tax Connector for Extension Platform to calculate taxes.
  • An invoice contains more than 50,000 items in total, including invoice items, discount items, and taxation items.

See Invoice Reversal for more information.

put/v1/invoices/{invoiceKey}/reverse

Path parameters

invoiceKeystring required

The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.

Headers

Accept-Encodingstring

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-Encodingstring

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-Idstring

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-Idsstring

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-Idsstring

Comma separated IDs. If you have <a href="https://docs.zuora.com/en/zuora-platform/organization-and-entity-management/multi-org/overview-of-multi-org" target="_blank">Zuora Multi-Org</a> 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. This header is important in Multi-Org (MO) setups because it defines the organization context under which the API should operate—mainly used for read access or data visibility filtering. If the header is not set, the operation is performed in scope of the user's accessible orgs.

Zuora-Versionstring

The minor API version.

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

Request body

applyEffectiveDatestring date

The date when the credit memo is applied to the invoice that will be reversed, 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 invoice and create the credit memo.

Note: If the target invoice is a split invoice, this date must be equal to or later than all invoice dates in the split invoice group.

commentstring

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

memoDatestring date

The date when the credit memo was created, in yyyy-mm-dd format. The memo date must be later than or equal to the invoice date.

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

Note: If the target invoice is a split invoice, this date must be equal to or later than all invoice dates in the split invoice group.

reasonCodestring

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 credit memo generated by reversing the specified invoice.

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

Example request

{
  "applyEffectiveDate": "2017-02-20",
  "memoDate": "2017-02-20"
}

Response

OK

idstring nullable

The ID of the invoice to be reversed.

This field is available only when the reversal operation is performed asynchronously.

jobIdstring nullable

The ID of the job that handles the invoice reversal operation.

You can specify the value of this field as the value of the jobId path parameter in the Retrieve an operation job API operation to query job information.

This field is available only when the reversal operation is performed asynchronously.

jobStatus'Pending' | 'Processing' | 'Failed' | 'Completed' nullable

The status of the invoice reversal operation.

This field is available only when the reversal operation is performed asynchronously.

successboolean

Returns true if the request was processed successfully.

Example response

{
  "creditMemos": [
    {
      "id": "402890555a40ca7f015a5b099b0e307a"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 4 revisions of this API.