Export bulk PDF files

The background job that compresses large number of PDF(s) into ZIP files. For answers to frequently asked questions regarding exporting bulk PDF files, see Export Bulk PDF Files FAQs.

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


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.


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.


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

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 (').


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.

Request Body schema: application/json
Array of objects (DocumentList)

An array that contains a collection of objects where each object contains billing document type and their IDs.

string <= 32 characters

The prefix part of output file name(s). The response will include multiple file URLs. The number of zip files generated corresponds to the number of invoice IDs. Each zip file contains up to 1000 document IDs. Eg: if fileName is "all-invoices-posted-jan-2024" then fileURL(s) will start with the file name followed by an underscore and a number. For instance, all-invoices-posted-jan-2024_1.zip, all-invoices-posted-jan-2024_2.zip, and so on.

string <= 32 characters

The name of the job.


The format of the index file. It contains the metadata about the files and their contents.

Enum: "JSON" "CSV"

This flag controls the behavior of whether to generate PDF(s) for billing documents that do not already have one.

  • setting it to true indicates service would go through the provided document ID list, find the billing documents that do not have a generated PDF, generate them all at once, and then proceed to the zipping process.

  • setting it to false indicates service would go through the provided document ID list, find the billing documents that do not have a generated PDF, mark them as Invalid, and skip them from the zipping process. IDs marked as invalid will be included in the response.

The default value is false.


Invalid input


Internal Server Error


Request Errors

Request samples
  • "documents": [
  • "fileName": "all-invoices-posted-jan-2024",
  • "name": "BulkPDFGenerationJobV1",
  • "indexFileFormat": "JSON",
  • "generateMissingPDF": true
Response samples
  • "jobId": "402880de8ce7edc3018ce7f18404312a",
  • "invalidIds": [ ],
  • "success": true