Firefly III documentation
Search documentation…
/
Unofficial preview
API Reference
Preference
Documentation
API Reference
Firefly III documentation
API Reference
Documentation
API Reference
Introduction
Authentication
System
Configuration
Accounts
Piggy banks
Transactions
Transaction links
Attachments
Budgets
Available budgets
Subscriptions
Recurring transactions
Categories
Tags
Object groups
Currencies
Exchange rates
Rules
Rule groups
Webhooks
Insight
Summary
Charts
Search
Autocomplete
Data
Preferences
Financial administrations
Users
Models
CurrencyExchangeRateUpdateNoDate
ObjectGroup
ObjectGroupUpdate
ObjectLink
PageLink
PiggyBankAccountRead
PiggyBankAccountStore
PiggyBankAccountUpdate
PiggyBankProperties
PiggyBankStore
PiggyBankUpdate
PiggyBankEventProperties
Preference
PreferenceUpdate
RecurrenceProperties
RecurrenceStore
RecurrenceUpdate
RecurrenceRepetition
RecurrenceRepetitionStore
RecurrenceRepetitionUpdate
RecurrenceTransaction
RecurrenceTransactionStore
RecurrenceTransactionUpdate
Rule
RuleStore
Unofficial preview
GitHub
Models
Preference
object
created_at
string<date-time>
read only
Example
2026-10-01T00:00:00+00:00
Copy
Copy
updated_at
string<date-time>
read only
Example
2026-10-01T00:00:00+00:00
Copy
Copy
name
string
required
Example
currencyPreference
Copy
Copy
data
boolean | string | object | Array<StringArrayItem>
required
Show child attributes
One of
One of
Option 1 · boolean
Option 2 · string
Option 3 · object
Option 4 · Array<StringArrayItem>
boolean
string
object
Array<StringArrayItem>
← Previous
PiggyBankEventProperties
Next →
PreferenceUpdate
©
James Cole
, licensed under
Attribution-ShareAlike 4.0 International
.
Docs by Sourcey