PUT /v1/invoices/{invoiceKey}/write-off

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.

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
`invoiceKey`	String	Yes	The ID or number of the invoice. For example, 2c92c8955bd63cc1015bd7c151af02ab or INV-0000001.

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
`comment`	String	No	Comments about the write-off. The comment is used as the comment of the credit memo generated by writing off the specified invoice.
`IntegrationStatus__NS`	String	No	Status of the credit memo's synchronization with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
`SyncDate__NS`	String	No	Date when the credit memo was synchronized with NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
`IntegrationId__NS`	String	No	ID of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
`Transaction__NS`	String	No	Related transaction in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
`items[]`	Array	No	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.
`items[].comment`	String	No	Comments about the credit memo item.
`items[].serviceEndDate`	String	No	The service end date of the credit memo item.
`items[].invoiceItemId`	String	No	The ID of the invoice item.
`items[].skuName`	String	No	The name of the charge associated with the invoice.
`items[].serviceStartDate`	String	No	The service start date of the credit memo item.
`items[].financeInformation`	Object	No	Container for the finance information related to the credit memo item.
`items[].financeInformation.recognizedRevenueAccountingCode`	String	No	The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.
`items[].financeInformation.revenueRecognitionRuleName`	String	No	The name of the revenue recognition rule governing the revenue schedule.
`items[].financeInformation.onAccountAccountingCode`	String	No	The accounting code that maps to an on account in your accounting system.
`items[].financeInformation.deferredRevenueAccountingCode`	String	No	The accounting code for the deferred revenue, such as Monthly Recurring Liability.
`items[].unitOfMeasure`	String	No	The definable unit that you measure when determining charges.
`Origin__NS`	String	No	Origin of the corresponding object in NetSuite. Only available if you have installed the Zuora Connector for NetSuite.
`reasonCode`	String	No	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`.
`memoDate`	String	No	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.

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.