Invoice Updated

An invoice was updated

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.
Payload
1{
2  "eventType": "invoice.updated",
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      "accounts": [
104        {
105          "accountId": "85866843",
106          "postalCode": "94105",
107          "nameOnAccount": "John Doe"
108        }
109      ],
110      "counterpartyType": [
111        "ENTITY"
112      ],
113      "foreignId": "MY-DB-ID-12345",
114      "paymentMethods": [
115        {
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      ]
135    },
136    "paymentSource": {
137      "type": "bankAccount",
138      "accountName": "My Checking Account",
139      "accountNumber": "99988767623",
140      "accountType": "CHECKING",
141      "bankName": "Chase",
142      "createdAt": "2021-01-01T00:00:00Z",
143      "frozen": false,
144      "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
145      "isDefaultDestination": true,
146      "isDefaultSource": true,
147      "metadata": {},
148      "routingNumber": "12345678",
149      "status": "VERIFIED",
150      "supportedCurrencies": [
151        "USD"
152      ],
153      "updatedAt": "2021-01-01T00:00:00Z"
154    },
155    "paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
156    "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
157    "vendor": {
158      "acceptedTos": false,
159      "accountType": "business",
160      "createdAt": "2024-01-01T00:00:00Z",
161      "email": "vendor@bigboxstore.com",
162      "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
163      "isCustomer": false,
164      "isNetworkPayee": false,
165      "isNetworkPayor": false,
166      "isPayee": true,
167      "isPayor": false,
168      "name": "Big Box Store",
169      "profile": {
170        "business": {
171          "legalBusinessName": "Big Box Store",
172          "taxIDProvided": false,
173          "email": "vendor@bigboxstore.com",
174          "businessType": "publicCorporation",
175          "ownersProvided": false
176        }
177      },
178      "status": "unverified",
179      "updatedAt": "2024-01-02T00:00:00Z",
180      "counterpartyType": [
181        "ENTITY"
182      ],
183      "foreignId": "MY-DB-ID-90909",
184      "paymentMethods": [
185        {
186          "type": "bankAccount",
187          "accountName": "Vendor Checking Account",
188          "accountNumber": "55934059697648",
189          "accountType": "CHECKING",
190          "bankName": "Chase",
191          "createdAt": "2021-01-01T00:00:00Z",
192          "frozen": false,
193          "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
194          "isDefaultDestination": true,
195          "isDefaultSource": true,
196          "metadata": {},
197          "routingNumber": "66554433",
198          "status": "NEW",
199          "supportedCurrencies": [
200            "USD"
201          ],
202          "updatedAt": "2021-01-01T00:00:00Z"
203        }
204      ]
205    },
206    "paymentDestination": {
207      "type": "check",
208      "addressLine1": "123 Main St",
209      "city": "New York",
210      "country": "US",
211      "createdAt": "2021-01-01T00:00:00Z",
212      "frozen": false,
213      "id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
214      "isDefaultDestination": true,
215      "isDefaultSource": false,
216      "metadata": {},
217      "payToTheOrderOf": "John Doe",
218      "postalCode": "10001",
219      "stateOrProvince": "NY",
220      "supportedCurrencies": [
221        "USD"
222      ],
223      "updatedAt": "2021-01-01T00:00:00Z",
224      "addressLine2": "Apt 1"
225    },
226    "paymentDestinationId": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
227    "paymentDestinationOptions": {
228      "type": "check",
229      "delivery": "MAIL"
230    },
231    "comments": [
232      {
233        "id": "ic_b3525b66-da94-4525-9f31-426bcf657128",
234        "text": "This is an approval comment",
235        "createdAt": "2021-01-01T00:00:00Z",
236        "updatedAt": "2021-01-01T00:00:00Z",
237        "user": {
238          "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
239          "roles": [
240            "admin",
241            "approver"
242          ],
243          "createdAt": "2024-01-01T00:00:00Z",
244          "updatedAt": "2024-01-01T00:00:00Z",
245          "foreignId": "MY-DB-ID-12345",
246          "email": "john.doe@acme.com",
247          "name": "John Doe"
248        },
249        "associatedApprovalAction": {
250          "userId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506",
251          "action": "APPROVE"
252        }
253      }
254    ],
255    "lineItems": [
256      {
257        "id": "inli_26672f38-eb9a-48f1-a7a0-f1b855e38cd7",
258        "currency": "USD",
259        "category": "EXPENSE",
260        "createdAt": "2021-01-01T00:00:00Z",
261        "updatedAt": "2021-01-01T00:00:00Z",
262        "amount": 100,
263        "description": "Product A",
264        "name": "Product A",
265        "quantity": 1,
266        "unitPrice": 100,
267        "serviceStartDate": "2021-01-01T00:00:00Z",
268        "serviceEndDate": "2021-01-31T00:00:00Z",
269        "metadata": {
270          "key1": "value1",
271          "key2": "value2"
272        },
273        "glAccountId": "600394"
274      }
275    ],
276    "foreignId": "YOUR-DATABASE-ID",
277    "creatorUser": {
278      "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
279      "roles": [
280        "admin",
281        "approver"
282      ],
283      "createdAt": "2024-01-01T00:00:00Z",
284      "updatedAt": "2024-01-01T00:00:00Z",
285      "foreignId": "MY-DB-ID-12345",
286      "email": "john.doe@acme.com",
287      "name": "John Doe"
288    }
289  },
290  "user": {
291    "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
292    "roles": [
293      "admin",
294      "approver"
295    ],
296    "createdAt": "2024-01-01T00:00:00Z",
297    "updatedAt": "2024-01-01T00:00:00Z",
298    "foreignId": "MY-DB-ID-12345",
299    "email": "john.doe@acme.com",
300    "name": "John Doe"
301  }
302}
Built with