---
title: "Retrieve the PDF file generation status of debit memos"
method: GET
path: "/v1/debit-memos/pdf-status"
tags: ["Debit Memos"]
---

# Retrieve the PDF file generation status of debit memos

`GET /v1/debit-memos/pdf-status`

Retrieves the PDF generation statuses of a batch of debit memos.

## Query parameters

- `debitMemoKeys` string, required

## Headers

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

## Response `200`

OK

- GetDebitMemoPdfStatusBatchResponse
  - `debitMemoFiles` GetDebitMemoPdfStatusResponse[] — Array of debit memo PDF statuses requested.
    - `debitMemoId` string — The ID of the debit memo whose pdf status is requested.
    - `debitMemoNumber` string — The debit memo number of the debit memo whose pdf status is requested.
    - `pdfGenerationStatus` 'None' | 'Pending' | 'Processing' | 'Generated' | 'Error' | 'Obsolete' — The generation status of the debit memo PDF.
    - `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)
