Search Contracts

GET

1 import { MercoaClient } from "@mercoa/javascript";
2 
3 const client = new MercoaClient({ token: "YOUR_TOKEN" });
4 await client.contract.find({
5     creatorEntityId: "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c"
6 });

Try it

200Find contracts by creator

1 {
2   "count": 1,
3   "hasMore": false,
4   "data": [
5     {
6       "id": "cnt_3bd62b69-3835-433e-829f-4388a2e46c41",
7       "summary": "Contract Start Date: January 29, 2025\nParties to the Agreement:\n- Provider (Vendor): [Vendor Name] - Client (Payer): [Client Name]\nFees and Payment Terms:\n- Monthly Recurring Fee: \\$20.00 - Payment Schedule: Fees are payable in advance on the 1st day of each month. - First Payment Date: February 1, 2025 - Payment Method: Via credit card to the account designated by Provider. - Payment Due Date: Payment is due 5 days after the invoice date.\n",
8       "recurrences": [
9         {
10           "id": "cntrec_0b2d48a7-38e8-44e1-9abc-95e0e67eb484",
11           "contractId": "cnt_3bd62b69-3835-433e-829f-4388a2e46c41",
12           "rrule": "DTSTART:20250201T000000ZRRULE:FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=1",
13           "justification": "Monthly recurring fee billed in advance on the 1st of each month",
14           "filteredContractSummary": "Contract Start Date: January 29, 2025\nParties to the Agreement:\n- Provider (Vendor): [Vendor Name] - Client (Payer): [Client Name]\nFees and Payment Terms:\n- Monthly Recurring Fee: \\$20.00 - Payment Schedule: Fees are payable in advance on the 1st day of each month. - First Payment Date: February 1, 2025 - Payment Method: Via credit card to the account designated by Provider. - Payment Due Date: Payment is due 5 days after the invoice date.\n",
15           "invoiceSchema": {
16             "lineItems": [
17               {
18                 "name": "Monthly Subscription Service Fee",
19                 "unitPrice": 20,
20                 "currency": "USD",
21                 "quantity": 1
22               }
23             ]
24           },
25           "createdInvoiceIds": [
26             "in_8545a84e-a45f-41bf-bdf1-33b42a55812c"
27           ],
28           "createdAt": "2025-01-29T00:00:00Z",
29           "updatedAt": "2025-01-29T00:00:00Z"
30         }
31       ],
32       "creatorEntityId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
33       "createdAt": "2025-01-29T00:00:00Z",
34       "updatedAt": "2025-02-01T00:00:00Z",
35       "nextInvoiceDate": "2025-03-01",
36       "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
37       "payer": {
38         "acceptedTos": true,
39         "accountType": "business",
40         "createdAt": "2024-01-01T00:00:00Z",
41         "email": "customer@acme.com",
42         "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
43         "isCustomer": true,
44         "isNetworkPayee": false,
45         "isNetworkPayor": false,
46         "isPayee": false,
47         "isPayor": true,
48         "name": "Acme Inc.",
49         "profile": {
50           "business": {
51             "legalBusinessName": "Acme Inc.",
52             "taxIDProvided": true,
53             "email": "customer@acme.com",
54             "businessType": "llc",
55             "phone": {
56               "countryCode": "1",
57               "number": "4155551234"
58             },
59             "address": {
60               "addressLine1": "123 Main St",
61               "city": "San Francisco",
62               "stateOrProvince": "CA",
63               "postalCode": "94105",
64               "addressLine2": "Unit 1",
65               "country": "US"
66             },
67             "ownersProvided": true,
68             "taxId": {
69               "ein": {
70                 "number": "12-3456789"
71               }
72             }
73           }
74         },
75         "status": "verified",
76         "updatedAt": "2024-01-02T00:00:00Z",
77         "accounts": [
78           {
79             "accountId": "85866843",
80             "postalCode": "94105",
81             "nameOnAccount": "John Doe"
82           }
83         ],
84         "counterpartyType": [
85           "ENTITY"
86         ],
87         "foreignId": "MY-DB-ID-12345",
88         "paymentMethods": [
89           {
90             "type": "bankAccount",
91             "accountName": "My Checking Account",
92             "accountNumber": "99988767623",
93             "accountType": "CHECKING",
94             "bankName": "Chase",
95             "createdAt": "2021-01-01T00:00:00Z",
96             "frozen": false,
97             "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
98             "isDefaultDestination": true,
99             "isDefaultSource": true,
100             "metadata": {},
101             "routingNumber": "12345678",
102             "status": "VERIFIED",
103             "supportedCurrencies": [
104               "USD"
105             ],
106             "updatedAt": "2021-01-01T00:00:00Z",
107             "confirmedByEntity": true
108           }
109         ]
110       },
111       "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
112       "vendor": {
113         "acceptedTos": false,
114         "accountType": "business",
115         "createdAt": "2024-01-01T00:00:00Z",
116         "email": "vendor@bigboxstore.com",
117         "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
118         "isCustomer": false,
119         "isNetworkPayee": false,
120         "isNetworkPayor": false,
121         "isPayee": true,
122         "isPayor": false,
123         "name": "Big Box Store",
124         "profile": {
125           "business": {
126             "legalBusinessName": "Big Box Store",
127             "taxIDProvided": false,
128             "email": "vendor@bigboxstore.com",
129             "businessType": "publicCorporation",
130             "ownersProvided": false
131           }
132         },
133         "status": "unverified",
134         "updatedAt": "2024-01-02T00:00:00Z",
135         "counterpartyType": [
136           "ENTITY"
137         ],
138         "foreignId": "MY-DB-ID-90909",
139         "paymentMethods": [
140           {
141             "type": "bankAccount",
142             "accountName": "Vendor Checking Account",
143             "accountNumber": "55934059697648",
144             "accountType": "CHECKING",
145             "bankName": "Chase",
146             "createdAt": "2021-01-01T00:00:00Z",
147             "frozen": false,
148             "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
149             "isDefaultDestination": true,
150             "isDefaultSource": true,
151             "metadata": {},
152             "routingNumber": "66554433",
153             "status": "NEW",
154             "supportedCurrencies": [
155               "USD"
156             ],
157             "updatedAt": "2021-01-01T00:00:00Z",
158             "confirmedByEntity": false
159           }
160         ]
161       }
162     }
163   ]
164 }

Search contracts for all entities in the organization

Query parameters

creatorEntityIdstringOptional

ID of the entity that created the contracts

Response

This endpoint returns an object.

countinteger

Total number of contracts found

hasMoreboolean

True if there are more contracts available for the given filters

datalist of objects

Search Contracts

Headers

Query parameters

Response

Errors