Invoice Status Scheduled

An invoice’s status was changed to scheduled

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.status.scheduled",
3 "invoice": {
4 "id": "inv_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
5 "status": "SCHEDULED",
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 "deductionDate": "2021-01-29T00:00:00Z",
18 "dueDate": "2021-01-31T00:00:00Z",
19 "invoiceNumber": "INV-123",
20 "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
21 "payer": {
22 "acceptedTos": true,
23 "accountType": "business",
24 "createdAt": "2024-01-01T00:00:00Z",
25 "email": "customer@acme.com",
26 "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
27 "isCustomer": true,
28 "isNetworkPayee": false,
29 "isNetworkPayor": false,
30 "isPayee": false,
31 "isPayor": true,
32 "name": "Acme Inc.",
33 "profile": {
34 "business": {
35 "legalBusinessName": "Acme Inc.",
36 "taxIDProvided": true,
37 "email": "customer@acme.com",
38 "businessType": "llc",
39 "phone": {
40 "countryCode": "1",
41 "number": "4155551234"
42 },
43 "address": {
44 "addressLine1": "123 Main St",
45 "city": "San Francisco",
46 "stateOrProvince": "CA",
47 "postalCode": "94105",
48 "addressLine2": "Unit 1",
49 "country": "US"
50 },
51 "ownersProvided": true,
52 "taxId": {
53 "ein": {
54 "number": "12-3456789"
55 }
56 }
57 }
58 },
59 "status": "verified",
60 "updatedAt": "2024-01-02T00:00:00Z",
61 "accounts": [
62 {
63 "accountId": "85866843",
64 "postalCode": "94105",
65 "nameOnAccount": "John Doe"
66 }
67 ],
68 "counterpartyType": [
69 "ENTITY"
70 ],
71 "foreignId": "MY-DB-ID-12345",
72 "paymentMethods": [
73 {
74 "type": "bankAccount",
75 "accountName": "My Checking Account",
76 "accountNumber": "99988767623",
77 "accountType": "CHECKING",
78 "bankName": "Chase",
79 "createdAt": "2021-01-01T00:00:00Z",
80 "frozen": false,
81 "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
82 "isDefaultDestination": true,
83 "isDefaultSource": true,
84 "metadata": {},
85 "routingNumber": "12345678",
86 "status": "VERIFIED",
87 "supportedCurrencies": [
88 "USD"
89 ],
90 "updatedAt": "2021-01-01T00:00:00Z"
91 }
92 ]
93 },
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 },
113 "paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
114 "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
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 }
162 ]
163 },
164 "paymentDestination": {
165 "type": "check",
166 "addressLine1": "123 Main St",
167 "city": "New York",
168 "country": "US",
169 "createdAt": "2021-01-01T00:00:00Z",
170 "frozen": false,
171 "id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
172 "isDefaultDestination": true,
173 "isDefaultSource": false,
174 "metadata": {},
175 "payToTheOrderOf": "John Doe",
176 "postalCode": "10001",
177 "stateOrProvince": "NY",
178 "supportedCurrencies": [
179 "USD"
180 ],
181 "updatedAt": "2021-01-01T00:00:00Z",
182 "addressLine2": "Apt 1"
183 },
184 "paymentDestinationId": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18"
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}