Invoice Status Paid

Payload
1 {
2   "eventType": "invoice.status.paid",
3   "invoice": {
4     "approvalPolicy": [],
5     "approvers": [],
6     "createdAt": "2021-01-01T00:00:00Z",
7     "hasDocuments": true,
8     "hasSourceEmail": true,
9     "id": "in_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
10     "metadata": {},
11     "paymentDestinationConfirmed": true,
12     "status": "PAID",
13     "updatedAt": "2021-01-01T00:00:00Z",
14     "amount": 100,
15     "currency": "USD",
16     "deductionDate": "2021-01-29T00:00:00Z",
17     "dueDate": "2021-01-31T00:00:00Z",
18     "invoiceDate": "2021-01-01T00:00:00Z",
19     "invoiceNumber": "INV-123",
20     "payer": {
21       "acceptedTos": true,
22       "accountType": "business",
23       "createdAt": "2024-01-01T00:00:00Z",
24       "email": "customer@acme.com",
25       "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
26       "isCustomer": true,
27       "isNetworkPayee": false,
28       "isNetworkPayor": false,
29       "isPayee": false,
30       "isPayor": true,
31       "name": "Acme Inc.",
32       "profile": {
33         "business": {
34           "legalBusinessName": "Acme Inc.",
35           "taxIDProvided": true,
36           "email": "customer@acme.com",
37           "businessType": "llc",
38           "phone": {
39             "countryCode": "1",
40             "number": "4155551234"
41           },
42           "address": {
43             "addressLine1": "123 Main St",
44             "city": "San Francisco",
45             "stateOrProvince": "CA",
46             "postalCode": "94105",
47             "addressLine2": "Unit 1",
48             "country": "US"
49           },
50           "ownersProvided": true,
51           "taxId": {
52             "ein": {
53               "number": "12-3456789"
54             }
55           }
56         }
57       },
58       "status": "verified",
59       "updatedAt": "2024-01-02T00:00:00Z",
60       "accounts": [
61         {
62           "accountId": "85866843",
63           "postalCode": "94105",
64           "nameOnAccount": "John Doe"
65         }
66       ],
67       "counterpartyType": [
68         "ENTITY"
69       ],
70       "foreignId": "MY-DB-ID-12345",
71       "paymentMethods": [
72         {
73           "type": "bankAccount",
74           "accountName": "My Checking Account",
75           "accountNumber": "99988767623",
76           "accountType": "CHECKING",
77           "bankName": "Chase",
78           "createdAt": "2021-01-01T00:00:00Z",
79           "frozen": false,
80           "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
81           "isDefaultDestination": true,
82           "isDefaultSource": true,
83           "metadata": {},
84           "routingNumber": "12345678",
85           "status": "VERIFIED",
86           "supportedCurrencies": [
87             "USD"
88           ],
89           "updatedAt": "2021-01-01T00:00:00Z"
90         }
91       ]
92     },
93     "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
94     "paymentDestination": {
95       "type": "check",
96       "addressLine1": "123 Main St",
97       "city": "New York",
98       "country": "US",
99       "createdAt": "2021-01-01T00:00:00Z",
100       "frozen": false,
101       "id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
102       "isDefaultDestination": true,
103       "isDefaultSource": false,
104       "metadata": {},
105       "payToTheOrderOf": "John Doe",
106       "postalCode": "10001",
107       "stateOrProvince": "NY",
108       "supportedCurrencies": [
109         "USD"
110       ],
111       "updatedAt": "2021-01-01T00:00:00Z",
112       "addressLine2": "Apt 1"
113     },
114     "paymentDestinationId": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
115     "paymentSource": {
116       "type": "bankAccount",
117       "accountName": "My Checking Account",
118       "accountNumber": "99988767623",
119       "accountType": "CHECKING",
120       "bankName": "Chase",
121       "createdAt": "2021-01-01T00:00:00Z",
122       "frozen": false,
123       "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
124       "isDefaultDestination": true,
125       "isDefaultSource": true,
126       "metadata": {},
127       "routingNumber": "12345678",
128       "status": "VERIFIED",
129       "supportedCurrencies": [
130         "USD"
131       ],
132       "updatedAt": "2021-01-01T00:00:00Z"
133     },
134     "paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
135     "transactions": [
136       {
137         "type": "bankAccountToBankAccount",
138         "amount": 10000,
139         "createdAt": "2024-01-01T00:00:00Z",
140         "currency": "USD",
141         "id": "trx_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
142         "payer": {
143           "acceptedTos": true,
144           "accountType": "business",
145           "createdAt": "2024-01-01T00:00:00Z",
146           "email": "customer@acme.com",
147           "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
148           "isCustomer": true,
149           "isNetworkPayee": false,
150           "isNetworkPayor": false,
151           "isPayee": false,
152           "isPayor": true,
153           "name": "Acme Inc.",
154           "profile": {
155             "business": {
156               "legalBusinessName": "Acme Inc.",
157               "taxIDProvided": true,
158               "email": "customer@acme.com",
159               "businessType": "llc",
160               "phone": {
161                 "countryCode": "1",
162                 "number": "4155551234"
163               },
164               "address": {
165                 "addressLine1": "123 Main St",
166                 "city": "San Francisco",
167                 "stateOrProvince": "CA",
168                 "postalCode": "94105",
169                 "addressLine2": "Unit 1",
170                 "country": "US"
171               },
172               "ownersProvided": true,
173               "taxId": {
174                 "ein": {
175                   "number": "12-3456789"
176                 }
177               }
178             }
179           },
180           "status": "verified",
181           "updatedAt": "2024-01-02T00:00:00Z",
182           "accounts": [
183             {
184               "accountId": "85866843",
185               "postalCode": "94105",
186               "nameOnAccount": "John Doe"
187             }
188           ],
189           "counterpartyType": [
190             "ENTITY"
191           ],
192           "foreignId": "MY-DB-ID-12345",
193           "paymentMethods": [
194             {
195               "type": "bankAccount",
196               "accountName": "My Checking Account",
197               "accountNumber": "99988767623",
198               "accountType": "CHECKING",
199               "bankName": "Chase",
200               "createdAt": "2021-01-01T00:00:00Z",
201               "frozen": false,
202               "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
203               "isDefaultDestination": true,
204               "isDefaultSource": true,
205               "metadata": {},
206               "routingNumber": "12345678",
207               "status": "VERIFIED",
208               "supportedCurrencies": [
209                 "USD"
210               ],
211               "updatedAt": "2021-01-01T00:00:00Z"
212             }
213           ]
214         },
215         "payerId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
216         "paymentDestination": {
217           "type": "bankAccount",
218           "accountName": "My Checking Account",
219           "accountNumber": "99988767623",
220           "accountType": "CHECKING",
221           "bankName": "Chase",
222           "createdAt": "2021-01-01T00:00:00Z",
223           "frozen": false,
224           "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
225           "isDefaultDestination": true,
226           "isDefaultSource": true,
227           "metadata": {},
228           "routingNumber": "12345678",
229           "status": "VERIFIED",
230           "supportedCurrencies": [
231             "USD"
232           ],
233           "updatedAt": "2021-01-01T00:00:00Z"
234         },
235         "paymentDestinationId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
236         "paymentSource": {
237           "type": "bankAccount",
238           "accountName": "My Checking Account",
239           "accountNumber": "99988767623",
240           "accountType": "CHECKING",
241           "bankName": "Chase",
242           "createdAt": "2021-01-01T00:00:00Z",
243           "frozen": false,
244           "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
245           "isDefaultDestination": true,
246           "isDefaultSource": true,
247           "metadata": {},
248           "routingNumber": "12345678",
249           "status": "VERIFIED",
250           "supportedCurrencies": [
251             "USD"
252           ],
253           "updatedAt": "2021-01-01T00:00:00Z"
254         },
255         "paymentSourceId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
256         "status": "COMPLETED",
257         "updatedAt": "2024-01-01T00:00:00Z",
258         "vendor": {
259           "acceptedTos": false,
260           "accountType": "business",
261           "createdAt": "2024-01-01T00:00:00Z",
262           "email": "vendor@bigboxstore.com",
263           "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
264           "isCustomer": false,
265           "isNetworkPayee": false,
266           "isNetworkPayor": false,
267           "isPayee": true,
268           "isPayor": false,
269           "name": "Big Box Store",
270           "profile": {
271             "business": {
272               "legalBusinessName": "Big Box Store",
273               "taxIDProvided": false,
274               "email": "vendor@bigboxstore.com",
275               "businessType": "publicCorporation",
276               "ownersProvided": false
277             }
278           },
279           "status": "unverified",
280           "updatedAt": "2024-01-02T00:00:00Z",
281           "counterpartyType": [
282             "ENTITY"
283           ],
284           "foreignId": "MY-DB-ID-90909",
285           "paymentMethods": [
286             {
287               "type": "bankAccount",
288               "accountName": "Vendor Checking Account",
289               "accountNumber": "55934059697648",
290               "accountType": "CHECKING",
291               "bankName": "Chase",
292               "createdAt": "2021-01-01T00:00:00Z",
293               "frozen": false,
294               "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
295               "isDefaultDestination": true,
296               "isDefaultSource": true,
297               "metadata": {},
298               "routingNumber": "66554433",
299               "status": "NEW",
300               "supportedCurrencies": [
301                 "USD"
302               ],
303               "updatedAt": "2021-01-01T00:00:00Z"
304             }
305           ]
306         },
307         "vendorId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4"
308       }
309     ],
310     "vendor": {
311       "acceptedTos": false,
312       "accountType": "business",
313       "createdAt": "2024-01-01T00:00:00Z",
314       "email": "vendor@bigboxstore.com",
315       "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
316       "isCustomer": false,
317       "isNetworkPayee": false,
318       "isNetworkPayor": false,
319       "isPayee": true,
320       "isPayor": false,
321       "name": "Big Box Store",
322       "profile": {
323         "business": {
324           "legalBusinessName": "Big Box Store",
325           "taxIDProvided": false,
326           "email": "vendor@bigboxstore.com",
327           "businessType": "publicCorporation",
328           "ownersProvided": false
329         }
330       },
331       "status": "unverified",
332       "updatedAt": "2024-01-02T00:00:00Z",
333       "counterpartyType": [
334         "ENTITY"
335       ],
336       "foreignId": "MY-DB-ID-90909",
337       "paymentMethods": [
338         {
339           "type": "bankAccount",
340           "accountName": "Vendor Checking Account",
341           "accountNumber": "55934059697648",
342           "accountType": "CHECKING",
343           "bankName": "Chase",
344           "createdAt": "2021-01-01T00:00:00Z",
345           "frozen": false,
346           "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
347           "isDefaultDestination": true,
348           "isDefaultSource": true,
349           "metadata": {},
350           "routingNumber": "66554433",
351           "status": "NEW",
352           "supportedCurrencies": [
353             "USD"
354           ],
355           "updatedAt": "2021-01-01T00:00:00Z"
356         }
357       ]
358     },
359     "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
360   },
361   "user": {
362     "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
363     "roles": [
364       "admin",
365       "approver"
366     ],
367     "createdAt": "2024-01-01T00:00:00Z",
368     "updatedAt": "2024-01-01T00:00:00Z",
369     "foreignId": "MY-DB-ID-12345",
370     "email": "john.doe@acme.com",
371     "name": "John Doe"
372   }
373 }
An invoice’s status was changed to paid
Payload

The payload of this webhook request is an object.
eventTypestringRequired
invoiceobjectRequired
userobjectOptional
User who initiated the change.
Response

200
any
Return a 200 status to indicate that the data was received successfully.