Invoice Status Changed

An invoice's status was changed

Payload

The payload of this webhook request is an object.
eventType
stringRequired
invoice
objectRequired
newStatus
stringRequired
previousStatus
stringRequired
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.status.changed",
3 "invoice": {
4 "id": "inv_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
5 "status": "NEW",
6 "paymentDestinationConfirmed": true,
7 "hasDocuments": true,
8 "hasSourceEmail": true,
9 "approvers": [],
10 "approvalPolicy": [],
11 "metadata": {},
12 "createdAt": "2021-01-01T00:00:00Z",
13 "updatedAt": "2021-01-01T00:00:00Z",
14 "amount": 100,
15 "currency": "USD",
16 "invoiceDate": "2021-01-01T00:00:00Z",
17 "dueDate": "2021-01-31T00:00:00Z",
18 "invoiceNumber": "INV-123",
19 "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
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 }
52 },
53 "status": "verified",
54 "updatedAt": "2024-01-02T00:00:00Z",
55 "counterpartyType": [
56 "ENTITY"
57 ],
58 "foreignId": "MY-DB-ID-12345",
59 "paymentMethods": [
60 {
61 "type": "bankAccount",
62 "accountName": "My Checking Account",
63 "accountNumber": "99988767623",
64 "accountType": "CHECKING",
65 "bankName": "Chase",
66 "createdAt": "2021-01-01T00:00:00Z",
67 "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
68 "isDefaultDestination": true,
69 "isDefaultSource": true,
70 "routingNumber": "12345678",
71 "status": "VERIFIED",
72 "supportedCurrencies": [
73 "USD"
74 ],
75 "updatedAt": "2021-01-01T00:00:00Z"
76 }
77 ]
78 },
79 "paymentSource": {
80 "type": "bankAccount",
81 "accountName": "My Checking Account",
82 "accountNumber": "99988767623",
83 "accountType": "CHECKING",
84 "bankName": "Chase",
85 "createdAt": "2021-01-01T00:00:00Z",
86 "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
87 "isDefaultDestination": true,
88 "isDefaultSource": true,
89 "routingNumber": "12345678",
90 "status": "VERIFIED",
91 "supportedCurrencies": [
92 "USD"
93 ],
94 "updatedAt": "2021-01-01T00:00:00Z"
95 },
96 "paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
97 "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
98 "vendor": {
99 "acceptedTos": false,
100 "accountType": "business",
101 "createdAt": "2024-01-01T00:00:00Z",
102 "email": "vendor@bigboxstore.com",
103 "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
104 "isCustomer": false,
105 "isNetworkPayee": false,
106 "isNetworkPayor": false,
107 "isPayee": true,
108 "isPayor": false,
109 "name": "Big Box Store",
110 "profile": {
111 "business": {
112 "legalBusinessName": "Big Box Store",
113 "taxIDProvided": false,
114 "email": "vendor@bigboxstore.com",
115 "businessType": "publicCorporation",
116 "ownersProvided": false
117 }
118 },
119 "status": "unverified",
120 "updatedAt": "2024-01-02T00:00:00Z",
121 "counterpartyType": [
122 "ENTITY"
123 ],
124 "foreignId": "MY-DB-ID-90909",
125 "paymentMethods": [
126 {
127 "type": "bankAccount",
128 "accountName": "Vendor Checking Account",
129 "accountNumber": "55934059697648",
130 "accountType": "CHECKING",
131 "bankName": "Chase",
132 "createdAt": "2021-01-01T00:00:00Z",
133 "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
134 "isDefaultDestination": true,
135 "isDefaultSource": true,
136 "routingNumber": "66554433",
137 "status": "NEW",
138 "supportedCurrencies": [
139 "USD"
140 ],
141 "updatedAt": "2021-01-01T00:00:00Z"
142 }
143 ]
144 }
145 },
146 "newStatus": "new",
147 "previousStatus": "draft",
148 "user": {
149 "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
150 "roles": [
151 "admin",
152 "approver"
153 ],
154 "createdAt": "2024-01-01T00:00:00Z",
155 "updatedAt": "2024-01-01T00:00:00Z",
156 "foreignId": "MY-DB-ID-12345",
157 "email": "john.doe@acme.com",
158 "name": "John Doe"
159 }
160}