Write off an invoice asynchronously

POST

/v1/invoices/:invoiceKey/write-off-async

POST

/v1/invoices/:invoiceKey/write-off-async

from zuora import ZuoraClient, CreditMemoItemFromWriteOffInvoice
import datetime
client = ZuoraClient(
    token="YOUR_TOKEN_HERE",
)
client.invoices.write_off_invoice_async(
    invoice_key="invoiceKey",
    comment="Customer bankruptcy - writing off outstanding balance",
    items=[
        CreditMemoItemFromWriteOffInvoice(
            comment="Item-level comment",
            invoice_item_id="8ad097b490a1ec740190a5aaece25734",
            service_end_date=datetime.date.fromisoformat("2024-01-31"),
            service_start_date=datetime.date.fromisoformat("2024-01-01"),
        )
    ],
    memo_date=datetime.date.fromisoformat("2024-08-19"),
    reason_code="Write-off",
)

{
  "success": true,
  "id": "40288ae9600808280160081dc9c13f15",
  "status": "Pending",
  "operationType": "AsyncCreditMemoApply",
  "referenceId": "4028905f5a890526015a8d73f73d0015",
  "referenceType": "CreditMemo",
  "error": null,
  "creditMemo": {
    "id": "402890555a40ca7f015a5b099b0e307a"
  }
}

Asynchronously writes off a posted invoice.\n\nBy 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.\n\nNote: 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. 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 <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.\n

Authentication

AuthorizationBearer

Use Bearer {{token}} in the Authorization header for authentication.

Path parameters

invoiceKeystringRequired

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

Headers

Content-EncodingstringOptional

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-Org-IdsstringOptional

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

This endpoint expects an object.

IntegrationId__NSstringOptional<=255 characters

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

IntegrationStatus__NSstringOptional<=255 characters

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

Origin__NSstringOptional<=255 characters

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

SyncDate__NSstringOptional<=255 characters

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

Transaction__NSstringOptional<=255 characters

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

amountdoubleOptional

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.

commentstringOptional0-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.

itemslist of objectsOptional

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

memoDatedateOptional

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.

nonRevenueWriteOffAccountingCodestringOptional

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.

reasonCodestringOptional

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.

revenueImpactingenumOptionalDefaults to 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

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

Allowed values:

Response headers

Content-EncodingstringOptional

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-LimitstringOptional

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingdouble

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetdouble

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Concurrency-Limit-Limitinteger

The total number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-Remaininginteger

The remaining number of the permitted concurrent requests.

For more information, see Concurrent request limits.

Concurrency-Limit-TypestringOptional

The type of the concurrency limit, which can be Default, High-volume transactions, or Object Query.

For more information, see Concurrent request limits.

Zuora-Request-IdstringOptional

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-IdstringOptional

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Response

processIdstringOptional

The ID of the process that handles the operation.

reasonslist of objectsOptional

The container of the error code and message. This field is available only if the success field is false.

requestIdstringOptionalformat: "uuid"=36 characters

Unique identifier of the request.

successbooleanOptional

Indicates whether the call succeeded.

idstringOptional

The ID of the operation job.

statusenumOptional

Job status of the Invoice Settlement async job.

Allowed values:

operationTypeenumOptional

Operation type of the Invoice Settlement async job.

Allowed values:

referenceIdstringOptional

The ID of the business object which is being operated.

referenceTypeenumOptional

Reference type of the Invoice Settlement async job.

Allowed values:

errorstring or nullOptional

The error message if the operation fails.

creditMemoobjectOptional

Container for the credit memo that is automatically generated when writing off invoices.

Errors

4XX

Client Request Error

500

Internal Server Error