Update — Mercoa | Documentation

Path parameters

contractIdstringRequired

Contract ID

Request

This endpoint expects an object.

summarystringOptional

Natural language summary of the contract

recurrenceslist of objectsOptional

Recurrences defining the contract’s fee schedule. Please note that setting this will overwrite all existing recurrences.

creatorEntityIdstringOptional

ID of the entity that created the contract

payerIdstringOptional

ID of the payer entity for this contract

vendorIdstringOptional

ID of the vendor entity for this contract

Response

This endpoint returns an object.

idstring

summarystring

Natural language summary of the contract

recurrenceslist of objects

Recurrences defining the contract’s fee schedule

creatorEntityIdstring

The ID of the entity who created this contract

createdAtdatetime

updatedAtdatetime

nextInvoiceDatedateOptional

Date of the next invoice to be created from the contract

payerIdstringOptional

The ID of the payer entity for this contract

payerobjectOptional

The payer entity for this contract

vendorIdstringOptional

The ID of the vendor entity for this contract

vendorobjectOptional

The vendor entity for this contract

1 curl -X PUT https://api.mercoa.com/contract/cnt_3bd62b69-3835-433e-829f-4388a2e46c41 \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "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", 6 "recurrences": [ 7 { 8 "rrule": "DTSTART:20250201T000000ZRRULE:FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=1", 9 "justification": "Monthly recurring fee billed in advance on the 1st of each month", 10 "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", 11 "invoiceSchema": { 12 "lineItems": [ 13 { 14 "name": "Monthly Subscription Service Fee", 15 "unitPrice": 20, 16 "currency": "USD", 17 "quantity": 1 18 } 19 ] 20 } 21 } 22 ] 23 }'

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

1	curl -X PUT https://api.mercoa.com/contract/cnt_3bd62b69-3835-433e-829f-4388a2e46c41 \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"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",
6	"recurrences": [
7	{
8	"rrule": "DTSTART:20250201T000000ZRRULE:FREQ=MONTHLY;INTERVAL=1;BYMONTHDAY=1",
9	"justification": "Monthly recurring fee billed in advance on the 1st of each month",
10	"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",
11	"invoiceSchema": {
12	"lineItems": [
13	{
14	"name": "Monthly Subscription Service Fee",
15	"unitPrice": 20,
16	"currency": "USD",
17	"quantity": 1
18	}
19	]
20	}
21	}
22	]
23	}'

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