Generate Contract (Sync)

Generate a new contract object from a Base64 encoded PDF of a contract. This endpoint will block until the contract is generated.

1 curl -X POST https://api.mercoa.com/contract/generate \ 2 -H "Authorization: Bearer <token>" \ 3 -H "Content-Type: application/json" \ 4 -d '{ 5 "document": "data:application/pdf;base64,JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==", 6 "creatorEntityId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c" 7 }'

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

Request

Response

1	curl -X POST https://api.mercoa.com/contract/generate \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"document": "data:application/pdf;base64,JVBERi0xLjEKJcKlwrHDqwoKMSAwIG9iagogIDw8IC9UeXBlIC9DYXRhbG9nCiAgICAgL1BhZ2VzIDIgMCBSCiAgPj4KZW5kb2JqCgoyIDAgb2JqCiAgPDwgL1R5cGUgL1BhZ2VzCiAgICAgL0tpZHMgWzMgMCBSXQogICAgIC9Db3VudCAxCiAgICAgL01lZGlhQm94IFswIDAgMzAwIDE0NF0KICA+PgplbmRvYmoKCjMgMCBvYmoKICA8PCAgL1R5cGUgL1BhZ2UKICAgICAgL1BhcmVudCAyIDAgUgogICAgICAvUmVzb3VyY2VzCiAgICAgICA8PCAvRm9udAogICAgICAgICAgIDw8IC9GMQogICAgICAgICAgICAgICA8PCAvVHlwZSAvRm9udAogICAgICAgICAgICAgICAgICAvU3VidHlwZSAvVHlwZTEKICAgICAgICAgICAgICAgICAgL0Jhc2VGb250IC9UaW1lcy1Sb21hbgogICAgICAgICAgICAgICA+PgogICAgICAgICAgID4+CiAgICAgICA+PgogICAgICAvQ29udGVudHMgNCAwIFIKICA+PgplbmRvYmoKCjQgMCBvYmoKICA8PCAvTGVuZ3RoIDU1ID4+CnN0cmVhbQogIEJUCiAgICAvRjEgMTggVGYKICAgIDAgMCBUZAogICAgKEhlbGxvIFdvcmxkKSBUagogIEVUCmVuZHN0cmVhbQplbmRvYmoKCnhyZWYKMCA1CjAwMDAwMDAwMDAgNjU1MzUgZiAKMDAwMDAwMDAxOCAwMDAwMCBuIAowMDAwMDAwMDc3IDAwMDAwIG4gCjAwMDAwMDAxNzggMDAwMDAgbiAKMDAwMDAwMDQ1NyAwMDAwMCBuIAp0cmFpbGVyCiAgPDwgIC9Sb290IDEgMCBSCiAgICAgIC9TaXplIDUKICA+PgpzdGFydHhyZWYKNTY1CiUlRU9GCg==",
6	"creatorEntityId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c"
7	}'

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