Email billing documents generated from a bill run

Manually emails all the billing documents that are generated from a specified bill run to your customers.

Bill runs can generate invoices and credit memos based on your invoice and credit memo generation rule. Credit memos are only available if you have the Invoice Settlement feature enabled.

Using this API operation, the billing documents are sent to the email addresses specified in the To Email field of the email templates. The email template used for each billing document is 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.

Notes

  • Even though no field is required in the Request body, you still need to specify {} in the request. Otherwise, an error will be returned.

  • You can only email posted billing documents.

  • You must activate the following notifications before emailing invoices and credit memos:

    • Manual Email For Invoice | Manual Email For Invoice
    • Email Credit Memo | Manually email Credit Memo

  • To include the invoice PDF in the email, select the Include Invoice PDF check box in the Edit notification dialog from the Zuora UI. To include the credit memo PDF in the email, select the Include Credit 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 following templates are used for billing documents:

    • Invoices: Invoice Posted Default Email Template
    • Credit memos: Manual Email for Credit Memo Default Template

    See Create and Edit Email Templates for more information.

Request
path Parameters
billRunKey
required
string

The ID or number of the bill run. For example, 2c92c8f95d0c886e015d11287a8f0f8b or BR-00000001.

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

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

Request Body schema: application/json
required
resend
boolean
Default: false

Whether to send out emails for all the billing documents that are associated with the bill run.

  • If the value is false, emails are sent out only for the billing documents that never have emails sent out. Note: Do not perform this API operation with the resend field set to false multiple times in a short period. Otherwise, you may receive the same email multiple times, which contradicts the purpose of this setting.

  • If the value is true, emails are sent out for all the billing documents.

Responses
200
500

Internal Server Error

4XX

Request Errors

post/v1/bill-runs/{billRunKey}/emails
Request samples
application/json
{
  • "resend": "true"
}
Response samples
application/json
{
  • "success": true
}