---
title: "Download Bulk Invoices (Sync)"
method: GET
path: "/entity/{entityId}/invoices/download"
tags: ["entity > invoice"]
---

# Download Bulk Invoices (Sync)

`GET /entity/{entityId}/invoices/download`

## Request

- Base URL: `https://api.mercoa.com`
- URL: `https://api.mercoa.com/entity/{entityId}/invoices/download`
- Auth: HTTP bearer

Get a URL to download invoices for an entity as a CSV/JSON file.

## Path parameters

- `entityId` string, required

## Query parameters

- `format` 'CSV' | 'JSON'
- `excludePayables` boolean
- `excludeReceivables` boolean
- `startDate` string, date-time
- `endDate` string, date-time
- `dateType` 'INVOICE_DATE' | 'DEDUCTION_DATE' | 'DUE_DATE' | 'SETTLEMENT_DATE' | 'CREATED_AT' | 'UPDATED_AT'
- `orderBy` 'AMOUNT' | 'DUE_DATE' | 'CREATED_AT' | 'UPDATED_AT' | 'DEDUCTION_DATE' | 'INVOICE_DATE' | 'SETTLEMENT_DATE' | 'INVOICE_NUMBER' | 'VENDOR_NAME' | 'PAYER_NAME'
- `orderDirection` 'ASC' | 'DESC'
- `search` string
- `metadata` InvoiceTypesMetadataFilter
  - `key` string, required
  - `value` union, required
    - string
    - string[]
- `lineItemMetadata` InvoiceTypesMetadataFilter
  - `key` string, required
  - `value` union, required
    - string
    - string[]
- `lineItemGlAccountId` string
- `payerId` string
- `vendorId` string
- `creatorUserId` string
- `approverId` string
- `approverAction` 'NONE' | 'APPROVE' | 'REJECT'
- `invoiceId` string
- `status` 'UNASSIGNED' | 'DRAFT' | 'NEW' | 'APPROVED' | 'SCHEDULED' | 'PENDING' | 'PAID' | 'ARCHIVED' | 'REFUSED' | 'CANCELED' | 'FAILED'
- `paymentType` InvoiceTypesPaymentType[]
- `returnPayerMetadata` boolean
- `returnVendorMetadata` boolean

## Response `200`

Response with status 200

- CommonsBulkDownloadResponse
  - `url` string, required
  - `mimeType` 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)