Email a debit memo

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.

Sends a posted debit memo to the specified email addresses manually.

Notes

  • You must activate the Email Debit Memo | Manually email Debit Memo notification before emailing debit memos. To include the debit memo PDF in the email, select the Include Debit Memo PDF check box in the Edit notification dialog from the Zuora UI. See Create and Edit Notifications for more information.

  • Zuora sends the email messages based on the email template you set. You can set the email template to use in the Delivery Options panel of the Edit notification dialog from the Zuora UI. By default, the Manual Email for Debit Memo Default Template template is used. See Create and Edit Email Templates for more information.

  • The debit memos are sent only to the work email addresses or personal email addresses of the Bill To contact if the following conditions are all met:

    • The useEmailTemplateSetting field is set to false.
    • The email addresses are not specified in the emailAddresses field.
Request
path Parameters
debitMemoKey
required
string

The ID or number of a posted debit memo. For example, 8a8082e65b27f6c3015ba419f3c2644e or DM00000001.

header Parameters
Idempotency-Key
string <= 255 characters

Specify a unique idempotency key if you want to perform an idempotent POST or PATCH request. Do not use this header in other request types.

With this header specified, the Zuora server can identify subsequent retries of the same request using this value, which prevents the same operation from being performed multiple times by accident.

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.

Authorization
string

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Id
string <= 64 characters

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 do not need to 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.

If the header is not set, the operation is performed in scope of the user's accessible orgs.

Request Body schema: application/json
required
emailAddresses
string

The valid email addresses you want to email a debit memo to. Use commas to separate email addresses.

Note: This field is only applicable if you set the useEmailTemplateSetting field to false.

includeAdditionalEmailAddresses
boolean
Default: false

Indicates whether to send a debit memo to the additional email addresses of the memo account.

You can set the additional email addresses in the Additional Email Addresses field on the account detail page from the Zuora UI. See Create a Customer Account for more information.

Enum: true false
pdfFileId
string

The ID of the PDF file that you want to send in the email.

If you do not specify any PDF file ID, the latest PDF file generated for the debit memo is sent in the email.

useEmailTemplateSetting
boolean
Default: false

Indicates whether to email a debit memo based on the email template setting.

If you set this field to true, the debit memo is sent to the email addresses specified in the To Email field of the email template. The email template is the one you set in the Delivery Options panel of the Edit notification dialog from the Zuora UI. See Edit Email Templates for more information about how to edit the To Email field in the email template.

Enum: true false
Responses
200
post/v1/debitmemos/{debitMemoKey}/emails
Request samples
application/json
{
  • "emailAddresses": "contact1@example.com,contact2@example.com",
  • "includeAdditionalEmailAddresses": false,
  • "pdfFileId": "162297b6f8d94edc81373f6037af76fa",
  • "useEmailTemplateSetting": false
}
Response samples
application/json
{
  • "success": true
}