Skip to main content

Cancel a delivery adjustment

Zuora

Cancel a delivery adjustment

  1. Last updated
  2. Save as PDF

You can cancel a delivery adjustment, for example, the delivery adjustment on 2023-04-02. For more information, see the example.

For canceling multiple delivery adjustments in an adjustment period, you need to cancel them one by one.

Prerequisites

Before cancelling a delivery adjustment, ensure the following tasks are completed:

  • The Post Debit Memo billing permission has been enabled for the billing role specified in Profiles > Billing Role so as to generate and post debit memos. For more information, see Billing Role.
  • Debit memo reason codes are initialized.

To initialize debit memo reason codes, perform the following steps:

  1. Click your username at the top right in the UI and then navigate to Payments > Configure Reason Codes. 
  2. Select the Debit Memo from the drop-down list under Define Reason Codes to initialize debit memo reason codes. Among the reason codes, ensure the Write-off reason code is Active.

After completing all prerequisite tasks, you can now cancel a delivery adjustment as follows.

Cancel a delivery adjustment using the Zuora UI

You can cancel a delivery adjustment only if the credit memo is posted and the entire credit memo amount has not been applied. Otherwise, you need to unapply the entire credit memo amount and ensure the credit memo status is still posted. For more information, see Unapply credit memos from invoices and debit memos.

To cancel a delivery adjustment, perform the following steps:

  1. Navigate to Billing > Delivery Adjustments.
  2. On the Delivery Adjustments page, filter and sort subscriptions to locate the delivery adjustment you want to cancel.
  3. Click a delivery adjustment to open the delivery adjustment details page. In the Associated Credit Memo Number section of the page, click the associated credit memo number link to verify the credit memo.

  4. Return to the Delivery Adjustments page, and in the row of the delivery adjustment, click the cancel button icon-cancel-order.png to cancel the delivery adjustment.

    If the cancellation succeeds, you will see a debit memo number link generated in the Debit Memo Number column, otherwise the cancellation fails.

Cancel a delivery adjustment using the API

You can cancel a delivery adjustment only if the credit memo is posted and the entire credit memo amount has not been applied. Otherwise, you need to unapply the entire credit memo amount and ensure the credit memo status is still posted. For more information, see Unapply credit memos from invoices and debit memos.

To cancel a delivery adjustment, perform the following steps:

  1. Retrieve the credit memo number associated with the delivery adjustment through the Retrieve an adjustment operation, using the adjustment ID.

  2. Retrieve the credit memo through the Retrieve a credit memo operation, using the retrieved credit memo number, and verify the credit memo.

  3. Use the Cancel a delivery adjustment operation to cancel the delivery adjustment through the same adjustment ID.
    Request PUT /v1/adjustments/{adjustmentId}/cancel

API process result

After your operation, Zuora creates a debit memo whose amount equals the credit memo amount to write off the credit memo, and the result of the cancellation of the delivery adjustment depends on whether the debit memo generation succeeds, as follows:

  • If succeeded, the debit memo status changes to Posted. The entire amount of the credit memo is applied to the debit memo, and the credit memo balance changes to 0. Meanwhile, the delivery adjustment status changes to Cancelled.
  • If failed, the failure is returned in the response, and the delivery adjustment status remains unchanged, still as Billed.