entity > counterparty > bulk

Download Bulk Payees

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

get/entity/{entityId}/counterparties/payees/download

Request

  • Base URL: https://api.mercoa.com
  • URL: https://api.mercoa.com/entity/{entityId}/counterparties/payees/download
  • Auth: HTTP bearer

Path parameters

entityIdstring required

Entity ID or Entity ForeignID

Query parameters

format'CSV' | 'JSON'

Format of the file to download. Defaults to CSV.

searchstring

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

networkType'ENTITY' | 'NETWORK'

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

paymentMethodsboolean

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

invoiceMetricsboolean

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

counterpartyIdstring

Filter by counterparty ids (Foreign ID is supported)

keystring required

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

returnMetadatastring

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

Response

Response with status 200

urlstring required
mimeTypestring required

Changes

No recorded changes to this operation across all 1 revision of this API.