Edit credit and debit memos
You can edit a credit or debit memo after creation from the Zuora UI and REST API. You can edit credit or debit memos only if you have the Billing user permission. See Billing Roles for more information.
Overview
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.
Edit credit memos and debit memos through the Zuora UI
To edit credit memos and debit memos from the Zuora UI, complete the following steps:
- Navigate to Billing > Credit and Debit Memos in the navigation section.
- On the Credit and Debit Memos page, click the memo number that you want to edit in the Credit Memos or Debit Memos tab. The memo detail page opens.
- In the Basic Information section, click Edit to update the basic information of the memo. The Reason Code field is only editable if you have the billing user permission.
- Click Save.
- Click Edit in the memo item row you want to edit. Edit the memo item information. Note that you cannot edit the items of the credit memos that are generated from the bill run.
- Click Save.
For more information about the description of service periods and accounting codes, see View credit and debit memos.
Edit credit memos and debit memos through the API
To edit a credit or debit memo commonly, see Update a credit memo and Update a debit memo.
This section specifically introduces how to create and delete a credit memo item when editing a draft standalone credit memo. The operations on draft standalone debit memos are similar.
Create and add credit memo items of draft standalone credit memos
To create and add a credit memo item to a draft standalone credit memo based on an existing product rate plan charge through the “Update a credit memo” operation, perform the following steps:
- Determine the mandatory fields that you need for creating and adding a credit memo item, including:
- Path parameter:
creditMemoKey
- Request fields:
amount
productRatePlanChargeId
- Path parameter:
- Use the “Update a credit memo” operation to create and add a credit memo item to a draft standalone credit memo.
The following sample API request creates and adds a credit memo item to a draft standalone credit memo:
Request | PUT /v1/creditmemos/{creditMemoKey} |
---|---|
Request body |
{ "items": [ { "amount": 10, "productRatePlanChargeId": "8ad097b4909708e001909b41bb085d38" } ] } |
Delete credit memo items of draft standalone credit memos
To delete a credit memo item of a draft standalone credit memo through the “Update a credit memo” operation, perform the following steps:
- Determine the mandatory fields that you need for deleting a credit memo item, including:
- Path parameter:
creditMemoKey
- Request fields:
id
delete
- Path parameter:
- Use the “Update a credit memo” operation to delete a credit memo item from a draft standalone credit memo.
The following sample API request deletes a credit memo item from a draft standalone credit memo:
Request | PUT /v1/creditmemos/{creditMemoKey} |
---|---|
Request body |
{ "items": [ { "id": "8ad097b4909708e001909b41bb085d38", "delete": true } ] } |