Schemathesis 4.30.1
API Coverage Report
2026-10-10 11:00:30
Operations
Operations called at least once
100% 243 of 243 called
Parameters
Tested with valid and invalid values
80.4% 686 of 853 covered
Keywords
Constraints tested both ways
61.3% 2528 of 4122 covered
Examples
Schema examples sent in tests
80.8% 1213 of 1500 used
Responses
Documented response codes hit
47.5% 623 of 1309 received
Show
about 4 operations 3 covered 1 partial 0 uncovered 0 not measured 61% #
Headers
X-Trace-Id2 / 2
#validinvalidschema
18777{
28777 "format": "uuid",
3164n/a "type": "string"
48777}
Responses
codedescriptionhitsavg
200The available system information27916ms
400Bad request438ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Headers
X-Trace-Id2 / 2
#validinvalidschema
1178133{
2178133 "format": "uuid",
3311n/a "type": "string"
4178133}
Responses
codedescriptionhitsavg
200The user51416ms
400Bad request498ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Headers
X-Trace-Id2 / 2
#validinvalidschema
110163{
210163 "format": "uuid",
3164n/a "type": "string"
410163}
Responses
codedescriptionhitsavg
204Empty response when the update was successful. A future improvement is to include the changed transactions.0never seen
400Bad request0never seen
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
4153207ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path Parameters
cliToken0 / 2
#validinvalidschema
100{
200 "format": "string",
30n/a "type": "string"
400}
Query Parameters
date0 / 2
100{
200 "format": "date",
30n/a "type": "string"
400}
force0 / 1
100{
200 "type": "boolean"
300}
Headers
X-Trace-Id2 / 2
120960{
220960 "format": "uuid",
3269n/a "type": "string"
420960}
Responses
codedescriptionhitsavg
200The result of the cron job(s) firing.45516ms
400Bad request0never seen
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"d5ea6b5fb774618dd6ad6ba6e0a7f55c"cliToken
Query
"2026-10-01"date
falseforce
accounts 8 operations 5 covered 3 partial 0 uncovered 0 not measured 63% #
Query Parameters
limit1 / 2
#validinvalidschema
1551{
2551 "format": "int32",
3560 "type": "integer"
4551}
page2 / 2
1521{
2521 "format": "int32",
3521 "type": "integer"
4521}
active0 / 2
1850{
200 "format": "boolean",
3850 "type": "boolean"
4850}
start1 / 2
1120{
2120 "format": "date",
312n/a "type": "string"
4120}
end1 / 2
1120{
2120 "format": "date",
312n/a "type": "string"
4120}
date2 / 2
1153{
2153 "format": "date",
318n/a "type": "string"
4153}
type2 / 2
AccountTypeFilter
1301{
2301 "enum": [
37n/a "all",
42n/a "asset",
53n/a "cash",
61n/a "expense",
73n/a "revenue",
82n/a "special",
97n/a "hidden",
100n/a "liability",
110n/a "liabilities",
120n/a "Default account",
130n/a "Cash account",
140n/a "Asset account",
150n/a "Expense account",
160n/a "Revenue account",
170n/a "Initial balance account",
180n/a "Beneficiary account",
191n/a "Import account",
202n/a "Reconciliation account",
212n/a "Loan",
220n/a "Debt",
230n/a "Mortgage"
24301 ],
2531n/a "type": "string"
26301}
Headers
X-Trace-Id2 / 2
128152{
228152 "format": "uuid",
3333n/a "type": "string"
428152}
Responses
codedescriptionhitsavg
200A list of accounts53420ms
400Bad request248ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
trueactive
Headers
X-Trace-Id2 / 2
#validinvalidschema
122739{
222739 "format": "uuid",
3266n/a "type": "string"
422739}
Body
application/json18 / 76
AccountStore
1914{
2914 "properties": {
3150 "account_number": {
400 "format": "string",
515n/a "nullable": true,
6150 "type": "string"
7150 },
8150 "account_role": {
10150 },
11140 "active": {
12140 "type": "boolean"
13140 },
14130 "bic": {
1500 "format": "string",
1613n/a "nullable": true,
17130 "type": "string"
18130 },
19130 "credit_card_type": {
21130 },
22160 "currency_code": {
2300 "format": "string",
24160 "type": "string"
25160 },
26120 "currency_id": {
2700 "format": "string",
28120 "type": "string"
29120 },
30130 "iban": {
3100 "format": "iban",
3213n/a "nullable": true,
33130 "type": "string"
34130 },
35140 "include_net_worth": {
36140 "type": "boolean"
37140 },
38130 "interest": {
3900 "format": "string",
4013n/a "nullable": true,
41130 "type": "string"
42130 },
43140 "interest_period": {
45140 },
46113 "latitude": {
47113 "format": "double",
4814n/a "nullable": true,
49140 "type": "number"
50113 },
51120 "liability_direction": {
53120 },
54150 "liability_type": {
56150 },
57213 "longitude": {
58213 "format": "double",
5915n/a "nullable": true,
60150 "type": "number"
61213 },
62160 "monthly_payment_date": {
63150 "format": "date-time",
6416n/a "nullable": true,
65160 "type": "string"
66160 },
67230 "name": {
6800 "format": "string",
69230 "type": "string"
70230 },
71130 "notes": {
7200 "format": "string",
7313n/a "nullable": true,
74130 "type": "string"
75130 },
76160 "opening_balance": {
7700 "format": "amount",
78160 "type": "string"
79160 },
80130 "opening_balance_date": {
81130 "format": "date-time",
8213n/a "nullable": true,
83130 "type": "string"
84130 },
85130 "order": {
86130 "format": "int32",
87130 "type": "integer"
88130 },
89230 "type": {
91230 },
92130 "virtual_balance": {
9300 "format": "amount",
94130 "type": "string"
95130 },
96140 "zoom_level": {
97140 "format": "int32",
9814n/a "nullable": true,
99140 "type": "integer"
100140 }
101914 },
102230 "required": [
103230 "name",
104230 "type"
105230 ],
106230 "type": "object"
107914}
Referenced Components (6)5 of 29 keywords
AccountRoleProperty1 of 5 keywords
1150{
2150 "enum": [
31n/a "defaultAsset",
40n/a "sharedAsset",
50n/a "savingAsset",
60n/a "ccAsset",
70n/a "cashWalletAsset",
814n/a null
9150 ],
1000 "format": "string",
1115n/a "nullable": true,
12150 "type": "string"
13150}
CreditCardTypeProperty1 of 5 keywords
1130{
2130 "enum": [
30n/a "monthlyFull",
413n/a null
5130 ],
600 "format": "string",
713n/a "nullable": true,
8130 "type": "string"
9130}
InterestPeriodProperty1 of 5 keywords
1140{
2140 "enum": [
32n/a "daily",
40n/a "weekly",
50n/a "monthly",
60n/a "quarterly",
70n/a "half-year",
80n/a "yearly",
912n/a null
10140 ],
1100 "format": "string",
1214n/a "nullable": true,
13140 "type": "string"
14140}
LiabilityDirectionProperty1 of 5 keywords
1120{
2120 "enum": [
30n/a "credit",
40n/a "debit",
512n/a null
6120 ],
700 "format": "string",
812n/a "nullable": true,
9120 "type": "string"
10120}
LiabilityTypeProperty1 of 5 keywords
1150{
2150 "enum": [
30n/a "loan",
41n/a "debt",
52n/a "mortgage",
612n/a null
7150 ],
800 "format": "string",
915n/a "nullable": true,
10150 "type": "string"
11150}
ShortAccountTypeProperty0 of 4 keywords
1230{
2230 "enum": [
313n/a "asset",
42n/a "expense",
52n/a "import",
62n/a "revenue",
71n/a "cash",
81n/a "liability",
90n/a "liabilities",
100n/a "initial-balance",
112n/a "reconciliation"
12230 ],
1300 "format": "string",
14230 "type": "string"
15230}
application/x-www-form-urlencoded41 / 76
AccountStore
1103{
2103 "properties": {
330 "account_number": {
400 "format": "string",
53n/a "nullable": true,
63n/a "type": "string"
730 },
812 "account_role": {
1012 },
1110 "active": {
1210 "type": "boolean"
1310 },
1440 "bic": {
1500 "format": "string",
164n/a "nullable": true,
174n/a "type": "string"
1840 },
1910 "credit_card_type": {
2110 },
2230 "currency_code": {
2300 "format": "string",
243n/a "type": "string"
2530 },
2630 "currency_id": {
2700 "format": "string",
283n/a "type": "string"
2930 },
3020 "iban": {
3100 "format": "iban",
322n/a "nullable": true,
332n/a "type": "string"
3420 },
3540 "include_net_worth": {
3640 "type": "boolean"
3740 },
3830 "interest": {
3900 "format": "string",
403n/a "nullable": true,
413n/a "type": "string"
4230 },
4311 "interest_period": {
4511 },
4630 "latitude": {
4730 "format": "double",
483n/a "nullable": true,
4930 "type": "number"
5030 },
5130 "liability_direction": {
5330 },
5430 "liability_type": {
5630 },
5730 "longitude": {
5830 "format": "double",
593n/a "nullable": true,
6030 "type": "number"
6130 },
6230 "monthly_payment_date": {
6330 "format": "date-time",
643n/a "nullable": true,
653n/a "type": "string"
6630 },
67110 "name": {
6800 "format": "string",
6911n/a "type": "string"
70110 },
7130 "notes": {
7200 "format": "string",
733n/a "nullable": true,
743n/a "type": "string"
7530 },
7640 "opening_balance": {
7700 "format": "amount",
784n/a "type": "string"
7940 },
8012 "opening_balance_date": {
8112 "format": "date-time",
823n/a "nullable": true,
833n/a "type": "string"
8412 },
8540 "order": {
8640 "format": "int32",
8740 "type": "integer"
8840 },
89130 "type": {
91130 },
9210 "virtual_balance": {
9300 "format": "amount",
941n/a "type": "string"
9510 },
9630 "zoom_level": {
9730 "format": "int32",
983n/a "nullable": true,
9930 "type": "integer"
10030 }
101103 },
102112 "required": [
103112 "name",
104130 "type"
105112 ],
10613n/a "type": "object"
107103}
Referenced Components (6)15 of 29 keywords
AccountRoleProperty4 of 5 keywords
112{
212 "enum": [
31n/a "defaultAsset",
40n/a "sharedAsset",
50n/a "savingAsset",
60n/a "ccAsset",
70n/a "cashWalletAsset",
80n/a null
912 ],
1000 "format": "string",
113n/a "nullable": true,
123n/a "type": "string"
1312}
CreditCardTypeProperty2 of 5 keywords
110{
210 "enum": [
31n/a "monthlyFull",
40n/a null
510 ],
600 "format": "string",
71n/a "nullable": true,
81n/a "type": "string"
910}
InterestPeriodProperty4 of 5 keywords
111{
211 "enum": [
30n/a "daily",
40n/a "weekly",
51n/a "monthly",
60n/a "quarterly",
70n/a "half-year",
80n/a "yearly",
90n/a null
1011 ],
1100 "format": "string",
122n/a "nullable": true,
132n/a "type": "string"
1411}
LiabilityDirectionProperty2 of 5 keywords
130{
230 "enum": [
31n/a "credit",
42n/a "debit",
50n/a null
630 ],
700 "format": "string",
83n/a "nullable": true,
93n/a "type": "string"
1030}
LiabilityTypeProperty2 of 5 keywords
130{
230 "enum": [
31n/a "loan",
42n/a "debt",
50n/a "mortgage",
60n/a null
730 ],
800 "format": "string",
93n/a "nullable": true,
103n/a "type": "string"
1130}
ShortAccountTypeProperty1 of 4 keywords
1130{
2130 "enum": [
31n/a "asset",
40n/a "expense",
50n/a "import",
611n/a "revenue",
70n/a "cash",
81n/a "liability",
90n/a "liabilities",
100n/a "initial-balance",
110n/a "reconciliation"
12130 ],
1300 "format": "string",
1413n/a "type": "string"
15130}
Responses
codedescriptionhitsavg
200New account stored, result in response.37717ms
400Bad request258ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41517ms
Examples
Body: application/json
"7009312345678"AccountStore.account_number
"defaultAsset"AccountRoleProperty
trueAccountStore.active
falseAccountStore.active
"BOFAUS3N"AccountStore.bic
"monthlyFull"CreditCardTypeProperty
"EUR"AccountStore.currency_code
"12"AccountStore.currency_id
"GB98MIDL07009312345678"AccountStore.iban
trueAccountStore.include_net_worth
trueAccountStore.include_net_worth
"0"AccountStore.interest
"5.3"AccountStore.interest
"monthly"InterestPeriodProperty
51.983333AccountStore.latitude
"credit"LiabilityDirectionProperty
"loan"LiabilityTypeProperty
5.916667AccountStore.longitude
"2026-10-01T00:00:00+00:00"AccountStore.monthly_payment_date
"My checking account"AccountStore.name
"Some example notes"AccountStore.notes
"-1012.12"AccountStore.opening_balance
"2026-10-01T00:00:00+00:00"AccountStore.opening_balance_date
1AccountStore.order
"asset"ShortAccountTypeProperty
"123.45"AccountStore.virtual_balance
6AccountStore.zoom_level
Body: application/x-www-form-urlencoded
"7009312345678"AccountStore.account_number
"defaultAsset"AccountRoleProperty
trueAccountStore.active
falseAccountStore.active
"BOFAUS3N"AccountStore.bic
"monthlyFull"CreditCardTypeProperty
"EUR"AccountStore.currency_code
"12"AccountStore.currency_id
"GB98MIDL07009312345678"AccountStore.iban
trueAccountStore.include_net_worth
trueAccountStore.include_net_worth
"0"AccountStore.interest
"5.3"AccountStore.interest
"monthly"InterestPeriodProperty
51.983333AccountStore.latitude
"credit"LiabilityDirectionProperty
"loan"LiabilityTypeProperty
5.916667AccountStore.longitude
"2026-10-01T00:00:00+00:00"AccountStore.monthly_payment_date
"My checking account"AccountStore.name
"Some example notes"AccountStore.notes
"-1012.12"AccountStore.opening_balance
"2026-10-01T00:00:00+00:00"AccountStore.opening_balance_date
1AccountStore.order
"asset"ShortAccountTypeProperty
"123.45"AccountStore.virtual_balance
6AccountStore.zoom_level
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path Parameters
id1 / 1
#validinvalidschema
1159n/a{
2159n/a "type": "string"
3159n/a}
Headers
X-Trace-Id2 / 2
14335{
24335 "format": "uuid",
378n/a "type": "string"
44335}
Responses
codedescriptionhitsavg
204Account deleted533ms
400Bad request198ms
401Unauthenticated0never seen
404Page not found13514ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK316ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1474n/a{
2474n/a "type": "string"
3474n/a}
Query Parameters
start2 / 2
115038{
215038 "format": "date",
3188n/a "type": "string"
415038}
end2 / 2
115239{
215239 "format": "date",
3191n/a "type": "string"
415239}
date2 / 2
115838{
215838 "format": "date",
3196n/a "type": "string"
415838}
Headers
X-Trace-Id2 / 2
120347{
220347 "format": "uuid",
3250n/a "type": "string"
420347}
Responses
codedescriptionhitsavg
200The requested account2019ms
400Bad request268ms
401Unauthenticated0never seen
404Page not found44115ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1794n/a{
2794n/a "type": "string"
3794n/a}
Headers
X-Trace-Id2 / 2
157239{
257239 "format": "uuid",
3611n/a "type": "string"
457239}
Body
application/json53 / 67
AccountUpdate
1213225{
2213217 "properties": {
32215 "account_number": {
400 "format": "string",
5226n/a "nullable": true,
62215 "type": "string"
72215 },
82315 "account_role": {
102315 },
112185 "active": {
122185 "type": "boolean"
132185 },
142344 "bic": {
1500 "format": "string",
16238n/a "nullable": true,
172344 "type": "string"
182344 },
192128 "credit_card_type": {
212128 },
222255 "currency_code": {
2300 "format": "string",
242255 "type": "string"
252255 },
262235 "currency_id": {
2700 "format": "string",
282235 "type": "string"
292235 },
302264 "iban": {
3100 "format": "iban",
32230n/a "nullable": true,
332264 "type": "string"
342264 },
352155 "include_net_worth": {
362155 "type": "boolean"
372155 },
382084 "interest": {
3900 "format": "string",
40212n/a "nullable": true,
412084 "type": "string"
422084 },
432175 "interest_period": {
452175 },
4616193 "latitude": {
4716193 "format": "double",
48209n/a "nullable": true,
492054 "type": "number"
5016193 },
512225 "liability_type": {
532225 },
5423187 "longitude": {
5523187 "format": "double",
56210n/a "nullable": true,
572064 "type": "number"
5823187 },
592117 "monthly_payment_date": {
602033 "format": "date-time",
61218n/a "nullable": true,
622144 "type": "string"
632117 },
644225 "name": {
6500 "format": "string",
664225 "type": "string"
674225 },
682204 "notes": {
6900 "format": "string",
70224n/a "nullable": true,
712204 "type": "string"
722204 },
732145 "opening_balance": {
7400 "format": "amount",
752145 "type": "string"
762145 },
772116 "opening_balance_date": {
782062 "format": "date-time",
79217n/a "nullable": true,
802134 "type": "string"
812116 },
822028 "order": {
832028 "format": "int32",
842046 "type": "integer"
852028 },
862125 "virtual_balance": {
8700 "format": "amount",
882125 "type": "string"
892125 },
9018220 "zoom_level": {
9118220 "format": "int32",
92202n/a "nullable": true,
931975 "type": "integer"
9418220 }
95213217 },
964267 "required": [
974276 "name",
984321 "type"
994267 ],
1004335 "type": "object"
101213225}
Referenced Components (4)16 of 20 keywords
AccountRoleProperty4 of 5 keywords
12315{
22315 "enum": [
317n/a "defaultAsset",
44n/a "sharedAsset",
56n/a "savingAsset",
611n/a "ccAsset",
73n/a "cashWalletAsset",
8190n/a null
92315 ],
1000 "format": "string",
11236n/a "nullable": true,
122324 "type": "string"
132315}
CreditCardTypeProperty4 of 5 keywords
12128{
22128 "enum": [
320n/a "monthlyFull",
4192n/a null
52128 ],
600 "format": "string",
7220n/a "nullable": true,
82137 "type": "string"
92128}
InterestPeriodProperty4 of 5 keywords
12175{
22175 "enum": [
35n/a "daily",
42n/a "weekly",
516n/a "monthly",
61n/a "quarterly",
714n/a "half-year",
84n/a "yearly",
9175n/a null
102175 ],
1100 "format": "string",
12222n/a "nullable": true,
132184 "type": "string"
142175}
LiabilityTypeProperty4 of 5 keywords
12225{
22225 "enum": [
311n/a "loan",
47n/a "debt",
55n/a "mortgage",
6199n/a null
72225 ],
800 "format": "string",
9227n/a "nullable": true,
102234 "type": "string"
112225}
application/x-www-form-urlencoded53 / 67
AccountUpdate
170198{
295173 "properties": {
31430 "account_number": {
400 "format": "string",
5143n/a "nullable": true,
6143n/a "type": "string"
71430 },
833109 "account_role": {
1033109 },
111282 "active": {
121282 "type": "boolean"
131282 },
141410 "bic": {
1500 "format": "string",
16141n/a "nullable": true,
17141n/a "type": "string"
181410 },
1919131 "credit_card_type": {
2119131 },
221330 "currency_code": {
2300 "format": "string",
24133n/a "type": "string"
251330 },
261540 "currency_id": {
2700 "format": "string",
28154n/a "type": "string"
291540 },
301380 "iban": {
3100 "format": "iban",
32138n/a "nullable": true,
33138n/a "type": "string"
341380 },
351322 "include_net_worth": {
361322 "type": "boolean"
371322 },
381380 "interest": {
3900 "format": "string",
40138n/a "nullable": true,
41138n/a "type": "string"
421380 },
4327108 "interest_period": {
4527108 },
4614111 "latitude": {
4714111 "format": "double",
48125n/a "nullable": true,
4914111 "type": "number"
5014111 },
5118118 "liability_type": {
5318118 },
5412112 "longitude": {
5512112 "format": "double",
56124n/a "nullable": true,
5712112 "type": "number"
5812112 },
5911014 "monthly_payment_date": {
6011014 "format": "date-time",
61124n/a "nullable": true,
62124n/a "type": "string"
6311014 },
642660 "name": {
6500 "format": "string",
66266n/a "type": "string"
672660 },
681270 "notes": {
6900 "format": "string",
70127n/a "nullable": true,
71127n/a "type": "string"
721270 },
731290 "opening_balance": {
7400 "format": "amount",
75129n/a "type": "string"
761290 },
7712311 "opening_balance_date": {
7812311 "format": "date-time",
79134n/a "nullable": true,
80134n/a "type": "string"
8112311 },
821336 "order": {
831336 "format": "int32",
841363 "type": "integer"
851336 },
861090 "virtual_balance": {
8700 "format": "amount",
88109n/a "type": "string"
891090 },
9010511 "zoom_level": {
9110511 "format": "int32",
92116n/a "nullable": true,
931079 "type": "integer"
9410511 }
9595173 },
9622642 "required": [
972662 "name",
9822840 "type"
9922642 ],
100268n/a "type": "object"
10170198}
Referenced Components (4)16 of 20 keywords
AccountRoleProperty4 of 5 keywords
133109{
233109 "enum": [
311n/a "defaultAsset",
413n/a "sharedAsset",
53n/a "savingAsset",
64n/a "ccAsset",
72n/a "cashWalletAsset",
80n/a null
933109 ],
1000 "format": "string",
11142n/a "nullable": true,
12142n/a "type": "string"
1333109}
CreditCardTypeProperty4 of 5 keywords
119131{
219131 "enum": [
319n/a "monthlyFull",
40n/a null
519131 ],
600 "format": "string",
7150n/a "nullable": true,
8150n/a "type": "string"
919131}
InterestPeriodProperty4 of 5 keywords
127108{
227108 "enum": [
311n/a "daily",
42n/a "weekly",
56n/a "monthly",
62n/a "quarterly",
73n/a "half-year",
83n/a "yearly",
90n/a null
1027108 ],
1100 "format": "string",
12135n/a "nullable": true,
13135n/a "type": "string"
1427108}
LiabilityTypeProperty4 of 5 keywords
118118{
218118 "enum": [
35n/a "loan",
43n/a "debt",
510n/a "mortgage",
60n/a null
718118 ],
800 "format": "string",
9136n/a "nullable": true,
10136n/a "type": "string"
1118118}
Responses
codedescriptionhitsavg
200Updated account stored, result in response7416ms
400Bad request348ms
401Unauthenticated0never seen
404Page not found75514ms
422Validation error. The body will have the exact details.0never seen
500Internal exception218ms
Undocumented - not in spec
codedescriptionhitsavg
41537ms
Examples
Body: application/json
"7009312345678"AccountUpdate.account_number
"defaultAsset"AccountRoleProperty
trueAccountUpdate.active
falseAccountUpdate.active
"BOFAUS3N"AccountUpdate.bic
"monthlyFull"CreditCardTypeProperty
"EUR"AccountUpdate.currency_code
"12"AccountUpdate.currency_id
"GB98MIDL07009312345678"AccountUpdate.iban
trueAccountUpdate.include_net_worth
trueAccountUpdate.include_net_worth
"5.3"AccountUpdate.interest
"monthly"InterestPeriodProperty
51.983333AccountUpdate.latitude
"loan"LiabilityTypeProperty
5.916667AccountUpdate.longitude
"2026-10-01T00:00:00+00:00"AccountUpdate.monthly_payment_date
"My checking account"AccountUpdate.name
"Some example notes"AccountUpdate.notes
"-1012.12"AccountUpdate.opening_balance
"2026-10-01T00:00:00+00:00"AccountUpdate.opening_balance_date
1AccountUpdate.order
"123.45"AccountUpdate.virtual_balance
6AccountUpdate.zoom_level
Body: application/x-www-form-urlencoded
"7009312345678"AccountUpdate.account_number
"defaultAsset"AccountRoleProperty
trueAccountUpdate.active
falseAccountUpdate.active
"BOFAUS3N"AccountUpdate.bic
"monthlyFull"CreditCardTypeProperty
"EUR"AccountUpdate.currency_code
"12"AccountUpdate.currency_id
"GB98MIDL07009312345678"AccountUpdate.iban
trueAccountUpdate.include_net_worth
trueAccountUpdate.include_net_worth
"5.3"AccountUpdate.interest
"monthly"InterestPeriodProperty
51.983333AccountUpdate.latitude
"loan"LiabilityTypeProperty
5.916667AccountUpdate.longitude
"2026-10-01T00:00:00+00:00"AccountUpdate.monthly_payment_date
"My checking account"AccountUpdate.name
"Some example notes"AccountUpdate.notes
"-1012.12"AccountUpdate.opening_balance
"2026-10-01T00:00:00+00:00"AccountUpdate.opening_balance_date
1AccountUpdate.order
"123.45"AccountUpdate.virtual_balance
6AccountUpdate.zoom_level
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1425n/a{
2425n/a "type": "string"
3425n/a}
Query Parameters
limit2 / 2
120153{
220153 "format": "int32",
321935 "type": "integer"
420153}
page2 / 2
117652{
217652 "format": "int32",
319632 "type": "integer"
417652}
Headers
X-Trace-Id2 / 2
123950{
223950 "format": "uuid",
3289n/a "type": "string"
423950}
Responses
codedescriptionhitsavg
200A list of attachments14418ms
400Bad request298ms
401Unauthenticated0never seen
404Page not found38715ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
Path Parameters
id1 / 1
#validinvalidschema
1397n/a{
2397n/a "type": "string"
3397n/a}
Query Parameters
limit2 / 2
116647{
216647 "format": "int32",
318231 "type": "integer"
416647}
page2 / 2
114549{
214549 "format": "int32",
316727 "type": "integer"
414549}
Headers
X-Trace-Id2 / 2
116570{
216570 "format": "uuid",
3235n/a "type": "string"
416570}
Responses
codedescriptionhitsavg
200A list of piggy banks9116ms
400Bad request338ms
401Unauthenticated0never seen
404Page not found36215ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
Path Parameters
id1 / 1
#validinvalidschema
1554n/a{
2554n/a "type": "string"
3554n/a}
Query Parameters
limit2 / 2
125135{
225135 "format": "int32",
326719 "type": "integer"
425135}
page2 / 2
123242{
223242 "format": "int32",
325222 "type": "integer"
423242}
start2 / 2
124528{
224528 "format": "date",
3273n/a "type": "string"
424528}
end2 / 2
121830{
221830 "format": "date",
3248n/a "type": "string"
421830}
type2 / 2
TransactionTypeFilter
118819{
218819 "enum": [
364n/a "all",
413n/a "withdrawal",
510n/a "withdrawals",
69n/a "expense",
714n/a "deposit",
85n/a "deposits",
912n/a "income",
109n/a "transfer",
1115n/a "transfers",
125n/a "opening_balance",
1311n/a "reconciliation",
145n/a "special",
153n/a "specials",
1613n/a "default"
1718819 ],
18207n/a "type": "string"
1918819}
Headers
X-Trace-Id2 / 2
128542{
228542 "format": "uuid",
3327n/a "type": "string"
428542}
Responses
codedescriptionhitsavg
200A list of transactions4220ms
400Bad request288ms
401Unauthenticated0never seen
404Page not found52415ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
"2026-10-01"start
"2026-10-31"end
attachments 7 operations 5 covered 2 partial 0 uncovered 0 not measured 65% #
Query Parameters
limit2 / 2
#validinvalidschema
1916{
2916 "format": "int32",
3943 "type": "integer"
4916}
page2 / 2
1816{
2816 "format": "int32",
3852 "type": "integer"
4816}
Headers
X-Trace-Id2 / 2
126756{
226756 "format": "uuid",
3323n/a "type": "string"
426756}
Responses
codedescriptionhitsavg
200A list of attachments.51917ms
400Bad request328ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
Headers
X-Trace-Id2 / 2
#validinvalidschema
137555{
237555 "format": "uuid",
3430n/a "type": "string"
437555}
Body
application/json6 / 16
AttachmentStore
1167{
2174 "properties": {
3210 "attachable_id": {
400 "format": "string",
5210 "type": "string"
6210 },
7210 "attachable_type": {
9210 },
10173 "filename": {
1100 "format": "string",
12173 "type": "string"
13173 },
14154 "notes": {
1500 "format": "string",
1619n/a "nullable": true,
17154 "type": "string"
18154 },
19160 "title": {
2000 "format": "string",
21160 "type": "string"
22160 }
23174 },
24201 "required": [
25201 "filename",
26210 "attachable_type",
27210 "attachable_id"
28201 ],
29212 "type": "object"
30167}
Referenced Components (1)0 of 4 keywords
AttachableType0 of 4 keywords
1210{
2210 "enum": [
33n/a "Account",
40n/a "Budget",
513n/a "Bill",
60n/a "TransactionJournal",
73n/a "PiggyBank",
82n/a "Tag"
9210 ],
1000 "format": "string",
11210 "type": "string"
12210}
application/x-www-form-urlencoded7 / 16
AttachmentStore
140{
240 "properties": {
340 "attachable_id": {
400 "format": "string",
54n/a "type": "string"
640 },
740 "attachable_type": {
940 },
1040 "filename": {
1100 "format": "string",
124n/a "type": "string"
1340 },
1420 "notes": {
1500 "format": "string",
162n/a "nullable": true,
172n/a "type": "string"
1820 },
1920 "title": {
2000 "format": "string",
212n/a "type": "string"
2220 }
2340 },
2440 "required": [
2540 "filename",
2640 "attachable_type",
2740 "attachable_id"
2840 ],
294n/a "type": "object"
3040}
Referenced Components (1)1 of 4 keywords
AttachableType1 of 4 keywords
140{
240 "enum": [
30n/a "Account",
40n/a "Budget",
50n/a "Bill",
63n/a "TransactionJournal",
71n/a "PiggyBank",
80n/a "Tag"
940 ],
1000 "format": "string",
114n/a "type": "string"
1240}
Responses
codedescriptionhitsavg
200New attachment stored, result in response.69717ms
400Bad request298ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41537ms
Examples
Body: application/json
"134"AttachmentStore.attachable_id
"Bill"AttachableType
"file.pdf"AttachmentStore.filename
"Some notes"AttachmentStore.notes
"Some PDF file"AttachmentStore.title
Body: application/x-www-form-urlencoded
"134"AttachmentStore.attachable_id
"Bill"AttachableType
"file.pdf"AttachmentStore.filename
"Some notes"AttachmentStore.notes
"Some PDF file"AttachmentStore.title
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path Parameters
id1 / 1
#validinvalidschema
190n/a{
290n/a "type": "string"
390n/a}
Headers
X-Trace-Id2 / 2
18440{
28440 "format": "uuid",
3124n/a "type": "string"
48440}
Responses
codedescriptionhitsavg
204Attachment deleted.0never seen
400Bad request228ms
401Unauthenticated0never seen
404Page not found6814ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK5315ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1377n/a{
2377n/a "type": "string"
3377n/a}
Headers
X-Trace-Id2 / 2
112268{
212268 "format": "uuid",
3190n/a "type": "string"
412268}
Responses
codedescriptionhitsavg
200The requested attachment116ms
400Bad request448ms
401Unauthenticated0never seen
404Page not found33314ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1438n/a{
2438n/a "type": "string"
3438n/a}
Headers
X-Trace-Id2 / 2
120046{
220046 "format": "uuid",
3246n/a "type": "string"
420046}
Body
application/json6 / 9
AttachmentUpdate
122821{
214216 "properties": {
31016 "filename": {
400 "format": "string",
51016 "type": "string"
61016 },
71045 "notes": {
800 "format": "string",
9109n/a "nullable": true,
101045 "type": "string"
111045 },
121286 "title": {
1300 "format": "string",
141286 "type": "string"
151286 }
1614216 },
172445 "type": "object"
1822821}
application/x-www-form-urlencoded5 / 9
AttachmentUpdate
11050{
2930 "properties": {
3700 "filename": {
400 "format": "string",
570n/a "type": "string"
6700 },
7620 "notes": {
800 "format": "string",
962n/a "nullable": true,
1062n/a "type": "string"
11620 },
12680 "title": {
1300 "format": "string",
1468n/a "type": "string"
15680 }
16930 },
17105n/a "type": "object"
181050}
Responses
codedescriptionhitsavg
200Updated attachment stored, result in response7620ms
400Bad request268ms
401Unauthenticated0never seen
404Page not found40915ms
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41537ms
Examples
Body: application/json
"file.pdf"AttachmentUpdate.filename
"Some notes"AttachmentUpdate.notes
"Some PDF file"AttachmentUpdate.title
Body: application/x-www-form-urlencoded
"file.pdf"AttachmentUpdate.filename
"Some notes"AttachmentUpdate.notes
"Some PDF file"AttachmentUpdate.title
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1125n/a{
2125n/a "type": "string"
3125n/a}
Headers
X-Trace-Id2 / 2
12956{
22956 "format": "uuid",
385n/a "type": "string"
42956}
Responses
codedescriptionhitsavg
200The requested attachment10816ms
400Bad request298ms
401Unauthenticated0never seen
404Page not found9615ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1179n/a{
2179n/a "type": "string"
3179n/a}
Headers
X-Trace-Id2 / 2
16044{
26044 "format": "uuid",
3104n/a "type": "string"
46044}
Body
application/octet-stream2 / 2
1147n/a{
2147n/a "format": "binary",
3147n/a "type": "string"
4147n/a}
Responses
codedescriptionhitsavg
204Upload was a success0never seen
400Bad request288ms
401Unauthenticated0never seen
404Page not found15114ms
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK12416ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
autocomplete 15 operations 0 covered 15 partial 0 uncovered 0 not measured 70% #
Query Parameters
query1 / 2
#validinvalidschema
11220{
200 "format": "string",
3122n/a "type": "string"
41220}
limit1 / 2
11123{
21123 "format": "int32",
31150 "type": "integer"
41123}
date1 / 2
1950{
200 "format": "string",
395n/a "type": "string"
4950}
types4 / 4
1649{
2649 "items": {
4649 },
573n/a "type": "array"
6649}
Referenced Components (1)3 of 3 keywords
AccountTypeFilter3 of 3 keywords
12299{
22299 "enum": [
326n/a "all",
48n/a "asset",
59n/a "cash",
69n/a "expense",
73n/a "revenue",
89n/a "special",
97n/a "hidden",
1015n/a "liability",
116n/a "liabilities",
1215n/a "Default account",
1310n/a "Cash account",
145n/a "Asset account",
1510n/a "Expense account",
1613n/a "Revenue account",
178n/a "Initial balance account",
1810n/a "Beneficiary account",
1918n/a "Import account",
2015n/a "Reconciliation account",
2111n/a "Loan",
2214n/a "Debt",
238n/a "Mortgage"
242299 ],
25238n/a "type": "string"
262299}
Headers
X-Trace-Id2 / 2
124547{
224547 "format": "uuid",
3292n/a "type": "string"
424547}
Responses
codedescriptionhitsavg
200A list of accounts with very basic information.47119ms
400Bad request318ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
query1 / 2
#validinvalidschema
11280{
200 "format": "string",
3128n/a "type": "string"
41280}
limit0 / 2
11160{
21160 "format": "int32",
31160 "type": "integer"
41160}
Headers
X-Trace-Id2 / 2
121656{
221656 "format": "uuid",
3272n/a "type": "string"
421656}
Responses
codedescriptionhitsavg
200A list of bills with very basic information.44118ms
400Bad request338ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
query1 / 2
#validinvalidschema
11220{
200 "format": "string",
3122n/a "type": "string"
41220}
limit2 / 2
11184{
21184 "format": "int32",
31211 "type": "integer"
41184}
Headers
X-Trace-Id2 / 2
117147{
217147 "format": "uuid",
3218n/a "type": "string"
417147}
Responses
codedescriptionhitsavg
200A list of budgets with very basic information.39819ms
400Bad request368ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
query1 / 2
#validinvalidschema
11280{
200 "format": "string",
3128n/a "type": "string"
41280}
limit0 / 2
11170{
21170 "format": "int32",
31170 "type": "integer"
41170}
Headers
X-Trace-Id2 / 2
118336{
218336 "format": "uuid",
3219n/a "type": "string"
418336}
Responses
codedescriptionhitsavg
200A list of categories with very basic information.43418ms
400Bad request218ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
query1 / 2
#validinvalidschema
1890{
200 "format": "string",
389n/a "type": "string"
4890}
limit2 / 2
1646{
2646 "format": "int32",
3682 "type": "integer"
4646}
Headers
X-Trace-Id2 / 2
18744{
28744 "format": "uuid",
3131n/a "type": "string"
48744}
Responses
codedescriptionhitsavg
200A list of currencies with very basic information.28918ms
400Bad request288ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
query1 / 2
#validinvalidschema
11220{
200 "format": "string",
3122n/a "type": "string"
41220}
limit0 / 2
11180{
21180 "format": "int32",
31180 "type": "integer"
41180}
Headers
X-Trace-Id2 / 2
119535{
219535 "format": "uuid",
3230n/a "type": "string"
419535}
Responses
codedescriptionhitsavg
200A list of object groups with very basic information.44118ms
400Bad request278ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
query1 / 2
#validinvalidschema
11500{
200 "format": "string",
3150n/a "type": "string"
41500}
limit1 / 2
11334{
21334 "format": "int32",
31370 "type": "integer"
41334}
Headers
X-Trace-Id2 / 2
120638{
220638 "format": "uuid",
3244n/a "type": "string"
420638}
Responses
codedescriptionhitsavg
200A list of piggy banks with basic information.44619ms
400Bad request318ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
query1 / 2
#validinvalidschema
11270{
200 "format": "string",
3127n/a "type": "string"
41270}
limit2 / 2
11195{
21195 "format": "int32",
31195 "type": "integer"
41195}
Headers
X-Trace-Id2 / 2
119442{
219442 "format": "uuid",
3236n/a "type": "string"
419442}
Responses
codedescriptionhitsavg
200A list of recurring transactions with very basic information.45918ms
400Bad request228ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
query1 / 2
#validinvalidschema
11300{
200 "format": "string",
3130n/a "type": "string"
41300}
limit2 / 2
11081{
21081 "format": "int32",
31081 "type": "integer"
41081}
Headers
X-Trace-Id2 / 2
119030{
219030 "format": "uuid",
3220n/a "type": "string"
419030}
Responses
codedescriptionhitsavg
200A list of rule groups with very basic information.43618ms
400Bad request258ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
query1 / 2
#validinvalidschema
1770{
200 "format": "string",
377n/a "type": "string"
4770}
limit1 / 2
1621{
2621 "format": "int32",
3630 "type": "integer"
4621}
Headers
X-Trace-Id2 / 2
19639{
29639 "format": "uuid",
3135n/a "type": "string"
49639}
Responses
codedescriptionhitsavg
200A list of rules with very basic information.26818ms
400Bad request258ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
query1 / 2
#validinvalidschema
11610{
200 "format": "string",
3161n/a "type": "string"
41610}
limit0 / 2
11360{
21360 "format": "int32",
31360 "type": "integer"
41360}
Headers
X-Trace-Id2 / 2
122237{
222237 "format": "uuid",
3259n/a "type": "string"
422237}
Responses
codedescriptionhitsavg
200A list of subscriptions with very basic information.49618ms
400Bad request278ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
query1 / 2
#validinvalidschema
11290{
200 "format": "string",
3129n/a "type": "string"
41290}
limit2 / 2
11234{
21234 "format": "int32",
31261 "type": "integer"
41234}
Headers
X-Trace-Id2 / 2
118351{
218351 "format": "uuid",
3234n/a "type": "string"
418351}
Responses
codedescriptionhitsavg
200A list of tags with very basic information.44118ms
400Bad request358ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
query1 / 2
#validinvalidschema
1970{
200 "format": "string",
397n/a "type": "string"
4970}
limit2 / 2
1771{
2771 "format": "int32",
3771 "type": "integer"
4771}
Headers
X-Trace-Id2 / 2
110145{
210145 "format": "uuid",
3146n/a "type": "string"
410145}
Responses
codedescriptionhitsavg
200A list of transaction types with very basic information.28218ms
400Bad request358ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
query1 / 2
#validinvalidschema
1970{
200 "format": "string",
397n/a "type": "string"
4970}
limit2 / 2
1743{
2743 "format": "int32",
3743 "type": "integer"
4743}
Headers
X-Trace-Id2 / 2
19741{
29741 "format": "uuid",
3138n/a "type": "string"
49741}
Responses
codedescriptionhitsavg
200A list of transaction descriptions with very basic information.28818ms
400Bad request268ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
query1 / 2
#validinvalidschema
1930{
200 "format": "string",
393n/a "type": "string"
4930}
limit1 / 2
1621{
2621 "format": "int32",
3630 "type": "integer"
4621}
Headers
X-Trace-Id2 / 2
110635{
210635 "format": "uuid",
3141n/a "type": "string"
410635}
Responses
codedescriptionhitsavg
200Returns all transactions, complemented with meta information.28119ms
400Bad request258ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
available_budgets 2 operations 1 covered 1 partial 0 uncovered 0 not measured 61% #
Query Parameters
limit1 / 2
#validinvalidschema
1651{
2651 "format": "int32",
3660 "type": "integer"
4651}
page0 / 2
1720{
2720 "format": "int32",
3720 "type": "integer"
4720}
start1 / 2
1390{
2390 "format": "date",
339n/a "type": "string"
4390}
end1 / 2
1390{
2390 "format": "date",
339n/a "type": "string"
4390}
Headers
X-Trace-Id2 / 2
124844{
224844 "format": "uuid",
3292n/a "type": "string"
424844}
Responses
codedescriptionhitsavg
200A list of available budget amounts.50917ms
400Bad request238ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
"2026-10-01"start
"2026-10-31"end
Path Parameters
id1 / 1
#validinvalidschema
1175n/a{
2175n/a "type": "string"
3175n/a}
Headers
X-Trace-Id2 / 2
14662{
24662 "format": "uuid",
3108n/a "type": "string"
44662}
Responses
codedescriptionhitsavg
200The requested available budget12615ms
400Bad request328ms
401Unauthenticated0never seen
404Page not found14315ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
bills 16 operations 11 covered 5 partial 0 uncovered 0 not measured 58% #
Query Parameters
limit1 / 2
#validinvalidschema
1513{
2513 "format": "int32",
3540 "type": "integer"
4513}
page2 / 2
1417{
2417 "format": "int32",
3462 "type": "integer"
4417}
start2 / 2
1237{
2237 "format": "date",
330n/a "type": "string"
4237}
end2 / 2
1205{
2205 "format": "date",
325n/a "type": "string"
4205}
Headers
X-Trace-Id2 / 2
125741{
225741 "format": "uuid",
3298n/a "type": "string"
425741}
Responses
codedescriptionhitsavg
200A list of bills48218ms
400Bad request358ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
"2026-10-01"start
"2026-10-01"end
Headers
X-Trace-Id2 / 2
#validinvalidschema
145944{
245944 "format": "uuid",
3503n/a "type": "string"
445944}
Body
application/json9 / 35
BillStore
11615{
21812 "properties": {
3290 "active": {
4290 "type": "boolean"
5290 },
6246 "amount_max": {
700 "format": "amount",
8246 "type": "string"
9246 },
10282 "amount_min": {
1100 "format": "amount",
12282 "type": "string"
13282 },
14280 "currency_code": {
1500 "format": "string",
16280 "type": "string"
17280 },
18280 "currency_id": {
1900 "format": "string",
20280 "type": "string"
21280 },
22282 "date": {
23280 "format": "date-time",
24282 "type": "string"
25282 },
26280 "end_date": {
27280 "format": "date-time",
28280 "type": "string"
29280 },
30240 "extension_date": {
31240 "format": "date-time",
32240 "type": "string"
33240 },
34262 "name": {
3500 "format": "string",
36262 "type": "string"
37262 },
38290 "notes": {
3900 "format": "string",
4029n/a "nullable": true,
41290 "type": "string"
42290 },
43240 "object_group_id": {
4400 "format": "string",
4524n/a "nullable": true,
46240 "type": "string"
47240 },
48280 "object_group_title": {
4900 "format": "string",
5028n/a "nullable": true,
51280 "type": "string"
52280 },
53300 "repeat_freq": {
55300 },
56280 "skip": {
57280 "format": "int32",
58280 "type": "integer"
59280 }
601812 },
61283 "required": [
62283 "name",
63301 "amount_min",
64301 "amount_max",
65301 "date",
66301 "repeat_freq"
67283 ],
68310 "type": "object"
691615}
Referenced Components (1)0 of 4 keywords
BillRepeatFrequency0 of 4 keywords
1300{
2300 "enum": [
30n/a "weekly",
421n/a "monthly",
57n/a "quarterly",
60n/a "half-year",
72n/a "yearly"
8300 ],
900 "format": "string",
10300 "type": "string"
11300}
application/x-www-form-urlencoded19 / 35
BillStore
1105{
2123 "properties": {
380 "active": {
480 "type": "boolean"
580 },
6150 "amount_max": {
700 "format": "amount",
815n/a "type": "string"
9150 },
10150 "amount_min": {
1100 "format": "amount",
1215n/a "type": "string"
13150 },
1460 "currency_code": {
1500 "format": "string",
166n/a "type": "string"
1760 },
1860 "currency_id": {
1900 "format": "string",
206n/a "type": "string"
2160 },
22123 "date": {
23123 "format": "date-time",
2415n/a "type": "string"
25123 },
2660 "end_date": {
2760 "format": "date-time",
286n/a "type": "string"
2960 },
3070 "extension_date": {
3170 "format": "date-time",
327n/a "type": "string"
3370 },
34130 "name": {
3500 "format": "string",
3613n/a "type": "string"
37130 },
3850 "notes": {
3900 "format": "string",
405n/a "nullable": true,
415n/a "type": "string"
4250 },
4370 "object_group_id": {
4400 "format": "string",
457n/a "nullable": true,
467n/a "type": "string"
4770 },
4890 "object_group_title": {
4900 "format": "string",
509n/a "nullable": true,
519n/a "type": "string"
5290 },
53150 "repeat_freq": {
55150 },
5670 "skip": {
5770 "format": "int32",
5870 "type": "integer"
5970 }
60123 },
61132 "required": [
62132 "name",
63150 "amount_min",
64150 "amount_max",
65150 "date",
66150 "repeat_freq"
67132 ],
6815n/a "type": "object"
69105}
Referenced Components (1)1 of 4 keywords
BillRepeatFrequency1 of 4 keywords
1150{
2150 "enum": [
33n/a "weekly",
42n/a "monthly",
51n/a "quarterly",
64n/a "half-year",
75n/a "yearly"
8150 ],
900 "format": "string",
1015n/a "type": "string"
11150}
Responses
codedescriptionhitsavg
200New bill stored, result in response.68616ms
400Bad request368ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception817ms
Undocumented - not in spec
codedescriptionhitsavg
41538ms
Examples
Body: application/json
trueBillStore.active
"123.45"BillStore.amount_max
"123.45"BillStore.amount_min
"EUR"BillStore.currency_code
"5"BillStore.currency_id
"2026-10-01T00:00:00+00:00"BillStore.date
"2026-10-31T23:59:59+00:00"BillStore.end_date
"2026-10-31T23:59:59+00:00"BillStore.extension_date
"Rent"BillStore.name
"Some example notes"BillStore.notes
"5"BillStore.object_group_id
"Example Group"BillStore.object_group_title
"monthly"BillRepeatFrequency
0BillStore.skip
Body: application/x-www-form-urlencoded
trueBillStore.active
"123.45"BillStore.amount_max
"123.45"BillStore.amount_min
"EUR"BillStore.currency_code
"5"BillStore.currency_id
"2026-10-01T00:00:00+00:00"BillStore.date
"2026-10-31T23:59:59+00:00"BillStore.end_date
"2026-10-31T23:59:59+00:00"BillStore.extension_date
"Rent"BillStore.name
"Some example notes"BillStore.notes
"5"BillStore.object_group_id
"Example Group"BillStore.object_group_title
"monthly"BillRepeatFrequency
0BillStore.skip
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path Parameters
id1 / 1
#validinvalidschema
169n/a{
269n/a "type": "string"
369n/a}
Headers
X-Trace-Id2 / 2
12119{
22119 "format": "uuid",
340n/a "type": "string"
42119}
Responses
codedescriptionhitsavg
204Bill deleted.130ms
400Bad request137ms
401Unauthenticated0never seen
404Page not found5514ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK215ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1360n/a{
2360n/a "type": "string"
3360n/a}
Query Parameters
start2 / 2
115916{
215916 "format": "date",
3175n/a "type": "string"
415916}
end2 / 2
116017{
216017 "format": "date",
3177n/a "type": "string"
416017}
Headers
X-Trace-Id2 / 2
121244{
221244 "format": "uuid",
3256n/a "type": "string"
421244}
Responses
codedescriptionhitsavg
200The requested bill8517ms
400Bad request278ms
401Unauthenticated0never seen
404Page not found32715ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
"2026-10-01"start
"2026-10-31"end
Path Parameters
id1 / 1
#validinvalidschema
1573n/a{
2573n/a "type": "string"
3573n/a}
Headers
X-Trace-Id2 / 2
131364{
231364 "format": "uuid",
3377n/a "type": "string"
431364}
Body
application/json18 / 35
BillUpdate
122640{
222733 "properties": {
31181 "active": {
41181 "type": "boolean"
51181 },
61154 "amount_max": {
700 "format": "amount",
81154 "type": "string"
91154 },
101045 "amount_min": {
1100 "format": "amount",
121045 "type": "string"
131045 },
141212 "currency_code": {
1500 "format": "string",
161212 "type": "string"
171212 },
181280 "currency_id": {
1900 "format": "string",
201280 "type": "string"
211280 },
221282 "date": {
231280 "format": "date-time",
241282 "type": "string"
251282 },
261080 "end_date": {
271080 "format": "date-time",
281080 "type": "string"
291080 },
301011 "extension_date": {
311010 "format": "date-time",
321011 "type": "string"
331011 },
342581 "name": {
3500 "format": "string",
362581 "type": "string"
372581 },
381048 "notes": {
3900 "format": "string",
40112n/a "nullable": true,
411048 "type": "string"
421048 },
43924 "object_group_id": {
4400 "format": "string",
4596n/a "nullable": true,
46924 "type": "string"
47924 },
48964 "object_group_title": {
4900 "format": "string",
50100n/a "nullable": true,
51964 "type": "string"
52964 },
53940 "repeat_freq": {
55940 },
56979 "skip": {
57979 "format": "int32",
581051 "type": "integer"
59979 }
6022733 },
612592 "required": [
622592 "name"
632592 ],
642615 "type": "object"
6522640}
Referenced Components (1)0 of 4 keywords
BillRepeatFrequency0 of 4 keywords
1940{
2940 "enum": [
33n/a "weekly",
465n/a "monthly",
510n/a "quarterly",
65n/a "half-year",
711n/a "yearly"
8940 ],
900 "format": "string",
10940 "type": "string"
11940}
application/x-www-form-urlencoded21 / 35
BillUpdate
11877{
21922 "properties": {
3720 "active": {
4720 "type": "boolean"
5720 },
6860 "amount_max": {
700 "format": "amount",
886n/a "type": "string"
9860 },
10800 "amount_min": {
1100 "format": "amount",
1280n/a "type": "string"
13800 },
14780 "currency_code": {
1500 "format": "string",
1678n/a "type": "string"
17780 },
18860 "currency_id": {
1900 "format": "string",
2086n/a "type": "string"
21860 },
22731 "date": {
23731 "format": "date-time",
2474n/a "type": "string"
25731 },
26930 "end_date": {
27930 "format": "date-time",
2893n/a "type": "string"
29930 },
30780 "extension_date": {
31780 "format": "date-time",
3278n/a "type": "string"
33780 },
341890 "name": {
3500 "format": "string",
36189n/a "type": "string"
371890 },
38810 "notes": {
3900 "format": "string",
4081n/a "nullable": true,
4181n/a "type": "string"
42810 },
43720 "object_group_id": {
4400 "format": "string",
4572n/a "nullable": true,
4672n/a "type": "string"
47720 },
48700 "object_group_title": {
4900 "format": "string",
5070n/a "nullable": true,
5170n/a "type": "string"
52700 },
53690 "repeat_freq": {
55690 },
56621 "skip": {
57621 "format": "int32",
58621 "type": "integer"
59621 }
601922 },
611895 "required": [
621895 "name"
631895 ],
64194n/a "type": "object"
651877}
Referenced Components (1)1 of 4 keywords
BillRepeatFrequency1 of 4 keywords
1690{
2690 "enum": [
310n/a "weekly",
427n/a "monthly",
511n/a "quarterly",
67n/a "half-year",
714n/a "yearly"
8690 ],
900 "format": "string",
1069n/a "type": "string"
11690}
Responses
codedescriptionhitsavg
200Updated bill stored, result in response19121ms
400Bad request418ms
401Unauthenticated0never seen
404Page not found41615ms
422Validation error. The body will have the exact details.0never seen
500Internal exception1217ms
Undocumented - not in spec
codedescriptionhitsavg
41538ms
Examples
Body: application/json
trueBillUpdate.active
"123.45"BillUpdate.amount_max
"123.45"BillUpdate.amount_min
"EUR"BillUpdate.currency_code
"5"BillUpdate.currency_id
"2026-10-01T00:00:00+00:00"BillUpdate.date
"2026-10-31T23:59:59+00:00"BillUpdate.end_date
"2026-10-31T23:59:59+00:00"BillUpdate.extension_date
"Rent"BillUpdate.name
"Some example notes"BillUpdate.notes
"5"BillUpdate.object_group_id
"Example Group"BillUpdate.object_group_title
"monthly"BillRepeatFrequency
0BillUpdate.skip
Body: application/x-www-form-urlencoded
trueBillUpdate.active
"123.45"BillUpdate.amount_max
"123.45"BillUpdate.amount_min
"EUR"BillUpdate.currency_code
"5"BillUpdate.currency_id
"2026-10-01T00:00:00+00:00"BillUpdate.date
"2026-10-31T23:59:59+00:00"BillUpdate.end_date
"2026-10-31T23:59:59+00:00"BillUpdate.extension_date
"Rent"BillUpdate.name
"Some example notes"BillUpdate.notes
"5"BillUpdate.object_group_id
"Example Group"BillUpdate.object_group_title
"monthly"BillRepeatFrequency
0BillUpdate.skip
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1486n/a{
2486n/a "type": "string"
3486n/a}
Query Parameters
limit2 / 2
119831{
219831 "format": "int32",
321613 "type": "integer"
419831}
page2 / 2
118626{
218626 "format": "int32",
319913 "type": "integer"
418626}
Headers
X-Trace-Id2 / 2
121031{
221031 "format": "uuid",
3241n/a "type": "string"
421031}
Responses
codedescriptionhitsavg
200A list of attachments4715ms
400Bad request258ms
401Unauthenticated0never seen
404Page not found45315ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
Path Parameters
id1 / 1
#validinvalidschema
1372n/a{
2372n/a "type": "string"
3372n/a}
Headers
X-Trace-Id2 / 2
119790{
219790 "format": "uuid",
3287n/a "type": "string"
419790}
Responses
codedescriptionhitsavg
200A list of rules13519ms
400Bad request538ms
401Unauthenticated0never seen
404Page not found31315ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1514n/a{
2514n/a "type": "string"
3514n/a}
Query Parameters
limit2 / 2
121240{
221240 "format": "int32",
323220 "type": "integer"
421240}
page2 / 2
118731{
218731 "format": "int32",
320711 "type": "integer"
418731}
start2 / 2
122825{
222825 "format": "date",
3253n/a "type": "string"
422825}
end2 / 2
121621{
221621 "format": "date",
3237n/a "type": "string"
421621}
type2 / 2
TransactionTypeFilter
116618{
216618 "enum": [
334n/a "all",
418n/a "withdrawal",
57n/a "withdrawals",
613n/a "expense",
710n/a "deposit",
816n/a "deposits",
99n/a "income",
105n/a "transfer",
1112n/a "transfers",
125n/a "opening_balance",
134n/a "reconciliation",
146n/a "special",
1511n/a "specials",
1616n/a "default"
1716618 ],
18184n/a "type": "string"
1916618}
Headers
X-Trace-Id2 / 2
124356{
224356 "format": "uuid",
3299n/a "type": "string"
424356}
Responses
codedescriptionhitsavg
200A list of transactions10218ms
400Bad request468ms
401Unauthenticated0never seen
404Page not found43315ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
"2026-10-01"start
"2026-10-31"end
Query Parameters
limit2 / 2
#validinvalidschema
1615{
2615 "format": "int32",
3615 "type": "integer"
4615}
page2 / 2
15811{
25811 "format": "int32",
3654 "type": "integer"
45811}
start2 / 2
1312{
2312 "format": "date",
333n/a "type": "string"
4312}
end2 / 2
1249{
2249 "format": "date",
333n/a "type": "string"
4249}
Headers
X-Trace-Id2 / 2
128068{
228068 "format": "uuid",
3348n/a "type": "string"
428068}
Responses
codedescriptionhitsavg
200A list of subscriptions50017ms
400Bad request468ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
"2026-10-01"start
"2026-10-01"end
Headers
X-Trace-Id2 / 2
#validinvalidschema
149544{
249544 "format": "uuid",
3539n/a "type": "string"
449544}
Body
application/json9 / 35
BillStore
11510{
2187 "properties": {
3240 "active": {
4240 "type": "boolean"
5240 },
6232 "amount_max": {
700 "format": "amount",
8232 "type": "string"
9232 },
10232 "amount_min": {
1100 "format": "amount",
12232 "type": "string"
13232 },
14240 "currency_code": {
1500 "format": "string",
16240 "type": "string"
17240 },
18220 "currency_id": {
1900 "format": "string",
20220 "type": "string"
21220 },
22232 "date": {
23230 "format": "date-time",
24232 "type": "string"
25232 },
26230 "end_date": {
27230 "format": "date-time",
28230 "type": "string"
29230 },
30250 "extension_date": {
31250 "format": "date-time",
32250 "type": "string"
33250 },
34211 "name": {
3500 "format": "string",
36211 "type": "string"
37211 },
38230 "notes": {
3900 "format": "string",
4023n/a "nullable": true,
41230 "type": "string"
42230 },
43210 "object_group_id": {
4400 "format": "string",
4521n/a "nullable": true,
46210 "type": "string"
47210 },
48240 "object_group_title": {
4900 "format": "string",
5024n/a "nullable": true,
51240 "type": "string"
52240 },
53250 "repeat_freq": {
55250 },
56240 "skip": {
57240 "format": "int32",
58240 "type": "integer"
59240 }
60187 },
61223 "required": [
62223 "name",
63250 "amount_min",
64250 "amount_max",
65250 "date",
66250 "repeat_freq"
67223 ],
68250 "type": "object"
691510}
Referenced Components (1)0 of 4 keywords
BillRepeatFrequency0 of 4 keywords
1250{
2250 "enum": [
31n/a "weekly",
421n/a "monthly",
52n/a "quarterly",
60n/a "half-year",
71n/a "yearly"
8250 ],
900 "format": "string",
10250 "type": "string"
11250}
application/x-www-form-urlencoded17 / 35
BillStore
181{
290 "properties": {
380 "active": {
480 "type": "boolean"
580 },
690 "amount_max": {
700 "format": "amount",
89n/a "type": "string"
990 },
1090 "amount_min": {
1100 "format": "amount",
129n/a "type": "string"
1390 },
1480 "currency_code": {
1500 "format": "string",
168n/a "type": "string"
1780 },
1880 "currency_id": {
1900 "format": "string",
208n/a "type": "string"
2180 },
2290 "date": {
2390 "format": "date-time",
249n/a "type": "string"
2590 },
2670 "end_date": {
2770 "format": "date-time",
287n/a "type": "string"
2970 },
3070 "extension_date": {
3170 "format": "date-time",
327n/a "type": "string"
3370 },
3480 "name": {
3500 "format": "string",
368n/a "type": "string"
3780 },
3870 "notes": {
3900 "format": "string",
407n/a "nullable": true,
417n/a "type": "string"
4270 },
4380 "object_group_id": {
4400 "format": "string",
458n/a "nullable": true,
468n/a "type": "string"
4780 },
4870 "object_group_title": {
4900 "format": "string",
507n/a "nullable": true,
517n/a "type": "string"
5270 },
5390 "repeat_freq": {
5590 },
5670 "skip": {
5770 "format": "int32",
5870 "type": "integer"
5970 }
6090 },
6181 "required": [
6281 "name",
6390 "amount_min",
6490 "amount_max",
6590 "date",
6690 "repeat_freq"
6781 ],
689n/a "type": "object"
6981}
Referenced Components (1)1 of 4 keywords
BillRepeatFrequency1 of 4 keywords
190{
290 "enum": [
31n/a "weekly",
42n/a "monthly",
51n/a "quarterly",
65n/a "half-year",
70n/a "yearly"
890 ],
900 "format": "string",
109n/a "type": "string"
1190}
Responses
codedescriptionhitsavg
200New subscription stored, result in response.69916ms
400Bad request268ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception818ms
Undocumented - not in spec
codedescriptionhitsavg
41538ms
Examples
Body: application/json
trueBillStore.active
"123.45"BillStore.amount_max
"123.45"BillStore.amount_min
"EUR"BillStore.currency_code
"5"BillStore.currency_id
"2026-10-01T00:00:00+00:00"BillStore.date
"2026-10-31T23:59:59+00:00"BillStore.end_date
"2026-10-31T23:59:59+00:00"BillStore.extension_date
"Rent"BillStore.name
"Some example notes"BillStore.notes
"5"BillStore.object_group_id
"Example Group"BillStore.object_group_title
"monthly"BillRepeatFrequency
0BillStore.skip
Body: application/x-www-form-urlencoded
trueBillStore.active
"123.45"BillStore.amount_max
"123.45"BillStore.amount_min
"EUR"BillStore.currency_code
"5"BillStore.currency_id
"2026-10-01T00:00:00+00:00"BillStore.date
"2026-10-31T23:59:59+00:00"BillStore.end_date
"2026-10-31T23:59:59+00:00"BillStore.extension_date
"Rent"BillStore.name
"Some example notes"BillStore.notes
"5"BillStore.object_group_id
"Example Group"BillStore.object_group_title
"monthly"BillRepeatFrequency
0BillStore.skip
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path Parameters
id1 / 1
#validinvalidschema
1193n/a{
2193n/a "type": "string"
3193n/a}
Headers
X-Trace-Id2 / 2
15741{
25741 "format": "uuid",
398n/a "type": "string"
45741}
Responses
codedescriptionhitsavg
204Subscription deleted.121ms
400Bad request308ms
401Unauthenticated0never seen
404Page not found16214ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK6117ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1376n/a{
2376n/a "type": "string"
3376n/a}
Query Parameters
start2 / 2
116829{
216829 "format": "date",
3197n/a "type": "string"
416829}
end2 / 2
116029{
216029 "format": "date",
3189n/a "type": "string"
416029}
Headers
X-Trace-Id2 / 2
112840{
212840 "format": "uuid",
3168n/a "type": "string"
412840}
Responses
codedescriptionhitsavg
200The requested subscription3516ms
400Bad request288ms
401Unauthenticated0never seen
404Page not found34215ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
"2026-10-01"start
"2026-10-31"end
Path Parameters
id1 / 1
#validinvalidschema
1425n/a{
2425n/a "type": "string"
3425n/a}
Headers
X-Trace-Id2 / 2
140536{
240536 "format": "uuid",
3441n/a "type": "string"
440536}
Body
application/json11 / 35
BillUpdate
119418{
219512 "properties": {
3920 "active": {
4920 "type": "boolean"
5920 },
6814 "amount_max": {
700 "format": "amount",
8814 "type": "string"
9814 },
10914 "amount_min": {
1100 "format": "amount",
12914 "type": "string"
13914 },
14890 "currency_code": {
1500 "format": "string",
16890 "type": "string"
17890 },
18780 "currency_id": {
1900 "format": "string",
20780 "type": "string"
21780 },
22982 "date": {
23980 "format": "date-time",
24982 "type": "string"
25982 },
26901 "end_date": {
27901 "format": "date-time",
28910 "type": "string"
29901 },
301010 "extension_date": {
311010 "format": "date-time",
321010 "type": "string"
331010 },
342051 "name": {
3500 "format": "string",
362051 "type": "string"
372051 },
381040 "notes": {
3900 "format": "string",
40104n/a "nullable": true,
411040 "type": "string"
421040 },
43780 "object_group_id": {
4400 "format": "string",
4578n/a "nullable": true,
46780 "type": "string"
47780 },
481040 "object_group_title": {
4900 "format": "string",
50104n/a "nullable": true,
511040 "type": "string"
521040 },
53790 "repeat_freq": {
55790 },
56970 "skip": {
57970 "format": "int32",
58970 "type": "integer"
59970 }
6019512 },
612061 "required": [
622061 "name"
632061 ],
642075 "type": "object"
6519418}
Referenced Components (1)0 of 4 keywords
BillRepeatFrequency0 of 4 keywords
1790{
2790 "enum": [
310n/a "weekly",
445n/a "monthly",
511n/a "quarterly",
65n/a "half-year",
78n/a "yearly"
8790 ],
900 "format": "string",
10790 "type": "string"
11790}
application/x-www-form-urlencoded22 / 35
BillUpdate
1889{
2895 "properties": {
3380 "active": {
4380 "type": "boolean"
5380 },
6350 "amount_max": {
700 "format": "amount",
835n/a "type": "string"
9350 },
10380 "amount_min": {
1100 "format": "amount",
1238n/a "type": "string"
13380 },
14480 "currency_code": {
1500 "format": "string",
1648n/a "type": "string"
17480 },
18410 "currency_id": {
1900 "format": "string",
2041n/a "type": "string"
21410 },
22290 "date": {
23290 "format": "date-time",
2429n/a "type": "string"
25290 },
26390 "end_date": {
27390 "format": "date-time",
2839n/a "type": "string"
29390 },
30512 "extension_date": {
31512 "format": "date-time",
3253n/a "type": "string"
33512 },
34930 "name": {
3500 "format": "string",
3693n/a "type": "string"
37930 },
38430 "notes": {
3900 "format": "string",
4043n/a "nullable": true,
4143n/a "type": "string"
42430 },
43400 "object_group_id": {
4400 "format": "string",
4540n/a "nullable": true,
4640n/a "type": "string"
47400 },
48350 "object_group_title": {
4900 "format": "string",
5035n/a "nullable": true,
5135n/a "type": "string"
52350 },
53392 "repeat_freq": {
55392 },
56391 "skip": {
57391 "format": "int32",
58400 "type": "integer"
59391 }
60895 },
61934 "required": [
62934 "name"
63934 ],
6497n/a "type": "object"
65889}
Referenced Components (1)3 of 4 keywords
BillRepeatFrequency3 of 4 keywords
1392{
2392 "enum": [
32n/a "weekly",
48n/a "monthly",
59n/a "quarterly",
616n/a "half-year",
74n/a "yearly"
8392 ],
900 "format": "string",
1041n/a "type": "string"
11392}
Responses
codedescriptionhitsavg
200Updated subscription stored, result in response18716ms
400Bad request288ms
401Unauthenticated0never seen
404Page not found37615ms
422Validation error. The body will have the exact details.0never seen
500Internal exception1019ms
Undocumented - not in spec
codedescriptionhitsavg
41537ms
Examples
Body: application/json
trueBillUpdate.active
"123.45"BillUpdate.amount_max
"123.45"BillUpdate.amount_min
"EUR"BillUpdate.currency_code
"5"BillUpdate.currency_id
"2026-10-01T00:00:00+00:00"BillUpdate.date
"2026-10-31T23:59:59+00:00"BillUpdate.end_date
"2026-10-31T23:59:59+00:00"BillUpdate.extension_date
"Rent"BillUpdate.name
"Some example notes"BillUpdate.notes
"5"BillUpdate.object_group_id
"Example Group"BillUpdate.object_group_title
"monthly"BillRepeatFrequency
0BillUpdate.skip
Body: application/x-www-form-urlencoded
trueBillUpdate.active
"123.45"BillUpdate.amount_max
"123.45"BillUpdate.amount_min
"EUR"BillUpdate.currency_code
"5"BillUpdate.currency_id
"2026-10-01T00:00:00+00:00"BillUpdate.date
"2026-10-31T23:59:59+00:00"BillUpdate.end_date
"2026-10-31T23:59:59+00:00"BillUpdate.extension_date
"Rent"BillUpdate.name
"Some example notes"BillUpdate.notes
"5"BillUpdate.object_group_id
"Example Group"BillUpdate.object_group_title
"monthly"BillRepeatFrequency
0BillUpdate.skip
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1518n/a{
2518n/a "type": "string"
3518n/a}
Query Parameters
limit2 / 2
119246{
219246 "format": "int32",
320632 "type": "integer"
419246}
page2 / 2
121749{
221749 "format": "int32",
323630 "type": "integer"
421749}
Headers
X-Trace-Id2 / 2
121146{
221146 "format": "uuid",
3257n/a "type": "string"
421146}
Responses
codedescriptionhitsavg
200A list of attachments11616ms
400Bad request288ms
401Unauthenticated0never seen
404Page not found43315ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
Path Parameters
id1 / 1
#validinvalidschema
1391n/a{
2391n/a "type": "string"
3391n/a}
Headers
X-Trace-Id2 / 2
116558{
216558 "format": "uuid",
3223n/a "type": "string"
416558}
Responses
codedescriptionhitsavg
200A list of rules15717ms
400Bad request328ms
401Unauthenticated0never seen
404Page not found28015ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1578n/a{
2578n/a "type": "string"
3578n/a}
Query Parameters
limit2 / 2
128231{
228231 "format": "int32",
329716 "type": "integer"
428231}
page2 / 2
125633{
225633 "format": "int32",
327613 "type": "integer"
425633}
start2 / 2
123427{
223427 "format": "date",
3261n/a "type": "string"
423427}
end2 / 2
127329{
227329 "format": "date",
3302n/a "type": "string"
427329}
type2 / 2
TransactionTypeFilter
121017{
221017 "enum": [
371n/a "all",
411n/a "withdrawal",
57n/a "withdrawals",
620n/a "expense",
714n/a "deposit",
88n/a "deposits",
98n/a "income",
1017n/a "transfer",
1112n/a "transfers",
129n/a "opening_balance",
136n/a "reconciliation",
1413n/a "special",
158n/a "specials",
166n/a "default"
1721017 ],
18227n/a "type": "string"
1921017}
Headers
X-Trace-Id2 / 2
127144{
227144 "format": "uuid",
3315n/a "type": "string"
427144}
Responses
codedescriptionhitsavg
200A list of transactions7320ms
400Bad request288ms
401Unauthenticated0never seen
404Page not found50315ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
"2026-10-01"start
"2026-10-31"end
budgets 15 operations 11 covered 4 partial 0 uncovered 0 not measured 75% #
Query Parameters
start2 / 2
#validinvalidschema
1613{
2613 "format": "date",
364n/a "type": "string"
4613}
end2 / 2
1574{
2574 "format": "date",
361n/a "type": "string"
4574}
Headers
X-Trace-Id2 / 2
123732{
223732 "format": "uuid",
3269n/a "type": "string"
423732}
Responses
codedescriptionhitsavg
200A list of budget limits.44617ms
400Bad request248ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
"2026-10-01"start
"2026-10-31"end
Query Parameters
limit2 / 2
#validinvalidschema
123837{
223837 "format": "int32",
325025 "type": "integer"
423837}
page2 / 2
123421{
223421 "format": "int32",
324015 "type": "integer"
423421}
start2 / 2
121934{
221934 "format": "date",
3253n/a "type": "string"
421934}
end2 / 2
123427{
223427 "format": "date",
3261n/a "type": "string"
423427}
Headers
X-Trace-Id2 / 2
136945{
236945 "format": "uuid",
3414n/a "type": "string"
436945}
Responses
codedescriptionhitsavg
200A list of budgets.51719ms
400Bad request318ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
"2026-10-01"start
"2026-10-31"end
Headers
X-Trace-Id2 / 2
#validinvalidschema
123947{
223947 "format": "uuid",
3286n/a "type": "string"
423947}
Body
application/json11 / 29
BudgetStore
1331{
2331 "properties": {
3170 "active": {
4170 "type": "boolean"
5170 },
6141 "auto_budget_amount": {
700 "format": "amount",
815n/a "nullable": true,
9141 "type": "string"
10141 },
11150 "auto_budget_currency_code": {
1200 "format": "string",
1315n/a "nullable": true,
14150 "type": "string"
15150 },
16180 "auto_budget_currency_id": {
1700 "format": "string",
1818n/a "nullable": true,
19180 "type": "string"
20180 },
21141 "auto_budget_period": {
23141 },
24140 "auto_budget_type": {
26140 },
27160 "fire_webhooks": {
28160 "type": "boolean"
29160 },
30340 "name": {
3100 "format": "string",
32340 "type": "string"
33340 },
34160 "notes": {
3500 "format": "string",
3616n/a "nullable": true,
37160 "type": "string"
38160 }
39331 },
40340 "required": [
41340 "name"
42340 ],
43340 "type": "object"
44331}
Referenced Components (2)5 of 10 keywords
AutoBudgetPeriod4 of 5 keywords
1141{
2141 "enum": [
31n/a "daily",
40n/a "weekly",
50n/a "monthly",
61n/a "quarterly",
70n/a "half-year",
80n/a "yearly",
912n/a null
10141 ],
1100 "format": "string",
1215n/a "nullable": true,
13141 "type": "string"
14141}
AutoBudgetType1 of 5 keywords
1140{
2140 "enum": [
30n/a "reset",
41n/a "rollover",
50n/a "none",
613n/a null
7140 ],
800 "format": "string",
914n/a "nullable": true,
10140 "type": "string"
11140}
application/x-www-form-urlencoded15 / 29
BudgetStore
1312{
2312 "properties": {
340 "active": {
440 "type": "boolean"
540 },
600 "auto_budget_amount": {
700 "format": "amount",
80n/a "nullable": true,
90n/a "type": "string"
1000 },
1160 "auto_budget_currency_code": {
1200 "format": "string",
136n/a "nullable": true,
146n/a "type": "string"
1560 },
1650 "auto_budget_currency_id": {
1700 "format": "string",
185n/a "nullable": true,
195n/a "type": "string"
2050 },
2152 "auto_budget_period": {
2352 },
2410 "auto_budget_type": {
2610 },
2720 "fire_webhooks": {
2820 "type": "boolean"
2920 },
30330 "name": {
3100 "format": "string",
3233n/a "type": "string"
33330 },
3440 "notes": {
3500 "format": "string",
364n/a "nullable": true,
374n/a "type": "string"
3840 }
39312 },
40330 "required": [
41330 "name"
42330 ],
4333n/a "type": "object"
44312}
Referenced Components (2)6 of 10 keywords
AutoBudgetPeriod4 of 5 keywords
152{
252 "enum": [
30n/a "daily",
43n/a "weekly",
50n/a "monthly",
62n/a "quarterly",
70n/a "half-year",
80n/a "yearly",
90n/a null
1052 ],
1100 "format": "string",
127n/a "nullable": true,
137n/a "type": "string"
1452}
AutoBudgetType2 of 5 keywords
110{
210 "enum": [
30n/a "reset",
40n/a "rollover",
51n/a "none",
60n/a null
710 ],
800 "format": "string",
91n/a "nullable": true,
101n/a "type": "string"
1110}
Responses
codedescriptionhitsavg
200New budget stored, result in response.43117ms
400Bad request268ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41517ms
Examples
Body: application/json
falseBudgetStore.active
"-1012.12"BudgetStore.auto_budget_amount
"EUR"BudgetStore.auto_budget_currency_code
"12"BudgetStore.auto_budget_currency_id
"monthly"AutoBudgetPeriod
"reset"AutoBudgetType
trueBudgetStore.fire_webhooks
trueBudgetStore.fire_webhooks
"Bills"BudgetStore.name
"Some notes"BudgetStore.notes
Body: application/x-www-form-urlencoded
falseBudgetStore.active
"-1012.12"BudgetStore.auto_budget_amount
"EUR"BudgetStore.auto_budget_currency_code
"12"BudgetStore.auto_budget_currency_id
"monthly"AutoBudgetPeriod
"reset"AutoBudgetType
trueBudgetStore.fire_webhooks
trueBudgetStore.fire_webhooks
"Bills"BudgetStore.name
"Some notes"BudgetStore.notes
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
limit2 / 2
#validinvalidschema
119924{
219924 "format": "int32",
320815 "type": "integer"
419924}
page2 / 2
119037{
219037 "format": "int32",
320324 "type": "integer"
419037}
start2 / 2
123716{
223716 "format": "date",
3253n/a "type": "string"
423716}
end2 / 2
119937{
219937 "format": "date",
3236n/a "type": "string"
419937}
Headers
X-Trace-Id2 / 2
132534{
232534 "format": "uuid",
3359n/a "type": "string"
432534}
Responses
codedescriptionhitsavg
200A list of transactions.48522ms
400Bad request258ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
"2026-10-01"start
"2026-10-31"end
Path Parameters
id1 / 1
#validinvalidschema
1101n/a{
2101n/a "type": "string"
3101n/a}
Headers
X-Trace-Id2 / 2
13532{
23532 "format": "uuid",
367n/a "type": "string"
43532}
Responses
codedescriptionhitsavg
204Budget deleted.828ms
400Bad request288ms
401Unauthenticated0never seen
404Page not found6515ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK516ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1453n/a{
2453n/a "type": "string"
3453n/a}
Query Parameters
start2 / 2
116853{
216853 "format": "date",
3221n/a "type": "string"
416853}
end2 / 2
116846{
216846 "format": "date",
3214n/a "type": "string"
416846}
Headers
X-Trace-Id2 / 2
123452{
223452 "format": "uuid",
3286n/a "type": "string"
423452}
Responses
codedescriptionhitsavg
200The requested budget16118ms
400Bad request348ms
401Unauthenticated0never seen
404Page not found26015ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
"2026-10-01"start
"2026-10-31"end
Path Parameters
id1 / 1
#validinvalidschema
1573n/a{
2573n/a "type": "string"
3573n/a}
Headers
X-Trace-Id2 / 2
136445{
236445 "format": "uuid",
3409n/a "type": "string"
436445}
Body
application/json24 / 31
BudgetUpdate
121261{
221454 "properties": {
31586 "active": {
41586 "type": "boolean"
51586 },
61704 "auto_budget_amount": {
700 "format": "amount",
8174n/a "nullable": true,
91704 "type": "string"
101704 },
111635 "auto_budget_currency_code": {
1200 "format": "string",
13168n/a "nullable": true,
141635 "type": "string"
151635 },
161565 "auto_budget_currency_id": {
1700 "format": "string",
18161n/a "nullable": true,
191565 "type": "string"
201565 },
211565 "auto_budget_period": {
231565 },
241496 "auto_budget_type": {
261496 },
271517 "fire_webhooks": {
281517 "type": "boolean"
291517 },
302615 "name": {
3100 "format": "string",
322615 "type": "string"
332615 },
341505 "notes": {
3500 "format": "string",
36155n/a "nullable": true,
371505 "type": "string"
381505 },
391489 "order": {
401489 "format": "int32",
411516 "type": "integer"
421489 }
4321454 },
442662 "required": [
452662 "name"
462662 ],
472685 "type": "object"
4821261}
Referenced Components (2)8 of 10 keywords
AutoBudgetPeriod4 of 5 keywords
11565{
21565 "enum": [
36n/a "daily",
44n/a "weekly",
516n/a "monthly",
612n/a "quarterly",
713n/a "half-year",
84n/a "yearly",
9101n/a null
101565 ],
1100 "format": "string",
12161n/a "nullable": true,
131574 "type": "string"
141565}
AutoBudgetType4 of 5 keywords
11496{
21496 "enum": [
321n/a "reset",
47n/a "rollover",
516n/a "none",
6105n/a null
71496 ],
800 "format": "string",
9155n/a "nullable": true,
101505 "type": "string"
111496}
application/x-www-form-urlencoded24 / 31
BudgetUpdate
1117113{
214783 "properties": {
31172 "active": {
41172 "type": "boolean"
51172 },
61280 "auto_budget_amount": {
700 "format": "amount",
8128n/a "nullable": true,
9128n/a "type": "string"
101280 },
111620 "auto_budget_currency_code": {
1200 "format": "string",
13162n/a "nullable": true,
14162n/a "type": "string"
151620 },
161520 "auto_budget_currency_id": {
1700 "format": "string",
18152n/a "nullable": true,
19152n/a "type": "string"
201520 },
216550 "auto_budget_period": {
236550 },
245970 "auto_budget_type": {
265970 },
271242 "fire_webhooks": {
281242 "type": "boolean"
291242 },
301960 "name": {
3100 "format": "string",
32196n/a "type": "string"
331960 },
341260 "notes": {
3500 "format": "string",
36126n/a "nullable": true,
37126n/a "type": "string"
381260 },
39958 "order": {
40958 "format": "int32",
411003 "type": "integer"
42958 }
4314783 },
4419634 "required": [
4519634 "name"
4619634 ],
47230n/a "type": "object"
48117113}
Referenced Components (2)8 of 10 keywords
AutoBudgetPeriod4 of 5 keywords
16550{
26550 "enum": [
319n/a "daily",
415n/a "weekly",
55n/a "monthly",
612n/a "quarterly",
76n/a "half-year",
88n/a "yearly",
90n/a null
106550 ],
1100 "format": "string",
12115n/a "nullable": true,
13115n/a "type": "string"
146550}
AutoBudgetType4 of 5 keywords
15970{
25970 "enum": [
325n/a "reset",
47n/a "rollover",
527n/a "none",
60n/a null
75970 ],
800 "format": "string",
9129n/a "nullable": true,
10129n/a "type": "string"
115970}
Responses
codedescriptionhitsavg
200Updated budget stored, result in response14018ms
400Bad request298ms
401Unauthenticated0never seen
404Page not found47514ms
422Validation error. The body will have the exact details.0never seen
500Internal exception1119ms
Undocumented - not in spec
codedescriptionhitsavg
41538ms
Examples
Body: application/json
falseBudgetUpdate.active
"-1012.12"BudgetUpdate.auto_budget_amount
"EUR"BudgetUpdate.auto_budget_currency_code
"12"BudgetUpdate.auto_budget_currency_id
"monthly"AutoBudgetPeriod
"reset"AutoBudgetType
trueBudgetUpdate.fire_webhooks
trueBudgetUpdate.fire_webhooks
"Bills"BudgetUpdate.name
"Some notes"BudgetUpdate.notes
5BudgetUpdate.order
Body: application/x-www-form-urlencoded
falseBudgetUpdate.active
"-1012.12"BudgetUpdate.auto_budget_amount
"EUR"BudgetUpdate.auto_budget_currency_code
"12"BudgetUpdate.auto_budget_currency_id
"monthly"AutoBudgetPeriod
"reset"AutoBudgetType
trueBudgetUpdate.fire_webhooks
trueBudgetUpdate.fire_webhooks
"Bills"BudgetUpdate.name
"Some notes"BudgetUpdate.notes
5BudgetUpdate.order
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1466n/a{
2466n/a "type": "string"
3466n/a}
Query Parameters
limit2 / 2
118337{
218337 "format": "int32",
319228 "type": "integer"
418337}
page2 / 2
118748{
218748 "format": "int32",
320431 "type": "integer"
418748}
Headers
X-Trace-Id2 / 2
127343{
227343 "format": "uuid",
3316n/a "type": "string"
427343}
Responses
codedescriptionhitsavg
200A list of attachments21017ms
400Bad request308ms
401Unauthenticated0never seen
404Page not found25115ms
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
Path Parameters
id1 / 1
#validinvalidschema
1459n/a{
2459n/a "type": "string"
3459n/a}
Query Parameters
start2 / 2
118541{
218541 "format": "date",
3226n/a "type": "string"
418541}
end2 / 2
118652{
218652 "format": "date",
3238n/a "type": "string"
418652}
Headers
X-Trace-Id2 / 2
119549{
219549 "format": "uuid",
3244n/a "type": "string"
419549}
Responses
codedescriptionhitsavg
200A list of budget limits applicable to this budget.19421ms
400Bad request348ms
401Unauthenticated0never seen
404Page not found25715ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
"2026-10-01"start
"2026-10-31"end
Path Parameters
id1 / 1
#validinvalidschema
1279n/a{
2279n/a "type": "string"
3279n/a}
Headers
X-Trace-Id2 / 2
126627{
226627 "format": "uuid",
3293n/a "type": "string"
426627}
Body
application/json8 / 17
BudgetLimitStore
113914{
213914 "properties": {
31530 "amount": {
400 "format": "amount",
51530 "type": "string"
61530 },
7520 "currency_code": {
800 "format": "string",
9520 "type": "string"
10520 },
111420 "currency_id": {
1200 "format": "string",
131420 "type": "string"
141420 },
151503 "end": {
161501 "format": "date",
171512 "type": "string"
181503 },
19511 "fire_webhooks": {
20511 "type": "boolean"
21511 },
22544 "notes": {
2300 "format": "string",
2458n/a "nullable": true,
25544 "type": "string"
26544 },
271476 "start": {
281474 "format": "date",
291512 "type": "string"
301476 }
3113914 },
321530 "required": [
331530 "amount",
341530 "start",
351530 "end"
361530 ],
371530 "type": "object"
3813914}
application/x-www-form-urlencoded11 / 17
BudgetLimitStore
11036{
21036 "properties": {
31090 "amount": {
400 "format": "amount",
5109n/a "type": "string"
61090 },
7330 "currency_code": {
800 "format": "string",
933n/a "type": "string"
10330 },
11910 "currency_id": {
1200 "format": "string",
1391n/a "type": "string"
14910 },
151063 "end": {
161063 "format": "date",
17109n/a "type": "string"
181063 },
19330 "fire_webhooks": {
20330 "type": "boolean"
21330 },
22290 "notes": {
2300 "format": "string",
2429n/a "nullable": true,
2529n/a "type": "string"
26290 },
271045 "start": {
281045 "format": "date",
29109n/a "type": "string"
301045 }
311036 },
321090 "required": [
331090 "amount",
341090 "start",
351090 "end"
361090 ],
37109n/a "type": "object"
381036}
Responses
codedescriptionhitsavg
200New budget limit stored, result in response.19215ms
400Bad request218ms
401Unauthenticated0never seen
404Page not found20015ms
422Validation error. The body will have the exact details.0never seen
500Internal exception5418ms
Undocumented - not in spec
codedescriptionhitsavg
41538ms
Examples
Body: application/json
"123.45"BudgetLimitStore.amount
"EUR"BudgetLimitStore.currency_code
"5"BudgetLimitStore.currency_id
"2026-10-31"BudgetLimitStore.end
trueBudgetLimitStore.fire_webhooks
trueBudgetLimitStore.fire_webhooks
"Some example notes"BudgetLimitStore.notes
"2026-10-01"BudgetLimitStore.start
Body: application/x-www-form-urlencoded
"123.45"BudgetLimitStore.amount
"EUR"BudgetLimitStore.currency_code
"5"BudgetLimitStore.currency_id
"2026-10-31"BudgetLimitStore.end
trueBudgetLimitStore.fire_webhooks
trueBudgetLimitStore.fire_webhooks
"Some example notes"BudgetLimitStore.notes
"2026-10-01"BudgetLimitStore.start
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
176n/a{
276n/a "type": "string"
376n/a}
limitId1 / 1
176n/a{
276n/a "type": "string"
376n/a}
Headers
X-Trace-Id2 / 2
11645{
21645 "format": "uuid",
361n/a "type": "string"
41645}
Responses
codedescriptionhitsavg
204Budget limit deleted.0never seen
400Bad request248ms
401Unauthenticated0never seen
404Page not found5214ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK5115ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
"123"limitId
Path Parameters
id1 / 1
#validinvalidschema
1415n/a{
2415n/a "type": "string"
3415n/a}
limitId2 / 2
135164{
235126 "minimum": 1,
337738 "type": "integer"
435164}
Headers
X-Trace-Id2 / 2
115838{
215838 "format": "uuid",
3196n/a "type": "string"
415838}
Responses
codedescriptionhitsavg
200The requested budget limit0never seen
400Bad request258ms
401Unauthenticated0never seen
404Page not found39015ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
1limitId
Path Parameters
id1 / 1
#validinvalidschema
1498n/a{
2498n/a "type": "string"
3498n/a}
limitId1 / 1
1498n/a{
2498n/a "type": "string"
3498n/a}
Headers
X-Trace-Id2 / 2
135742{
235742 "format": "uuid",
3399n/a "type": "string"
435742}
Body
application/json13 / 18
BudgetLimitUpdate
121950{
215044 "properties": {
31675 "amount": {
400 "format": "amount",
51675 "type": "string"
61675 },
71665 "currency_code": {
800 "format": "string",
91665 "type": "string"
101665 },
111655 "currency_id": {
1200 "format": "string",
131655 "type": "string"
141655 },
151635 "currency_name": {
1600 "format": "string",
171635 "type": "string"
181635 },
191626 "end": {
201621 "format": "date-time",
211635 "type": "string"
221626 },
231635 "fire_webhooks": {
241635 "type": "boolean"
251635 },
261644 "notes": {
2700 "format": "string",
28168n/a "nullable": true,
291644 "type": "string"
301644 },
311619 "start": {
321614 "format": "date-time",
331655 "type": "string"
341619 }
3515044 },
362636 "type": "object"
3721950}
application/x-www-form-urlencoded13 / 18
BudgetLimitUpdate
113111{
211211 "properties": {
31010 "amount": {
400 "format": "amount",
5101n/a "type": "string"
61010 },
71030 "currency_code": {
800 "format": "string",
9103n/a "type": "string"
101030 },
111010 "currency_id": {
1200 "format": "string",
13101n/a "type": "string"
141010 },
15990 "currency_name": {
1600 "format": "string",
1799n/a "type": "string"
18990 },
19981 "end": {
20981 "format": "date-time",
2199n/a "type": "string"
22981 },
23972 "fire_webhooks": {
24972 "type": "boolean"
25972 },
26980 "notes": {
2700 "format": "string",
2898n/a "nullable": true,
2998n/a "type": "string"
30980 },
31958 "start": {
32958 "format": "date-time",
33103n/a "type": "string"
34958 }
3511211 },
36142n/a "type": "object"
3713111}
Responses
codedescriptionhitsavg
200Updated budget limit stored, result in response10316ms
400Bad request268ms
401Unauthenticated0never seen
404Page not found46914ms
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41537ms
Examples
Body: application/json
"123.45"BudgetLimitUpdate.amount
"EUR"BudgetLimitUpdate.currency_code
"5"BudgetLimitUpdate.currency_id
"Euro"BudgetLimitUpdate.currency_name
"2026-10-31T23:59:59+00:00"BudgetLimitUpdate.end
trueBudgetLimitUpdate.fire_webhooks
trueBudgetLimitUpdate.fire_webhooks
"Some example notes"BudgetLimitUpdate.notes
"2026-10-01T00:00:00+00:00"BudgetLimitUpdate.start
Body: application/x-www-form-urlencoded
"123.45"BudgetLimitUpdate.amount
"EUR"BudgetLimitUpdate.currency_code
"5"BudgetLimitUpdate.currency_id
"Euro"BudgetLimitUpdate.currency_name
"2026-10-31T23:59:59+00:00"BudgetLimitUpdate.end
trueBudgetLimitUpdate.fire_webhooks
trueBudgetLimitUpdate.fire_webhooks
"Some example notes"BudgetLimitUpdate.notes
"2026-10-01T00:00:00+00:00"BudgetLimitUpdate.start
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
"123"limitId
Path Parameters
id1 / 1
#validinvalidschema
1470n/a{
2470n/a "type": "string"
3470n/a}
limitId1 / 1
1470n/a{
2470n/a "type": "string"
3470n/a}
Query Parameters
limit2 / 2
122841{
222841 "format": "int32",
324425 "type": "integer"
422841}
page2 / 2
121338{
221338 "format": "int32",
322823 "type": "integer"
421338}
type2 / 2
TransactionTypeFilter
118143{
218143 "enum": [
351n/a "all",
411n/a "withdrawal",
53n/a "withdrawals",
67n/a "expense",
716n/a "deposit",
814n/a "deposits",
97n/a "income",
1013n/a "transfer",
1113n/a "transfers",
128n/a "opening_balance",
1313n/a "reconciliation",
144n/a "special",
1513n/a "specials",
168n/a "default"
1718143 ],
18224n/a "type": "string"
1918143}
Headers
X-Trace-Id2 / 2
125549{
225549 "format": "uuid",
3304n/a "type": "string"
425549}
Responses
codedescriptionhitsavg
200A list of transactions.6817ms
400Bad request368ms
401Unauthenticated0never seen
404Page not found43415ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
"123"limitId
Query
10limit
1page
Path Parameters
id1 / 1
#validinvalidschema
1529n/a{
2529n/a "type": "string"
3529n/a}
Query Parameters
limit2 / 2
121660{
221660 "format": "int32",
324927 "type": "integer"
421660}
page2 / 2
121745{
221745 "format": "int32",
323230 "type": "integer"
421745}
start2 / 2
123754{
223754 "format": "date",
3291n/a "type": "string"
423754}
end2 / 2
121528{
221528 "format": "date",
3243n/a "type": "string"
421528}
type2 / 2
TransactionTypeFilter
117428{
217428 "enum": [
357n/a "all",
410n/a "withdrawal",
53n/a "withdrawals",
618n/a "expense",
76n/a "deposit",
89n/a "deposits",
97n/a "income",
105n/a "transfer",
116n/a "transfers",
1212n/a "opening_balance",
136n/a "reconciliation",
1417n/a "special",
159n/a "specials",
169n/a "default"
1717428 ],
18202n/a "type": "string"
1917428}
Headers
X-Trace-Id2 / 2
129362{
229362 "format": "uuid",
3355n/a "type": "string"
429362}
Responses
codedescriptionhitsavg
200A list of transactions.26621ms
400Bad request328ms
401Unauthenticated0never seen
404Page not found30615ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
"2026-10-01"start
"2026-10-31"end
categories 7 operations 5 covered 2 partial 0 uncovered 0 not measured 84% #
Query Parameters
limit2 / 2
#validinvalidschema
118052{
218052 "format": "int32",
320527 "type": "integer"
418052}
page2 / 2
116349{
216349 "format": "int32",
317933 "type": "integer"
416349}
Headers
X-Trace-Id2 / 2
121944{
221944 "format": "uuid",
3263n/a "type": "string"
421944}
Responses
codedescriptionhitsavg
200A list of categories.44118ms
400Bad request298ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
Headers
X-Trace-Id2 / 2
#validinvalidschema
124156{
224156 "format": "uuid",
3297n/a "type": "string"
424156}
Body
application/json5 / 8
CategoryStore
1994{
21003 "properties": {
31002 "name": {
400 "format": "string",
51002 "type": "string"
61002 },
7621 "notes": {
800 "format": "string",
963n/a "nullable": true,
10621 "type": "string"
11621 }
121003 },
131021 "required": [
141021 "name"
151021 ],
161030 "type": "object"
17994}
application/x-www-form-urlencoded5 / 8
CategoryStore
1924{
2960 "properties": {
3920 "name": {
400 "format": "string",
592n/a "type": "string"
6920 },
7550 "notes": {
800 "format": "string",
955n/a "nullable": true,
1055n/a "type": "string"
11550 }
12960 },
13924 "required": [
14924 "name"
15924 ],
1696n/a "type": "object"
17924}
Responses
codedescriptionhitsavg
200New category stored, result in response.44018ms
400Bad request348ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception1617ms
Undocumented - not in spec
codedescriptionhitsavg
41537ms
Examples
Body: application/json
"Lunch"CategoryStore.name
"Some example notes"CategoryStore.notes
Body: application/x-www-form-urlencoded
"Lunch"CategoryStore.name
"Some example notes"CategoryStore.notes
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path Parameters
id1 / 1
#validinvalidschema
136n/a{
236n/a "type": "string"
336n/a}
Headers
X-Trace-Id2 / 2
11616{
21616 "format": "uuid",
332n/a "type": "string"
41616}
Responses
codedescriptionhitsavg
204Category deleted.623ms
400Bad request147ms
401Unauthenticated0never seen
404Page not found1614ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK415ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1405n/a{
2405n/a "type": "string"
3405n/a}
Query Parameters
start2 / 2
117338{
217338 "format": "date",
3211n/a "type": "string"
417338}
end2 / 2
116330{
216330 "format": "date",
3193n/a "type": "string"
416330}
Headers
X-Trace-Id2 / 2
116435{
216435 "format": "uuid",
3199n/a "type": "string"
416435}
Responses
codedescriptionhitsavg
200The requested category11217ms
400Bad request308ms
401Unauthenticated0never seen
404Page not found26715ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
"2026-10-01"start
"2026-10-31"end
Path Parameters
id1 / 1
#validinvalidschema
1392n/a{
2392n/a "type": "string"
3392n/a}
Headers
X-Trace-Id2 / 2
118551{
218551 "format": "uuid",
3236n/a "type": "string"
418551}
Body
application/json6 / 8
CategoryUpdate
118717{
21899 "properties": {
31915 "name": {
400 "format": "string",
51915 "type": "string"
61915 },
7934 "notes": {
800 "format": "string",
997n/a "nullable": true,
10934 "type": "string"
11934 }
121899 },
131963 "required": [
141963 "name"
151963 ],
161995 "type": "object"
1718717}
application/x-www-form-urlencoded5 / 8
CategoryUpdate
111210{
21210 "properties": {
31120 "name": {
400 "format": "string",
5112n/a "type": "string"
61120 },
7540 "notes": {
800 "format": "string",
954n/a "nullable": true,
1054n/a "type": "string"
11540 }
121210 },
1311210 "required": [
1411210 "name"
1511210 ],
16122n/a "type": "object"
1711210}
Responses
codedescriptionhitsavg
200Updated category stored, result in response8918ms
400Bad request348ms
401Unauthenticated0never seen
404Page not found35015ms
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41537ms
Examples
Body: application/json
"Lunch"CategoryUpdate.name
"Some example notes"CategoryUpdate.notes
Body: application/x-www-form-urlencoded
"Lunch"CategoryUpdate.name
"Some example notes"CategoryUpdate.notes
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1497n/a{
2497n/a "type": "string"
3497n/a}
Query Parameters
limit2 / 2
124563{
224563 "format": "int32",
327335 "type": "integer"
424563}
page2 / 2
122157{
222157 "format": "int32",
324137 "type": "integer"
422157}
Headers
X-Trace-Id2 / 2
123051{
223051 "format": "uuid",
3281n/a "type": "string"
423051}
Responses
codedescriptionhitsavg
200A list of attachments19216ms
400Bad request338ms
401Unauthenticated0never seen
404Page not found32215ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
Path Parameters
id1 / 1
#validinvalidschema
1610n/a{
2610n/a "type": "string"
3610n/a}
Query Parameters
limit2 / 2
133134{
233134 "format": "int32",
334223 "type": "integer"
433134}
page2 / 2
128630{
228630 "format": "int32",
330016 "type": "integer"
428630}
start2 / 2
128028{
228028 "format": "date",
3308n/a "type": "string"
428028}
end2 / 2
126729{
226729 "format": "date",
3296n/a "type": "string"
426729}
type2 / 2
TransactionTypeFilter
120723{
220723 "enum": [
366n/a "all",
47n/a "withdrawal",
56n/a "withdrawals",
611n/a "expense",
712n/a "deposit",
813n/a "deposits",
913n/a "income",
1013n/a "transfer",
117n/a "transfers",
125n/a "opening_balance",
1318n/a "reconciliation",
146n/a "special",
1520n/a "specials",
1610n/a "default"
1720723 ],
18230n/a "type": "string"
1920723}
Headers
X-Trace-Id2 / 2
132645{
232645 "format": "uuid",
3371n/a "type": "string"
432645}
Responses
codedescriptionhitsavg
200A list of transactions.22222ms
400Bad request358ms
401Unauthenticated0never seen
404Page not found35615ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
"2026-10-01"start
"2026-10-31"end
charts 5 operations 5 covered 0 partial 0 uncovered 0 not measured 100% #
Query Parameters
start2 / 2
#validinvalidschema
1644{
2644 "format": "date",
368n/a "type": "string"
4644}
end2 / 2
1685{
2685 "format": "date",
373n/a "type": "string"
4685}
period2 / 2
1374{
2374 "enum": [
318n/a "1D",
43n/a "1W",
515n/a "1M",
60n/a "3M",
71n/a "6M",
80n/a "1Y"
9374 ],
1041n/a "type": "string"
11374}
preselected2 / 2
1301{
2301 "enum": [
312n/a "empty",
410n/a "all",
55n/a "assets",
63n/a "liabilities"
7301 ],
831n/a "type": "string"
9301}
Headers
X-Trace-Id2 / 2
114546{
214546 "format": "uuid",
3191n/a "type": "string"
414546}
Responses
codedescriptionhitsavg
200Line chart oriented chart information. Check out the model for more details. Each entry is a line (or bar) in the chart.30417ms
400Bad request348ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
"1M"period
"all"preselected
Query Parameters
start2 / 2
#validinvalidschema
110711{
210711 "format": "date",
3118n/a "type": "string"
410711}
end2 / 2
110711{
210711 "format": "date",
3118n/a "type": "string"
410711}
period2 / 2
15612{
25612 "enum": [
329n/a "1D",
41n/a "1W",
519n/a "1M",
62n/a "3M",
72n/a "6M",
83n/a "1Y"
95612 ],
1068n/a "type": "string"
115612}
preselected2 / 2
1568{
2568 "enum": [
325n/a "empty",
413n/a "all",
55n/a "assets",
613n/a "liabilities"
7568 ],
864n/a "type": "string"
9568}
accounts[]3 / 3
14623{
24623 "items": {
317226 "format": "int64",
417424 "type": "integer"
54623 },
669n/a "type": "array"
74623}
Headers
X-Trace-Id2 / 2
125045{
225045 "format": "uuid",
3295n/a "type": "string"
425045}
Responses
codedescriptionhitsavg
200Line chart oriented chart information. Check out the model for more details. Each entry is a line (or bar) in the chart.31517ms
400Bad request328ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception3920ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
"1M"period
"all"preselected
[ 1, 2, 3 ]accounts[]
Query Parameters
start2 / 2
#validinvalidschema
1281{
2281 "format": "date",
329n/a "type": "string"
4281}
end2 / 2
1281{
2281 "format": "date",
329n/a "type": "string"
4281}
Headers
X-Trace-Id2 / 2
111933{
211933 "format": "uuid",
3152n/a "type": "string"
411933}
Responses
codedescriptionhitsavg
200Bar chart oriented chart information. Check out the model for more details. Each entry is a line (or bar) in the chart.27718ms
400Bad request208ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
start2 / 2
#validinvalidschema
1674{
2674 "format": "date",
371n/a "type": "string"
4674}
end2 / 2
1663{
2663 "format": "date",
369n/a "type": "string"
4663}
Headers
X-Trace-Id2 / 2
113734{
213734 "format": "uuid",
3171n/a "type": "string"
413734}
Responses
codedescriptionhitsavg
200Bar chart oriented chart information. Check out the model for more details. Each entry is a line (or bar) in the chart.23322ms
400Bad request228ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
start2 / 2
#validinvalidschema
1326{
2326 "format": "date",
338n/a "type": "string"
4326}
end2 / 2
1335{
2335 "format": "date",
338n/a "type": "string"
4335}
Headers
X-Trace-Id2 / 2
111642{
211642 "format": "uuid",
3158n/a "type": "string"
411642}
Responses
codedescriptionhitsavg
200Line chart oriented chart information. Check out the model for more details. Each entry is a line (or bar) in the chart.28516ms
400Bad request288ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
configuration 3 operations 2 covered 1 partial 0 uncovered 0 not measured 79% #
Headers
X-Trace-Id2 / 2
#validinvalidschema
120391{
220391 "format": "uuid",
3294n/a "type": "string"
420391}
Responses
codedescriptionhitsavg
200System configuration values43316ms
400Bad request508ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path Parameters
name2 / 2
ConfigValueFilter
#validinvalidschema
14036{
24036 "enum": [
358n/a "configuration.is_demo_site",
411n/a "configuration.permission_update_check",
54n/a "configuration.last_update_check",
616n/a "configuration.single_user_mode",
717n/a "firefly.version",
818n/a "firefly.default_location",
910n/a "firefly.account_to_transaction",
1019n/a "firefly.allowed_opposing_types",
1112n/a "firefly.accountRoles",
129n/a "firefly.valid_liabilities",
1319n/a "firefly.interest_periods",
1413n/a "firefly.enable_external_map",
158n/a "firefly.expected_source_types",
161n/a "app.timezone",
1716n/a "firefly.bill_periods",
1813n/a "firefly.credit_card_types",
1912n/a "firefly.languages",
2014n/a "firefly.valid_view_ranges",
21111n/a "cer.enabled",
2211n/a "firefly.preselected_accounts",
232n/a "firefly.rule-actions",
241n/a "firefly.context-rule-actions",
251n/a "search.operators",
261n/a "webhook.triggers",
271n/a "webhook.responses",
285n/a "webhook.deliveries"
294036 ],
30409n/a "type": "string"
314036}
Headers
X-Trace-Id2 / 2
117529{
217529 "format": "uuid",
3204n/a "type": "string"
417529}
Responses
codedescriptionhitsavg
200One system configuration value39016ms
400Bad request228ms
401Unauthenticated0never seen
404Page not found614ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"configuration.is_demo_site"name
Path Parameters
name2 / 2
ConfigValueUpdateFilter
#validinvalidschema
126211{
226211 "enum": [
3160n/a "configuration.is_demo_site",
418n/a "configuration.permission_update_check",
515n/a "configuration.last_update_check",
631n/a "configuration.single_user_mode",
71n/a "configuration.enable_exchange_rates",
81n/a "configuration.use_running_balance",
910n/a "configuration.enable_external_map",
1013n/a "configuration.enable_external_rates",
111n/a "configuration.allow_webhooks",
1212n/a "configuration.valid_url_protocols"
1326211 ],
14273n/a "type": "string"
1526211}
Headers
X-Trace-Id2 / 2
114041{
214041 "format": "uuid",
3181n/a "type": "string"
414041}
Body
application/json10 / 12
ConfigurationUpdate
1508{
2507 "properties": {
3507 "value": {
5507 }
6507 },
7571 "required": [
8571 "value"
9571 ],
10580 "type": "object"
11508}
Referenced Components (2)8 of 9 keywords
PolymorphicProperty7 of 7 keywords
1507{
2507 "oneOf": [
31740 {
41740 "type": "boolean"
51740 },
6156 {
7156 "type": "string"
8156 },
91542 {
101542 "type": "object"
111542 },
121740 {
13176 "items": {
15176 },
162334 "type": "array"
171740 }
18507 ]
19507}
StringArrayItem1 of 2 keywords
11457{
200 "format": "string",
31457 "type": "string"
41457}
application/x-www-form-urlencoded7 / 12
ConfigurationUpdate
12102{
2210n/a "properties": {
3210n/a "value": {
5210n/a }
6210n/a },
72102 "required": [
82102 "value"
92102 ],
10212n/a "type": "object"
112102}
Referenced Components (2)4 of 9 keywords
PolymorphicProperty4 of 7 keywords
1210n/a{
2210n/a "oneOf": [
318525 {
418525 "type": "boolean"
518525 },
625n/a {
725n/a "type": "string"
825n/a },
90210 {
100210 "type": "object"
110210 },
120210 {
1300 "items": {
1500 },
160210 "type": "array"
170210 }
18210n/a ]
19210n/a}
StringArrayItem0 of 2 keywords
100{
200 "format": "string",
30n/a "type": "string"
400}
Responses
codedescriptionhitsavg
200New configuration value stored, result in response.30017ms
400Bad request268ms
401Unauthenticated0never seen
404Page not found1114ms
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41538ms
Examples
Body: application/json
"EUR"StringArrayItem
Body: application/x-www-form-urlencoded
"EUR"StringArrayItem
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
currencies 18 operations 4 covered 14 partial 0 uncovered 0 not measured 74% #
Query Parameters
limit2 / 2
#validinvalidschema
121053{
221053 "format": "int32",
323627 "type": "integer"
421053}
page2 / 2
118052{
218052 "format": "int32",
319933 "type": "integer"
418052}
Headers
X-Trace-Id2 / 2
122744{
222744 "format": "uuid",
3271n/a "type": "string"
422744}
Responses
codedescriptionhitsavg
200A list of currencies.47420ms
400Bad request318ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
Headers
X-Trace-Id2 / 2
#validinvalidschema
124141{
224141 "format": "uuid",
3282n/a "type": "string"
424141}
Body
application/json5 / 13
CurrencyStore
1317{
2362 "properties": {
3330 "code": {
400 "format": "string",
5330 "type": "string"
6330 },
7151 "decimal_places": {
8151 "format": "int32",
9151 "type": "integer"
10151 },
11190 "enabled": {
12190 "type": "boolean"
13190 },
14371 "name": {
1500 "format": "string",
16371 "type": "string"
17371 },
18170 "primary": {
19170 "type": "boolean"
20170 },
21380 "symbol": {
2200 "format": "string",
23380 "type": "string"
24380 }
25362 },
26335 "required": [
27335 "code",
28380 "name",
29380 "symbol"
30335 ],
31380 "type": "object"
32317}
application/x-www-form-urlencoded7 / 13
CurrencyStore
1197{
2251 "properties": {
3200 "code": {
400 "format": "string",
520n/a "type": "string"
6200 },
711 "decimal_places": {
811 "format": "int32",
920 "type": "integer"
1011 },
11120 "enabled": {
12120 "type": "boolean"
13120 },
14260 "name": {
1500 "format": "string",
1626n/a "type": "string"
17260 },
1870 "primary": {
1970 "type": "boolean"
2070 },
21260 "symbol": {
2200 "format": "string",
2326n/a "type": "string"
24260 }
25251 },
26206 "required": [
27206 "code",
28260 "name",
29260 "symbol"
30206 ],
3126n/a "type": "object"
32197}
Responses
codedescriptionhitsavg
200New currency stored, result in response.44517ms
400Bad request338ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41538ms
Examples
Body: application/json
"AMS"CurrencyStore.code
2CurrencyStore.decimal_places
trueCurrencyStore.enabled
trueCurrencyStore.enabled
"Ankh-Morpork dollar"CurrencyStore.name
trueCurrencyStore.primary
"AM$"CurrencyStore.symbol
Body: application/x-www-form-urlencoded
"AMS"CurrencyStore.code
2CurrencyStore.decimal_places
trueCurrencyStore.enabled
trueCurrencyStore.enabled
"Ankh-Morpork dollar"CurrencyStore.name
trueCurrencyStore.primary
"AM$"CurrencyStore.symbol
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Headers
X-Trace-Id2 / 2
#validinvalidschema
119290{
219290 "format": "uuid",
3282n/a "type": "string"
419290}
Responses
codedescriptionhitsavg
200The default currency45817ms
400Bad request558ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Headers
X-Trace-Id2 / 2
#validinvalidschema
119175{
219175 "format": "uuid",
3266n/a "type": "string"
419175}
Responses
codedescriptionhitsavg
200The primary currency46317ms
400Bad request388ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path Parameters
code1 / 2
#validinvalidschema
11270{
200 "format": "string",
3127n/a "type": "string"
41270}
Headers
X-Trace-Id2 / 2
14144{
24144 "format": "uuid",
385n/a "type": "string"
44144}
Responses
codedescriptionhitsavg
204Currency deleted.124ms
400Bad request268ms
401Unauthenticated0never seen
404Page not found9815ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK11816ms
403Forbidden20ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"GBP"code
Path Parameters
code1 / 2
#validinvalidschema
13480{
200 "format": "string",
3348n/a "type": "string"
43480}
Headers
X-Trace-Id2 / 2
113235{
213235 "format": "uuid",
3167n/a "type": "string"
413235}
Responses
codedescriptionhitsavg
200The requested currency16717ms
400Bad request248ms
401Unauthenticated0never seen
404Page not found16415ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden50ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"USD"code
Path Parameters
code1 / 2
#validinvalidschema
14440{
200 "format": "string",
3444n/a "type": "string"
44440}
Headers
X-Trace-Id2 / 2
128936{
228936 "format": "uuid",
3325n/a "type": "string"
428936}
Body
application/vnd.api+json4 / 13
CurrencyUpdate
11707{
21041 "properties": {
3740 "code": {
400 "format": "string",
5740 "type": "string"
6740 },
7640 "decimal_places": {
8640 "format": "int32",
9640 "type": "integer"
10640 },
11801 "enabled": {
12801 "type": "boolean"
13801 },
14640 "name": {
1500 "format": "string",
16640 "type": "string"
17640 },
18730 "primary": {
19730 "enum": [
2073n/a true
21730 ],
22730 "type": "boolean"
23730 },
24631 "symbol": {
2500 "format": "string",
26631 "type": "string"
27631 }
281041 },
291716 "type": "object"
301707}
application/x-www-form-urlencoded7 / 13
CurrencyUpdate
11389{
21199 "properties": {
3830 "code": {
400 "format": "string",
583n/a "type": "string"
6830 },
7789 "decimal_places": {
8789 "format": "int32",
9861 "type": "integer"
10789 },
11900 "enabled": {
12900 "type": "boolean"
13900 },
14720 "name": {
1500 "format": "string",
1672n/a "type": "string"
17720 },
18750 "primary": {
19750 "enum": [
2075n/a true
21750 ],
22750 "type": "boolean"
23750 },
24840 "symbol": {
2500 "format": "string",
2684n/a "type": "string"
27840 }
281199 },
29147n/a "type": "object"
301389}
Responses
codedescriptionhitsavg
200Updated currency stored, result in response30219ms
400Bad request278ms
401Unauthenticated0never seen
404Page not found25815ms
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41538ms
403Forbidden40ms
409Conflict625ms
Examples
Body: application/vnd.api+json
"AMS"CurrencyUpdate.code
2CurrencyUpdate.decimal_places
trueCurrencyUpdate.enabled
"Ankh-Morpork dollar"CurrencyUpdate.name
trueCurrencyUpdate.primary
"AM$"CurrencyUpdate.symbol
Body: application/x-www-form-urlencoded
"AMS"CurrencyUpdate.code
2CurrencyUpdate.decimal_places
trueCurrencyUpdate.enabled
"Ankh-Morpork dollar"CurrencyUpdate.name
trueCurrencyUpdate.primary
"AM$"CurrencyUpdate.symbol
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"EUR"code
Path Parameters
code1 / 2
#validinvalidschema
15290{
200 "format": "string",
3529n/a "type": "string"
45290}
Query Parameters
limit2 / 2
124230{
224230 "format": "int32",
325517 "type": "integer"
424230}
page2 / 2
126234{
226234 "format": "int32",
328115 "type": "integer"
426234}
date2 / 2
119623{
219623 "format": "date",
3219n/a "type": "string"
419623}
type2 / 2
AccountTypeFilter
119726{
219726 "enum": [
353n/a "all",
47n/a "asset",
56n/a "cash",
616n/a "expense",
79n/a "revenue",
810n/a "special",
97n/a "hidden",
102n/a "liability",
1122n/a "liabilities",
1212n/a "Default account",
134n/a "Cash account",
144n/a "Asset account",
153n/a "Expense account",
164n/a "Revenue account",
174n/a "Initial balance account",
183n/a "Beneficiary account",
1911n/a "Import account",
201n/a "Reconciliation account",
216n/a "Loan",
223n/a "Debt",
2310n/a "Mortgage"
2419726 ],
25223n/a "type": "string"
2619726}
Headers
X-Trace-Id2 / 2
122938{
222938 "format": "uuid",
3267n/a "type": "string"
422938}
Responses
codedescriptionhitsavg
200A list of accounts27222ms
400Bad request278ms
401Unauthenticated0never seen
404Page not found23415ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"USD"code
Query
10limit
1page
Path Parameters
code1 / 2
#validinvalidschema
15390{
200 "format": "string",
3539n/a "type": "string"
45390}
Query Parameters
limit2 / 2
124349{
224349 "format": "int32",
326329 "type": "integer"
424349}
page2 / 2
120642{
220642 "format": "int32",
322127 "type": "integer"
420642}
Headers
X-Trace-Id2 / 2
123527{
223527 "format": "uuid",
3262n/a "type": "string"
423527}
Responses
codedescriptionhitsavg
200A list of available budgets28017ms
400Bad request238ms
401Unauthenticated0never seen
404Page not found23915ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden20ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"EUR"code
Query
10limit
1page
Path Parameters
code1 / 2
#validinvalidschema
14880{
200 "format": "string",
3488n/a "type": "string"
44880}
Query Parameters
limit2 / 2
119743{
219743 "format": "int32",
321723 "type": "integer"
419743}
page2 / 2
118539{
218539 "format": "int32",
319331 "type": "integer"
418539}
Headers
X-Trace-Id2 / 2
115641{
215641 "format": "uuid",
3197n/a "type": "string"
415641}
Responses
codedescriptionhitsavg
200A list of bills.25718ms
400Bad request348ms
401Unauthenticated0never seen
404Page not found19115ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden80ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"USD"code
Query
10limit
1page
Path Parameters
code1 / 2
#validinvalidschema
15390{
200 "format": "string",
3539n/a "type": "string"
45390}
Query Parameters
limit2 / 2
121231{
221231 "format": "int32",
322518 "type": "integer"
421231}
page2 / 2
119925{
219925 "format": "int32",
321113 "type": "integer"
419925}
start2 / 2
119822{
219822 "format": "date",
3220n/a "type": "string"
419822}
end2 / 2
120122{
220122 "format": "date",
3223n/a "type": "string"
420122}
Headers
X-Trace-Id2 / 2
128533{
228533 "format": "uuid",
3318n/a "type": "string"
428533}
Responses
codedescriptionhitsavg
200A list of budget limits.26720ms
400Bad request188ms
401Unauthenticated0never seen
404Page not found25715ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"USD"code
Query
10limit
1page
"2026-10-01"start
"2026-10-31"end
Path Parameters
code1 / 2
#validinvalidschema
13440{
200 "format": "string",
3344n/a "type": "string"
43440}
Query Parameters
limit2 / 2
117330{
217330 "format": "int32",
318518 "type": "integer"
417330}
page2 / 2
117029{
217029 "format": "int32",
318316 "type": "integer"
417029}
Headers
X-Trace-Id2 / 2
120231{
220231 "format": "uuid",
3233n/a "type": "string"
420231}
Responses
codedescriptionhitsavg
200A list of currency exchange rates.12018ms
400Bad request248ms
401Unauthenticated0never seen
404Page not found19715ms
500Internal exception12317ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"USD"code
Query
10limit
1page
Path Parameters
code1 / 1
#validinvalidschema
1550n/a{
2550n/a "type": "string"
3550n/a}
Headers
X-Trace-Id2 / 2
122065{
222065 "format": "uuid",
3285n/a "type": "string"
422065}
Responses
codedescriptionhitsavg
204Currency was disabled.0never seen
400Bad request0never seen
401Unauthenticated0never seen
404Page not found0never seen
409Currency cannot be disabled, because it is still in use.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
4155508ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"GBP"code
Path Parameters
code1 / 2
#validinvalidschema
14860{
200 "format": "string",
3486n/a "type": "string"
44860}
Headers
X-Trace-Id2 / 2
119039{
219039 "format": "uuid",
3229n/a "type": "string"
419039}
Responses
codedescriptionhitsavg
204Currency was enabled.0never seen
400Bad request0never seen
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
4154858ms
403Forbidden10ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"USD"code
Path Parameters
code1 / 2
#validinvalidschema
14760{
200 "format": "string",
3476n/a "type": "string"
44760}
Headers
X-Trace-Id2 / 2
118536{
218536 "format": "uuid",
3221n/a "type": "string"
418536}
Responses
codedescriptionhitsavg
204Currency has been made the primary currency.0never seen
400Bad request0never seen
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
4154768ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"USD"code
Path Parameters
code1 / 2
#validinvalidschema
14890{
200 "format": "string",
3489n/a "type": "string"
44890}
Query Parameters
limit2 / 2
119144{
219144 "format": "int32",
321124 "type": "integer"
419144}
page2 / 2
118134{
218134 "format": "int32",
319322 "type": "integer"
418134}
Headers
X-Trace-Id2 / 2
117634{
217634 "format": "uuid",
3210n/a "type": "string"
417634}
Responses
codedescriptionhitsavg
200A list of recurring transactions24718ms
400Bad request198ms
401Unauthenticated0never seen
404Page not found22415ms
500Internal exception219ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"EUR"code
Query
10limit
1page
Path Parameters
code1 / 2
#validinvalidschema
15160{
200 "format": "string",
3516n/a "type": "string"
45160}
Query Parameters
limit2 / 2
123635{
223635 "format": "int32",
325417 "type": "integer"
423635}
page2 / 2
121942{
221942 "format": "int32",
323229 "type": "integer"
421942}
Headers
X-Trace-Id2 / 2
122146{
222146 "format": "uuid",
3267n/a "type": "string"
422146}
Responses
codedescriptionhitsavg
200A list of rules21517ms
400Bad request268ms
401Unauthenticated0never seen
404Page not found27415ms
500Internal exception5718ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"USD"code
Query
10limit
1page
Path Parameters
code1 / 2
#validinvalidschema
15260{
200 "format": "string",
3526n/a "type": "string"
45260}
Query Parameters
limit2 / 2
121028{
221028 "format": "int32",
322117 "type": "integer"
421028}
page2 / 2
121714{
221714 "format": "int32",
322110 "type": "integer"
421714}
start2 / 2
122236{
222236 "format": "date",
3258n/a "type": "string"
422236}
end2 / 2
121113{
221113 "format": "date",
3224n/a "type": "string"
421113}
type2 / 2
TransactionTypeFilter
118412{
218412 "enum": [
363n/a "all",
46n/a "withdrawal",
510n/a "withdrawals",
69n/a "expense",
710n/a "deposit",
811n/a "deposits",
98n/a "income",
109n/a "transfer",
1112n/a "transfers",
1213n/a "opening_balance",
139n/a "reconciliation",
145n/a "special",
1514n/a "specials",
165n/a "default"
1718412 ],
18196n/a "type": "string"
1918412}
Headers
X-Trace-Id2 / 2
127329{
227329 "format": "uuid",
3302n/a "type": "string"
427329}
Responses
codedescriptionhitsavg
200A list of transactions.28622ms
400Bad request238ms
401Unauthenticated0never seen
404Page not found22215ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"USD"code
Query
10limit
1page
"2026-10-01"start
"2026-10-31"end
currency_exchange_rates 12 operations 6 covered 6 partial 0 uncovered 0 not measured 73% #
Query Parameters
limit2 / 2
#validinvalidschema
122257{
222257 "format": "int32",
324930 "type": "integer"
422257}
page2 / 2
120454{
220454 "format": "int32",
323127 "type": "integer"
420454}
Headers
X-Trace-Id2 / 2
124065{
224065 "format": "uuid",
3305n/a "type": "string"
424065}
Responses
codedescriptionhitsavg
200A list of all available currency exchange rates.45723ms
400Bad request488ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
Headers
X-Trace-Id2 / 2
#validinvalidschema
120439{
220439 "format": "uuid",
3243n/a "type": "string"
420439}
Body
application/json1 / 15
CurrencyExchangeRateStore
1291{
2300 "properties": {
3300 "date": {
4300 "format": "date",
5300 "nullable": false,
6300 "type": "string"
7300 },
8300 "from": {
900 "format": "string",
10300 "nullable": false,
11300 "type": "string"
12300 },
13290 "rate": {
1400 "format": "string",
15290 "nullable": false,
16290 "type": "string"
17290 },
18300 "to": {
1900 "format": "string",
20300 "nullable": false,
21300 "type": "string"
22300 }
23300 },
24291 "required": [
25300 "date",
26300 "from",
27300 "to",
28291 "rates"
29291 ],
30300 "type": "object"
31291}
application/x-www-form-urlencoded8 / 15
CurrencyExchangeRateStore
153{
271 "properties": {
371 "date": {
471 "format": "date",
580 "nullable": false,
68n/a "type": "string"
771 },
880 "from": {
900 "format": "string",
1080 "nullable": false,
118n/a "type": "string"
1280 },
1360 "rate": {
1400 "format": "string",
1560 "nullable": false,
166n/a "type": "string"
1760 },
1880 "to": {
1900 "format": "string",
2080 "nullable": false,
218n/a "type": "string"
2280 }
2371 },
2453 "required": [
2580 "date",
2680 "from",
2780 "to",
2853 "rates"
2953 ],
308n/a "type": "object"
3153}
Responses
codedescriptionhitsavg
200New exchange stored, result in response. If a rate already exists for this currency pair and date, it will be updated.37517ms
400Bad request298ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41538ms
Examples
Body: application/json
"2026-10-01"CurrencyExchangeRateStore.date
"USD"CurrencyExchangeRateStore.from
"2.3456"CurrencyExchangeRateStore.rate
"EUR"CurrencyExchangeRateStore.to
Body: application/x-www-form-urlencoded
"2026-10-01"CurrencyExchangeRateStore.date
"USD"CurrencyExchangeRateStore.from
"2.3456"CurrencyExchangeRateStore.rate
"EUR"CurrencyExchangeRateStore.to
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path Parameters
from1 / 1
#validinvalidschema
1366n/a{
2366n/a "type": "string"
3366n/a}
to1 / 1
1366n/a{
2366n/a "type": "string"
3366n/a}
Headers
X-Trace-Id2 / 2
117946{
217946 "format": "uuid",
3225n/a "type": "string"
417946}
Body
application/json2 / 2
CurrencyExchangeRateStoreByPair
126918{
215711 "additionalProperties": {
346433 "type": "string"
415711 },
52807 "type": "object"
626918}
Responses
codedescriptionhitsavg
200New exchange rates stored, result in response. If a rate already existed for any submitted entry, it will be updated.15818ms
400Bad request318ms
401Unauthenticated0never seen
404Page not found25915ms
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41538ms
403Forbidden20ms
Examples
Body: application/json
{ "2025-08-01": "1.2345", "2025-08-02": "6.3456" }CurrencyExchangeRateStoreByPair
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"EUR"from
"USD"to
Path Parameters
date1 / 2
#validinvalidschema
14910{
200 "format": "string",
3491n/a "type": "string"
44910}
Headers
X-Trace-Id2 / 2
122130{
222130 "format": "uuid",
3251n/a "type": "string"
422130}
Body
application/json6 / 7
CurrencyExchangeRateStoreByDate
138822{
239211 "properties": {
33936 "from": {
400 "format": "string",
53936 "type": "string"
63936 },
73976 "rates": {
82462 "additionalProperties": {
973612 "type": "string"
102462 },
113994 "type": "object"
123976 }
1339211 },
143994 "required": [
153994 "from",
164030 "date",
174030 "rates"
183994 ],
194037 "type": "object"
2038822}
Responses
codedescriptionhitsavg
200New exchange rates stored, result in response. If a rate already existed for any submitted entry, it will be updated.1916ms
400Bad request248ms
401Unauthenticated0never seen
404Page not found36615ms
422Validation error. The body will have the exact details.0never seen
500Internal exception9420ms
Undocumented - not in spec
codedescriptionhitsavg
41537ms
403Forbidden20ms
Examples
Body: application/json
"EUR"CurrencyExchangeRateStoreByDate.from
{ "GBP": "6.3456", "USD": "1.2345" }CurrencyExchangeRateStoreByDate.rates
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path Parameters
from1 / 1
#validinvalidschema
1212n/a{
2212n/a "type": "string"
3212n/a}
to1 / 1
1212n/a{
2212n/a "type": "string"
3212n/a}
Headers
X-Trace-Id2 / 2
18376{
28376 "format": "uuid",
3159n/a "type": "string"
48376}
Responses
codedescriptionhitsavg
204Currency exchange rate(s) deleted.6023ms
400Bad request398ms
401Unauthenticated0never seen
404Page not found10915ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK9615ms
403Forbidden40ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"EUR"from
"USD"to
Path Parameters
from1 / 1
#validinvalidschema
1534n/a{
2534n/a "type": "string"
3534n/a}
to1 / 1
1534n/a{
2534n/a "type": "string"
3534n/a}
Query Parameters
limit2 / 2
1192190{
2192190 "format": "int32",
334537 "type": "integer"
4192190}
page2 / 2
1192190{
2192190 "format": "int32",
3211171 "type": "integer"
4192190}
Headers
X-Trace-Id2 / 2
125436{
225436 "format": "uuid",
3290n/a "type": "string"
425436}
Responses
codedescriptionhitsavg
200A list of currency exchange rates.21318ms
400Bad request318ms
401Unauthenticated0never seen
404Page not found29915ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"EUR"from
"USD"to
Query
10limit
1page
Path Parameters
from1 / 1
#validinvalidschema
1320n/a{
2320n/a "type": "string"
3320n/a}
to1 / 1
1320n/a{
2320n/a "type": "string"
3320n/a}
date1 / 2
13200{
200 "format": "string",
3320n/a "type": "string"
43200}
Headers
X-Trace-Id2 / 2
18049{
28049 "format": "uuid",
3129n/a "type": "string"
48049}
Responses
codedescriptionhitsavg
204Currency exchange rate(s) deleted.0never seen
400Bad request318ms
401Unauthenticated0never seen
404Page not found28014ms
500Internal exception920ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"EUR"from
"USD"to
Path Parameters
from1 / 1
#validinvalidschema
1475n/a{
2475n/a "type": "string"
3475n/a}
to1 / 1
1475n/a{
2475n/a "type": "string"
3475n/a}
date1 / 2
14750{
200 "format": "string",
3475n/a "type": "string"
44750}
Query Parameters
limit2 / 2
121030{
221030 "format": "int32",
322218 "type": "integer"
421030}
page2 / 2
120838{
220838 "format": "int32",
322818 "type": "integer"
420838}
Headers
X-Trace-Id2 / 2
119643{
219643 "format": "uuid",
3239n/a "type": "string"
419643}
Responses
codedescriptionhitsavg
200A list of currency exchange rates.3116ms
400Bad request278ms
401Unauthenticated0never seen
404Page not found44215ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden40ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"EUR"from
"USD"to
Query
10limit
1page
Path Parameters
from1 / 1
#validinvalidschema
1335n/a{
2335n/a "type": "string"
3335n/a}
to1 / 1
1335n/a{
2335n/a "type": "string"
3335n/a}
date1 / 2
13350{
200 "format": "string",
3335n/a "type": "string"
43350}
Headers
X-Trace-Id2 / 2
125336{
225336 "format": "uuid",
3289n/a "type": "string"
425336}
Body
application/json5 / 6
CurrencyExchangeRateUpdateNoDate
11698{
21694 "properties": {
31694 "rate": {
400 "format": "string",
51712 "nullable": false,
61694 "type": "string"
71694 }
81694 },
91733 "required": [
101733 "rate"
111733 ],
121761 "type": "object"
131698}
application/x-www-form-urlencoded10 / 15
CurrencyExchangeRateUpdate
11386{
21404 "properties": {
31384 "date": {
41384 "format": "date",
51420 "nullable": false,
6142n/a "type": "string"
71384 },
8540 "from": {
900 "format": "string",
1054n/a "nullable": true,
1154n/a "type": "string"
12540 },
131440 "rate": {
1400 "format": "string",
151440 "nullable": false,
16144n/a "type": "string"
171440 },
18580 "to": {
1900 "format": "string",
2058n/a "nullable": true,
2158n/a "type": "string"
22580 }
231404 },
241422 "required": [
251422 "date",
261440 "rate"
271422 ],
28144n/a "type": "object"
291386}
Responses
codedescriptionhitsavg
200Updated exchange rate stored, result in response13817ms
400Bad request198ms
401Unauthenticated0never seen
404Page not found30915ms
422Validation error. The body will have the exact details.0never seen
Undocumented - not in spec
codedescriptionhitsavg
41538ms
403Forbidden20ms
Examples
Body: application/json
"2.3456"CurrencyExchangeRateUpdateNoDate.rate
Body: application/x-www-form-urlencoded
"2026-10-01"CurrencyExchangeRateUpdate.date
"USD"CurrencyExchangeRateUpdate.from
"2.3456"CurrencyExchangeRateUpdate.rate
"EUR"CurrencyExchangeRateUpdate.to
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"EUR"from
"USD"to
Path Parameters
id1 / 1
#validinvalidschema
169n/a{
269n/a "type": "string"
369n/a}
Headers
X-Trace-Id2 / 2
13920{
23920 "format": "uuid",
359n/a "type": "string"
43920}
Responses
codedescriptionhitsavg
204Currency exchange rate deleted.1325ms
400Bad request178ms
401Unauthenticated0never seen
404Page not found3714ms
500Internal exception222ms
Undocumented - not in spec
codedescriptionhitsavg
200OK315ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1405n/a{
2405n/a "type": "string"
3405n/a}
Query Parameters
limit2 / 2
117138{
217138 "format": "int32",
318425 "type": "integer"
417138}
page2 / 2
117136{
217136 "format": "int32",
317928 "type": "integer"
417136}
Headers
X-Trace-Id2 / 2
119537{
219537 "format": "uuid",
3232n/a "type": "string"
419537}
Responses
codedescriptionhitsavg
200The exchange rate requested.18118ms
400Bad request318ms
401Unauthenticated0never seen
404Page not found19515ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
Path Parameters
id1 / 1
#validinvalidschema
1363n/a{
2363n/a "type": "string"
3363n/a}
Headers
X-Trace-Id2 / 2
124734{
224734 "format": "uuid",
3281n/a "type": "string"
424734}
Body
application/json12 / 15
CurrencyExchangeRateUpdate
119828{
220120 "properties": {
32136 "date": {
42131 "format": "date",
52181 "nullable": false,
62145 "type": "string"
72136 },
81284 "from": {
900 "format": "string",
10132n/a "nullable": true,
111284 "type": "string"
121284 },
132146 "rate": {
1400 "format": "string",
152191 "nullable": false,
162146 "type": "string"
172146 },
181334 "to": {
1900 "format": "string",
20137n/a "nullable": true,
211334 "type": "string"
221334 }
2320120 },
242183 "required": [
252192 "date",
262201 "rate"
272183 ],
282215 "type": "object"
2919828}
application/x-www-form-urlencoded10 / 15
CurrencyExchangeRateUpdate
11147{
21174 "properties": {
31164 "date": {
41164 "format": "date",
51200 "nullable": false,
6120n/a "type": "string"
71164 },
8650 "from": {
900 "format": "string",
1065n/a "nullable": true,
1165n/a "type": "string"
12650 },
131190 "rate": {
1400 "format": "string",
151190 "nullable": false,
16119n/a "type": "string"
171190 },
18740 "to": {
1900 "format": "string",
2074n/a "nullable": true,
2174n/a "type": "string"
22740 }
231174 },
241183 "required": [
251201 "date",
261192 "rate"
271183 ],
28121n/a "type": "object"
291147}
Responses
codedescriptionhitsavg
200Updated exchange rate stored, result in response17817ms
400Bad request278ms
401Unauthenticated0never seen
404Page not found32215ms
422Validation error. The body will have the exact details.0never seen
Undocumented - not in spec
codedescriptionhitsavg
41538ms
Examples
Body: application/json
"2026-10-01"CurrencyExchangeRateUpdate.date
"USD"CurrencyExchangeRateUpdate.from
"2.3456"CurrencyExchangeRateUpdate.rate
"EUR"CurrencyExchangeRateUpdate.to
Body: application/x-www-form-urlencoded
"2026-10-01"CurrencyExchangeRateUpdate.date
"USD"CurrencyExchangeRateUpdate.from
"2.3456"CurrencyExchangeRateUpdate.rate
"EUR"CurrencyExchangeRateUpdate.to
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
data 13 operations 11 covered 2 partial 0 uncovered 0 not measured 94% #
Query Parameters
query1 / 2
#validinvalidschema
1680{
200 "format": "json",
368n/a "type": "string"
4680}
Headers
X-Trace-Id2 / 2
111656{
211656 "format": "uuid",
3172n/a "type": "string"
411656}
Responses
codedescriptionhitsavg
204Empty response when the update was successful. A future improvement is to include the changed transactions.0never seen
400Bad request268ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception4219ms
Undocumented - not in spec
codedescriptionhitsavg
200OK30917ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
objects2 / 2
DataDestroyObject
#validinvalidschema
11714{
21714 "enum": [
315n/a "not_assets_liabilities",
41n/a "budgets",
54n/a "bills",
60n/a "piggy_banks",
72n/a "rules",
82n/a "recurring",
92n/a "categories",
10127n/a "tags",
111n/a "object_groups",
120n/a "accounts",
131n/a "asset_accounts",
144n/a "expense_accounts",
155n/a "revenue_accounts",
160n/a "liabilities",
171n/a "transactions",
182n/a "withdrawals",
193n/a "deposits",
201n/a "transfers"
211714 ],
22175n/a "type": "string"
231714}
unused3 / 3
1165{
2165 "items": {
34837 "format": "int64",
45332 "type": "integer"
5165 },
621n/a "type": "array"
7165}
Headers
X-Trace-Id2 / 2
112146{
212146 "format": "uuid",
3167n/a "type": "string"
412146}
Responses
codedescriptionhitsavg
204Empty response when data has been destroyed.14422ms
400Bad request318ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK14316ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]unused
Query Parameters
type2 / 2
ExportFileFilter
#validinvalidschema
1639{
2639 "enum": [
363n/a "csv"
4639 ],
572n/a "type": "string"
6639}
Headers
X-Trace-Id2 / 2
111550{
211550 "format": "uuid",
3165n/a "type": "string"
411550}
Responses
codedescriptionhitsavg
200The exported transaction in a file.27518ms
400Bad request328ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
type2 / 2
ExportFileFilter
#validinvalidschema
16311{
26311 "enum": [
363n/a "csv"
46311 ],
574n/a "type": "string"
66311}
Headers
X-Trace-Id2 / 2
110543{
210543 "format": "uuid",
3148n/a "type": "string"
410543}
Responses
codedescriptionhitsavg
200The exported transaction in a file.26618ms
400Bad request308ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
type2 / 2
ExportFileFilter
#validinvalidschema
16311{
26311 "enum": [
363n/a "csv"
46311 ],
574n/a "type": "string"
66311}
Headers
X-Trace-Id2 / 2
112834{
212834 "format": "uuid",
3162n/a "type": "string"
412834}
Responses
codedescriptionhitsavg
200The exported transaction in a file.25619ms
400Bad request288ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
type2 / 2
ExportFileFilter
#validinvalidschema
1645{
2645 "enum": [
364n/a "csv"
4645 ],
569n/a "type": "string"
6645}
Headers
X-Trace-Id2 / 2
110346{
210346 "format": "uuid",
3149n/a "type": "string"
410346}
Responses
codedescriptionhitsavg
200The exported transaction in a file.25020ms
400Bad request298ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
type2 / 2
ExportFileFilter
#validinvalidschema
1665{
2665 "enum": [
366n/a "csv"
4665 ],
571n/a "type": "string"
6665}
Headers
X-Trace-Id2 / 2
111241{
211241 "format": "uuid",
3153n/a "type": "string"
411241}
Responses
codedescriptionhitsavg
200The exported transaction in a file.26218ms
400Bad request308ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception219ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
type2 / 2
ExportFileFilter
#validinvalidschema
1652{
2652 "enum": [
365n/a "csv"
4652 ],
567n/a "type": "string"
6652}
Headers
X-Trace-Id2 / 2
111640{
211640 "format": "uuid",
3156n/a "type": "string"
411640}
Responses
codedescriptionhitsavg
200The exported transaction in a file.28717ms
400Bad request338ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
type2 / 2
ExportFileFilter
#validinvalidschema
1546{
2546 "enum": [
354n/a "csv"
4546 ],
560n/a "type": "string"
6546}
Headers
X-Trace-Id2 / 2
19739{
29739 "format": "uuid",
3136n/a "type": "string"
49739}
Responses
codedescriptionhitsavg
200The exported transaction in a file.27418ms
400Bad request268ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
type2 / 2
ExportFileFilter
#validinvalidschema
1664{
2664 "enum": [
366n/a "csv"
4664 ],
570n/a "type": "string"
6664}
Headers
X-Trace-Id2 / 2
111832{
211832 "format": "uuid",
3150n/a "type": "string"
411832}
Responses
codedescriptionhitsavg
200The exported transaction in a file.27718ms
400Bad request258ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
type2 / 2
ExportFileFilter
#validinvalidschema
15912{
25912 "enum": [
359n/a "csv"
45912 ],
571n/a "type": "string"
65912}
Headers
X-Trace-Id2 / 2
112737{
212737 "format": "uuid",
3164n/a "type": "string"
412737}
Responses
codedescriptionhitsavg
200The exported transaction in a file.28418ms
400Bad request318ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
start1 / 2
#validinvalidschema
11120{
21120 "format": "date",
3112n/a "type": "string"
41120}
end2 / 2
11085{
21085 "format": "date",
3113n/a "type": "string"
41085}
accounts1 / 2
1490{
200 "format": "string",
349n/a "type": "string"
4490}
type2 / 2
ExportFileFilter
1271{
2271 "enum": [
327n/a "csv"
4271 ],
528n/a "type": "string"
6271}
Headers
X-Trace-Id2 / 2
119640{
219640 "format": "uuid",
3236n/a "type": "string"
419640}
Responses
codedescriptionhitsavg
200The exported transaction in a file.34518ms
400Bad request328ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Headers
X-Trace-Id2 / 2
#validinvalidschema
18449{
28449 "format": "uuid",
3133n/a "type": "string"
48449}
Responses
codedescriptionhitsavg
204Empty response when data has been purged.26120ms
400Bad request268ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK1625ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
insight 24 operations 17 covered 7 partial 0 uncovered 0 not measured 96% #
Query Parameters
start2 / 2
#validinvalidschema
11533{
21533 "format": "date",
3156n/a "type": "string"
41533}
end2 / 2
11515{
21515 "format": "date",
3156n/a "type": "string"
41515}
accounts[]3 / 3
16817{
26817 "items": {
327635 "format": "int64",
427734 "type": "integer"
56817 },
685n/a "type": "array"
76817}
Headers
X-Trace-Id2 / 2
19942{
29942 "format": "uuid",
3141n/a "type": "string"
49942}
Responses
codedescriptionhitsavg
200A list of asset accounts and expense details. Each asset account has one row per currency.26518ms
400Bad request258ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception1718ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]accounts[]
Query Parameters
start2 / 2
#validinvalidschema
12282{
22282 "format": "date",
3230n/a "type": "string"
42282}
end2 / 2
12282{
22282 "format": "date",
3230n/a "type": "string"
42282}
bills[]3 / 3
110320{
210320 "items": {
335023 "format": "int64",
435221 "type": "integer"
510320 },
6123n/a "type": "array"
710320}
accounts[]3 / 3
18717{
28717 "items": {
326550 "format": "int64",
426847 "type": "integer"
58717 },
6104n/a "type": "array"
78717}
Headers
X-Trace-Id2 / 2
118527{
218527 "format": "uuid",
3212n/a "type": "string"
418527}
Responses
codedescriptionhitsavg
200A list of budget and expense details. Each budget has one row per currency.31518ms
400Bad request248ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception2918ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]bills[]
[ 1, 2, 3 ]accounts[]
Query Parameters
start2 / 2
#validinvalidschema
11953{
21953 "format": "date",
3198n/a "type": "string"
41953}
end2 / 2
11926{
21926 "format": "date",
3198n/a "type": "string"
41926}
budgets[]3 / 3
18318{
28318 "items": {
323858 "format": "int64",
424056 "type": "integer"
58318 },
6101n/a "type": "array"
78318}
accounts[]3 / 3
15821{
25821 "items": {
3191140 "format": "int64",
4193138 "type": "integer"
55821 },
679n/a "type": "array"
75821}
Headers
X-Trace-Id2 / 2
119937{
219937 "format": "uuid",
3236n/a "type": "string"
419937}
Responses
codedescriptionhitsavg
200A list of budget and expense details. Each budget has one row per currency.29425ms
400Bad request288ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception1917ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]budgets[]
[ 1, 2, 3 ]accounts[]
Query Parameters
start1 / 2
#validinvalidschema
11380{
21380 "format": "date",
3138n/a "type": "string"
41380}
end1 / 2
11380{
21380 "format": "date",
3138n/a "type": "string"
41380}
categories[]3 / 3
16622{
26622 "items": {
321275 "format": "int64",
421473 "type": "integer"
56622 },
688n/a "type": "array"
76622}
accounts[]3 / 3
15619{
25619 "items": {
317831 "format": "int64",
418029 "type": "integer"
55619 },
675n/a "type": "array"
75619}
Headers
X-Trace-Id2 / 2
115139{
215139 "format": "uuid",
3190n/a "type": "string"
415139}
Responses
codedescriptionhitsavg
200A list of category and expense details. Each category has one row per currency.26330ms
400Bad request238ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception2118ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]categories[]
[ 1, 2, 3 ]accounts[]
Query Parameters
start1 / 2
#validinvalidschema
11710{
21710 "format": "date",
3171n/a "type": "string"
41710}
end2 / 2
11692{
21692 "format": "date",
3171n/a "type": "string"
41692}
accounts[]3 / 3
17613{
27613 "items": {
325723 "format": "int64",
426020 "type": "integer"
57613 },
689n/a "type": "array"
77613}
Headers
X-Trace-Id2 / 2
113442{
213442 "format": "uuid",
3176n/a "type": "string"
413442}
Responses
codedescriptionhitsavg
200A list of expense accounts and expense details. Each expense account has one row per currency.27118ms
400Bad request328ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception1018ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]accounts[]
Query Parameters
start2 / 2
#validinvalidschema
12252{
22252 "format": "date",
3227n/a "type": "string"
42252}
end2 / 2
12252{
22252 "format": "date",
3227n/a "type": "string"
42252}
accounts[]3 / 3
18814{
28814 "items": {
325628 "format": "int64",
425727 "type": "integer"
58814 },
6102n/a "type": "array"
78814}
Headers
X-Trace-Id2 / 2
112040{
212040 "format": "uuid",
3160n/a "type": "string"
412040}
Responses
codedescriptionhitsavg
200A list of expense details. One row per currency.28618ms
400Bad request258ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception1018ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]accounts[]
Query Parameters
start2 / 2
#validinvalidschema
11752{
21752 "format": "date",
3177n/a "type": "string"
41752}
end2 / 2
11781{
21781 "format": "date",
3179n/a "type": "string"
41781}
accounts[]3 / 3
17019{
27019 "items": {
3235127 "format": "int64",
4236126 "type": "integer"
57019 },
689n/a "type": "array"
77019}
Headers
X-Trace-Id2 / 2
110628{
210628 "format": "uuid",
3134n/a "type": "string"
410628}
Responses
codedescriptionhitsavg
200A list of expense details. One row per currency.28517ms
400Bad request238ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception1618ms
Undocumented - not in spec
codedescriptionhitsavg
41411ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]accounts[]
Query Parameters
start2 / 2
#validinvalidschema
12221{
22221 "format": "date",
3223n/a "type": "string"
42221}
end2 / 2
12221{
22221 "format": "date",
3223n/a "type": "string"
42221}
accounts[]3 / 3
17615{
27615 "items": {
3221330 "format": "int64",
4222329 "type": "integer"
57615 },
691n/a "type": "array"
77615}
Headers
X-Trace-Id2 / 2
115640{
215640 "format": "uuid",
3196n/a "type": "string"
415640}
Responses
codedescriptionhitsavg
200A list of expense details. One row per currency.27418ms
400Bad request278ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception1218ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]accounts[]
Query Parameters
start2 / 2
#validinvalidschema
12102{
22102 "format": "date",
3212n/a "type": "string"
42102}
end2 / 2
12075{
22075 "format": "date",
3212n/a "type": "string"
42075}
accounts[]3 / 3
16713{
26713 "items": {
320726 "format": "int64",
421023 "type": "integer"
56713 },
680n/a "type": "array"
76713}
Headers
X-Trace-Id2 / 2
115544{
215544 "format": "uuid",
3199n/a "type": "string"
415544}
Responses
codedescriptionhitsavg
200A list of expense details. One row per currency.27219ms
400Bad request298ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception917ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]accounts[]
Query Parameters
start2 / 2
#validinvalidschema
11534{
21534 "format": "date",
3157n/a "type": "string"
41534}
end2 / 2
11543{
21543 "format": "date",
3157n/a "type": "string"
41543}
tags[]3 / 3
16523{
26523 "items": {
319472 "format": "int64",
420066 "type": "integer"
56523 },
688n/a "type": "array"
76523}
accounts[]3 / 3
16615{
26615 "items": {
320517 "format": "int64",
420715 "type": "integer"
56615 },
681n/a "type": "array"
76615}
Headers
X-Trace-Id2 / 2
116449{
216449 "format": "uuid",
3213n/a "type": "string"
416449}
Responses
codedescriptionhitsavg
200A list of tag and expense details. Each tag has one row per currency.31717ms
400Bad request318ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception2617ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]tags[]
[ 1, 2, 3 ]accounts[]
Query Parameters
start2 / 2
#validinvalidschema
11867{
21867 "format": "date",
3193n/a "type": "string"
41867}
end2 / 2
11894{
21894 "format": "date",
3193n/a "type": "string"
41894}
accounts[]3 / 3
17215{
27215 "items": {
324247 "format": "int64",
424643 "type": "integer"
57215 },
687n/a "type": "array"
77215}
Headers
X-Trace-Id2 / 2
110156{
210156 "format": "uuid",
3157n/a "type": "string"
410156}
Responses
codedescriptionhitsavg
200A list of sums in different currencies.27417ms
400Bad request358ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception1617ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]accounts[]
Query Parameters
start2 / 2
#validinvalidschema
11033{
21033 "format": "date",
3106n/a "type": "string"
41033}
end2 / 2
11033{
21033 "format": "date",
3106n/a "type": "string"
41033}
accounts[]3 / 3
14714{
24714 "items": {
313224 "format": "int64",
413323 "type": "integer"
54714 },
661n/a "type": "array"
74714}
Headers
X-Trace-Id2 / 2
115449{
215449 "format": "uuid",
3203n/a "type": "string"
415449}
Responses
codedescriptionhitsavg
200A list of asset accounts and income details. Each asset account has one row per currency.27117ms
400Bad request308ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception1217ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]accounts[]
Query Parameters
start2 / 2
#validinvalidschema
11913{
21913 "format": "date",
3194n/a "type": "string"
41913}
end1 / 2
11940{
21940 "format": "date",
3194n/a "type": "string"
41940}
categories[]3 / 3
17126{
27126 "items": {
3212243 "format": "int64",
4214241 "type": "integer"
57126 },
697n/a "type": "array"
77126}
accounts[]3 / 3
16119{
26119 "items": {
318421 "format": "int64",
418619 "type": "integer"
56119 },
680n/a "type": "array"
76119}
Headers
X-Trace-Id2 / 2
119539{
219539 "format": "uuid",
3234n/a "type": "string"
419539}
Responses
codedescriptionhitsavg
200A list of category and income details. Each category has one row per currency.24336ms
400Bad request228ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception3118ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]categories[]
[ 1, 2, 3 ]accounts[]
Query Parameters
start1 / 2
#validinvalidschema
12380{
22380 "format": "date",
3238n/a "type": "string"
42380}
end2 / 2
12343{
22343 "format": "date",
3237n/a "type": "string"
42343}
accounts[]3 / 3
1789{
2789 "items": {
326623 "format": "int64",
426722 "type": "integer"
5789 },
687n/a "type": "array"
7789}
Headers
X-Trace-Id2 / 2
110948{
210948 "format": "uuid",
3157n/a "type": "string"
410948}
Responses
codedescriptionhitsavg
200A list of income details. One row per currency.27418ms
400Bad request348ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception1318ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]accounts[]
Query Parameters
start2 / 2
#validinvalidschema
11554{
21554 "format": "date",
3159n/a "type": "string"
41554}
end2 / 2
11564{
21564 "format": "date",
3160n/a "type": "string"
41564}
accounts[]3 / 3
16014{
26014 "items": {
319497 "format": "int64",
419596 "type": "integer"
56014 },
674n/a "type": "array"
76014}
Headers
X-Trace-Id2 / 2
112630{
212630 "format": "uuid",
3156n/a "type": "string"
412630}
Responses
codedescriptionhitsavg
200A list of income details. One row per currency.28217ms
400Bad request268ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception1017ms
Undocumented - not in spec
codedescriptionhitsavg
41412ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]accounts[]
Query Parameters
start2 / 2
#validinvalidschema
11235{
21235 "format": "date",
3128n/a "type": "string"
41235}
end2 / 2
11264{
21264 "format": "date",
3130n/a "type": "string"
41264}
accounts[]3 / 3
15717{
25717 "items": {
318675 "format": "int64",
419071 "type": "integer"
55717 },
674n/a "type": "array"
75717}
Headers
X-Trace-Id2 / 2
110748{
210748 "format": "uuid",
3155n/a "type": "string"
410748}
Responses
codedescriptionhitsavg
200A list of revenue accounts and income details. Each revenue account has one row per currency.26617ms
400Bad request348ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception1517ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]accounts[]
Query Parameters
start1 / 2
#validinvalidschema
11900{
21900 "format": "date",
3190n/a "type": "string"
41900}
end2 / 2
11873{
21873 "format": "date",
3190n/a "type": "string"
41873}
tags[]3 / 3
17520{
27520 "items": {
325022 "format": "int64",
425418 "type": "integer"
57520 },
695n/a "type": "array"
77520}
accounts[]3 / 3
16422{
26422 "items": {
325324 "format": "int64",
425522 "type": "integer"
56422 },
686n/a "type": "array"
76422}
Headers
X-Trace-Id2 / 2
116231{
216231 "format": "uuid",
3193n/a "type": "string"
416231}
Responses
codedescriptionhitsavg
200A list of tag and income details. Each tag has one row per currency.31417ms
400Bad request288ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception3017ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]tags[]
[ 1, 2, 3 ]accounts[]
Query Parameters
start2 / 2
#validinvalidschema
11511{
21511 "format": "date",
3152n/a "type": "string"
41511}
end2 / 2
11521{
21521 "format": "date",
3153n/a "type": "string"
41521}
accounts[]3 / 3
1529{
2529 "items": {
318712 "format": "int64",
418811 "type": "integer"
5529 },
661n/a "type": "array"
7529}
Headers
X-Trace-Id2 / 2
110826{
210826 "format": "uuid",
3134n/a "type": "string"
410826}
Responses
codedescriptionhitsavg
200A list of sums in different currencies.28517ms
400Bad request178ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception1317ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]accounts[]
Query Parameters
start2 / 2
#validinvalidschema
12216{
22216 "format": "date",
3227n/a "type": "string"
42216}
end2 / 2
12243{
22243 "format": "date",
3227n/a "type": "string"
42243}
accounts[]3 / 3
18424{
28424 "items": {
3290399 "format": "int64",
4291398 "type": "integer"
58424 },
6108n/a "type": "array"
78424}
Headers
X-Trace-Id2 / 2
111848{
211848 "format": "uuid",
3166n/a "type": "string"
411848}
Responses
codedescriptionhitsavg
200A list of asset accounts and transfer details. Each asset account has one row per currency.26218ms
400Bad request388ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception1217ms
Undocumented - not in spec
codedescriptionhitsavg
41411ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]accounts[]
Query Parameters
start1 / 2
#validinvalidschema
11520{
21520 "format": "date",
3152n/a "type": "string"
41520}
end2 / 2
11466{
21466 "format": "date",
3152n/a "type": "string"
41466}
categories[]3 / 3
15923{
25923 "items": {
315642 "format": "int64",
415840 "type": "integer"
55923 },
682n/a "type": "array"
75923}
accounts[]3 / 3
16915{
26915 "items": {
320226 "format": "int64",
420424 "type": "integer"
56915 },
684n/a "type": "array"
76915}
Headers
X-Trace-Id2 / 2
114942{
214942 "format": "uuid",
3191n/a "type": "string"
414942}
Responses
codedescriptionhitsavg
200A list of category and transfer details. Each category has one row per currency.26029ms
400Bad request278ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception3818ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]categories[]
[ 1, 2, 3 ]accounts[]
Query Parameters
start2 / 2
#validinvalidschema
11528{
21528 "format": "date",
3160n/a "type": "string"
41528}
end2 / 2
11564{
21564 "format": "date",
3160n/a "type": "string"
41564}
accounts[]3 / 3
15020{
25020 "items": {
314846 "format": "int64",
414945 "type": "integer"
55020 },
670n/a "type": "array"
75020}
Headers
X-Trace-Id2 / 2
115555{
215555 "format": "uuid",
3210n/a "type": "string"
415555}
Responses
codedescriptionhitsavg
200A list of transfer details. One row per currency.26817ms
400Bad request388ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception817ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]accounts[]
Query Parameters
start2 / 2
#validinvalidschema
11954{
21954 "format": "date",
3199n/a "type": "string"
41954}
end2 / 2
11963{
21963 "format": "date",
3199n/a "type": "string"
41963}
accounts[]3 / 3
17023{
27023 "items": {
323847 "format": "int64",
424144 "type": "integer"
57023 },
693n/a "type": "array"
77023}
Headers
X-Trace-Id2 / 2
110644{
210644 "format": "uuid",
3150n/a "type": "string"
410644}
Responses
codedescriptionhitsavg
200A list of transfer details. One row per currency.28117ms
400Bad request388ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception1117ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]accounts[]
Query Parameters
start2 / 2
#validinvalidschema
11818{
21818 "format": "date",
3189n/a "type": "string"
41818}
end1 / 2
11890{
21890 "format": "date",
3189n/a "type": "string"
41890}
tags[]3 / 3
16824{
26824 "items": {
3238158 "format": "int64",
4241155 "type": "integer"
56824 },
692n/a "type": "array"
76824}
accounts[]3 / 3
16822{
26822 "items": {
317974 "format": "int64",
418172 "type": "integer"
56822 },
690n/a "type": "array"
76822}
Headers
X-Trace-Id2 / 2
121636{
221636 "format": "uuid",
3252n/a "type": "string"
421636}
Responses
codedescriptionhitsavg
200A list of tag and transfer details. Each tag has one row per currency.31317ms
400Bad request308ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception2117ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]tags[]
[ 1, 2, 3 ]accounts[]
Query Parameters
start2 / 2
#validinvalidschema
12108{
22108 "format": "date",
3218n/a "type": "string"
42108}
end2 / 2
12126{
22126 "format": "date",
3218n/a "type": "string"
42126}
accounts[]3 / 3
17823{
27823 "items": {
3278570 "format": "int64",
4279569 "type": "integer"
57823 },
6101n/a "type": "array"
77823}
Headers
X-Trace-Id2 / 2
113044{
213044 "format": "uuid",
3174n/a "type": "string"
413044}
Responses
codedescriptionhitsavg
200A list of sums in different currencies.25318ms
400Bad request408ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception1618ms
Undocumented - not in spec
codedescriptionhitsavg
41462ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
[ 1, 2, 3 ]accounts[]
object_groups 6 operations 5 covered 1 partial 0 uncovered 0 not measured 95% #
Query Parameters
limit2 / 2
#validinvalidschema
120859{
220859 "format": "int32",
323037 "type": "integer"
420859}
page2 / 2
118567{
218567 "format": "int32",
321141 "type": "integer"
418567}
Headers
X-Trace-Id2 / 2
117946{
217946 "format": "uuid",
3225n/a "type": "string"
417946}
Responses
codedescriptionhitsavg
200A list of object groups49517ms
400Bad request428ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
Path Parameters
id1 / 1
#validinvalidschema
1142n/a{
2142n/a "type": "string"
3142n/a}
Headers
X-Trace-Id2 / 2
15645{
25645 "format": "uuid",
3101n/a "type": "string"
45645}
Responses
codedescriptionhitsavg
204Object group deleted.322ms
400Bad request288ms
401Unauthenticated0never seen
404Page not found11115ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK8018ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1233n/a{
2233n/a "type": "string"
3233n/a}
Headers
X-Trace-Id2 / 2
16668{
26668 "format": "uuid",
3134n/a "type": "string"
46668}
Responses
codedescriptionhitsavg
200The requested object group12218ms
400Bad request418ms
401Unauthenticated0never seen
404Page not found11015ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1462n/a{
2462n/a "type": "string"
3462n/a}
Headers
X-Trace-Id2 / 2
122338{
222338 "format": "uuid",
3261n/a "type": "string"
422338}
Body
application/json6 / 7
ObjectGroupUpdate
119220{
219313 "properties": {
31108 "order": {
41108 "format": "int32",
51126 "type": "integer"
61108 },
72005 "title": {
800 "format": "string",
92005 "type": "string"
102005 }
1119313 },
122051 "required": [
132051 "title"
142051 ],
152066 "type": "object"
1619220}
application/x-www-form-urlencoded6 / 7
ObjectGroupUpdate
11409{
21418 "properties": {
3588 "order": {
4588 "format": "int32",
5633 "type": "integer"
6588 },
71480 "title": {
800 "format": "string",
9148n/a "type": "string"
101480 }
111418 },
121481 "required": [
131481 "title"
141481 ],
15149n/a "type": "object"
161409}
Responses
codedescriptionhitsavg
200Updated object group stored, result in response9518ms
400Bad request328ms
401Unauthenticated0never seen
404Page not found34915ms
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41537ms
Examples
Body: application/json
1ObjectGroupUpdate.order
"My object group"ObjectGroupUpdate.title
Body: application/x-www-form-urlencoded
1ObjectGroupUpdate.order
"My object group"ObjectGroupUpdate.title
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1516n/a{
2516n/a "type": "string"
3516n/a}
Query Parameters
limit2 / 2
119470{
219470 "format": "int32",
320658 "type": "integer"
419470}
page2 / 2
120759{
220759 "format": "int32",
323729 "type": "integer"
420759}
Headers
X-Trace-Id2 / 2
124360{
224360 "format": "uuid",
3303n/a "type": "string"
424360}
Responses
codedescriptionhitsavg
200A list of bills.16317ms
400Bad request358ms
401Unauthenticated0never seen
404Page not found36815ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
Path Parameters
id1 / 1
#validinvalidschema
1422n/a{
2422n/a "type": "string"
3422n/a}
Query Parameters
limit2 / 2
117451{
217451 "format": "int32",
320421 "type": "integer"
417451}
page2 / 2
116553{
216553 "format": "int32",
319523 "type": "integer"
416553}
Headers
X-Trace-Id2 / 2
126046{
226046 "format": "uuid",
3306n/a "type": "string"
426046}
Responses
codedescriptionhitsavg
200A list of piggy banks20018ms
400Bad request338ms
401Unauthenticated0never seen
404Page not found27915ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
piggy_banks 8 operations 6 covered 2 partial 0 uncovered 0 not measured 57% #
Query Parameters
limit2 / 2
#validinvalidschema
121154{
221154 "format": "int32",
323233 "type": "integer"
421154}
page2 / 2
119746{
219746 "format": "int32",
321528 "type": "integer"
419746}
Headers
X-Trace-Id2 / 2
122736{
222736 "format": "uuid",
3263n/a "type": "string"
422736}
Responses
codedescriptionhitsavg
200A list of piggy banks47618ms
400Bad request298ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
Headers
X-Trace-Id2 / 2
#validinvalidschema
150551{
250551 "format": "uuid",
3556n/a "type": "string"
450551}
Body
application/json10 / 39
PiggyBankStore
1135{
2135 "properties": {
3152 "accounts": {
4152 "items": {
6152 },
7170 "type": "array"
8152 },
9170 "current_amount": {
1000 "format": "amount",
11170 "type": "string"
12170 },
13180 "name": {
1400 "format": "string",
15180 "type": "string"
16180 },
17170 "notes": {
1800 "format": "string",
1917n/a "nullable": true,
20170 "type": "string"
21170 },
22170 "object_group_id": {
2300 "format": "string",
2417n/a "nullable": true,
25170 "type": "string"
26170 },
27180 "object_group_title": {
2800 "format": "string",
2918n/a "nullable": true,
30180 "type": "string"
31180 },
32170 "order": {
33170 "format": "int32",
34170 "type": "integer"
35170 },
36162 "start_date": {
37160 "format": "date",
38162 "type": "string"
39162 },
40171 "target_amount": {
4100 "format": "amount",
4218n/a "nullable": true,
43171 "type": "string"
44171 },
45180 "target_date": {
46170 "format": "date",
4718n/a "nullable": true,
48180 "type": "string"
49180 }
50135 },
51180 "required": [
52180 "name",
53180 "account_id",
54180 "target_amount",
55180 "start_date"
56180 ],
57180 "type": "object"
58135}
Referenced Components (1)2 of 13 keywords
PiggyBankAccountStore2 of 13 keywords
102{
202 "properties": {
302 "current_amount": {
400 "format": "amount",
502 "type": "string"
602 },
720 "id": {
800 "format": "string",
92n/a "nullable": true,
1020 "type": "string"
1120 },
1220 "name": {
1300 "format": "string",
142n/a "nullable": true,
1520 "type": "string"
1620 }
1702 },
1820 "required": [
1920 "id"
2020 ],
2120 "type": "object"
2202}
application/x-www-form-urlencoded14 / 39
PiggyBankStore
117{
235 "properties": {
302 "accounts": {
402 "items": {
602 },
720 "type": "array"
802 },
930 "current_amount": {
1000 "format": "amount",
113n/a "type": "string"
1230 },
1380 "name": {
1400 "format": "string",
158n/a "type": "string"
1680 },
1740 "notes": {
1800 "format": "string",
194n/a "nullable": true,
204n/a "type": "string"
2140 },
2200 "object_group_id": {
2300 "format": "string",
240n/a "nullable": true,
250n/a "type": "string"
2600 },
2710 "object_group_title": {
2800 "format": "string",
291n/a "nullable": true,
301n/a "type": "string"
3110 },
3212 "order": {
3312 "format": "int32",
3430 "type": "integer"
3512 },
3653 "start_date": {
3753 "format": "date",
388n/a "type": "string"
3953 },
4080 "target_amount": {
4100 "format": "amount",
428n/a "nullable": true,
438n/a "type": "string"
4480 },
4500 "target_date": {
4600 "format": "date",
470n/a "nullable": true,
480n/a "type": "string"
4900 }
5035 },
5144 "required": [
5280 "name",
5344 "account_id",
5480 "target_amount",
5580 "start_date"
5644 ],
578n/a "type": "object"
5817}
Referenced Components (1)0 of 13 keywords
PiggyBankAccountStore0 of 13 keywords
1056{
200 "properties": {
300 "current_amount": {
400 "format": "amount",
500 "type": "string"
600 },
700 "id": {
800 "format": "string",
90n/a "nullable": true,
1000 "type": "string"
1100 },
1200 "name": {
1300 "format": "string",
140n/a "nullable": true,
1500 "type": "string"
1600 }
1700 },
1800 "required": [
1900 "id"
2000 ],
21056 "type": "object"
22056}
Responses
codedescriptionhitsavg
200New piggy bank stored, result in response.85716ms
400Bad request218ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception519ms
Undocumented - not in spec
codedescriptionhitsavg
41517ms
Examples
Body: application/json
"123.45"PiggyBankAccountStore.current_amount
"3"PiggyBankAccountStore.id
"Checking account"PiggyBankAccountStore.name
"123.45"PiggyBankStore.current_amount
"New digital camera"PiggyBankStore.name
"Some notes"PiggyBankStore.notes
"5"PiggyBankStore.object_group_id
"Example Group"PiggyBankStore.object_group_title
5PiggyBankStore.order
"2026-10-01"PiggyBankStore.start_date
"123.45"PiggyBankStore.target_amount
"2026-10-31"PiggyBankStore.target_date
Body: application/x-www-form-urlencoded
"123.45"PiggyBankAccountStore.current_amount
"3"PiggyBankAccountStore.id
"Checking account"PiggyBankAccountStore.name
"123.45"PiggyBankStore.current_amount
"New digital camera"PiggyBankStore.name
"Some notes"PiggyBankStore.notes
"5"PiggyBankStore.object_group_id
"Example Group"PiggyBankStore.object_group_title
5PiggyBankStore.order
"2026-10-01"PiggyBankStore.start_date
"123.45"PiggyBankStore.target_amount
"2026-10-31"PiggyBankStore.target_date
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path Parameters
id1 / 1
#validinvalidschema
196n/a{
296n/a "type": "string"
396n/a}
Headers
X-Trace-Id2 / 2
12640{
22640 "format": "uuid",
366n/a "type": "string"
42640}
Responses
codedescriptionhitsavg
204Piggy bank deleted.0never seen
400Bad request288ms
401Unauthenticated0never seen
404Page not found6815ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK920ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1292n/a{
2292n/a "type": "string"
3292n/a}
Headers
X-Trace-Id2 / 2
111055{
211055 "format": "uuid",
3165n/a "type": "string"
411055}
Responses
codedescriptionhitsavg
200The requested piggy bank10618ms
400Bad request398ms
401Unauthenticated0never seen
404Page not found25115ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1560n/a{
2560n/a "type": "string"
3560n/a}
Headers
X-Trace-Id2 / 2
130841{
230841 "format": "uuid",
3349n/a "type": "string"
430841}
Body
application/json29 / 37
PiggyBankUpdate
118479{
212173 "properties": {
312325 "accounts": {
412318 "items": {
612318 },
71417 "type": "array"
812325 },
91545 "name": {
1000 "format": "string",
111545 "type": "string"
121545 },
131506 "notes": {
1400 "format": "string",
15156n/a "nullable": true,
161506 "type": "string"
171506 },
181576 "object_group_id": {
1900 "format": "string",
20163n/a "nullable": true,
211576 "type": "string"
221576 },
231404 "object_group_title": {
2400 "format": "string",
25144n/a "nullable": true,
261404 "type": "string"
271404 },
281478 "order": {
291478 "format": "int32",
301496 "type": "integer"
311478 },
3214411 "start_date": {
331446 "format": "date",
341505 "type": "string"
3514411 },
361394 "target_amount": {
3700 "format": "amount",
38143n/a "nullable": true,
391394 "type": "string"
401394 },
411306 "target_date": {
421292 "format": "date",
43136n/a "nullable": true,
441324 "type": "string"
451306 }
4612173 },
472576 "type": "object"
4818479}
Referenced Components (1)11 of 14 keywords
PiggyBankAccountUpdate11 of 14 keywords
14018{
22412 "properties": {
3294 "account_id": {
400 "format": "string",
533n/a "nullable": true,
6294 "type": "string"
7294 },
8304 "current_amount": {
900 "format": "amount",
1034n/a "nullable": true,
11304 "type": "string"
12304 },
13284 "name": {
1400 "format": "string",
1532n/a "nullable": true,
16284 "type": "string"
17284 }
182412 },
19521 "required": [
20521 "id"
21521 ],
22535 "type": "object"
234018}
application/x-www-form-urlencoded18 / 37
PiggyBankUpdate
18842{
26242 "properties": {
3027 "accounts": {
4027 "items": {
6027 },
7270 "type": "array"
8027 },
9760 "name": {
1000 "format": "string",
1176n/a "type": "string"
12760 },
13700 "notes": {
1400 "format": "string",
1570n/a "nullable": true,
1670n/a "type": "string"
17700 },
18710 "object_group_id": {
1900 "format": "string",
2071n/a "nullable": true,
2171n/a "type": "string"
22710 },
23700 "object_group_title": {
2400 "format": "string",
2570n/a "nullable": true,
2670n/a "type": "string"
27700 },
28676 "order": {
29676 "format": "int32",
30703 "type": "integer"
31676 },
32692 "start_date": {
33692 "format": "date",
3471n/a "type": "string"
35692 },
36700 "target_amount": {
3700 "format": "amount",
3870n/a "nullable": true,
3970n/a "type": "string"
40700 },
415714 "target_date": {
425714 "format": "date",
4371n/a "nullable": true,
4471n/a "type": "string"
455714 }
466242 },
47130n/a "type": "object"
488842}
Referenced Components (1)0 of 14 keywords
PiggyBankAccountUpdate0 of 14 keywords
10526{
200 "properties": {
300 "account_id": {
400 "format": "string",
50n/a "nullable": true,
600 "type": "string"
700 },
800 "current_amount": {
900 "format": "amount",
100n/a "nullable": true,
1100 "type": "string"
1200 },
1300 "name": {
1400 "format": "string",
150n/a "nullable": true,
1600 "type": "string"
1700 }
1800 },
1900 "required": [
2000 "id"
2100 ],
220526 "type": "object"
230526}
Responses
codedescriptionhitsavg
200Updated piggy bank stored, result in response416ms
400Bad request278ms
401Unauthenticated0never seen
404Page not found53015ms
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41537ms
Examples
Body: application/json
"3"PiggyBankAccountUpdate.account_id
"123.45"PiggyBankAccountUpdate.current_amount
"Checking account"PiggyBankAccountUpdate.name
"New digital camera"PiggyBankUpdate.name
"Some notes"PiggyBankUpdate.notes
"5"PiggyBankUpdate.object_group_id
"Example Group"PiggyBankUpdate.object_group_title
5PiggyBankUpdate.order
"2026-10-01"PiggyBankUpdate.start_date
"123.45"PiggyBankUpdate.target_amount
"2026-10-31"PiggyBankUpdate.target_date
Body: application/x-www-form-urlencoded
"3"PiggyBankAccountUpdate.account_id
"123.45"PiggyBankAccountUpdate.current_amount
"Checking account"PiggyBankAccountUpdate.name
"New digital camera"PiggyBankUpdate.name
"Some notes"PiggyBankUpdate.notes
"5"PiggyBankUpdate.object_group_id
"Example Group"PiggyBankUpdate.object_group_title
5PiggyBankUpdate.order
"2026-10-01"PiggyBankUpdate.start_date
"123.45"PiggyBankUpdate.target_amount
"2026-10-31"PiggyBankUpdate.target_date
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1396n/a{
2396n/a "type": "string"
3396n/a}
Query Parameters
limit2 / 2
118143{
218143 "format": "int32",
319232 "type": "integer"
418143}
page2 / 2
116941{
216941 "format": "int32",
319416 "type": "integer"
416941}
Headers
X-Trace-Id2 / 2
118633{
218633 "format": "uuid",
3219n/a "type": "string"
418633}
Responses
codedescriptionhitsavg
200A list of accounts5517ms
400Bad request308ms
401Unauthenticated0never seen
404Page not found36415ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
Path Parameters
id1 / 1
#validinvalidschema
1498n/a{
2498n/a "type": "string"
3498n/a}
Query Parameters
limit2 / 2
120854{
220854 "format": "int32",
322636 "type": "integer"
420854}
page2 / 2
121652{
221652 "format": "int32",
323929 "type": "integer"
421652}
Headers
X-Trace-Id2 / 2
122630{
222630 "format": "uuid",
3256n/a "type": "string"
422630}
Responses
codedescriptionhitsavg
200A list of attachments517ms
400Bad request228ms
401Unauthenticated0never seen
404Page not found47415ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
Path Parameters
id1 / 1
#validinvalidschema
1401n/a{
2401n/a "type": "string"
3401n/a}
Query Parameters
limit2 / 2
117040{
217040 "format": "int32",
318822 "type": "integer"
417040}
page2 / 2
118043{
218043 "format": "int32",
319825 "type": "integer"
418043}
Headers
X-Trace-Id2 / 2
126028{
226028 "format": "uuid",
3288n/a "type": "string"
426028}
Responses
codedescriptionhitsavg
200A list of piggy bank related events5316ms
400Bad request218ms
401Unauthenticated0never seen
404Page not found37815ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
preferences 4 operations 1 covered 3 partial 0 uncovered 0 not measured 69% #
Query Parameters
limit2 / 2
#validinvalidschema
121744{
221744 "format": "int32",
322635 "type": "integer"
421744}
page2 / 2
121344{
221344 "format": "int32",
323225 "type": "integer"
421344}
Headers
X-Trace-Id2 / 2
121245{
221245 "format": "uuid",
3257n/a "type": "string"
421245}
Responses
codedescriptionhitsavg
200A list of preferences.50717ms
400Bad request428ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
Headers
X-Trace-Id2 / 2
#validinvalidschema
118244{
218244 "format": "uuid",
3226n/a "type": "string"
418244}
Body
application/json10 / 14
Preference
18910{
28910 "properties": {
3918 "data": {
5918 },
6972 "name": {
700 "format": "string",
8972 "type": "string"
9972 }
108910 },
11990 "required": [
12990 "name",
13990 "data"
14990 ],
15990 "type": "object"
168910}
Referenced Components (2)8 of 9 keywords
PolymorphicProperty7 of 7 keywords
1918{
2918 "oneOf": [
35346 {
45346 "type": "boolean"
55346 },
63069 {
73069 "type": "string"
83069 },
9495 {
10495 "type": "object"
11495 },
12495 {
1346 "items": {
1546 },
161089 "type": "array"
17495 }
18918 ]
19918}
StringArrayItem1 of 2 keywords
1127{
200 "format": "string",
3127 "type": "string"
4127}
application/x-www-form-urlencoded7 / 14
Preference
1541{
2550 "properties": {
354n/a "data": {
554n/a },
6550 "name": {
700 "format": "string",
855n/a "type": "string"
9550 }
10550 },
11541 "required": [
12550 "name",
13541 "data"
14541 ],
1555n/a "type": "object"
16541}
Referenced Components (2)4 of 9 keywords
PolymorphicProperty4 of 7 keywords
154n/a{
254n/a "oneOf": [
32925 {
42925 "type": "boolean"
52925 },
625n/a {
725n/a "type": "string"
825n/a },
9054 {
10054 "type": "object"
11054 },
12054 {
1300 "items": {
1500 },
16054 "type": "array"
17054 }
1854n/a ]
1954n/a}
StringArrayItem0 of 2 keywords
100{
200 "format": "string",
30n/a "type": "string"
400}
Responses
codedescriptionhitsavg
200New account stored, result in response.29518ms
400Bad request258ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception4516ms
Undocumented - not in spec
codedescriptionhitsavg
41538ms
Examples
Body: application/json
"EUR"StringArrayItem
"currencyPreference"Preference.name
Body: application/x-www-form-urlencoded
"EUR"StringArrayItem
"currencyPreference"Preference.name
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path Parameters
name1 / 2
#validinvalidschema
13870{
200 "format": "string",
3387n/a "type": "string"
43870}
Headers
X-Trace-Id2 / 2
114943{
214943 "format": "uuid",
3192n/a "type": "string"
414943}
Responses
codedescriptionhitsavg
200A single preference.32016ms
400Bad request298ms
401Unauthenticated0never seen
404Page not found2816ms
500Internal exception1318ms
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden10ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"currencyPreference"name
Path Parameters
name1 / 2
#validinvalidschema
12690{
200 "format": "string",
3269n/a "type": "string"
42690}
Headers
X-Trace-Id2 / 2
119822{
219822 "format": "uuid",
3220n/a "type": "string"
419822}
Body
application/json9 / 12
PreferenceUpdate
115310{
215310 "properties": {
315310 "data": {
515310 }
615310 },
71630 "required": [
81630 "data"
91630 ],
101630 "type": "object"
1115310}
Referenced Components (2)8 of 9 keywords
PolymorphicProperty7 of 7 keywords
115310{
215310 "oneOf": [
341122 {
441122 "type": "boolean"
541122 },
69370 {
79370 "type": "string"
89370 },
96157 {
106157 "type": "object"
116157 },
1213150 {
13131 "items": {
15131 },
1614149 "type": "array"
1713150 }
1815310 ]
1915310}
StringArrayItem1 of 2 keywords
1543{
200 "format": "string",
3543 "type": "string"
4543}
application/x-www-form-urlencoded7 / 12
PreferenceUpdate
11004{
2100n/a "properties": {
3100n/a "data": {
5100n/a }
6100n/a },
71004 "required": [
81004 "data"
91004 ],
10104n/a "type": "object"
111004}
Referenced Components (2)4 of 9 keywords
PolymorphicProperty4 of 7 keywords
1100n/a{
2100n/a "oneOf": [
33169 {
43169 "type": "boolean"
53169 },
669n/a {
769n/a "type": "string"
869n/a },
90100 {
100100 "type": "object"
110100 },
120100 {
1300 "items": {
1500 },
160100 "type": "array"
170100 }
18100n/a ]
19100n/a}
StringArrayItem0 of 2 keywords
100{
200 "format": "string",
30n/a "type": "string"
400}
Responses
codedescriptionhitsavg
200Updated preference.25018ms
400Bad request178ms
401Unauthenticated0never seen
404Page not found615ms
422Validation error. The body will have the exact details.0never seen
500Internal exception3917ms
Undocumented - not in spec
codedescriptionhitsavg
41537ms
405Method Not Allowed29ms
403Forbidden70ms
Examples
Body: application/json
"EUR"StringArrayItem
Body: application/x-www-form-urlencoded
"EUR"StringArrayItem
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"currencyPreference"name
recurrences 7 operations 5 covered 2 partial 0 uncovered 0 not measured 39% #
Query Parameters
limit2 / 2
#validinvalidschema
121364{
221364 "format": "int32",
324334 "type": "integer"
421364}
page2 / 2
120664{
220664 "format": "int32",
322743 "type": "integer"
420664}
Headers
X-Trace-Id2 / 2
122936{
222936 "format": "uuid",
3265n/a "type": "string"
422936}
Responses
codedescriptionhitsavg
200A list of recurring transactions.49218ms
400Bad request318ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
Headers
X-Trace-Id2 / 2
#validinvalidschema
148249{
248249 "format": "uuid",
3531n/a "type": "string"
448249}
Body
application/json14 / 79
RecurrenceStore
1218{
2218 "properties": {
3260 "active": {
4260 "type": "boolean"
5260 },
6210 "apply_rules": {
7210 "type": "boolean"
8210 },
9220 "description": {
1000 "format": "string",
11220 "type": "string"
12220 },
13290 "first_date": {
14290 "format": "date",
15290 "type": "string"
16290 },
17200 "notes": {
1800 "format": "string",
1920n/a "nullable": true,
20200 "type": "string"
21200 },
22148 "nr_of_repetitions": {
23148 "format": "int32",
2422n/a "nullable": true,
25220 "type": "integer"
26148 },
27290 "repeat_until": {
28270 "format": "date",
2929n/a "nullable": true,
30290 "type": "string"
31290 },
32290 "repetitions": {
33290 "items": {
35290 },
36290 "type": "array"
37290 },
38290 "title": {
3900 "format": "string",
40290 "type": "string"
41290 },
42281 "transactions": {
43281 "items": {
45281 },
46290 "type": "array"
47281 },
48290 "type": {
50290 }
51218 },
52290 "required": [
53290 "type",
54290 "title",
55290 "first_date",
56290 "repeat_until",
57290 "repetitions",
58290 "transactions"
59290 ],
60290 "type": "object"
61218}
Referenced Components (4)9 of 60 keywords
RecurrenceRepetitionStore0 of 12 keywords
1690{
2690 "properties": {
3690 "moment": {
400 "format": "string",
5690 "type": "string"
6690 },
7290 "skip": {
8290 "format": "int32",
9290 "type": "integer"
10290 },
11690 "type": {
13690 },
14240 "weekend": {
15240 "format": "int32",
16240 "type": "integer"
17240 }
18690 },
19690 "required": [
20690 "type",
21690 "moment"
22690 ],
23690 "type": "object"
24690}
RecurrenceRepetitionType0 of 4 keywords
1690{
2690 "enum": [
38n/a "daily",
413n/a "weekly",
512n/a "ndom",
626n/a "monthly",
710n/a "yearly"
8690 ],
900 "format": "string",
10690 "type": "string"
11690}
RecurrenceTransactionStore9 of 40 keywords
11363{
21363 "properties": {
31390 "amount": {
400 "format": "amount",
51390 "type": "string"
61390 },
7490 "bill_id": {
800 "format": "string",
949n/a "nullable": true,
10490 "type": "string"
11490 },
12540 "budget_id": {
1300 "format": "string",
14540 "type": "string"
15540 },
16640 "category_id": {
1700 "format": "string",
18640 "type": "string"
19640 },
20660 "currency_code": {
2100 "format": "string",
22660 "type": "string"
23660 },
24550 "currency_id": {
2500 "format": "string",
26550 "type": "string"
27550 },
281390 "description": {
2900 "format": "string",
301390 "type": "string"
311390 },
321390 "destination_id": {
3300 "format": "string",
341390 "type": "string"
351390 },
36620 "foreign_amount": {
3700 "format": "amount",
3862n/a "nullable": true,
39620 "type": "string"
40620 },
41600 "foreign_currency_code": {
4200 "format": "string",
4360n/a "nullable": true,
44600 "type": "string"
45600 },
46490 "foreign_currency_id": {
4700 "format": "string",
4849n/a "nullable": true,
49490 "type": "string"
50490 },
51523 "piggy_bank_id": {
5200 "format": "string",
5355n/a "nullable": true,
54523 "type": "string"
55523 },
561390 "source_id": {
5700 "format": "string",
581390 "type": "string"
591390 },
60630 "tags": {
61220 "items": {
6200 "format": "string",
63610 "type": "string"
64220 },
6563n/a "nullable": true,
66630 "type": "array"
67630 }
681363 },
691390 "required": [
701390 "description",
711390 "amount",
721390 "source_id",
731390 "destination_id"
741390 ],
751390 "type": "object"
761363}
RecurrenceTransactionType0 of 4 keywords
1290{
2290 "enum": [
313n/a "withdrawal",
47n/a "transfer",
59n/a "deposit"
6290 ],
700 "format": "string",
8290 "type": "string"
9290}
application/x-www-form-urlencoded14 / 79
RecurrenceStore
1041{
2041 "properties": {
3240 "active": {
4240 "type": "boolean"
5240 },
6200 "apply_rules": {
7200 "type": "boolean"
8200 },
9190 "description": {
1000 "format": "string",
1119n/a "type": "string"
12190 },
13410 "first_date": {
14410 "format": "date",
1541n/a "type": "string"
16410 },
17230 "notes": {
1800 "format": "string",
1923n/a "nullable": true,
2023n/a "type": "string"
21230 },
221310 "nr_of_repetitions": {
231310 "format": "int32",
2423n/a "nullable": true,
251310 "type": "integer"
261310 },
27635 "repeat_until": {
28635 "format": "date",
2941n/a "nullable": true,
3041n/a "type": "string"
31635 },
32035 "repetitions": {
33035 "items": {
35035 },
36350 "type": "array"
37035 },
38410 "title": {
3900 "format": "string",
4041n/a "type": "string"
41410 },
42029 "transactions": {
43029 "items": {
45029 },
46290 "type": "array"
47029 },
48410 "type": {
50410 }
51041 },
522714 "required": [
53410 "type",
54410 "title",
55410 "first_date",
56410 "repeat_until",
57356 "repetitions",
582912 "transactions"
592714 ],
6041n/a "type": "object"
61041}
Referenced Components (4)1 of 60 keywords
RecurrenceRepetitionStore0 of 12 keywords
10736{
200 "properties": {
300 "moment": {
400 "format": "string",
500 "type": "string"
600 },
700 "skip": {
800 "format": "int32",
900 "type": "integer"
1000 },
1100 "type": {
1300 },
1400 "weekend": {
1500 "format": "int32",
1600 "type": "integer"
1700 }
1800 },
1900 "required": [
2000 "type",
2100 "moment"
2200 ],
230736 "type": "object"
240736}
RecurrenceRepetitionType0 of 4 keywords
100{
200 "enum": [
30n/a "daily",
40n/a "weekly",
50n/a "ndom",
60n/a "monthly",
70n/a "yearly"
800 ],
900 "format": "string",
1000 "type": "string"
1100}
RecurrenceTransactionStore0 of 40 keywords
102670{
200 "properties": {
300 "amount": {
400 "format": "amount",
500 "type": "string"
600 },
700 "bill_id": {
800 "format": "string",
90n/a "nullable": true,
1000 "type": "string"
1100 },
1200 "budget_id": {
1300 "format": "string",
1400 "type": "string"
1500 },
1600 "category_id": {
1700 "format": "string",
1800 "type": "string"
1900 },
2000 "currency_code": {
2100 "format": "string",
2200 "type": "string"
2300 },
2400 "currency_id": {
2500 "format": "string",
2600 "type": "string"
2700 },
2800 "description": {
2900 "format": "string",
3000 "type": "string"
3100 },
3200 "destination_id": {
3300 "format": "string",
3400 "type": "string"
3500 },
3600 "foreign_amount": {
3700 "format": "amount",
380n/a "nullable": true,
3900 "type": "string"
4000 },
4100 "foreign_currency_code": {
4200 "format": "string",
430n/a "nullable": true,
4400 "type": "string"
4500 },
4600 "foreign_currency_id": {
4700 "format": "string",
480n/a "nullable": true,
4900 "type": "string"
5000 },
5100 "piggy_bank_id": {
5200 "format": "string",
530n/a "nullable": true,
5400 "type": "string"
5500 },
5600 "source_id": {
5700 "format": "string",
5800 "type": "string"
5900 },
6000 "tags": {
6100 "items": {
6200 "format": "string",
6300 "type": "string"
6400 },
650n/a "nullable": true,
6600 "type": "array"
6700 }
6800 },
6900 "required": [
7000 "description",
7100 "amount",
7200 "source_id",
7300 "destination_id"
7400 ],
7502670 "type": "object"
7602670}
RecurrenceTransactionType1 of 4 keywords
1410{
2410 "enum": [
321n/a "withdrawal",
413n/a "transfer",
57n/a "deposit"
6410 ],
700 "format": "string",
841n/a "type": "string"
9410}
Responses
codedescriptionhitsavg
200New recurring transaction stored, result in response.65017ms
400Bad request218ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception4920ms
Undocumented - not in spec
codedescriptionhitsavg
41517ms
Examples
Body: application/json
trueRecurrenceStore.active
trueRecurrenceStore.apply_rules
"Recurring transaction for the monthly rent"RecurrenceStore.description
"2026-10-31"RecurrenceStore.first_date
"Some notes"RecurrenceStore.notes
5RecurrenceStore.nr_of_repetitions
"2026-10-31"RecurrenceStore.repeat_until
"3"RecurrenceRepetitionStore.moment
0RecurrenceRepetitionStore.skip
"weekly"RecurrenceRepetitionType
1RecurrenceRepetitionStore.weekend
"Rent"RecurrenceStore.title
"123.45"RecurrenceTransactionStore.amount
"123"RecurrenceTransactionStore.bill_id
"4"RecurrenceTransactionStore.budget_id
"211"RecurrenceTransactionStore.category_id
"EUR"RecurrenceTransactionStore.currency_code
"3"RecurrenceTransactionStore.currency_id
"Rent for the current month"RecurrenceTransactionStore.description
"258"RecurrenceTransactionStore.destination_id
"123.45"RecurrenceTransactionStore.foreign_amount
"GBP"RecurrenceTransactionStore.foreign_currency_code
"17"RecurrenceTransactionStore.foreign_currency_id
"123"RecurrenceTransactionStore.piggy_bank_id
"913"RecurrenceTransactionStore.source_id
nullRecurrenceTransactionStore.tags
"Barbecue preparation"RecurrenceTransactionStore.tags
"withdrawal"RecurrenceTransactionType
Body: application/x-www-form-urlencoded
trueRecurrenceStore.active
trueRecurrenceStore.apply_rules
"Recurring transaction for the monthly rent"RecurrenceStore.description
"2026-10-31"RecurrenceStore.first_date
"Some notes"RecurrenceStore.notes
5RecurrenceStore.nr_of_repetitions
"2026-10-31"RecurrenceStore.repeat_until
"3"RecurrenceRepetitionStore.moment
0RecurrenceRepetitionStore.skip
"weekly"RecurrenceRepetitionType
1RecurrenceRepetitionStore.weekend
"Rent"RecurrenceStore.title
"123.45"RecurrenceTransactionStore.amount
"123"RecurrenceTransactionStore.bill_id
"4"RecurrenceTransactionStore.budget_id
"211"RecurrenceTransactionStore.category_id
"EUR"RecurrenceTransactionStore.currency_code
"3"RecurrenceTransactionStore.currency_id
"Rent for the current month"RecurrenceTransactionStore.description
"258"RecurrenceTransactionStore.destination_id
"123.45"RecurrenceTransactionStore.foreign_amount
"GBP"RecurrenceTransactionStore.foreign_currency_code
"17"RecurrenceTransactionStore.foreign_currency_id
"123"RecurrenceTransactionStore.piggy_bank_id
"913"RecurrenceTransactionStore.source_id
nullRecurrenceTransactionStore.tags
"Barbecue preparation"RecurrenceTransactionStore.tags
"withdrawal"RecurrenceTransactionType
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path Parameters
id1 / 1
#validinvalidschema
186n/a{
286n/a "type": "string"
386n/a}
Headers
X-Trace-Id2 / 2
16737{
26737 "format": "uuid",
3104n/a "type": "string"
46737}
Responses
codedescriptionhitsavg
204Recurring transaction deleted.0never seen
400Bad request218ms
401Unauthenticated0never seen
404Page not found6514ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK5016ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1312n/a{
2312n/a "type": "string"
3312n/a}
Headers
X-Trace-Id2 / 2
111755{
211755 "format": "uuid",
3172n/a "type": "string"
411755}
Responses
codedescriptionhitsavg
200The requested recurring transaction5717ms
400Bad request318ms
401Unauthenticated0never seen
404Page not found27914ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1704n/a{
2704n/a "type": "string"
3704n/a}
Headers
X-Trace-Id2 / 2
152554{
252554 "format": "uuid",
3579n/a "type": "string"
452554}
Body
application/json53 / 72
RecurrenceUpdate
1208217{
2168209 "properties": {
33145 "active": {
43145 "type": "boolean"
53145 },
63015 "apply_rules": {
73015 "type": "boolean"
83015 },
93045 "description": {
1000 "format": "string",
113045 "type": "string"
123045 },
1330518 "first_date": {
1430513 "format": "date",
153185 "type": "string"
1630518 },
173095 "notes": {
1800 "format": "string",
19314n/a "nullable": true,
203095 "type": "string"
213095 },
2226639 "nr_of_repetitions": {
2326639 "format": "int32",
24305n/a "nullable": true,
253005 "type": "integer"
2626639 },
273096 "repeat_until": {
282912 "format": "date",
29315n/a "nullable": true,
303114 "type": "string"
313096 },
3226741 "repetitions": {
3326733 "items": {
3526733 },
363008 "type": "array"
3726741 },
383176 "title": {
3900 "format": "string",
403176 "type": "string"
413176 },
4221985 "transactions": {
4321980 "items": {
4521980 },
462995 "type": "array"
4721985 }
48168209 },
494178 "type": "object"
50208217}
Referenced Components (3)37 of 53 keywords
RecurrenceRepetitionType3 of 4 keywords
11796{
21796 "enum": [
333n/a "daily",
455n/a "weekly",
533n/a "ndom",
633n/a "monthly",
725n/a "yearly"
81796 ],
900 "format": "string",
101805 "type": "string"
111796}
RecurrenceRepetitionUpdate9 of 10 keywords
132333{
222328 "properties": {
31875 "moment": {
400 "format": "string",
51875 "type": "string"
61875 },
71818 "skip": {
81818 "format": "int32",
91836 "type": "integer"
101818 },
111796 "type": {
131796 },
141769 "weekend": {
151769 "format": "int32",
161796 "type": "integer"
171769 }
1822328 },
193515 "type": "object"
2032333}
RecurrenceTransactionUpdate25 of 39 keywords
136094{
236188 "properties": {
32329 "amount": {
400 "format": "amount",
52329 "type": "string"
62329 },
72484 "bill_id": {
800 "format": "string",
9252n/a "nullable": true,
102484 "type": "string"
112484 },
122125 "budget_id": {
1300 "format": "string",
142125 "type": "string"
152125 },
162345 "category_id": {
1700 "format": "string",
182345 "type": "string"
192345 },
202175 "currency_code": {
2100 "format": "string",
222175 "type": "string"
232175 },
242355 "currency_id": {
2500 "format": "string",
262355 "type": "string"
272355 },
282225 "description": {
2900 "format": "string",
302225 "type": "string"
312225 },
322235 "destination_id": {
3300 "format": "string",
342235 "type": "string"
352235 },
362144 "foreign_amount": {
3700 "format": "amount",
38218n/a "nullable": true,
392144 "type": "string"
402144 },
412234 "foreign_currency_id": {
4200 "format": "string",
43227n/a "nullable": true,
442234 "type": "string"
452234 },
464435 "id": {
4700 "format": "string",
484435 "type": "string"
494435 },
5021817 "piggy_bank_id": {
5100 "format": "string",
52235n/a "nullable": true,
5321817 "type": "string"
5421817 },
552285 "source_id": {
5600 "format": "string",
572285 "type": "string"
582285 },
5919023 "tags": {
601446 "items": {
6100 "format": "string",
623427 "type": "string"
631446 },
64213n/a "nullable": true,
6519617 "type": "array"
6619023 }
6736188 },
684481 "required": [
694481 "id"
704481 ],
714495 "type": "object"
7236094}
application/x-www-form-urlencoded16 / 72
RecurrenceUpdate
186171{
271171 "properties": {
31792 "active": {
41792 "type": "boolean"
51792 },
61712 "apply_rules": {
71712 "type": "boolean"
81712 },
91990 "description": {
1000 "format": "string",
11199n/a "type": "string"
121990 },
131553 "first_date": {
141553 "format": "date",
15158n/a "type": "string"
161553 },
171640 "notes": {
1800 "format": "string",
19164n/a "nullable": true,
20164n/a "type": "string"
211640 },
2213053 "nr_of_repetitions": {
2313053 "format": "int32",
24183n/a "nullable": true,
2513251 "type": "integer"
2613053 },
2714824 "repeat_until": {
2814824 "format": "date",
29172n/a "nullable": true,
30172n/a "type": "string"
3114824 },
32079 "repetitions": {
33079 "items": {
35079 },
36790 "type": "array"
37079 },
381760 "title": {
3900 "format": "string",
40176n/a "type": "string"
411760 },
42092 "transactions": {
43092 "items": {
45092 },
46920 "type": "array"
47092 }
4871171 },
49257n/a "type": "object"
5086171}
Referenced Components (3)0 of 53 keywords
RecurrenceRepetitionType0 of 4 keywords
100{
200 "enum": [
30n/a "daily",
40n/a "weekly",
50n/a "ndom",
60n/a "monthly",
70n/a "yearly"
800 ],
900 "format": "string",
1000 "type": "string"
1100}
RecurrenceRepetitionUpdate0 of 10 keywords
101224{
200 "properties": {
300 "moment": {
400 "format": "string",
500 "type": "string"
600 },
700 "skip": {
800 "format": "int32",
900 "type": "integer"
1000 },
1100 "type": {
1300 },
1400 "weekend": {
1500 "format": "int32",
1600 "type": "integer"
1700 }
1800 },
1901224 "type": "object"
2001224}
RecurrenceTransactionUpdate0 of 39 keywords
102142{
200 "properties": {
300 "amount": {
400 "format": "amount",
500 "type": "string"
600 },
700 "bill_id": {
800 "format": "string",
90n/a "nullable": true,
1000 "type": "string"
1100 },
1200 "budget_id": {
1300 "format": "string",
1400 "type": "string"
1500 },
1600 "category_id": {
1700 "format": "string",
1800 "type": "string"
1900 },
2000 "currency_code": {
2100 "format": "string",
2200 "type": "string"
2300 },
2400 "currency_id": {
2500 "format": "string",
2600 "type": "string"
2700 },
2800 "description": {
2900 "format": "string",
3000 "type": "string"
3100 },
3200 "destination_id": {
3300 "format": "string",
3400 "type": "string"
3500 },
3600 "foreign_amount": {
3700 "format": "amount",
380n/a "nullable": true,
3900 "type": "string"
4000 },
4100 "foreign_currency_id": {
4200 "format": "string",
430n/a "nullable": true,
4400 "type": "string"
4500 },
4600 "id": {
4700 "format": "string",
4800 "type": "string"
4900 },
5000 "piggy_bank_id": {
5100 "format": "string",
520n/a "nullable": true,
5300 "type": "string"
5400 },
5500 "source_id": {
5600 "format": "string",
5700 "type": "string"
5800 },
5900 "tags": {
6000 "items": {
6100 "format": "string",
6200 "type": "string"
6300 },
640n/a "nullable": true,
6500 "type": "array"
6600 }
6700 },
6800 "required": [
6900 "id"
7000 ],
7102142 "type": "object"
7202142}
Responses
codedescriptionhitsavg
200Updated recurring transaction stored, result in response11217ms
400Bad request448ms
401Unauthenticated0never seen
404Page not found65614ms
422Validation error. The body will have the exact details.0never seen
500Internal exception118ms
Undocumented - not in spec
codedescriptionhitsavg
41538ms
Examples
Body: application/json
trueRecurrenceUpdate.active
trueRecurrenceUpdate.apply_rules
"Recurring transaction for the monthly rent"RecurrenceUpdate.description
"2026-10-31"RecurrenceUpdate.first_date
"Some notes"RecurrenceUpdate.notes
5RecurrenceUpdate.nr_of_repetitions
"2026-10-31"RecurrenceUpdate.repeat_until
"3"RecurrenceRepetitionUpdate.moment
0RecurrenceRepetitionUpdate.skip
"weekly"RecurrenceRepetitionType
1RecurrenceRepetitionUpdate.weekend
"Rent"RecurrenceUpdate.title
"123.45"RecurrenceTransactionUpdate.amount
"123"RecurrenceTransactionUpdate.bill_id
"4"RecurrenceTransactionUpdate.budget_id
"211"RecurrenceTransactionUpdate.category_id
"EUR"RecurrenceTransactionUpdate.currency_code
"3"RecurrenceTransactionUpdate.currency_id
"Rent for the current month"RecurrenceTransactionUpdate.description
"258"RecurrenceTransactionUpdate.destination_id
"123.45"RecurrenceTransactionUpdate.foreign_amount
"17"RecurrenceTransactionUpdate.foreign_currency_id
"ID of the recurring transaction. Not to be confused with the ID of the recurrence itself. Is marked as REQUIRED but can be skipped when there is only ONE transaction."RecurrenceTransactionUpdate.id
"123"RecurrenceTransactionUpdate.piggy_bank_id
"913"RecurrenceTransactionUpdate.source_id
nullRecurrenceTransactionUpdate.tags
"Barbecue preparation"RecurrenceTransactionUpdate.tags
Body: application/x-www-form-urlencoded
trueRecurrenceUpdate.active
trueRecurrenceUpdate.apply_rules
"Recurring transaction for the monthly rent"RecurrenceUpdate.description
"2026-10-31"RecurrenceUpdate.first_date
"Some notes"RecurrenceUpdate.notes
5RecurrenceUpdate.nr_of_repetitions
"2026-10-31"RecurrenceUpdate.repeat_until
"3"RecurrenceRepetitionUpdate.moment
0RecurrenceRepetitionUpdate.skip
"weekly"RecurrenceRepetitionType
1RecurrenceRepetitionUpdate.weekend
"Rent"RecurrenceUpdate.title
"123.45"RecurrenceTransactionUpdate.amount
"123"RecurrenceTransactionUpdate.bill_id
"4"RecurrenceTransactionUpdate.budget_id
"211"RecurrenceTransactionUpdate.category_id
"EUR"RecurrenceTransactionUpdate.currency_code
"3"RecurrenceTransactionUpdate.currency_id
"Rent for the current month"RecurrenceTransactionUpdate.description
"258"RecurrenceTransactionUpdate.destination_id
"123.45"RecurrenceTransactionUpdate.foreign_amount
"17"RecurrenceTransactionUpdate.foreign_currency_id
"ID of the recurring transaction. Not to be confused with the ID of the recurrence itself. Is marked as REQUIRED but can be skipped when there is only ONE transaction."RecurrenceTransactionUpdate.id
"123"RecurrenceTransactionUpdate.piggy_bank_id
"913"RecurrenceTransactionUpdate.source_id
nullRecurrenceTransactionUpdate.tags
"Barbecue preparation"RecurrenceTransactionUpdate.tags
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1484n/a{
2484n/a "type": "string"
3484n/a}
Query Parameters
limit2 / 2
124036{
224036 "format": "int32",
325521 "type": "integer"
424036}
page2 / 2
121941{
221941 "format": "int32",
323228 "type": "integer"
421941}
start2 / 2
123632{
223632 "format": "date",
3268n/a "type": "string"
423632}
end2 / 2
123325{
223325 "format": "date",
3258n/a "type": "string"
423325}
type2 / 2
TransactionTypeFilter
120038{
220038 "enum": [
355n/a "all",
413n/a "withdrawal",
59n/a "withdrawals",
63n/a "expense",
710n/a "deposit",
89n/a "deposits",
98n/a "income",
1019n/a "transfer",
1129n/a "transfers",
1213n/a "opening_balance",
1310n/a "reconciliation",
1411n/a "special",
159n/a "specials",
162n/a "default"
1720038 ],
18238n/a "type": "string"
1920038}
Headers
X-Trace-Id2 / 2
126953{
226953 "format": "uuid",
3322n/a "type": "string"
426953}
Responses
codedescriptionhitsavg
200A list of transactions13516ms
400Bad request458ms
401Unauthenticated0never seen
404Page not found43915ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
"2026-10-01"start
"2026-10-31"end
Path Parameters
id1 / 1
#validinvalidschema
1659n/a{
2659n/a "type": "string"
3659n/a}
Query Parameters
date2 / 2
164414{
264414 "format": "date",
3658n/a "type": "string"
464414}
Headers
X-Trace-Id2 / 2
140536{
240536 "format": "uuid",
3441n/a "type": "string"
440536}
Responses
codedescriptionhitsavg
200A list of transactions (always just 1) created by the recurrence, or a list of zero (0) when there is nothing to create for this date.0never seen
400Bad request0never seen
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
4156598ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
rule_groups 8 operations 6 covered 2 partial 0 uncovered 0 not measured 84% #
Query Parameters
limit2 / 2
#validinvalidschema
120860{
220860 "format": "int32",
323137 "type": "integer"
420860}
page2 / 2
118571{
218571 "format": "int32",
320848 "type": "integer"
418571}
Headers
X-Trace-Id2 / 2
121846{
221846 "format": "uuid",
3264n/a "type": "string"
421846}
Responses
codedescriptionhitsavg
200A list of rule groups.46617ms
400Bad request318ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
Headers
X-Trace-Id2 / 2
#validinvalidschema
120650{
220650 "format": "uuid",
3256n/a "type": "string"
420650}
Body
application/json5 / 11
RuleGroupStore
17311{
27311 "properties": {
3370 "active": {
4370 "type": "boolean"
5370 },
6461 "description": {
700 "format": "string",
847n/a "nullable": true,
9461 "type": "string"
10461 },
11398 "order": {
12398 "format": "int32",
13470 "type": "integer"
14398 },
15822 "title": {
1600 "format": "string",
17822 "type": "string"
18822 }
197311 },
20840 "required": [
21840 "title"
22840 ],
23840 "type": "object"
247311}
application/x-www-form-urlencoded7 / 11
RuleGroupStore
1802{
2811 "properties": {
3420 "active": {
4420 "type": "boolean"
5420 },
6350 "description": {
700 "format": "string",
835n/a "nullable": true,
935n/a "type": "string"
10350 },
11461 "order": {
12461 "format": "int32",
13470 "type": "integer"
14461 },
15810 "title": {
1600 "format": "string",
1781n/a "type": "string"
18810 }
19811 },
20811 "required": [
21811 "title"
22811 ],
2382n/a "type": "object"
24802}
Responses
codedescriptionhitsavg
200New rule group stored, result in response.43421ms
400Bad request348ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception535ms
Undocumented - not in spec
codedescriptionhitsavg
41538ms
Examples
Body: application/json
trueRuleGroupStore.active
"Description of this rule group"RuleGroupStore.description
4RuleGroupStore.order
"Default rule group"RuleGroupStore.title
Body: application/x-www-form-urlencoded
trueRuleGroupStore.active
"Description of this rule group"RuleGroupStore.description
4RuleGroupStore.order
"Default rule group"RuleGroupStore.title
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path Parameters
id1 / 1
#validinvalidschema
1132n/a{
2132n/a "type": "string"
3132n/a}
Headers
X-Trace-Id2 / 2
14542{
24542 "format": "uuid",
387n/a "type": "string"
44542}
Responses
codedescriptionhitsavg
204Rule group deleted.0never seen
400Bad request348ms
401Unauthenticated0never seen
404Page not found9814ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK10118ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1351n/a{
2351n/a "type": "string"
3351n/a}
Headers
X-Trace-Id2 / 2
112764{
212764 "format": "uuid",
3191n/a "type": "string"
412764}
Responses
codedescriptionhitsavg
200The requested rule group5016ms
400Bad request448ms
401Unauthenticated0never seen
404Page not found30715ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1551n/a{
2551n/a "type": "string"
3551n/a}
Headers
X-Trace-Id2 / 2
130150{
230150 "format": "uuid",
3351n/a "type": "string"
430150}
Body
application/json8 / 10
RuleGroupUpdate
123145{
215236 "properties": {
310811 "active": {
410811 "type": "boolean"
510811 },
613210 "description": {
700 "format": "string",
8142n/a "nullable": true,
913210 "type": "string"
1013210 },
1112510 "order": {
1212510 "format": "int32",
131287 "type": "integer"
1412510 },
151046 "title": {
1600 "format": "string",
171046 "type": "string"
181046 }
1915236 },
202679 "type": "object"
2123145}
application/x-www-form-urlencoded8 / 10
RuleGroupUpdate
114127{
211527 "properties": {
3942 "active": {
4942 "type": "boolean"
5942 },
61020 "description": {
700 "format": "string",
8102n/a "nullable": true,
9102n/a "type": "string"
101020 },
118125 "order": {
128125 "format": "int32",
131033 "type": "integer"
148125 },
15880 "title": {
1600 "format": "string",
1788n/a "type": "string"
18880 }
1911527 },
20168n/a "type": "object"
2114127}
Responses
codedescriptionhitsavg
200Updated rule group stored, result in response215ms
400Bad request368ms
401Unauthenticated0never seen
404Page not found51115ms
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41538ms
403Forbidden10ms
Examples
Body: application/json
trueRuleGroupUpdate.active
"Description of this rule group"RuleGroupUpdate.description
4RuleGroupUpdate.order
"Default rule group"RuleGroupUpdate.title
Body: application/x-www-form-urlencoded
trueRuleGroupUpdate.active
"Description of this rule group"RuleGroupUpdate.description
4RuleGroupUpdate.order
"Default rule group"RuleGroupUpdate.title
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1505n/a{
2505n/a "type": "string"
3505n/a}
Query Parameters
limit2 / 2
124475{
224475 "format": "int32",
328435 "type": "integer"
424475}
page2 / 2
121376{
221376 "format": "int32",
323752 "type": "integer"
421376}
Headers
X-Trace-Id2 / 2
123059{
223059 "format": "uuid",
3289n/a "type": "string"
423059}
Responses
codedescriptionhitsavg
200A list of rules.16116ms
400Bad request498ms
401Unauthenticated0never seen
404Page not found29815ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
Path Parameters
id1 / 1
#validinvalidschema
1464n/a{
2464n/a "type": "string"
3464n/a}
Query Parameters
limit2 / 2
118825{
218825 "format": "int32",
320112 "type": "integer"
418825}
page2 / 2
115817{
215817 "format": "int32",
31669 "type": "integer"
415817}
start2 / 2
117023{
217023 "format": "date",
3193n/a "type": "string"
417023}
end2 / 2
119213{
219213 "format": "date",
3205n/a "type": "string"
419213}
search_limit1 / 1
112711{
212711 "type": "integer"
312711}
triggered_limit1 / 1
112218{
212218 "type": "integer"
312218}
accounts[]3 / 3
116234{
216234 "items": {
377936 "format": "int64",
478134 "type": "integer"
516234 },
6196n/a "type": "array"
716234}
Headers
X-Trace-Id2 / 2
1379100{
2379100 "format": "uuid",
3479n/a "type": "string"
4379100}
Responses
codedescriptionhitsavg
200A list of transactions that would be changed by any of the rules of the rule group. No changes will be made.26716ms
400Bad request348ms
401Unauthenticated0never seen
404Page not found36915ms
500Internal exception6117ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
"2026-10-01"start
"2026-10-31"end
[ 1, 2, 3 ]accounts[]
Path Parameters
id1 / 1
#validinvalidschema
1372n/a{
2372n/a "type": "string"
3372n/a}
Query Parameters
start2 / 2
114842{
214842 "format": "date",
3190n/a "type": "string"
414842}
end2 / 2
110534{
210534 "format": "date",
3139n/a "type": "string"
410534}
accounts[]3 / 3
19685{
29685 "items": {
3295149 "format": "int64",
4297147 "type": "integer"
59685 },
6181n/a "type": "array"
79685}
Headers
X-Trace-Id2 / 2
110188{
210188 "format": "uuid",
3189n/a "type": "string"
410188}
Responses
codedescriptionhitsavg
204The rules in the group are executed. Due to the setup of this function (asynchronous job execution) the result cannot be displayed.0never seen
400Bad request0never seen
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
4153728ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
"2026-10-01"start
"2026-10-31"end
[ 1, 2, 3 ]accounts[]
rules 8 operations 6 covered 2 partial 0 uncovered 0 not measured 45% #
Query Parameters
limit2 / 2
#validinvalidschema
119944{
219944 "format": "int32",
321627 "type": "integer"
419944}
page2 / 2
118265{
218265 "format": "int32",
320146 "type": "integer"
418265}
Headers
X-Trace-Id2 / 2
117147{
217147 "format": "uuid",
3218n/a "type": "string"
417147}
Responses
codedescriptionhitsavg
200A list of rules44817ms
400Bad request318ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
Headers
X-Trace-Id2 / 2
#validinvalidschema
153359{
253359 "format": "uuid",
3592n/a "type": "string"
453359}
Body
application/json9 / 52
RuleStore
1231{
2231 "properties": {
3231 "actions": {
4231 "items": {
6231 },
7240 "type": "array"
8231 },
9150 "active": {
10150 "type": "boolean"
11150 },
12171 "description": {
1300 "format": "string",
14171 "type": "string"
15171 },
16230 "order": {
17230 "format": "int32",
18230 "type": "integer"
19230 },
20240 "rule_group_id": {
2100 "format": "string",
22240 "type": "string"
23240 },
24150 "rule_group_title": {
2500 "format": "string",
26150 "type": "string"
27150 },
28150 "stop_processing": {
29150 "type": "boolean"
30150 },
31160 "strict": {
32160 "type": "boolean"
33160 },
34240 "title": {
3500 "format": "string",
36240 "type": "string"
37240 },
38240 "trigger": {
40240 },
41231 "triggers": {
42231 "items": {
44231 },
45240 "type": "array"
46231 }
47231 },
48240 "required": [
49240 "title",
50240 "rule_group_id",
51240 "trigger",
52240 "triggers",
53240 "actions"
54240 ],
55240 "type": "object"
56231}
Referenced Components (5)7 of 38 keywords
RuleActionKeyword0 of 4 keywords
1400{
2400 "enum": [
33n/a "user_action",
41n/a "set_category",
55n/a "clear_category",
61n/a "set_budget",
74n/a "clear_budget",
81n/a "add_tag",
92n/a "remove_tag",
100n/a "remove_all_tags",
111n/a "set_description",
120n/a "append_description",
133n/a "prepend_description",
142n/a "set_source_account",
151n/a "set_destination_account",
162n/a "set_notes",
170n/a "append_notes",
181n/a "prepend_notes",
192n/a "clear_notes",
200n/a "link_to_bill",
210n/a "convert_withdrawal",
220n/a "convert_deposit",
231n/a "convert_transfer",
2410n/a "delete_transaction"
25400 ],
2600 "format": "string",
27400 "type": "string"
28400}
RuleActionStore4 of 13 keywords
1391{
2391 "properties": {
3210 "active": {
4210 "type": "boolean"
5210 },
6200 "order": {
7200 "format": "int32",
8200 "type": "integer"
9200 },
10190 "stop_processing": {
11190 "type": "boolean"
12190 },
13400 "type": {
15400 },
16391 "value": {
1700 "format": "string",
1840n/a "nullable": true,
19391 "type": "string"
20391 }
21391 },
22400 "required": [
23400 "type",
24400 "value"
25400 ],
26400 "type": "object"
27391}
RuleTriggerKeyword0 of 4 keywords
1930{
2930 "enum": [
32n/a "from_account_starts",
45n/a "from_account_ends",
54n/a "from_account_is",
67n/a "from_account_contains",
72n/a "to_account_starts",
82n/a "to_account_ends",
94n/a "to_account_is",
101n/a "to_account_contains",
113n/a "amount_less",
123n/a "amount_exactly",
132n/a "amount_more",
140n/a "description_starts",
150n/a "description_ends",
166n/a "description_contains",
174n/a "description_is",
184n/a "transaction_type",
190n/a "category_is",
206n/a "budget_is",
214n/a "tag_is",
222n/a "currency_is",
231n/a "has_attachments",
242n/a "has_no_category",
252n/a "has_any_category",
260n/a "has_no_budget",
273n/a "has_any_budget",
281n/a "has_no_tag",
291n/a "has_any_tag",
306n/a "notes_contains",
310n/a "notes_starts",
323n/a "notes_end",
335n/a "notes_are",
340n/a "no_notes",
350n/a "any_notes",
364n/a "source_account_is",
374n/a "destination_account_is",
380n/a "source_account_starts"
39930 ],
4000 "format": "string",
41930 "type": "string"
42930}
RuleTriggerStore3 of 13 keywords
1912{
2912 "properties": {
3510 "active": {
4510 "type": "boolean"
5510 },
6490 "order": {
7490 "format": "int32",
8490 "type": "integer"
9490 },
10510 "prohibited": {
11510 "type": "boolean"
12510 },
13382 "stop_processing": {
14382 "type": "boolean"
15382 },
16930 "type": {
18930 },
19930 "value": {
2000 "format": "string",
21930 "type": "string"
22930 }
23912 },
24930 "required": [
25930 "type",
26930 "value"
27930 ],
28930 "type": "object"
29912}
RuleTriggerType0 of 4 keywords
1240{
2240 "enum": [
318n/a "store-journal",
44n/a "update-journal",
52n/a "manual-activation"
6240 ],
700 "format": "string",
8240 "type": "string"
9240}
application/x-www-form-urlencoded7 / 52
RuleStore
1019{
2019 "properties": {
3019 "actions": {
4019 "items": {
6019 },
7190 "type": "array"
8019 },
9150 "active": {
10150 "type": "boolean"
11150 },
1290 "description": {
1300 "format": "string",
149n/a "type": "string"
1590 },
1660 "order": {
1760 "format": "int32",
1860 "type": "integer"
1960 },
20190 "rule_group_id": {
2100 "format": "string",
2219n/a "type": "string"
23190 },
2460 "rule_group_title": {
2500 "format": "string",
266n/a "type": "string"
2760 },
28180 "stop_processing": {
29180 "type": "boolean"
30180 },
31150 "strict": {
32150 "type": "boolean"
33150 },
34190 "title": {
3500 "format": "string",
3619n/a "type": "string"
37190 },
38190 "trigger": {
40190 },
41018 "triggers": {
42018 "items": {
44018 },
45180 "type": "array"
46018 }
47019 },
48181 "required": [
49190 "title",
50190 "rule_group_id",
51190 "trigger",
52181 "triggers",
53190 "actions"
54181 ],
5519n/a "type": "object"
56019}
Referenced Components (5)1 of 38 keywords
RuleActionKeyword0 of 4 keywords
100{
200 "enum": [
30n/a "user_action",
40n/a "set_category",
50n/a "clear_category",
60n/a "set_budget",
70n/a "clear_budget",
80n/a "add_tag",
90n/a "remove_tag",
100n/a "remove_all_tags",
110n/a "set_description",
120n/a "append_description",
130n/a "prepend_description",
140n/a "set_source_account",
150n/a "set_destination_account",
160n/a "set_notes",
170n/a "append_notes",
180n/a "prepend_notes",
190n/a "clear_notes",
200n/a "link_to_bill",
210n/a "convert_withdrawal",
220n/a "convert_deposit",
230n/a "convert_transfer",
240n/a "delete_transaction"
2500 ],
2600 "format": "string",
2700 "type": "string"
2800}
RuleActionStore0 of 13 keywords
10270{
200 "properties": {
300 "active": {
400 "type": "boolean"
500 },
600 "order": {
700 "format": "int32",
800 "type": "integer"
900 },
1000 "stop_processing": {
1100 "type": "boolean"
1200 },
1300 "type": {
1500 },
1600 "value": {
1700 "format": "string",
180n/a "nullable": true,
1900 "type": "string"
2000 }
2100 },
2200 "required": [
2300 "type",
2400 "value"
2500 ],
260270 "type": "object"
270270}
RuleTriggerKeyword0 of 4 keywords
100{
200 "enum": [
30n/a "from_account_starts",
40n/a "from_account_ends",
50n/a "from_account_is",
60n/a "from_account_contains",
70n/a "to_account_starts",
80n/a "to_account_ends",
90n/a "to_account_is",
100n/a "to_account_contains",
110n/a "amount_less",
120n/a "amount_exactly",
130n/a "amount_more",
140n/a "description_starts",
150n/a "description_ends",
160n/a "description_contains",
170n/a "description_is",
180n/a "transaction_type",
190n/a "category_is",
200n/a "budget_is",
210n/a "tag_is",
220n/a "currency_is",
230n/a "has_attachments",
240n/a "has_no_category",
250n/a "has_any_category",
260n/a "has_no_budget",
270n/a "has_any_budget",
280n/a "has_no_tag",
290n/a "has_any_tag",
300n/a "notes_contains",
310n/a "notes_starts",
320n/a "notes_end",
330n/a "notes_are",
340n/a "no_notes",
350n/a "any_notes",
360n/a "source_account_is",
370n/a "destination_account_is",
380n/a "source_account_starts"
3900 ],
4000 "format": "string",
4100 "type": "string"
4200}
RuleTriggerStore0 of 13 keywords
10642{
200 "properties": {
300 "active": {
400 "type": "boolean"
500 },
600 "order": {
700 "format": "int32",
800 "type": "integer"
900 },
1000 "prohibited": {
1100 "type": "boolean"
1200 },
1300 "stop_processing": {
1400 "type": "boolean"
1500 },
1600 "type": {
1800 },
1900 "value": {
2000 "format": "string",
2100 "type": "string"
2200 }
2300 },
2400 "required": [
2500 "type",
2600 "value"
2700 ],
280642 "type": "object"
290642}
RuleTriggerType1 of 4 keywords
1190{
2190 "enum": [
34n/a "store-journal",
412n/a "update-journal",
53n/a "manual-activation"
6190 ],
700 "format": "string",
819n/a "type": "string"
9190}
Responses
codedescriptionhitsavg
200New rule stored, result in response.87416ms
400Bad request398ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception720ms
Undocumented - not in spec
codedescriptionhitsavg
41517ms
Examples
Body: application/json
trueRuleActionStore.active
trueRuleActionStore.active
5RuleActionStore.order
falseRuleActionStore.stop_processing
falseRuleActionStore.stop_processing
"set_category"RuleActionKeyword
"Daily groceries"RuleActionStore.value
trueRuleStore.active
trueRuleStore.active
"First rule description"RuleStore.description
5RuleStore.order
"81"RuleStore.rule_group_id
"New rule group"RuleStore.rule_group_title
falseRuleStore.stop_processing
trueRuleStore.strict
trueRuleStore.strict
"First rule title."RuleStore.title
"store-journal"RuleTriggerType
trueRuleTriggerStore.active
trueRuleTriggerStore.active
5RuleTriggerStore.order
falseRuleTriggerStore.prohibited
falseRuleTriggerStore.prohibited
falseRuleTriggerStore.stop_processing
falseRuleTriggerStore.stop_processing
"user_action"RuleTriggerKeyword
"tag1"RuleTriggerStore.value
Body: application/x-www-form-urlencoded
trueRuleActionStore.active
trueRuleActionStore.active
5RuleActionStore.order
falseRuleActionStore.stop_processing
falseRuleActionStore.stop_processing
"set_category"RuleActionKeyword
"Daily groceries"RuleActionStore.value
trueRuleStore.active
trueRuleStore.active
"First rule description"RuleStore.description
5RuleStore.order
"81"RuleStore.rule_group_id
"New rule group"RuleStore.rule_group_title
falseRuleStore.stop_processing
trueRuleStore.strict
trueRuleStore.strict
"First rule title."RuleStore.title
"store-journal"RuleTriggerType
trueRuleTriggerStore.active
trueRuleTriggerStore.active
5RuleTriggerStore.order
falseRuleTriggerStore.prohibited
falseRuleTriggerStore.prohibited
falseRuleTriggerStore.stop_processing
falseRuleTriggerStore.stop_processing
"user_action"RuleTriggerKeyword
"tag1"RuleTriggerStore.value
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query Parameters
expression1 / 1
#validinvalidschema
1116n/a{
2116n/a "type": "string"
3116n/a}
Headers
X-Trace-Id2 / 2
17229{
27229 "format": "uuid",
3101n/a "type": "string"
47229}
Responses
codedescriptionhitsavg
200The expression is valid.25616ms
400Bad request248ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
"{{ description | upper }}"expression
Path Parameters
id1 / 1
#validinvalidschema
1137n/a{
2137n/a "type": "string"
3137n/a}
Headers
X-Trace-Id2 / 2
13038{
23038 "format": "uuid",
368n/a "type": "string"
43038}
Responses
codedescriptionhitsavg
204Rule deleted.0never seen
400Bad request218ms
401Unauthenticated0never seen
404Page not found11614ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1318n/a{
2318n/a "type": "string"
3318n/a}
Headers
X-Trace-Id2 / 2
116462{
216462 "format": "uuid",
3226n/a "type": "string"
416462}
Responses
codedescriptionhitsavg
200The requested rule11017ms
400Bad request408ms
401Unauthenticated0never seen
404Page not found27815ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1809n/a{
2809n/a "type": "string"
3809n/a}
Headers
X-Trace-Id2 / 2
156460{
256460 "format": "uuid",
3624n/a "type": "string"
456460}
Body
application/json38 / 46
RuleUpdate
1317150{
2260145 "properties": {
327349 "actions": {
427344 "items": {
627344 },
73175 "type": "array"
827349 },
93045 "active": {
103045 "type": "boolean"
113045 },
123025 "description": {
1300 "format": "string",
143025 "type": "string"
153025 },
1630013 "order": {
1730013 "format": "int32",
183076 "type": "integer"
1930013 },
202945 "rule_group_id": {
2100 "format": "string",
222945 "type": "string"
232945 },
242995 "stop_processing": {
252995 "type": "boolean"
262995 },
272905 "strict": {
282905 "type": "boolean"
292905 },
302985 "title": {
3100 "format": "string",
322985 "type": "string"
332985 },
343106 "trigger": {
363106 },
3725756 "triggers": {
3825751 "items": {
4025751 },
413085 "type": "array"
4225756 }
43260145 },
444625 "type": "object"
45317150}
Referenced Components (5)28 of 33 keywords
RuleActionKeyword3 of 4 keywords
12236{
22236 "enum": [
320n/a "user_action",
438n/a "set_category",
56n/a "clear_category",
66n/a "set_budget",
78n/a "clear_budget",
89n/a "add_tag",
98n/a "remove_tag",
106n/a "remove_all_tags",
1115n/a "set_description",
1212n/a "append_description",
136n/a "prepend_description",
149n/a "set_source_account",
155n/a "set_destination_account",
163n/a "set_notes",
1711n/a "append_notes",
1811n/a "prepend_notes",
1912n/a "clear_notes",
207n/a "link_to_bill",
2111n/a "convert_withdrawal",
2210n/a "convert_deposit",
236n/a "convert_transfer",
244n/a "delete_transaction"
252236 ],
2600 "format": "string",
272245 "type": "string"
282236}
RuleActionUpdate10 of 11 keywords
140975{
229070 "properties": {
32275 "active": {
42275 "type": "boolean"
52275 },
62309 "order": {
72309 "format": "int32",
82336 "type": "integer"
92309 },
102125 "stop_processing": {
112125 "type": "boolean"
122125 },
132236 "type": {
152236 },
1621645 "value": {
1700 "format": "string",
18261n/a "nullable": true,
1921645 "type": "string"
2021645 }
2129070 },
224795 "type": "object"
2340975}
RuleTriggerKeyword3 of 4 keywords
122413{
222413 "enum": [
334n/a "from_account_starts",
44n/a "from_account_ends",
511n/a "from_account_is",
64n/a "from_account_contains",
79n/a "to_account_starts",
85n/a "to_account_ends",
95n/a "to_account_is",
108n/a "to_account_contains",
117n/a "amount_less",
122n/a "amount_exactly",
135n/a "amount_more",
144n/a "description_starts",
155n/a "description_ends",
161n/a "description_contains",
1723n/a "description_is",
184n/a "transaction_type",
198n/a "category_is",
202n/a "budget_is",
218n/a "tag_is",
225n/a "currency_is",
237n/a "has_attachments",
245n/a "has_no_category",
257n/a "has_any_category",
263n/a "has_no_budget",
279n/a "has_any_budget",
283n/a "has_no_tag",
292n/a "has_any_tag",
306n/a "notes_contains",
312n/a "notes_starts",
326n/a "notes_end",
333n/a "notes_are",
344n/a "no_notes",
352n/a "any_notes",
362n/a "source_account_is",
374n/a "destination_account_is",
385n/a "source_account_starts"
3922413 ],
4000 "format": "string",
412325 "type": "string"
4222413}
RuleTriggerType3 of 4 keywords
13106{
23106 "enum": [
3257n/a "store-journal",
415n/a "update-journal",
538n/a "manual-activation"
63106 ],
700 "format": "string",
83115 "type": "string"
93106}
RuleTriggerUpdate9 of 10 keywords
137266{
229661 "properties": {
323113 "active": {
423113 "type": "boolean"
523113 },
624825 "order": {
724825 "format": "int32",
825023 "type": "integer"
924825 },
102285 "stop_processing": {
112285 "type": "boolean"
122285 },
1322413 "type": {
1522413 },
1622513 "value": {
1700 "format": "string",
1822513 "type": "string"
1922513 }
2029661 },
214335 "type": "object"
2237266}
application/x-www-form-urlencoded13 / 46
RuleUpdate
171203{
264203 "properties": {
30103 "actions": {
40103 "items": {
60103 },
71030 "type": "array"
80103 },
91982 "active": {
101982 "type": "boolean"
111982 },
122090 "description": {
1300 "format": "string",
14209n/a "type": "string"
152090 },
162105 "order": {
172105 "format": "int32",
182123 "type": "integer"
192105 },
201880 "rule_group_id": {
2100 "format": "string",
22188n/a "type": "string"
231880 },
242082 "stop_processing": {
252082 "type": "boolean"
262082 },
272022 "strict": {
282022 "type": "boolean"
292022 },
302000 "title": {
3100 "format": "string",
32200n/a "type": "string"
332000 },
342024 "trigger": {
362024 },
370118 "triggers": {
380118 "items": {
400118 },
411180 "type": "array"
420118 }
4364203 },
44274n/a "type": "object"
4571203}
Referenced Components (5)3 of 33 keywords
RuleActionKeyword0 of 4 keywords
100{
200 "enum": [
30n/a "user_action",
40n/a "set_category",
50n/a "clear_category",
60n/a "set_budget",
70n/a "clear_budget",
80n/a "add_tag",
90n/a "remove_tag",
100n/a "remove_all_tags",
110n/a "set_description",
120n/a "append_description",
130n/a "prepend_description",
140n/a "set_source_account",
150n/a "set_destination_account",
160n/a "set_notes",
170n/a "append_notes",
180n/a "prepend_notes",
190n/a "clear_notes",
200n/a "link_to_bill",
210n/a "convert_withdrawal",
220n/a "convert_deposit",
230n/a "convert_transfer",
240n/a "delete_transaction"
2500 ],
2600 "format": "string",
2700 "type": "string"
2800}
RuleActionUpdate0 of 11 keywords
101431{
200 "properties": {
300 "active": {
400 "type": "boolean"
500 },
600 "order": {
700 "format": "int32",
800 "type": "integer"
900 },
1000 "stop_processing": {
1100 "type": "boolean"
1200 },
1300 "type": {
1500 },
1600 "value": {
1700 "format": "string",
180n/a "nullable": true,
1900 "type": "string"
2000 }
2100 },
2201431 "type": "object"
2301431}
RuleTriggerKeyword0 of 4 keywords
100{
200 "enum": [
30n/a "from_account_starts",
40n/a "from_account_ends",
50n/a "from_account_is",
60n/a "from_account_contains",
70n/a "to_account_starts",
80n/a "to_account_ends",
90n/a "to_account_is",
100n/a "to_account_contains",
110n/a "amount_less",
120n/a "amount_exactly",
130n/a "amount_more",
140n/a "description_starts",
150n/a "description_ends",
160n/a "description_contains",
170n/a "description_is",
180n/a "transaction_type",
190n/a "category_is",
200n/a "budget_is",
210n/a "tag_is",
220n/a "currency_is",
230n/a "has_attachments",
240n/a "has_no_category",
250n/a "has_any_category",
260n/a "has_no_budget",
270n/a "has_any_budget",
280n/a "has_no_tag",
290n/a "has_any_tag",
300n/a "notes_contains",
310n/a "notes_starts",
320n/a "notes_end",
330n/a "notes_are",
340n/a "no_notes",
350n/a "any_notes",
360n/a "source_account_is",
370n/a "destination_account_is",
380n/a "source_account_starts"
3900 ],
4000 "format": "string",
4100 "type": "string"
4200}
RuleTriggerType3 of 4 keywords
12024{
22024 "enum": [
3159n/a "store-journal",
423n/a "update-journal",
520n/a "manual-activation"
62024 ],
700 "format": "string",
8206n/a "type": "string"
92024}
RuleTriggerUpdate0 of 10 keywords
101472{
200 "properties": {
300 "active": {
400 "type": "boolean"
500 },
600 "order": {
700 "format": "int32",
800 "type": "integer"
900 },
1000 "stop_processing": {
1100 "type": "boolean"
1200 },
1300 "type": {
1500 },
1600 "value": {
1700 "format": "string",
1800 "type": "string"
1900 }
2000 },
2101472 "type": "object"
2201472}
Responses
codedescriptionhitsavg
200Updated rule stored, result in response3915ms
400Bad request348ms
401Unauthenticated0never seen
404Page not found77214ms
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41537ms
Examples
Body: application/json
trueRuleActionUpdate.active
5RuleActionUpdate.order
falseRuleActionUpdate.stop_processing
"set_category"RuleActionKeyword
"Daily groceries"RuleActionUpdate.value
trueRuleUpdate.active
trueRuleUpdate.active
"First rule description"RuleUpdate.description
5RuleUpdate.order
"81"RuleUpdate.rule_group_id
falseRuleUpdate.stop_processing
falseRuleUpdate.stop_processing
trueRuleUpdate.strict
"First rule title."RuleUpdate.title
"store-journal"RuleTriggerType
trueRuleTriggerUpdate.active
5RuleTriggerUpdate.order
falseRuleTriggerUpdate.stop_processing
"user_action"RuleTriggerKeyword
"tag1"RuleTriggerUpdate.value
Body: application/x-www-form-urlencoded
trueRuleActionUpdate.active
5RuleActionUpdate.order
falseRuleActionUpdate.stop_processing
"set_category"RuleActionKeyword
"Daily groceries"RuleActionUpdate.value
trueRuleUpdate.active
trueRuleUpdate.active
"First rule description"RuleUpdate.description
5RuleUpdate.order
"81"RuleUpdate.rule_group_id
falseRuleUpdate.stop_processing
falseRuleUpdate.stop_processing
trueRuleUpdate.strict
"First rule title."RuleUpdate.title
"store-journal"RuleTriggerType
trueRuleTriggerUpdate.active
5RuleTriggerUpdate.order
falseRuleTriggerUpdate.stop_processing
"user_action"RuleTriggerKeyword
"tag1"RuleTriggerUpdate.value
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1493n/a{
2493n/a "type": "string"
3493n/a}
Query Parameters
start2 / 2
124737{
224737 "format": "date",
3284n/a "type": "string"
424737}
end2 / 2
122843{
222843 "format": "date",
3271n/a "type": "string"
422843}
accounts[]3 / 3
119160{
219160 "items": {
3670201 "format": "int64",
4678193 "type": "integer"
519160 },
6251n/a "type": "array"
719160}
Headers
X-Trace-Id2 / 2
126376{
226376 "format": "uuid",
3339n/a "type": "string"
426376}
Responses
codedescriptionhitsavg
200A list of transactions that would be changed by the rule. No changes will be made.5118ms
400Bad request648ms
401Unauthenticated0never seen
404Page not found42915ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
"2026-10-01"start
"2026-10-31"end
[ 1, 2, 3 ]accounts[]
Path Parameters
id1 / 1
#validinvalidschema
1368n/a{
2368n/a "type": "string"
3368n/a}
Query Parameters
start2 / 2
110129{
210129 "format": "date",
3130n/a "type": "string"
410129}
end2 / 2
111827{
211827 "format": "date",
3145n/a "type": "string"
411827}
accounts[]3 / 3
110934{
210934 "items": {
336482 "format": "int64",
436779 "type": "integer"
510934 },
6143n/a "type": "array"
710934}
Headers
X-Trace-Id2 / 2
111952{
211952 "format": "uuid",
3171n/a "type": "string"
411952}
Responses
codedescriptionhitsavg
204The rules in the group are executed. Due to the setup of this function (asynchronous job execution) the result cannot be displayed.0never seen
400Bad request0never seen
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
4153688ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
"2026-10-01"start
"2026-10-31"end
[ 1, 2, 3 ]accounts[]
summary 1 operation 0 covered 1 partial 0 uncovered 0 not measured 62% #
Query Parameters
start1 / 2
#validinvalidschema
1970{
2970 "format": "date",
397n/a "type": "string"
4970}
end1 / 2
1970{
2970 "format": "date",
397n/a "type": "string"
4970}
currency_code1 / 2
1230{
200 "format": "string",
323n/a "type": "string"
4230}
Headers
X-Trace-Id2 / 2
114841{
214841 "format": "uuid",
3189n/a "type": "string"
414841}
Responses
codedescriptionhitsavg
200An array of sums. It depends on the user what you can expect to get back, so please try this out on the demo site.26920ms
400Bad request228ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
tags 7 operations 1 covered 6 partial 0 uncovered 0 not measured 81% #
Query Parameters
limit2 / 2
#validinvalidschema
122448{
222448 "format": "int32",
324725 "type": "integer"
422448}
page2 / 2
119754{
219754 "format": "int32",
322031 "type": "integer"
419754}
Headers
X-Trace-Id2 / 2
119848{
219848 "format": "uuid",
3246n/a "type": "string"
419848}
Responses
codedescriptionhitsavg
200A list of tags48718ms
400Bad request288ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
Headers
X-Trace-Id2 / 2
#validinvalidschema
129364{
229364 "format": "uuid",
3357n/a "type": "string"
429364}
Body
application/json10 / 20
TagModelStore
12635{
23328 "properties": {
3320 "date": {
4200 "format": "date",
532n/a "nullable": true,
6320 "type": "string"
7320 },
8310 "description": {
900 "format": "string",
1031n/a "nullable": true,
11310 "type": "string"
12310 },
13025 "latitude": {
14025 "format": "double",
1525n/a "nullable": true,
16250 "type": "number"
17025 },
18618 "longitude": {
19618 "format": "double",
2024n/a "nullable": true,
21240 "type": "number"
22618 },
23502 "tag": {
2400 "format": "string",
25502 "type": "string"
26502 },
27157 "zoom_level": {
28157 "format": "int32",
2922n/a "nullable": true,
30220 "type": "integer"
31157 }
323328 },
33529 "required": [
34529 "tag"
35529 ],
36610 "type": "object"
372635}
application/x-www-form-urlencoded18 / 20
TagModelStore
1297{
2306 "properties": {
371 "date": {
471 "format": "date",
58n/a "nullable": true,
68n/a "type": "string"
771 },
8100 "description": {
900 "format": "string",
1010n/a "nullable": true,
1110n/a "type": "string"
12100 },
1336 "latitude": {
1436 "format": "double",
159n/a "nullable": true,
1636 "type": "number"
1736 },
1844 "longitude": {
1944 "format": "double",
208n/a "nullable": true,
2144 "type": "number"
2244 },
23350 "tag": {
2400 "format": "string",
2535n/a "type": "string"
26350 },
2763 "zoom_level": {
2863 "format": "int32",
299n/a "nullable": true,
3063 "type": "integer"
3163 }
32306 },
33351 "required": [
34351 "tag"
35351 ],
3636n/a "type": "object"
37297}
Responses
codedescriptionhitsavg
200New tag stored, result in response.48716ms
400Bad request438ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41537ms
Examples
Body: application/json
"2026-10-01"TagModelStore.date
"Tag for expensive stuff"TagModelStore.description
51.983333TagModelStore.latitude
5.916667TagModelStore.longitude
"expensive"TagModelStore.tag
6TagModelStore.zoom_level
Body: application/x-www-form-urlencoded
"2026-10-01"TagModelStore.date
"Tag for expensive stuff"TagModelStore.description
51.983333TagModelStore.latitude
5.916667TagModelStore.longitude
"expensive"TagModelStore.tag
6TagModelStore.zoom_level
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path Parameters
tag1 / 2
#validinvalidschema
1320{
200 "format": "string",
332n/a "type": "string"
4320}
Headers
X-Trace-Id2 / 2
11114{
21114 "format": "uuid",
325n/a "type": "string"
41114}
Responses
codedescriptionhitsavg
204Tag deleted.425ms
400Bad request127ms
401Unauthenticated0never seen
404Page not found1614ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK215ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"groceries"tag
Path Parameters
tag1 / 2
#validinvalidschema
14000{
200 "format": "string",
3400n/a "type": "string"
44000}
Query Parameters
limit2 / 2
117624{
217624 "format": "int32",
318515 "type": "integer"
417624}
page2 / 2
118227{
218227 "format": "int32",
319118 "type": "integer"
418227}
Headers
X-Trace-Id2 / 2
115438{
215438 "format": "uuid",
3192n/a "type": "string"
415438}
Responses
codedescriptionhitsavg
200The requested tag3016ms
400Bad request318ms
401Unauthenticated0never seen
404Page not found33915ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
403Forbidden20ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"groceries"tag
Query
10limit
1page
Path Parameters
tag1 / 2
#validinvalidschema
13220{
200 "format": "string",
3322n/a "type": "string"
43220}
Headers
X-Trace-Id2 / 2
136440{
236440 "format": "uuid",
3404n/a "type": "string"
436440}
Body
application/json15 / 19
TagModelUpdate
187102{
28497 "properties": {
31022 "date": {
4831 "format": "date",
5104n/a "nullable": true,
61031 "type": "string"
71022 },
8942 "description": {
900 "format": "string",
1096n/a "nullable": true,
11942 "type": "string"
12942 },
132676 "latitude": {
142676 "format": "double",
15102n/a "nullable": true,
161020 "type": "number"
172676 },
182477 "longitude": {
192477 "format": "double",
20101n/a "nullable": true,
211010 "type": "number"
222477 },
231634 "tag": {
2400 "format": "string",
251634 "type": "string"
261634 },
276829 "zoom_level": {
286829 "format": "int32",
2997n/a "nullable": true,
30961 "type": "integer"
316829 }
328497 },
331845 "type": "object"
3487102}
application/x-www-form-urlencoded17 / 19
TagModelUpdate
15860{
25560 "properties": {
33723 "date": {
43723 "format": "date",
560n/a "nullable": true,
660n/a "type": "string"
73723 },
8440 "description": {
900 "format": "string",
1044n/a "nullable": true,
1144n/a "type": "string"
12440 },
132826 "latitude": {
142826 "format": "double",
1554n/a "nullable": true,
162826 "type": "number"
172826 },
182431 "longitude": {
192431 "format": "double",
2055n/a "nullable": true,
212431 "type": "number"
222431 },
231070 "tag": {
2400 "format": "string",
25107n/a "type": "string"
261070 },
273522 "zoom_level": {
283522 "format": "int32",
2957n/a "nullable": true,
303621 "type": "integer"
313522 }
325560 },
33118n/a "type": "object"
345860}
Responses
codedescriptionhitsavg
200Updated tag stored, result in response20317ms
400Bad request318ms
401Unauthenticated0never seen
404Page not found26915ms
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41538ms
Examples
Body: application/json
"2026-10-01"TagModelUpdate.date
"Tag for expensive stuff"TagModelUpdate.description
51.983333TagModelUpdate.latitude
5.916667TagModelUpdate.longitude
"expensive"TagModelUpdate.tag
6TagModelUpdate.zoom_level
Body: application/x-www-form-urlencoded
"2026-10-01"TagModelUpdate.date
"Tag for expensive stuff"TagModelUpdate.description
51.983333TagModelUpdate.latitude
5.916667TagModelUpdate.longitude
"expensive"TagModelUpdate.tag
6TagModelUpdate.zoom_level
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"groceries"tag
Path Parameters
tag1 / 2
#validinvalidschema
13890{
200 "format": "string",
3389n/a "type": "string"
43890}
Query Parameters
limit2 / 2
120235{
220235 "format": "int32",
321621 "type": "integer"
420235}
page2 / 2
117329{
217329 "format": "int32",
318517 "type": "integer"
417329}
Headers
X-Trace-Id2 / 2
117235{
217235 "format": "uuid",
3207n/a "type": "string"
417235}
Responses
codedescriptionhitsavg
200A list of attachments7216ms
400Bad request268ms
401Unauthenticated0never seen
404Page not found34115ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"groceries"tag
Query
10limit
1page
Path Parameters
tag1 / 2
#validinvalidschema
15070{
200 "format": "string",
3507n/a "type": "string"
45070}
Query Parameters
limit2 / 2
124627{
224627 "format": "int32",
325419 "type": "integer"
424627}
page2 / 2
124730{
224730 "format": "int32",
325621 "type": "integer"
424730}
start2 / 2
125531{
225531 "format": "date",
3286n/a "type": "string"
425531}
end2 / 2
124429{
224429 "format": "date",
3273n/a "type": "string"
424429}
type2 / 2
TransactionTypeFilter
121729{
221729 "enum": [
368n/a "all",
413n/a "withdrawal",
59n/a "withdrawals",
66n/a "expense",
712n/a "deposit",
819n/a "deposits",
95n/a "income",
1018n/a "transfer",
115n/a "transfers",
128n/a "opening_balance",
1311n/a "reconciliation",
1410n/a "special",
1514n/a "specials",
1619n/a "default"
1721729 ],
18246n/a "type": "string"
1921729}
Headers
X-Trace-Id2 / 2
133354{
233354 "format": "uuid",
3387n/a "type": "string"
433354}
Responses
codedescriptionhitsavg
200A list of transactions.24020ms
400Bad request358ms
401Unauthenticated0never seen
404Page not found33816ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"groceries"tag
Query
10limit
1page
"2026-10-01"start
"2026-10-31"end
transactions 10 operations 8 covered 2 partial 0 uncovered 0 not measured 30% #
Path Parameters
id1 / 1
#validinvalidschema
1173n/a{
2173n/a "type": "string"
3173n/a}
Headers
X-Trace-Id2 / 2
16559{
26559 "format": "uuid",
3124n/a "type": "string"
46559}
Responses
codedescriptionhitsavg
204Transaction journal (split) deleted.0never seen
400Bad request288ms
401Unauthenticated0never seen
404Page not found14515ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK9216ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1337n/a{
2337n/a "type": "string"
3337n/a}
Headers
X-Trace-Id2 / 2
114782{
214782 "format": "uuid",
3229n/a "type": "string"
414782}
Responses
codedescriptionhitsavg
200The requested transaction.12917ms
400Bad request518ms
401Unauthenticated0never seen
404Page not found28615ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query Parameters
limit2 / 2
#validinvalidschema
122152{
222152 "format": "int32",
323637 "type": "integer"
422152}
page2 / 2
121744{
221744 "format": "int32",
323526 "type": "integer"
421744}
start2 / 2
125346{
225346 "format": "date",
3299n/a "type": "string"
425346}
end2 / 2
123233{
223233 "format": "date",
3265n/a "type": "string"
423233}
type2 / 2
TransactionTypeFilter
116334{
216334 "enum": [
355n/a "all",
46n/a "withdrawal",
57n/a "withdrawals",
67n/a "expense",
76n/a "deposit",
810n/a "deposits",
96n/a "income",
105n/a "transfer",
115n/a "transfers",
1213n/a "opening_balance",
1320n/a "reconciliation",
149n/a "special",
155n/a "specials",
169n/a "default"
1716334 ],
18197n/a "type": "string"
1916334}
Headers
X-Trace-Id2 / 2
127641{
227641 "format": "uuid",
3317n/a "type": "string"
427641}
Responses
codedescriptionhitsavg
200A list of transactions.54221ms
400Bad request288ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
"2026-10-01"start
"2026-10-31"end
Headers
X-Trace-Id2 / 2
#validinvalidschema
150056{
250056 "format": "uuid",
3556n/a "type": "string"
450056}
Body
application/json22 / 137
TransactionStore
1171{
2171 "properties": {
3170 "apply_rules": {
4170 "type": "boolean"
5170 },
6170 "error_if_duplicate_hash": {
7170 "type": "boolean"
8170 },
9170 "fire_webhooks": {
10170 "type": "boolean"
11170 },
12170 "group_title": {
1300 "format": "string",
1417n/a "nullable": true,
15170 "type": "string"
16170 },
17171 "transactions": {
18171 "items": {
20171 },
21180 "type": "array"
22171 }
23171 },
24180 "required": [
25180 "transactions"
26180 ],
27180 "type": "object"
28171}
Referenced Components (2)20 of 129 keywords
TransactionSplitStore20 of 125 keywords
107{
207 "properties": {
370 "amount": {
400 "format": "amount",
570 "type": "string"
670 },
700 "bill_id": {
800 "format": "string",
90n/a "nullable": true,
1000 "type": "string"
1100 },
1200 "bill_name": {
1300 "format": "string",
140n/a "nullable": true,
1500 "type": "string"
1600 },
1700 "book_date": {
1800 "format": "date-time",
190n/a "nullable": true,
2000 "type": "string"
2100 },
2200 "budget_id": {
2300 "format": "string",
240n/a "nullable": true,
2500 "type": "string"
2600 },
2710 "budget_name": {
2800 "format": "string",
291n/a "nullable": true,
3010 "type": "string"
3110 },
3210 "category_id": {
3300 "format": "string",
341n/a "nullable": true,
3510 "type": "string"
3610 },
3720 "category_name": {
3800 "format": "string",
392n/a "nullable": true,
4020 "type": "string"
4120 },
4230 "currency_code": {
4300 "format": "string",
443n/a "nullable": true,
4530 "type": "string"
4630 },
4720 "currency_id": {
4800 "format": "string",
492n/a "nullable": true,
5020 "type": "string"
5120 },
5270 "date": {
5370 "format": "date-time",
5470 "type": "string"
5570 },
5670 "description": {
5700 "format": "string",
5870 "type": "string"
5970 },
6020 "destination_id": {
6100 "format": "string",
622n/a "nullable": true,
6320 "type": "string"
6420 },
6500 "destination_name": {
6600 "format": "string",
670n/a "nullable": true,
6800 "type": "string"
6900 },
7010 "due_date": {
7110 "format": "date-time",
721n/a "nullable": true,
7310 "type": "string"
7410 },
7510 "external_id": {
7600 "format": "string",
771n/a "nullable": true,
7810 "type": "string"
7910 },
8010 "external_url": {
8100 "format": "string",
821n/a "nullable": true,
8310 "type": "string"
8410 },
8520 "foreign_amount": {
8600 "format": "amount",
872n/a "nullable": true,
8820 "type": "string"
8920 },
9020 "foreign_currency_code": {
9100 "format": "string",
922n/a "nullable": true,
9320 "type": "string"
9420 },
9500 "foreign_currency_id": {
9600 "format": "string",
970n/a "nullable": true,
9800 "type": "string"
9900 },
10000 "interest_date": {
10100 "format": "date-time",
1020n/a "nullable": true,
10300 "type": "string"
10400 },
10510 "internal_reference": {
10600 "format": "string",
1071n/a "nullable": true,
10810 "type": "string"
10910 },
11010 "invoice_date": {
11100 "format": "date-time",
1121n/a "nullable": true,
11310 "type": "string"
11410 },
11500 "notes": {
11600 "format": "string",
1170n/a "nullable": true,
11800 "type": "string"
11900 },
12000 "order": {
12100 "format": "int32",
1220n/a "nullable": true,
12300 "type": "integer"
12400 },
12500 "payment_date": {
12600 "format": "date-time",
1270n/a "nullable": true,
12800 "type": "string"
12900 },
13007 "piggy_bank_id": {
13107 "format": "int32",
1327n/a "nullable": true,
13307 "type": "integer",
134 "writeOnly": true
13507 },
13600 "piggy_bank_name": {
13700 "format": "string",
1380n/a "nullable": true,
13900 "type": "string",
140 "writeOnly": true
14100 },
14220 "process_date": {
14310 "format": "date-time",
1442n/a "nullable": true,
14520 "type": "string"
14620 },
14720 "reconciled": {
14820 "type": "boolean"
14920 },
15010 "sepa_batch_id": {
15100 "format": "string",
1521n/a "nullable": true,
15310 "type": "string"
15410 },
15500 "sepa_cc": {
15600 "format": "string",
1570n/a "nullable": true,
15800 "type": "string"
15900 },
16010 "sepa_ci": {
16100 "format": "string",
1621n/a "nullable": true,
16310 "type": "string"
16410 },
16500 "sepa_country": {
16600 "format": "string",
1670n/a "nullable": true,
16800 "type": "string"
16900 },
17000 "sepa_ct_id": {
17100 "format": "string",
1720n/a "nullable": true,
17300 "type": "string"
17400 },
17520 "sepa_ct_op": {
17600 "format": "string",
1772n/a "nullable": true,
17820 "type": "string"
17920 },
18000 "sepa_db": {
18100 "format": "string",
1820n/a "nullable": true,
18300 "type": "string"
18400 },
18500 "sepa_ep": {
18600 "format": "string",
1870n/a "nullable": true,
18800 "type": "string"
18900 },
19010 "source_id": {
19100 "format": "string",
1921n/a "nullable": true,
19310 "type": "string"
19410 },
19530 "source_name": {
19600 "format": "string",
1973n/a "nullable": true,
19830 "type": "string"
19930 },
20000 "tags": {
20100 "items": {
20200 "format": "string",
20300 "type": "string"
20400 },
2050n/a "nullable": true,
20600 "type": "array"
20700 },
20870 "type": {
21070 }
21107 },
21270 "required": [
21370 "amount",
21470 "date",
21570 "description",
21670 "type"
21770 ],
21870 "type": "object"
21907}
TransactionTypeProperty0 of 4 keywords
170{
270 "enum": [
31n/a "withdrawal",
42n/a "deposit",
51n/a "transfer",
61n/a "reconciliation",
72n/a "opening balance"
870 ],
900 "format": "string",
1070 "type": "string"
1170}
application/x-www-form-urlencoded5 / 137
TransactionStore
1011{
251 "properties": {
350 "apply_rules": {
450 "type": "boolean"
550 },
660 "error_if_duplicate_hash": {
760 "type": "boolean"
860 },
960 "fire_webhooks": {
1060 "type": "boolean"
1160 },
1260 "group_title": {
1300 "format": "string",
146n/a "nullable": true,
156n/a "type": "string"
1660 },
1701 "transactions": {
1801 "items": {
2001 },
2110 "type": "array"
2201 }
2351 },
24110 "required": [
25110 "transactions"
26110 ],
2711n/a "type": "object"
28011}
Referenced Components (2)0 of 129 keywords
TransactionSplitStore0 of 125 keywords
107{
200 "properties": {
300 "amount": {
400 "format": "amount",
500 "type": "string"
600 },
700 "bill_id": {
800 "format": "string",
90n/a "nullable": true,
1000 "type": "string"
1100 },
1200 "bill_name": {
1300 "format": "string",
140n/a "nullable": true,
1500 "type": "string"
1600 },
1700 "book_date": {
1800 "format": "date-time",
190n/a "nullable": true,
2000 "type": "string"
2100 },
2200 "budget_id": {
2300 "format": "string",
240n/a "nullable": true,
2500 "type": "string"
2600 },
2700 "budget_name": {
2800 "format": "string",
290n/a "nullable": true,
3000 "type": "string"
3100 },
3200 "category_id": {
3300 "format": "string",
340n/a "nullable": true,
3500 "type": "string"
3600 },
3700 "category_name": {
3800 "format": "string",
390n/a "nullable": true,
4000 "type": "string"
4100 },
4200 "currency_code": {
4300 "format": "string",
440n/a "nullable": true,
4500 "type": "string"
4600 },
4700 "currency_id": {
4800 "format": "string",
490n/a "nullable": true,
5000 "type": "string"
5100 },
5200 "date": {
5300 "format": "date-time",
5400 "type": "string"
5500 },
5600 "description": {
5700 "format": "string",
5800 "type": "string"
5900 },
6000 "destination_id": {
6100 "format": "string",
620n/a "nullable": true,
6300 "type": "string"
6400 },
6500 "destination_name": {
6600 "format": "string",
670n/a "nullable": true,
6800 "type": "string"
6900 },
7000 "due_date": {
7100 "format": "date-time",
720n/a "nullable": true,
7300 "type": "string"
7400 },
7500 "external_id": {
7600 "format": "string",
770n/a "nullable": true,
7800 "type": "string"
7900 },
8000 "external_url": {
8100 "format": "string",
820n/a "nullable": true,
8300 "type": "string"
8400 },
8500 "foreign_amount": {
8600 "format": "amount",
870n/a "nullable": true,
8800 "type": "string"
8900 },
9000 "foreign_currency_code": {
9100 "format": "string",
920n/a "nullable": true,
9300 "type": "string"
9400 },
9500 "foreign_currency_id": {
9600 "format": "string",
970n/a "nullable": true,
9800 "type": "string"
9900 },
10000 "interest_date": {
10100 "format": "date-time",
1020n/a "nullable": true,
10300 "type": "string"
10400 },
10500 "internal_reference": {
10600 "format": "string",
1070n/a "nullable": true,
10800 "type": "string"
10900 },
11000 "invoice_date": {
11100 "format": "date-time",
1120n/a "nullable": true,
11300 "type": "string"
11400 },
11500 "notes": {
11600 "format": "string",
1170n/a "nullable": true,
11800 "type": "string"
11900 },
12000 "order": {
12100 "format": "int32",
1220n/a "nullable": true,
12300 "type": "integer"
12400 },
12500 "payment_date": {
12600 "format": "date-time",
1270n/a "nullable": true,
12800 "type": "string"
12900 },
13000 "piggy_bank_id": {
13100 "format": "int32",
1320n/a "nullable": true,
13300 "type": "integer",
134 "writeOnly": true
13500 },
13600 "piggy_bank_name": {
13700 "format": "string",
1380n/a "nullable": true,
13900 "type": "string",
140 "writeOnly": true
14100 },
14200 "process_date": {
14300 "format": "date-time",
1440n/a "nullable": true,
14500 "type": "string"
14600 },
14700 "reconciled": {
14800 "type": "boolean"
14900 },
15000 "sepa_batch_id": {
15100 "format": "string",
1520n/a "nullable": true,
15300 "type": "string"
15400 },
15500 "sepa_cc": {
15600 "format": "string",
1570n/a "nullable": true,
15800 "type": "string"
15900 },
16000 "sepa_ci": {
16100 "format": "string",
1620n/a "nullable": true,
16300 "type": "string"
16400 },
16500 "sepa_country": {
16600 "format": "string",
1670n/a "nullable": true,
16800 "type": "string"
16900 },
17000 "sepa_ct_id": {
17100 "format": "string",
1720n/a "nullable": true,
17300 "type": "string"
17400 },
17500 "sepa_ct_op": {
17600 "format": "string",
1770n/a "nullable": true,
17800 "type": "string"
17900 },
18000 "sepa_db": {
18100 "format": "string",
1820n/a "nullable": true,
18300 "type": "string"
18400 },
18500 "sepa_ep": {
18600 "format": "string",
1870n/a "nullable": true,
18800 "type": "string"
18900 },
19000 "source_id": {
19100 "format": "string",
1920n/a "nullable": true,
19300 "type": "string"
19400 },
19500 "source_name": {
19600 "format": "string",
1970n/a "nullable": true,
19800 "type": "string"
19900 },
20000 "tags": {
20100 "items": {
20200 "format": "string",
20300 "type": "string"
20400 },
2050n/a "nullable": true,
20600 "type": "array"
20700 },
20800 "type": {
21000 }
21100 },
21200 "required": [
21300 "amount",
21400 "date",
21500 "description",
21600 "type"
21700 ],
21807 "type": "object"
21907}
TransactionTypeProperty0 of 4 keywords
100{
200 "enum": [
30n/a "withdrawal",
40n/a "deposit",
50n/a "transfer",
60n/a "reconciliation",
70n/a "opening balance"
800 ],
900 "format": "string",
1000 "type": "string"
1100}
Responses
codedescriptionhitsavg
200New transaction stored(s), result in response.75616ms
400Bad request308ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41518ms
Examples
Body: application/json
falseTransactionStore.apply_rules
falseTransactionStore.error_if_duplicate_hash
trueTransactionStore.fire_webhooks
trueTransactionStore.fire_webhooks
"Split transaction title."TransactionStore.group_title
"123.45"TransactionSplitStore.amount
"112"TransactionSplitStore.bill_id
"Monthly rent"TransactionSplitStore.bill_name
"4"TransactionSplitStore.budget_id
"Groceries"TransactionSplitStore.budget_name
"43"TransactionSplitStore.category_id
"Groceries"TransactionSplitStore.category_name
"EUR"TransactionSplitStore.currency_code
"12"TransactionSplitStore.currency_id
"2026-10-01T00:00:00+00:00"TransactionSplitStore.date
"Vegetables"TransactionSplitStore.description
"2"TransactionSplitStore.destination_id
"Buy and Large"TransactionSplitStore.destination_name
"123.45"TransactionSplitStore.foreign_amount
"USD"TransactionSplitStore.foreign_currency_code
"17"TransactionSplitStore.foreign_currency_id
"Some example notes"TransactionSplitStore.notes
0TransactionSplitStore.order
falseTransactionSplitStore.reconciled
"2"TransactionSplitStore.source_id
"Checking account"TransactionSplitStore.source_name
nullTransactionSplitStore.tags
"Barbecue preparation"TransactionSplitStore.tags
"withdrawal"TransactionTypeProperty
Body: application/x-www-form-urlencoded
falseTransactionStore.apply_rules
falseTransactionStore.error_if_duplicate_hash
trueTransactionStore.fire_webhooks
trueTransactionStore.fire_webhooks
"Split transaction title."TransactionStore.group_title
"123.45"TransactionSplitStore.amount
"112"TransactionSplitStore.bill_id
"Monthly rent"TransactionSplitStore.bill_name
"4"TransactionSplitStore.budget_id
"Groceries"TransactionSplitStore.budget_name
"43"TransactionSplitStore.category_id
"Groceries"TransactionSplitStore.category_name
"EUR"TransactionSplitStore.currency_code
"12"TransactionSplitStore.currency_id
"2026-10-01T00:00:00+00:00"TransactionSplitStore.date
"Vegetables"TransactionSplitStore.description
"2"TransactionSplitStore.destination_id
"Buy and Large"TransactionSplitStore.destination_name
"123.45"TransactionSplitStore.foreign_amount
"USD"TransactionSplitStore.foreign_currency_code
"17"TransactionSplitStore.foreign_currency_id
"Some example notes"TransactionSplitStore.notes
0TransactionSplitStore.order
falseTransactionSplitStore.reconciled
"2"TransactionSplitStore.source_id
"Checking account"TransactionSplitStore.source_name
nullTransactionSplitStore.tags
"Barbecue preparation"TransactionSplitStore.tags
"withdrawal"TransactionTypeProperty
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path Parameters
id1 / 1
#validinvalidschema
168n/a{
268n/a "type": "string"
368n/a}
Headers
X-Trace-Id2 / 2
12329{
22329 "format": "uuid",
352n/a "type": "string"
42329}
Responses
codedescriptionhitsavg
204Transaction deleted.232ms
400Bad request157ms
401Unauthenticated0never seen
404Page not found5114ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK216ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1375n/a{
2375n/a "type": "string"
3375n/a}
Headers
X-Trace-Id2 / 2
118154{
218154 "format": "uuid",
3235n/a "type": "string"
418154}
Responses
codedescriptionhitsavg
200The requested transaction.5316ms
400Bad request378ms
401Unauthenticated0never seen
404Page not found33815ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1976n/a{
2976n/a "type": "string"
3976n/a}
Headers
X-Trace-Id2 / 2
179836{
279836 "format": "uuid",
3834n/a "type": "string"
479836}
Body
application/json99 / 133
TransactionUpdate
1346231{
2267226 "properties": {
34675 "apply_rules": {
44675 "type": "boolean"
54675 },
64585 "fire_webhooks": {
74585 "type": "boolean"
84585 },
94554 "group_title": {
1000 "format": "string",
11459n/a "nullable": true,
124554 "type": "string"
134554 },
14237212 "transactions": {
15237207 "items": {
17237207 },
184445 "type": "array"
19237212 }
20267226 },
215725 "type": "object"
22346231}
Referenced Components (2)93 of 126 keywords
TransactionSplitUpdate90 of 122 keywords
1205208{
2200203 "properties": {
33435 "amount": {
400 "format": "amount",
53435 "type": "string"
63435 },
73424 "bill_id": {
800 "format": "string",
9346n/a "nullable": true,
103424 "type": "string"
113424 },
123404 "bill_name": {
1300 "format": "string",
14344n/a "nullable": true,
153404 "type": "string"
163404 },
173376 "book_date": {
183352 "format": "date-time",
19343n/a "nullable": true,
203394 "type": "string"
213376 },
223384 "budget_id": {
2300 "format": "string",
24342n/a "nullable": true,
253384 "type": "string"
263384 },
273374 "category_id": {
2800 "format": "string",
29341n/a "nullable": true,
303374 "type": "string"
313374 },
323384 "category_name": {
3300 "format": "string",
34342n/a "nullable": true,
353384 "type": "string"
363384 },
373364 "currency_code": {
3800 "format": "string",
39340n/a "nullable": true,
403364 "type": "string"
413364 },
423354 "currency_id": {
4300 "format": "string",
44339n/a "nullable": true,
453354 "type": "string"
463354 },
473326 "date": {
483321 "format": "date-time",
493335 "type": "string"
503326 },
513315 "description": {
5200 "format": "string",
533315 "type": "string"
543315 },
553324 "destination_iban": {
5600 "format": "string",
57336n/a "nullable": true,
583324 "type": "string"
593324 },
603304 "destination_id": {
6100 "format": "string",
62334n/a "nullable": true,
633304 "type": "string"
643304 },
653294 "destination_name": {
6600 "format": "string",
67333n/a "nullable": true,
683294 "type": "string"
693294 },
703296 "due_date": {
713262 "format": "date-time",
72335n/a "nullable": true,
733314 "type": "string"
743296 },
753274 "external_id": {
7600 "format": "string",
77331n/a "nullable": true,
783274 "type": "string"
793274 },
803274 "external_url": {
8100 "format": "string",
82331n/a "nullable": true,
833274 "type": "string"
843274 },
853254 "foreign_amount": {
8600 "format": "amount",
87329n/a "nullable": true,
883254 "type": "string"
893254 },
903246 "foreign_currency_code": {
9100 "format": "string",
92330n/a "nullable": true,
933246 "type": "string"
943246 },
953244 "foreign_currency_id": {
9600 "format": "string",
97328n/a "nullable": true,
983244 "type": "string"
993244 },
1003216 "interest_date": {
1013182 "format": "date-time",
102327n/a "nullable": true,
1033234 "type": "string"
1043216 },
1053224 "internal_reference": {
10600 "format": "string",
107326n/a "nullable": true,
1083224 "type": "string"
1093224 },
1103186 "invoice_date": {
1113162 "format": "date-time",
112324n/a "nullable": true,
1133204 "type": "string"
1143186 },
1153204 "notes": {
11600 "format": "string",
117324n/a "nullable": true,
1183204 "type": "string"
1193204 },
1203148 "order": {
1213148 "format": "int32",
122322n/a "nullable": true,
1233175 "type": "integer"
1243148 },
1253156 "payment_date": {
1263132 "format": "date-time",
127321n/a "nullable": true,
1283174 "type": "string"
1293156 },
1303146 "process_date": {
1313122 "format": "date-time",
132320n/a "nullable": true,
1333164 "type": "string"
1343146 },
1353145 "reconciled": {
1363145 "type": "boolean"
1373145 },
1383154 "sepa_batch_id": {
13900 "format": "string",
140319n/a "nullable": true,
1413154 "type": "string"
1423154 },
1433134 "sepa_cc": {
14400 "format": "string",
145317n/a "nullable": true,
1463134 "type": "string"
1473134 },
1483154 "sepa_ci": {
14900 "format": "string",
150319n/a "nullable": true,
1513154 "type": "string"
1523154 },
1533117 "sepa_country": {
15400 "format": "string",
155318n/a "nullable": true,
1563117 "type": "string"
1573117 },
1583104 "sepa_ct_id": {
15900 "format": "string",
160314n/a "nullable": true,
1613104 "type": "string"
1623104 },
1633114 "sepa_ct_op": {
16400 "format": "string",
165315n/a "nullable": true,
1663114 "type": "string"
1673114 },
1683094 "sepa_db": {
16900 "format": "string",
170313n/a "nullable": true,
1713094 "type": "string"
1723094 },
1733084 "sepa_ep": {
17400 "format": "string",
175312n/a "nullable": true,
1763084 "type": "string"
1773084 },
1783064 "source_iban": {
17900 "format": "string",
180310n/a "nullable": true,
1813064 "type": "string"
1823064 },
1833054 "source_id": {
18400 "format": "string",
185309n/a "nullable": true,
1863054 "type": "string"
1873054 },
1883066 "source_name": {
18900 "format": "string",
190312n/a "nullable": true,
1913066 "type": "string"
1923066 },
19329710 "tags": {
1942966 "items": {
19500 "format": "string",
19627 "type": "string"
1972966 },
198307n/a "nullable": true,
1993034 "type": "array"
20029710 },
2013035 "transaction_journal_id": {
20200 "format": "string",
2033035 "type": "string"
2043035 },
2053006 "type": {
2073006 }
208200203 },
2094085 "type": "object"
210205208}
TransactionTypeProperty3 of 4 keywords
13006{
23006 "enum": [
3295n/a "withdrawal",
41n/a "deposit",
51n/a "transfer",
62n/a "reconciliation",
71n/a "opening balance"
83006 ],
900 "format": "string",
103015 "type": "string"
113006}
application/x-www-form-urlencoded6 / 133
TransactionUpdate
178248{
258248 "properties": {
32812 "apply_rules": {
42812 "type": "boolean"
52812 },
62762 "fire_webhooks": {
72762 "type": "boolean"
82762 },
92820 "group_title": {
1000 "format": "string",
11282n/a "nullable": true,
12282n/a "type": "string"
132820 },
140244 "transactions": {
150244 "items": {
170244 },
182440 "type": "array"
190244 }
2058248 },
21326n/a "type": "object"
2278248}
Referenced Components (2)0 of 126 keywords
TransactionSplitUpdate0 of 122 keywords
107165{
200 "properties": {
300 "amount": {
400 "format": "amount",
500 "type": "string"
600 },
700 "bill_id": {
800 "format": "string",
90n/a "nullable": true,
1000 "type": "string"
1100 },
1200 "bill_name": {
1300 "format": "string",
140n/a "nullable": true,
1500 "type": "string"
1600 },
1700 "book_date": {
1800 "format": "date-time",
190n/a "nullable": true,
2000 "type": "string"
2100 },
2200 "budget_id": {
2300 "format": "string",
240n/a "nullable": true,
2500 "type": "string"
2600 },
2700 "category_id": {
2800 "format": "string",
290n/a "nullable": true,
3000 "type": "string"
3100 },
3200 "category_name": {
3300 "format": "string",
340n/a "nullable": true,
3500 "type": "string"
3600 },
3700 "currency_code": {
3800 "format": "string",
390n/a "nullable": true,
4000 "type": "string"
4100 },
4200 "currency_id": {
4300 "format": "string",
440n/a "nullable": true,
4500 "type": "string"
4600 },
4700 "date": {
4800 "format": "date-time",
4900 "type": "string"
5000 },
5100 "description": {
5200 "format": "string",
5300 "type": "string"
5400 },
5500 "destination_iban": {
5600 "format": "string",
570n/a "nullable": true,
5800 "type": "string"
5900 },
6000 "destination_id": {
6100 "format": "string",
620n/a "nullable": true,
6300 "type": "string"
6400 },
6500 "destination_name": {
6600 "format": "string",
670n/a "nullable": true,
6800 "type": "string"
6900 },
7000 "due_date": {
7100 "format": "date-time",
720n/a "nullable": true,
7300 "type": "string"
7400 },
7500 "external_id": {
7600 "format": "string",
770n/a "nullable": true,
7800 "type": "string"
7900 },
8000 "external_url": {
8100 "format": "string",
820n/a "nullable": true,
8300 "type": "string"
8400 },
8500 "foreign_amount": {
8600 "format": "amount",
870n/a "nullable": true,
8800 "type": "string"
8900 },
9000 "foreign_currency_code": {
9100 "format": "string",
920n/a "nullable": true,
9300 "type": "string"
9400 },
9500 "foreign_currency_id": {
9600 "format": "string",
970n/a "nullable": true,
9800 "type": "string"
9900 },
10000 "interest_date": {
10100 "format": "date-time",
1020n/a "nullable": true,
10300 "type": "string"
10400 },
10500 "internal_reference": {
10600 "format": "string",
1070n/a "nullable": true,
10800 "type": "string"
10900 },
11000 "invoice_date": {
11100 "format": "date-time",
1120n/a "nullable": true,
11300 "type": "string"
11400 },
11500 "notes": {
11600 "format": "string",
1170n/a "nullable": true,
11800 "type": "string"
11900 },
12000 "order": {
12100 "format": "int32",
1220n/a "nullable": true,
12300 "type": "integer"
12400 },
12500 "payment_date": {
12600 "format": "date-time",
1270n/a "nullable": true,
12800 "type": "string"
12900 },
13000 "process_date": {
13100 "format": "date-time",
1320n/a "nullable": true,
13300 "type": "string"
13400 },
13500 "reconciled": {
13600 "type": "boolean"
13700 },
13800 "sepa_batch_id": {
13900 "format": "string",
1400n/a "nullable": true,
14100 "type": "string"
14200 },
14300 "sepa_cc": {
14400 "format": "string",
1450n/a "nullable": true,
14600 "type": "string"
14700 },
14800 "sepa_ci": {
14900 "format": "string",
1500n/a "nullable": true,
15100 "type": "string"
15200 },
15300 "sepa_country": {
15400 "format": "string",
1550n/a "nullable": true,
15600 "type": "string"
15700 },
15800 "sepa_ct_id": {
15900 "format": "string",
1600n/a "nullable": true,
16100 "type": "string"
16200 },
16300 "sepa_ct_op": {
16400 "format": "string",
1650n/a "nullable": true,
16600 "type": "string"
16700 },
16800 "sepa_db": {
16900 "format": "string",
1700n/a "nullable": true,
17100 "type": "string"
17200 },
17300 "sepa_ep": {
17400 "format": "string",
1750n/a "nullable": true,
17600 "type": "string"
17700 },
17800 "source_iban": {
17900 "format": "string",
1800n/a "nullable": true,
18100 "type": "string"
18200 },
18300 "source_id": {
18400 "format": "string",
1850n/a "nullable": true,
18600 "type": "string"
18700 },
18800 "source_name": {
18900 "format": "string",
1900n/a "nullable": true,
19100 "type": "string"
19200 },
19300 "tags": {
19400 "items": {
19500 "format": "string",
19600 "type": "string"
19700 },
1980n/a "nullable": true,
19900 "type": "array"
20000 },
20100 "transaction_journal_id": {
20200 "format": "string",
20300 "type": "string"
20400 },
20500 "type": {
20700 }
20800 },
20907165 "type": "object"
21007165}
TransactionTypeProperty0 of 4 keywords
100{
200 "enum": [
30n/a "withdrawal",
40n/a "deposit",
50n/a "transfer",
60n/a "reconciliation",
70n/a "opening balance"
800 ],
900 "format": "string",
1000 "type": "string"
1100}
Responses
codedescriptionhitsavg
200Updated transaction stored, result in response4717ms
400Bad request218ms
401Unauthenticated0never seen
404Page not found95215ms
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41537ms
Examples
Body: application/json
falseTransactionUpdate.apply_rules
trueTransactionUpdate.fire_webhooks
trueTransactionUpdate.fire_webhooks
"Split transaction title."TransactionUpdate.group_title
"123.45"TransactionSplitUpdate.amount
"111"TransactionSplitUpdate.bill_id
"Monthly rent"TransactionSplitUpdate.bill_name
"4"TransactionSplitUpdate.budget_id
"43"TransactionSplitUpdate.category_id
"Groceries"TransactionSplitUpdate.category_name
"EUR"TransactionSplitUpdate.currency_code
"12"TransactionSplitUpdate.currency_id
"2026-10-01T00:00:00+00:00"TransactionSplitUpdate.date
"Vegetables"TransactionSplitUpdate.description
"NL02ABNA0123456789"TransactionSplitUpdate.destination_iban
"2"TransactionSplitUpdate.destination_id
"Buy and Large"TransactionSplitUpdate.destination_name
"123.45"TransactionSplitUpdate.foreign_amount
"USD"TransactionSplitUpdate.foreign_currency_code
"17"TransactionSplitUpdate.foreign_currency_id
"Some example notes"TransactionSplitUpdate.notes
0TransactionSplitUpdate.order
falseTransactionSplitUpdate.reconciled
"NL02ABNA0123456789"TransactionSplitUpdate.source_iban
"2"TransactionSplitUpdate.source_id
"Checking account"TransactionSplitUpdate.source_name
nullTransactionSplitUpdate.tags
"Barbecue preparation"TransactionSplitUpdate.tags
"123"TransactionSplitUpdate.transaction_journal_id
"withdrawal"TransactionTypeProperty
Body: application/x-www-form-urlencoded
falseTransactionUpdate.apply_rules
trueTransactionUpdate.fire_webhooks
trueTransactionUpdate.fire_webhooks
"Split transaction title."TransactionUpdate.group_title
"123.45"TransactionSplitUpdate.amount
"111"TransactionSplitUpdate.bill_id
"Monthly rent"TransactionSplitUpdate.bill_name
"4"TransactionSplitUpdate.budget_id
"43"TransactionSplitUpdate.category_id
"Groceries"TransactionSplitUpdate.category_name
"EUR"TransactionSplitUpdate.currency_code
"12"TransactionSplitUpdate.currency_id
"2026-10-01T00:00:00+00:00"TransactionSplitUpdate.date
"Vegetables"TransactionSplitUpdate.description
"NL02ABNA0123456789"TransactionSplitUpdate.destination_iban
"2"TransactionSplitUpdate.destination_id
"Buy and Large"TransactionSplitUpdate.destination_name
"123.45"TransactionSplitUpdate.foreign_amount
"USD"TransactionSplitUpdate.foreign_currency_code
"17"TransactionSplitUpdate.foreign_currency_id
"Some example notes"TransactionSplitUpdate.notes
0TransactionSplitUpdate.order
falseTransactionSplitUpdate.reconciled
"NL02ABNA0123456789"TransactionSplitUpdate.source_iban
"2"TransactionSplitUpdate.source_id
"Checking account"TransactionSplitUpdate.source_name
nullTransactionSplitUpdate.tags
"Barbecue preparation"TransactionSplitUpdate.tags
"123"TransactionSplitUpdate.transaction_journal_id
"withdrawal"TransactionTypeProperty
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1379n/a{
2379n/a "type": "string"
3379n/a}
Query Parameters
limit2 / 2
116054{
216054 "format": "int32",
317737 "type": "integer"
416054}
page2 / 2
116744{
216744 "format": "int32",
319219 "type": "integer"
416744}
Headers
X-Trace-Id2 / 2
121935{
221935 "format": "uuid",
3254n/a "type": "string"
421935}
Responses
codedescriptionhitsavg
200A list of attachments15517ms
400Bad request278ms
401Unauthenticated0never seen
404Page not found25115ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
Path Parameters
id1 / 1
#validinvalidschema
1399n/a{
2399n/a "type": "string"
3399n/a}
Query Parameters
limit2 / 2
118460{
218460 "format": "int32",
322024 "type": "integer"
418460}
page2 / 2
116761{
216761 "format": "int32",
320127 "type": "integer"
416761}
Headers
X-Trace-Id2 / 2
126428{
226428 "format": "uuid",
3292n/a "type": "string"
426428}
Responses
codedescriptionhitsavg
200A list of piggy bank events.12417ms
400Bad request228ms
401Unauthenticated0never seen
404Page not found30515ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Query
10limit
1page
user_groups 3 operations 2 covered 1 partial 0 uncovered 0 not measured 70% #
Query Parameters
limit2 / 2
#validinvalidschema
111320{
211320 "format": "int32",
311617 "type": "integer"
411320}
page2 / 2
110320{
210320 "format": "int32",
310716 "type": "integer"
410320}
Headers
X-Trace-Id2 / 2
121847{
221847 "format": "uuid",
3265n/a "type": "string"
421847}
Responses
codedescriptionhitsavg
200A list of user groups.48917ms
400Bad request418ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
Path Parameters
id1 / 1
#validinvalidschema
1610n/a{
2610n/a "type": "string"
3610n/a}
Headers
X-Trace-Id2 / 2
124347{
224347 "format": "uuid",
3290n/a "type": "string"
424347}
Responses
codedescriptionhitsavg
200The requested user group34017ms
400Bad request268ms
401Unauthenticated0never seen
404Page not found25415ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1222n/a{
2222n/a "type": "string"
3222n/a}
Headers
X-Trace-Id2 / 2
119128{
219128 "format": "uuid",
3219n/a "type": "string"
419128}
Body
application/json5 / 9
UserGroupUpdate
1968{
21004 "properties": {
3501 "primary_currency_code": {
400 "format": "string",
5501 "type": "string"
6501 },
7921 "primary_currency_id": {
800 "format": "string",
9921 "type": "string"
10921 },
11982 "title": {
1200 "format": "string",
13982 "type": "string"
14982 }
151004 },
161004 "required": [
171004 "title"
181004 ],
191040 "type": "object"
20968}
application/x-www-form-urlencoded4 / 9
UserGroupUpdate
11150{
21150 "properties": {
3370 "primary_currency_code": {
400 "format": "string",
537n/a "type": "string"
6370 },
7980 "primary_currency_id": {
800 "format": "string",
998n/a "type": "string"
10980 },
111150 "title": {
1200 "format": "string",
13115n/a "type": "string"
141150 }
151150 },
161150 "required": [
171150 "title"
181150 ],
19115n/a "type": "object"
201150}
Responses
codedescriptionhitsavg
200Updated user group is stored, result is in the response23520ms
400Bad request268ms
401Unauthenticated0never seen
404Page not found13215ms
422Validation error. The body will have the exact details.0never seen
500Internal exception819ms
Undocumented - not in spec
codedescriptionhitsavg
41538ms
Examples
Body: application/json
"EUR"UserGroupUpdate.primary_currency_code
"1"UserGroupUpdate.primary_currency_id
"New user group title"UserGroupUpdate.title
Body: application/x-www-form-urlencoded
"EUR"UserGroupUpdate.primary_currency_code
"1"UserGroupUpdate.primary_currency_id
"New user group title"UserGroupUpdate.title
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"1"id
users 5 operations 3 covered 2 partial 0 uncovered 0 not measured 77% #
Query Parameters
limit2 / 2
#validinvalidschema
117239{
217239 "format": "int32",
318427 "type": "integer"
417239}
page2 / 2
116048{
216048 "format": "int32",
318226 "type": "integer"
416048}
Headers
X-Trace-Id2 / 2
118537{
218537 "format": "uuid",
3222n/a "type": "string"
418537}
Responses
codedescriptionhitsavg
200A list of users.41918ms
400Bad request258ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
Headers
X-Trace-Id2 / 2
#validinvalidschema
119050{
219050 "format": "uuid",
3240n/a "type": "string"
419050}
Body
application/json6 / 16
User
1212{
2212 "properties": {
3140 "blocked": {
4140 "type": "boolean"
5140 },
6130 "blocked_code": {
8130 },
9230 "email": {
10230 "format": "email",
11230 "type": "string"
12230 },
13142 "role": {
15142 }
16212 },
17230 "required": [
18230 "email"
19230 ],
20230 "type": "object"
21212}
Referenced Components (2)5 of 10 keywords
UserBlockedCodeProperty1 of 5 keywords
1130{
2130 "enum": [
31n/a "email_changed",
412n/a null
5130 ],
600 "format": "string",
713n/a "nullable": true,
8130 "type": "string"
9130}
UserRoleProperty4 of 5 keywords
1142{
2142 "enum": [
31n/a "owner",
41n/a "demo",
512n/a null
6142 ],
700 "format": "string",
816n/a "nullable": true,
9142 "type": "string"
10142}
application/x-www-form-urlencoded12 / 16
User
1184{
2184 "properties": {
330 "blocked": {
430 "type": "boolean"
530 },
633 "blocked_code": {
833 },
9211 "email": {
10211 "format": "email",
1122n/a "type": "string"
12211 },
1342 "role": {
1542 }
16184 },
17220 "required": [
18220 "email"
19220 ],
2022n/a "type": "object"
21184}
Referenced Components (2)8 of 10 keywords
UserBlockedCodeProperty4 of 5 keywords
133{
233 "enum": [
33n/a "email_changed",
40n/a null
533 ],
600 "format": "string",
76n/a "nullable": true,
86n/a "type": "string"
933}
UserRoleProperty4 of 5 keywords
142{
242 "enum": [
33n/a "owner",
41n/a "demo",
50n/a null
642 ],
700 "format": "string",
86n/a "nullable": true,
96n/a "type": "string"
1042}
Responses
codedescriptionhitsavg
200New user stored, result in response.34624ms
400Bad request268ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41537ms
Examples
Body: application/json
falseUser.blocked
"email_changed"UserBlockedCodeProperty
"james@firefly-iii.org"User.email
"owner"UserRoleProperty
Body: application/x-www-form-urlencoded
falseUser.blocked
"email_changed"UserBlockedCodeProperty
"james@firefly-iii.org"User.email
"owner"UserRoleProperty
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path Parameters
id1 / 1
#validinvalidschema
1147n/a{
2147n/a "type": "string"
3147n/a}
Headers
X-Trace-Id2 / 2
14534{
24534 "format": "uuid",
379n/a "type": "string"
44534}
Responses
codedescriptionhitsavg
204User deleted.224ms
400Bad request238ms
401Unauthenticated0never seen
404Page not found12214ms
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK215ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1393n/a{
2393n/a "type": "string"
3393n/a}
Headers
X-Trace-Id2 / 2
114155{
214155 "format": "uuid",
3196n/a "type": "string"
414155}
Responses
codedescriptionhitsavg
200The requested user.25417ms
400Bad request358ms
401Unauthenticated0never seen
404Page not found10915ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1351n/a{
2351n/a "type": "string"
3351n/a}
Headers
X-Trace-Id2 / 2
114023{
214023 "format": "uuid",
3163n/a "type": "string"
414023}
Body
application/json14 / 16
User
110639{
210826 "properties": {
3665 "blocked": {
4665 "type": "boolean"
5665 },
6655 "blocked_code": {
8655 },
912111 "email": {
101266 "format": "email",
111275 "type": "string"
1212111 },
13635 "role": {
15635 }
1610826 },
171327 "required": [
181327 "email"
191327 ],
201396 "type": "object"
2110639}
Referenced Components (2)8 of 10 keywords
UserBlockedCodeProperty4 of 5 keywords
1655{
2655 "enum": [
34n/a "email_changed",
461n/a null
5655 ],
600 "format": "string",
770n/a "nullable": true,
8664 "type": "string"
9655}
UserRoleProperty4 of 5 keywords
1635{
2635 "enum": [
32n/a "owner",
41n/a "demo",
560n/a null
6635 ],
700 "format": "string",
868n/a "nullable": true,
9644 "type": "string"
10635}
application/x-www-form-urlencoded14 / 16
User
14344{
24541 "properties": {
3452 "blocked": {
4452 "type": "boolean"
5452 },
6632 "blocked_code": {
8632 },
9776 "email": {
10776 "format": "email",
1183n/a "type": "string"
12776 },
131131 "role": {
151131 }
164541 },
17834 "required": [
18834 "email"
19834 ],
2087n/a "type": "object"
214344}
Referenced Components (2)8 of 10 keywords
UserBlockedCodeProperty4 of 5 keywords
1632{
2632 "enum": [
36n/a "email_changed",
40n/a null
5632 ],
600 "format": "string",
738n/a "nullable": true,
838n/a "type": "string"
9632}
UserRoleProperty4 of 5 keywords
11131{
21131 "enum": [
39n/a "owner",
42n/a "demo",
50n/a null
61131 ],
700 "format": "string",
842n/a "nullable": true,
942n/a "type": "string"
101131}
Responses
codedescriptionhitsavg
200Updated user stored, result in response10318ms
400Bad request188ms
401Unauthenticated0never seen
404Page not found24614ms
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41538ms
Examples
Body: application/json
falseUser.blocked
"email_changed"UserBlockedCodeProperty
"james@firefly-iii.org"User.email
"owner"UserRoleProperty
Body: application/x-www-form-urlencoded
falseUser.blocked
"email_changed"UserBlockedCodeProperty
"james@firefly-iii.org"User.email
"owner"UserRoleProperty
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
webhooks 13 operations 9 covered 4 partial 0 uncovered 0 not measured 45% #
Query Parameters
limit2 / 2
#validinvalidschema
119369{
219369 "format": "int32",
321448 "type": "integer"
419369}
page2 / 2
115572{
215572 "format": "int32",
317750 "type": "integer"
415572}
Headers
X-Trace-Id2 / 2
119339{
219339 "format": "uuid",
3232n/a "type": "string"
419339}
Responses
codedescriptionhitsavg
200A list of webhooks.116ms
400Bad request308ms
401Unauthenticated0never seen
404Page not found45917ms
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Query
10limit
1page
Headers
X-Trace-Id2 / 2
#validinvalidschema
138938{
238938 "format": "uuid",
3427n/a "type": "string"
438938}
Body
application/json15 / 35
WebhookStore
19717{
29816 "properties": {
3562 "active": {
4562 "type": "boolean"
5562 },
6546 "deliveries": {
8546 },
9511 "responses": {
11511 },
121076 "title": {
1300 "format": "string",
141076 "type": "string"
151076 },
16587 "triggers": {
18587 },
191113 "url": {
2000 "format": "string",
21 "readOnly": false,
221113 "type": "string"
231113 }
249816 },
251131 "required": [
261131 "title",
271140 "trigger",
281140 "response",
291140 "delivery",
301140 "url"
311131 ],
321140 "type": "object"
339717}
Referenced Components (6)10 of 27 keywords
WebhookDelivery2 of 5 keywords
1544{
2544 "enum": [
354n/a "JSON"
4544 ],
500 "format": "string",
6580 "nullable": false,
7580 "type": "string"
8544}
WebhookDeliveryArray2 of 4 keywords
1546{
2544 "items": {
4544 },
5580 "maxItems": 1,
6580 "minItems": 1,
7582 "type": "array"
8546}
WebhookResponse2 of 5 keywords
1511{
2511 "enum": [
323n/a "TRANSACTIONS",
410n/a "ACCOUNTS",
52n/a "BUDGET",
67n/a "RELEVANT",
79n/a "NONE"
8511 ],
900 "format": "string",
10520 "nullable": false,
11520 "type": "string"
12511}
WebhookResponseArray1 of 4 keywords
1511{
2511 "items": {
4511 },
5520 "maxItems": 1,
6520 "minItems": 1,
7520 "type": "array"
8511}
WebhookTrigger2 of 5 keywords
110211{
210211 "enum": [
318n/a "ANY",
423n/a "STORE_TRANSACTION",
525n/a "UPDATE_TRANSACTION",
68n/a "DESTROY_TRANSACTION",
711n/a "STORE_BUDGET",
87n/a "UPDATE_BUDGET",
98n/a "DESTROY_BUDGET",
102n/a "STORE_UPDATE_BUDGET_LIMIT"
1110211 ],
1200 "format": "string",
131130 "nullable": false,
141130 "type": "string"
1510211}
WebhookTriggerArray1 of 4 keywords
1587{
2587 "items": {
4587 },
5650 "maxItems": 3,
6650 "minItems": 1,
7650 "type": "array"
8587}
application/x-www-form-urlencoded17 / 35
WebhookStore
13263{
2896 "properties": {
3620 "active": {
4620 "type": "boolean"
5620 },
6374 "deliveries": {
8374 },
9492 "responses": {
11492 },
12930 "title": {
1300 "format": "string",
1493n/a "type": "string"
15930 },
16503 "triggers": {
18503 },
19950 "url": {
2000 "format": "string",
21 "readOnly": false,
2295n/a "type": "string"
23950 }
24896 },
253560 "required": [
26932 "title",
277223 "trigger",
287124 "response",
295738 "delivery",
30950 "url"
313560 ],
3295n/a "type": "object"
333263}
Referenced Components (6)11 of 27 keywords
WebhookDelivery1 of 5 keywords
1560{
2560 "enum": [
356n/a "JSON"
4560 ],
500 "format": "string",
6560 "nullable": false,
756n/a "type": "string"
8560}
WebhookDeliveryArray1 of 4 keywords
1374{
2410 "items": {
4410 },
5374 "maxItems": 1,
6410 "minItems": 1,
7410 "type": "array"
8374}
WebhookResponse3 of 5 keywords
1492{
2492 "enum": [
37n/a "TRANSACTIONS",
44n/a "ACCOUNTS",
515n/a "BUDGET",
64n/a "RELEVANT",
719n/a "NONE"
8492 ],
900 "format": "string",
10510 "nullable": false,
1151n/a "type": "string"
12492}
WebhookResponseArray1 of 4 keywords
1492{
2492 "items": {
4492 },
5510 "maxItems": 1,
6510 "minItems": 1,
7510 "type": "array"
8492}
WebhookTrigger3 of 5 keywords
1902{
2902 "enum": [
35n/a "ANY",
415n/a "STORE_TRANSACTION",
517n/a "UPDATE_TRANSACTION",
69n/a "DESTROY_TRANSACTION",
710n/a "STORE_BUDGET",
813n/a "UPDATE_BUDGET",
913n/a "DESTROY_BUDGET",
108n/a "STORE_UPDATE_BUDGET_LIMIT"
11902 ],
1200 "format": "string",
13920 "nullable": false,
1492n/a "type": "string"
15902}
WebhookTriggerArray2 of 4 keywords
1503{
2512 "items": {
4512 },
5521 "maxItems": 3,
6530 "minItems": 1,
7530 "type": "array"
8503}
Responses
codedescriptionhitsavg
200New webhook stored, result in response.50216ms
400Bad request278ms
401Unauthenticated0never seen
404Page not found419ms
422Validation error. The body will have the exact details.0never seen
500Internal exception17818ms
Undocumented - not in spec
codedescriptionhitsavg
41518ms
Examples
Body: application/json
falseWebhookStore.active
[ "JSON" ]WebhookDeliveryArray
[ "JSON" ]WebhookDelivery
[ "TRANSACTIONS" ]WebhookResponseArray
"RELEVANT"WebhookResponse
"Update magic mirror on new transaction"WebhookStore.title
[ "STORE_TRANSACTION", "UPDATE_TRANSACTION" ]WebhookTriggerArray
"DESTROY_TRANSACTION"WebhookTrigger
"https://example.com"WebhookStore.url
Body: application/x-www-form-urlencoded
falseWebhookStore.active
[ "JSON" ]WebhookDeliveryArray
[ "JSON" ]WebhookDelivery
[ "TRANSACTIONS" ]WebhookResponseArray
"RELEVANT"WebhookResponse
"Update magic mirror on new transaction"WebhookStore.title
[ "STORE_TRANSACTION", "UPDATE_TRANSACTION" ]WebhookTriggerArray
"DESTROY_TRANSACTION"WebhookTrigger
"https://example.com"WebhookStore.url
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path Parameters
id1 / 1
#validinvalidschema
115n/a{
215n/a "type": "string"
315n/a}
Headers
X-Trace-Id2 / 2
12923{
22923 "format": "uuid",
352n/a "type": "string"
42923}
Responses
codedescriptionhitsavg
204Webhook deleted.0never seen
400Bad request157ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK8315ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
134n/a{
234n/a "type": "string"
334n/a}
Headers
X-Trace-Id2 / 2
129892{
229892 "format": "uuid",
3390n/a "type": "string"
429892}
Responses
codedescriptionhitsavg
200The requested webhook.77417ms
400Bad request348ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
126n/a{
226n/a "type": "string"
326n/a}
Headers
X-Trace-Id2 / 2
148351{
248351 "format": "uuid",
3534n/a "type": "string"
448351}
Body
application/json0 / 36
WebhookUpdate
1190{
2160 "properties": {
3140 "active": {
4140 "type": "boolean"
5140 },
6150 "deliveries": {
8150 },
9140 "responses": {
11140 },
12150 "secret": {
1300 "format": "string",
14150 "type": "string"
15150 },
16130 "title": {
1700 "format": "string",
18130 "type": "string"
19130 },
20150 "triggers": {
22150 },
23130 "url": {
2400 "format": "string",
25 "readOnly": false,
26130 "type": "string"
27130 }
28160 },
29190 "type": "object"
30190}
Referenced Components (6)0 of 27 keywords
WebhookDelivery0 of 5 keywords
1150{
2150 "enum": [
315n/a "JSON"
4150 ],
500 "format": "string",
6150 "nullable": false,
7150 "type": "string"
8150}
WebhookDeliveryArray0 of 4 keywords
1150{
2150 "items": {
4150 },
5150 "maxItems": 1,
6150 "minItems": 1,
7150 "type": "array"
8150}
WebhookResponse0 of 5 keywords
1140{
2140 "enum": [
312n/a "TRANSACTIONS",
40n/a "ACCOUNTS",
50n/a "BUDGET",
61n/a "RELEVANT",
71n/a "NONE"
8140 ],
900 "format": "string",
10140 "nullable": false,
11140 "type": "string"
12140}
WebhookResponseArray0 of 4 keywords
1140{
2140 "items": {
4140 },
5140 "maxItems": 1,
6140 "minItems": 1,
7140 "type": "array"
8140}
WebhookTrigger0 of 5 keywords
1280{
2280 "enum": [
31n/a "ANY",
413n/a "STORE_TRANSACTION",
512n/a "UPDATE_TRANSACTION",
60n/a "DESTROY_TRANSACTION",
71n/a "STORE_BUDGET",
80n/a "UPDATE_BUDGET",
91n/a "DESTROY_BUDGET",
100n/a "STORE_UPDATE_BUDGET_LIMIT"
11280 ],
1200 "format": "string",
13280 "nullable": false,
14280 "type": "string"
15280}
WebhookTriggerArray0 of 4 keywords
1150{
2150 "items": {
4150 },
5150 "maxItems": 3,
6150 "minItems": 1,
7150 "type": "array"
8150}
application/x-www-form-urlencoded7 / 36
WebhookUpdate
130{
230 "properties": {
320 "active": {
420 "type": "boolean"
520 },
620 "deliveries": {
820 },
920 "responses": {
1120 },
1230 "secret": {
1300 "format": "string",
143n/a "type": "string"
1530 },
1620 "title": {
1700 "format": "string",
182n/a "type": "string"
1920 },
2020 "triggers": {
2220 },
2320 "url": {
2400 "format": "string",
25 "readOnly": false,
262n/a "type": "string"
2720 }
2830 },
293n/a "type": "object"
3030}
Referenced Components (6)3 of 27 keywords
WebhookDelivery1 of 5 keywords
120{
220 "enum": [
32n/a "JSON"
420 ],
500 "format": "string",
620 "nullable": false,
72n/a "type": "string"
820}
WebhookDeliveryArray0 of 4 keywords
120{
220 "items": {
420 },
520 "maxItems": 1,
620 "minItems": 1,
720 "type": "array"
820}
WebhookResponse1 of 5 keywords
120{
220 "enum": [
30n/a "TRANSACTIONS",
40n/a "ACCOUNTS",
50n/a "BUDGET",
60n/a "RELEVANT",
72n/a "NONE"
820 ],
900 "format": "string",
1020 "nullable": false,
112n/a "type": "string"
1220}
WebhookResponseArray0 of 4 keywords
120{
220 "items": {
420 },
520 "maxItems": 1,
620 "minItems": 1,
720 "type": "array"
820}
WebhookTrigger1 of 5 keywords
160{
260 "enum": [
30n/a "ANY",
40n/a "STORE_TRANSACTION",
50n/a "UPDATE_TRANSACTION",
60n/a "DESTROY_TRANSACTION",
72n/a "STORE_BUDGET",
84n/a "UPDATE_BUDGET",
90n/a "DESTROY_BUDGET",
100n/a "STORE_UPDATE_BUDGET_LIMIT"
1160 ],
1200 "format": "string",
1360 "nullable": false,
146n/a "type": "string"
1560}
WebhookTriggerArray0 of 4 keywords
120{
220 "items": {
420 },
520 "maxItems": 3,
620 "minItems": 1,
720 "type": "array"
820}
Responses
codedescriptionhitsavg
200Updated webhook stored, result in response94516ms
400Bad request238ms
401Unauthenticated0never seen
404Page not found0never seen
422Validation error. The body will have the exact details.0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
41537ms
Examples
Body: application/json
falseWebhookUpdate.active
[ "JSON" ]WebhookDeliveryArray
[ "JSON" ]WebhookDelivery
[ "TRANSACTIONS" ]WebhookResponseArray
"RELEVANT"WebhookResponse
"iMLZLtLx2JHWhK9Dtyuoqyir"WebhookUpdate.secret
"Update magic mirror on new transaction"WebhookUpdate.title
[ "STORE_TRANSACTION", "UPDATE_TRANSACTION" ]WebhookTriggerArray
"DESTROY_TRANSACTION"WebhookTrigger
"https://example.com"WebhookUpdate.url
Body: application/x-www-form-urlencoded
falseWebhookUpdate.active
[ "JSON" ]WebhookDeliveryArray
[ "JSON" ]WebhookDelivery
[ "TRANSACTIONS" ]WebhookResponseArray
"RELEVANT"WebhookResponse
"iMLZLtLx2JHWhK9Dtyuoqyir"WebhookUpdate.secret
"Update magic mirror on new transaction"WebhookUpdate.title
[ "STORE_TRANSACTION", "UPDATE_TRANSACTION" ]WebhookTriggerArray
"DESTROY_TRANSACTION"WebhookTrigger
"https://example.com"WebhookUpdate.url
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
140n/a{
240n/a "type": "string"
340n/a}
Headers
X-Trace-Id2 / 2
138170{
238170 "format": "uuid",
3451n/a "type": "string"
438170}
Responses
codedescriptionhitsavg
200A list of webhook messages.79917ms
400Bad request408ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
112n/a{
212n/a "type": "string"
312n/a}
messageId0 / 1
1120{
2120 "type": "integer"
3120}
Headers
X-Trace-Id2 / 2
12816{
22816 "format": "uuid",
344n/a "type": "string"
42816}
Responses
codedescriptionhitsavg
204Webhook message deleted.0never seen
400Bad request128ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK4816ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
1messageId
Path Parameters
id1 / 1
#validinvalidschema
122n/a{
222n/a "type": "string"
322n/a}
messageId1 / 1
1211{
2211 "type": "integer"
3211}
Headers
X-Trace-Id2 / 2
110554{
210554 "format": "uuid",
3159n/a "type": "string"
410554}
Responses
codedescriptionhitsavg
200A single webhook message.39616ms
400Bad request228ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
1messageId
Path Parameters
id1 / 1
#validinvalidschema
125n/a{
225n/a "type": "string"
325n/a}
messageId1 / 1
1241{
2241 "type": "integer"
3241}
Query Parameters
limit2 / 2
1129{
2129 "format": "int32",
3174 "type": "integer"
4129}
page2 / 2
1144{
2144 "format": "int32",
3144 "type": "integer"
4144}
Headers
X-Trace-Id2 / 2
115839{
215839 "format": "uuid",
3197n/a "type": "string"
415839}
Responses
codedescriptionhitsavg
200A list of webhook attempts.48416ms
400Bad request258ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
1messageId
Query
10limit
1page
Path Parameters
id1 / 1
#validinvalidschema
115n/a{
215n/a "type": "string"
315n/a}
messageId1 / 1
1141{
2141 "type": "integer"
3141}
attemptId1 / 1
1141{
2141 "type": "integer"
3141}
Headers
X-Trace-Id2 / 2
14721{
24721 "format": "uuid",
368n/a "type": "string"
44721}
Responses
codedescriptionhitsavg
204Webhook message attempt deleted.0never seen
400Bad request158ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
200OK12515ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
1messageId
1attemptId
Path Parameters
id1 / 1
#validinvalidschema
121n/a{
221n/a "type": "string"
321n/a}
messageId0 / 1
1210{
2210 "type": "integer"
3210}
attemptId0 / 1
1210{
2210 "type": "integer"
3210}
Headers
X-Trace-Id2 / 2
115041{
215041 "format": "uuid",
3191n/a "type": "string"
415041}
Responses
codedescriptionhitsavg
200A single webhook attempt.41216ms
400Bad request218ms
401Unauthenticated0never seen
404Page not found0never seen
500Internal exception0never seen
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
1messageId
1attemptId
Path Parameters
id1 / 1
#validinvalidschema
1326n/a{
2326n/a "type": "string"
3326n/a}
Headers
X-Trace-Id2 / 2
18853{
28853 "format": "uuid",
3141n/a "type": "string"
48853}
Responses
codedescriptionhitsavg
200OK.0never seen
204No messages to send, so did nothing.0never seen
400Bad request0never seen
404Page not found0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
4153268ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
Path Parameters
id1 / 1
#validinvalidschema
1466n/a{
2466n/a "type": "string"
3466n/a}
transactionId1 / 1
1466n/a{
2466n/a "type": "string"
3466n/a}
Headers
X-Trace-Id2 / 2
114193{
214193 "format": "uuid",
3234n/a "type": "string"
414193}
Responses
codedescriptionhitsavg
204Webhook triggered successfully.0never seen
400Bad request0never seen
404Page not found0never seen
500Internal exception0never seen
Undocumented - not in spec
codedescriptionhitsavg
4154668ms
Examples
Header
"40c71bbb-c676-4f24-83cf-cc725d7d7a00"X-Trace-Id
Path
"123"id
"123"transactionId
788 unmatched requests Not counted in coverage above
MethodHostPathReasonCount
DELETE0.0.0.0:41817/api/v1/aboutmethod not documented1
DELETE0.0.0.0:41817/api/v1/about/usermethod not documented1
DELETE0.0.0.0:41817/api/v1/accountsmethod not documented1
DELETE0.0.0.0:41817/api/v1/accounts/{id}/attachmentsmethod not documented1
DELETE0.0.0.0:41817/api/v1/accounts/{id}/piggy-banksmethod not documented1
DELETE0.0.0.0:41817/api/v1/accounts/{id}/transactionsmethod not documented1
DELETE0.0.0.0:41817/api/v1/attachmentsmethod not documented1
DELETE0.0.0.0:41817/api/v1/attachments/{id}/downloadmethod not documented1
DELETE0.0.0.0:41817/api/v1/attachments/{id}/uploadmethod not documented1
DELETE0.0.0.0:41817/api/v1/autocomplete/accountsmethod not documented1

... and 778 more groups