🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
Book a DemoInstallSign in
Socket

gitea.stuzer.link/stuzer05/go-firefly3

Package Overview
Dependencies
Alerts
File Explorer
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

gitea.stuzer.link/stuzer05/go-firefly3

v2.0.14+incompatible
Go
Version published
Created
Source

Go Reference

Go API client for swagger

This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the "Authorize" button to try the API below. This file was last generated on 2024-04-20T05:28:29+00:00 Please keep in mind that the demo site does not accept requests from curl, colly, wget, etc. You must use a browser or a tool like Postman to make requests. Too many script kiddies out there, sorry about that.

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 2.0.14
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen For more information, please visit https://firefly-iii.org

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to https://demo.firefly-iii.org/api

ClassMethodHTTP requestDescription
AboutApiGetAboutGet /v1/aboutSystem information end point.
AboutApiGetCronGet /v1/cron/{cliToken}Cron job endpoint
AboutApiGetCurrentUserGet /v1/about/userCurrently authenticated user endpoint.
AccountsApiDeleteAccountDelete /v1/accounts/{id}Permanently delete account.
AccountsApiGetAccountGet /v1/accounts/{id}Get single account.
AccountsApiListAccountGet /v1/accountsList all accounts.
AccountsApiListAttachmentByAccountGet /v1/accounts/{id}/attachmentsLists all attachments.
AccountsApiListPiggyBankByAccountGet /v1/accounts/{id}/piggy-banksList all piggy banks related to the account.
AccountsApiListTransactionByAccountGet /v1/accounts/{id}/transactionsList all transactions related to the account.
AccountsApiStoreAccountPost /v1/accountsCreate new account.
AccountsApiUpdateAccountPut /v1/accounts/{id}Update existing account.
AttachmentsApiDeleteAttachmentDelete /v1/attachments/{id}Delete an attachment.
AttachmentsApiDownloadAttachmentGet /v1/attachments/{id}/downloadDownload a single attachment.
AttachmentsApiGetAttachmentGet /v1/attachments/{id}Get a single attachment.
AttachmentsApiListAttachmentGet /v1/attachmentsList all attachments.
AttachmentsApiStoreAttachmentPost /v1/attachmentsStore a new attachment.
AttachmentsApiUpdateAttachmentPut /v1/attachments/{id}Update existing attachment.
AttachmentsApiUploadAttachmentPost /v1/attachments/{id}/uploadUpload an attachment.
AutocompleteApiGetAccountsACGet /v1/autocomplete/accountsReturns all accounts of the user returned in a basic auto-complete array.
AutocompleteApiGetBillsACGet /v1/autocomplete/billsReturns all bills of the user returned in a basic auto-complete array.
AutocompleteApiGetBudgetsACGet /v1/autocomplete/budgetsReturns all budgets of the user returned in a basic auto-complete array.
AutocompleteApiGetCategoriesACGet /v1/autocomplete/categoriesReturns all categories of the user returned in a basic auto-complete array.
AutocompleteApiGetCurrenciesACGet /v1/autocomplete/currenciesReturns all currencies of the user returned in a basic auto-complete array.
AutocompleteApiGetCurrenciesCodeACGet /v1/autocomplete/currencies-with-codeReturns all currencies of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.
AutocompleteApiGetObjectGroupsACGet /v1/autocomplete/object-groupsReturns all object groups of the user returned in a basic auto-complete array.
AutocompleteApiGetPiggiesACGet /v1/autocomplete/piggy-banksReturns all piggy banks of the user returned in a basic auto-complete array.
AutocompleteApiGetPiggiesBalanceACGet /v1/autocomplete/piggy-banks-with-balanceReturns all piggy banks of the user returned in a basic auto-complete array complemented with balance information.
AutocompleteApiGetRecurringACGet /v1/autocomplete/recurringReturns all recurring transactions of the user returned in a basic auto-complete array.
AutocompleteApiGetRuleGroupsACGet /v1/autocomplete/rule-groupsReturns all rule groups of the user returned in a basic auto-complete array.
AutocompleteApiGetRulesACGet /v1/autocomplete/rulesReturns all rules of the user returned in a basic auto-complete array.
AutocompleteApiGetTagACGet /v1/autocomplete/tagsReturns all tags of the user returned in a basic auto-complete array.
AutocompleteApiGetTransactionTypesACGet /v1/autocomplete/transaction-typesReturns all transaction types returned in a basic auto-complete array. English only.
AutocompleteApiGetTransactionsACGet /v1/autocomplete/transactionsReturns all transaction descriptions of the user returned in a basic auto-complete array.
AutocompleteApiGetTransactionsIDACGet /v1/autocomplete/transactions-with-idReturns all transactions, complemented with their ID, of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.
AvailableBudgetsApiGetAvailableBudgetGet /v1/available-budgets/{id}Get a single available budget.
AvailableBudgetsApiListAvailableBudgetGet /v1/available-budgetsList all available budget amounts.
BillsApiDeleteBillDelete /v1/bills/{id}Delete a bill.
BillsApiGetBillGet /v1/bills/{id}Get a single bill.
BillsApiListAttachmentByBillGet /v1/bills/{id}/attachmentsList all attachments uploaded to the bill.
BillsApiListBillGet /v1/billsList all bills.
BillsApiListRuleByBillGet /v1/bills/{id}/rulesList all rules associated with the bill.
BillsApiListTransactionByBillGet /v1/bills/{id}/transactionsList all transactions associated with the bill.
BillsApiStoreBillPost /v1/billsStore a new bill
BillsApiUpdateBillPut /v1/bills/{id}Update existing bill.
BudgetsApiDeleteBudgetDelete /v1/budgets/{id}Delete a budget.
BudgetsApiDeleteBudgetLimitDelete /v1/budgets/{id}/limits/{limitId}Delete a budget limit.
BudgetsApiGetBudgetGet /v1/budgets/{id}Get a single budget.
BudgetsApiGetBudgetLimitGet /v1/budgets/{id}/limits/{limitId}Get single budget limit.
BudgetsApiListAttachmentByBudgetGet /v1/budgets/{id}/attachmentsLists all attachments of a budget.
BudgetsApiListBudgetGet /v1/budgetsList all budgets.
BudgetsApiListBudgetLimitGet /v1/budget-limitsGet list of budget limits by date
BudgetsApiListBudgetLimitByBudgetGet /v1/budgets/{id}/limitsGet all limits for a budget.
BudgetsApiListTransactionByBudgetGet /v1/budgets/{id}/transactionsAll transactions to a budget.
BudgetsApiListTransactionByBudgetLimitGet /v1/budgets/{id}/limits/{limitId}/transactionsList all transactions by a budget limit ID.
BudgetsApiStoreBudgetPost /v1/budgetsStore a new budget
BudgetsApiStoreBudgetLimitPost /v1/budgets/{id}/limitsStore new budget limit.
BudgetsApiUpdateBudgetPut /v1/budgets/{id}Update existing budget.
BudgetsApiUpdateBudgetLimitPut /v1/budgets/{id}/limits/{limitId}Update existing budget limit.
CategoriesApiDeleteCategoryDelete /v1/categories/{id}Delete a category.
CategoriesApiGetCategoryGet /v1/categories/{id}Get a single category.
CategoriesApiListAttachmentByCategoryGet /v1/categories/{id}/attachmentsLists all attachments.
CategoriesApiListCategoryGet /v1/categoriesList all categories.
CategoriesApiListTransactionByCategoryGet /v1/categories/{id}/transactionsList all transactions in a category.
CategoriesApiStoreCategoryPost /v1/categoriesStore a new category
CategoriesApiUpdateCategoryPut /v1/categories/{id}Update existing category.
ChartsApiGetChartAccountOverviewGet /v1/chart/account/overviewDashboard chart with asset account balance information.
ConfigurationApiGetConfigurationGet /v1/configurationGet Firefly III system configuration values.
ConfigurationApiGetSingleConfigurationGet /v1/configuration/{name}Get a single Firefly III system configuration value
ConfigurationApiSetConfigurationPut /v1/configuration/{name}Update configuration value
CurrenciesApiDefaultCurrencyPost /v1/currencies/{code}/defaultMake currency default currency.
CurrenciesApiDeleteCurrencyDelete /v1/currencies/{code}Delete a currency.
CurrenciesApiDisableCurrencyPost /v1/currencies/{code}/disableDisable a currency.
CurrenciesApiEnableCurrencyPost /v1/currencies/{code}/enableEnable a single currency.
CurrenciesApiGetCurrencyGet /v1/currencies/{code}Get a single currency.
CurrenciesApiGetDefaultCurrencyGet /v1/currencies/defaultGet the user's default currency.
CurrenciesApiListAccountByCurrencyGet /v1/currencies/{code}/accountsList all accounts with this currency.
CurrenciesApiListAvailableBudgetByCurrencyGet /v1/currencies/{code}/available-budgetsList all available budgets with this currency.
CurrenciesApiListBillByCurrencyGet /v1/currencies/{code}/billsList all bills with this currency.
CurrenciesApiListBudgetLimitByCurrencyGet /v1/currencies/{code}/budget_limitsList all budget limits with this currency
CurrenciesApiListCurrencyGet /v1/currenciesList all currencies.
CurrenciesApiListRecurrenceByCurrencyGet /v1/currencies/{code}/recurrencesList all recurring transactions with this currency.
CurrenciesApiListRuleByCurrencyGet /v1/currencies/{code}/rulesList all rules with this currency.
CurrenciesApiListTransactionByCurrencyGet /v1/currencies/{code}/transactionsList all transactions with this currency.
CurrenciesApiStoreCurrencyPost /v1/currenciesStore a new currency
CurrenciesApiUpdateCurrencyPut /v1/currencies/{code}Update existing currency.
DataApiBulkUpdateTransactionsPost /v1/data/bulk/transactionsBulk update transaction properties. For more information, see https://docs.firefly-iii.org/references/firefly-iii/api/specials/
DataApiDestroyDataDelete /v1/data/destroyEndpoint to destroy user data
DataApiExportAccountsGet /v1/data/export/accountsExport account data from Firefly III
DataApiExportBillsGet /v1/data/export/billsExport bills from Firefly III
DataApiExportBudgetsGet /v1/data/export/budgetsExport budgets and budget amount data from Firefly III
DataApiExportCategoriesGet /v1/data/export/categoriesExport category data from Firefly III
DataApiExportPiggiesGet /v1/data/export/piggy-banksExport piggy banks from Firefly III
DataApiExportRecurringGet /v1/data/export/recurringExport recurring transaction data from Firefly III
DataApiExportRulesGet /v1/data/export/rulesExport rule groups and rule data from Firefly III
DataApiExportTagsGet /v1/data/export/tagsExport tag data from Firefly III
DataApiExportTransactionsGet /v1/data/export/transactionsExport transaction data from Firefly III
DataApiPurgeDataDelete /v1/data/purgeEndpoint to purge user data
InsightApiInsightExpenseAssetGet /v1/insight/expense/assetInsight into expenses, grouped by asset account.
InsightApiInsightExpenseBillGet /v1/insight/expense/billInsight into expenses, grouped by bill.
InsightApiInsightExpenseBudgetGet /v1/insight/expense/budgetInsight into expenses, grouped by budget.
InsightApiInsightExpenseCategoryGet /v1/insight/expense/categoryInsight into expenses, grouped by category.
InsightApiInsightExpenseExpenseGet /v1/insight/expense/expenseInsight into expenses, grouped by expense account.
InsightApiInsightExpenseNoBillGet /v1/insight/expense/no-billInsight into expenses, without bill.
InsightApiInsightExpenseNoBudgetGet /v1/insight/expense/no-budgetInsight into expenses, without budget.
InsightApiInsightExpenseNoCategoryGet /v1/insight/expense/no-categoryInsight into expenses, without category.
InsightApiInsightExpenseNoTagGet /v1/insight/expense/no-tagInsight into expenses, without tag.
InsightApiInsightExpenseTagGet /v1/insight/expense/tagInsight into expenses, grouped by tag.
InsightApiInsightExpenseTotalGet /v1/insight/expense/totalInsight into total expenses.
InsightApiInsightIncomeAssetGet /v1/insight/income/assetInsight into income, grouped by asset account.
InsightApiInsightIncomeCategoryGet /v1/insight/income/categoryInsight into income, grouped by category.
InsightApiInsightIncomeNoCategoryGet /v1/insight/income/no-categoryInsight into income, without category.
InsightApiInsightIncomeNoTagGet /v1/insight/income/no-tagInsight into income, without tag.
InsightApiInsightIncomeRevenueGet /v1/insight/income/revenueInsight into income, grouped by revenue account.
InsightApiInsightIncomeTagGet /v1/insight/income/tagInsight into income, grouped by tag.
InsightApiInsightIncomeTotalGet /v1/insight/income/totalInsight into total income.
InsightApiInsightTransferCategoryGet /v1/insight/transfer/categoryInsight into transfers, grouped by category.
InsightApiInsightTransferNoCategoryGet /v1/insight/transfer/no-categoryInsight into transfers, without category.
InsightApiInsightTransferNoTagGet /v1/insight/transfer/no-tagInsight into expenses, without tag.
InsightApiInsightTransferTagGet /v1/insight/transfer/tagInsight into transfers, grouped by tag.
InsightApiInsightTransferTotalGet /v1/insight/transfer/totalInsight into total transfers.
InsightApiInsightTransfersGet /v1/insight/transfer/assetInsight into transfers, grouped by account.
LinksApiDeleteLinkTypeDelete /v1/link-types/{id}Permanently delete link type.
LinksApiDeleteTransactionLinkDelete /v1/transaction-links/{id}Permanently delete link between transactions.
LinksApiGetLinkTypeGet /v1/link-types/{id}Get single a link type.
LinksApiGetTransactionLinkGet /v1/transaction-links/{id}Get a single link.
LinksApiListLinkTypeGet /v1/link-typesList all types of links.
LinksApiListTransactionByLinkTypeGet /v1/link-types/{id}/transactionsList all transactions under this link type.
LinksApiListTransactionLinkGet /v1/transaction-linksList all transaction links.
LinksApiStoreLinkTypePost /v1/link-typesCreate a new link type
LinksApiStoreTransactionLinkPost /v1/transaction-linksCreate a new link between transactions
LinksApiUpdateLinkTypePut /v1/link-types/{id}Update existing link type.
LinksApiUpdateTransactionLinkPut /v1/transaction-links/{id}Update an existing link between transactions.
ObjectGroupsApiDeleteObjectGroupDelete /v1/object-groups/{id}Delete a object group.
ObjectGroupsApiGetObjectGroupGet /v1/object-groups/{id}Get a single object group.
ObjectGroupsApiListBillByObjectGroupGet /v1/object-groups/{id}/billsList all bills with this object group.
ObjectGroupsApiListObjectGroupsGet /v1/object-groupsList all oject groups.
ObjectGroupsApiListPiggyBankByObjectGroupGet /v1/object-groups/{id}/piggy-banksList all piggy banks related to the object group.
ObjectGroupsApiUpdateObjectGroupPut /v1/object-groups/{id}Update existing object group.
PiggyBanksApiDeletePiggyBankDelete /v1/piggy-banks/{id}Delete a piggy bank.
PiggyBanksApiGetPiggyBankGet /v1/piggy-banks/{id}Get a single piggy bank.
PiggyBanksApiListAttachmentByPiggyBankGet /v1/piggy-banks/{id}/attachmentsLists all attachments.
PiggyBanksApiListEventByPiggyBankGet /v1/piggy-banks/{id}/eventsList all events linked to a piggy bank.
PiggyBanksApiListPiggyBankGet /v1/piggy-banksList all piggy banks.
PiggyBanksApiStorePiggyBankPost /v1/piggy-banksStore a new piggy bank
PiggyBanksApiUpdatePiggyBankPut /v1/piggy-banks/{id}Update existing piggy bank.
PreferencesApiGetPreferenceGet /v1/preferences/{name}Return a single preference.
PreferencesApiListPreferenceGet /v1/preferencesList all users preferences.
PreferencesApiStorePreferencePost /v1/preferencesStore a new preference for this user.
PreferencesApiUpdatePreferencePut /v1/preferences/{name}Update preference
RecurrencesApiDeleteRecurrenceDelete /v1/recurrences/{id}Delete a recurring transaction.
RecurrencesApiGetRecurrenceGet /v1/recurrences/{id}Get a single recurring transaction.
RecurrencesApiListRecurrenceGet /v1/recurrencesList all recurring transactions.
RecurrencesApiListTransactionByRecurrenceGet /v1/recurrences/{id}/transactionsList all transactions created by a recurring transaction.
RecurrencesApiStoreRecurrencePost /v1/recurrencesStore a new recurring transaction
RecurrencesApiUpdateRecurrencePut /v1/recurrences/{id}Update existing recurring transaction.
RuleGroupsApiDeleteRuleGroupDelete /v1/rule-groups/{id}Delete a rule group.
RuleGroupsApiFireRuleGroupPost /v1/rule-groups/{id}/triggerFire the rule group on your transactions.
RuleGroupsApiGetRuleGroupGet /v1/rule-groups/{id}Get a single rule group.
RuleGroupsApiListRuleByGroupGet /v1/rule-groups/{id}/rulesList rules in this rule group.
RuleGroupsApiListRuleGroupGet /v1/rule-groupsList all rule groups.
RuleGroupsApiStoreRuleGroupPost /v1/rule-groupsStore a new rule group.
RuleGroupsApiTestRuleGroupGet /v1/rule-groups/{id}/testTest which transactions would be hit by the rule group. No changes will be made.
RuleGroupsApiUpdateRuleGroupPut /v1/rule-groups/{id}Update existing rule group.
RulesApiDeleteRuleDelete /v1/rules/{id}Delete an rule.
RulesApiFireRulePost /v1/rules/{id}/triggerFire the rule on your transactions.
RulesApiGetRuleGet /v1/rules/{id}Get a single rule.
RulesApiListRuleGet /v1/rulesList all rules.
RulesApiStoreRulePost /v1/rulesStore a new rule
RulesApiTestRuleGet /v1/rules/{id}/testTest which transactions would be hit by the rule. No changes will be made.
RulesApiUpdateRulePut /v1/rules/{id}Update existing rule.
SearchApiSearchAccountsGet /v1/search/accountsSearch for accounts
SearchApiSearchTransactionsGet /v1/search/transactionsSearch for transactions
SummaryApiGetBasicSummaryGet /v1/summary/basicReturns basic sums of the users data.
TagsApiDeleteTagDelete /v1/tags/{tag}Delete an tag.
TagsApiGetTagGet /v1/tags/{tag}Get a single tag.
TagsApiListAttachmentByTagGet /v1/tags/{tag}/attachmentsLists all attachments.
TagsApiListTagGet /v1/tagsList all tags.
TagsApiListTransactionByTagGet /v1/tags/{tag}/transactionsList all transactions with this tag.
TagsApiStoreTagPost /v1/tagsStore a new tag
TagsApiUpdateTagPut /v1/tags/{tag}Update existing tag.
TransactionsApiDeleteTransactionDelete /v1/transactions/{id}Delete a transaction.
TransactionsApiDeleteTransactionJournalDelete /v1/transaction-journals/{id}Delete split from transaction
TransactionsApiGetTransactionGet /v1/transactions/{id}Get a single transaction.
TransactionsApiGetTransactionByJournalGet /v1/transaction-journals/{id}Get a single transaction, based on one of the underlying transaction journals (transaction splits).
TransactionsApiListAttachmentByTransactionGet /v1/transactions/{id}/attachmentsLists all attachments.
TransactionsApiListEventByTransactionGet /v1/transactions/{id}/piggy-bank-eventsLists all piggy bank events.
TransactionsApiListLinksByJournalGet /v1/transaction-journals/{id}/linksLists all the transaction links for an individual journal (individual split).
TransactionsApiListTransactionGet /v1/transactionsList all the user's transactions.
TransactionsApiStoreTransactionPost /v1/transactionsStore a new transaction
TransactionsApiUpdateTransactionPut /v1/transactions/{id}Update existing transaction. For more information, see https://docs.firefly-iii.org/references/firefly-iii/api/specials/
UsersApiDeleteUserDelete /v1/users/{id}Delete a user.
UsersApiGetUserGet /v1/users/{id}Get a single user.
UsersApiListUserGet /v1/usersList all users.
UsersApiStoreUserPost /v1/usersStore a new user
UsersApiUpdateUserPut /v1/users/{id}Update an existing user's information.
WebhooksApiDeleteWebhookDelete /v1/webhooks/{id}Delete a webhook.
WebhooksApiDeleteWebhookMessageDelete /v1/webhooks/{id}/messages/{messageId}Delete a webhook message.
WebhooksApiDeleteWebhookMessageAttemptDelete /v1/webhooks/{id}/messages/{messageId}/attempts/{attemptId}Delete a webhook attempt.
WebhooksApiGetSingleWebhookMessageGet /v1/webhooks/{id}/messages/{messageId}Get a single message from a webhook.
WebhooksApiGetSingleWebhookMessageAttemptGet /v1/webhooks/{id}/messages/{messageId}/attempts/{attemptId}Get a single failed attempt from a single webhook message.
WebhooksApiGetWebhookGet /v1/webhooks/{id}Get a single webhook.
WebhooksApiGetWebhookMessageAttemptsGet /v1/webhooks/{id}/messages/{messageId}/attemptsGet all the failed attempts of a single webhook message.
WebhooksApiGetWebhookMessagesGet /v1/webhooks/{id}/messagesGet all the messages of a single webhook.
WebhooksApiListWebhookGet /v1/webhooksList all webhooks.
WebhooksApiStoreWebhookPost /v1/webhooksStore a new webhook
WebhooksApiSubmitWebookPost /v1/webhooks/{id}/submitSubmit messages for a webhook.
WebhooksApiTriggerTransactionWebhookPost /v1/webhooks/{id}/trigger-transaction/{transactionId}Trigger webhook for a given transaction.
WebhooksApiUpdateWebhookPut /v1/webhooks/{id}Update existing webhook.

Documentation For Models

Documentation For Authorization

firefly_iii_auth

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */

tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
r, err := client.Service.Operation(auth, args)

local_bearer_auth

Author

james@firefly-iii.org

FAQs

Package last updated on 11 May 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts