Generate billing documents by account ID

Generates draft or posted billing documents for a specified account. You can also generate billing documents for specified subscriptions of a specified account. The billing documents contain invoices and credit memos. To generate credit memos, you must have the Invoice Settlement feature enabled.

Note: You cannot generate billing documents for cancelled or suspended subscriptions.

Request
path Parameters
key
required
string

The ID or number of the customer account that billing documents are generated for. For example, 8a8082e65b27f6c3015ba3e326b26419 or AC0000001.

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
autoPost
boolean
Default: false

Whether to automatically post the billing documents after the draft billing documents are generated.

If an error occurs during posting billing documents, the draft billing documents are not generated too.

Enum: true false
autoRenew
boolean
Default: false

Whether to automatically renew the subscriptions with Auto Renew set to Yes.

Enum: true false
chargeTypeToExclude
Array of strings

The types of the charges to be excluded from the generation of billing documents. The field values are case insensitive. Supported values include onetime, recurring, and usage.

creditMemoReasonCode
string

A code identifying the reason for the credit memo transaction that is generated by the request. The value must be an existing reason code. If you do not pass the field or pass the field with empty value, Zuora uses the default reason code.

effectiveDate
string <date>

The date on which to generate the billing documents, in yyyy-mm-dd format.

subscriptionIds
Array of strings

The IDs of the subscriptions that you want to create the billing documents for. Each value must be the ID of the latest version of an active subscription.

targetDate
string <date>

The date used to determine which charges are to be billed, in yyyy-mm-dd format.

Responses
200
post/v1/accounts/{key}/billing-documents/generate
Request samples
application/json
{
  • "autoPost": false,
  • "creditMemoReasonCode": "Unsatisfactory service",
  • "effectiveDate": "2017-05-23",
  • "subscriptionIds": [
    ],
  • "targetDate": "2017-08-23"
}
Response samples
application/json
{
  • "creditMemos": [
    ],
  • "invoices": [
    ],
  • "success": true
}