Invoice Status Changed

An invoice's status was changed

Payload

The payload of this webhook request is an object.
eventTypestringRequired
invoiceobjectRequired
newStatusstringRequired
previousStatusstringRequired
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.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 "accounts": [
56 {
57 "accountId": "85866843",
58 "postalCode": "94105",
59 "nameOnAccount": "John Doe"
60 }
61 ],
62 "counterpartyType": [
63 "ENTITY"
64 ],
65 "foreignId": "MY-DB-ID-12345",
66 "paymentMethods": [
67 {
68 "type": "bankAccount",
69 "accountName": "My Checking Account",
70 "accountNumber": "99988767623",
71 "accountType": "CHECKING",
72 "bankName": "Chase",
73 "createdAt": "2021-01-01T00:00:00Z",
74 "frozen": false,
75 "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
76 "isDefaultDestination": true,
77 "isDefaultSource": true,
78 "metadata": {},
79 "routingNumber": "12345678",
80 "status": "VERIFIED",
81 "supportedCurrencies": [
82 "USD"
83 ],
84 "updatedAt": "2021-01-01T00:00:00Z"
85 }
86 ]
87 },
88 "paymentSource": {
89 "type": "bankAccount",
90 "accountName": "My Checking Account",
91 "accountNumber": "99988767623",
92 "accountType": "CHECKING",
93 "bankName": "Chase",
94 "createdAt": "2021-01-01T00:00:00Z",
95 "frozen": false,
96 "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
97 "isDefaultDestination": true,
98 "isDefaultSource": true,
99 "metadata": {},
100 "routingNumber": "12345678",
101 "status": "VERIFIED",
102 "supportedCurrencies": [
103 "USD"
104 ],
105 "updatedAt": "2021-01-01T00:00:00Z"
106 },
107 "paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
108 "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
109 "vendor": {
110 "acceptedTos": false,
111 "accountType": "business",
112 "createdAt": "2024-01-01T00:00:00Z",
113 "email": "vendor@bigboxstore.com",
114 "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
115 "isCustomer": false,
116 "isNetworkPayee": false,
117 "isNetworkPayor": false,
118 "isPayee": true,
119 "isPayor": false,
120 "name": "Big Box Store",
121 "profile": {
122 "business": {
123 "legalBusinessName": "Big Box Store",
124 "taxIDProvided": false,
125 "email": "vendor@bigboxstore.com",
126 "businessType": "publicCorporation",
127 "ownersProvided": false
128 }
129 },
130 "status": "unverified",
131 "updatedAt": "2024-01-02T00:00:00Z",
132 "counterpartyType": [
133 "ENTITY"
134 ],
135 "foreignId": "MY-DB-ID-90909",
136 "paymentMethods": [
137 {
138 "type": "bankAccount",
139 "accountName": "Vendor Checking Account",
140 "accountNumber": "55934059697648",
141 "accountType": "CHECKING",
142 "bankName": "Chase",
143 "createdAt": "2021-01-01T00:00:00Z",
144 "frozen": false,
145 "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
146 "isDefaultDestination": true,
147 "isDefaultSource": true,
148 "metadata": {},
149 "routingNumber": "66554433",
150 "status": "NEW",
151 "supportedCurrencies": [
152 "USD"
153 ],
154 "updatedAt": "2021-01-01T00:00:00Z"
155 }
156 ]
157 }
158 },
159 "newStatus": "new",
160 "previousStatus": "draft",
161 "user": {
162 "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
163 "roles": [
164 "admin",
165 "approver"
166 ],
167 "createdAt": "2024-01-01T00:00:00Z",
168 "updatedAt": "2024-01-01T00:00:00Z",
169 "foreignId": "MY-DB-ID-12345",
170 "email": "john.doe@acme.com",
171 "name": "John Doe"
172 }
173}