Sign in
Invoices

Retrieve the PDF file generation status of invoices

Retrieves the PDF generation statuses of a batch of invoices.

get/v1/invoices/pdf-status

Query parameters

invoiceKeysstring required

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.

Headers

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.

Response

OK

successboolean

Indicates whether the call succeeded.

Example response

{
  "invoiceFiles": [
    {
      "invoiceId": "402824aa8cc894d5018cc8a120576881",
      "invoiceNumber": "INV00000003",
      "pdfGenerationStatus": "Generated",
      "createdOn": "2024-01-01 11:35:56",
      "updatedOn": "2024-01-01 11:35:56",
      "pdfFileUrl": "/v1/files/2c98901f62d7d83d0162d7facea6262d"
    },
    {
      "invoiceId": "2c98908a904dfc2601904e6e14090241",
      "invoiceNumber": "INV00000004",
      "pdfGenerationStatus": "Error",
      "createdOn": "2024-01-02 10:14:13",
      "updatedOn": "2024-01-02 10:14:13",
      "errorCode": "INVALID_TEMPLATE",
      "errorMessage": "Unknown merge filed chargeNumber__c"
    },
    {
      "invoiceId": "402824aa8cc894d5018cc8a120576881",
      "invoiceNumber": "INV00000005",
      "pdfGenerationStatus": "Pending",
      "createdOn": "2024-01-01 11:35:56",
      "updatedOn": "2024-01-01 11:35:56"
    }
  ],
  "success": true
}

Changes