---
title: "Retrieve the PDF file generation status of invoices"
method: GET
path: "/v1/invoices/pdf-status"
tags: ["Invoices"]
---

# Retrieve the PDF file generation status of invoices

`GET /v1/invoices/pdf-status`

Retrieves the PDF generation statuses of a batch of invoices.

## Query parameters

- `invoiceKeys` string, required

## Headers

- `Accept-Encoding` string
- `Content-Encoding` string
- `Zuora-Track-Id` string
- `Zuora-Entity-Ids` string
- `Zuora-Version` string

## Response `200`

OK

- GetInvoicePdfStatusBatchResponse
  - `invoiceFiles` GetInvoicePdfStatusResponse[] — Array of invoice PDF statuses requested.
    - `invoiceId` string — The ID of the invoice whose pdf status is requested.
    - `invoiceNumber` string — The invoice number of the invoice whose pdf status is requested.
    - `pdfGenerationStatus` 'None' | 'Pending' | 'Processing' | 'Generated' | 'Error' | 'Obsolete' | 'Archived' — The generation status of the invoice PDF. - **Obsolete**: The status changes to `Obsolete` when additional updates are applied to the document, for example, payment applied or custom fields updated. - **Archived**: The status changes to `Archived` from `Generated` when the PDF file is archived. The file cannot be used directly until it is restored. For restoring, refer to the <a href="https://developer.zuora.com/v1-api-reference/api/operation/PUT_Files/" target="_blank">Restore a file</a> operation.
    - `createdOn` string — The time at which the request to generate the PDF was created.
    - `updatedOn` string — The time at which the request to generate the PDF was updated.
    - `pdfFileURL` string — The file path or the URL of the PDF when the status is `Generated`.
    - `errorCategory` string — The error category when the status is `Error`.
    - `errorMessage` string — The error message when the status is `Error`.
  - `success` boolean — Indicates whether the call succeeded.

## Other responses

- `400` — Invalid input
- `401` — Unauthorized
- `403` — Forbidden
- `500` — Internal Server Error
- `4XX` — Request Errors

---

[API](https://skmtc.dev/zuora/apis/api-reference.md) · [All operations](https://skmtc.dev/zuora/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/zuora/api-reference/revisions/d11e237f3e54/schema)