Sign in
Invoices

Write off an invoice asynchronously

Asynchronously writes off a posted invoice. By writing off an invoice, a credit memo is created and applied to the invoice. If the invoice contains more than 2,000 items, this operation is performed asynchronously. Use the Retrieve invoice write-off async job operation to track the status of the async job.

Note: This operation is only available if you have <a href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/adjust-invoice-amounts/invoice-settlement/get-started-with-invoice-settlement/invoice-settlement-overview" target="_blank">Invoice Settlement</a> enabled. This feature includes Unapplied Payments, Credit and Debit Memo, and Invoice Item Settlement. If you want to enable Invoice Settlement, see <a href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/adjust-invoice-amounts/invoice-settlement/invoice-settlement-migration-checklist-and-guide" target=“_blank”>Invoice Settlement Enablement and Checklist Guide</a> for more information.

post/v1/invoices/{invoiceKey}/write-off-async

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.

Authorizationstring

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

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

The minor API version.

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

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.

Request body

commentstring

Comments about the write-off. The comment is used as the comment of the credit memo generated by writing off the specified invoice.

amountnumber

The write off amount of the invoice.

Note: This field is available only if you have enabled the enhanced write-off permission for your tenant. Contact <a href="https://support.zuora.com/hc/en-us" target="_blank">Zuora Global Support</a> to enable this permission.

revenueImpacting'Yes' | 'No'

Indicates whether this write off operation impacts the revenue. If revenueImpacting = Yes, the deferred revenue accounting code will be automatically selected from the associated invoice

The Exclude Billing Item From Revenue field will be automatically set to Yes by default for such non-revenue impacting write off credit memos, and this setting cannot be changed. This enhancement helps ensure that only revenue-impacting items are synchronized with Zuora Revenue, reducing unnecessary data processing.

If revenueImpacting = No, users can select an accounting code such as bad-debt expense accounting code for the write off operation.

Note: This field is available only if you have enabled the enhanced write-off permission for your tenant. Contact <a href="https://support.zuora.com/hc/en-us" target="_blank">Zuora Global Support</a> to enable this permission.

nonRevenueWriteOffAccountingCodestring

Specify the accounting code for the non revenue write off. Available only if revenueImpacting = no.

Note: This field is available only if you have enabled the enhanced write-off permission for your tenant. Contact <a href="https://support.zuora.com/hc/en-us" target="_blank">Zuora Global Support</a> to enable this permission.

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 write off the invoice.

reasonCodestring

A code identifying the reason for the transaction. The value must be an existing reason code or empty. If you do not specify a value, Zuora uses the default reason code Write-off.

IntegrationId__NSstring

ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

IntegrationStatus__NSstring

Status of the credit memo's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Origin__NSstring

Origin of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

SyncDate__NSstring

Date when the credit memo was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Transaction__NSstring

Related transaction in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.

Example request

{
  "comment": "Customer bankruptcy - writing off outstanding balance",
  "memoDate": "2024-08-19",
  "reasonCode": "Write-off",
  "taxAutoCalculation": false,
  "items": [
    {
      "invoiceItemId": "8ad097b490a1ec740190a5aaece25734",
      "comment": "Item-level comment",
      "serviceStartDate": "2024-01-01",
      "serviceEndDate": "2024-01-31"
    }
  ]
}

Response

OK

processIdstring

The ID of the process that handles the operation.

requestIdstring uuid

Unique identifier of the request.

successboolean

Indicates whether the call succeeded.

idstring

The ID of the operation job.

status'Pending' | 'Processing' | 'Processed' | 'Error'

Job status of the Invoice Settlement async job.

operationType'AsyncCreditMemoApply' | 'AsyncCreditMemoUnapply'

Operation type of the Invoice Settlement async job.

referenceIdstring

The ID of the business object which is being operated.

referenceType'CreditMemo'

Reference type of the Invoice Settlement async job.

errorstring nullable

The error message if the operation fails.

Example response

{
  "creditMemo": {
    "id": "7e9fd1381a074fed8a27a3a34ad438ab"
  }
}

Changes

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