Invoice Created

A new invoice was created

Payload

The payload of this webhook request is an object.
eventType
stringRequired
invoice
objectRequired
user
objectOptional
User who initiated the change.

Response

200
any
Return a 200 status to indicate that the data was received successfully.
Payload
1{
2 "eventType": "invoice.created",
3 "invoice": {
4 "id": "inv_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
5 "status": "PAID",
6 "paymentDestinationConfirmed": true,
7 "hasDocuments": true,
8 "hasSourceEmail": true,
9 "approvers": [
10 {
11 "approvalPolicyId": "apvl_5ce50275-1789-42ea-bc60-bb7e6d03635c",
12 "approvalSlotId": "inap_9bb311c9-7c15-4c9e-8148-63814e0abec6",
13 "action": "APPROVE",
14 "eligibleRoles": [
15 "admin"
16 ],
17 "eligibleUserIds": [
18 "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
19 ],
20 "date": "2021-01-01T00:00:00Z",
21 "assignedUserId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
22 }
23 ],
24 "approvalPolicy": [
25 {
26 "id": "apvl_8545a84e-a45f-41bf-bdf1-33b42a55812c",
27 "trigger": [
28 {
29 "type": "amount",
30 "amount": 100,
31 "currency": "USD"
32 }
33 ],
34 "rule": {
35 "type": "approver",
36 "identifierList": {
37 "type": "rolesList",
38 "value": [
39 "Admin",
40 "Controller"
41 ]
42 },
43 "numApprovers": 2
44 },
45 "upstreamPolicyId": "root",
46 "createdAt": "2024-01-01T00:00:00Z",
47 "updatedAt": "2024-01-02T00:00:00Z"
48 }
49 ],
50 "metadata": {
51 "key1": "value1",
52 "key2": "value2"
53 },
54 "createdAt": "2021-01-01T00:00:00Z",
55 "updatedAt": "2021-01-01T00:00:00Z",
56 "amount": 100,
57 "currency": "USD",
58 "invoiceDate": "2021-01-01T00:00:00Z",
59 "deductionDate": "2021-01-01T00:00:00Z",
60 "processedAt": "2021-01-01T00:00:00Z",
61 "settlementDate": "2021-01-03T00:00:00Z",
62 "dueDate": "2021-01-31T00:00:00Z",
63 "invoiceNumber": "INV-123",
64 "noteToSelf": "For the month of January",
65 "serviceStartDate": "2021-01-01T00:00:00Z",
66 "serviceEndDate": "2021-01-31T00:00:00Z",
67 "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
68 "payer": {
69 "acceptedTos": true,
70 "accountType": "business",
71 "createdAt": "2024-01-01T00:00:00Z",
72 "email": "customer@acme.com",
73 "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
74 "isCustomer": true,
75 "isNetworkPayee": false,
76 "isNetworkPayor": false,
77 "isPayee": false,
78 "isPayor": true,
79 "name": "Acme Inc.",
80 "profile": {
81 "business": {
82 "legalBusinessName": "Acme Inc.",
83 "taxIDProvided": true,
84 "email": "customer@acme.com",
85 "businessType": "llc",
86 "phone": {
87 "countryCode": "1",
88 "number": "4155551234"
89 },
90 "address": {
91 "addressLine1": "123 Main St",
92 "city": "San Francisco",
93 "stateOrProvince": "CA",
94 "postalCode": "94105",
95 "addressLine2": "Unit 1",
96 "country": "US"
97 },
98 "ownersProvided": true
99 }
100 },
101 "status": "verified",
102 "updatedAt": "2024-01-02T00:00:00Z",
103 "counterpartyType": [
104 "ENTITY"
105 ],
106 "foreignId": "MY-DB-ID-12345",
107 "paymentMethods": [
108 {
109 "type": "bankAccount",
110 "accountName": "My Checking Account",
111 "accountNumber": "99988767623",
112 "accountType": "CHECKING",
113 "bankName": "Chase",
114 "createdAt": "2021-01-01T00:00:00Z",
115 "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
116 "isDefaultDestination": true,
117 "isDefaultSource": true,
118 "routingNumber": "12345678",
119 "status": "VERIFIED",
120 "supportedCurrencies": [
121 "USD"
122 ],
123 "updatedAt": "2021-01-01T00:00:00Z"
124 }
125 ]
126 },
127 "paymentSource": {
128 "type": "bankAccount",
129 "accountName": "My Checking Account",
130 "accountNumber": "99988767623",
131 "accountType": "CHECKING",
132 "bankName": "Chase",
133 "createdAt": "2021-01-01T00:00:00Z",
134 "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
135 "isDefaultDestination": true,
136 "isDefaultSource": true,
137 "routingNumber": "12345678",
138 "status": "VERIFIED",
139 "supportedCurrencies": [
140 "USD"
141 ],
142 "updatedAt": "2021-01-01T00:00:00Z"
143 },
144 "paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
145 "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
146 "vendor": {
147 "acceptedTos": false,
148 "accountType": "business",
149 "createdAt": "2024-01-01T00:00:00Z",
150 "email": "vendor@bigboxstore.com",
151 "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
152 "isCustomer": false,
153 "isNetworkPayee": false,
154 "isNetworkPayor": false,
155 "isPayee": true,
156 "isPayor": false,
157 "name": "Big Box Store",
158 "profile": {
159 "business": {
160 "legalBusinessName": "Big Box Store",
161 "taxIDProvided": false,
162 "email": "vendor@bigboxstore.com",
163 "businessType": "publicCorporation",
164 "ownersProvided": false
165 }
166 },
167 "status": "unverified",
168 "updatedAt": "2024-01-02T00:00:00Z",
169 "counterpartyType": [
170 "ENTITY"
171 ],
172 "foreignId": "MY-DB-ID-90909",
173 "paymentMethods": [
174 {
175 "type": "bankAccount",
176 "accountName": "Vendor Checking Account",
177 "accountNumber": "55934059697648",
178 "accountType": "CHECKING",
179 "bankName": "Chase",
180 "createdAt": "2021-01-01T00:00:00Z",
181 "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
182 "isDefaultDestination": true,
183 "isDefaultSource": true,
184 "routingNumber": "66554433",
185 "status": "NEW",
186 "supportedCurrencies": [
187 "USD"
188 ],
189 "updatedAt": "2021-01-01T00:00:00Z"
190 }
191 ]
192 },
193 "paymentDestination": {
194 "type": "check",
195 "addressLine1": "123 Main St",
196 "city": "New York",
197 "country": "US",
198 "createdAt": "2021-01-01T00:00:00Z",
199 "id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
200 "isDefaultDestination": true,
201 "isDefaultSource": false,
202 "payToTheOrderOf": "John Doe",
203 "postalCode": "10001",
204 "stateOrProvince": "NY",
205 "supportedCurrencies": [
206 "USD"
207 ],
208 "updatedAt": "2021-01-01T00:00:00Z",
209 "addressLine2": "Apt 1"
210 },
211 "paymentDestinationId": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
212 "paymentDestinationOptions": {
213 "type": "check",
214 "delivery": "MAIL"
215 },
216 "comments": [
217 {
218 "id": "ic_b3525b66-da94-4525-9f31-426bcf657128",
219 "text": "This is an approval comment",
220 "createdAt": "2021-01-01T00:00:00Z",
221 "updatedAt": "2021-01-01T00:00:00Z",
222 "user": {
223 "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
224 "roles": [
225 "admin",
226 "approver"
227 ],
228 "createdAt": "2024-01-01T00:00:00Z",
229 "updatedAt": "2024-01-01T00:00:00Z",
230 "foreignId": "MY-DB-ID-12345",
231 "email": "john.doe@acme.com",
232 "name": "John Doe"
233 },
234 "associatedApprovalAction": {
235 "userId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506",
236 "action": "APPROVE"
237 }
238 }
239 ],
240 "lineItems": [
241 {
242 "id": "inli_26672f38-eb9a-48f1-a7a0-f1b855e38cd7",
243 "currency": "USD",
244 "createdAt": "2021-01-01T00:00:00Z",
245 "updatedAt": "2021-01-01T00:00:00Z",
246 "amount": 100,
247 "description": "Product A",
248 "name": "Product A",
249 "quantity": 1,
250 "unitPrice": 100,
251 "serviceStartDate": "2021-01-01T00:00:00Z",
252 "serviceEndDate": "2021-01-31T00:00:00Z",
253 "metadata": {
254 "key1": "value1",
255 "key2": "value2"
256 },
257 "glAccountId": "600394"
258 }
259 ],
260 "foreignId": "YOUR-DATABASE-ID",
261 "creatorUser": {
262 "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
263 "roles": [
264 "admin",
265 "approver"
266 ],
267 "createdAt": "2024-01-01T00:00:00Z",
268 "updatedAt": "2024-01-01T00:00:00Z",
269 "foreignId": "MY-DB-ID-12345",
270 "email": "john.doe@acme.com",
271 "name": "John Doe"
272 }
273 },
274 "user": {
275 "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
276 "roles": [
277 "admin",
278 "approver"
279 ],
280 "createdAt": "2024-01-01T00:00:00Z",
281 "updatedAt": "2024-01-01T00:00:00Z",
282 "foreignId": "MY-DB-ID-12345",
283 "email": "john.doe@acme.com",
284 "name": "John Doe"
285 }
286}