Incoming Invoice Email

1
{
2
  "eventType": "invoice.email",
3
  "invoice": {
4
    "id": "inv_26e7b5d3-a739-4b23-9ad9-6aaa085f47a9",
5
    "status": "PAID",
6
    "paymentDestinationConfirmed": true,
7
    "hasDocuments": true,
8
    "hasSourceEmail": true,
9
    "approvers": [
10
      {
11
        "approvalPolicyId": "apvl_5ce50275-1789-42ea-bc60-bb7e6d03635c",
12
        "approvalSlotId": "inap_9bb311c9-7c15-4c9e-8148-63814e0abec6",
13
        "action": "APPROVE",
14
        "eligibleRoles": [
15
          "admin"
16
        ],
17
        "eligibleUserIds": [
18
          "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
19
        ],
20
        "date": "2021-01-01T00:00:00Z",
21
        "assignedUserId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506"
22
      }
23
    ],
24
    "approvalPolicy": [
25
      {
26
        "id": "apvl_8545a84e-a45f-41bf-bdf1-33b42a55812c",
27
        "trigger": [
28
          {
29
            "type": "amount",
30
            "amount": 100,
31
            "currency": "USD"
32
          }
33
        ],
34
        "rule": {
35
          "type": "approver",
36
          "identifierList": {
37
            "type": "rolesList",
38
            "value": [
39
              "Admin",
40
              "Controller"
41
            ]
42
          },
43
          "numApprovers": 2
44
        },
45
        "upstreamPolicyId": "root",
46
        "createdAt": "2024-01-01T00:00:00Z",
47
        "updatedAt": "2024-01-02T00:00:00Z"
48
      }
49
    ],
50
    "metadata": {
51
      "key1": "value1",
52
      "key2": "value2"
53
    },
54
    "createdAt": "2021-01-01T00:00:00Z",
55
    "updatedAt": "2021-01-01T00:00:00Z",
56
    "amount": 100,
57
    "currency": "USD",
58
    "invoiceDate": "2021-01-01T00:00:00Z",
59
    "deductionDate": "2021-01-01T00:00:00Z",
60
    "processedAt": "2021-01-01T00:00:00Z",
61
    "settlementDate": "2021-01-03T00:00:00Z",
62
    "dueDate": "2021-01-31T00:00:00Z",
63
    "invoiceNumber": "INV-123",
64
    "noteToSelf": "For the month of January",
65
    "serviceStartDate": "2021-01-01T00:00:00Z",
66
    "serviceEndDate": "2021-01-31T00:00:00Z",
67
    "payerId": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
68
    "payer": {
69
      "acceptedTos": true,
70
      "accountType": "business",
71
      "createdAt": "2024-01-01T00:00:00Z",
72
      "email": "customer@acme.com",
73
      "id": "ent_8545a84e-a45f-41bf-bdf1-33b42a55812c",
74
      "isCustomer": true,
75
      "isNetworkPayee": false,
76
      "isNetworkPayor": false,
77
      "isPayee": false,
78
      "isPayor": true,
79
      "name": "Acme Inc.",
80
      "profile": {
81
        "business": {
82
          "legalBusinessName": "Acme Inc.",
83
          "taxIDProvided": true,
84
          "email": "customer@acme.com",
85
          "businessType": "llc",
86
          "phone": {
87
            "countryCode": "1",
88
            "number": "4155551234"
89
          },
90
          "address": {
91
            "addressLine1": "123 Main St",
92
            "city": "San Francisco",
93
            "stateOrProvince": "CA",
94
            "postalCode": "94105",
95
            "addressLine2": "Unit 1",
96
            "country": "US"
97
          },
98
          "ownersProvided": true,
99
          "taxId": {
100
            "ein": {
101
              "number": "12-3456789"
102
            }
103
          }
104
        }
105
      },
106
      "status": "verified",
107
      "updatedAt": "2024-01-02T00:00:00Z",
108
      "accounts": [
109
        {
110
          "accountId": "85866843",
111
          "postalCode": "94105",
112
          "nameOnAccount": "John Doe"
113
        }
114
      ],
115
      "counterpartyType": [
116
        "ENTITY"
117
      ],
118
      "foreignId": "MY-DB-ID-12345",
119
      "paymentMethods": [
120
        {
121
          "type": "bankAccount",
122
          "accountName": "My Checking Account",
123
          "accountNumber": "99988767623",
124
          "accountType": "CHECKING",
125
          "bankName": "Chase",
126
          "createdAt": "2021-01-01T00:00:00Z",
127
          "frozen": false,
128
          "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
129
          "isDefaultDestination": true,
130
          "isDefaultSource": true,
131
          "metadata": {},
132
          "routingNumber": "12345678",
133
          "status": "VERIFIED",
134
          "supportedCurrencies": [
135
            "USD"
136
          ],
137
          "updatedAt": "2021-01-01T00:00:00Z"
138
        }
139
      ]
140
    },
141
    "paymentSource": {
142
      "type": "bankAccount",
143
      "accountName": "My Checking Account",
144
      "accountNumber": "99988767623",
145
      "accountType": "CHECKING",
146
      "bankName": "Chase",
147
      "createdAt": "2021-01-01T00:00:00Z",
148
      "frozen": false,
149
      "id": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
150
      "isDefaultDestination": true,
151
      "isDefaultSource": true,
152
      "metadata": {},
153
      "routingNumber": "12345678",
154
      "status": "VERIFIED",
155
      "supportedCurrencies": [
156
        "USD"
157
      ],
158
      "updatedAt": "2021-01-01T00:00:00Z"
159
    },
160
    "paymentSourceId": "pm_4794d597-70dc-4fec-b6ec-c5988e759769",
161
    "vendorId": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
162
    "vendor": {
163
      "acceptedTos": false,
164
      "accountType": "business",
165
      "createdAt": "2024-01-01T00:00:00Z",
166
      "email": "vendor@bigboxstore.com",
167
      "id": "ent_21661ac1-a2a8-4465-a6c0-64474ba8181d",
168
      "isCustomer": false,
169
      "isNetworkPayee": false,
170
      "isNetworkPayor": false,
171
      "isPayee": true,
172
      "isPayor": false,
173
      "name": "Big Box Store",
174
      "profile": {
175
        "business": {
176
          "legalBusinessName": "Big Box Store",
177
          "taxIDProvided": false,
178
          "email": "vendor@bigboxstore.com",
179
          "businessType": "publicCorporation",
180
          "ownersProvided": false
181
        }
182
      },
183
      "status": "unverified",
184
      "updatedAt": "2024-01-02T00:00:00Z",
185
      "counterpartyType": [
186
        "ENTITY"
187
      ],
188
      "foreignId": "MY-DB-ID-90909",
189
      "paymentMethods": [
190
        {
191
          "type": "bankAccount",
192
          "accountName": "Vendor Checking Account",
193
          "accountNumber": "55934059697648",
194
          "accountType": "CHECKING",
195
          "bankName": "Chase",
196
          "createdAt": "2021-01-01T00:00:00Z",
197
          "frozen": false,
198
          "id": "pm_7610541f-4619-4033-8620-cfccfb811293",
199
          "isDefaultDestination": true,
200
          "isDefaultSource": true,
201
          "metadata": {},
202
          "routingNumber": "66554433",
203
          "status": "NEW",
204
          "supportedCurrencies": [
205
            "USD"
206
          ],
207
          "updatedAt": "2021-01-01T00:00:00Z"
208
        }
209
      ]
210
    },
211
    "paymentDestination": {
212
      "type": "check",
213
      "addressLine1": "123 Main St",
214
      "city": "New York",
215
      "country": "US",
216
      "createdAt": "2021-01-01T00:00:00Z",
217
      "frozen": false,
218
      "id": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
219
      "isDefaultDestination": true,
220
      "isDefaultSource": false,
221
      "metadata": {},
222
      "payToTheOrderOf": "John Doe",
223
      "postalCode": "10001",
224
      "stateOrProvince": "NY",
225
      "supportedCurrencies": [
226
        "USD"
227
      ],
228
      "updatedAt": "2021-01-01T00:00:00Z",
229
      "addressLine2": "Apt 1"
230
    },
231
    "paymentDestinationId": "pm_5fde2f4a-facc-48ef-8f0d-6b7d087c7b18",
232
    "paymentDestinationOptions": {
233
      "type": "check",
234
      "delivery": "MAIL"
235
    },
236
    "comments": [
237
      {
238
        "id": "ic_b3525b66-da94-4525-9f31-426bcf657128",
239
        "text": "This is an approval comment",
240
        "createdAt": "2021-01-01T00:00:00Z",
241
        "updatedAt": "2021-01-01T00:00:00Z",
242
        "user": {
243
          "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
244
          "roles": [
245
            "admin",
246
            "approver"
247
          ],
248
          "createdAt": "2024-01-01T00:00:00Z",
249
          "updatedAt": "2024-01-01T00:00:00Z",
250
          "foreignId": "MY-DB-ID-12345",
251
          "email": "john.doe@acme.com",
252
          "name": "John Doe"
253
        },
254
        "associatedApprovalAction": {
255
          "userId": "user_e24fc81c-c5ee-47e8-af42-4fe29d895506",
256
          "action": "APPROVE"
257
        }
258
      }
259
    ],
260
    "lineItems": [
261
      {
262
        "id": "inli_26672f38-eb9a-48f1-a7a0-f1b855e38cd7",
263
        "currency": "USD",
264
        "category": "EXPENSE",
265
        "createdAt": "2021-01-01T00:00:00Z",
266
        "updatedAt": "2021-01-01T00:00:00Z",
267
        "amount": 100,
268
        "description": "Product A",
269
        "name": "Product A",
270
        "quantity": 1,
271
        "unitPrice": 100,
272
        "serviceStartDate": "2021-01-01T00:00:00Z",
273
        "serviceEndDate": "2021-01-31T00:00:00Z",
274
        "metadata": {
275
          "key1": "value1",
276
          "key2": "value2"
277
        },
278
        "glAccountId": "600394"
279
      }
280
    ],
281
    "foreignId": "YOUR-DATABASE-ID",
282
    "creatorUser": {
283
      "id": "user_ec3aafc8-ea86-408a-a6c1-545497badbbb",
284
      "roles": [
285
        "admin",
286
        "approver"
287
      ],
288
      "createdAt": "2024-01-01T00:00:00Z",
289
      "updatedAt": "2024-01-01T00:00:00Z",
290
      "foreignId": "MY-DB-ID-12345",
291
      "email": "john.doe@acme.com",
292
      "name": "John Doe"
293
    }
294
  }
295
}