Retrieve the PDF file generation status of invoices

Retrieves the PDF generation statuses of a batch of invoices.

Request
query Parameters
invoiceKeys
required
string

The IDs or numbers of the invoices separated by commas. For example - ?invoiceKeys=2c92c8955bd63cc1015bd7c151af02ab,4b65b8605bd63cc1015bd7c151af02cd,INV-0000001. A maximum of 50 keys can be entered in this field.

header Parameters
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-version
string

The minor version of the Zuora REST API. See Minor Version for information about REST API version control.

Responses
200

OK

400

Invalid input

401

Unauthorized

403

Forbidden

500

Internal Server Error

4XX

Request Errors

get/v1/invoices/pdf-status
Request samples 
Response samples 
application/json
{
  • "invoiceFiles": [
    ],
  • "success": true
}