-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
1295 lines (1295 loc) · 44.8 KB
/
openapi.yaml
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
998
999
1000
openapi: 3.0.2
info:
servers:
- api.finleycms.com
title: Finley API
description: Finley API documentation
version: 0.0.2
servers:
- url: api.finleycms.com
tags:
- description: Funding Request Endpoints
name: FundingRequests
- description: >-
Deprecated Funding Request Endpoints. Please use endpoints listed under
Credit Facilities API
/credit-facilities/{creditFacilityId}/funding-requests. The deprecated
routes are scheduled to be removed on September 30, 2022.
name: FundingRequestsDeprecated
- description: Borrowing Base Report Endpoints
name: BorrowingBaseReports
- description: Credit Facilities Endpoints
name: CreditFacilities
- description: Expenses & Fees Report Endpoints
name: ExpensesFeesReports
- description: Webhook Details
name: Webhooks
- description: |
<SchemaDefinition schemaRef="#/components/schemas/BorrowingBaseReport" />
name: borrowingBaseReportModel
x-displayName: BorrowingBaseReport Model
- description: |
<SchemaDefinition schemaRef="#/components/schemas/CreditFacility" />
name: creditFacilityModel
x-displayName: CreditFacility Model
- description: |
<SchemaDefinition schemaRef="#/components/schemas/FundingRequest" />
name: fundingRequestModel
x-displayName: FundingRequest Model
- description: >
<SchemaDefinition schemaRef="#/components/schemas/FundingRequestComponent"
/>
name: fundingRequestComponentModel
x-displayName: FundingRequestComponent Model
- description: >
<SchemaDefinition
schemaRef="#/components/schemas/FundingRequestComponentSummary" />
name: fundingRequestComponentSummaryModel
x-displayName: FundingRequestComponentSummary Model
paths:
/credit-facilities/{creditFacilityId}/borrowing-base-reports/{borrowingBaseReportId}:
get:
tags:
- BorrowingBaseReports
summary: Get Borrowing-base Report
operationId: BorrowingBaseReports_getById
description: Fetches borrowing base report by borrowingBaseReportId
parameters:
- description: id of the associated credit facility id
in: path
name: creditFacilityId
schema:
type: string
required: true
example: 2c843493-ee7d-4998-94cb-6a97deb92123
- description: id of the borrowing base report to get
in: path
name: borrowingBaseReportId
schema:
type: string
required: true
example: 4a61197g-a7c6-32cd-b9f7-f02921c5b123
responses:
'200':
description: borrowing base report object
content:
application/json:
schema:
$ref: '#/components/schemas/BorrowingBaseReport'
produces:
- application/json
/credit-facilities/{creditFacilityId}/borrowing-base-reports:
get:
tags:
- BorrowingBaseReports
summary: List Borrowing-base Reports
operationId: BorrowingBaseReports_getList
description: Fetches a list of borrowing base reports.
parameters:
- description: id of the associated credit facility id
in: path
name: creditFacilityId
schema:
type: string
required: true
example: 2c843493-ee7d-4998-94cb-6a97deb92123
responses:
'200':
description: array of borrowing base report objects
content:
application/json:
schema:
$ref: '#/components/schemas/BorrowingBaseReportsGetListResponse'
/credit-facilities/{creditFacilityId}:
get:
tags:
- CreditFacilities
summary: Get Credit Facility
operationId: CreditFacilities_getById
description: Fetches Credit Facility by creditFacilityId
parameters:
- description: id of the credit facility to get
in: path
name: creditFacility
schema:
type: string
required: true
example: 2c843493-ee7d-4998-94cb-6a97deb92123
responses:
'200':
description: credit facility object
content:
application/json:
schema:
$ref: '#/components/schemas/CreditFacility'
/credit-facilities:
get:
tags:
- CreditFacilities
summary: Get Credit Facilities
operationId: CreditFacilities_getList
description: Fetches Credit Facilities
responses:
'200':
description: credit facility object array
content:
application/json:
schema:
$ref: '#/components/schemas/CreditFacilitiesGetListResponse'
/credit-facilities/{creditFacilityId}/expenses-fees:
get:
tags:
- ExpensesFeesReports
summary: Get Expenses & Fees Report
operationId: ExpensesFeesReports_getSummary
description: Fetches summary of expenses and fees.
parameters:
- description: ID of the associated credit facility
in: path
name: creditFacilityId
schema:
type: string
required: true
example: 2c843493-ee7d-4998-94cb-6a97deb92123
- description: Optional start date (inclusive) for ledger data
in: query
name: startDate
schema:
type: string
required: false
example: '2023-08-01'
- description: Optional end date (inclusive) for ledger data
in: query
name: endDate
schema:
type: string
required: false
example: '2023-08-31'
responses:
'200':
description: Object containing maximum date boundaries and ledger data
content:
application/json:
schema:
$ref: '#/components/schemas/ExpensesFeesReport'
examples:
Ledger with available entries:
value:
creditFacilityId: 2c843493-ee7d-4998-94cb-6a97deb92123
fullLedgerLength: 100
ledger:
- date: '2023-08-31'
countersigner: Organization Name
transaction: Admin Fee
amount: 123.45
balance: 123.45
currencyCode: USD
- date: '2023-08-31'
countersigner: Organization Name
transaction: Interest
amount: 126.54
balance: 249.99
currencyCode: USD
_links:
self: >-
/credit-facilities/2c843493-ee7d-4998-94cb-6a97deb92123/expenses-fees?startDate=2023-08-31
Ledger with no entries:
value:
creditFacilityId: 2c843493-ee7d-4998-94cb-6a97deb92123
fullLedgerLength: 0
ledger: []
_links:
self: >-
/credit-facilities/2c843493-ee7d-4998-94cb-6a97deb92123/expenses-fees
/credit-facilities/{creditFacilityId}/funding-requests/{fundingRequestId}:
get:
tags:
- FundingRequests
summary: Get Funding Request
operationId: FundingRequests_getByRequestId
description: Fetches funding request by fundingRequestId
parameters:
- description: id of the associated credit facility
in: path
name: creditFacilityId
schema:
type: string
required: true
example: 2c843493-ee7d-4998-94cb-6a97deb92123
- description: id of the funding request to get
in: path
name: fundingRequestId
schema:
type: string
required: true
example: 5e71197d-e7d6-41fd-b9f7-f02921c5b392
responses:
'200':
description: funding request object
content:
application/json:
schema:
$ref: '#/components/schemas/FundingRequest'
/credit-facilities/{creditFacilityId}/funding-requests:
get:
tags:
- FundingRequests
summary: List Funding Requests
operationId: FundingRequests_list
description: Fetches funding requests.
parameters:
- description: ID of the associated credit facility
in: path
name: creditFacilityId
schema:
type: string
required: true
example: 2c843493-ee7d-4998-94cb-6a97deb92123
- description: >-
ID of the associated borrowing base report from which the funding
request was generated
in: query
name: borrowingBaseReportId
schema:
type: string
required: false
example: 3d743493-ee7d-4998-94cb-6a97deb92123
- description: Status of the funding request
in: query
name: status
schema:
type: string
required: false
example: pending
enum:
- approved
- canceled
- expired
- pending
- rejected
- submitted
type: string
responses:
'200':
description: array of funding request objects
content:
application/json:
schema:
$ref: '#/components/schemas/FundingRequestsListResponse'
post:
tags:
- FundingRequests
summary: Create Funding Request
operationId: FundingRequests_createPendingRequestUsingLatestBorrowingBase
description: Creates a pending funding request using the latest borrowing base report
responses:
'200':
description: Funding request object
content:
application/json:
schema:
$ref: '#/components/schemas/FundingRequest'
'409':
description: Funding request creation failed
content:
application/json:
schema:
$ref: >-
#/components/schemas/FundingRequestsCreatePendingRequestUsingLatestBorrowingBaseResponse
/credit-facilities/{creditFacilityId}/funding-requests/{fundingRequestId}/components/{fundingRequestComponentId}:
get:
tags:
- FundingRequests
summary: Get Component
operationId: FundingRequests_getComponentById
description: >-
Fetches a funding request component specified by fundingRequestId and
fundingRequestComponentId
parameters:
- description: id of the associated credit facility
in: path
name: creditFacilityId
schema:
type: string
required: true
example: 2c843493-ee7d-4998-94cb-6a97deb92123
- description: id of the funding request of whose components to get
in: path
name: fundingRequestId
schema:
type: string
required: true
example: 5e71197d-e7d6-41fd-b9f7-f02921c5b392
- description: id of the funding request component to be settled
in: path
name: fundingRequestComponentId
schema:
type: string
required: true
example: a22cc363-639b-4243-b4b6-3a8d5c46316c
responses:
'200':
description: funding request component
content:
application/json:
schema:
$ref: '#/components/schemas/FundingRequestComponent'
/credit-facilities/{creditFacilityId}/funding-requests/{fundingRequestId}/components:
get:
tags:
- FundingRequests
summary: List Components
operationId: FundingRequests_listComponentsByRequestId
description: Fetches all funding request components by fundingRequestId
parameters:
- description: id of the associated credit facility
in: path
name: creditFacilityId
schema:
type: string
required: true
example: 2c843493-ee7d-4998-94cb-6a97deb92123
- description: id of the funding request of whose components to get
in: path
name: fundingRequestId
schema:
type: string
required: true
example: 5e71197d-e7d6-41fd-b9f7-f02921c5b392
responses:
'200':
description: an array of funding request component summaries
content:
application/json:
schema:
$ref: >-
#/components/schemas/FundingRequestsListComponentsByRequestIdResponse
/credit-facilities/{creditFacilityId}/funding-requests/{fundingRequestId}/components/{fundingRequestComponentId}/settle:
put:
tags:
- FundingRequests
summary: Settle Component
operationId: FundingRequests_settleComponentSettlement
description: Settles a funding request component
parameters:
- description: id of the associated credit facility
in: path
name: creditFacilityId
schema:
type: string
required: true
example: 2c843493-ee7d-4998-94cb-6a97deb92123
- description: id of the funding request whose component will be settled
in: path
name: fundingRequestId
schema:
type: string
required: true
example: 5e71197d-e7d6-41fd-b9f7-f02921c5b392
- description: id of the funding request component to be settled
in: path
name: fundingRequestComponentId
schema:
type: string
required: true
example: a22cc363-639b-4243-b4b6-3a8d5c46316c
requestBody:
description: Request body
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SettleRequestBody'
responses:
'204':
description: No content
'409':
description: Settle has already been performed previously
/credit-facilities/{creditFacilityId}/funding-requests/{fundingRequestId}/submit:
put:
tags:
- FundingRequests
summary: Submit Funding Request
operationId: FundingRequests_submitFundingRequest
description: Submits a funding request
parameters:
- description: id of the associated credit facility
in: path
name: creditFacilityId
schema:
type: string
required: true
example: 2c843493-ee7d-4998-94cb-6a97deb92123
- description: id of the funding request whose component will be settled
in: path
name: fundingRequestId
schema:
type: string
required: true
example: 5e71197d-e7d6-41fd-b9f7-f02921c5b392
requestBody:
description: Request body
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FundingRequestSubmissionRequestBody'
responses:
'204':
description: No content
'409':
description: Funding request submission failed
content:
application/json:
schema:
$ref: >-
#/components/schemas/FundingRequestsSubmitFundingRequestResponse
/funding-requests/{fundingRequestId}:
get:
tags:
- FundingRequestsDeprecated
summary: Get Funding Request
operationId: FundingRequestsDeprecated_getById
description: Fetches funding request by fundingRequestId
parameters:
- description: id of the funding request to get
in: path
name: fundingRequestId
schema:
type: string
required: true
example: 5e71197d-e7d6-41fd-b9f7-f02921c5b392
responses:
'200':
description: funding request object
content:
application/json:
schema:
$ref: '#/components/schemas/FundingRequest'
deprecated: true
/funding-requests:
get:
tags:
- FundingRequestsDeprecated
summary: List Funding Requests
operationId: FundingRequestsDeprecated_getList
description: Fetches funding requests.
responses:
'200':
description: array of funding request objects
content:
application/json:
schema:
$ref: '#/components/schemas/FundingRequestsDeprecatedGetListResponse'
deprecated: true
/funding-requests/{fundingRequestId}/components/{fundingRequestComponentId}:
get:
tags:
- FundingRequestsDeprecated
summary: Get Component
operationId: FundingRequestsDeprecated_getComponentById
description: >-
Fetches a funding request component specified by fundingRequestId and
fundingRequestComponentId
parameters:
- description: id of the funding request of whose components to get
in: path
name: fundingRequestId
schema:
type: string
required: true
example: 5e71197d-e7d6-41fd-b9f7-f02921c5b392
- description: id of the funding request component to be settled
in: path
name: fundingRequestComponentId
schema:
type: string
required: true
example: a22cc363-639b-4243-b4b6-3a8d5c46316c
responses:
'200':
description: funding request component
content:
application/json:
schema:
$ref: '#/components/schemas/FundingRequestComponent'
deprecated: true
/funding-requests/{fundingRequestId}/components:
get:
tags:
- FundingRequestsDeprecated
summary: List Components
operationId: FundingRequestsDeprecated_getComponentsByRequestId
description: Fetches all funding request components by fundingRequestId
parameters:
- description: id of the funding request of whose components to get
in: path
name: fundingRequestId
schema:
type: string
required: true
example: 5e71197d-e7d6-41fd-b9f7-f02921c5b392
responses:
'200':
description: an array of funding request component summaries
content:
application/json:
schema:
$ref: >-
#/components/schemas/FundingRequestsDeprecatedGetComponentsByRequestIdResponse
deprecated: true
produces:
- application/json
/funding-requests/{fundingRequestId}/components/{fundingRequestComponentId}/settle:
put:
tags:
- FundingRequestsDeprecated
summary: Settle Component
operationId: FundingRequestsDeprecated_settleComponent
description: Settles a funding request component
parameters:
- description: id of the funding request whose component will be settled
in: path
name: fundingRequestId
schema:
type: string
required: true
example: 5e71197d-e7d6-41fd-b9f7-f02921c5b392
- description: id of the funding request component to be settled
in: path
name: fundingRequestComponentId
schema:
type: string
required: true
example: a22cc363-639b-4243-b4b6-3a8d5c46316c
requestBody:
description: Request body
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SettleRequestBody'
responses:
'204':
description: No content
'409':
description: Settle has already been performed previously
deprecated: true
components:
schemas:
BorrowingBaseReport:
type: object
properties:
id:
description: The id of the borrowing base report
type: string
example: 4a61197g-a7c6-32cd-b9f7-f02921c5b123
creditFacilityId:
description: The id of the associated credit facility
type: string
example: 2c843493-ee7d-4998-94cb-6a97deb92123
currentPrincipalBalance:
description: The current principal balance of credit facility
type: number
example: 10000
fileVersion:
description: The file version of the borrowing base report
type: number
example: 1
borrowingBaseAmount:
description: >-
The total contribution of assets to the borrowing base (after
applying eligibility kickouts, concentration limits, asset
valuations, advance rates, borrowing base reserve, if applicable)
type: number
example: 20000
proFormaCurrentPrincipalBalance:
description: >-
Current principal balance assuming all approved funding requests are
executed
type: number
example: 15000
proFormaBorrowingBaseAmount:
description: >-
The total contribution of assets to the borrowing base assuming all
approved funding requests are executed
type: number
example: 20000
reportingDate:
description: The reporting date of the borrowing base report
type: string
format: date
example: '2022-01-01'
concentrationLimits:
description: Concentration limit calculations
type: array
items:
$ref: '#/components/schemas/ConcentrationLimit'
_links:
type: object
properties:
self:
type: string
example: >-
/credit-facilities/2c843493-ee7d-4998-94cb-6a97deb92123/borrowing-base-reports/4a61197g-a7c6-32cd-b9f7-f02921c5b123
ConcentrationLimit:
type: object
properties:
key:
description: Identifier for the concentration limit
type: string
type:
description: Type of value against which `concentrationLimit` is specified
type: string
enum:
- standard
- weightedAverage
complianceStatus:
description: Compliance status
type: string
enum:
- compliant
- limitReached
- waived
concentration:
description: >-
Value computed for testing against `concentrationLimit`. If `type`
is `standard`, this is computed as `concentrationAmount` / `total
eligible exposure`. If `type` is `weightedAverage`, this is computed
as the weighted average of a particular receivable property,
weighted by exposure.
type: number
concentrationLimit:
description: >-
Threshold against which `concentration` is compared, as defined in
the contract
type: number
concentrationAmount:
description: >-
For standard concentration limits, the exposure (prior to
concentration limits being applied) of eligible receivables matching
this concentration limit's criteria. For weighted average
concentration limits, not present.
type: number
kickout:
description: >-
Amount by which the borrowing base was reduced by this concentration
limit
type: number
CreditFacility:
type: object
properties:
id:
description: The id of the credit facility
type: string
example: 2c843493-ee7d-4998-94cb-6a97deb92123
slug:
description: The slug (human readable) identifier for the credit facility
type: string
example: acmeCorpAbcProviders1
isActive:
description: Represents if the credit facility is active or not
type: boolean
example: true
_links:
type: object
properties:
self:
type: string
example: /credit-facilities/2c843493-ee7d-4998-94cb-6a97deb92123
ExpensesFeesReport:
description: Object containing maximum date boundaries and ledger data
type: object
properties:
creditFacilityId:
description: The id of the credit facility
type: string
example: 2c843493-ee7d-4998-94cb-6a97deb92123
fullLedgerLength:
description: The full length of the ledger without query parameters
type: number
example: 123
firstEntryDate:
description: The date corresponding to the earliest ledger entry available
type: string
example: '2023-08-01'
format: date
lastEntryDate:
description: The date corresponding to the most recent ledger entry available
type: string
example: '2023-08-31'
format: date
updatedAt:
description: >-
The timestamp corresponding to the latest ledger update (may not be
the same as latest entry when if ledger entries are backdated)
type: string
format: date-time
example: '2023-08-31T13:15:23.17Z'
ledger:
description: Array of objects containing daily summarized ledger entries
type: array
items:
description: >-
Object containing summary of daily amount per transaction type
with running balance across all entries
type: object
properties:
date:
description: Posting date of transaction
type: string
example: '2023-08-31'
format: date
countersigner:
description: Party to which liability is owed
type: string
example: Organization Name
transaction:
description: Name of transaction type
type: string
example: Admin Fee
amount:
description: >-
Total amount posted for transaction type on associated date
(sum of debits and credits)
type: number
example: 123.45
balance:
description: Running balance across transactions
type: number
example: 123.45
currencyCode:
description: Currency code corresponding to customer account
type: string
example: USD
_links:
description: Links to relevant resources
type: object
properties:
self:
description: Link for current resource
type: string
example: >-
/credit-facilities/2c843493-ee7d-4998-94cb-6a97deb92123/expenses-fees?startDate=2023-08-01
required:
- creditFacilityId
- fullLedgerLength
- ledger
FundingRequest:
type: object
properties:
id:
description: The id of the funding request
type: string
example: 5e71197d-e7d6-41fd-b9f7-f02921c5b392
borrowingBaseReportId:
description: >-
The id of the corresponding borrowing base report from which this
funding request was generated
type: string
example: 4a61197g-a7c6-32cd-b9f7-f02921c5b123
collectionsPaydownTotalAmount:
description: >-
The total amount of collections paydowns associated with the funding
request
type: number
example: 0
collectionsRecycleTotalAmount:
description: >-
The total amount of collections recycles associated with the funding
request
type: number
example: 500250.51
createdAt:
description: The datetime the funding request was created
type: string
format: date-time
creditFacilityId:
description: The credit facility id associated with funding request
type: string
example: 2c843493-ee7d-4998-94cb-6a97deb92123
curePaydownTotalAmount:
description: >-
The total amount of cure paydowns associated with the funding
request
type: number
example: 0
drawRequestTotalAmount:
description: >-
The total amount of draw requests paydowns associated with the
funding request
type: number
example: 1234567.89
expire:
description: >-
The expiration datetime of the funding request (if the funding
request does not reach a terminal state prior)
type: string
format: date-time
isCurrent:
description: >-
Will be true if funding request is the current funding request,
otherwise null
type: boolean
nullable: true
example: true
status:
description: The current status of the funding request
type: string
example: approved
enum:
- approved
- canceled
- expired
- pending
- rejected
- submitted
_links:
type: object
properties:
components:
type: string
example: >-
/credit-facilities/2c843493-ee7d-4998-94cb-6a97deb92123/funding-requests/5e71197d-e7d6-41fd-b9f7-f02921c5b392/components
borrowingBaseReport:
type: string
example: >-
/credit-facilities/2c843493-ee7d-4998-94cb-6a97deb92123/borrowing-base-reports/4a61197g-a7c6-32cd-b9f7-f02921c5b123
self:
type: string
example: >-
/credit-facilities/2c843493-ee7d-4998-94cb-6a97deb92123/funding-requests/5e71197d-e7d6-41fd-b9f7-f02921c5b392
FundingRequestComponent:
type: object
properties:
id:
description: The id of the funding request component
type: string
example: a22cc363-639b-4243-b4b6-3a8d5c46316c
amount:
description: The amount associated with the funding request component
type: number
example: 1234567.89
destinationBankAccountId:
description: >-
The destination bank account id (internal Finley identifier)
associated with the funding request component
type: string
example: 151d1f11-139c-4371-98fc-6b4934e69f1b
fundingRequestId:
description: The id of the associated funding request
type: string
example: 5e71197d-e7d6-41fd-b9f7-f02921c5b392
settlementDate:
description: >-
The date the funding request component amount was transferred from
source to destination bank account
type: string
nullable: true
example: null
format: date
sourceBankAccountId:
description: >-
The source bank account id (internal Finley identifier) associated
with the funding request component
type: string
example: 441a53a7-10f8-42ad-8fa0-a5a253db0f4e
capitalProviderSlug:
description: >-
The slug (human readable) identifier for the associated capital
provider. May be null if there is no associated capital provider
(e.g. components of type collections recycle).
type: string
example: abcProviders
nullable: true
targetFundingDate:
description: >-
The target date the funding request component amount was intended to
be transferred
type: string
nullable: true
format: date
type:
description: The type of funding request component
type: string
example: drawRequest
enum:
- collectionsPaydown
- collectionsRecycle
- curePaydown
- drawRequest
_links:
type: object
properties:
self:
type: string
example: >-
/funding-requests/5e71197d-e7d6-41fd-b9f7-f02921c5b392/components/a22cc363-639b-4243-b4b6-3a8d5c46316c
FundingRequestComponentSummary:
type: object
properties:
amount:
description: The amount associated with the funding request component
type: number
example: 1234567.89
id:
description: The id of the funding request component
type: string
example: a22cc363-639b-4243-b4b6-3a8d5c46316c
type:
description: The type of funding request component
type: string
example: drawRequest
enum:
- collectionsPaydown
- collectionsRecycle
- curePaydown
- drawRequest
_links:
type: object
properties:
self:
type: string
example: >-
/credit-facilities/2c843493-ee7d-4998-94cb-6a97deb92123/funding-requests/5e71197d-e7d6-41fd-b9f7-f02921c5b392/components/a22cc363-639b-4243-b4b6-3a8d5c46316c
FundingRequestSubmissionRequestBody:
description: >-
The funding request components (only non-zero components should be
submitted)
type: object
properties:
collectionsPaydown:
description: Transaction to issue paydown of balance from collections account
type: object
properties:
amount:
description: Amount for funding transaction
type: number
example: 1000000
targetFundingDate:
description: >-
The target date for which this funding transaction is expected
to settle
type: string
format: date
example: '2023-08-31'
collectionsRecycle:
description: Transaction to recycle cash from collections account
type: object
properties:
amount:
description: Amount for funding transaction
type: number
example: 1000000
targetFundingDate:
description: >-
The target date for which this funding transaction is expected
to settle
type: string
format: date
example: '2023-08-31'
curePaydown:
description: >-
Transaction to issue paydown of balance from parent operating
account
type: object
properties:
amount:
description: Amount for funding transaction
type: number
example: 1000000