EntityCounterparty

Find payee counterparties

GET
Find payee counterparties. This endpoint lets you find vendors linked to the entity.

Path parameters

entityIdstringRequired

Query parameters

namestringOptional
Filter by counterparty name
networkTypeenumOptional
Filter by network type. By default, only ENTITY counterparties are returned.
Allowed values: ENTITYNETWORK
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
limitintegerOptional
Number of counterparties to return. Limit can range between 1 and 100, and the default is 10.
startingAfterstringOptional
The ID of the counterparties to start after. If not provided, the first page of counterparties will be returned.

Response

This endpoint returns an object
count
integer
Total number of counterparties for the given filters. This value is not limited by the limit parameter. It is provided so that you can determine how many pages of results are available.
hasMore
boolean
True if there are more counterparties available for the given filters.
data
list of objects
GET
1curl -G https://api.mercoa.com/entity/:entityId/counterparties/payees \
2     -H "Authorization: Bearer <token>" \
3     -d name=string \
4     -d networkType=ENTITY
200
Retrieved
1{
2  "count": 0,
3  "hasMore": true,
4  "data": [
5    {
6      "acceptedTos": true,
7      "accountType": "business",
8      "counterpartyType": [
9        "ENTITY"
10      ],
11      "createdAt": "2023-01-01T00:00:00Z",
12      "email": "string",
13      "id": "string",
14      "isCustomer": true,
15      "isPayee": true,
16      "isPayor": true,
17      "name": "string",
18      "paymentMethods": [
19        {
20          "type": "bankAccount",
21          "accountName": "string",
22          "accountNumber": "string",
23          "accountType": "CHECKING",
24          "bankName": "string",
25          "createdAt": "2023-01-01T00:00:00Z",
26          "id": "string",
27          "isDefaultDestination": true,
28          "isDefaultSource": true,
29          "routingNumber": "string",
30          "status": "NEW",
31          "supportedCurrencies": [
32            "AED"
33          ],
34          "updatedAt": "2023-01-01T00:00:00Z",
35          "checkOptions": {
36            "signatoryName": "string",
37            "enabled": true,
38            "initialCheckNumber": 0,
39            "routingNumberOverride": "string",
40            "accountNumberOverride": "string",
41            "signatureImage": "string",
42            "useSignatureImage": true
43          }
44        }
45      ],
46      "profile": {
47        "business": {
48          "legalBusinessName": "string",
49          "taxIDProvided": true,
50          "email": "string",
51          "businessType": "soleProprietorship",
52          "phone": {
53            "countryCode": "string",
54            "number": "string"
55          },
56          "doingBusinessAs": "string",
57          "website": "string",
58          "description": "string",
59          "address": {
60            "addressLine1": "string",
61            "city": "string",
62            "stateOrProvince": "string",
63            "postalCode": "string",
64            "addressLine2": "string",
65            "country": "string"
66          },
67          "ownersProvided": true
68        },
69        "individual": {
70          "name": {
71            "firstName": "string",
72            "lastName": "string",
73            "middleName": "string",
74            "suffix": "string"
75          },
76          "birthDateProvided": true,
77          "governmentIDProvided": true,
78          "email": "string",
79          "phone": {
80            "countryCode": "string",
81            "number": "string"
82          },
83          "address": {
84            "addressLine1": "string",
85            "city": "string",
86            "stateOrProvince": "string",
87            "postalCode": "string",
88            "addressLine2": "string",
89            "country": "string"
90          }
91        }
92      },
93      "status": "unverified",
94      "updatedAt": "2023-01-01T00:00:00Z",
95      "emailTo": "string",
96      "emailToAlias": [
97        "string"
98      ],
99      "foreignId": "string",
100      "invoiceMetrics": {
101        "totalCount": 0,
102        "totalAmount": 1,
103        "statuses": [
104          {
105            "status": "DRAFT",
106            "totalCount": 0,
107            "totalAmount": 1
108          }
109        ]
110      }
111    }
112  ]
113}
Built with