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