For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Sign inBook a demo
HomeGuidesAPI ReferenceGlossary
HomeGuidesAPI ReferenceGlossary
  • API Reference
      • POSTCounterparty Added
      • POSTCounterparty Hidden
      • POSTCounterparty Onboarding Completed
      • POSTEntity Created
      • POSTEntity Updated
      • POSTEntity Status Changed
      • POSTEntity Metadata Updated
      • POSTPayment Method Created
      • POSTPayment Method Updated
      • POSTPayment Method Deleted
      • POSTInvoice Created
      • POSTInvoice Updated
      • POSTInvoice Deleted
      • POSTInvoice Status Changed
      • POSTIncoming Invoice Email
      • POSTInvoice Status Draft
      • POSTInvoice Status New
      • POSTInvoice Status Approved
      • POSTInvoice Status Refused
      • POSTInvoice Status Scheduled
      • POSTInvoice Status Pending
      • POSTInvoice Status Canceled
      • POSTInvoice Status Paid
      • POSTInvoice Status Failed
      • POSTInvoice Status Archived
      • POSTTransaction Created
      • POSTTransaction Pending
      • POSTTransaction Completed
      • POSTTransaction Failed
      • POSTTransaction Returned
      • POSTBulk Invoices Created
      • POSTBulk Invoices Updated
      • POSTBulk Invoices Approved
      • POSTBulk Entities Created
      • POSTInvoice Collection Event - Overdue Invoice
      • POSTInvoice Collection Event - Email Sent
      • POSTInvoice Collection Event - Email Received
      • POSTOCR Job Completed
      • POSTPayment Gateway Validation Job Completed
      • POSTPayment Gateway Process Job Completed
Logo
Sign inBook a demo
API ReferenceWebhooks

Invoice Collection Event - Email Received

Payload
1{
2  "eventType": "invoice.collection.email.received",
3  "invoice": {
4    "approvalPolicy": [
5      {
6        "id": "apvl_8545a84e-a45f-41bf-bdf1-33b42a55812c",
7        "trigger": [
8          {
9            "type": "amount",
10            "amount": 100,
11            "currency": "USD"
12          }
13        ],
14        "rule": {
15          "type": "approver",
16          "identifierList": {
17            "type": "rolesList",
18            "value": [
19              "Admin",
20              "Controller"
21            ]
22          },
23          "numApprovers": 2
24        },
25        "upstreamPolicyId": "root",
26        "createdAt": "2024-01-01T00:00:00Z",
27        "updatedAt": "2024-01-02T00:00:00Z"
28      }
29    ],
30    "approvers": [
31      {
32        "approvalPolicyId": "apvl_5ce50275-1789-42ea-bc60-bb7e6d03635c",
33        "approvalSlotId": "inap_9bb311c9-7c15-4c9e-8148-63814e0abec6",
34        "action": "APPROVE",
35        "eligibleRoles": [
36          "admin"
37        ],
38        "eligibleUserIds": [
39          "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
40        ],
41        "date": "2021-01-01T00:00:00Z",
42        "assignedUserId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
43      }
44    ],
45    "createdAt": "2021-01-01T00:00:00Z",
46    "hasDocuments": true,
47    "hasSourceEmail": true,
48    "id": "in_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
49    "metadata": {
50      "key1": "value1",
51      "key2": "value2"
52    },
53    "paymentDestinationConfirmed": true,
54    "status": "PAID",
55    "updatedAt": "2021-01-01T00:00:00Z",
56    "amount": 100,
57    "comments": [
58      {
59        "id": "ic_b3525b66-da94-4525-9f31-426bcf657128",
60        "text": "This is an approval comment",
61        "createdAt": "2021-01-01T00:00:00Z",
62        "updatedAt": "2021-01-01T00:00:00Z",
63        "user": {
64          "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
65          "roles": [
66            "admin",
67            "approver"
68          ],
69          "createdAt": "2024-01-01T00:00:00Z",
70          "updatedAt": "2024-01-01T00:00:00Z",
71          "foreignId": "MY-DB-ID-12345",
72          "email": "john.doe@acme.com",
73          "name": "John Doe"
74        },
75        "associatedApprovalAction": {
76          "userId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506",
77          "action": "APPROVE"
78        }
79      }
80    ],
81    "creatorUser": {
82      "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
83      "roles": [
84        "admin",
85        "approver"
86      ],
87      "createdAt": "2024-01-01T00:00:00Z",
88      "updatedAt": "2024-01-01T00:00:00Z",
89      "foreignId": "MY-DB-ID-12345",
90      "email": "john.doe@acme.com",
91      "name": "John Doe"
92    },
93    "currency": "USD",
94    "deductionDate": "2021-01-01T00:00:00Z",
95    "dueDate": "2021-01-31T00:00:00Z",
96    "foreignId": "YOUR-DATABASE-ID",
97    "invoiceDate": "2021-01-01T00:00:00Z",
98    "invoiceNumber": "INV-123",
99    "lineItems": [
100      {
101        "id": "inli_26672f38-eb9a-48f1-a7a0-f1b855e38cd7",
102        "currency": "USD",
103        "category": "EXPENSE",
104        "createdAt": "2021-01-01T00:00:00Z",
105        "updatedAt": "2021-01-01T00:00:00Z",
106        "amount": 100,
107        "description": "Product A",
108        "name": "Product A",
109        "quantity": 1,
110        "unitPrice": 100,
111        "serviceStartDate": "2021-01-01T00:00:00Z",
112        "serviceEndDate": "2021-01-31T00:00:00Z",
113        "metadata": {
114          "key1": "value1",
115          "key2": "value2"
116        },
117        "glAccountId": "600394"
118      }
119    ],
120    "noteToSelf": "For the month of January",
121    "payer": {
122      "acceptedTos": true,
123      "accountType": "business",
124      "createdAt": "2024-01-01T00:00:00Z",
125      "email": "customer@acme.com",
126      "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
127      "isCustomer": true,
128      "isNetworkPayee": false,
129      "isNetworkPayor": false,
130      "isPayee": false,
131      "isPayor": true,
132      "name": "Acme Inc.",
133      "profile": {
134        "business": {
135          "legalBusinessName": "Acme Inc.",
136          "taxIDProvided": true,
137          "email": "customer@acme.com",
138          "businessType": "llc",
139          "phone": {
140            "countryCode": "1",
141            "number": "4155551234"
142          },
143          "address": {
144            "addressLine1": "123 Main St",
145            "city": "San Francisco",
146            "stateOrProvince": "CA",
147            "postalCode": "94105",
148            "addressLine2": "Unit 1",
149            "country": "US"
150          },
151          "ownersProvided": true,
152          "taxId": {
153            "ein": {
154              "number": "12-3456789"
155            }
156          }
157        }
158      },
159      "status": "verified",
160      "updatedAt": "2024-01-02T00:00:00Z",
161      "accounts": [
162        {
163          "accountId": "85866843",
164          "postalCode": "94105",
165          "nameOnAccount": "John Doe"
166        }
167      ],
168      "counterpartyType": [
169        "ENTITY"
170      ],
171      "foreignId": "MY-DB-ID-12345",
172      "paymentMethods": [
173        {
174          "type": "bankAccount",
175          "accountName": "My Checking Account",
176          "accountNumber": "99988767623",
177          "accountType": "CHECKING",
178          "bankName": "Chase",
179          "createdAt": "2021-01-01T00:00:00Z",
180          "frozen": false,
181          "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
182          "isDefaultDestination": true,
183          "isDefaultSource": true,
184          "metadata": {},
185          "routingNumber": "12345678",
186          "status": "VERIFIED",
187          "supportedCurrencies": [
188            "USD"
189          ],
190          "updatedAt": "2021-01-01T00:00:00Z",
191          "confirmedByEntity": true
192        }
193      ]
194    },
195    "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
196    "paymentDestination": {
197      "type": "check",
198      "addressLine1": "123 Main St",
199      "city": "New York",
200      "country": "US",
201      "createdAt": "2021-01-01T00:00:00Z",
202      "frozen": false,
203      "id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
204      "isDefaultDestination": true,
205      "isDefaultSource": false,
206      "metadata": {},
207      "payToTheOrderOf": "John Doe",
208      "postalCode": "10001",
209      "stateOrProvince": "NY",
210      "supportedCurrencies": [
211        "USD"
212      ],
213      "updatedAt": "2021-01-01T00:00:00Z",
214      "addressLine2": "Apt 1",
215      "confirmedByEntity": true
216    },
217    "paymentDestinationId": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
218    "paymentDestinationOptions": {
219      "type": "check",
220      "delivery": "MAIL",
221      "printDescription": true
222    },
223    "paymentSource": {
224      "type": "bankAccount",
225      "accountName": "My Checking Account",
226      "accountNumber": "99988767623",
227      "accountType": "CHECKING",
228      "bankName": "Chase",
229      "createdAt": "2021-01-01T00:00:00Z",
230      "frozen": false,
231      "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
232      "isDefaultDestination": true,
233      "isDefaultSource": true,
234      "metadata": {},
235      "routingNumber": "12345678",
236      "status": "VERIFIED",
237      "supportedCurrencies": [
238        "USD"
239      ],
240      "updatedAt": "2021-01-01T00:00:00Z",
241      "confirmedByEntity": true
242    },
243    "paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
244    "paymentSourceOptions": {
245      "type": "bnpl",
246      "acceptedTerms": true,
247      "defermentWeeks": 8,
248      "installmentsStartDate": "2025-06-18"
249    },
250    "processedAt": "2021-01-01T00:00:00Z",
251    "serviceEndDate": "2021-01-31T00:00:00Z",
252    "serviceStartDate": "2021-01-01T00:00:00Z",
253    "settlementDate": "2021-01-03T00:00:00Z",
254    "transactions": [
255      {
256        "type": "bankAccountToBankAccount",
257        "amount": 10000,
258        "createdAt": "2024-01-01T00:00:00Z",
259        "currency": "USD",
260        "id": "trx_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
261        "payer": {
262          "acceptedTos": true,
263          "accountType": "business",
264          "createdAt": "2024-01-01T00:00:00Z",
265          "email": "customer@acme.com",
266          "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
267          "isCustomer": true,
268          "isNetworkPayee": false,
269          "isNetworkPayor": false,
270          "isPayee": false,
271          "isPayor": true,
272          "name": "Acme Inc.",
273          "profile": {
274            "business": {
275              "legalBusinessName": "Acme Inc.",
276              "taxIDProvided": true,
277              "email": "customer@acme.com",
278              "businessType": "llc",
279              "phone": {
280                "countryCode": "1",
281                "number": "4155551234"
282              },
283              "address": {
284                "addressLine1": "123 Main St",
285                "city": "San Francisco",
286                "stateOrProvince": "CA",
287                "postalCode": "94105",
288                "addressLine2": "Unit 1",
289                "country": "US"
290              },
291              "ownersProvided": true,
292              "taxId": {
293                "ein": {
294                  "number": "12-3456789"
295                }
296              }
297            }
298          },
299          "status": "verified",
300          "updatedAt": "2024-01-02T00:00:00Z",
301          "accounts": [
302            {
303              "accountId": "85866843",
304              "postalCode": "94105",
305              "nameOnAccount": "John Doe"
306            }
307          ],
308          "counterpartyType": [
309            "ENTITY"
310          ],
311          "foreignId": "MY-DB-ID-12345",
312          "paymentMethods": [
313            {
314              "type": "bankAccount",
315              "accountName": "My Checking Account",
316              "accountNumber": "99988767623",
317              "accountType": "CHECKING",
318              "bankName": "Chase",
319              "createdAt": "2021-01-01T00:00:00Z",
320              "frozen": false,
321              "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
322              "isDefaultDestination": true,
323              "isDefaultSource": true,
324              "metadata": {},
325              "routingNumber": "12345678",
326              "status": "VERIFIED",
327              "supportedCurrencies": [
328                "USD"
329              ],
330              "updatedAt": "2021-01-01T00:00:00Z",
331              "confirmedByEntity": true
332            }
333          ]
334        },
335        "payerId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4",
336        "paymentDestination": {
337          "type": "bankAccount",
338          "accountName": "My Checking Account",
339          "accountNumber": "99988767623",
340          "accountType": "CHECKING",
341          "bankName": "Chase",
342          "createdAt": "2021-01-01T00:00:00Z",
343          "frozen": false,
344          "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
345          "isDefaultDestination": true,
346          "isDefaultSource": true,
347          "metadata": {},
348          "routingNumber": "12345678",
349          "status": "VERIFIED",
350          "supportedCurrencies": [
351            "USD"
352          ],
353          "updatedAt": "2021-01-01T00:00:00Z",
354          "confirmedByEntity": true
355        },
356        "paymentDestinationId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
357        "paymentSource": {
358          "type": "bankAccount",
359          "accountName": "My Checking Account",
360          "accountNumber": "99988767623",
361          "accountType": "CHECKING",
362          "bankName": "Chase",
363          "createdAt": "2021-01-01T00:00:00Z",
364          "frozen": false,
365          "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
366          "isDefaultDestination": true,
367          "isDefaultSource": true,
368          "metadata": {},
369          "routingNumber": "12345678",
370          "status": "VERIFIED",
371          "supportedCurrencies": [
372            "USD"
373          ],
374          "updatedAt": "2021-01-01T00:00:00Z",
375          "confirmedByEntity": true
376        },
377        "paymentSourceId": "pm_65523ab0-043d-4706-b2b2-0b73fed92269",
378        "status": "COMPLETED",
379        "updatedAt": "2024-01-01T00:00:00Z",
380        "vendor": {
381          "acceptedTos": false,
382          "accountType": "business",
383          "createdAt": "2024-01-01T00:00:00Z",
384          "email": "vendor@bigboxstore.com",
385          "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
386          "isCustomer": false,
387          "isNetworkPayee": false,
388          "isNetworkPayor": false,
389          "isPayee": true,
390          "isPayor": false,
391          "name": "Big Box Store",
392          "profile": {
393            "business": {
394              "legalBusinessName": "Big Box Store",
395              "taxIDProvided": false,
396              "email": "vendor@bigboxstore.com",
397              "businessType": "publicCorporation",
398              "ownersProvided": false
399            }
400          },
401          "status": "unverified",
402          "updatedAt": "2024-01-02T00:00:00Z",
403          "counterpartyType": [
404            "ENTITY"
405          ],
406          "foreignId": "MY-DB-ID-90909",
407          "paymentMethods": [
408            {
409              "type": "bankAccount",
410              "accountName": "Vendor Checking Account",
411              "accountNumber": "55934059697648",
412              "accountType": "CHECKING",
413              "bankName": "Chase",
414              "createdAt": "2021-01-01T00:00:00Z",
415              "frozen": false,
416              "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
417              "isDefaultDestination": true,
418              "isDefaultSource": true,
419              "metadata": {},
420              "routingNumber": "66554433",
421              "status": "NEW",
422              "supportedCurrencies": [
423                "USD"
424              ],
425              "updatedAt": "2021-01-01T00:00:00Z",
426              "confirmedByEntity": false
427            }
428          ]
429        },
430        "vendorId": "ent_bb08e72f-19f8-45f3-bcf9-46fdc46cb2f4"
431      }
432    ],
433    "vendor": {
434      "acceptedTos": false,
435      "accountType": "business",
436      "createdAt": "2024-01-01T00:00:00Z",
437      "email": "vendor@bigboxstore.com",
438      "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
439      "isCustomer": false,
440      "isNetworkPayee": false,
441      "isNetworkPayor": false,
442      "isPayee": true,
443      "isPayor": false,
444      "name": "Big Box Store",
445      "profile": {
446        "business": {
447          "legalBusinessName": "Big Box Store",
448          "taxIDProvided": false,
449          "email": "vendor@bigboxstore.com",
450          "businessType": "publicCorporation",
451          "ownersProvided": false
452        }
453      },
454      "status": "unverified",
455      "updatedAt": "2024-01-02T00:00:00Z",
456      "counterpartyType": [
457        "ENTITY"
458      ],
459      "foreignId": "MY-DB-ID-90909",
460      "paymentMethods": [
461        {
462          "type": "bankAccount",
463          "accountName": "Vendor Checking Account",
464          "accountNumber": "55934059697648",
465          "accountType": "CHECKING",
466          "bankName": "Chase",
467          "createdAt": "2021-01-01T00:00:00Z",
468          "frozen": false,
469          "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
470          "isDefaultDestination": true,
471          "isDefaultSource": true,
472          "metadata": {},
473          "routingNumber": "66554433",
474          "status": "NEW",
475          "supportedCurrencies": [
476            "USD"
477          ],
478          "updatedAt": "2021-01-01T00:00:00Z",
479          "confirmedByEntity": false
480        }
481      ]
482    },
483    "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
484  },
485  "email": {
486    "subject": "Re: Invoice Past Due - Please Review",
487    "body": "This slipped under my radar; I will make sure to pay this today."
488  }
489}

An email was received from a payee to collect an overdue invoice (in development)

Was this page helpful?
Previous

OCR Job Completed

Next
Built with

Payload

The payload of this webhook request is an object.
eventTypestringRequired
The type of the event.
invoiceobjectRequired
The invoice involved in the event.
emailobjectOptional
Email message related to the invoice collection.

Response

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