# Update a debit memo

Notes: 
- 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. 
- You can update a debit memo only if you have the user permission. See Billing Roles for more information.

Updates the basic and finance information about a debit memo. 


Currently, Zuora supports updating tax-exclusive memo items, but does not support updating tax-inclusive memo items. If the amount of a memo item is updated, the tax will be recalculated in the following conditions:
- The memo is created from a product rate plan charge and you use Avalara to calculate the tax.
- The memo is created from an invoice and you use Avalara or Zuora Tax to calculate the tax.

The Edit credit and debit memos tutorial demonstrates how to use this operation to add and delete memo items.

Endpoint: PUT /v1/debit-memos/{debitMemoKey}
Version: 2026-02-20
Security: bearerAuth

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

  - `Zuora-Track-Id` (string)
    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. 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-Version` (string)
    The minor API version.

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

## Path parameters:

  - `debitMemoKey` (string, required)
    The unique ID or number of a debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.

## Request fields (application/json):

  - `autoPay` (boolean)
    Whether debit memos are automatically picked up for processing in the corresponding payment run. 

By default, debit memos are automatically picked up for processing in the corresponding payment run.

  - `comment` (string)
    Comments about the debit memo.
    Example: "Details about this Debit Memo"

  - `dueDate` (string)
    The date by which the payment for the debit memo is due, in yyyy-mm-dd format.

  - `effectiveDate` (string)
    The date when the debit memo takes effect.

  - `items` (array)
    Container for debit memo items.

  - `items.amount` (number)
    The amount of the debit memo item. For tax-inclusive debit memo items, the amount indicates the debit memo item amount including tax. For tax-exclusive debit memo items, the amount indicates the debit memo item amount excluding tax.

  - `items.comment` (string)
    Comments about the debit memo item.

  - `items.delete` (boolean)
    Whether to delete the existing debit memo item.


Note: To delete a debit memo item, set this field to true and specify a debit memo item ID in the id field.

  - `items.excludeItemBillingFromRevenueAccounting` (boolean)
    The flag to exclude the debit memo item from revenue accounting.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

  - `items.financeInformation` (object)
    Container for the finance information related to the debit memo item.

  - `items.financeInformation.deferredRevenueAccountingCode` (string)
    The accounting code for the deferred revenue, such as Monthly Recurring Liability.

  - `items.financeInformation.recognizedRevenueAccountingCode` (string)
    The accounting code for the recognized revenue, such as Monthly Recurring Charges or Overage Charges.

  - `items.financeInformation.revenueRecognitionRuleName` (string)
    The name of the revenue recognition rule governing the revenue schedule.

  - `items.id` (string)
    The ID of the debit memo item.
- Specify this field when updating or deleting an existing memo item. 
- Do not specify this field when creating a memo item.

  - `items.productRatePlanChargeId` (string)
    The ID of the product rate plan charge that the debit memo is created from.


Note: Do not specify the debit memo item id when specifying this field.

  - `items.quantity` (number)
    The number of units for the debit memo item.

  - `items.serviceEndDate` (string)
    The service end date of the debit memo item.

  - `items.serviceStartDate` (string)
    The service start date of the debit memo item.

  - `items.skuName` (string)
    The name of the SKU.

  - `items.taxItems` (array)
    Container for debit memo taxation items.

  - `items.taxItems.amount` (number)
    The amount of the taxation item in the debit memo item.

  - `items.taxItems.financeInformation` (object)
    Container for the finance information related to the taxation item in the debit memo item.

  - `items.taxItems.financeInformation.salesTaxPayableAccountingCode` (string)
    The accounting code for the sales taxes payable.

  - `items.taxItems.id` (string, required)
    The ID of the taxation item in the debit memo item.

  - `items.taxItems.jurisdiction` (string)
    The jurisdiction that applies the tax or VAT. This value is typically a state, province, county, or city.

  - `items.taxItems.locationCode` (string)
    The identifier for the location based on the value of the taxCode field.

  - `items.taxItems.taxCode` (string)
    The tax code identifies which tax rules and tax rates to apply to a specific debit memo.

  - `items.taxItems.taxCodeDescription` (string)
    The description of the tax code.

  - `items.taxItems.taxDate` (string)
    The date that the tax is applied to the debit memo, in yyyy-mm-dd format.

  - `items.taxItems.taxExemptAmount` (number)
    The calculated tax amount excluded due to the exemption.

  - `items.taxItems.taxName` (string)
    The name of taxation.

  - `items.taxItems.taxRate` (number)
    The tax rate applied to the debit memo.

  - `items.taxItems.taxRateDescription` (string)
    The description of the tax rate.

  - `items.taxItems.taxRateType` (string)
    The type of the tax rate applied to the debit memo.
    Enum: "Percentage", "FlatFee"

  - `items.unitOfMeasure` (string)
    The definable unit that you measure when determining charges.

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

  - `transferredToAccounting` (string)
    Whether the debit memo is transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite.
    Enum: "Processing", "Yes", "No", "Error", "Ignore"

  - `IntegrationId__NS` (string)
    ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `IntegrationStatus__NS` (string)
    Status of the debit memo's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `SyncDate__NS` (string)
    Date when the debit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

## Response 200 fields (application/json):

  - `accountId` (string)
    The ID of the customer account associated with the debit memo.

  - `accountNumber` (string)
    The number of the customer account associated with the debit memo.

  - `amount` (number)
    The total amount of the debit memo.

  - `autoPay` (boolean)
    Whether debit memos are automatically picked up for processing in the corresponding payment run.

By default, debit memos are automatically picked up for processing in the corresponding payment run.

  - `balance` (number)
    The balance of the debit memo.

  - `beAppliedAmount` (number)
    The amount that is applied to the debit memo.

  - `billToContactId` (string)
    The ID of the bill-to contact associated with the debit memo.

The value of this field is null if you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes) feature disabled.

  - `billToContactSnapshotId` (string)
    The ID of the bill-to contact snapshot associated with the debit memo.

The value of this field is null if the bill rule [Preserve snapshot of bill-to and sold-to contacts when billing documents are posted](https://knowledgecenter.zuora.com/Zuora_Billing/Billing_and_Invoicing/Billing_Settings/Define_Billing_Rules#Preserve_snapshot_of_bill-to_and_sold-to_contacts_when_billing_documents_are_posted) is disabled.

  - `cancelledById` (string,null)
    The ID of the Zuora user who cancelled the debit memo.

  - `cancelledOn` (string,null)
    The date and time when the debit memo was cancelled, in yyyy-mm-dd hh:mm:ss format.

  - `currency` (string,null)
    The currency of the debit memo.

Note: By default, the currency on a billing document matches the default currency set on the associated account. 
However, Zuora now offers a Multiple Currencies feature to support different currencies for billing documents, allowing flexibility beyond the account-level currency. 
For more information, see Multiple Currency.

  - `comment` (string,null)
    Comments about the debit memo.

  - `createdById` (string)
    The ID of the Zuora user who created the debit memo.

  - `createdDate` (string)
    The date and time when the debit memo was created, in yyyy-mm-dd hh:mm:ss format. For example, 2017-03-01 15:31:10.

  - `debitMemoDate` (string)
    The date when the debit memo takes effect, in yyyy-mm-dd format. For example, 2017-05-20.

  - `dueDate` (string)
    The date by which the payment for the debit memo is due, in yyyy-mm-dd format.

  - `einvoiceErrorCode` (string,null)
    The error code returned when the e-invoice file status is Failed. This code can either be a Zuora-generated error code or one returned by a third-party e-invoicing service provider.

Note: This field is available only if you have the E-Invoicing feature in Early Adopter phase enabled.

  - `einvoiceErrorMessage` (string,null)
    The error message returned when the e-invoice file status is Failed. This message can either be a Zuora-generated error message or one returned by a third-party e-invoicing service provider.

Note: This field is available only if you have the E-Invoicing feature in Early Adopter phase enabled.

  - `einvoiceFileId` (string,null)
    The ID of the e-invoice file generated for the debit memo.

Note: This field is available only if you have the E-Invoicing feature in Early Adopter phase enabled.

  - `einvoiceStatus` (string,null)
    The status of the e-invoice file generation for the debit memo. 

- If e-invoice file generation succeeds, this field is either Generated or Success, and both the error code and message are empty, and the eInvoiceFileId field stores the ID of the generated e-invoice file.
- If the responses from tax vendors such as Sovos or Avalara are 
  taking too long, this field becomes RetrieveTimeOut. Once the 
  vendor responds successfully, you can use the 'Resync E-Invoice Status' 
  action to update the status automatically.  You can view these updates 
  in System Health telemetry.

- If a failure occurs during e-invoice file generation, this field is Failed and an error code and an error message are returned respectively in the einvoiceErrorCode and einvoiceErrorMessage fields.
- If e-invoice file generation conditionally succeeds, this field is ConditionalSuccess and an error code and an error message are returned respectively in the einvoiceErrorCode and einvoiceErrorMessage fields.
- If the e-invoice file has been approved by the tax authority, this field is ApprovedByAuthority. The next status will be either Success or Rejected.
- If the e-invoice file has been rejected by the government, this field is Rejected. You cannot resend this e-invoice; you must create a new invoice instead.

  Note: This field is available only if you have the E-Invoicing feature in Early Adopter phase
  enabled.
    Enum: "Processing", "RetrieveTimeOut", "Generated", "Success", "Failed", "ConditionalSuccess", "ApprovedByAuthority", "Rejected"

  - `excludeItemBillingFromRevenueAccounting` (boolean)
    The flag to exclude the debit memo item from revenue accounting.

Note: This field is only available if you have the Billing - Revenue Integration feature enabled.

  - `id` (string)
    The unique ID of the debit memo.

  - `invoiceGroupNumber` (string,null)
    The number of the invoice group associated with the debit memo.

The value of this field is null if you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes) feature disabled.

  - `latestPDFFileId` (string)
    The ID of the latest PDF file generated for the debit memo.

  - `number` (string)
    The unique identification number of the debit memo.

  - `organizationLabel` (string)
    The organization that this object belongs to.

Note: This field is available only when the Multi-Org feature is enabled.

  - `paymentTerm` (string)
    The name of the payment term assoicated with the debit memo.

The value of this field is null if you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes) feature disabled.

  - `postedById` (string,null)
    The ID of the Zuora user who posted the debit memo.

  - `postedOn` (string,null)
    The date and time when the debit memo was posted, in yyyy-mm-dd hh:mm:ss format.

  - `reasonCode` (string)
    A code identifying the reason for the transaction. The value must be an existing reason code or empty.

  - `referredCreditMemoId` (string)
    The ID of the credit memo from which the debit memo was created.

  - `referredInvoiceId` (string,null)
    The ID of a referred invoice.

  - `sequenceSetId` (string,null)
    The ID of the sequence set associated with the debit memo.

The value of this field is null if you have the [Flexible Billing Attributes](https://docs.zuora.com/en/zuora-billing/bill-your-customer/leverage-advanced-capabilities/flexible-billing/flexible-billing-attributes/overview-of-flexible-billing-attributes) feature disabled.

  - `communicationProfileId` (string,null)
    The ID of the communication profile associated with the debit memo.

Note: This field is available in the request body only if you have the Flexible Billing Attributes
feature turned on. The value is null in the response body without this feature turned on.

  - `soldToContactId` (string,null)
    The ID of the sold-to contact associated with the debit memo.
The value of this field is null if you have the Flexible Billing Attributes feature disabled.

  - `soldToContactSnapshotId` (string,null)
    The ID of the sold-to contact snapshot associated with the debit memo.
The value of this field is null if you have the Flexible Billing Attributes feature disabled.

  - `sourceType` (string)
    The type of the debit memo source.
    Enum: "Subscription", "Standalone", "Order", "Consolidation", "Invoice", "CreditMemo"

  - `status` (string)
    The status of the debit memo.
    Enum: "Draft", "Posted", "Canceled", "Error", "PendingForTax", "Generating", "CancelInProgress"

  - `success` (boolean)
    Returns true if the request was processed successfully.

  - `targetDate` (string,null)
    The target date for the debit memo, in yyyy-mm-dd format. For example, 2017-07-20.

  - `taxAmount` (number)
    The amount of taxation.

  - `taxMessage` (string,null)
    The message about the status of tax calculation related to the debit memo. If tax calculation fails in one debit memo, this field displays the reason for the failure.

  - `taxStatus` (string,null)
    The status of tax calculation related to the debit memo.

Note: This field is only applicable to tax calculation by third-party tax engines. Also, the Voided status indicates that the tax transaction is successfully canceled on the tax vendor's side.  If a tax transaction was successfully committed to the third-party tax engine but the invoice failed to post, Zuora automatically detects the issue and voids the tax transaction on the vendor's side.
    Enum: "Complete", "Error", "UnknownError", "DuplicateDoc", "InvalidRequest", "InvalidResponse", "TaxEngineError", "ConcurrentModify", "InternalServerError", "TaxCodeTemplateError", "Voided"

  - `totalTaxExemptAmount` (number)
    The calculated tax amount excluded due to the exemption.

  - `transferredToAccounting` (string)
    Whether the debit memo was transferred to an external accounting system. Use this field for integration with accounting systems, such as NetSuite.
    Enum: "Processing", "Yes", "No", "Error", "Ignore"

  - `updatedById` (string)
    The ID of the Zuora user who last updated the debit memo.

  - `updatedDate` (string)
    The date and time when the debit memo was last updated, in yyyy-mm-dd hh:mm:ss format. For example, 2017-03-02 15:36:10.

  - `IntegrationId__NS` (string)
    ID of the corresponding object in NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `IntegrationStatus__NS` (string)
    Status of the debit memo's synchronization with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

  - `SyncDate__NS` (string)
    Date when the debit memo was synchronized with NetSuite. Only available if you have installed the [Zuora Connector for NetSuite](https://www.zuora.com/connect/app/?appId=265).

## Response 500 fields (application/json):

  - `reasons` (array)
    Example: [{"code":"ObjectNotFound","message":"Notification definition with id 6e569e1e05f040eda51a927b140c0ac1 does not exist"}]

  - `reasons.code` (string)
    The error code of response.

  - `reasons.message` (string)
    The detail information of the error response

## Response 4XX fields (application/json):

  - `processId` (string)
    The ID of the process that handles the operation.

  - `reasons` (array)
    The container of the error code and message. This field is available only if the success field is false.

  - `reasons.code` (string)
    The error code of response.

  - `reasons.message` (string)
    The detail information of the error response

  - `requestId` (string)
    Unique identifier of the request.

  - `success` (boolean)
    Indicates whether the call succeeded.