-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathexports.ts
More file actions
997 lines (874 loc) · 27.5 KB
/
exports.ts
File metadata and controls
997 lines (874 loc) · 27.5 KB
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
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
import { APIResource } from '../core/resource';
import { APIPromise } from '../core/api-promise';
import { Page, type PageParams, PagePromise } from '../core/pagination';
import { RequestOptions } from '../internal/request-options';
import { path } from '../internal/utils/path';
export class Exports extends APIResource {
/**
* Create an Export
*
* @example
* ```ts
* const _export = await client.exports.create({
* category: 'transaction_csv',
* });
* ```
*/
create(body: ExportCreateParams, options?: RequestOptions): APIPromise<Export> {
return this._client.post('/exports', { body, ...options });
}
/**
* Retrieve an Export
*
* @example
* ```ts
* const _export = await client.exports.retrieve(
* 'export_8s4m48qz3bclzje0zwh9',
* );
* ```
*/
retrieve(exportID: string, options?: RequestOptions): APIPromise<Export> {
return this._client.get(path`/exports/${exportID}`, options);
}
/**
* List Exports
*
* @example
* ```ts
* // Automatically fetches more pages as needed.
* for await (const _export of client.exports.list()) {
* // ...
* }
* ```
*/
list(
query: ExportListParams | null | undefined = {},
options?: RequestOptions,
): PagePromise<ExportsPage, Export> {
return this._client.getAPIList('/exports', Page<Export>, { query, ...options });
}
}
export type ExportsPage = Page<Export>;
/**
* Exports are generated files. Some exports can contain a lot of data, like a CSV
* of your transactions. Others can be a single document, like a tax form. Since
* they can take a while, they are generated asynchronously. We send a webhook when
* they are ready. For more information, please read our
* [Exports documentation](https://increase.com/documentation/exports).
*/
export interface Export {
/**
* The Export identifier.
*/
id: string;
/**
* Details of the account statement BAI2 export. This field will be present when
* the `category` is equal to `account_statement_bai2`.
*/
account_statement_bai2: Export.AccountStatementBai2 | null;
/**
* Details of the account statement OFX export. This field will be present when the
* `category` is equal to `account_statement_ofx`.
*/
account_statement_ofx: Export.AccountStatementOfx | null;
/**
* Details of the account verification letter export. This field will be present
* when the `category` is equal to `account_verification_letter`.
*/
account_verification_letter: Export.AccountVerificationLetter | null;
/**
* Details of the balance CSV export. This field will be present when the
* `category` is equal to `balance_csv`.
*/
balance_csv: Export.BalanceCsv | null;
/**
* Details of the bookkeeping account balance CSV export. This field will be
* present when the `category` is equal to `bookkeeping_account_balance_csv`.
*/
bookkeeping_account_balance_csv: Export.BookkeepingAccountBalanceCsv | null;
/**
* The category of the Export. We may add additional possible values for this enum
* over time; your application should be able to handle that gracefully.
*
* - `account_statement_ofx` - Export an Open Financial Exchange (OFX) file of
* transactions and balances for a given time range and Account.
* - `account_statement_bai2` - Export a BAI2 file of transactions and balances for
* a given date and optional Account.
* - `transaction_csv` - Export a CSV of all transactions for a given time range.
* - `balance_csv` - Export a CSV of account balances for the dates in a given
* range. (deprecated, use `daily_account_balance_csv` instead)
* - `bookkeeping_account_balance_csv` - Export a CSV of bookkeeping account
* balances for the dates in a given range.
* - `entity_csv` - Export a CSV of entities with a given status.
* - `vendor_csv` - Export a CSV of vendors added to the third-party risk
* management dashboard.
* - `dashboard_table_csv` - Certain dashboard tables are available as CSV exports.
* This export cannot be created via the API.
* - `account_verification_letter` - A PDF of an account verification letter.
* - `funding_instructions` - A PDF of funding instructions.
* - `form_1099_int` - A PDF of an Internal Revenue Service Form 1099-INT.
* - `form_1099_misc` - A PDF of an Internal Revenue Service Form 1099-MISC.
* - `fee_csv` - Export a CSV of fees. The time range must not include any fees
* that are part of an open fee statement.
* - `voided_check` - A PDF of a voided check.
* - `daily_account_balance_csv` - Export a CSV of daily account balances with
* starting and ending balances for a given date range.
*/
category:
| 'account_statement_ofx'
| 'account_statement_bai2'
| 'transaction_csv'
| 'balance_csv'
| 'bookkeeping_account_balance_csv'
| 'entity_csv'
| 'vendor_csv'
| 'dashboard_table_csv'
| 'account_verification_letter'
| 'funding_instructions'
| 'form_1099_int'
| 'form_1099_misc'
| 'fee_csv'
| 'voided_check'
| 'daily_account_balance_csv';
/**
* The time the Export was created.
*/
created_at: string;
/**
* Details of the daily account balance CSV export. This field will be present when
* the `category` is equal to `daily_account_balance_csv`.
*/
daily_account_balance_csv: Export.DailyAccountBalanceCsv | null;
/**
* Details of the dashboard table CSV export. This field will be present when the
* `category` is equal to `dashboard_table_csv`.
*/
dashboard_table_csv: Export.DashboardTableCsv | null;
/**
* Details of the entity CSV export. This field will be present when the `category`
* is equal to `entity_csv`.
*/
entity_csv: Export.EntityCsv | null;
/**
* Details of the fee CSV export. This field will be present when the `category` is
* equal to `fee_csv`.
*/
fee_csv: Export.FeeCsv | null;
/**
* Details of the Form 1099-INT export. This field will be present when the
* `category` is equal to `form_1099_int`.
*/
form_1099_int: Export.Form1099Int | null;
/**
* Details of the Form 1099-MISC export. This field will be present when the
* `category` is equal to `form_1099_misc`.
*/
form_1099_misc: Export.Form1099Misc | null;
/**
* Details of the funding instructions export. This field will be present when the
* `category` is equal to `funding_instructions`.
*/
funding_instructions: Export.FundingInstructions | null;
/**
* The idempotency key you chose for this object. This value is unique across
* Increase and is used to ensure that a request is only processed once. Learn more
* about [idempotency](https://increase.com/documentation/idempotency-keys).
*/
idempotency_key: string | null;
/**
* The result of the Export. This will be present when the Export's status
* transitions to `complete`.
*/
result: Export.Result | null;
/**
* The status of the Export.
*
* - `pending` - Increase is generating the export.
* - `complete` - The export has been successfully generated.
* - `failed` - The export failed to generate. Increase will reach out to you to
* resolve the issue.
*/
status: 'pending' | 'complete' | 'failed';
/**
* Details of the transaction CSV export. This field will be present when the
* `category` is equal to `transaction_csv`.
*/
transaction_csv: Export.TransactionCsv | null;
/**
* A constant representing the object's type. For this resource it will always be
* `export`.
*/
type: 'export';
/**
* Details of the vendor CSV export. This field will be present when the `category`
* is equal to `vendor_csv`.
*/
vendor_csv: Export.VendorCsv | null;
/**
* Details of the voided check export. This field will be present when the
* `category` is equal to `voided_check`.
*/
voided_check: Export.VoidedCheck | null;
[k: string]: unknown;
}
export namespace Export {
/**
* Details of the account statement BAI2 export. This field will be present when
* the `category` is equal to `account_statement_bai2`.
*/
export interface AccountStatementBai2 {
/**
* Filter results by Account.
*/
account_id: string | null;
/**
* The date for which to retrieve the balance.
*/
effective_date: string | null;
/**
* Filter results by Program.
*/
program_id: string | null;
}
/**
* Details of the account statement OFX export. This field will be present when the
* `category` is equal to `account_statement_ofx`.
*/
export interface AccountStatementOfx {
/**
* The Account to create a statement for.
*/
account_id: string;
/**
* Filter transactions by their created date.
*/
created_at: AccountStatementOfx.CreatedAt | null;
}
export namespace AccountStatementOfx {
/**
* Filter transactions by their created date.
*/
export interface CreatedAt {
/**
* Filter results to transactions created before this time.
*/
before: string | null;
/**
* Filter results to transactions created on or after this time.
*/
on_or_after: string | null;
}
}
/**
* Details of the account verification letter export. This field will be present
* when the `category` is equal to `account_verification_letter`.
*/
export interface AccountVerificationLetter {
/**
* The Account Number to create a letter for.
*/
account_number_id: string;
/**
* The date of the balance to include in the letter.
*/
balance_date: string | null;
}
/**
* Details of the balance CSV export. This field will be present when the
* `category` is equal to `balance_csv`.
*/
export interface BalanceCsv {
/**
* Filter results by Account.
*/
account_id: string | null;
/**
* Filter balances by their created date.
*/
created_at: BalanceCsv.CreatedAt | null;
}
export namespace BalanceCsv {
/**
* Filter balances by their created date.
*/
export interface CreatedAt {
/**
* Filter balances created after this time.
*/
after: string | null;
/**
* Filter balances created before this time.
*/
before: string | null;
}
}
/**
* Details of the bookkeeping account balance CSV export. This field will be
* present when the `category` is equal to `bookkeeping_account_balance_csv`.
*/
export interface BookkeepingAccountBalanceCsv {
/**
* Filter results by Bookkeeping Account.
*/
bookkeeping_account_id: string | null;
/**
* Filter balances to those on or after this date.
*/
on_or_after_date: string | null;
/**
* Filter balances to those on or before this date.
*/
on_or_before_date: string | null;
}
/**
* Details of the daily account balance CSV export. This field will be present when
* the `category` is equal to `daily_account_balance_csv`.
*/
export interface DailyAccountBalanceCsv {
/**
* Filter results by Account.
*/
account_id: string | null;
/**
* Filter balances on or after this date.
*/
on_or_after_date: string | null;
/**
* Filter balances on or before this date.
*/
on_or_before_date: string | null;
}
/**
* Details of the dashboard table CSV export. This field will be present when the
* `category` is equal to `dashboard_table_csv`.
*/
export interface DashboardTableCsv {}
/**
* Details of the entity CSV export. This field will be present when the `category`
* is equal to `entity_csv`.
*/
export interface EntityCsv {}
/**
* Details of the fee CSV export. This field will be present when the `category` is
* equal to `fee_csv`.
*/
export interface FeeCsv {
/**
* Filter fees by their created date. The time range must not include any fees that
* are part of an open fee statement.
*/
created_at: FeeCsv.CreatedAt | null;
}
export namespace FeeCsv {
/**
* Filter fees by their created date. The time range must not include any fees that
* are part of an open fee statement.
*/
export interface CreatedAt {
/**
* Filter fees created after this time.
*/
after: string | null;
/**
* Filter fees created before this time.
*/
before: string | null;
}
}
/**
* Details of the Form 1099-INT export. This field will be present when the
* `category` is equal to `form_1099_int`.
*/
export interface Form1099Int {
/**
* The Account the tax form is for.
*/
account_id: string;
/**
* Whether the tax form is a corrected form.
*/
corrected: boolean;
/**
* A description of the tax form.
*/
description: string;
/**
* The tax year for the tax form.
*/
year: number;
}
/**
* Details of the Form 1099-MISC export. This field will be present when the
* `category` is equal to `form_1099_misc`.
*/
export interface Form1099Misc {
/**
* The Account the tax form is for.
*/
account_id: string;
/**
* Whether the tax form is a corrected form.
*/
corrected: boolean;
/**
* The tax year for the tax form.
*/
year: number;
}
/**
* Details of the funding instructions export. This field will be present when the
* `category` is equal to `funding_instructions`.
*/
export interface FundingInstructions {
/**
* The Account Number to create funding instructions for.
*/
account_number_id: string;
}
/**
* The result of the Export. This will be present when the Export's status
* transitions to `complete`.
*/
export interface Result {
/**
* The File containing the contents of the Export.
*/
file_id: string;
}
/**
* Details of the transaction CSV export. This field will be present when the
* `category` is equal to `transaction_csv`.
*/
export interface TransactionCsv {
/**
* Filter results by Account.
*/
account_id: string | null;
/**
* Filter transactions by their created date.
*/
created_at: TransactionCsv.CreatedAt | null;
}
export namespace TransactionCsv {
/**
* Filter transactions by their created date.
*/
export interface CreatedAt {
/**
* Filter transactions created after this time.
*/
after: string | null;
/**
* Filter transactions created before this time.
*/
before: string | null;
}
}
/**
* Details of the vendor CSV export. This field will be present when the `category`
* is equal to `vendor_csv`.
*/
export interface VendorCsv {}
/**
* Details of the voided check export. This field will be present when the
* `category` is equal to `voided_check`.
*/
export interface VoidedCheck {
/**
* The Account Number for the voided check.
*/
account_number_id: string;
/**
* The payer information printed on the check.
*/
payer: Array<VoidedCheck.Payer>;
}
export namespace VoidedCheck {
export interface Payer {
/**
* The contents of the line.
*/
line: string;
}
}
}
export interface ExportCreateParams {
/**
* The type of Export to create.
*
* - `account_statement_ofx` - Export an Open Financial Exchange (OFX) file of
* transactions and balances for a given time range and Account.
* - `account_statement_bai2` - Export a BAI2 file of transactions and balances for
* a given date and optional Account.
* - `transaction_csv` - Export a CSV of all transactions for a given time range.
* - `balance_csv` - Export a CSV of account balances for the dates in a given
* range. (deprecated, use `daily_account_balance_csv` instead)
* - `bookkeeping_account_balance_csv` - Export a CSV of bookkeeping account
* balances for the dates in a given range.
* - `entity_csv` - Export a CSV of entities with a given status.
* - `vendor_csv` - Export a CSV of vendors added to the third-party risk
* management dashboard.
* - `account_verification_letter` - A PDF of an account verification letter.
* - `funding_instructions` - A PDF of funding instructions.
* - `voided_check` - A PDF of a voided check.
* - `daily_account_balance_csv` - Export a CSV of daily account balances with
* starting and ending balances for a given date range.
*/
category:
| 'account_statement_ofx'
| 'account_statement_bai2'
| 'transaction_csv'
| 'balance_csv'
| 'bookkeeping_account_balance_csv'
| 'entity_csv'
| 'vendor_csv'
| 'account_verification_letter'
| 'funding_instructions'
| 'voided_check'
| 'daily_account_balance_csv';
/**
* Options for the created export. Required if `category` is equal to
* `account_statement_bai2`.
*/
account_statement_bai2?: ExportCreateParams.AccountStatementBai2;
/**
* Options for the created export. Required if `category` is equal to
* `account_statement_ofx`.
*/
account_statement_ofx?: ExportCreateParams.AccountStatementOfx;
/**
* Options for the created export. Required if `category` is equal to
* `account_verification_letter`.
*/
account_verification_letter?: ExportCreateParams.AccountVerificationLetter;
/**
* Options for the created export. Required if `category` is equal to
* `bookkeeping_account_balance_csv`.
*/
bookkeeping_account_balance_csv?: ExportCreateParams.BookkeepingAccountBalanceCsv;
/**
* Options for the created export. Required if `category` is equal to
* `daily_account_balance_csv`.
*/
daily_account_balance_csv?: ExportCreateParams.DailyAccountBalanceCsv;
/**
* Options for the created export. Required if `category` is equal to `entity_csv`.
*/
entity_csv?: ExportCreateParams.EntityCsv;
/**
* Options for the created export. Required if `category` is equal to
* `funding_instructions`.
*/
funding_instructions?: ExportCreateParams.FundingInstructions;
/**
* Options for the created export. Required if `category` is equal to
* `transaction_csv`.
*/
transaction_csv?: ExportCreateParams.TransactionCsv;
/**
* Options for the created export. Required if `category` is equal to `vendor_csv`.
*/
vendor_csv?: ExportCreateParams.VendorCsv;
/**
* Options for the created export. Required if `category` is equal to
* `voided_check`.
*/
voided_check?: ExportCreateParams.VoidedCheck;
[k: string]: unknown;
}
export namespace ExportCreateParams {
/**
* Options for the created export. Required if `category` is equal to
* `account_statement_bai2`.
*/
export interface AccountStatementBai2 {
/**
* The Account to create a BAI2 report for. If not provided, all open accounts will
* be included.
*/
account_id?: string;
/**
* The date to create a BAI2 report for. If not provided, the current date will be
* used. The timezone is UTC. If the current date is used, the report will include
* intraday balances, otherwise it will include end-of-day balances for the
* provided date.
*/
effective_date?: string;
/**
* The Program to create a BAI2 report for. If not provided, all open accounts will
* be included.
*/
program_id?: string;
}
/**
* Options for the created export. Required if `category` is equal to
* `account_statement_ofx`.
*/
export interface AccountStatementOfx {
/**
* The Account to create a statement for.
*/
account_id: string;
/**
* Filter transactions by their created date.
*/
created_at?: AccountStatementOfx.CreatedAt;
}
export namespace AccountStatementOfx {
/**
* Filter transactions by their created date.
*/
export interface CreatedAt {
/**
* Filter results to transactions created before this time.
*/
before?: string;
/**
* Filter results to transactions created on or after this time.
*/
on_or_after?: string;
[k: string]: unknown;
}
}
/**
* Options for the created export. Required if `category` is equal to
* `account_verification_letter`.
*/
export interface AccountVerificationLetter {
/**
* The Account Number to create a letter for.
*/
account_number_id: string;
/**
* The date of the balance to include in the letter. Defaults to the current date.
*/
balance_date?: string;
}
/**
* Options for the created export. Required if `category` is equal to
* `bookkeeping_account_balance_csv`.
*/
export interface BookkeepingAccountBalanceCsv {
/**
* Filter exported Bookkeeping Account Balances to the specified Bookkeeping
* Account.
*/
bookkeeping_account_id?: string;
/**
* Filter exported Balances to those on or after this date.
*/
on_or_after_date?: string;
/**
* Filter exported Balances to those on or before this date.
*/
on_or_before_date?: string;
}
/**
* Options for the created export. Required if `category` is equal to
* `daily_account_balance_csv`.
*/
export interface DailyAccountBalanceCsv {
/**
* Filter exported Balances to the specified Account.
*/
account_id?: string;
/**
* Filter exported Balances to those on or after this date.
*/
on_or_after_date?: string;
/**
* Filter exported Balances to those on or before this date.
*/
on_or_before_date?: string;
}
/**
* Options for the created export. Required if `category` is equal to `entity_csv`.
*/
export interface EntityCsv {}
/**
* Options for the created export. Required if `category` is equal to
* `funding_instructions`.
*/
export interface FundingInstructions {
/**
* The Account Number to create funding instructions for.
*/
account_number_id: string;
}
/**
* Options for the created export. Required if `category` is equal to
* `transaction_csv`.
*/
export interface TransactionCsv {
/**
* Filter exported Transactions to the specified Account.
*/
account_id?: string;
/**
* Filter results by time range on the `created_at` attribute.
*/
created_at?: TransactionCsv.CreatedAt;
}
export namespace TransactionCsv {
/**
* Filter results by time range on the `created_at` attribute.
*/
export interface CreatedAt {
/**
* Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
* timestamp.
*/
after?: string;
/**
* Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
* timestamp.
*/
before?: string;
/**
* Return results on or after this
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
*/
on_or_after?: string;
/**
* Return results on or before this
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
*/
on_or_before?: string;
}
}
/**
* Options for the created export. Required if `category` is equal to `vendor_csv`.
*/
export interface VendorCsv {}
/**
* Options for the created export. Required if `category` is equal to
* `voided_check`.
*/
export interface VoidedCheck {
/**
* The Account Number for the voided check.
*/
account_number_id: string;
/**
* The payer information to be printed on the check.
*/
payer?: Array<VoidedCheck.Payer>;
}
export namespace VoidedCheck {
export interface Payer {
/**
* The contents of the line.
*/
line: string;
}
}
}
export interface ExportListParams extends PageParams {
/**
* Filter Exports for those with the specified category.
*
* - `account_statement_ofx` - Export an Open Financial Exchange (OFX) file of
* transactions and balances for a given time range and Account.
* - `account_statement_bai2` - Export a BAI2 file of transactions and balances for
* a given date and optional Account.
* - `transaction_csv` - Export a CSV of all transactions for a given time range.
* - `balance_csv` - Export a CSV of account balances for the dates in a given
* range. (deprecated, use `daily_account_balance_csv` instead)
* - `bookkeeping_account_balance_csv` - Export a CSV of bookkeeping account
* balances for the dates in a given range.
* - `entity_csv` - Export a CSV of entities with a given status.
* - `vendor_csv` - Export a CSV of vendors added to the third-party risk
* management dashboard.
* - `dashboard_table_csv` - Certain dashboard tables are available as CSV exports.
* This export cannot be created via the API.
* - `account_verification_letter` - A PDF of an account verification letter.
* - `funding_instructions` - A PDF of funding instructions.
* - `form_1099_int` - A PDF of an Internal Revenue Service Form 1099-INT.
* - `form_1099_misc` - A PDF of an Internal Revenue Service Form 1099-MISC.
* - `fee_csv` - Export a CSV of fees. The time range must not include any fees
* that are part of an open fee statement.
* - `voided_check` - A PDF of a voided check.
* - `daily_account_balance_csv` - Export a CSV of daily account balances with
* starting and ending balances for a given date range.
*/
category?:
| 'account_statement_ofx'
| 'account_statement_bai2'
| 'transaction_csv'
| 'balance_csv'
| 'bookkeeping_account_balance_csv'
| 'entity_csv'
| 'vendor_csv'
| 'dashboard_table_csv'
| 'account_verification_letter'
| 'funding_instructions'
| 'form_1099_int'
| 'form_1099_misc'
| 'fee_csv'
| 'voided_check'
| 'daily_account_balance_csv';
created_at?: ExportListParams.CreatedAt;
form_1099_int?: ExportListParams.Form1099Int;
form_1099_misc?: ExportListParams.Form1099Misc;
/**
* Filter records to the one with the specified `idempotency_key` you chose for
* that object. This value is unique across Increase and is used to ensure that a
* request is only processed once. Learn more about
* [idempotency](https://increase.com/documentation/idempotency-keys).
*/
idempotency_key?: string;
status?: ExportListParams.Status;
}
export namespace ExportListParams {
export interface CreatedAt {
/**
* Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
* timestamp.
*/
after?: string;
/**
* Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
* timestamp.
*/
before?: string;
/**
* Return results on or after this
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
*/
on_or_after?: string;
/**
* Return results on or before this
* [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
*/
on_or_before?: string;
}
export interface Form1099Int {
/**
* Filter Form 1099-INT Exports to those for the specified Account.
*/
account_id?: string;
}
export interface Form1099Misc {
/**
* Filter Form 1099-MISC Exports to those for the specified Account.
*/
account_id?: string;
}
export interface Status {
/**
* Filter Exports for those with the specified status or statuses. For GET
* requests, this should be encoded as a comma-delimited string, such as
* `?in=one,two,three`.
*/
in?: Array<'pending' | 'complete' | 'failed'>;
}
}
export declare namespace Exports {
export {
type Export as Export,
type ExportsPage as ExportsPage,
type ExportCreateParams as ExportCreateParams,
type ExportListParams as ExportListParams,
};
}