Sign in
Invoices

Unpost an invoice

Unposts a posted invoice and changes its status to Draft.

  • For invoices with a large number of invoice items, Zuora might process this operation asynchronously. In this case, the response returns jobId and jobStatus.

    • If jobStatus is Pending, use the Retrieve an operation job operation to retrieve the job status until processing is complete.
    • If jobStatus is Completed, the operation completed synchronously and the response includes the unposted invoice details.

  • When an invoice and a credit memo contain items generated from the same rate plan charge, posting or unposting either document automatically posts or unposts the other.

Restrictions:

You cannot unpost an invoice if any of the following restrictions is met:

  • The invoice is not in Posted status.
  • Payments or adjustments are applied to the invoice.
  • Non-cancelled memos have been created from the invoice.
  • Credit memos are applied to the invoice.
  • The invoice does not satisfy other applicable unpost validations, such as e-invoicing validation.
put/v1/invoices/{invoiceKey}/unpost

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.

Response

OK

jobIdstring

Operation job ID for tracking.

Note: Use with the Retrieve an operation job operation to poll the asynchronous job's status.

jobStatus'Pending' | 'Completed'

Job status of the operation.

Note:

  • Completed indicates the operation finished synchronously.
  • Pending indicates the operation is still running asynchronously.
successboolean

Indicates whether the operation was successful.

Changes