Logo
Sign inBook a demo
HomeGuidesAPI ReferenceGlossary
HomeGuidesAPI ReferenceGlossary
  • API Reference
Sign inBook a demo
API ReferenceWebhooks

Invoice Status Changed

An invoice's status was changed

Payload

The payload of this webhook request is an object.
eventTypestringRequired
The type of the event.
invoiceobjectRequired
The invoice involved in the event.
newStatusstringRequired
The new status of the invoice.
previousStatusstringRequired
The previous status of the invoice.
userobjectOptional
User who initiated the change.

Response

200
any
Return a 200 status to indicate that the data was received successfully.
Was this page helpful?
Previous

Incoming Invoice Email

Next
Built with
Payload
1{
2 "eventType": "invoice.status.changed",
3 "invoice": {
4 "approvalPolicy": [],
5 "approvers": [],
6 "createdAt": "2021-01-01T00:00:00Z",
7 "hasDocuments": true,
8 "hasSourceEmail": true,
9 "id": "in_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
10 "metadata": {},
11 "paymentDestinationConfirmed": true,
12 "status": "NEW",
13 "updatedAt": "2021-01-01T00:00:00Z",
14 "amount": 100,
15 "currency": "USD",
16 "dueDate": "2021-01-31T00:00:00Z",
17 "invoiceDate": "2021-01-01T00:00:00Z",
18 "invoiceNumber": "INV-123",
19 "payer": {
20 "acceptedTos": true,
21 "accountType": "business",
22 "createdAt": "2024-01-01T00:00:00Z",
23 "email": "customer@acme.com",
24 "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
25 "isCustomer": true,
26 "isNetworkPayee": false,
27 "isNetworkPayor": false,
28 "isPayee": false,
29 "isPayor": true,
30 "name": "Acme Inc.",
31 "profile": {
32 "business": {
33 "legalBusinessName": "Acme Inc.",
34 "taxIDProvided": true,
35 "email": "customer@acme.com",
36 "businessType": "llc",
37 "phone": {
38 "countryCode": "1",
39 "number": "4155551234"
40 },
41 "address": {
42 "addressLine1": "123 Main St",
43 "city": "San Francisco",
44 "stateOrProvince": "CA",
45 "postalCode": "94105",
46 "addressLine2": "Unit 1",
47 "country": "US"
48 },
49 "ownersProvided": true,
50 "taxId": {
51 "ein": {
52 "number": "12-3456789"
53 }
54 }
55 }
56 },
57 "status": "verified",
58 "updatedAt": "2024-01-02T00:00:00Z",
59 "accounts": [
60 {
61 "accountId": "85866843",
62 "postalCode": "94105",
63 "nameOnAccount": "John Doe"
64 }
65 ],
66 "counterpartyType": [
67 "ENTITY"
68 ],
69 "foreignId": "MY-DB-ID-12345",
70 "paymentMethods": [
71 {
72 "type": "bankAccount",
73 "accountName": "My Checking Account",
74 "accountNumber": "99988767623",
75 "accountType": "CHECKING",
76 "bankName": "Chase",
77 "createdAt": "2021-01-01T00:00:00Z",
78 "frozen": false,
79 "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
80 "isDefaultDestination": true,
81 "isDefaultSource": true,
82 "metadata": {},
83 "routingNumber": "12345678",
84 "status": "VERIFIED",
85 "supportedCurrencies": [
86 "USD"
87 ],
88 "updatedAt": "2021-01-01T00:00:00Z",
89 "confirmedByEntity": true
90 }
91 ]
92 },
93 "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
94 "paymentSource": {
95 "type": "bankAccount",
96 "accountName": "My Checking Account",
97 "accountNumber": "99988767623",
98 "accountType": "CHECKING",
99 "bankName": "Chase",
100 "createdAt": "2021-01-01T00:00:00Z",
101 "frozen": false,
102 "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
103 "isDefaultDestination": true,
104 "isDefaultSource": true,
105 "metadata": {},
106 "routingNumber": "12345678",
107 "status": "VERIFIED",
108 "supportedCurrencies": [
109 "USD"
110 ],
111 "updatedAt": "2021-01-01T00:00:00Z",
112 "confirmedByEntity": true
113 },
114 "paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
115 "vendor": {
116 "acceptedTos": false,
117 "accountType": "business",
118 "createdAt": "2024-01-01T00:00:00Z",
119 "email": "vendor@bigboxstore.com",
120 "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
121 "isCustomer": false,
122 "isNetworkPayee": false,
123 "isNetworkPayor": false,
124 "isPayee": true,
125 "isPayor": false,
126 "name": "Big Box Store",
127 "profile": {
128 "business": {
129 "legalBusinessName": "Big Box Store",
130 "taxIDProvided": false,
131 "email": "vendor@bigboxstore.com",
132 "businessType": "publicCorporation",
133 "ownersProvided": false
134 }
135 },
136 "status": "unverified",
137 "updatedAt": "2024-01-02T00:00:00Z",
138 "counterpartyType": [
139 "ENTITY"
140 ],
141 "foreignId": "MY-DB-ID-90909",
142 "paymentMethods": [
143 {
144 "type": "bankAccount",
145 "accountName": "Vendor Checking Account",
146 "accountNumber": "55934059697648",
147 "accountType": "CHECKING",
148 "bankName": "Chase",
149 "createdAt": "2021-01-01T00:00:00Z",
150 "frozen": false,
151 "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
152 "isDefaultDestination": true,
153 "isDefaultSource": true,
154 "metadata": {},
155 "routingNumber": "66554433",
156 "status": "NEW",
157 "supportedCurrencies": [
158 "USD"
159 ],
160 "updatedAt": "2021-01-01T00:00:00Z",
161 "confirmedByEntity": false
162 }
163 ]
164 },
165 "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
166 },
167 "newStatus": "new",
168 "previousStatus": "draft",
169 "user": {
170 "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
171 "roles": [
172 "admin",
173 "approver"
174 ],
175 "createdAt": "2024-01-01T00:00:00Z",
176 "updatedAt": "2024-01-01T00:00:00Z",
177 "foreignId": "MY-DB-ID-12345",
178 "email": "john.doe@acme.com",
179 "name": "John Doe"
180 }
181}