-
-
Notifications
You must be signed in to change notification settings - Fork 5
/
firefly-iii-2.0.0-v1.yaml
19788 lines (19787 loc) · 595 KB
/
firefly-iii-2.0.0-v1.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.0
servers:
- description: Firefly III demo site
url: https://demo.firefly-iii.org/api
info:
title: Firefly III API v2.0.0
description: |
This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the "Authorize" button to try the API below. This file was last generated on 2023-03-05T14:16:31+00:00
version: "2.0.0"
contact:
name: James Cole
email: james@firefly-iii.org
url: https://firefly-iii.org
license:
name: AGPLv3
url: 'https://www.gnu.org/licenses/agpl-3.0.en.html'
tags:
- name: about
description: These endpoints deliver general system information, version- and meta
information.
- name: accounts
description: Endpoints that deliver all of the user's asset, expense and other accounts
(and the metadata) together with related transactions, piggy banks and other objects.
Also delivers endpoints for CRUD operations for accounts.
- name: attachments
description: Endpoints to manage the attachments of the authenticated user, including
up- and downloading of the files.
- name: autocomplete
description: Auto-complete endpoints show basic information about Firefly III models,
like the name and maybe some amounts. They all support a search query and can
be used to autocomplete data in forms. Autocomplete return values always have
a "name"-field.
- name: available_budgets
description: Endpoints to manage the total available amount that the user has made
available to themselves. Used in periodic budgeting.
- name: bills
description: Endpoints to manage a user's bills and all related objects.
- name: budgets
description: Endpoints to manage a user's budgets and get info on the related objects,
like limits.
- name: categories
description: Endpoints to manage a user's categories and get information on transactions
and other related objects.
- name: charts
description: The "charts" endpoints deliver optimised data for charts and graphs.
- name: configuration
description: These endpoints allow you to manage and update the Firefly III configuration.
You need to have the "owner" role to update configuration.
- name: currencies
description: Endpoints to manage the currencies in Firefly III. Depending on the
user's role you can also disable and enable them, or add new ones.
- name: data
description: The "data"-endpoints manage generic Firefly III and user-specific data.
- name: insight
description: The "insight" endpoints try to deliver sums, balances and insightful
information in the broadest sense of the word.
- name: links
description: Endpoints to manage links between transactions, and manage the type
of links available.
- name: object_groups
description: Endpoints to control and manage all of the user's object groups. Can
only be created in conjunction with another object (for example a piggy bank)
and will auto-delete when no other items are linked to it.
- name: piggy_banks
description: Endpoints to control and manage all of the user's piggy banks and related
objects and information.
- name: preferences
description: These endpoints can be used to manage the user's preferences, including
some hidden ones.
- name: recurrences
description: Use these endpoints to manage the user's recurring transactions, trigger
the creation of transactions and manage the settings.
- name: rule_groups
description: Manage all of the user's groups of rules and trigger the execution
of entire groups.
- name: rules
description: These endpoints can be used to manage all of the user's rules. Also
includes triggers to execute or test rules and individual triggers.
- name: search
description: Endpoints that allow you to search through the user's financial data.
Different from the autocomplete endpoints, the search accepts more advanced arguments.
- name: summary
description: These endpoints deliver summaries, like sums, lists of numbers and
other processed information. Mainly used for the main dashboard and pretty specific
for Firefly III itself.
- name: tags
description: This endpoint manages all of the user's tags.
- name: transactions
description: The most-used endpoints in Firefly III, these endpoints are used to
manage the user's transactions.
- name: users
description: Use these endpoints to manage the users registered within Firefly III.
You need to have the "owner" role to access these endpoints.
- name: webhooks
description: These endpoints can be used to manage the user's webhooks and triggers
them if necessary.
paths:
/v1/autocomplete/accounts:
get:
tags:
- autocomplete
operationId: getAccountsAC
parameters:
- name: X-Trace-Id
in: header
description: Unique identifier associated with this request.
required: false
schema:
type: string
format: uuid
- in: query
name: query
description: The autocomplete search query.
required: false
schema:
type: string
format: string
example: "string"
- in: query
name: limit
description: The number of items returned.
required: false
schema:
type: integer
format: int32
example: 10
- in: query
name: date
required: false
schema:
type: string
format: string
example: "2020-09-17"
description: If the account is an asset account or a liability, the autocomplete will also return the balance of the account on this date.
- in: query
name: type
description: Optional filter on the account type(s) used in the autocomplete.
required: false
schema:
$ref: '#/components/schemas/AccountTypeFilter'
summary: Returns all accounts of the user returned in a basic auto-complete array.
responses:
401:
description: Unauthenticated
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthenticated'
404:
description: Page not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
400:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
500:
description: Internal exception
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
200:
description: A list of accounts with very basic information.
content:
application/json:
schema:
$ref: '#/components/schemas/AutocompleteAccountArray'
/v1/autocomplete/bills:
get:
tags:
- autocomplete
operationId: getBillsAC
parameters:
- name: X-Trace-Id
in: header
description: Unique identifier associated with this request.
required: false
schema:
type: string
format: uuid
- in: query
name: query
description: The autocomplete search query.
required: false
schema:
type: string
format: string
example: "string"
- in: query
name: limit
description: The number of items returned.
required: false
schema:
type: integer
format: int32
example: 10
summary: Returns all bills of the user returned in a basic auto-complete array.
responses:
401:
description: Unauthenticated
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthenticated'
404:
description: Page not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
400:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
500:
description: Internal exception
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
200:
description: A list of bills with very basic information.
content:
application/json:
schema:
$ref: '#/components/schemas/AutocompleteBillArray'
/v1/autocomplete/budgets:
get:
tags:
- autocomplete
operationId: getBudgetsAC
parameters:
- name: X-Trace-Id
in: header
description: Unique identifier associated with this request.
required: false
schema:
type: string
format: uuid
- in: query
name: query
description: The autocomplete search query.
required: false
schema:
type: string
format: string
example: "string"
- in: query
name: limit
description: The number of items returned.
required: false
schema:
type: integer
format: int32
example: 10
summary: Returns all budgets of the user returned in a basic auto-complete array.
responses:
401:
description: Unauthenticated
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthenticated'
404:
description: Page not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
400:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
500:
description: Internal exception
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
200:
description: A list of budgets with very basic information.
content:
application/json:
schema:
$ref: '#/components/schemas/AutocompleteBudgetArray'
/v1/autocomplete/categories:
get:
tags:
- autocomplete
operationId: getCategoriesAC
parameters:
- name: X-Trace-Id
in: header
description: Unique identifier associated with this request.
required: false
schema:
type: string
format: uuid
- in: query
name: query
description: The autocomplete search query.
required: false
schema:
type: string
format: string
example: "string"
- in: query
name: limit
description: The number of items returned.
required: false
schema:
type: integer
format: int32
example: 10
summary: Returns all categories of the user returned in a basic auto-complete array.
responses:
401:
description: Unauthenticated
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthenticated'
404:
description: Page not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
400:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
500:
description: Internal exception
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
200:
description: A list of categories with very basic information.
content:
application/json:
schema:
$ref: '#/components/schemas/AutocompleteCategoryArray'
/v1/autocomplete/currencies:
get:
tags:
- autocomplete
operationId: getCurrenciesAC
parameters:
- name: X-Trace-Id
in: header
description: Unique identifier associated with this request.
required: false
schema:
type: string
format: uuid
- in: query
name: query
description: The autocomplete search query.
required: false
schema:
type: string
format: string
example: "string"
- in: query
name: limit
description: The number of items returned.
required: false
schema:
type: integer
format: int32
example: 10
summary: Returns all currencies of the user returned in a basic auto-complete array.
responses:
401:
description: Unauthenticated
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthenticated'
404:
description: Page not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
400:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
500:
description: Internal exception
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
200:
description: A list of currencies with very basic information.
content:
application/json:
schema:
$ref: '#/components/schemas/AutocompleteCurrencyArray'
/v1/autocomplete/currencies-with-code:
get:
tags:
- autocomplete
operationId: getCurrenciesCodeAC
parameters:
- name: X-Trace-Id
in: header
description: Unique identifier associated with this request.
required: false
schema:
type: string
format: uuid
- in: query
name: query
description: The autocomplete search query.
required: false
schema:
type: string
format: string
example: "string"
- in: query
name: limit
description: The number of items returned.
required: false
schema:
type: integer
format: int32
example: 10
summary: Returns all currencies of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.
responses:
401:
description: Unauthenticated
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthenticated'
404:
description: Page not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
400:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
500:
description: Internal exception
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
200:
description: A list of currencies with very basic information and the currency code between brackets. This endpoint is DEPRECATED and I suggest you DO NOT use it.
content:
application/json:
schema:
$ref: '#/components/schemas/AutocompleteCurrencyCodeArray'
/v1/autocomplete/object-groups:
get:
tags:
- autocomplete
operationId: getObjectGroupsAC
parameters:
- name: X-Trace-Id
in: header
description: Unique identifier associated with this request.
required: false
schema:
type: string
format: uuid
- in: query
name: query
description: The autocomplete search query.
required: false
schema:
type: string
format: string
example: "string"
- in: query
name: limit
description: The number of items returned.
required: false
schema:
type: integer
format: int32
example: 10
summary: Returns all object groups of the user returned in a basic auto-complete array.
responses:
401:
description: Unauthenticated
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthenticated'
404:
description: Page not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
400:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
500:
description: Internal exception
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
200:
description: A list of object groups with very basic information.
content:
application/json:
schema:
$ref: '#/components/schemas/AutocompleteObjectGroupArray'
/v1/autocomplete/piggy-banks:
get:
tags:
- autocomplete
operationId: getPiggiesAC
parameters:
- name: X-Trace-Id
in: header
description: Unique identifier associated with this request.
required: false
schema:
type: string
format: uuid
- in: query
name: query
description: The autocomplete search query.
required: false
schema:
type: string
format: string
example: "string"
- in: query
name: limit
description: The number of items returned.
required: false
schema:
type: integer
format: int32
example: 10
summary: Returns all piggy banks of the user returned in a basic auto-complete array.
responses:
401:
description: Unauthenticated
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthenticated'
404:
description: Page not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
400:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
500:
description: Internal exception
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
200:
description: A list of piggy banks with very basic information.
content:
application/json:
schema:
$ref: '#/components/schemas/AutocompletePiggyArray'
/v1/autocomplete/piggy-banks-with-balance:
get:
tags:
- autocomplete
operationId: getPiggiesBalanceAC
parameters:
- name: X-Trace-Id
in: header
description: Unique identifier associated with this request.
required: false
schema:
type: string
format: uuid
- in: query
name: query
description: The autocomplete search query.
required: false
schema:
type: string
format: string
example: "string"
- in: query
name: limit
description: The number of items returned.
required: false
schema:
type: integer
format: int32
example: 10
summary: Returns all piggy banks of the user returned in a basic auto-complete array complemented with balance information.
responses:
401:
description: Unauthenticated
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthenticated'
404:
description: Page not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
400:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
500:
description: Internal exception
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
200:
description: A list of piggy banks with very basic balance information.
content:
application/json:
schema:
$ref: '#/components/schemas/AutocompletePiggyBalanceArray'
/v1/autocomplete/recurring:
get:
tags:
- autocomplete
operationId: getRecurringAC
parameters:
- name: X-Trace-Id
in: header
description: Unique identifier associated with this request.
required: false
schema:
type: string
format: uuid
- in: query
name: query
description: The autocomplete search query.
required: false
schema:
type: string
format: string
example: "string"
- in: query
name: limit
description: The number of items returned.
required: false
schema:
type: integer
format: int32
example: 10
summary: Returns all recurring transactions of the user returned in a basic auto-complete array.
responses:
401:
description: Unauthenticated
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthenticated'
404:
description: Page not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
400:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
500:
description: Internal exception
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
200:
description: A list of recurring transactions with very basic information.
content:
application/json:
schema:
$ref: '#/components/schemas/AutocompleteRecurrenceArray'
/v1/autocomplete/rule-groups:
get:
tags:
- autocomplete
operationId: getRuleGroupsAC
parameters:
- name: X-Trace-Id
in: header
description: Unique identifier associated with this request.
required: false
schema:
type: string
format: uuid
- in: query
name: query
description: The autocomplete search query.
required: false
schema:
type: string
format: string
example: "string"
- in: query
name: limit
description: The number of items returned.
required: false
schema:
type: integer
format: int32
example: 10
summary: Returns all rule groups of the user returned in a basic auto-complete array.
responses:
401:
description: Unauthenticated
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthenticated'
404:
description: Page not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
400:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
500:
description: Internal exception
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
200:
description: A list of rule groups with very basic information.
content:
application/json:
schema:
$ref: '#/components/schemas/AutocompleteRuleGroupArray'
/v1/autocomplete/rules:
get:
tags:
- autocomplete
operationId: getRulesAC
parameters:
- name: X-Trace-Id
in: header
description: Unique identifier associated with this request.
required: false
schema:
type: string
format: uuid
- in: query
name: query
description: The autocomplete search query.
required: false
schema:
type: string
format: string
example: "string"
- in: query
name: limit
description: The number of items returned.
required: false
schema:
type: integer
format: int32
example: 10
summary: Returns all rules of the user returned in a basic auto-complete array.
responses:
401:
description: Unauthenticated
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthenticated'
404:
description: Page not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
400:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
500:
description: Internal exception
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
200:
description: A list of rules with very basic information.
content:
application/json:
schema:
$ref: '#/components/schemas/AutocompleteRuleArray'
/v1/autocomplete/tags:
get:
tags:
- autocomplete
operationId: getTagAC
parameters:
- name: X-Trace-Id
in: header
description: Unique identifier associated with this request.
required: false
schema:
type: string
format: uuid
- in: query
name: query
description: The autocomplete search query.
required: false
schema:
type: string
format: string
example: "string"
- in: query
name: limit
description: The number of items returned.
required: false
schema:
type: integer
format: int32
example: 10
summary: Returns all tags of the user returned in a basic auto-complete array.
responses:
401:
description: Unauthenticated
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthenticated'
404:
description: Page not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
400:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
500:
description: Internal exception
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
200:
description: A list of tags with very basic information.
content:
application/json:
schema:
$ref: '#/components/schemas/AutocompleteTagArray'
/v1/autocomplete/transaction-types:
get:
tags:
- autocomplete
operationId: getTransactionTypesAC
parameters:
- name: X-Trace-Id
in: header
description: Unique identifier associated with this request.
required: false
schema:
type: string
format: uuid
- in: query
name: query
description: The autocomplete search query.
required: false
schema:
type: string
format: string
example: "string"
- in: query
name: limit
description: The number of items returned.
required: false
schema:
type: integer
format: int32
example: 10
summary: Returns all transaction types returned in a basic auto-complete array. English only.
responses:
401:
description: Unauthenticated
content:
application/json:
schema:
$ref: '#/components/schemas/Unauthenticated'
404:
description: Page not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFound'
400:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequest'
500:
description: Internal exception
content:
application/json:
schema:
$ref: '#/components/schemas/InternalException'
200:
description: A list of transaction types with very basic information.
content:
application/json:
schema:
$ref: '#/components/schemas/AutocompleteTransactionTypeArray'
/v1/autocomplete/transactions:
get:
tags:
- autocomplete
operationId: getTransactionsAC
parameters:
- name: X-Trace-Id
in: header
description: Unique identifier associated with this request.
required: false
schema:
type: string
format: uuid
- in: query
name: query
description: The autocomplete search query.
required: false
schema:
type: string
format: string
example: "string"
- in: query
name: limit
description: The number of items returned.
required: false
schema:
type: integer
format: int32
example: 10
summary: Returns all transaction descriptions of the user returned in a basic auto-complete array.
responses:
401:
description: Unauthenticated
content: