Invoice Status Canceled

Payload
1 {
2   "eventType": "invoice.status.canceled",
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": "CANCELED",
13     "updatedAt": "2021-01-01T00:00:00Z",
14     "amount": 100,
15     "currency": "USD",
16     "deductionDate": "2021-01-29T00:00:00Z",
17     "dueDate": "2021-01-31T00:00:00Z",
18     "invoiceDate": "2021-01-01T00:00:00Z",
19     "invoiceNumber": "INV-123",
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           "taxId": {
52             "ein": {
53               "number": "12-3456789"
54             }
55           }
56         }
57       },
58       "status": "verified",
59       "updatedAt": "2024-01-02T00:00:00Z",
60       "accounts": [
61         {
62           "accountId": "85866843",
63           "postalCode": "94105",
64           "nameOnAccount": "John Doe"
65         }
66       ],
67       "counterpartyType": [
68         "ENTITY"
69       ],
70       "foreignId": "MY-DB-ID-12345",
71       "paymentMethods": [
72         {
73           "type": "bankAccount",
74           "accountName": "My Checking Account",
75           "accountNumber": "99988767623",
76           "accountType": "CHECKING",
77           "bankName": "Chase",
78           "createdAt": "2021-01-01T00:00:00Z",
79           "frozen": false,
80           "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
81           "isDefaultDestination": true,
82           "isDefaultSource": true,
83           "metadata": {},
84           "routingNumber": "12345678",
85           "status": "VERIFIED",
86           "supportedCurrencies": [
87             "USD"
88           ],
89           "updatedAt": "2021-01-01T00:00:00Z"
90         }
91       ]
92     },
93     "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
94     "paymentDestination": {
95       "type": "check",
96       "addressLine1": "123 Main St",
97       "city": "New York",
98       "country": "US",
99       "createdAt": "2021-01-01T00:00:00Z",
100       "frozen": false,
101       "id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
102       "isDefaultDestination": true,
103       "isDefaultSource": false,
104       "metadata": {},
105       "payToTheOrderOf": "John Doe",
106       "postalCode": "10001",
107       "stateOrProvince": "NY",
108       "supportedCurrencies": [
109         "USD"
110       ],
111       "updatedAt": "2021-01-01T00:00:00Z",
112       "addressLine2": "Apt 1"
113     },
114     "paymentDestinationId": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
115     "paymentSource": {
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     "paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
135     "vendor": {
136       "acceptedTos": false,
137       "accountType": "business",
138       "createdAt": "2024-01-01T00:00:00Z",
139       "email": "vendor@bigboxstore.com",
140       "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
141       "isCustomer": false,
142       "isNetworkPayee": false,
143       "isNetworkPayor": false,
144       "isPayee": true,
145       "isPayor": false,
146       "name": "Big Box Store",
147       "profile": {
148         "business": {
149           "legalBusinessName": "Big Box Store",
150           "taxIDProvided": false,
151           "email": "vendor@bigboxstore.com",
152           "businessType": "publicCorporation",
153           "ownersProvided": false
154         }
155       },
156       "status": "unverified",
157       "updatedAt": "2024-01-02T00:00:00Z",
158       "counterpartyType": [
159         "ENTITY"
160       ],
161       "foreignId": "MY-DB-ID-90909",
162       "paymentMethods": [
163         {
164           "type": "bankAccount",
165           "accountName": "Vendor Checking Account",
166           "accountNumber": "55934059697648",
167           "accountType": "CHECKING",
168           "bankName": "Chase",
169           "createdAt": "2021-01-01T00:00:00Z",
170           "frozen": false,
171           "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
172           "isDefaultDestination": true,
173           "isDefaultSource": true,
174           "metadata": {},
175           "routingNumber": "66554433",
176           "status": "NEW",
177           "supportedCurrencies": [
178             "USD"
179           ],
180           "updatedAt": "2021-01-01T00:00:00Z"
181         }
182       ]
183     },
184     "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
185   },
186   "user": {
187     "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
188     "roles": [
189       "admin",
190       "approver"
191     ],
192     "createdAt": "2024-01-01T00:00:00Z",
193     "updatedAt": "2024-01-01T00:00:00Z",
194     "foreignId": "MY-DB-ID-12345",
195     "email": "john.doe@acme.com",
196     "name": "John Doe"
197   }
198 }
An invoice’s status was changed to canceled
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.