Skip to content

Commit 2df8f3d

Browse files
committed
Add about config values.
1 parent 1687206 commit 2df8f3d

File tree

1 file changed

+8
-0
lines changed
  • docs/docs/references/firefly-iii/api

1 file changed

+8
-0
lines changed

docs/docs/references/firefly-iii/api/index.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,11 @@ Amounts, balances and collections of expenses (such as `spent` or `earned` array
2929

3030
If the user does NOT enable "convert to primary", all `pc_*` attributes will be `null`. This means that the API will not convert amounts to the primary currency. If the currency of the object is the same as the primary currency, the `pc_*` attributes will be the same as the regular attributes. For example, a transaction in EUR with a primary currency of EUR will have `amount` and `pc_amount` set to the same value.
3131

32+
## Configuration values
33+
34+
The endpoint `/api/v1/configuration` returns a variety of static and dynamic configuration values of Firefly III.
35+
36+
There are two sets of configuration values that you can retrieve through this endpoint.
37+
38+
1. Static values. You cannot edit these. The source code of Firefly III has [the full list of options](https://github.com/firefly-iii/firefly-iii/blob/main/app/Support/Binder/EitherConfigKey.php#L35).
39+
2. Dynamic values. These can be changed. The source code of Firefly III has [the full list of options](https://github.com/firefly-iii/firefly-iii/blob/main/app/Support/Binder/DynamicConfigKey.php#L35).

0 commit comments

Comments
 (0)