Mercoa entity > counterparty API
The entity > counterparty API from Mercoa — 4 operation(s) for entity > counterparty.
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-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 API
version: 1.0.0
servers:
- url: https://api.mercoa.com
description: Production
tags:
- name: entity > counterparty
paths:
/entity/{entityId}/addPayees:
post:
operationId: entity_counterparty_addPayees
summary: Link Payees
description: Create association between Entity and a given list of Payees. If a Payee has previously been archived, unarchive the Payee.
tags:
- entity > counterparty
parameters:
- name: entityId
in: path
description: Entity ID or Entity ForeignID
required: true
schema:
$ref: '#/components/schemas/entityTypes_EntityId'
responses:
'200':
description: Successful response
'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
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/entityTypes_EntityAddPayeesRequest'
security:
- default: []
/entity/{entityId}/hidePayees:
post:
operationId: entity_counterparty_hidePayees
summary: Hide Payee
description: Marks Payees as unsearchable by Entity via Counterparty search. Invoices associated with these Payees will still be searchable via Invoice search.
tags:
- entity > counterparty
parameters:
- name: entityId
in: path
description: Entity ID or Entity ForeignID
required: true
schema:
$ref: '#/components/schemas/entityTypes_EntityId'
responses:
'200':
description: Successful response
'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
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/entityTypes_EntityHidePayeesRequest'
security:
- default: []
/entity/{entityId}/addPayors:
post:
operationId: entity_counterparty_addPayors
summary: Link Payors
description: Create association between Entity and a given list of Payors. If a Payor has previously been archived, unarchive the Payor.
tags:
- entity > counterparty
parameters:
- name: entityId
in: path
description: Entity ID or Entity ForeignID
required: true
schema:
$ref: '#/components/schemas/entityTypes_EntityId'
responses:
'200':
description: Successful response
'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
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/entityTypes_EntityAddPayorsRequest'
security:
- default: []
/entity/{entityId}/hidePayors:
post:
operationId: entity_counterparty_hidePayors
summary: Hide Payors
description: Marks Payors as unsearchable by Entity via Counterparty search. Invoices associated with these Payors will still be searchable via Invoice search.
tags:
- entity > counterparty
parameters:
- name: entityId
in: path
description: Entity ID or Entity ForeignID
required: true
schema:
$ref: '#/components/schemas/entityTypes_EntityId'
responses:
'200':
description: Successful response
'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
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/entityTypes_EntityHidePayorsRequest'
security:
- default: []
components:
schemas:
entityTypes_EntityAddPayeesRequest:
type: object
properties:
payees:
type: array
items:
$ref: '#/components/schemas/entityTypes_EntityId'
description: List of payee entity IDs or foreign IDs to associate with the entity
customizations:
type: array
items:
$ref: '#/components/schemas/entityTypes_CounterpartyCustomizationRequest'
description: List of customizations to apply to the payees. If the payee is not currently a counterparty of the entity, the counterparty will be created with the provided customizations.
required:
- payees
title: EntityAddPayeesRequest
entityTypes_EntityHidePayorsRequest:
type: object
properties:
payors:
type: array
items:
$ref: '#/components/schemas/entityTypes_EntityId'
description: List of payor entity IDs or foreign IDs to hide
required:
- payors
title: EntityHidePayorsRequest
entityTypes_EntityAddPayorsRequest:
type: object
properties:
payors:
type: array
items:
$ref: '#/components/schemas/entityTypes_EntityId'
description: List of payor entity IDs or foreign IDs to associate with the entity
customizations:
type: array
items:
$ref: '#/components/schemas/entityTypes_CounterpartyCustomizationRequest'
description: List of customizations to apply to the payors. If the payor is not currently a counterparty of the entity, the counterparty will be created with the provided customizations.
required:
- payors
title: EntityAddPayorsRequest
entityTypes_CounterpartyCustomizationRequest:
type: object
properties:
counterpartyId:
$ref: '#/components/schemas/entityTypes_EntityId'
accounts:
type: array
items:
$ref: '#/components/schemas/entityTypes_CounterpartyCustomizationAccount'
description: The list of accounts the entity has with the counterparty.
required:
- counterpartyId
title: CounterpartyCustomizationRequest
entityTypes_EntityId:
type: string
title: EntityId
entityTypes_EntityHidePayeesRequest:
type: object
properties:
payees:
type: array
items:
$ref: '#/components/schemas/entityTypes_EntityId'
description: List of payee entity IDs or foreign IDs to hide
required:
- payees
title: EntityHidePayeesRequest
entityTypes_CounterpartyCustomizationAccount:
type: object
properties:
accountId:
type: string
description: The ID the counterparty has assigned to this account.
postalCode:
type: string
description: The postal code the counterparty has assigned to this account.
nameOnAccount:
type: string
description: The name on the account the counterparty has assigned to this account.
required:
- accountId
title: CounterpartyCustomizationAccount
securitySchemes:
default:
type: http
scheme: bearer