Skip to content

Latest commit

 

History

History
588 lines (550 loc) · 48.9 KB

README.md

File metadata and controls

588 lines (550 loc) · 48.9 KB
Raw

FireflyIIINet - the C# library for the Firefly III API v2.0.2

This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the "Authorize" button to try the API below. This file was last generated on 2023-05-17T04:54:43+00:00

This C# SDK is automatically generated by the OpenAPI Generator project:

  • API version: 2.0.2
  • SDK version: 2.0.2.1
  • Build package: org.openapitools.codegen.languages.CSharpClientCodegen For more information, please visit https://firefly-iii.org

Frameworks supported

Dependencies

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
Install-Package System.ComponentModel.Annotations

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742. NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See RestSharp#1406.

Installation

Run the following command to generate the DLL

  • [Mac/Linux] /bin/sh build.sh
  • [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using FireflyIIINet.Api;
using FireflyIIINet.Client;
using FireflyIIINet.Model;

Packaging

A .nuspec is included with the project. You can follow the Nuget quickstart to create and publish packages.

This .nuspec uses placeholders from the .csproj, so build the .csproj directly:

nuget pack -Build -OutputDirectory out FireflyIIINet.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Usage

To use the API client with a HTTP proxy, setup a System.Net.WebProxy

Configuration c = new Configuration();
System.Net.WebProxy webProxy = new System.Net.WebProxy("http://myProxyUrl:80/");
webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
c.Proxy = webProxy;

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using FireflyIIINet.Api;
using FireflyIIINet.Client;
using FireflyIIINet.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

            Configuration config = new Configuration();
            config.BasePath = "https://demo.firefly-iii.org/api";
            // Configure OAuth2 access token for authorization: firefly_iii_auth
            config.AccessToken = "YOUR_ACCESS_TOKEN";

            var apiInstance = new AboutApi(config);
            var xTraceId = "xTraceId_example";  // Guid? | Unique identifier associated with this request. (optional) 

            try
            {
                // System information end point.
                SystemInfo result = apiInstance.GetAbout(xTraceId);
                Debug.WriteLine(result);
            }
            catch (ApiException e)
            {
                Debug.Print("Exception when calling AboutApi.GetAbout: " + e.Message );
                Debug.Print("Status Code: "+ e.ErrorCode);
                Debug.Print(e.StackTrace);
            }

        }
    }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
AboutApi GetAbout GET /v1/about System information end point.
AboutApi GetCron GET /v1/cron/{cliToken} Cron job endpoint
AboutApi GetCurrentUser GET /v1/about/user Currently authenticated user endpoint.
AccountsApi DeleteAccount DELETE /v1/accounts/{id} Permanently delete account.
AccountsApi GetAccount GET /v1/accounts/{id} Get single account.
AccountsApi ListAccount GET /v1/accounts List all accounts.
AccountsApi ListAttachmentByAccount GET /v1/accounts/{id}/attachments Lists all attachments.
AccountsApi ListPiggyBankByAccount GET /v1/accounts/{id}/piggy-banks List all piggy banks related to the account.
AccountsApi ListTransactionByAccount GET /v1/accounts/{id}/transactions List all transactions related to the account.
AccountsApi ListTransactionByAccountV2 GET /v2/accounts/{id}/transactions List all transactions related to the account.
AccountsApi StoreAccount POST /v1/accounts Create new account.
AccountsApi UpdateAccount PUT /v1/accounts/{id} Update existing account.
AttachmentsApi DeleteAttachment DELETE /v1/attachments/{id} Delete an attachment.
AttachmentsApi DownloadAttachment GET /v1/attachments/{id}/download Download a single attachment.
AttachmentsApi GetAttachment GET /v1/attachments/{id} Get a single attachment.
AttachmentsApi ListAttachment GET /v1/attachments List all attachments.
AttachmentsApi StoreAttachment POST /v1/attachments Store a new attachment.
AttachmentsApi UpdateAttachment PUT /v1/attachments/{id} Update existing attachment.
AttachmentsApi UploadAttachment POST /v1/attachments/{id}/upload Upload an attachment.
AutocompleteApi GetAccountsAC GET /v1/autocomplete/accounts Returns all accounts of the user returned in a basic auto-complete array.
AutocompleteApi GetBillsAC GET /v1/autocomplete/bills Returns all bills of the user returned in a basic auto-complete array.
AutocompleteApi GetBudgetsAC GET /v1/autocomplete/budgets Returns all budgets of the user returned in a basic auto-complete array.
AutocompleteApi GetCategoriesAC GET /v1/autocomplete/categories Returns all categories of the user returned in a basic auto-complete array.
AutocompleteApi GetCurrenciesAC GET /v1/autocomplete/currencies Returns all currencies of the user returned in a basic auto-complete array.
AutocompleteApi GetCurrenciesCodeAC GET /v1/autocomplete/currencies-with-code Returns all currencies of the user returned in a basic auto-complete array. This endpoint is DEPRECATED and I suggest you DO NOT use it.
AutocompleteApi GetObjectGroupsAC GET /v1/autocomplete/object-groups Returns all object groups of the user returned in a basic auto-complete array.
AutocompleteApi GetPiggiesAC GET /v1/autocomplete/piggy-banks Returns all piggy banks of the user returned in a basic auto-complete array.
AutocompleteApi GetPiggiesBalanceAC GET /v1/autocomplete/piggy-banks-with-balance Returns all piggy banks of the user returned in a basic auto-complete array complemented with balance information.
AutocompleteApi GetRecurringAC GET /v1/autocomplete/recurring Returns all recurring transactions of the user returned in a basic auto-complete array.
AutocompleteApi GetRuleGroupsAC GET /v1/autocomplete/rule-groups Returns all rule groups of the user returned in a basic auto-complete array.
AutocompleteApi GetRulesAC GET /v1/autocomplete/rules Returns all rules of the user returned in a basic auto-complete array.
AutocompleteApi GetTagAC GET /v1/autocomplete/tags Returns all tags of the user returned in a basic auto-complete array.
AutocompleteApi GetTransactionTypesAC GET /v1/autocomplete/transaction-types Returns all transaction types returned in a basic auto-complete array. English only.
AutocompleteApi GetTransactionsAC GET /v1/autocomplete/transactions Returns all transaction descriptions of the user returned in a basic auto-complete array.
AutocompleteApi GetTransactionsIDAC GET /v1/autocomplete/transactions-with-id Returns 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.
AvailableBudgetsApi GetAvailableBudget GET /v1/available-budgets/{id} Get a single available budget.
AvailableBudgetsApi ListAvailableBudget GET /v1/available-budgets List all available budget amounts.
BillsApi DeleteBill DELETE /v1/bills/{id} Delete a bill.
BillsApi GetBill GET /v1/bills/{id} Get a single bill.
BillsApi ListAttachmentByBill GET /v1/bills/{id}/attachments List all attachments uploaded to the bill.
BillsApi ListBill GET /v1/bills List all bills.
BillsApi ListRuleByBill GET /v1/bills/{id}/rules List all rules associated with the bill.
BillsApi ListTransactionByBill GET /v1/bills/{id}/transactions List all transactions associated with the bill.
BillsApi StoreBill POST /v1/bills Store a new bill
BillsApi UpdateBill PUT /v1/bills/{id} Update existing bill.
BudgetsApi DeleteBudget DELETE /v1/budgets/{id} Delete a budget.
BudgetsApi DeleteBudgetLimit DELETE /v1/budgets/{id}/limits/{limitId} Delete a budget limit.
BudgetsApi GetBudget GET /v1/budgets/{id} Get a single budget.
BudgetsApi GetBudgetLimit GET /v1/budgets/{id}/limits/{limitId} Get single budget limit.
BudgetsApi GetBudgetedForBudget GET /v2/budgets/{id}/budgeted Returns the budgeted amount for the given budget in the given period.
BudgetsApi GetBudgetedForBudgets GET /v2/budgets/sum/budgeted Returns the budgeted amount for all budgets in the given period.
BudgetsApi GetSpentForBudget GET /v2/budgets/{id}/spent Returns the spent amount for the given budget in the given period.
BudgetsApi GetSpentForBudgets GET /v2/budgets/sum/spent Returns the spent amount for all budgets in the given period.
BudgetsApi ListAttachmentByBudget GET /v1/budgets/{id}/attachments Lists all attachments of a budget.
BudgetsApi ListBudget GET /v1/budgets List all budgets.
BudgetsApi ListBudgetLimit GET /v1/budget-limits Get list of budget limits by date
BudgetsApi ListBudgetLimitByBudget GET /v1/budgets/{id}/limits Get all limits for a budget.
BudgetsApi ListBudgetLimitByBudgetV2 GET /v2/budgets/{id}/limits Get all limits for a budget.
BudgetsApi ListBudgets GET /v2/budgets List all budgets.
BudgetsApi ListTransactionByBudget GET /v1/budgets/{id}/transactions All transactions to a budget.
BudgetsApi ListTransactionByBudgetLimit GET /v1/budgets/{id}/limits/{limitId}/transactions List all transactions by a budget limit ID.
BudgetsApi StoreBudget POST /v1/budgets Store a new budget
BudgetsApi StoreBudgetLimit POST /v1/budgets/{id}/limits Store new budget limit.
BudgetsApi UpdateBudget PUT /v1/budgets/{id} Update existing budget.
BudgetsApi UpdateBudgetLimit PUT /v1/budgets/{id}/limits/{limitId} Update existing budget limit.
CategoriesApi DeleteCategory DELETE /v1/categories/{id} Delete a category.
CategoriesApi GetCategory GET /v1/categories/{id} Get a single category.
CategoriesApi ListAttachmentByCategory GET /v1/categories/{id}/attachments Lists all attachments.
CategoriesApi ListCategory GET /v1/categories List all categories.
CategoriesApi ListTransactionByCategory GET /v1/categories/{id}/transactions List all transactions in a category.
CategoriesApi StoreCategory POST /v1/categories Store a new category
CategoriesApi UpdateCategory PUT /v1/categories/{id} Update existing category.
ChartsApi GetChartAccountOverview GET /v1/chart/account/overview Dashboard chart with asset account balance information.
ChartsApi GetChartAccountOverviewV2 GET /v2/chart/account/dashboard Dashboard chart with asset account balance information.
ConfigurationApi GetConfiguration GET /v1/configuration Get Firefly III system configuration values.
ConfigurationApi GetSingleConfiguration GET /v1/configuration/{name} Get a single Firefly III system configuration value
ConfigurationApi SetConfiguration PUT /v1/configuration/{name} Update configuration value
CurrenciesApi DefaultCurrency POST /v1/currencies/{code}/default Make currency default currency.
CurrenciesApi DeleteCurrency DELETE /v1/currencies/{code} Delete a currency.
CurrenciesApi DisableCurrency POST /v1/currencies/{code}/disable Disable a currency.
CurrenciesApi EnableCurrency POST /v1/currencies/{code}/enable Enable a single currency.
CurrenciesApi GetCurrency GET /v1/currencies/{code} Get a single currency.
CurrenciesApi GetDefaultCurrency GET /v1/currencies/default Get the user's default currency.
CurrenciesApi ListAccountByCurrency GET /v1/currencies/{code}/accounts List all accounts with this currency.
CurrenciesApi ListAvailableBudgetByCurrency GET /v1/currencies/{code}/available-budgets List all available budgets with this currency.
CurrenciesApi ListBillByCurrency GET /v1/currencies/{code}/bills List all bills with this currency.
CurrenciesApi ListBudgetLimitByCurrency GET /v1/currencies/{code}/budget_limits List all budget limits with this currency
CurrenciesApi ListCurrency GET /v1/currencies List all currencies.
CurrenciesApi ListRecurrenceByCurrency GET /v1/currencies/{code}/recurrences List all recurring transactions with this currency.
CurrenciesApi ListRuleByCurrency GET /v1/currencies/{code}/rules List all rules with this currency.
CurrenciesApi ListTransactionByCurrency GET /v1/currencies/{code}/transactions List all transactions with this currency.
CurrenciesApi StoreCurrency POST /v1/currencies Store a new currency
CurrenciesApi UpdateCurrency PUT /v1/currencies/{code} Update existing currency.
DataApi BulkUpdateTransactions POST /v1/data/bulk/transactions Bulk update transaction properties. For more information, see https://docs.firefly-iii.org/firefly-iii/api/specials
DataApi DestroyData DELETE /v1/data/destroy Endpoint to destroy user data
DataApi ExportAccounts GET /v1/data/export/accounts Export account data from Firefly III
DataApi ExportBills GET /v1/data/export/bills Export bills from Firefly III
DataApi ExportBudgets GET /v1/data/export/budgets Export budgets and budget amount data from Firefly III
DataApi ExportCategories GET /v1/data/export/categories Export category data from Firefly III
DataApi ExportPiggies GET /v1/data/export/piggy-banks Export piggy banks from Firefly III
DataApi ExportRecurring GET /v1/data/export/recurring Export recurring transaction data from Firefly III
DataApi ExportRules GET /v1/data/export/rules Export rule groups and rule data from Firefly III
DataApi ExportTags GET /v1/data/export/tags Export tag data from Firefly III
DataApi ExportTransactions GET /v1/data/export/transactions Export transaction data from Firefly III
DataApi PurgeData DELETE /v1/data/purge Endpoint to purge user data
InsightApi InsightExpenseAsset GET /v1/insight/expense/asset Insight into expenses, grouped by asset account.
InsightApi InsightExpenseBill GET /v1/insight/expense/bill Insight into expenses, grouped by bill.
InsightApi InsightExpenseBudget GET /v1/insight/expense/budget Insight into expenses, grouped by budget.
InsightApi InsightExpenseCategory GET /v1/insight/expense/category Insight into expenses, grouped by category.
InsightApi InsightExpenseExpense GET /v1/insight/expense/expense Insight into expenses, grouped by expense account.
InsightApi InsightExpenseNoBill GET /v1/insight/expense/no-bill Insight into expenses, without bill.
InsightApi InsightExpenseNoBudget GET /v1/insight/expense/no-budget Insight into expenses, without budget.
InsightApi InsightExpenseNoCategory GET /v1/insight/expense/no-category Insight into expenses, without category.
InsightApi InsightExpenseNoTag GET /v1/insight/expense/no-tag Insight into expenses, without tag.
InsightApi InsightExpenseTag GET /v1/insight/expense/tag Insight into expenses, grouped by tag.
InsightApi InsightExpenseTotal GET /v1/insight/expense/total Insight into total expenses.
InsightApi InsightIncomeAsset GET /v1/insight/income/asset Insight into income, grouped by asset account.
InsightApi InsightIncomeCategory GET /v1/insight/income/category Insight into income, grouped by category.
InsightApi InsightIncomeNoCategory GET /v1/insight/income/no-category Insight into income, without category.
InsightApi InsightIncomeNoTag GET /v1/insight/income/no-tag Insight into income, without tag.
InsightApi InsightIncomeRevenue GET /v1/insight/income/revenue Insight into income, grouped by revenue account.
InsightApi InsightIncomeTag GET /v1/insight/income/tag Insight into income, grouped by tag.
InsightApi InsightIncomeTotal GET /v1/insight/income/total Insight into total income.
InsightApi InsightTransferCategory GET /v1/insight/transfer/category Insight into transfers, grouped by category.
InsightApi InsightTransferNoCategory GET /v1/insight/transfer/no-category Insight into transfers, without category.
InsightApi InsightTransferNoTag GET /v1/insight/transfer/no-tag Insight into expenses, without tag.
InsightApi InsightTransferTag GET /v1/insight/transfer/tag Insight into transfers, grouped by tag.
InsightApi InsightTransferTotal GET /v1/insight/transfer/total Insight into total transfers.
InsightApi InsightTransfers GET /v1/insight/transfer/asset Insight into transfers, grouped by account.
LinksApi DeleteLinkType DELETE /v1/link-types/{id} Permanently delete link type.
LinksApi DeleteTransactionLink DELETE /v1/transaction-links/{id} Permanently delete link between transactions.
LinksApi GetLinkType GET /v1/link-types/{id} Get single a link type.
LinksApi GetTransactionLink GET /v1/transaction-links/{id} Get a single link.
LinksApi ListLinkType GET /v1/link-types List all types of links.
LinksApi ListTransactionByLinkType GET /v1/link-types/{id}/transactions List all transactions under this link type.
LinksApi ListTransactionLink GET /v1/transaction-links List all transaction links.
LinksApi StoreLinkType POST /v1/link-types Create a new link type
LinksApi StoreTransactionLink POST /v1/transaction-links Create a new link between transactions
LinksApi UpdateLinkType PUT /v1/link-types/{id} Update existing link type.
LinksApi UpdateTransactionLink PUT /v1/transaction-links/{id} Update an existing link between transactions.
NetWorthApi GetNetWorth GET /v2/net-worth Shows the net worth
ObjectGroupsApi DeleteObjectGroup DELETE /v1/object-groups/{id} Delete a object group.
ObjectGroupsApi GetObjectGroup GET /v1/object-groups/{id} Get a single object group.
ObjectGroupsApi ListBillByObjectGroup GET /v1/object-groups/{id}/bills List all bills with this object group.
ObjectGroupsApi ListObjectGroups GET /v1/object-groups List all oject groups.
ObjectGroupsApi ListPiggyBankByObjectGroup GET /v1/object-groups/{id}/piggy-banks List all piggy banks related to the object group.
ObjectGroupsApi UpdateObjectGroup PUT /v1/object-groups/{id} Update existing object group.
PiggyBanksApi DeletePiggyBank DELETE /v1/piggy-banks/{id} Delete a piggy bank.
PiggyBanksApi GetPiggyBank GET /v1/piggy-banks/{id} Get a single piggy bank.
PiggyBanksApi ListAttachmentByPiggyBank GET /v1/piggy-banks/{id}/attachments Lists all attachments.
PiggyBanksApi ListEventByPiggyBank GET /v1/piggy-banks/{id}/events List all events linked to a piggy bank.
PiggyBanksApi ListPiggyBank GET /v1/piggy-banks List all piggy banks.
PiggyBanksApi StorePiggyBank POST /v1/piggy-banks Store a new piggy bank
PiggyBanksApi UpdatePiggyBank PUT /v1/piggy-banks/{id} Update existing piggy bank.
PreferencesApi GetPreference GET /v1/preferences/{name} Return a single preference.
PreferencesApi GetPreferenceV2 GET /v2/preferences/{name} Return a single preference.
PreferencesApi ListPreference GET /v1/preferences List all users preferences.
PreferencesApi StorePreference POST /v1/preferences Store a new preference for this user.
PreferencesApi UpdatePreference PUT /v1/preferences/{name} Update preference
RecurrencesApi DeleteRecurrence DELETE /v1/recurrences/{id} Delete a recurring transaction.
RecurrencesApi GetRecurrence GET /v1/recurrences/{id} Get a single recurring transaction.
RecurrencesApi ListRecurrence GET /v1/recurrences List all recurring transactions.
RecurrencesApi ListTransactionByRecurrence GET /v1/recurrences/{id}/transactions List all transactions created by a recurring transaction.
RecurrencesApi StoreRecurrence POST /v1/recurrences Store a new recurring transaction
RecurrencesApi UpdateRecurrence PUT /v1/recurrences/{id} Update existing recurring transaction.
RuleGroupsApi DeleteRuleGroup DELETE /v1/rule-groups/{id} Delete a rule group.
RuleGroupsApi FireRuleGroup POST /v1/rule-groups/{id}/trigger Fire the rule group on your transactions.
RuleGroupsApi GetRuleGroup GET /v1/rule-groups/{id} Get a single rule group.
RuleGroupsApi ListRuleByGroup GET /v1/rule-groups/{id}/rules List rules in this rule group.
RuleGroupsApi ListRuleGroup GET /v1/rule-groups List all rule groups.
RuleGroupsApi StoreRuleGroup POST /v1/rule-groups Store a new rule group.
RuleGroupsApi TestRuleGroup GET /v1/rule-groups/{id}/test Test which transactions would be hit by the rule group. No changes will be made.
RuleGroupsApi UpdateRuleGroup PUT /v1/rule-groups/{id} Update existing rule group.
RulesApi DeleteRule DELETE /v1/rules/{id} Delete an rule.
RulesApi FireRule POST /v1/rules/{id}/trigger Fire the rule on your transactions.
RulesApi GetRule GET /v1/rules/{id} Get a single rule.
RulesApi ListRule GET /v1/rules List all rules.
RulesApi StoreRule POST /v1/rules Store a new rule
RulesApi TestRule GET /v1/rules/{id}/test Test which transactions would be hit by the rule. No changes will be made.
RulesApi UpdateRule PUT /v1/rules/{id} Update existing rule.
SearchApi SearchAccounts GET /v1/search/accounts Search for accounts
SearchApi SearchTransactions GET /v1/search/transactions Search for transactions
SummaryApi GetBasicSummary GET /v1/summary/basic Returns basic sums of the users data.
TagsApi DeleteTag DELETE /v1/tags/{tag} Delete an tag.
TagsApi GetTag GET /v1/tags/{tag} Get a single tag.
TagsApi ListAttachmentByTag GET /v1/tags/{tag}/attachments Lists all attachments.
TagsApi ListTag GET /v1/tags List all tags.
TagsApi ListTransactionByTag GET /v1/tags/{tag}/transactions List all transactions with this tag.
TagsApi StoreTag POST /v1/tags Store a new tag
TagsApi UpdateTag PUT /v1/tags/{tag} Update existing tag.
TransactionsApi DeleteTransaction DELETE /v1/transactions/{id} Delete a transaction.
TransactionsApi DeleteTransactionJournal DELETE /v1/transaction-journals/{id} Delete split from transaction
TransactionsApi GetTransaction GET /v1/transactions/{id} Get a single transaction.
TransactionsApi GetTransactionByJournal GET /v1/transaction-journals/{id} Get a single transaction, based on one of the underlying transaction journals (transaction splits).
TransactionsApi ListAttachmentByTransaction GET /v1/transactions/{id}/attachments Lists all attachments.
TransactionsApi ListEventByTransaction GET /v1/transactions/{id}/piggy-bank-events Lists all piggy bank events.
TransactionsApi ListLinksByJournal GET /v1/transaction-journals/{id}/links Lists all the transaction links for an individual journal (individual split).
TransactionsApi ListTransaction GET /v1/transactions List all the user's transactions.
TransactionsApi StoreTransaction POST /v1/transactions Store a new transaction
TransactionsApi UpdateTransaction PUT /v1/transactions/{id} Update existing transaction. For more information, see https://docs.firefly-iii.org/firefly-iii/api/specials
TransactionsSumApi GetBillsPaidTrSum GET /v2/bills/sum/paid Returns the sum of the bills already paid in the period indicated.
TransactionsSumApi GetBillsUnpaidTrSum GET /v2/bills/sum/unpaid Returns the sum of the bills not yet paid in the period indicated.
UsersApi DeleteUser DELETE /v1/users/{id} Delete a user.
UsersApi GetUser GET /v1/users/{id} Get a single user.
UsersApi ListUser GET /v1/users List all users.
UsersApi StoreUser POST /v1/users Store a new user
UsersApi UpdateUser PUT /v1/users/{id} Update an existing user's information.
WebhooksApi DeleteWebhook DELETE /v1/webhooks/{id} Delete a webhook.
WebhooksApi DeleteWebhookMessage DELETE /v1/webhooks/{id}/messages/{messageId} Delete a webhook message.
WebhooksApi DeleteWebhookMessageAttempt DELETE /v1/webhooks/{id}/messages/{messageId}/attempts/{attemptId} Delete a webhook attempt.
WebhooksApi GetSingleWebhookMessage GET /v1/webhooks/{id}/messages/{messageId} Get a single message from a webhook.
WebhooksApi GetSingleWebhookMessageAttempt GET /v1/webhooks/{id}/messages/{messageId}/attempts/{attemptId} Get a single failed attempt from a single webhook message.
WebhooksApi GetWebhook GET /v1/webhooks/{id} Get a single webhook.
WebhooksApi GetWebhookMessageAttempts GET /v1/webhooks/{id}/messages/{messageId}/attempts Get all the failed attempts of a single webhook message.
WebhooksApi GetWebhookMessages GET /v1/webhooks/{id}/messages Get all the messages of a single webhook.
WebhooksApi ListWebhook GET /v1/webhooks List all webhooks.
WebhooksApi StoreWebhook POST /v1/webhooks Store a new webhook
WebhooksApi SubmitWebook POST /v1/webhooks/{id}/submit Submit messages for a webhook.
WebhooksApi UpdateWebhook PUT /v1/webhooks/{id} Update existing webhook.

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

firefly_iii_auth

local_bearer_auth

  • Type: Bearer Authentication