---
title: "Download Transactions (Sync)"
method: GET
path: "/transactions/download"
tags: ["transaction"]
---

# Download Transactions (Sync)

`GET /transactions/download`

## Request

- Base URL: `https://api.mercoa.com`
- URL: `https://api.mercoa.com/transactions/download`
- Auth: HTTP bearer

Get a URL to download transactions as a CSV/JSON file.

## Query parameters

- `format` 'CSV' | 'JSON'
- `entityId` string
- `entityGroupId` string
- `startDate` string, date-time
- `endDate` string, date-time
- `limit` integer
- `startingAfter` string
- `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
- `invoiceId` string
- `transactionId` string
- `status` 'CREATED' | 'PENDING' | 'COMPLETED' | 'FAILED' | 'REVERSED' | 'QUEUED' | 'CANCELED' | 'RETURNED'
- `transactionType` 'bankAccountToBankAccount' | 'bankAccountToMailedCheck' | 'bankAccountToPrintedCheck' | 'bankAccountToWallet' | 'cardToBankAccount' | 'cardToWallet' | 'walletToBankAccount' | 'walletToWallet' | 'custom' | 'offPlatform'
- `creatorUserId` string

## 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)