---
title: "Get Check PDF"
method: GET
path: "/invoice/{invoiceId}/check/generate"
tags: ["invoice > document"]
---

# Get Check PDF

`GET /invoice/{invoiceId}/check/generate`

## Request

- Base URL: `https://api.mercoa.com`
- URL: `https://api.mercoa.com/invoice/{invoiceId}/check/generate`
- Auth: HTTP bearer

Get a PDF of the check for the invoice. If the invoice does not have check as the disbursement method, an error will be returned. If the disbursement option for the check is set to 'MAIL', a void copy of the check will be returned. If the disbursement option for the check is set to 'PRINT', a printable check will be returned. If the invoice is NOT marked as PAID, the check will be a void copy.

## Path parameters

- `invoiceId` string, required

## Response `200`

Link to the PDF file. Will expire after 1 hour.

- CommonsDocumentResponse
  - `id` string: ID of the document. If not provided, this is a dynamic document that is generated on the fly.
  - `mimeType` string, required
  - `type` 'INVOICE' | 'PAYMENT_CONFIRMATION' | 'TEN_NINETY_NINE' | 'W9' | 'CHECK' | 'BANK_STATEMENT' | 'CONTRACT' | 'OTHER', required
  - `uri` string, required

## Other responses

- `400`: Error response with status 400
- `401`: Error response with status 401
- `403`: Error response with status 403
- `404`: Error response with status 404
- `409`: Error response with status 409
- `500`: Error response with status 500
- `501`: Error response with status 501

---

[API](https://skmtc.dev/mercoa/apis/mercoa-2.md) - [All operations](https://skmtc.dev/mercoa/apis/mercoa-2/llms.txt) - [OpenAPI document](https://skmtc.dev/mercoa/apis/mercoa-2/revisions/00a8e403ae18?raw)
