Mercoa entity > counterparty > bulk API
The entity > counterparty > bulk API from Mercoa — 2 operation(s) for entity > counterparty > bulk.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/mercoa:mercoa-entity-counterparty-bulk-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Reference entity > counterparty > bulk API
version: 1.0.0
servers:
- url: https://api.mercoa.com
description: Production
tags:
- name: entity > counterparty > bulk
paths:
/entity/{entityId}/counterparties/payees/download:
get:
operationId: entity_counterparty_bulk_downloadPayees
summary: Download Bulk Payees
description: Get a URL to download payee counterparties as a CSV/JSON file. This endpoint lets you download vendors linked to the entity.
tags:
- entity > counterparty > bulk
parameters:
- name: entityId
in: path
description: Entity ID or Entity ForeignID
required: true
schema:
$ref: '#/components/schemas/entityTypes_EntityId'
- name: format
in: query
description: Format of the file to download. Defaults to CSV.
required: false
schema:
$ref: '#/components/schemas/commons_BulkDownloadFormat'
- name: search
in: query
description: Filter counterparties by name or email. Partial matches are supported.
required: false
schema:
type: string
- name: networkType
in: query
description: Filter by network type. By default, only ENTITY counterparties are returned.
required: false
schema:
$ref: '#/components/schemas/entityTypes_CounterpartyNetworkType'
- name: paymentMethods
in: query
description: If true, will include counterparty payment methods as part of the response
required: false
schema:
type: boolean
- name: invoiceMetrics
in: query
description: If true, will include counterparty invoice metrics as part of the response
required: false
schema:
type: boolean
- name: counterpartyId
in: query
description: Filter by counterparty ids (Foreign ID is supported)
required: false
schema:
$ref: '#/components/schemas/entityTypes_EntityId'
- name: metadata
in: query
description: Filter counterparties by simple key/value metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
required: false
schema:
$ref: '#/components/schemas/invoiceTypes_MetadataFilter'
- name: returnMetadata
in: query
description: If true, will return simple key/value metadata for the counterparties. For more complex metadata, use the Metadata API.
required: false
schema:
type: string
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/commons_BulkDownloadResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- BadRequest
content:
type: string
required:
- errorName
- content
'401':
description: Error response with status 401
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Unauthorized
content:
type: string
required:
- errorName
- content
'403':
description: Error response with status 403
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Forbidden
content:
type: string
required:
- errorName
- content
'404':
description: Error response with status 404
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- NotFound
content:
type: string
required:
- errorName
- content
'409':
description: Error response with status 409
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Conflict
content:
type: string
required:
- errorName
- content
'500':
description: Error response with status 500
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- InternalServerError
content:
type: string
required:
- errorName
- content
'501':
description: Error response with status 501
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Unimplemented
content:
type: string
required:
- errorName
- content
security:
- default: []
/entity/{entityId}/counterparties/payors/download:
get:
operationId: entity_counterparty_bulk_downloadPayors
summary: Download Bulk Payors
description: Get a URL to download payor counterparties as a CSV/JSON file. This endpoint lets you download customers linked to the entity.
tags:
- entity > counterparty > bulk
parameters:
- name: entityId
in: path
description: Entity ID or Entity ForeignID
required: true
schema:
$ref: '#/components/schemas/entityTypes_EntityId'
- name: format
in: query
description: Format of the file to download. Defaults to CSV.
required: false
schema:
$ref: '#/components/schemas/commons_BulkDownloadFormat'
- name: search
in: query
description: Filter counterparties by name or email. Partial matches are supported.
required: false
schema:
type: string
- name: networkType
in: query
description: Filter by network type. By default, only ENTITY counterparties are returned.
required: false
schema:
$ref: '#/components/schemas/entityTypes_CounterpartyNetworkType'
- name: paymentMethods
in: query
description: If true, will include counterparty payment methods as part of the response
required: false
schema:
type: boolean
- name: invoiceMetrics
in: query
description: If true, will include counterparty invoice metrics as part of the response
required: false
schema:
type: boolean
- name: counterpartyId
in: query
description: Filter by counterparty ids (Foreign ID is supported)
required: false
schema:
$ref: '#/components/schemas/entityTypes_EntityId'
- name: metadata
in: query
description: Filter counterparties by simple key/value metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.
required: false
schema:
$ref: '#/components/schemas/invoiceTypes_MetadataFilter'
- name: returnMetadata
in: query
description: If true, will return simple key/value metadata for the counterparties. For more complex metadata, use the Metadata API.
required: false
schema:
type: string
responses:
'200':
description: Response with status 200
content:
application/json:
schema:
$ref: '#/components/schemas/commons_BulkDownloadResponse'
'400':
description: Error response with status 400
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- BadRequest
content:
type: string
required:
- errorName
- content
'401':
description: Error response with status 401
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Unauthorized
content:
type: string
required:
- errorName
- content
'403':
description: Error response with status 403
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Forbidden
content:
type: string
required:
- errorName
- content
'404':
description: Error response with status 404
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- NotFound
content:
type: string
required:
- errorName
- content
'409':
description: Error response with status 409
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Conflict
content:
type: string
required:
- errorName
- content
'500':
description: Error response with status 500
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- InternalServerError
content:
type: string
required:
- errorName
- content
'501':
description: Error response with status 501
content:
application/json:
schema:
type: object
properties:
errorName:
type: string
enum:
- Unimplemented
content:
type: string
required:
- errorName
- content
security:
- default: []
components:
schemas:
commons_BulkDownloadResponse:
type: object
properties:
url:
type: string
mimeType:
type: string
required:
- url
- mimeType
title: BulkDownloadResponse
commons_BulkDownloadFormat:
type: string
enum:
- CSV
- JSON
title: BulkDownloadFormat
invoiceTypes_MetadataFilter:
type: object
properties:
key:
type: string
value:
$ref: '#/components/schemas/commons_StringOrStringArray'
description: If multiple values are provided, the filter will match if any of the values match (OR filter). To filter for the absence of a key, use the value 'NULL'. To filter for the presence of a key, use the value 'NOT NULL'.
required:
- key
- value
title: MetadataFilter
entityTypes_EntityId:
type: string
title: EntityId
entityTypes_CounterpartyNetworkType:
type: string
enum:
- ENTITY
- NETWORK
title: CounterpartyNetworkType
commons_StringOrStringArray:
oneOf:
- type: string
- type: array
items:
type: string
title: StringOrStringArray
securitySchemes:
default:
type: http
scheme: bearer