-
Notifications
You must be signed in to change notification settings - Fork 13
/
transactions.ts
473 lines (411 loc) · 11.9 KB
/
transactions.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import * as Core from '../../core';
import { APIResource } from '../../resource';
import { isRequestOptions } from '../../core';
import * as TransactionsAPI from './transactions';
import * as Shared from '../shared';
import * as LineItemsAPI from './line-items';
import { Page, type PageParams } from '../../pagination';
export class Transactions extends APIResource {
lineItems: LineItemsAPI.LineItems = new LineItemsAPI.LineItems(this._client);
/**
* create transaction
*/
create(params: TransactionCreateParams, options?: Core.RequestOptions): Core.APIPromise<Transaction> {
// @ts-expect-error idempotency key header isn't defined anymore but is included here for back-compat
const { 'Idempotency-Key': idempotencyKey, ...body } = params;
if (idempotencyKey) {
console.warn(
"The Idempotency-Key request param is deprecated, the 'idempotencyToken' option should be set instead",
);
}
return this._client.post('/api/transactions', {
body,
...options,
headers: { 'Idempotency-Key': idempotencyKey, ...options?.headers },
});
}
/**
* Get details on a single transaction.
*/
retrieve(id: string, options?: Core.RequestOptions): Core.APIPromise<Transaction> {
return this._client.get(`/api/transactions/${id}`, options);
}
/**
* Update a single transaction.
*/
update(
id: string,
body?: TransactionUpdateParams,
options?: Core.RequestOptions,
): Core.APIPromise<Transaction>;
update(id: string, options?: Core.RequestOptions): Core.APIPromise<Transaction>;
update(
id: string,
body: TransactionUpdateParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.APIPromise<Transaction> {
if (isRequestOptions(body)) {
return this.update(id, {}, body);
}
return this._client.patch(`/api/transactions/${id}`, { body, ...options });
}
/**
* Get a list of all transactions.
*/
list(
query?: TransactionListParams,
options?: Core.RequestOptions,
): Core.PagePromise<TransactionsPage, Transaction>;
list(options?: Core.RequestOptions): Core.PagePromise<TransactionsPage, Transaction>;
list(
query: TransactionListParams | Core.RequestOptions = {},
options?: Core.RequestOptions,
): Core.PagePromise<TransactionsPage, Transaction> {
if (isRequestOptions(query)) {
return this.list({}, query);
}
return this._client.getAPIList('/api/transactions', TransactionsPage, { query, ...options });
}
/**
* delete transaction
*/
del(id: string, options?: Core.RequestOptions): Core.APIPromise<void> {
return this._client.delete(`/api/transactions/${id}`, {
...options,
headers: { Accept: '*/*', ...options?.headers },
});
}
}
export class TransactionsPage extends Page<Transaction> {}
export interface Transaction {
id: string;
/**
* Value in specified currency's smallest unit. e.g. $10 would be represented
* as 1000.
*/
amount: number;
/**
* The date on which the transaction occurred.
*/
as_of_date: string | null;
/**
* The time on which the transaction occurred. Depending on the granularity of the
* timestamp information received from the bank, it may be `null`.
*/
as_of_time: string | null;
created_at: string;
/**
* Currency that this transaction is denominated in.
*/
currency: Shared.Currency;
/**
* Either `credit` or `debit`.
*/
direction: string;
discarded_at: string | null;
/**
* Associated serialized foreign exchange rate information.
*/
foreign_exchange_rate: Transaction.ForeignExchangeRate | null;
/**
* The ID of the relevant Internal Account.
*/
internal_account_id: string;
/**
* This field will be true if this object exists in the live environment or false
* if it exists in the test environment.
*/
live_mode: boolean;
/**
* Additional data represented as key-value pairs. Both the key and value must be
* strings.
*/
metadata: Record<string, string>;
object: string;
/**
* This field will be `true` if the transaction has posted to the account.
*/
posted: boolean;
/**
* This field will be `true` if a transaction is reconciled by the Modern Treasury
* system. This means that it has transaction line items that sum up to the
* transaction's amount.
*/
reconciled: boolean;
/**
* The type of the transaction. Examples could be
* `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
*/
type:
| 'ach'
| 'au_becs'
| 'bacs'
| 'book'
| 'card'
| 'chats'
| 'check'
| 'cross_border'
| 'dk_nets'
| 'eft'
| 'hu_ics'
| 'interac'
| 'masav'
| 'mx_ccen'
| 'neft'
| 'nics'
| 'nz_becs'
| 'pl_elixir'
| 'provxchange'
| 'ro_sent'
| 'rtp'
| 'se_bankgirot'
| 'sen'
| 'sepa'
| 'sg_giro'
| 'sic'
| 'signet'
| 'sknbi'
| 'wire'
| 'zengin'
| 'other';
updated_at: string;
/**
* When applicable, the bank-given code that determines the transaction's category.
* For most banks this is the BAI2/BTRS transaction code.
*/
vendor_code: string | null;
/**
* The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
* `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
* `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
* `swift`, `us_bank`, or others.
*/
vendor_code_type:
| 'bai2'
| 'bankprov'
| 'bnk_dev'
| 'cleartouch'
| 'column'
| 'cross_river'
| 'currencycloud'
| 'dc_bank'
| 'dwolla'
| 'evolve'
| 'goldman_sachs'
| 'iso20022'
| 'jpmc'
| 'mx'
| 'plaid'
| 'rspec_vendor'
| 'signet'
| 'silvergate'
| 'swift'
| 'us_bank'
| 'user'
| null;
/**
* An identifier given to this transaction by the bank, often `null`.
*/
vendor_customer_id: string | null;
/**
* An identifier given to this transaction by the bank.
*/
vendor_id: string | null;
/**
* This field contains additional information that the bank provided about the
* transaction. This is structured data. Some of the data in here might overlap
* with what is in the `vendor_description`. For example, the OBI could be a part
* of the vendor description, and it would also be included in here. The attributes
* that are passed through the details field will vary based on your banking
* partner. Currently, the following keys may be in the details object:
* `originator_name`, `originator_to_beneficiary_information`.
*/
details?: Record<string, string>;
/**
* The transaction detail text that often appears in on your bank statement and in
* your banking portal.
*/
vendor_description?: string | null;
}
export namespace Transaction {
/**
* Associated serialized foreign exchange rate information.
*/
export interface ForeignExchangeRate {
/**
* Amount in the lowest denomination of the `base_currency` to convert, often
* called the "sell" amount.
*/
base_amount: number;
/**
* Currency to convert, often called the "sell" currency.
*/
base_currency: Shared.Currency;
/**
* The exponent component of the rate. The decimal is calculated as `value` / (10 ^
* `exponent`).
*/
exponent: number;
/**
* A string representation of the rate.
*/
rate_string: string;
/**
* Amount in the lowest denomination of the `target_currency`, often called the
* "buy" amount.
*/
target_amount: number;
/**
* Currency to convert the `base_currency` to, often called the "buy" currency.
*/
target_currency: Shared.Currency;
/**
* The whole number component of the rate. The decimal is calculated as `value` /
* (10 ^ `exponent`).
*/
value: number;
}
}
export interface TransactionCreateParams {
/**
* Value in specified currency's smallest unit. e.g. $10 would be represented
* as 1000.
*/
amount: number;
/**
* The date on which the transaction occurred.
*/
as_of_date: string | null;
/**
* Either `credit` or `debit`.
*/
direction: string;
/**
* The ID of the relevant Internal Account.
*/
internal_account_id: string;
/**
* When applicable, the bank-given code that determines the transaction's category.
* For most banks this is the BAI2/BTRS transaction code.
*/
vendor_code: string | null;
/**
* The type of `vendor_code` being reported. Can be one of `bai2`, `bankprov`,
* `bnk_dev`, `cleartouch`, `currencycloud`, `cross_river`, `dc_bank`, `dwolla`,
* `evolve`, `goldman_sachs`, `iso20022`, `jpmc`, `mx`, `signet`, `silvergate`,
* `swift`, `us_bank`, or others.
*/
vendor_code_type: string | null;
/**
* Additional data represented as key-value pairs. Both the key and value must be
* strings.
*/
metadata?: Record<string, string>;
/**
* This field will be `true` if the transaction has posted to the account.
*/
posted?: boolean;
/**
* The type of the transaction. Examples could be
* `card, `ach`, `wire`, `check`, `rtp`, `book`, or `sen`.
*/
type?:
| 'ach'
| 'au_becs'
| 'bacs'
| 'book'
| 'card'
| 'chats'
| 'check'
| 'cross_border'
| 'dk_nets'
| 'eft'
| 'hu_ics'
| 'interac'
| 'masav'
| 'mx_ccen'
| 'neft'
| 'nics'
| 'nz_becs'
| 'pl_elixir'
| 'provxchange'
| 'ro_sent'
| 'rtp'
| 'se_bankgirot'
| 'sen'
| 'sepa'
| 'sg_giro'
| 'sic'
| 'signet'
| 'sknbi'
| 'wire'
| 'zengin'
| 'other'
| null;
/**
* The transaction detail text that often appears in on your bank statement and in
* your banking portal.
*/
vendor_description?: string | null;
}
export interface TransactionUpdateParams {
/**
* Additional data in the form of key-value pairs. Pairs can be removed by passing
* an empty string or `null` as the value.
*/
metadata?: Record<string, string>;
}
export interface TransactionListParams extends PageParams {
/**
* Filters transactions with an `as_of_date` starting on or before the specified
* date (YYYY-MM-DD).
*/
as_of_date_end?: string;
/**
* Filters transactions with an `as_of_date` starting on or after the specified
* date (YYYY-MM-DD).
*/
as_of_date_start?: string;
counterparty_id?: string;
/**
* Filters for transactions including the queried string in the description.
*/
description?: string;
direction?: string;
/**
* Specify `internal_account_id` if you wish to see transactions to/from a specific
* account.
*/
internal_account_id?: string;
/**
* For example, if you want to query for records with metadata key `Type` and value
* `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query
* parameters.
*/
metadata?: Record<string, string>;
payment_type?: string;
/**
* Either `true` or `false`.
*/
posted?: boolean;
transactable_type?: string;
/**
* Filters for transactions including the queried vendor id (an identifier given to
* transactions by the bank).
*/
vendor_id?: string;
virtual_account_id?: string;
}
export namespace Transactions {
export import Transaction = TransactionsAPI.Transaction;
export import TransactionsPage = TransactionsAPI.TransactionsPage;
export import TransactionCreateParams = TransactionsAPI.TransactionCreateParams;
export import TransactionUpdateParams = TransactionsAPI.TransactionUpdateParams;
export import TransactionListParams = TransactionsAPI.TransactionListParams;
export import LineItems = LineItemsAPI.LineItems;
export import TransactionLineItem = LineItemsAPI.TransactionLineItem;
export import TransactionLineItemsPage = LineItemsAPI.TransactionLineItemsPage;
export import LineItemCreateParams = LineItemsAPI.LineItemCreateParams;
export import LineItemListParams = LineItemsAPI.LineItemListParams;
}