Invoice Status Archived

An invoice's status was changed to archived

Payload

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