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 "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 }
90 ]
91 },
92 "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
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 "vendor": {
114 "acceptedTos": false,
115 "accountType": "business",
116 "createdAt": "2024-01-01T00:00:00Z",
117 "email": "vendor@bigboxstore.com",
118 "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
119 "isCustomer": false,
120 "isNetworkPayee": false,
121 "isNetworkPayor": false,
122 "isPayee": true,
123 "isPayor": false,
124 "name": "Big Box Store",
125 "profile": {
126 "business": {
127 "legalBusinessName": "Big Box Store",
128 "taxIDProvided": false,
129 "email": "vendor@bigboxstore.com",
130 "businessType": "publicCorporation",
131 "ownersProvided": false
132 }
133 },
134 "status": "unverified",
135 "updatedAt": "2024-01-02T00:00:00Z",
136 "counterpartyType": [
137 "ENTITY"
138 ],
139 "foreignId": "MY-DB-ID-90909",
140 "paymentMethods": [
141 {
142 "type": "bankAccount",
143 "accountName": "Vendor Checking Account",
144 "accountNumber": "55934059697648",
145 "accountType": "CHECKING",
146 "bankName": "Chase",
147 "createdAt": "2021-01-01T00:00:00Z",
148 "frozen": false,
149 "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
150 "isDefaultDestination": true,
151 "isDefaultSource": true,
152 "metadata": {},
153 "routingNumber": "66554433",
154 "status": "NEW",
155 "supportedCurrencies": [
156 "USD"
157 ],
158 "updatedAt": "2021-01-01T00:00:00Z"
159 }
160 ]
161 },
162 "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d"
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}