Incoming Invoice Email

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