Sign in
Operations

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 <a href="https://docs.zuora.com/en/zuora-billing/bill-your-customer/export-bulk-pdf-files/faqs" target="_blank">Export Bulk PDF Files FAQs</a>. Note: Do not include multiple objectIds with the same PDF file names in a single bulk PDF upload request.

post/v1/operations/bulk-pdf

Headers

Idempotency-Keystring

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

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

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.

Zuora-Track-Idstring

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

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

The minor API version.

For a list of available minor versions, see API upgrades.

Request body

fileNamestring required

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.

namestring

The name of the job.

indexFileFormat'JSON' | 'CSV' required

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

generateMissingPDFboolean

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.

ignoreArchivedFilesboolean

Ignores archived PDF files during export without causing the entire job request to fail when enabled.

persistIndexFileboolean

Controls the generation of the index file, allowing you to efficiently handle high volumes of requests. By default, this field is set to true.

  • When set to true, the index file is generated and included in the zip file.
  • When set to false, the index file is not generated and consequently not included in the zip file.

Example request

{
  "documents": [
    {
      "docType": "Invoice",
      "objectIds": [
        "402880de8ce7edc3018ce7f18404315a",
        "402880de8ce7edc3018ce7f18e0b3804"
      ]
    }
  ],
  "fileName": "all-invoices-posted-jan-2024",
  "name": "BulkPDFGenerationJobV1",
  "indexFileFormat": "JSON",
  "generateMissingPDF": true,
  "ignoreArchivedFiles": true
}

Response

OK

processIdstring

The ID of the process that handles the operation.

requestIdstring uuid

Unique identifier of the request.

successboolean

Indicates whether the call succeeded.

jobIdstring

Unique Id for the Job Triggered.

{"stackTrail":"components:schemas:POSTBulkPdfGenerationJobResponseType:allOf:properties:invalidIds","oasType":"schema","type":"unknown","description":"Collection of Ids that are not valid. \n\n Id is considered to be invalid if,\n \n * Billing Document Id doesn't exist in the database for the corresponding Billing Document Type\n * generateMissingPDF property is false in the Job Request and Valid PDF doesn't exist for the Billing Document Id\n"}

Example response

{
  "jobId": "402880de8ce7edc3018ce7f18404312a",
  "invalidIds": [],
  "success": true
}

Changes

No recorded changes to this endpoint across all 4 revisions of this API.