Invoice Status New

An invoice’s status was changed to new

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.new",
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 "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 "paymentSource": {
94 "type": "bankAccount",
95 "accountName": "My Checking Account",
96 "accountNumber": "99988767623",
97 "accountType": "CHECKING",
98 "bankName": "Chase",
99 "createdAt": "2021-01-01T00:00:00Z",
100 "frozen": false,
101 "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
102 "isDefaultDestination": true,
103 "isDefaultSource": true,
104 "metadata": {},
105 "routingNumber": "12345678",
106 "status": "VERIFIED",
107 "supportedCurrencies": [
108 "USD"
109 ],
110 "updatedAt": "2021-01-01T00:00:00Z"
111 },
112 "paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
113 "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
114 "vendor": {
115 "acceptedTos": false,
116 "accountType": "business",
117 "createdAt": "2024-01-01T00:00:00Z",
118 "email": "vendor@bigboxstore.com",
119 "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
120 "isCustomer": false,
121 "isNetworkPayee": false,
122 "isNetworkPayor": false,
123 "isPayee": true,
124 "isPayor": false,
125 "name": "Big Box Store",
126 "profile": {
127 "business": {
128 "legalBusinessName": "Big Box Store",
129 "taxIDProvided": false,
130 "email": "vendor@bigboxstore.com",
131 "businessType": "publicCorporation",
132 "ownersProvided": false
133 }
134 },
135 "status": "unverified",
136 "updatedAt": "2024-01-02T00:00:00Z",
137 "counterpartyType": [
138 "ENTITY"
139 ],
140 "foreignId": "MY-DB-ID-90909",
141 "paymentMethods": [
142 {
143 "type": "bankAccount",
144 "accountName": "Vendor Checking Account",
145 "accountNumber": "55934059697648",
146 "accountType": "CHECKING",
147 "bankName": "Chase",
148 "createdAt": "2021-01-01T00:00:00Z",
149 "frozen": false,
150 "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
151 "isDefaultDestination": true,
152 "isDefaultSource": true,
153 "metadata": {},
154 "routingNumber": "66554433",
155 "status": "NEW",
156 "supportedCurrencies": [
157 "USD"
158 ],
159 "updatedAt": "2021-01-01T00:00:00Z"
160 }
161 ]
162 }
163 },
164 "user": {
165 "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
166 "roles": [
167 "admin",
168 "approver"
169 ],
170 "createdAt": "2024-01-01T00:00:00Z",
171 "updatedAt": "2024-01-01T00:00:00Z",
172 "foreignId": "MY-DB-ID-12345",
173 "email": "john.doe@acme.com",
174 "name": "John Doe"
175 }
176}