Get Contract Generation Response (Async)

GET

https://api.mercoa.com/contract/generate-async/:jobId

GET

/contract/generate-async/:jobId

1 from mercoa import Mercoa
2 
3 client = Mercoa(
4     token="YOUR_TOKEN",
5 )
6 client.contract.generate_contract_get_async(
7     job_id="cntgen_d6734204-ae46-4fe9-a0c5-bd2763d40c9b",
8 )

Try it

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

Get the status and results of an asynchronous contract generation job.

Path parameters

jobIdstringRequired

Job ID

Response

This endpoint returns an object.

jobIdstring

Job ID

statusenum

Job status

Allowed values:

contractobject or null

Contract

Get Contract Generation Response (Async)

Path parameters

Headers

Response

Errors