Download Bulk Payees

GET

https://api.mercoa.com/entity/:entityId/counterparties/payees/download

Get a URL to download payee counterparties as a CSV/JSON file. This endpoint lets you download vendors linked to the entity.

Download Bulk Payors

Get a URL to download payee counterparties as a CSV/JSON file. This endpoint lets you download vendors linked to the entity.

AuthorizationBearer

Bearer authentication of the form `Bearer <token>`, where token is your auth token.

entityIdstringRequired

Entity ID or Entity ForeignID

formatenumOptional

Format of the file to download. Defaults to CSV.

Allowed values:

searchstringOptional

Filter counterparties by name or email. Partial matches are supported.

networkTypeenumOptional

Filter by network type. By default, only ENTITY counterparties are returned.

Allowed values:

paymentMethodsbooleanOptional

If true, will include counterparty payment methods as part of the response

invoiceMetricsbooleanOptional

If true, will include counterparty invoice metrics as part of the response

counterpartyIdstringOptional

Filter by counterparty ids (Foreign ID is supported)

metadataobjectOptional

Filter counterparties by simple key/value metadata. Each filter will be applied as an AND condition. Duplicate keys will be ignored.

returnMetadatastringOptional

If true, will return simple key/value metadata for the counterparties. For more complex metadata, use the Metadata API.

This endpoint returns an object.

urlstring

mimeTypestring

Entity ID or Entity ForeignID

Format of the file to download. Defaults to CSV.

Bearer authentication of the form Bearer <token>, where token is your auth token.

1	from mercoa import Mercoa
2
3	client = Mercoa(
4	token="YOUR_TOKEN",
5	)
6	client.entity.counterparty.bulk.download_payees(
7	entity_id="ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
8	format="CSV",
9	payment_methods=True,
10	invoice_metrics=True,
11	)

1	{
2	"url": "https://mercoa.com/download/bulk-invoices.csv",
3	"mimeType": "text/csv"
4	}