Write off 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.

Writes off a posted invoice.

By writing off an invoice, a credit memo is created and applied to the invoice. The generated credit memo items and credit memo taxation items are applied to invoice items and invoice taxation items based on the configured default application rule. If an invoice is written off, the balance of each invoice item and invoice taxation item must be zero.

If you set the Create credit memos mirroring invoice items billing rule to Yes, you can write off an invoice even if all its items have zero balance.

Restrictions: You cannot write off an invoice if any of the following restrictions is met:

  • The balance of an invoice has been changed before Invoice Settlement is enabled. For example, before Invoice Settlement is enabled, any credit balance adjustments, invoice item adjustments, or invoice adjustments have been applied to an invoice.
  • An invoice contains more than 2,000 items in total, including invoice items, discount items, and taxation items. See Invoice Write-off for more information.
Request
path Parameters
invoiceKey
required
string

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

header Parameters
Accept-Encoding
string

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-Encoding
string

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.

Authorization
string

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

Zuora-Track-Id
string <= 64 characters

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-Ids
string

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-Ids
string

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.

Request Body schema: application/json
required
comment
string [ 0 .. 255 ] characters

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

Array of objects (items)

Container for items. This field is optional. Note: If specified, you must specify ALL the items of the invoice. The entire balance of the invoice will be written off, you cannot just write off some items of the invoice.

memoDate
string <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.

revenueImpacting
string
Default: "Yes"

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

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 Zuora Global Support to enable this permission.

Enum: "Yes" "No"
amount
number

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 Zuora Global Support to enable this permission.

nonRevenueWriteOffAccountingCode
string

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 Zuora Global Support to enable this permission.

reasonCode
string

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__NS
string <= 255 characters

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

IntegrationStatus__NS
string <= 255 characters

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

Origin__NS
string <= 255 characters

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

SyncDate__NS
string <= 255 characters

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

Transaction__NS
string <= 255 characters

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

property name*
additional property
any

Custom fields of the Credit Memo object. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Custom Fields for more information.

Responses
200
500

Internal Server Error

4XX

Request Errors

put/v1/invoices/{invoiceKey}/write-off
Request samples
application/json
{
  • "memoDate": "2019-01-02"
}
Response samples
application/json
{
  • "creditMemo": {
    },
  • "success": true
}