The highest tagged major version is v2.

swagger

package module

v2.0.14+incompatible Latest Latest Go to latest Published: May 11, 2024 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

gitea.stuzer.link/stuzer05/go-firefly3

README ¶

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

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	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	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	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.
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/references/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.
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	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/references/firefly-iii/api/specials/
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	TriggerTransactionWebhook	Post /v1/webhooks/{id}/trigger-transaction/{transactionId}	Trigger webhook for a given transaction.
WebhooksApi	UpdateWebhook	Put /v1/webhooks/{id}	Update existing webhook.

Documentation For Models

Documentation For Authorization

firefly_iii_auth

Type: OAuth
Flow: accessCode
Authorization URL: https://demo.firefly-iii.org/oauth/authorize
Scopes:

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

Documentation ¶

Overview ¶

* Firefly III API v2.0.14 * * 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. * * API version: 2.0.14 * Contact: james@firefly-iii.org * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index ¶

Variables
func CacheExpires(r *http.Response) time.Time
type APIClient
- func NewAPIClient(cfg *Configuration) *APIClient
- func (c *APIClient) ChangeBasePath(path string)
type APIKey
type APIResponse
- func NewAPIResponse(r *http.Response) *APIResponse
- func NewAPIResponseWithError(errorMessage string) *APIResponse
type AboutApiGetAboutOpts
type AboutApiGetCronOpts
type AboutApiGetCurrentUserOpts
type AboutApiService
- func (a *AboutApiService) GetAbout(ctx context.Context, localVarOptionals *AboutApiGetAboutOpts) (SystemInfo, *http.Response, error)
- func (a *AboutApiService) GetCron(ctx context.Context, cliToken string, localVarOptionals *AboutApiGetCronOpts) (CronResult, *http.Response, error)
- func (a *AboutApiService) GetCurrentUser(ctx context.Context, localVarOptionals *AboutApiGetCurrentUserOpts) (UserSingle, *http.Response, error)
type Account
type AccountArray
type AccountRead
type AccountRoleProperty
type AccountSearchFieldFilter
type AccountSingle
type AccountStore
type AccountTypeFilter
type AccountTypeProperty
type AccountUpdate
type AccountsApiDeleteAccountOpts
type AccountsApiGetAccountOpts
type AccountsApiListAccountOpts
type AccountsApiListAttachmentByAccountOpts
type AccountsApiListPiggyBankByAccountOpts
type AccountsApiListTransactionByAccountOpts
type AccountsApiService
- func (a *AccountsApiService) DeleteAccount(ctx context.Context, id string, ...) (*http.Response, error)
- func (a *AccountsApiService) GetAccount(ctx context.Context, id string, localVarOptionals *AccountsApiGetAccountOpts) (AccountSingle, *http.Response, error)
- func (a *AccountsApiService) ListAccount(ctx context.Context, localVarOptionals *AccountsApiListAccountOpts) (AccountArray, *http.Response, error)
- func (a *AccountsApiService) ListAttachmentByAccount(ctx context.Context, id string, ...) (AttachmentArray, *http.Response, error)
- func (a *AccountsApiService) ListPiggyBankByAccount(ctx context.Context, id string, ...) (PiggyBankArray, *http.Response, error)
- func (a *AccountsApiService) ListTransactionByAccount(ctx context.Context, id string, ...) (TransactionArray, *http.Response, error)
- func (a *AccountsApiService) StoreAccount(ctx context.Context, body AccountStore, ...) (AccountSingle, *http.Response, error)
- func (a *AccountsApiService) UpdateAccount(ctx context.Context, body AccountUpdate, id string, ...) (AccountSingle, *http.Response, error)
type AccountsApiStoreAccountOpts
type AccountsApiUpdateAccountOpts
type AttachableType
type Attachment
type AttachmentArray
type AttachmentRead
type AttachmentSingle
type AttachmentStore
type AttachmentUpdate
type AttachmentsApiDeleteAttachmentOpts
type AttachmentsApiDownloadAttachmentOpts
type AttachmentsApiGetAttachmentOpts
type AttachmentsApiListAttachmentOpts
type AttachmentsApiService
- func (a *AttachmentsApiService) DeleteAttachment(ctx context.Context, id string, ...) (*http.Response, error)
- func (a *AttachmentsApiService) DownloadAttachment(ctx context.Context, id string, ...) (*os.File, *http.Response, error)
- func (a *AttachmentsApiService) GetAttachment(ctx context.Context, id string, ...) (AttachmentSingle, *http.Response, error)
- func (a *AttachmentsApiService) ListAttachment(ctx context.Context, localVarOptionals *AttachmentsApiListAttachmentOpts) (AttachmentArray, *http.Response, error)
- func (a *AttachmentsApiService) StoreAttachment(ctx context.Context, body AttachmentStore, ...) (AttachmentSingle, *http.Response, error)
- func (a *AttachmentsApiService) UpdateAttachment(ctx context.Context, body AttachmentUpdate, id string, ...) (AttachmentSingle, *http.Response, error)
- func (a *AttachmentsApiService) UploadAttachment(ctx context.Context, id string, ...) (*http.Response, error)
type AttachmentsApiStoreAttachmentOpts
type AttachmentsApiUpdateAttachmentOpts
type AttachmentsApiUploadAttachmentOpts
type AutoBudgetPeriod
type AutoBudgetType
type AutocompleteAccount
type AutocompleteApiGetAccountsACOpts
type AutocompleteApiGetBillsACOpts
type AutocompleteApiGetBudgetsACOpts
type AutocompleteApiGetCategoriesACOpts
type AutocompleteApiGetCurrenciesACOpts
type AutocompleteApiGetCurrenciesCodeACOpts
type AutocompleteApiGetObjectGroupsACOpts
type AutocompleteApiGetPiggiesACOpts
type AutocompleteApiGetPiggiesBalanceACOpts
type AutocompleteApiGetRecurringACOpts
type AutocompleteApiGetRuleGroupsACOpts
type AutocompleteApiGetRulesACOpts
type AutocompleteApiGetTagACOpts
type AutocompleteApiGetTransactionTypesACOpts
type AutocompleteApiGetTransactionsACOpts
type AutocompleteApiGetTransactionsIDACOpts
type AutocompleteApiService
- func (a *AutocompleteApiService) GetAccountsAC(ctx context.Context, localVarOptionals *AutocompleteApiGetAccountsACOpts) ([]AutocompleteAccount, *http.Response, error)
- func (a *AutocompleteApiService) GetBillsAC(ctx context.Context, localVarOptionals *AutocompleteApiGetBillsACOpts) ([]AutocompleteBill, *http.Response, error)
- func (a *AutocompleteApiService) GetBudgetsAC(ctx context.Context, localVarOptionals *AutocompleteApiGetBudgetsACOpts) ([]AutocompleteBudget, *http.Response, error)
- func (a *AutocompleteApiService) GetCategoriesAC(ctx context.Context, localVarOptionals *AutocompleteApiGetCategoriesACOpts) ([]AutocompleteCategory, *http.Response, error)
- func (a *AutocompleteApiService) GetCurrenciesAC(ctx context.Context, localVarOptionals *AutocompleteApiGetCurrenciesACOpts) ([]AutocompleteCurrency, *http.Response, error)
- func (a *AutocompleteApiService) GetCurrenciesCodeAC(ctx context.Context, localVarOptionals *AutocompleteApiGetCurrenciesCodeACOpts) ([]AutocompleteCurrencyCode, *http.Response, error)
- func (a *AutocompleteApiService) GetObjectGroupsAC(ctx context.Context, localVarOptionals *AutocompleteApiGetObjectGroupsACOpts) ([]AutocompleteObjectGroup, *http.Response, error)
- func (a *AutocompleteApiService) GetPiggiesAC(ctx context.Context, localVarOptionals *AutocompleteApiGetPiggiesACOpts) ([]AutocompletePiggy, *http.Response, error)
- func (a *AutocompleteApiService) GetPiggiesBalanceAC(ctx context.Context, localVarOptionals *AutocompleteApiGetPiggiesBalanceACOpts) ([]AutocompletePiggyBalance, *http.Response, error)
- func (a *AutocompleteApiService) GetRecurringAC(ctx context.Context, localVarOptionals *AutocompleteApiGetRecurringACOpts) ([]AutocompleteRecurrence, *http.Response, error)
- func (a *AutocompleteApiService) GetRuleGroupsAC(ctx context.Context, localVarOptionals *AutocompleteApiGetRuleGroupsACOpts) ([]AutocompleteRuleGroup, *http.Response, error)
- func (a *AutocompleteApiService) GetRulesAC(ctx context.Context, localVarOptionals *AutocompleteApiGetRulesACOpts) ([]AutocompleteRule, *http.Response, error)
- func (a *AutocompleteApiService) GetTagAC(ctx context.Context, localVarOptionals *AutocompleteApiGetTagACOpts) ([]AutocompleteTag, *http.Response, error)
- func (a *AutocompleteApiService) GetTransactionTypesAC(ctx context.Context, ...) ([]AutocompleteTransactionType, *http.Response, error)
- func (a *AutocompleteApiService) GetTransactionsAC(ctx context.Context, localVarOptionals *AutocompleteApiGetTransactionsACOpts) ([]AutocompleteTransaction, *http.Response, error)
- func (a *AutocompleteApiService) GetTransactionsIDAC(ctx context.Context, localVarOptionals *AutocompleteApiGetTransactionsIDACOpts) ([]AutocompleteTransactionId, *http.Response, error)
type AutocompleteBill
type AutocompleteBudget
type AutocompleteCategory
type AutocompleteCurrency
type AutocompleteCurrencyCode
type AutocompleteObjectGroup
type AutocompletePiggy
type AutocompletePiggyBalance
type AutocompleteRecurrence
type AutocompleteRule
type AutocompleteRuleGroup
type AutocompleteTag
type AutocompleteTransaction
type AutocompleteTransactionId
type AutocompleteTransactionType
type AvailableBudget
type AvailableBudgetArray
type AvailableBudgetRead
type AvailableBudgetSingle
type AvailableBudgetsApiGetAvailableBudgetOpts
type AvailableBudgetsApiListAvailableBudgetOpts
type AvailableBudgetsApiService
- func (a *AvailableBudgetsApiService) GetAvailableBudget(ctx context.Context, id string, ...) (AvailableBudgetSingle, *http.Response, error)
- func (a *AvailableBudgetsApiService) ListAvailableBudget(ctx context.Context, ...) (AvailableBudgetArray, *http.Response, error)
type BadRequestResponse
type BasicAuth
type BasicSummaryEntry
type Bill
type BillArray
type BillPaidDates
type BillRead
type BillRepeatFrequency
type BillSingle
type BillStore
type BillUpdate
type BillsApiDeleteBillOpts
type BillsApiGetBillOpts
type BillsApiListAttachmentByBillOpts
type BillsApiListBillOpts
type BillsApiListRuleByBillOpts
type BillsApiListTransactionByBillOpts
type BillsApiService
- func (a *BillsApiService) DeleteBill(ctx context.Context, id string, localVarOptionals *BillsApiDeleteBillOpts) (*http.Response, error)
- func (a *BillsApiService) GetBill(ctx context.Context, id string, localVarOptionals *BillsApiGetBillOpts) (BillSingle, *http.Response, error)
- func (a *BillsApiService) ListAttachmentByBill(ctx context.Context, id string, ...) (AttachmentArray, *http.Response, error)
- func (a *BillsApiService) ListBill(ctx context.Context, localVarOptionals *BillsApiListBillOpts) (BillArray, *http.Response, error)
- func (a *BillsApiService) ListRuleByBill(ctx context.Context, id string, localVarOptionals *BillsApiListRuleByBillOpts) (RuleArray, *http.Response, error)
- func (a *BillsApiService) ListTransactionByBill(ctx context.Context, id string, ...) (TransactionArray, *http.Response, error)
- func (a *BillsApiService) StoreBill(ctx context.Context, body BillStore, localVarOptionals *BillsApiStoreBillOpts) (BillSingle, *http.Response, error)
- func (a *BillsApiService) UpdateBill(ctx context.Context, body BillUpdate, id string, ...) (BillSingle, *http.Response, error)
type BillsApiStoreBillOpts
type BillsApiUpdateBillOpts
type Budget
type BudgetArray
type BudgetLimit
type BudgetLimitArray
type BudgetLimitRead
type BudgetLimitSingle
type BudgetLimitStore
type BudgetRead
type BudgetSingle
type BudgetSpent
type BudgetStore
type BudgetUpdate
type BudgetsApiDeleteBudgetLimitOpts
type BudgetsApiDeleteBudgetOpts
type BudgetsApiGetBudgetLimitOpts
type BudgetsApiGetBudgetOpts
type BudgetsApiListAttachmentByBudgetOpts
type BudgetsApiListBudgetLimitByBudgetOpts
type BudgetsApiListBudgetLimitOpts
type BudgetsApiListBudgetOpts
type BudgetsApiListTransactionByBudgetLimitOpts
type BudgetsApiListTransactionByBudgetOpts
type BudgetsApiService
- func (a *BudgetsApiService) DeleteBudget(ctx context.Context, id string, localVarOptionals *BudgetsApiDeleteBudgetOpts) (*http.Response, error)
- func (a *BudgetsApiService) DeleteBudgetLimit(ctx context.Context, id string, limitId string, ...) (*http.Response, error)
- func (a *BudgetsApiService) GetBudget(ctx context.Context, id string, localVarOptionals *BudgetsApiGetBudgetOpts) (BudgetSingle, *http.Response, error)
- func (a *BudgetsApiService) GetBudgetLimit(ctx context.Context, id string, limitId int32, ...) (BudgetLimitSingle, *http.Response, error)
- func (a *BudgetsApiService) ListAttachmentByBudget(ctx context.Context, id string, ...) (AttachmentArray, *http.Response, error)
- func (a *BudgetsApiService) ListBudget(ctx context.Context, localVarOptionals *BudgetsApiListBudgetOpts) (BudgetArray, *http.Response, error)
- func (a *BudgetsApiService) ListBudgetLimit(ctx context.Context, start string, end string, ...) (BudgetLimitArray, *http.Response, error)
- func (a *BudgetsApiService) ListBudgetLimitByBudget(ctx context.Context, id string, ...) (BudgetLimitArray, *http.Response, error)
- func (a *BudgetsApiService) ListTransactionByBudget(ctx context.Context, id string, ...) (TransactionArray, *http.Response, error)
- func (a *BudgetsApiService) ListTransactionByBudgetLimit(ctx context.Context, id string, limitId string, ...) (TransactionArray, *http.Response, error)
- func (a *BudgetsApiService) StoreBudget(ctx context.Context, body BudgetStore, ...) (BudgetSingle, *http.Response, error)
- func (a *BudgetsApiService) StoreBudgetLimit(ctx context.Context, body BudgetLimitStore, id string, ...) (BudgetLimitSingle, *http.Response, error)
- func (a *BudgetsApiService) UpdateBudget(ctx context.Context, body BudgetUpdate, id string, ...) (BudgetSingle, *http.Response, error)
- func (a *BudgetsApiService) UpdateBudgetLimit(ctx context.Context, body BudgetLimit, id string, limitId string, ...) (BudgetLimitSingle, *http.Response, error)
type BudgetsApiStoreBudgetLimitOpts
type BudgetsApiStoreBudgetOpts
type BudgetsApiUpdateBudgetLimitOpts
type BudgetsApiUpdateBudgetOpts
type CategoriesApiDeleteCategoryOpts
type CategoriesApiGetCategoryOpts
type CategoriesApiListAttachmentByCategoryOpts
type CategoriesApiListCategoryOpts
type CategoriesApiListTransactionByCategoryOpts
type CategoriesApiService
- func (a *CategoriesApiService) DeleteCategory(ctx context.Context, id string, ...) (*http.Response, error)
- func (a *CategoriesApiService) GetCategory(ctx context.Context, id string, ...) (CategorySingle, *http.Response, error)
- func (a *CategoriesApiService) ListAttachmentByCategory(ctx context.Context, id string, ...) (AttachmentArray, *http.Response, error)
- func (a *CategoriesApiService) ListCategory(ctx context.Context, localVarOptionals *CategoriesApiListCategoryOpts) (CategoryArray, *http.Response, error)
- func (a *CategoriesApiService) ListTransactionByCategory(ctx context.Context, id string, ...) (TransactionArray, *http.Response, error)
- func (a *CategoriesApiService) StoreCategory(ctx context.Context, body Category, ...) (CategorySingle, *http.Response, error)
- func (a *CategoriesApiService) UpdateCategory(ctx context.Context, body CategoryUpdate, id string, ...) (CategorySingle, *http.Response, error)
type CategoriesApiStoreCategoryOpts
type CategoriesApiUpdateCategoryOpts
type Category
type CategoryArray
type CategoryEarned
type CategoryRead
type CategorySingle
type CategorySpent
type CategoryUpdate
type ChartDataPoint
type ChartDataSet
type ChartsApiGetChartAccountOverviewOpts
type ChartsApiService
- func (a *ChartsApiService) GetChartAccountOverview(ctx context.Context, start string, end string, ...) ([]ChartDataSet, *http.Response, error)
type ConfigValueFilter
type ConfigValueUpdateFilter
type Configuration
- func NewConfiguration() *Configuration
- func (c *Configuration) AddDefaultHeader(key string, value string)
type ConfigurationApiGetConfigurationOpts
type ConfigurationApiGetSingleConfigurationOpts
type ConfigurationApiService
- func (a *ConfigurationApiService) GetConfiguration(ctx context.Context, localVarOptionals *ConfigurationApiGetConfigurationOpts) ([]Configuration, *http.Response, error)
- func (a *ConfigurationApiService) GetSingleConfiguration(ctx context.Context, name ConfigValueFilter, ...) (ConfigurationSingle, *http.Response, error)
- func (a *ConfigurationApiService) SetConfiguration(ctx context.Context, value PolymorphicProperty, name ConfigValueUpdateFilter, ...) (ConfigurationSingle, *http.Response, error)
type ConfigurationApiSetConfigurationOpts
type ConfigurationSingle
type ConfigurationUpdate
type CreditCardTypeProperty
type CronResult
type CronResultRow
type CurrenciesApiDefaultCurrencyOpts
type CurrenciesApiDeleteCurrencyOpts
type CurrenciesApiDisableCurrencyOpts
type CurrenciesApiEnableCurrencyOpts
type CurrenciesApiGetCurrencyOpts
type CurrenciesApiGetDefaultCurrencyOpts
type CurrenciesApiListAccountByCurrencyOpts
type CurrenciesApiListAvailableBudgetByCurrencyOpts
type CurrenciesApiListBillByCurrencyOpts
type CurrenciesApiListBudgetLimitByCurrencyOpts
type CurrenciesApiListCurrencyOpts
type CurrenciesApiListRecurrenceByCurrencyOpts
type CurrenciesApiListRuleByCurrencyOpts
type CurrenciesApiListTransactionByCurrencyOpts
type CurrenciesApiService
- func (a *CurrenciesApiService) DefaultCurrency(ctx context.Context, code string, ...) (CurrencySingle, *http.Response, error)
- func (a *CurrenciesApiService) DeleteCurrency(ctx context.Context, code string, ...) (*http.Response, error)
- func (a *CurrenciesApiService) DisableCurrency(ctx context.Context, code string, ...) (CurrencySingle, *http.Response, error)
- func (a *CurrenciesApiService) EnableCurrency(ctx context.Context, code string, ...) (CurrencySingle, *http.Response, error)
- func (a *CurrenciesApiService) GetCurrency(ctx context.Context, code string, ...) (CurrencySingle, *http.Response, error)
- func (a *CurrenciesApiService) GetDefaultCurrency(ctx context.Context, localVarOptionals *CurrenciesApiGetDefaultCurrencyOpts) (CurrencySingle, *http.Response, error)
- func (a *CurrenciesApiService) ListAccountByCurrency(ctx context.Context, code string, ...) (AccountArray, *http.Response, error)
- func (a *CurrenciesApiService) ListAvailableBudgetByCurrency(ctx context.Context, code string, ...) (AvailableBudgetArray, *http.Response, error)
- func (a *CurrenciesApiService) ListBillByCurrency(ctx context.Context, code string, ...) (BillArray, *http.Response, error)
- func (a *CurrenciesApiService) ListBudgetLimitByCurrency(ctx context.Context, code string, ...) (BudgetLimitArray, *http.Response, error)
- func (a *CurrenciesApiService) ListCurrency(ctx context.Context, localVarOptionals *CurrenciesApiListCurrencyOpts) (CurrencyArray, *http.Response, error)
- func (a *CurrenciesApiService) ListRecurrenceByCurrency(ctx context.Context, code string, ...) (RecurrenceArray, *http.Response, error)
- func (a *CurrenciesApiService) ListRuleByCurrency(ctx context.Context, code string, ...) (RuleArray, *http.Response, error)
- func (a *CurrenciesApiService) ListTransactionByCurrency(ctx context.Context, code string, ...) (TransactionArray, *http.Response, error)
- func (a *CurrenciesApiService) StoreCurrency(ctx context.Context, body CurrencyStore, ...) (CurrencySingle, *http.Response, error)
- func (a *CurrenciesApiService) UpdateCurrency(ctx context.Context, body CurrencyUpdate, code string, ...) (CurrencySingle, *http.Response, error)
type CurrenciesApiStoreCurrencyOpts
type CurrenciesApiUpdateCurrencyOpts
type Currency
type CurrencyArray
type CurrencyRead
type CurrencySingle
type CurrencyStore
type CurrencyUpdate
type DataApiDestroyDataOpts
type DataApiExportAccountsOpts
type DataApiExportBillsOpts
type DataApiExportBudgetsOpts
type DataApiExportCategoriesOpts
type DataApiExportPiggiesOpts
type DataApiExportRecurringOpts
type DataApiExportRulesOpts
type DataApiExportTagsOpts
type DataApiExportTransactionsOpts
type DataApiPurgeDataOpts
type DataApiService
- func (a *DataApiService) BulkUpdateTransactions(ctx context.Context, query string) (*http.Response, error)
- func (a *DataApiService) DestroyData(ctx context.Context, objects DataDestroyObject, ...) (*http.Response, error)
- func (a *DataApiService) ExportAccounts(ctx context.Context, localVarOptionals *DataApiExportAccountsOpts) (*os.File, *http.Response, error)
- func (a *DataApiService) ExportBills(ctx context.Context, localVarOptionals *DataApiExportBillsOpts) (*os.File, *http.Response, error)
- func (a *DataApiService) ExportBudgets(ctx context.Context, localVarOptionals *DataApiExportBudgetsOpts) (*os.File, *http.Response, error)
- func (a *DataApiService) ExportCategories(ctx context.Context, localVarOptionals *DataApiExportCategoriesOpts) (*os.File, *http.Response, error)
- func (a *DataApiService) ExportPiggies(ctx context.Context, localVarOptionals *DataApiExportPiggiesOpts) (*os.File, *http.Response, error)
- func (a *DataApiService) ExportRecurring(ctx context.Context, localVarOptionals *DataApiExportRecurringOpts) (*os.File, *http.Response, error)
- func (a *DataApiService) ExportRules(ctx context.Context, localVarOptionals *DataApiExportRulesOpts) (*os.File, *http.Response, error)
- func (a *DataApiService) ExportTags(ctx context.Context, localVarOptionals *DataApiExportTagsOpts) (*os.File, *http.Response, error)
- func (a *DataApiService) ExportTransactions(ctx context.Context, start string, end string, ...) (*os.File, *http.Response, error)
- func (a *DataApiService) PurgeData(ctx context.Context, localVarOptionals *DataApiPurgeDataOpts) (*http.Response, error)
type DataDestroyObject
type ExportFileFilter
type GenericSwaggerError
- func (e GenericSwaggerError) Body() []byte
- func (e GenericSwaggerError) Error() string
- func (e GenericSwaggerError) Model() interface{}
type InsightApiInsightExpenseAssetOpts
type InsightApiInsightExpenseBillOpts
type InsightApiInsightExpenseBudgetOpts
type InsightApiInsightExpenseCategoryOpts
type InsightApiInsightExpenseExpenseOpts
type InsightApiInsightExpenseNoBillOpts
type InsightApiInsightExpenseNoBudgetOpts
type InsightApiInsightExpenseNoCategoryOpts
type InsightApiInsightExpenseNoTagOpts
type InsightApiInsightExpenseTagOpts
type InsightApiInsightExpenseTotalOpts
type InsightApiInsightIncomeAssetOpts
type InsightApiInsightIncomeCategoryOpts
type InsightApiInsightIncomeNoCategoryOpts
type InsightApiInsightIncomeNoTagOpts
type InsightApiInsightIncomeRevenueOpts
type InsightApiInsightIncomeTagOpts
type InsightApiInsightIncomeTotalOpts
type InsightApiInsightTransferCategoryOpts
type InsightApiInsightTransferNoCategoryOpts
type InsightApiInsightTransferNoTagOpts
type InsightApiInsightTransferTagOpts
type InsightApiInsightTransferTotalOpts
type InsightApiInsightTransfersOpts
type InsightApiService
- func (a *InsightApiService) InsightExpenseAsset(ctx context.Context, start string, end string, ...) ([]InsightGroupEntry, *http.Response, error)
- func (a *InsightApiService) InsightExpenseBill(ctx context.Context, start string, end string, ...) ([]InsightGroupEntry, *http.Response, error)
- func (a *InsightApiService) InsightExpenseBudget(ctx context.Context, start string, end string, ...) ([]InsightGroupEntry, *http.Response, error)
- func (a *InsightApiService) InsightExpenseCategory(ctx context.Context, start string, end string, ...) ([]InsightGroupEntry, *http.Response, error)
- func (a *InsightApiService) InsightExpenseExpense(ctx context.Context, start string, end string, ...) ([]InsightGroupEntry, *http.Response, error)
- func (a *InsightApiService) InsightExpenseNoBill(ctx context.Context, start string, end string, ...) ([]InsightTotalEntry, *http.Response, error)
- func (a *InsightApiService) InsightExpenseNoBudget(ctx context.Context, start string, end string, ...) ([]InsightTotalEntry, *http.Response, error)
- func (a *InsightApiService) InsightExpenseNoCategory(ctx context.Context, start string, end string, ...) ([]InsightTotalEntry, *http.Response, error)
- func (a *InsightApiService) InsightExpenseNoTag(ctx context.Context, start string, end string, ...) ([]InsightTotalEntry, *http.Response, error)
- func (a *InsightApiService) InsightExpenseTag(ctx context.Context, start string, end string, ...) ([]InsightGroupEntry, *http.Response, error)
- func (a *InsightApiService) InsightExpenseTotal(ctx context.Context, start string, end string, ...) ([]InsightTotalEntry, *http.Response, error)
- func (a *InsightApiService) InsightIncomeAsset(ctx context.Context, start string, end string, ...) ([]InsightGroupEntry, *http.Response, error)
- func (a *InsightApiService) InsightIncomeCategory(ctx context.Context, start string, end string, ...) ([]InsightGroupEntry, *http.Response, error)
- func (a *InsightApiService) InsightIncomeNoCategory(ctx context.Context, start string, end string, ...) ([]InsightTotalEntry, *http.Response, error)
- func (a *InsightApiService) InsightIncomeNoTag(ctx context.Context, start string, end string, ...) ([]InsightTotalEntry, *http.Response, error)
- func (a *InsightApiService) InsightIncomeRevenue(ctx context.Context, start string, end string, ...) ([]InsightGroupEntry, *http.Response, error)
- func (a *InsightApiService) InsightIncomeTag(ctx context.Context, start string, end string, ...) ([]InsightGroupEntry, *http.Response, error)
- func (a *InsightApiService) InsightIncomeTotal(ctx context.Context, start string, end string, ...) ([]InsightTotalEntry, *http.Response, error)
- func (a *InsightApiService) InsightTransferCategory(ctx context.Context, start string, end string, ...) ([]InsightGroupEntry, *http.Response, error)
- func (a *InsightApiService) InsightTransferNoCategory(ctx context.Context, start string, end string, ...) ([]InsightTotalEntry, *http.Response, error)
- func (a *InsightApiService) InsightTransferNoTag(ctx context.Context, start string, end string, ...) ([]InsightTotalEntry, *http.Response, error)
- func (a *InsightApiService) InsightTransferTag(ctx context.Context, start string, end string, ...) ([]InsightGroupEntry, *http.Response, error)
- func (a *InsightApiService) InsightTransferTotal(ctx context.Context, start string, end string, ...) ([]InsightTotalEntry, *http.Response, error)
- func (a *InsightApiService) InsightTransfers(ctx context.Context, start string, end string, ...) ([]InsightTransferEntry, *http.Response, error)
type InsightGroupEntry
type InsightTotalEntry
type InsightTransferEntry
type InterestPeriodProperty
type InternalExceptionResponse
type LiabilityDirectionProperty
type LiabilityTypeProperty
type LinkType
type LinkTypeArray
type LinkTypeRead
type LinkTypeSingle
type LinkTypeUpdate
type LinksApiDeleteLinkTypeOpts
type LinksApiDeleteTransactionLinkOpts
type LinksApiGetLinkTypeOpts
type LinksApiGetTransactionLinkOpts
type LinksApiListLinkTypeOpts
type LinksApiListTransactionByLinkTypeOpts
type LinksApiListTransactionLinkOpts
type LinksApiService
- func (a *LinksApiService) DeleteLinkType(ctx context.Context, id string, localVarOptionals *LinksApiDeleteLinkTypeOpts) (*http.Response, error)
- func (a *LinksApiService) DeleteTransactionLink(ctx context.Context, id string, ...) (*http.Response, error)
- func (a *LinksApiService) GetLinkType(ctx context.Context, id string, localVarOptionals *LinksApiGetLinkTypeOpts) (LinkTypeSingle, *http.Response, error)
- func (a *LinksApiService) GetTransactionLink(ctx context.Context, id string, ...) (TransactionLinkSingle, *http.Response, error)
- func (a *LinksApiService) ListLinkType(ctx context.Context, localVarOptionals *LinksApiListLinkTypeOpts) (LinkTypeArray, *http.Response, error)
- func (a *LinksApiService) ListTransactionByLinkType(ctx context.Context, id string, ...) (TransactionArray, *http.Response, error)
- func (a *LinksApiService) ListTransactionLink(ctx context.Context, localVarOptionals *LinksApiListTransactionLinkOpts) (TransactionLinkArray, *http.Response, error)
- func (a *LinksApiService) StoreLinkType(ctx context.Context, body LinkType, ...) (LinkTypeSingle, *http.Response, error)
- func (a *LinksApiService) StoreTransactionLink(ctx context.Context, body TransactionLinkStore, ...) (TransactionLinkSingle, *http.Response, error)
- func (a *LinksApiService) UpdateLinkType(ctx context.Context, body LinkTypeUpdate, id string, ...) (LinkTypeSingle, *http.Response, error)
- func (a *LinksApiService) UpdateTransactionLink(ctx context.Context, body TransactionLinkUpdate, id string, ...) (TransactionLinkSingle, *http.Response, error)
type LinksApiStoreLinkTypeOpts
type LinksApiStoreTransactionLinkOpts
type LinksApiUpdateLinkTypeOpts
type LinksApiUpdateTransactionLinkOpts
type Meta
type MetaPagination
type NotFoundResponse
type ObjectGroup
type ObjectGroupArray
type ObjectGroupRead
type ObjectGroupSingle
type ObjectGroupUpdate
type ObjectGroupsApiDeleteObjectGroupOpts
type ObjectGroupsApiGetObjectGroupOpts
type ObjectGroupsApiListBillByObjectGroupOpts
type ObjectGroupsApiListObjectGroupsOpts
type ObjectGroupsApiListPiggyBankByObjectGroupOpts
type ObjectGroupsApiService
- func (a *ObjectGroupsApiService) DeleteObjectGroup(ctx context.Context, id string, ...) (*http.Response, error)
- func (a *ObjectGroupsApiService) GetObjectGroup(ctx context.Context, id string, ...) (ObjectGroupSingle, *http.Response, error)
- func (a *ObjectGroupsApiService) ListBillByObjectGroup(ctx context.Context, id string, ...) (BillArray, *http.Response, error)
- func (a *ObjectGroupsApiService) ListObjectGroups(ctx context.Context, localVarOptionals *ObjectGroupsApiListObjectGroupsOpts) (ObjectGroupArray, *http.Response, error)
- func (a *ObjectGroupsApiService) ListPiggyBankByObjectGroup(ctx context.Context, id string, ...) (PiggyBankArray, *http.Response, error)
- func (a *ObjectGroupsApiService) UpdateObjectGroup(ctx context.Context, body ObjectGroupUpdate, id string, ...) (ObjectGroupSingle, *http.Response, error)
type ObjectGroupsApiUpdateObjectGroupOpts
type ObjectLink
type ObjectLink0
type PageLink
type PiggyBank
type PiggyBankArray
type PiggyBankEvent
type PiggyBankEventArray
type PiggyBankEventRead
type PiggyBankRead
type PiggyBankSingle
type PiggyBankStore
type PiggyBankUpdate
type PiggyBanksApiDeletePiggyBankOpts
type PiggyBanksApiGetPiggyBankOpts
type PiggyBanksApiListAttachmentByPiggyBankOpts
type PiggyBanksApiListEventByPiggyBankOpts
type PiggyBanksApiListPiggyBankOpts
type PiggyBanksApiService
- func (a *PiggyBanksApiService) DeletePiggyBank(ctx context.Context, id string, ...) (*http.Response, error)
- func (a *PiggyBanksApiService) GetPiggyBank(ctx context.Context, id string, ...) (PiggyBankSingle, *http.Response, error)
- func (a *PiggyBanksApiService) ListAttachmentByPiggyBank(ctx context.Context, id string, ...) (AttachmentArray, *http.Response, error)
- func (a *PiggyBanksApiService) ListEventByPiggyBank(ctx context.Context, id string, ...) (PiggyBankEventArray, *http.Response, error)
- func (a *PiggyBanksApiService) ListPiggyBank(ctx context.Context, localVarOptionals *PiggyBanksApiListPiggyBankOpts) (PiggyBankArray, *http.Response, error)
- func (a *PiggyBanksApiService) StorePiggyBank(ctx context.Context, body PiggyBankStore, ...) (PiggyBankSingle, *http.Response, error)
- func (a *PiggyBanksApiService) UpdatePiggyBank(ctx context.Context, body PiggyBankUpdate, id string, ...) (PiggyBankSingle, *http.Response, error)
type PiggyBanksApiStorePiggyBankOpts
type PiggyBanksApiUpdatePiggyBankOpts
type PolymorphicProperty
type Preference
type PreferenceArray
type PreferenceRead
type PreferenceSingle
type PreferenceUpdate
type PreferencesApiGetPreferenceOpts
type PreferencesApiListPreferenceOpts
type PreferencesApiService
- func (a *PreferencesApiService) GetPreference(ctx context.Context, name string, ...) (PreferenceSingle, *http.Response, error)
- func (a *PreferencesApiService) ListPreference(ctx context.Context, localVarOptionals *PreferencesApiListPreferenceOpts) (PreferenceArray, *http.Response, error)
- func (a *PreferencesApiService) StorePreference(ctx context.Context, body Preference, ...) (PreferenceSingle, *http.Response, error)
- func (a *PreferencesApiService) UpdatePreference(ctx context.Context, body PreferenceUpdate, name string, ...) (PreferenceSingle, *http.Response, error)
type PreferencesApiStorePreferenceOpts
type PreferencesApiUpdatePreferenceOpts
type Recurrence
type RecurrenceArray
type RecurrenceRead
type RecurrenceRepetition
type RecurrenceRepetitionStore
type RecurrenceRepetitionType
type RecurrenceRepetitionUpdate
type RecurrenceSingle
type RecurrenceStore
type RecurrenceTransaction
type RecurrenceTransactionStore
type RecurrenceTransactionType
type RecurrenceTransactionUpdate
type RecurrenceUpdate
type RecurrencesApiDeleteRecurrenceOpts
type RecurrencesApiGetRecurrenceOpts
type RecurrencesApiListRecurrenceOpts
type RecurrencesApiListTransactionByRecurrenceOpts
type RecurrencesApiService
- func (a *RecurrencesApiService) DeleteRecurrence(ctx context.Context, id string, ...) (*http.Response, error)
- func (a *RecurrencesApiService) GetRecurrence(ctx context.Context, id string, ...) (RecurrenceSingle, *http.Response, error)
- func (a *RecurrencesApiService) ListRecurrence(ctx context.Context, localVarOptionals *RecurrencesApiListRecurrenceOpts) (RecurrenceArray, *http.Response, error)
- func (a *RecurrencesApiService) ListTransactionByRecurrence(ctx context.Context, id string, ...) (TransactionArray, *http.Response, error)
- func (a *RecurrencesApiService) StoreRecurrence(ctx context.Context, body RecurrenceStore, ...) (RecurrenceSingle, *http.Response, error)
- func (a *RecurrencesApiService) UpdateRecurrence(ctx context.Context, body RecurrenceUpdate, id string, ...) (RecurrenceSingle, *http.Response, error)
type RecurrencesApiStoreRecurrenceOpts
type RecurrencesApiUpdateRecurrenceOpts
type Rule
type RuleAction
type RuleActionKeyword
type RuleActionStore
type RuleActionUpdate
type RuleArray
type RuleGroup
type RuleGroupArray
type RuleGroupRead
type RuleGroupSingle
type RuleGroupStore
type RuleGroupUpdate
type RuleGroupsApiDeleteRuleGroupOpts
type RuleGroupsApiFireRuleGroupOpts
type RuleGroupsApiGetRuleGroupOpts
type RuleGroupsApiListRuleByGroupOpts
type RuleGroupsApiListRuleGroupOpts
type RuleGroupsApiService
- func (a *RuleGroupsApiService) DeleteRuleGroup(ctx context.Context, id string, ...) (*http.Response, error)
- func (a *RuleGroupsApiService) FireRuleGroup(ctx context.Context, id string, ...) (*http.Response, error)
- func (a *RuleGroupsApiService) GetRuleGroup(ctx context.Context, id string, ...) (RuleGroupSingle, *http.Response, error)
- func (a *RuleGroupsApiService) ListRuleByGroup(ctx context.Context, id string, ...) (RuleArray, *http.Response, error)
- func (a *RuleGroupsApiService) ListRuleGroup(ctx context.Context, localVarOptionals *RuleGroupsApiListRuleGroupOpts) (RuleGroupArray, *http.Response, error)
- func (a *RuleGroupsApiService) StoreRuleGroup(ctx context.Context, body RuleGroupStore, ...) (RuleGroupSingle, *http.Response, error)
- func (a *RuleGroupsApiService) TestRuleGroup(ctx context.Context, id string, ...) (TransactionArray, *http.Response, error)
- func (a *RuleGroupsApiService) UpdateRuleGroup(ctx context.Context, body RuleGroupUpdate, id string, ...) (RuleGroupSingle, *http.Response, error)
type RuleGroupsApiStoreRuleGroupOpts
type RuleGroupsApiTestRuleGroupOpts
type RuleGroupsApiUpdateRuleGroupOpts
type RuleRead
type RuleSingle
type RuleStore
type RuleTrigger
type RuleTriggerKeyword
type RuleTriggerStore
type RuleTriggerType
type RuleTriggerUpdate
type RuleUpdate
type RulesApiDeleteRuleOpts
type RulesApiFireRuleOpts
type RulesApiGetRuleOpts
type RulesApiListRuleOpts
type RulesApiService
- func (a *RulesApiService) DeleteRule(ctx context.Context, id string, localVarOptionals *RulesApiDeleteRuleOpts) (*http.Response, error)
- func (a *RulesApiService) FireRule(ctx context.Context, id string, localVarOptionals *RulesApiFireRuleOpts) (*http.Response, error)
- func (a *RulesApiService) GetRule(ctx context.Context, id string, localVarOptionals *RulesApiGetRuleOpts) (RuleSingle, *http.Response, error)
- func (a *RulesApiService) ListRule(ctx context.Context, localVarOptionals *RulesApiListRuleOpts) (RuleArray, *http.Response, error)
- func (a *RulesApiService) StoreRule(ctx context.Context, body RuleStore, localVarOptionals *RulesApiStoreRuleOpts) (RuleSingle, *http.Response, error)
- func (a *RulesApiService) TestRule(ctx context.Context, id string, localVarOptionals *RulesApiTestRuleOpts) (TransactionArray, *http.Response, error)
- func (a *RulesApiService) UpdateRule(ctx context.Context, body RuleUpdate, id string, ...) (RuleSingle, *http.Response, error)
type RulesApiStoreRuleOpts
type RulesApiTestRuleOpts
type RulesApiUpdateRuleOpts
type SearchApiSearchAccountsOpts
type SearchApiSearchTransactionsOpts
type SearchApiService
- func (a *SearchApiService) SearchAccounts(ctx context.Context, query string, field AccountSearchFieldFilter, ...) (AccountArray, *http.Response, error)
- func (a *SearchApiService) SearchTransactions(ctx context.Context, query string, ...) (TransactionArray, *http.Response, error)
type ShortAccountTypeProperty
type SummaryApiGetBasicSummaryOpts
type SummaryApiService
- func (a *SummaryApiService) GetBasicSummary(ctx context.Context, start string, end string, ...) (map[string]BasicSummaryEntry, *http.Response, error)
type SystemInfo
type SystemInfoData
type TagArray
type TagModel
type TagModelStore
type TagModelUpdate
type TagRead
type TagSingle
type TagsApiDeleteTagOpts
type TagsApiGetTagOpts
type TagsApiListAttachmentByTagOpts
type TagsApiListTagOpts
type TagsApiListTransactionByTagOpts
type TagsApiService
- func (a *TagsApiService) DeleteTag(ctx context.Context, tag string, localVarOptionals *TagsApiDeleteTagOpts) (*http.Response, error)
- func (a *TagsApiService) GetTag(ctx context.Context, tag string, localVarOptionals *TagsApiGetTagOpts) (TagSingle, *http.Response, error)
- func (a *TagsApiService) ListAttachmentByTag(ctx context.Context, tag string, ...) (AttachmentArray, *http.Response, error)
- func (a *TagsApiService) ListTag(ctx context.Context, localVarOptionals *TagsApiListTagOpts) (TagArray, *http.Response, error)
- func (a *TagsApiService) ListTransactionByTag(ctx context.Context, tag string, ...) (TransactionArray, *http.Response, error)
- func (a *TagsApiService) StoreTag(ctx context.Context, body TagModelStore, ...) (TagSingle, *http.Response, error)
- func (a *TagsApiService) UpdateTag(ctx context.Context, body TagModelUpdate, tag string, ...) (TagSingle, *http.Response, error)
type TagsApiStoreTagOpts
type TagsApiUpdateTagOpts
type Transaction
type TransactionArray
type TransactionLink
type TransactionLinkArray
type TransactionLinkRead
type TransactionLinkSingle
type TransactionLinkStore
type TransactionLinkUpdate
type TransactionRead
type TransactionSingle
type TransactionSplit
type TransactionSplitStore
type TransactionSplitUpdate
type TransactionStore
type TransactionTypeFilter
type TransactionTypeProperty
type TransactionUpdate
type TransactionsApiDeleteTransactionJournalOpts
type TransactionsApiDeleteTransactionOpts
type TransactionsApiGetTransactionByJournalOpts
type TransactionsApiGetTransactionOpts
type TransactionsApiListAttachmentByTransactionOpts
type TransactionsApiListEventByTransactionOpts
type TransactionsApiListLinksByJournalOpts
type TransactionsApiListTransactionOpts
type TransactionsApiService
- func (a *TransactionsApiService) DeleteTransaction(ctx context.Context, id string, ...) (*http.Response, error)
- func (a *TransactionsApiService) DeleteTransactionJournal(ctx context.Context, id string, ...) (*http.Response, error)
- func (a *TransactionsApiService) GetTransaction(ctx context.Context, id string, ...) (TransactionSingle, *http.Response, error)
- func (a *TransactionsApiService) GetTransactionByJournal(ctx context.Context, id string, ...) (TransactionSingle, *http.Response, error)
- func (a *TransactionsApiService) ListAttachmentByTransaction(ctx context.Context, id string, ...) (AttachmentArray, *http.Response, error)
- func (a *TransactionsApiService) ListEventByTransaction(ctx context.Context, id string, ...) (PiggyBankEventArray, *http.Response, error)
- func (a *TransactionsApiService) ListLinksByJournal(ctx context.Context, id string, ...) (TransactionLinkArray, *http.Response, error)
- func (a *TransactionsApiService) ListTransaction(ctx context.Context, localVarOptionals *TransactionsApiListTransactionOpts) (TransactionArray, *http.Response, error)
- func (a *TransactionsApiService) StoreTransaction(ctx context.Context, body TransactionStore, ...) (TransactionSingle, *http.Response, error)
- func (a *TransactionsApiService) UpdateTransaction(ctx context.Context, body TransactionUpdate, id string, ...) (TransactionSingle, *http.Response, error)
type TransactionsApiStoreTransactionOpts
type TransactionsApiUpdateTransactionOpts
type UnauthenticatedResponse
type User
type UserArray
type UserBlockedCodeProperty
type UserRead
type UserRoleProperty
type UserSingle
type UsersApiDeleteUserOpts
type UsersApiGetUserOpts
type UsersApiListUserOpts
type UsersApiService
- func (a *UsersApiService) DeleteUser(ctx context.Context, id string, localVarOptionals *UsersApiDeleteUserOpts) (*http.Response, error)
- func (a *UsersApiService) GetUser(ctx context.Context, id string, localVarOptionals *UsersApiGetUserOpts) (UserSingle, *http.Response, error)
- func (a *UsersApiService) ListUser(ctx context.Context, localVarOptionals *UsersApiListUserOpts) (UserArray, *http.Response, error)
- func (a *UsersApiService) StoreUser(ctx context.Context, body User, localVarOptionals *UsersApiStoreUserOpts) (UserSingle, *http.Response, error)
- func (a *UsersApiService) UpdateUser(ctx context.Context, body User, id string, ...) (UserSingle, *http.Response, error)
type UsersApiStoreUserOpts
type UsersApiUpdateUserOpts
type ValidationErrorResponse
type ValidationErrorResponseErrors
type Webhook
type WebhookArray
type WebhookAttempt
type WebhookAttemptArray
type WebhookAttemptRead
type WebhookAttemptSingle
type WebhookDelivery
type WebhookMessage
type WebhookMessageArray
type WebhookMessageRead
type WebhookMessageSingle
type WebhookRead
type WebhookResponse
type WebhookSingle
type WebhookStore
type WebhookTrigger
type WebhookUpdate
type WebhooksApiDeleteWebhookMessageAttemptOpts
type WebhooksApiDeleteWebhookMessageOpts
type WebhooksApiDeleteWebhookOpts
type WebhooksApiGetSingleWebhookMessageAttemptOpts
type WebhooksApiGetSingleWebhookMessageOpts
type WebhooksApiGetWebhookMessageAttemptsOpts
type WebhooksApiGetWebhookMessagesOpts
type WebhooksApiGetWebhookOpts
type WebhooksApiListWebhookOpts
type WebhooksApiService
- func (a *WebhooksApiService) DeleteWebhook(ctx context.Context, id string, ...) (*http.Response, error)
- func (a *WebhooksApiService) DeleteWebhookMessage(ctx context.Context, id string, messageId int32, ...) (*http.Response, error)
- func (a *WebhooksApiService) DeleteWebhookMessageAttempt(ctx context.Context, id string, messageId int32, attemptId int32, ...) (*http.Response, error)
- func (a *WebhooksApiService) GetSingleWebhookMessage(ctx context.Context, id string, messageId int32, ...) (WebhookMessageSingle, *http.Response, error)
- func (a *WebhooksApiService) GetSingleWebhookMessageAttempt(ctx context.Context, id string, messageId int32, attemptId int32, ...) (WebhookAttemptSingle, *http.Response, error)
- func (a *WebhooksApiService) GetWebhook(ctx context.Context, id string, localVarOptionals *WebhooksApiGetWebhookOpts) (WebhookSingle, *http.Response, error)
- func (a *WebhooksApiService) GetWebhookMessageAttempts(ctx context.Context, id string, messageId int32, ...) (WebhookAttemptArray, *http.Response, error)
- func (a *WebhooksApiService) GetWebhookMessages(ctx context.Context, id string, ...) (WebhookMessageArray, *http.Response, error)
- func (a *WebhooksApiService) ListWebhook(ctx context.Context, localVarOptionals *WebhooksApiListWebhookOpts) (WebhookArray, *http.Response, error)
- func (a *WebhooksApiService) StoreWebhook(ctx context.Context, body WebhookStore, ...) (WebhookSingle, *http.Response, error)
- func (a *WebhooksApiService) SubmitWebook(ctx context.Context, id string, localVarOptionals *WebhooksApiSubmitWebookOpts) (*http.Response, error)
- func (a *WebhooksApiService) TriggerTransactionWebhook(ctx context.Context, id string, transactionId string, ...) (*http.Response, error)
- func (a *WebhooksApiService) UpdateWebhook(ctx context.Context, body WebhookUpdate, id string, ...) (WebhookSingle, *http.Response, error)
type WebhooksApiStoreWebhookOpts
type WebhooksApiSubmitWebookOpts
type WebhooksApiTriggerTransactionWebhookOpts
type WebhooksApiUpdateWebhookOpts

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions ¶

func CacheExpires ¶

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types ¶

type APIClient ¶

type APIClient struct {
	AboutApi *AboutApiService

	AccountsApi *AccountsApiService

	AttachmentsApi *AttachmentsApiService

	AutocompleteApi *AutocompleteApiService

	AvailableBudgetsApi *AvailableBudgetsApiService

	BillsApi *BillsApiService

	BudgetsApi *BudgetsApiService

	CategoriesApi *CategoriesApiService

	ChartsApi *ChartsApiService

	ConfigurationApi *ConfigurationApiService

	CurrenciesApi *CurrenciesApiService

	DataApi *DataApiService

	InsightApi *InsightApiService

	LinksApi *LinksApiService

	ObjectGroupsApi *ObjectGroupsApiService

	PiggyBanksApi *PiggyBanksApiService

	PreferencesApi *PreferencesApiService

	RecurrencesApi *RecurrencesApiService

	RuleGroupsApi *RuleGroupsApiService

	RulesApi *RulesApiService

	SearchApi *SearchApiService

	SummaryApi *SummaryApiService

	TagsApi *TagsApiService

	TransactionsApi *TransactionsApiService

	UsersApi *UsersApiService

	WebhooksApi *WebhooksApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the Firefly III API v2.0.14 API v2.0.14 In most cases there should be only one, shared, APIClient.

func NewAPIClient ¶

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath ¶

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey ¶

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse ¶

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse ¶

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError ¶

func NewAPIResponseWithError(errorMessage string) *APIResponse

type AboutApiGetAboutOpts ¶

type AboutApiGetAboutOpts struct {
	XTraceId optional.Interface
}

type AboutApiGetCronOpts ¶

type AboutApiGetCronOpts struct {
	XTraceId optional.Interface
	Date     optional.String
	Force    optional.Bool
}

type AboutApiGetCurrentUserOpts ¶

type AboutApiGetCurrentUserOpts struct {
	XTraceId optional.Interface
}

type AboutApiService ¶

type AboutApiService service

func (*AboutApiService) GetAbout ¶

func (a *AboutApiService) GetAbout(ctx context.Context, localVarOptionals *AboutApiGetAboutOpts) (SystemInfo, *http.Response, error)

func (*AboutApiService) GetCron ¶

func (a *AboutApiService) GetCron(ctx context.Context, cliToken string, localVarOptionals *AboutApiGetCronOpts) (CronResult, *http.Response, error)

func (*AboutApiService) GetCurrentUser ¶

func (a *AboutApiService) GetCurrentUser(ctx context.Context, localVarOptionals *AboutApiGetCurrentUserOpts) (UserSingle, *http.Response, error)

type Account ¶

type Account struct {
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// If omitted, defaults to true.
	Active bool `json:"active,omitempty"`
	// Order of the account. Is NULL if account is not asset or liability.
	Order       int32                     `json:"order,omitempty"`
	Name        string                    `json:"name"`
	Type_       *ShortAccountTypeProperty `json:"type"`
	AccountRole *AccountRoleProperty      `json:"account_role,omitempty"`
	// Use either currency_id or currency_code. Defaults to the user's default currency.
	CurrencyId string `json:"currency_id,omitempty"`
	// Use either currency_id or currency_code. Defaults to the user's default currency.
	CurrencyCode          string `json:"currency_code,omitempty"`
	CurrencySymbol        string `json:"currency_symbol,omitempty"`
	CurrencyDecimalPlaces int32  `json:"currency_decimal_places,omitempty"`
	CurrentBalance        string `json:"current_balance,omitempty"`
	// The timestamp for this date is always 23:59:59, to indicate it's the balance at the very END of that particular day.
	CurrentBalanceDate time.Time `json:"current_balance_date,omitempty"`
	Iban               string    `json:"iban,omitempty"`
	Bic                string    `json:"bic,omitempty"`
	AccountNumber      string    `json:"account_number,omitempty"`
	// Represents the opening balance, the initial amount this account holds.
	OpeningBalance string `json:"opening_balance,omitempty"`
	// Represents the current debt for liabilities.
	CurrentDebt string `json:"current_debt,omitempty"`
	// Represents the date of the opening balance.
	OpeningBalanceDate time.Time `json:"opening_balance_date,omitempty"`
	VirtualBalance     string    `json:"virtual_balance,omitempty"`
	// If omitted, defaults to true.
	IncludeNetWorth bool                    `json:"include_net_worth,omitempty"`
	CreditCardType  *CreditCardTypeProperty `json:"credit_card_type,omitempty"`
	// Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank.
	MonthlyPaymentDate time.Time                   `json:"monthly_payment_date,omitempty"`
	LiabilityType      *LiabilityTypeProperty      `json:"liability_type,omitempty"`
	LiabilityDirection *LiabilityDirectionProperty `json:"liability_direction,omitempty"`
	// Mandatory when type is liability. Interest percentage.
	Interest       string                  `json:"interest,omitempty"`
	InterestPeriod *InterestPeriodProperty `json:"interest_period,omitempty"`
	Notes          string                  `json:"notes,omitempty"`
	// Latitude of the accounts's location, if applicable. Can be used to draw a map.
	Latitude float64 `json:"latitude,omitempty"`
	// Latitude of the accounts's location, if applicable. Can be used to draw a map.
	Longitude float64 `json:"longitude,omitempty"`
	// Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels.
	ZoomLevel int32 `json:"zoom_level,omitempty"`
}

type AccountArray ¶

type AccountArray struct {
	Data []AccountRead `json:"data"`
	Meta *Meta         `json:"meta"`
}

type AccountRead ¶

type AccountRead struct {
	// Immutable value
	Type_      string   `json:"type"`
	Id         string   `json:"id"`
	Attributes *Account `json:"attributes"`
}

type AccountRoleProperty ¶

type AccountRoleProperty string

AccountRoleProperty : Is only mandatory when the type is asset.

const (
	DEFAULT_ASSET_AccountRoleProperty     AccountRoleProperty = "defaultAsset"
	SHARED_ASSET_AccountRoleProperty      AccountRoleProperty = "sharedAsset"
	SAVING_ASSET_AccountRoleProperty      AccountRoleProperty = "savingAsset"
	CC_ASSET_AccountRoleProperty          AccountRoleProperty = "ccAsset"
	CASH_WALLET_ASSET_AccountRoleProperty AccountRoleProperty = "cashWalletAsset"
	NULL_AccountRoleProperty              AccountRoleProperty = ""
)

List of AccountRoleProperty

type AccountSearchFieldFilter ¶

type AccountSearchFieldFilter string

const (
	ALL_AccountSearchFieldFilter    AccountSearchFieldFilter = "all"
	IBAN_AccountSearchFieldFilter   AccountSearchFieldFilter = "iban"
	NAME_AccountSearchFieldFilter   AccountSearchFieldFilter = "name"
	NUMBER_AccountSearchFieldFilter AccountSearchFieldFilter = "number"
	ID_AccountSearchFieldFilter     AccountSearchFieldFilter = "id"
)

List of AccountSearchFieldFilter

type AccountSingle ¶

type AccountSingle struct {
	Data *AccountRead `json:"data"`
}

type AccountStore ¶

type AccountStore struct {
	Name          string                    `json:"name"`
	Type_         *ShortAccountTypeProperty `json:"type"`
	Iban          string                    `json:"iban,omitempty"`
	Bic           string                    `json:"bic,omitempty"`
	AccountNumber string                    `json:"account_number,omitempty"`
	// Represents the opening balance, the initial amount this account holds.
	OpeningBalance string `json:"opening_balance,omitempty"`
	// Represents the date of the opening balance.
	OpeningBalanceDate time.Time `json:"opening_balance_date,omitempty"`
	VirtualBalance     string    `json:"virtual_balance,omitempty"`
	// Use either currency_id or currency_code. Defaults to the user's default currency.
	CurrencyId string `json:"currency_id,omitempty"`
	// Use either currency_id or currency_code. Defaults to the user's default currency.
	CurrencyCode string `json:"currency_code,omitempty"`
	// If omitted, defaults to true.
	Active bool `json:"active,omitempty"`
	// Order of the account
	Order int32 `json:"order,omitempty"`
	// If omitted, defaults to true.
	IncludeNetWorth bool                    `json:"include_net_worth,omitempty"`
	AccountRole     *AccountRoleProperty    `json:"account_role,omitempty"`
	CreditCardType  *CreditCardTypeProperty `json:"credit_card_type,omitempty"`
	// Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank.
	MonthlyPaymentDate time.Time                   `json:"monthly_payment_date,omitempty"`
	LiabilityType      *LiabilityTypeProperty      `json:"liability_type,omitempty"`
	LiabilityDirection *LiabilityDirectionProperty `json:"liability_direction,omitempty"`
	// Mandatory when type is liability. Interest percentage.
	Interest       string                  `json:"interest,omitempty"`
	InterestPeriod *InterestPeriodProperty `json:"interest_period,omitempty"`
	Notes          string                  `json:"notes,omitempty"`
	// Latitude of the accounts's location, if applicable. Can be used to draw a map.
	Latitude float64 `json:"latitude,omitempty"`
	// Latitude of the accounts's location, if applicable. Can be used to draw a map.
	Longitude float64 `json:"longitude,omitempty"`
	// Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels.
	ZoomLevel int32 `json:"zoom_level,omitempty"`
}

type AccountTypeFilter ¶

type AccountTypeFilter string

const (
	ALL_AccountTypeFilter                     AccountTypeFilter = "all"
	ASSET_AccountTypeFilter                   AccountTypeFilter = "asset"
	CASH_AccountTypeFilter                    AccountTypeFilter = "cash"
	EXPENSE_AccountTypeFilter                 AccountTypeFilter = "expense"
	REVENUE_AccountTypeFilter                 AccountTypeFilter = "revenue"
	SPECIAL_AccountTypeFilter                 AccountTypeFilter = "special"
	HIDDEN_AccountTypeFilter                  AccountTypeFilter = "hidden"
	LIABILITY_AccountTypeFilter               AccountTypeFilter = "liability"
	LIABILITIES_AccountTypeFilter             AccountTypeFilter = "liabilities"
	DEFAULT_ACCOUNT_AccountTypeFilter         AccountTypeFilter = "Default account"
	CASH_ACCOUNT_AccountTypeFilter            AccountTypeFilter = "Cash account"
	ASSET_ACCOUNT_AccountTypeFilter           AccountTypeFilter = "Asset account"
	EXPENSE_ACCOUNT_AccountTypeFilter         AccountTypeFilter = "Expense account"
	REVENUE_ACCOUNT_AccountTypeFilter         AccountTypeFilter = "Revenue account"
	INITIAL_BALANCE_ACCOUNT_AccountTypeFilter AccountTypeFilter = "Initial balance account"
	BENEFICIARY_ACCOUNT_AccountTypeFilter     AccountTypeFilter = "Beneficiary account"
	IMPORT_ACCOUNT_AccountTypeFilter          AccountTypeFilter = "Import account"
	RECONCILIATION_ACCOUNT_AccountTypeFilter  AccountTypeFilter = "Reconciliation account"
	LOAN_AccountTypeFilter                    AccountTypeFilter = "Loan"
	DEBT_AccountTypeFilter                    AccountTypeFilter = "Debt"
	MORTGAGE_AccountTypeFilter                AccountTypeFilter = "Mortgage"
)

List of AccountTypeFilter

type AccountTypeProperty ¶

type AccountTypeProperty string

const (
	DEFAULT_ACCOUNT_AccountTypeProperty         AccountTypeProperty = "Default account"
	CASH_ACCOUNT_AccountTypeProperty            AccountTypeProperty = "Cash account"
	ASSET_ACCOUNT_AccountTypeProperty           AccountTypeProperty = "Asset account"
	EXPENSE_ACCOUNT_AccountTypeProperty         AccountTypeProperty = "Expense account"
	REVENUE_ACCOUNT_AccountTypeProperty         AccountTypeProperty = "Revenue account"
	INITIAL_BALANCE_ACCOUNT_AccountTypeProperty AccountTypeProperty = "Initial balance account"
	BENEFICIARY_ACCOUNT_AccountTypeProperty     AccountTypeProperty = "Beneficiary account"
	IMPORT_ACCOUNT_AccountTypeProperty          AccountTypeProperty = "Import account"
	RECONCILIATION_ACCOUNT_AccountTypeProperty  AccountTypeProperty = "Reconciliation account"
	LOAN_AccountTypeProperty                    AccountTypeProperty = "Loan"
	DEBT_AccountTypeProperty                    AccountTypeProperty = "Debt"
	MORTGAGE_AccountTypeProperty                AccountTypeProperty = "Mortgage"
)

List of AccountTypeProperty

type AccountUpdate ¶

type AccountUpdate struct {
	Name               string    `json:"name"`
	Iban               string    `json:"iban,omitempty"`
	Bic                string    `json:"bic,omitempty"`
	AccountNumber      string    `json:"account_number,omitempty"`
	OpeningBalance     string    `json:"opening_balance,omitempty"`
	OpeningBalanceDate time.Time `json:"opening_balance_date,omitempty"`
	VirtualBalance     string    `json:"virtual_balance,omitempty"`
	// Use either currency_id or currency_code. Defaults to the user's default currency.
	CurrencyId string `json:"currency_id,omitempty"`
	// Use either currency_id or currency_code. Defaults to the user's default currency.
	CurrencyCode string `json:"currency_code,omitempty"`
	// If omitted, defaults to true.
	Active bool `json:"active,omitempty"`
	// Order of the account
	Order int32 `json:"order,omitempty"`
	// If omitted, defaults to true.
	IncludeNetWorth bool                    `json:"include_net_worth,omitempty"`
	AccountRole     *AccountRoleProperty    `json:"account_role,omitempty"`
	CreditCardType  *CreditCardTypeProperty `json:"credit_card_type,omitempty"`
	// Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank.
	MonthlyPaymentDate time.Time              `json:"monthly_payment_date,omitempty"`
	LiabilityType      *LiabilityTypeProperty `json:"liability_type,omitempty"`
	// Mandatory when type is liability. Interest percentage.
	Interest       string                  `json:"interest,omitempty"`
	InterestPeriod *InterestPeriodProperty `json:"interest_period,omitempty"`
	Notes          string                  `json:"notes,omitempty"`
	// Latitude of the account's location, if applicable. Can be used to draw a map. If omitted, the existing location will be kept. If submitted as NULL, the current location will be removed.
	Latitude float64 `json:"latitude,omitempty"`
	// Latitude of the account's location, if applicable. Can be used to draw a map. If omitted, the existing location will be kept. If submitted as NULL, the current location will be removed.
	Longitude float64 `json:"longitude,omitempty"`
	// Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels. If omitted, the existing location will be kept. If submitted as NULL, the current location will be removed.
	ZoomLevel int32 `json:"zoom_level,omitempty"`
}

type AccountsApiDeleteAccountOpts ¶

type AccountsApiDeleteAccountOpts struct {
	XTraceId optional.Interface
}

type AccountsApiGetAccountOpts ¶

type AccountsApiGetAccountOpts struct {
	XTraceId optional.Interface
	Date     optional.String
}

type AccountsApiListAccountOpts ¶

type AccountsApiListAccountOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
	Date     optional.String
	Type_    optional.Interface
}

type AccountsApiListAttachmentByAccountOpts ¶

type AccountsApiListAttachmentByAccountOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type AccountsApiListPiggyBankByAccountOpts ¶

type AccountsApiListPiggyBankByAccountOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type AccountsApiListTransactionByAccountOpts ¶

type AccountsApiListTransactionByAccountOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
	Start    optional.String
	End      optional.String
	Type_    optional.Interface
}

type AccountsApiService ¶

type AccountsApiService service

func (*AccountsApiService) DeleteAccount ¶

func (a *AccountsApiService) DeleteAccount(ctx context.Context, id string, localVarOptionals *AccountsApiDeleteAccountOpts) (*http.Response, error)

func (*AccountsApiService) GetAccount ¶

func (a *AccountsApiService) GetAccount(ctx context.Context, id string, localVarOptionals *AccountsApiGetAccountOpts) (AccountSingle, *http.Response, error)

func (*AccountsApiService) ListAccount ¶

func (a *AccountsApiService) ListAccount(ctx context.Context, localVarOptionals *AccountsApiListAccountOpts) (AccountArray, *http.Response, error)

func (*AccountsApiService) ListAttachmentByAccount ¶

func (a *AccountsApiService) ListAttachmentByAccount(ctx context.Context, id string, localVarOptionals *AccountsApiListAttachmentByAccountOpts) (AttachmentArray, *http.Response, error)

func (*AccountsApiService) ListPiggyBankByAccount ¶

func (a *AccountsApiService) ListPiggyBankByAccount(ctx context.Context, id string, localVarOptionals *AccountsApiListPiggyBankByAccountOpts) (PiggyBankArray, *http.Response, error)

func (*AccountsApiService) ListTransactionByAccount ¶

func (a *AccountsApiService) ListTransactionByAccount(ctx context.Context, id string, localVarOptionals *AccountsApiListTransactionByAccountOpts) (TransactionArray, *http.Response, error)

func (*AccountsApiService) StoreAccount ¶

func (a *AccountsApiService) StoreAccount(ctx context.Context, body AccountStore, localVarOptionals *AccountsApiStoreAccountOpts) (AccountSingle, *http.Response, error)

func (*AccountsApiService) UpdateAccount ¶

func (a *AccountsApiService) UpdateAccount(ctx context.Context, body AccountUpdate, id string, localVarOptionals *AccountsApiUpdateAccountOpts) (AccountSingle, *http.Response, error)

type AccountsApiStoreAccountOpts ¶

type AccountsApiStoreAccountOpts struct {
	XTraceId optional.Interface
}

type AccountsApiUpdateAccountOpts ¶

type AccountsApiUpdateAccountOpts struct {
	XTraceId optional.Interface
}

type AttachableType ¶

type AttachableType string

AttachableType : The object class to which the attachment must be linked.

const (
	ACCOUNT_AttachableType             AttachableType = "Account"
	BUDGET_AttachableType              AttachableType = "Budget"
	BILL_AttachableType                AttachableType = "Bill"
	TRANSACTION_JOURNAL_AttachableType AttachableType = "TransactionJournal"
	PIGGY_BANK_AttachableType          AttachableType = "PiggyBank"
	TAG_AttachableType                 AttachableType = "Tag"
)

List of AttachableType

type Attachment ¶

type Attachment struct {
	CreatedAt      time.Time       `json:"created_at,omitempty"`
	UpdatedAt      time.Time       `json:"updated_at,omitempty"`
	AttachableType *AttachableType `json:"attachable_type"`
	// ID of the model this attachment is linked to.
	AttachableId string `json:"attachable_id"`
	// MD5 hash of the file for basic duplicate detection.
	Md5         string `json:"md5,omitempty"`
	Filename    string `json:"filename"`
	DownloadUrl string `json:"download_url,omitempty"`
	UploadUrl   string `json:"upload_url,omitempty"`
	Title       string `json:"title,omitempty"`
	Notes       string `json:"notes,omitempty"`
	Mime        string `json:"mime,omitempty"`
	Size        int32  `json:"size,omitempty"`
}

type AttachmentArray ¶

type AttachmentArray struct {
	Data []AttachmentRead `json:"data"`
	Meta *Meta            `json:"meta"`
}

type AttachmentRead ¶

type AttachmentRead struct {
	// Immutable value
	Type_      string      `json:"type"`
	Id         string      `json:"id"`
	Attributes *Attachment `json:"attributes"`
	Links      *ObjectLink `json:"links"`
}

type AttachmentSingle ¶

type AttachmentSingle struct {
	Data *AttachmentRead `json:"data"`
}

type AttachmentStore ¶

type AttachmentStore struct {
	Filename       string          `json:"filename"`
	AttachableType *AttachableType `json:"attachable_type"`
	// ID of the model this attachment is linked to.
	AttachableId string `json:"attachable_id"`
	Title        string `json:"title,omitempty"`
	Notes        string `json:"notes,omitempty"`
}

type AttachmentUpdate ¶

type AttachmentUpdate struct {
	Filename string `json:"filename,omitempty"`
	Title    string `json:"title,omitempty"`
	Notes    string `json:"notes,omitempty"`
}

type AttachmentsApiDeleteAttachmentOpts ¶

type AttachmentsApiDeleteAttachmentOpts struct {
	XTraceId optional.Interface
}

type AttachmentsApiDownloadAttachmentOpts ¶

type AttachmentsApiDownloadAttachmentOpts struct {
	XTraceId optional.Interface
}

type AttachmentsApiGetAttachmentOpts ¶

type AttachmentsApiGetAttachmentOpts struct {
	XTraceId optional.Interface
}

type AttachmentsApiListAttachmentOpts ¶

type AttachmentsApiListAttachmentOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type AttachmentsApiService ¶

type AttachmentsApiService service

func (*AttachmentsApiService) DeleteAttachment ¶

func (a *AttachmentsApiService) DeleteAttachment(ctx context.Context, id string, localVarOptionals *AttachmentsApiDeleteAttachmentOpts) (*http.Response, error)

func (*AttachmentsApiService) DownloadAttachment ¶

func (a *AttachmentsApiService) DownloadAttachment(ctx context.Context, id string, localVarOptionals *AttachmentsApiDownloadAttachmentOpts) (*os.File, *http.Response, error)

func (*AttachmentsApiService) GetAttachment ¶

func (a *AttachmentsApiService) GetAttachment(ctx context.Context, id string, localVarOptionals *AttachmentsApiGetAttachmentOpts) (AttachmentSingle, *http.Response, error)

func (*AttachmentsApiService) ListAttachment ¶

func (a *AttachmentsApiService) ListAttachment(ctx context.Context, localVarOptionals *AttachmentsApiListAttachmentOpts) (AttachmentArray, *http.Response, error)

func (*AttachmentsApiService) StoreAttachment ¶

func (a *AttachmentsApiService) StoreAttachment(ctx context.Context, body AttachmentStore, localVarOptionals *AttachmentsApiStoreAttachmentOpts) (AttachmentSingle, *http.Response, error)

func (*AttachmentsApiService) UpdateAttachment ¶

func (a *AttachmentsApiService) UpdateAttachment(ctx context.Context, body AttachmentUpdate, id string, localVarOptionals *AttachmentsApiUpdateAttachmentOpts) (AttachmentSingle, *http.Response, error)

func (*AttachmentsApiService) UploadAttachment ¶

func (a *AttachmentsApiService) UploadAttachment(ctx context.Context, id string, localVarOptionals *AttachmentsApiUploadAttachmentOpts) (*http.Response, error)

type AttachmentsApiStoreAttachmentOpts ¶

type AttachmentsApiStoreAttachmentOpts struct {
	XTraceId optional.Interface
}

type AttachmentsApiUpdateAttachmentOpts ¶

type AttachmentsApiUpdateAttachmentOpts struct {
	XTraceId optional.Interface
}

type AttachmentsApiUploadAttachmentOpts ¶

type AttachmentsApiUploadAttachmentOpts struct {
	Body     optional.Interface
	XTraceId optional.Interface
}

type AutoBudgetPeriod ¶

type AutoBudgetPeriod string

AutoBudgetPeriod : Period for the auto budget

const (
	DAILY_AutoBudgetPeriod     AutoBudgetPeriod = "daily"
	WEEKLY_AutoBudgetPeriod    AutoBudgetPeriod = "weekly"
	MONTHLY_AutoBudgetPeriod   AutoBudgetPeriod = "monthly"
	QUARTERLY_AutoBudgetPeriod AutoBudgetPeriod = "quarterly"
	HALF_YEAR_AutoBudgetPeriod AutoBudgetPeriod = "half-year"
	YEARLY_AutoBudgetPeriod    AutoBudgetPeriod = "yearly"
	NULL_AutoBudgetPeriod      AutoBudgetPeriod = ""
)

List of AutoBudgetPeriod

type AutoBudgetType ¶

type AutoBudgetType string

AutoBudgetType : The type of auto-budget that Firefly III must create.

const (
	RESET_AutoBudgetType    AutoBudgetType = "reset"
	ROLLOVER_AutoBudgetType AutoBudgetType = "rollover"
	NONE_AutoBudgetType     AutoBudgetType = "none"
	NULL_AutoBudgetType     AutoBudgetType = ""
)

List of AutoBudgetType

type AutocompleteAccount ¶

type AutocompleteAccount struct {
	Id string `json:"id"`
	// Name of the account found by an auto-complete search.
	Name string `json:"name"`
	// Asset accounts and liabilities have a second field with the given date's account balance.
	NameWithBalance string `json:"name_with_balance"`
	// Account type of the account found by the auto-complete search.
	Type_ string `json:"type"`
	// ID for the currency used by this account.
	CurrencyId string `json:"currency_id"`
	// Currency name for the currency used by this account.
	CurrencyName string `json:"currency_name"`
	// Currency code for the currency used by this account.
	CurrencyCode string `json:"currency_code"`
	// Currency symbol for the currency used by this account.
	CurrencySymbol string `json:"currency_symbol"`
	// Number of decimal places for the currency used by this account.
	CurrencyDecimalPlaces int32 `json:"currency_decimal_places"`
}

type AutocompleteApiGetAccountsACOpts ¶

type AutocompleteApiGetAccountsACOpts struct {
	XTraceId optional.Interface
	Query    optional.String
	Limit    optional.Int32
	Date     optional.String
	Types    optional.Interface
}

type AutocompleteApiGetBillsACOpts ¶

type AutocompleteApiGetBillsACOpts struct {
	XTraceId optional.Interface
	Query    optional.String
	Limit    optional.Int32
}

type AutocompleteApiGetBudgetsACOpts ¶

type AutocompleteApiGetBudgetsACOpts struct {
	XTraceId optional.Interface
	Query    optional.String
	Limit    optional.Int32
}

type AutocompleteApiGetCategoriesACOpts ¶

type AutocompleteApiGetCategoriesACOpts struct {
	XTraceId optional.Interface
	Query    optional.String
	Limit    optional.Int32
}

type AutocompleteApiGetCurrenciesACOpts ¶

type AutocompleteApiGetCurrenciesACOpts struct {
	XTraceId optional.Interface
	Query    optional.String
	Limit    optional.Int32
}

type AutocompleteApiGetCurrenciesCodeACOpts ¶

type AutocompleteApiGetCurrenciesCodeACOpts struct {
	XTraceId optional.Interface
	Query    optional.String
	Limit    optional.Int32
}

type AutocompleteApiGetObjectGroupsACOpts ¶

type AutocompleteApiGetObjectGroupsACOpts struct {
	XTraceId optional.Interface
	Query    optional.String
	Limit    optional.Int32
}

type AutocompleteApiGetPiggiesACOpts ¶

type AutocompleteApiGetPiggiesACOpts struct {
	XTraceId optional.Interface
	Query    optional.String
	Limit    optional.Int32
}

type AutocompleteApiGetPiggiesBalanceACOpts ¶

type AutocompleteApiGetPiggiesBalanceACOpts struct {
	XTraceId optional.Interface
	Query    optional.String
	Limit    optional.Int32
}

type AutocompleteApiGetRecurringACOpts ¶

type AutocompleteApiGetRecurringACOpts struct {
	XTraceId optional.Interface
	Query    optional.String
	Limit    optional.Int32
}

type AutocompleteApiGetRuleGroupsACOpts ¶

type AutocompleteApiGetRuleGroupsACOpts struct {
	XTraceId optional.Interface
	Query    optional.String
	Limit    optional.Int32
}

type AutocompleteApiGetRulesACOpts ¶

type AutocompleteApiGetRulesACOpts struct {
	XTraceId optional.Interface
	Query    optional.String
	Limit    optional.Int32
}

type AutocompleteApiGetTagACOpts ¶

type AutocompleteApiGetTagACOpts struct {
	XTraceId optional.Interface
	Query    optional.String
	Limit    optional.Int32
}

type AutocompleteApiGetTransactionTypesACOpts ¶

type AutocompleteApiGetTransactionTypesACOpts struct {
	XTraceId optional.Interface
	Query    optional.String
	Limit    optional.Int32
}

type AutocompleteApiGetTransactionsACOpts ¶

type AutocompleteApiGetTransactionsACOpts struct {
	XTraceId optional.Interface
	Query    optional.String
	Limit    optional.Int32
}

type AutocompleteApiGetTransactionsIDACOpts ¶

type AutocompleteApiGetTransactionsIDACOpts struct {
	XTraceId optional.Interface
	Query    optional.String
	Limit    optional.Int32
}

type AutocompleteApiService ¶

type AutocompleteApiService service

func (*AutocompleteApiService) GetAccountsAC ¶

func (a *AutocompleteApiService) GetAccountsAC(ctx context.Context, localVarOptionals *AutocompleteApiGetAccountsACOpts) ([]AutocompleteAccount, *http.Response, error)

func (*AutocompleteApiService) GetBillsAC ¶

func (a *AutocompleteApiService) GetBillsAC(ctx context.Context, localVarOptionals *AutocompleteApiGetBillsACOpts) ([]AutocompleteBill, *http.Response, error)

func (*AutocompleteApiService) GetBudgetsAC ¶

func (a *AutocompleteApiService) GetBudgetsAC(ctx context.Context, localVarOptionals *AutocompleteApiGetBudgetsACOpts) ([]AutocompleteBudget, *http.Response, error)

func (*AutocompleteApiService) GetCategoriesAC ¶

func (a *AutocompleteApiService) GetCategoriesAC(ctx context.Context, localVarOptionals *AutocompleteApiGetCategoriesACOpts) ([]AutocompleteCategory, *http.Response, error)

func (*AutocompleteApiService) GetCurrenciesAC ¶

func (a *AutocompleteApiService) GetCurrenciesAC(ctx context.Context, localVarOptionals *AutocompleteApiGetCurrenciesACOpts) ([]AutocompleteCurrency, *http.Response, error)

func (*AutocompleteApiService) GetCurrenciesCodeAC ¶

func (a *AutocompleteApiService) GetCurrenciesCodeAC(ctx context.Context, localVarOptionals *AutocompleteApiGetCurrenciesCodeACOpts) ([]AutocompleteCurrencyCode, *http.Response, error)

func (*AutocompleteApiService) GetObjectGroupsAC ¶

func (a *AutocompleteApiService) GetObjectGroupsAC(ctx context.Context, localVarOptionals *AutocompleteApiGetObjectGroupsACOpts) ([]AutocompleteObjectGroup, *http.Response, error)

func (*AutocompleteApiService) GetPiggiesAC ¶

func (a *AutocompleteApiService) GetPiggiesAC(ctx context.Context, localVarOptionals *AutocompleteApiGetPiggiesACOpts) ([]AutocompletePiggy, *http.Response, error)

func (*AutocompleteApiService) GetPiggiesBalanceAC ¶

func (a *AutocompleteApiService) GetPiggiesBalanceAC(ctx context.Context, localVarOptionals *AutocompleteApiGetPiggiesBalanceACOpts) ([]AutocompletePiggyBalance, *http.Response, error)

func (*AutocompleteApiService) GetRecurringAC ¶

func (a *AutocompleteApiService) GetRecurringAC(ctx context.Context, localVarOptionals *AutocompleteApiGetRecurringACOpts) ([]AutocompleteRecurrence, *http.Response, error)

func (*AutocompleteApiService) GetRuleGroupsAC ¶

func (a *AutocompleteApiService) GetRuleGroupsAC(ctx context.Context, localVarOptionals *AutocompleteApiGetRuleGroupsACOpts) ([]AutocompleteRuleGroup, *http.Response, error)

func (*AutocompleteApiService) GetRulesAC ¶

func (a *AutocompleteApiService) GetRulesAC(ctx context.Context, localVarOptionals *AutocompleteApiGetRulesACOpts) ([]AutocompleteRule, *http.Response, error)

func (*AutocompleteApiService) GetTagAC ¶

func (a *AutocompleteApiService) GetTagAC(ctx context.Context, localVarOptionals *AutocompleteApiGetTagACOpts) ([]AutocompleteTag, *http.Response, error)

func (*AutocompleteApiService) GetTransactionTypesAC ¶

func (a *AutocompleteApiService) GetTransactionTypesAC(ctx context.Context, localVarOptionals *AutocompleteApiGetTransactionTypesACOpts) ([]AutocompleteTransactionType, *http.Response, error)

func (*AutocompleteApiService) GetTransactionsAC ¶

func (a *AutocompleteApiService) GetTransactionsAC(ctx context.Context, localVarOptionals *AutocompleteApiGetTransactionsACOpts) ([]AutocompleteTransaction, *http.Response, error)

func (*AutocompleteApiService) GetTransactionsIDAC ¶

func (a *AutocompleteApiService) GetTransactionsIDAC(ctx context.Context, localVarOptionals *AutocompleteApiGetTransactionsIDACOpts) ([]AutocompleteTransactionId, *http.Response, error)

type AutocompleteBill ¶

type AutocompleteBill struct {
	Id string `json:"id"`
	// Name of the bill found by an auto-complete search.
	Name string `json:"name"`
	// Is the bill active or not?
	Active bool `json:"active,omitempty"`
}

type AutocompleteBudget ¶

type AutocompleteBudget struct {
	Id string `json:"id"`
	// Name of the budget found by an auto-complete search.
	Name string `json:"name"`
}

type AutocompleteCategory ¶

type AutocompleteCategory struct {
	Id string `json:"id"`
	// Name of the category found by an auto-complete search.
	Name string `json:"name"`
}

type AutocompleteCurrency ¶

type AutocompleteCurrency struct {
	Id string `json:"id"`
	// Currency name.
	Name string `json:"name"`
	// Currency code.
	Code          string `json:"code"`
	Symbol        string `json:"symbol"`
	DecimalPlaces int32  `json:"decimal_places"`
}

type AutocompleteCurrencyCode ¶

type AutocompleteCurrencyCode struct {
	Id string `json:"id"`
	// Currency name with the code between brackets.
	Name string `json:"name"`
	// Currency code.
	Code          string `json:"code"`
	Symbol        string `json:"symbol"`
	DecimalPlaces int32  `json:"decimal_places"`
}

type AutocompleteObjectGroup ¶

type AutocompleteObjectGroup struct {
	Id string `json:"id"`
	// Title of the object group found by an auto-complete search.
	Title string `json:"title"`
	// Title of the object group found by an auto-complete search.
	Name string `json:"name"`
}

type AutocompletePiggy ¶

type AutocompletePiggy struct {
	Id string `json:"id"`
	// Name of the piggy bank found by an auto-complete search.
	Name string `json:"name"`
	// Currency ID for this piggy bank.
	CurrencyId string `json:"currency_id,omitempty"`
	// Currency code for this piggy bank.
	CurrencyCode   string `json:"currency_code,omitempty"`
	CurrencySymbol string `json:"currency_symbol,omitempty"`
	// Currency name for the currency used by this account.
	CurrencyName          string `json:"currency_name,omitempty"`
	CurrencyDecimalPlaces int32  `json:"currency_decimal_places,omitempty"`
	// The group ID of the group this object is part of. NULL if no group.
	ObjectGroupId string `json:"object_group_id,omitempty"`
	// The name of the group. NULL if no group.
	ObjectGroupTitle string `json:"object_group_title,omitempty"`
}

type AutocompletePiggyBalance ¶

type AutocompletePiggyBalance struct {
	Id string `json:"id"`
	// Name of the piggy bank found by an auto-complete search.
	Name string `json:"name"`
	// Name of the piggy bank found by an auto-complete search with the current balance formatted nicely.
	NameWithBalance string `json:"name_with_balance,omitempty"`
	// Currency ID for this piggy bank.
	CurrencyId string `json:"currency_id,omitempty"`
	// Currency code for this piggy bank.
	CurrencyCode          string `json:"currency_code,omitempty"`
	CurrencySymbol        string `json:"currency_symbol,omitempty"`
	CurrencyDecimalPlaces int32  `json:"currency_decimal_places,omitempty"`
	// The group ID of the group this object is part of. NULL if no group.
	ObjectGroupId string `json:"object_group_id,omitempty"`
	// The name of the group. NULL if no group.
	ObjectGroupTitle string `json:"object_group_title,omitempty"`
}

type AutocompleteRecurrence ¶

type AutocompleteRecurrence struct {
	Id string `json:"id"`
	// Name of the recurrence found by an auto-complete search.
	Name string `json:"name"`
	// Description of the recurrence found by auto-complete.
	Description string `json:"description,omitempty"`
}

type AutocompleteRule ¶

type AutocompleteRule struct {
	Id string `json:"id"`
	// Name of the rule found by an auto-complete search.
	Name string `json:"name"`
	// Description of the rule found by auto-complete.
	Description string `json:"description,omitempty"`
}

type AutocompleteRuleGroup ¶

type AutocompleteRuleGroup struct {
	Id string `json:"id"`
	// Name of the rule group found by an auto-complete search.
	Name string `json:"name"`
	// Description of the rule group found by auto-complete.
	Description string `json:"description,omitempty"`
}

type AutocompleteTag ¶

type AutocompleteTag struct {
	Id string `json:"id"`
	// Name of the tag found by an auto-complete search.
	Name string `json:"name"`
	// Name of the tag found by an auto-complete search.
	Tag string `json:"tag"`
}

type AutocompleteTransaction ¶

type AutocompleteTransaction struct {
	// The ID of a transaction journal (basically a single split).
	Id string `json:"id"`
	// The ID of the underlying transaction group.
	TransactionGroupId string `json:"transaction_group_id,omitempty"`
	// Transaction description
	Name string `json:"name"`
	// Transaction description
	Description string `json:"description"`
}

type AutocompleteTransactionId ¶

type AutocompleteTransactionId struct {
	// The ID of a transaction journal (basically a single split).
	Id string `json:"id"`
	// The ID of the underlying transaction group.
	TransactionGroupId string `json:"transaction_group_id,omitempty"`
	// Transaction description with ID in the name.
	Name string `json:"name"`
	// Transaction description with ID in the name.
	Description string `json:"description"`
}

type AutocompleteTransactionType ¶

type AutocompleteTransactionType struct {
	Id string `json:"id"`
	// Type of the object found by an auto-complete search.
	Name string `json:"name"`
	// Name of the object found by an auto-complete search.
	Type_ string `json:"type"`
}

type AvailableBudget ¶

type AvailableBudget struct {
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// Use either currency_id or currency_code.
	CurrencyId string `json:"currency_id,omitempty"`
	// Use either currency_id or currency_code.
	CurrencyCode          string `json:"currency_code,omitempty"`
	CurrencySymbol        string `json:"currency_symbol,omitempty"`
	CurrencyDecimalPlaces int32  `json:"currency_decimal_places,omitempty"`
	Amount                string `json:"amount"`
	// Start date of the available budget.
	Start time.Time `json:"start"`
	// End date of the available budget.
	End                time.Time     `json:"end"`
	SpentInBudgets     []BudgetSpent `json:"spent_in_budgets,omitempty"`
	SpentOutsideBudget []BudgetSpent `json:"spent_outside_budget,omitempty"`
}

type AvailableBudgetArray ¶

type AvailableBudgetArray struct {
	Data []AvailableBudgetRead `json:"data"`
	Meta *Meta                 `json:"meta"`
}

type AvailableBudgetRead ¶

type AvailableBudgetRead struct {
	// Immutable value
	Type_      string           `json:"type"`
	Id         string           `json:"id"`
	Attributes *AvailableBudget `json:"attributes"`
}

type AvailableBudgetSingle ¶

type AvailableBudgetSingle struct {
	Data *AvailableBudgetRead `json:"data"`
}

type AvailableBudgetsApiGetAvailableBudgetOpts ¶

type AvailableBudgetsApiGetAvailableBudgetOpts struct {
	XTraceId optional.Interface
}

type AvailableBudgetsApiListAvailableBudgetOpts ¶

type AvailableBudgetsApiListAvailableBudgetOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
	Start    optional.String
	End      optional.String
}

type AvailableBudgetsApiService ¶

type AvailableBudgetsApiService service

func (*AvailableBudgetsApiService) GetAvailableBudget ¶

func (a *AvailableBudgetsApiService) GetAvailableBudget(ctx context.Context, id string, localVarOptionals *AvailableBudgetsApiGetAvailableBudgetOpts) (AvailableBudgetSingle, *http.Response, error)

func (*AvailableBudgetsApiService) ListAvailableBudget ¶

func (a *AvailableBudgetsApiService) ListAvailableBudget(ctx context.Context, localVarOptionals *AvailableBudgetsApiListAvailableBudgetOpts) (AvailableBudgetArray, *http.Response, error)

type BadRequestResponse ¶

type BadRequestResponse struct {
	Message   string `json:"message,omitempty"`
	Exception string `json:"exception,omitempty"`
}

type BasicAuth ¶

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type BasicSummaryEntry ¶

type BasicSummaryEntry struct {
	// This is a reference to the type of info shared, not influenced by translations or user preferences. The EUR value is a reference to the currency code. Possibilities are: balance-in-ABC, spent-in-ABC, earned-in-ABC, bills-paid-in-ABC, bills-unpaid-in-ABC, left-to-spend-in-ABC and net-worth-in-ABC.
	Key string `json:"key,omitempty"`
	// A translated title for the information shared.
	Title string `json:"title,omitempty"`
	// The amount as a float.
	MonetaryValue float64 `json:"monetary_value,omitempty"`
	// The currency ID of the associated currency.
	CurrencyId     string `json:"currency_id,omitempty"`
	CurrencyCode   string `json:"currency_code,omitempty"`
	CurrencySymbol string `json:"currency_symbol,omitempty"`
	// Number of decimals for the associated currency.
	CurrencyDecimalPlaces int32 `json:"currency_decimal_places,omitempty"`
	// The amount formatted according to the users locale
	ValueParsed string `json:"value_parsed,omitempty"`
	// Reference to a font-awesome icon without the fa- part.
	LocalIcon string `json:"local_icon,omitempty"`
	// A short explanation of the amounts origin. Already formatted according to the locale of the user or translated, if relevant.
	SubTitle string `json:"sub_title,omitempty"`
}

type Bill ¶

type Bill struct {
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// Use either currency_id or currency_code
	CurrencyId string `json:"currency_id,omitempty"`
	// Use either currency_id or currency_code
	CurrencyCode          string    `json:"currency_code,omitempty"`
	CurrencySymbol        string    `json:"currency_symbol,omitempty"`
	CurrencyDecimalPlaces int32     `json:"currency_decimal_places,omitempty"`
	Name                  string    `json:"name"`
	AmountMin             string    `json:"amount_min"`
	AmountMax             string    `json:"amount_max"`
	Date                  time.Time `json:"date"`
	// The date after which this bill is no longer valid or applicable
	EndDate time.Time `json:"end_date,omitempty"`
	// The date before which the bill must be renewed (or cancelled)
	ExtensionDate time.Time            `json:"extension_date,omitempty"`
	RepeatFreq    *BillRepeatFrequency `json:"repeat_freq"`
	// How often the bill must be skipped. 1 means a bi-monthly bill.
	Skip int32 `json:"skip,omitempty"`
	// If the bill is active.
	Active bool `json:"active,omitempty"`
	// Order of the bill.
	Order int32  `json:"order,omitempty"`
	Notes string `json:"notes,omitempty"`
	// When the bill is expected to be due.
	NextExpectedMatch time.Time `json:"next_expected_match,omitempty"`
	// Formatted (locally) when the bill is due.
	NextExpectedMatchDiff string `json:"next_expected_match_diff,omitempty"`
	// The group ID of the group this object is part of. NULL if no group.
	ObjectGroupId string `json:"object_group_id,omitempty"`
	// The order of the group. At least 1, for the highest sorting.
	ObjectGroupOrder int32 `json:"object_group_order,omitempty"`
	// The name of the group. NULL if no group.
	ObjectGroupTitle string `json:"object_group_title,omitempty"`
	// Array of future dates when the bill is expected to be paid. Autogenerated.
	PayDates []time.Time `json:"pay_dates,omitempty"`
	// Array of past transactions when the bill was paid.
	PaidDates []BillPaidDates `json:"paid_dates,omitempty"`
}

type BillArray ¶

type BillArray struct {
	Data []BillRead `json:"data"`
	Meta *Meta      `json:"meta"`
}

type BillPaidDates ¶

type BillPaidDates struct {
	// Transaction group ID of the paid bill.
	TransactionGroupId string `json:"transaction_group_id,omitempty"`
	// Transaction journal ID of the paid bill.
	TransactionJournalId string `json:"transaction_journal_id,omitempty"`
	// Date the bill was paid.
	Date time.Time `json:"date,omitempty"`
}

type BillRead ¶

type BillRead struct {
	// Immutable value
	Type_      string `json:"type"`
	Id         string `json:"id"`
	Attributes *Bill  `json:"attributes"`
}

type BillRepeatFrequency ¶

type BillRepeatFrequency string

BillRepeatFrequency : How often the bill must be paid.

const (
	WEEKLY_BillRepeatFrequency    BillRepeatFrequency = "weekly"
	MONTHLY_BillRepeatFrequency   BillRepeatFrequency = "monthly"
	QUARTERLY_BillRepeatFrequency BillRepeatFrequency = "quarterly"
	HALF_YEAR_BillRepeatFrequency BillRepeatFrequency = "half-year"
	YEARLY_BillRepeatFrequency    BillRepeatFrequency = "yearly"
)

List of BillRepeatFrequency

type BillSingle ¶

type BillSingle struct {
	Data *BillRead `json:"data"`
}

type BillStore ¶

type BillStore struct {
	// Use either currency_id or currency_code
	CurrencyId string `json:"currency_id,omitempty"`
	// Use either currency_id or currency_code
	CurrencyCode string    `json:"currency_code,omitempty"`
	Name         string    `json:"name"`
	AmountMin    string    `json:"amount_min"`
	AmountMax    string    `json:"amount_max"`
	Date         time.Time `json:"date"`
	// The date after which this bill is no longer valid or applicable
	EndDate time.Time `json:"end_date,omitempty"`
	// The date before which the bill must be renewed (or cancelled)
	ExtensionDate time.Time            `json:"extension_date,omitempty"`
	RepeatFreq    *BillRepeatFrequency `json:"repeat_freq"`
	// How often the bill must be skipped. 1 means a bi-monthly bill.
	Skip int32 `json:"skip,omitempty"`
	// If the bill is active.
	Active bool   `json:"active,omitempty"`
	Notes  string `json:"notes,omitempty"`
	// The group ID of the group this object is part of. NULL if no group.
	ObjectGroupId string `json:"object_group_id,omitempty"`
	// The name of the group. NULL if no group.
	ObjectGroupTitle string `json:"object_group_title,omitempty"`
}

type BillUpdate ¶

type BillUpdate struct {
	// Use either currency_id or currency_code
	CurrencyId string `json:"currency_id,omitempty"`
	// Use either currency_id or currency_code
	CurrencyCode string    `json:"currency_code,omitempty"`
	Name         string    `json:"name"`
	AmountMin    string    `json:"amount_min,omitempty"`
	AmountMax    string    `json:"amount_max,omitempty"`
	Date         time.Time `json:"date,omitempty"`
	// The date after which this bill is no longer valid or applicable
	EndDate time.Time `json:"end_date,omitempty"`
	// The date before which the bill must be renewed (or cancelled)
	ExtensionDate time.Time            `json:"extension_date,omitempty"`
	RepeatFreq    *BillRepeatFrequency `json:"repeat_freq,omitempty"`
	// How often the bill must be skipped. 1 means a bi-monthly bill.
	Skip int32 `json:"skip,omitempty"`
	// If the bill is active.
	Active bool   `json:"active,omitempty"`
	Notes  string `json:"notes,omitempty"`
	// The group ID of the group this object is part of. NULL if no group.
	ObjectGroupId string `json:"object_group_id,omitempty"`
	// The name of the group. NULL if no group.
	ObjectGroupTitle string `json:"object_group_title,omitempty"`
}

type BillsApiDeleteBillOpts ¶

type BillsApiDeleteBillOpts struct {
	XTraceId optional.Interface
}

type BillsApiGetBillOpts ¶

type BillsApiGetBillOpts struct {
	XTraceId optional.Interface
	Start    optional.String
	End      optional.String
}

type BillsApiListAttachmentByBillOpts ¶

type BillsApiListAttachmentByBillOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type BillsApiListBillOpts ¶

type BillsApiListBillOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
	Start    optional.String
	End      optional.String
}

type BillsApiListRuleByBillOpts ¶

type BillsApiListRuleByBillOpts struct {
	XTraceId optional.Interface
}

type BillsApiListTransactionByBillOpts ¶

type BillsApiListTransactionByBillOpts struct {
	XTraceId optional.Interface
	Start    optional.String
	End      optional.String
	Type_    optional.Interface
}

type BillsApiService ¶

type BillsApiService service

func (*BillsApiService) DeleteBill ¶

func (a *BillsApiService) DeleteBill(ctx context.Context, id string, localVarOptionals *BillsApiDeleteBillOpts) (*http.Response, error)

func (*BillsApiService) GetBill ¶

func (a *BillsApiService) GetBill(ctx context.Context, id string, localVarOptionals *BillsApiGetBillOpts) (BillSingle, *http.Response, error)

func (*BillsApiService) ListAttachmentByBill ¶

func (a *BillsApiService) ListAttachmentByBill(ctx context.Context, id string, localVarOptionals *BillsApiListAttachmentByBillOpts) (AttachmentArray, *http.Response, error)

func (*BillsApiService) ListBill ¶

func (a *BillsApiService) ListBill(ctx context.Context, localVarOptionals *BillsApiListBillOpts) (BillArray, *http.Response, error)

func (*BillsApiService) ListRuleByBill ¶

func (a *BillsApiService) ListRuleByBill(ctx context.Context, id string, localVarOptionals *BillsApiListRuleByBillOpts) (RuleArray, *http.Response, error)

func (*BillsApiService) ListTransactionByBill ¶

func (a *BillsApiService) ListTransactionByBill(ctx context.Context, id string, localVarOptionals *BillsApiListTransactionByBillOpts) (TransactionArray, *http.Response, error)

func (*BillsApiService) StoreBill ¶

func (a *BillsApiService) StoreBill(ctx context.Context, body BillStore, localVarOptionals *BillsApiStoreBillOpts) (BillSingle, *http.Response, error)

func (*BillsApiService) UpdateBill ¶

func (a *BillsApiService) UpdateBill(ctx context.Context, body BillUpdate, id string, localVarOptionals *BillsApiUpdateBillOpts) (BillSingle, *http.Response, error)

type BillsApiStoreBillOpts ¶

type BillsApiStoreBillOpts struct {
	XTraceId optional.Interface
}

type BillsApiUpdateBillOpts ¶

type BillsApiUpdateBillOpts struct {
	XTraceId optional.Interface
}

type Budget ¶

type Budget struct {
	CreatedAt      time.Time       `json:"created_at,omitempty"`
	UpdatedAt      time.Time       `json:"updated_at,omitempty"`
	Name           string          `json:"name"`
	Active         bool            `json:"active,omitempty"`
	Notes          string          `json:"notes,omitempty"`
	Order          int32           `json:"order,omitempty"`
	AutoBudgetType *AutoBudgetType `json:"auto_budget_type,omitempty"`
	// Use either currency_id or currency_code. Defaults to the user's default currency.
	AutoBudgetCurrencyId string `json:"auto_budget_currency_id,omitempty"`
	// Use either currency_id or currency_code. Defaults to the user's default currency.
	AutoBudgetCurrencyCode string            `json:"auto_budget_currency_code,omitempty"`
	AutoBudgetAmount       string            `json:"auto_budget_amount,omitempty"`
	AutoBudgetPeriod       *AutoBudgetPeriod `json:"auto_budget_period,omitempty"`
	// Information on how much was spent in this budget. Is only filled in when the start and end date are submitted.
	Spent []BudgetSpent `json:"spent,omitempty"`
}

type BudgetArray ¶

type BudgetArray struct {
	Data []BudgetRead `json:"data"`
	Meta *Meta        `json:"meta"`
}

type BudgetLimit ¶

type BudgetLimit struct {
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// Start date of the budget limit.
	Start time.Time `json:"start"`
	// End date of the budget limit.
	End time.Time `json:"end"`
	// Use either currency_id or currency_code. Defaults to the user's default currency.
	CurrencyId string `json:"currency_id,omitempty"`
	// Use either currency_id or currency_code. Defaults to the user's default currency.
	CurrencyCode          string `json:"currency_code,omitempty"`
	CurrencyName          string `json:"currency_name,omitempty"`
	CurrencySymbol        string `json:"currency_symbol,omitempty"`
	CurrencyDecimalPlaces int32  `json:"currency_decimal_places,omitempty"`
	// The budget ID of the associated budget.
	BudgetId string `json:"budget_id"`
	// Period of the budget limit. Only used when auto-generated by auto-budget.
	Period string `json:"period,omitempty"`
	Amount string `json:"amount"`
	Spent  string `json:"spent,omitempty"`
}

type BudgetLimitArray ¶

type BudgetLimitArray struct {
	Data []BudgetLimitRead `json:"data"`
	Meta *Meta             `json:"meta"`
}

type BudgetLimitRead ¶

type BudgetLimitRead struct {
	// Immutable value
	Type_      string       `json:"type"`
	Id         string       `json:"id"`
	Attributes *BudgetLimit `json:"attributes"`
}

type BudgetLimitSingle ¶

type BudgetLimitSingle struct {
	Data *BudgetLimitRead `json:"data"`
}

type BudgetLimitStore ¶

type BudgetLimitStore struct {
	// Use either currency_id or currency_code. Defaults to the user's default currency.
	CurrencyId string `json:"currency_id,omitempty"`
	// Use either currency_id or currency_code. Defaults to the user's default currency.
	CurrencyCode string `json:"currency_code,omitempty"`
	// The budget ID of the associated budget.
	BudgetId string `json:"budget_id"`
	// Start date of the budget limit.
	Start string `json:"start"`
	// Period of the budget limit. Only used when auto-generated by auto-budget.
	Period string `json:"period,omitempty"`
	// End date of the budget limit.
	End    string `json:"end"`
	Amount string `json:"amount"`
}

type BudgetRead ¶

type BudgetRead struct {
	// Immutable value
	Type_      string  `json:"type"`
	Id         string  `json:"id"`
	Attributes *Budget `json:"attributes"`
}

type BudgetSingle ¶

type BudgetSingle struct {
	Data *BudgetRead `json:"data"`
}

type BudgetSpent ¶

type BudgetSpent struct {
	// The amount spent.
	Sum            string `json:"sum,omitempty"`
	CurrencyId     string `json:"currency_id,omitempty"`
	CurrencyCode   string `json:"currency_code,omitempty"`
	CurrencySymbol string `json:"currency_symbol,omitempty"`
	// Number of decimals supported by the currency
	CurrencyDecimalPlaces int32 `json:"currency_decimal_places,omitempty"`
}

type BudgetStore ¶

type BudgetStore struct {
	Name           string          `json:"name"`
	Active         bool            `json:"active,omitempty"`
	Order          int32           `json:"order,omitempty"`
	Notes          string          `json:"notes,omitempty"`
	AutoBudgetType *AutoBudgetType `json:"auto_budget_type,omitempty"`
	// Use either currency_id or currency_code. Defaults to the user's default currency.
	AutoBudgetCurrencyId string `json:"auto_budget_currency_id,omitempty"`
	// Use either currency_id or currency_code. Defaults to the user's default currency.
	AutoBudgetCurrencyCode string            `json:"auto_budget_currency_code,omitempty"`
	AutoBudgetAmount       string            `json:"auto_budget_amount,omitempty"`
	AutoBudgetPeriod       *AutoBudgetPeriod `json:"auto_budget_period,omitempty"`
}

type BudgetUpdate ¶

type BudgetUpdate struct {
	Name           string          `json:"name"`
	Active         bool            `json:"active,omitempty"`
	Order          int32           `json:"order,omitempty"`
	Notes          string          `json:"notes,omitempty"`
	AutoBudgetType *AutoBudgetType `json:"auto_budget_type,omitempty"`
	// Use either currency_id or currency_code. Defaults to the user's default currency.
	AutoBudgetCurrencyId string `json:"auto_budget_currency_id,omitempty"`
	// Use either currency_id or currency_code. Defaults to the user's default currency.
	AutoBudgetCurrencyCode string            `json:"auto_budget_currency_code,omitempty"`
	AutoBudgetAmount       string            `json:"auto_budget_amount,omitempty"`
	AutoBudgetPeriod       *AutoBudgetPeriod `json:"auto_budget_period,omitempty"`
}

type BudgetsApiDeleteBudgetLimitOpts ¶

type BudgetsApiDeleteBudgetLimitOpts struct {
	XTraceId optional.Interface
}

type BudgetsApiDeleteBudgetOpts ¶

type BudgetsApiDeleteBudgetOpts struct {
	XTraceId optional.Interface
}

type BudgetsApiGetBudgetLimitOpts ¶

type BudgetsApiGetBudgetLimitOpts struct {
	XTraceId optional.Interface
}

type BudgetsApiGetBudgetOpts ¶

type BudgetsApiGetBudgetOpts struct {
	XTraceId optional.Interface
	Start    optional.String
	End      optional.String
}

type BudgetsApiListAttachmentByBudgetOpts ¶

type BudgetsApiListAttachmentByBudgetOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type BudgetsApiListBudgetLimitByBudgetOpts ¶

type BudgetsApiListBudgetLimitByBudgetOpts struct {
	XTraceId optional.Interface
	Start    optional.String
	End      optional.String
}

type BudgetsApiListBudgetLimitOpts ¶

type BudgetsApiListBudgetLimitOpts struct {
	XTraceId optional.Interface
}

type BudgetsApiListBudgetOpts ¶

type BudgetsApiListBudgetOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
	Start    optional.String
	End      optional.String
}

type BudgetsApiListTransactionByBudgetLimitOpts ¶

type BudgetsApiListTransactionByBudgetLimitOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
	Type_    optional.Interface
}

type BudgetsApiListTransactionByBudgetOpts ¶

type BudgetsApiListTransactionByBudgetOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
	Start    optional.String
	End      optional.String
	Type_    optional.Interface
}

type BudgetsApiService ¶

type BudgetsApiService service

func (*BudgetsApiService) DeleteBudget ¶

func (a *BudgetsApiService) DeleteBudget(ctx context.Context, id string, localVarOptionals *BudgetsApiDeleteBudgetOpts) (*http.Response, error)

func (*BudgetsApiService) DeleteBudgetLimit ¶

func (a *BudgetsApiService) DeleteBudgetLimit(ctx context.Context, id string, limitId string, localVarOptionals *BudgetsApiDeleteBudgetLimitOpts) (*http.Response, error)

func (*BudgetsApiService) GetBudget ¶

func (a *BudgetsApiService) GetBudget(ctx context.Context, id string, localVarOptionals *BudgetsApiGetBudgetOpts) (BudgetSingle, *http.Response, error)

func (*BudgetsApiService) GetBudgetLimit ¶

func (a *BudgetsApiService) GetBudgetLimit(ctx context.Context, id string, limitId int32, localVarOptionals *BudgetsApiGetBudgetLimitOpts) (BudgetLimitSingle, *http.Response, error)

func (*BudgetsApiService) ListAttachmentByBudget ¶

func (a *BudgetsApiService) ListAttachmentByBudget(ctx context.Context, id string, localVarOptionals *BudgetsApiListAttachmentByBudgetOpts) (AttachmentArray, *http.Response, error)

func (*BudgetsApiService) ListBudget ¶

func (a *BudgetsApiService) ListBudget(ctx context.Context, localVarOptionals *BudgetsApiListBudgetOpts) (BudgetArray, *http.Response, error)

func (*BudgetsApiService) ListBudgetLimit ¶

func (a *BudgetsApiService) ListBudgetLimit(ctx context.Context, start string, end string, localVarOptionals *BudgetsApiListBudgetLimitOpts) (BudgetLimitArray, *http.Response, error)

func (*BudgetsApiService) ListBudgetLimitByBudget ¶

func (a *BudgetsApiService) ListBudgetLimitByBudget(ctx context.Context, id string, localVarOptionals *BudgetsApiListBudgetLimitByBudgetOpts) (BudgetLimitArray, *http.Response, error)

func (*BudgetsApiService) ListTransactionByBudget ¶

func (a *BudgetsApiService) ListTransactionByBudget(ctx context.Context, id string, localVarOptionals *BudgetsApiListTransactionByBudgetOpts) (TransactionArray, *http.Response, error)

func (*BudgetsApiService) ListTransactionByBudgetLimit ¶

func (a *BudgetsApiService) ListTransactionByBudgetLimit(ctx context.Context, id string, limitId string, localVarOptionals *BudgetsApiListTransactionByBudgetLimitOpts) (TransactionArray, *http.Response, error)

func (*BudgetsApiService) StoreBudget ¶

func (a *BudgetsApiService) StoreBudget(ctx context.Context, body BudgetStore, localVarOptionals *BudgetsApiStoreBudgetOpts) (BudgetSingle, *http.Response, error)

func (*BudgetsApiService) StoreBudgetLimit ¶

func (a *BudgetsApiService) StoreBudgetLimit(ctx context.Context, body BudgetLimitStore, id string, localVarOptionals *BudgetsApiStoreBudgetLimitOpts) (BudgetLimitSingle, *http.Response, error)

func (*BudgetsApiService) UpdateBudget ¶

func (a *BudgetsApiService) UpdateBudget(ctx context.Context, body BudgetUpdate, id string, localVarOptionals *BudgetsApiUpdateBudgetOpts) (BudgetSingle, *http.Response, error)

func (*BudgetsApiService) UpdateBudgetLimit ¶

func (a *BudgetsApiService) UpdateBudgetLimit(ctx context.Context, body BudgetLimit, id string, limitId string, localVarOptionals *BudgetsApiUpdateBudgetLimitOpts) (BudgetLimitSingle, *http.Response, error)

type BudgetsApiStoreBudgetLimitOpts ¶

type BudgetsApiStoreBudgetLimitOpts struct {
	XTraceId optional.Interface
}

type BudgetsApiStoreBudgetOpts ¶

type BudgetsApiStoreBudgetOpts struct {
	XTraceId optional.Interface
}

type BudgetsApiUpdateBudgetLimitOpts ¶

type BudgetsApiUpdateBudgetLimitOpts struct {
	XTraceId optional.Interface
}

type BudgetsApiUpdateBudgetOpts ¶

type BudgetsApiUpdateBudgetOpts struct {
	XTraceId optional.Interface
}

type CategoriesApiDeleteCategoryOpts ¶

type CategoriesApiDeleteCategoryOpts struct {
	XTraceId optional.Interface
}

type CategoriesApiGetCategoryOpts ¶

type CategoriesApiGetCategoryOpts struct {
	XTraceId optional.Interface
	Start    optional.String
	End      optional.String
}

type CategoriesApiListAttachmentByCategoryOpts ¶

type CategoriesApiListAttachmentByCategoryOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type CategoriesApiListCategoryOpts ¶

type CategoriesApiListCategoryOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type CategoriesApiListTransactionByCategoryOpts ¶

type CategoriesApiListTransactionByCategoryOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
	Start    optional.String
	End      optional.String
	Type_    optional.Interface
}

type CategoriesApiService ¶

type CategoriesApiService service

func (*CategoriesApiService) DeleteCategory ¶

func (a *CategoriesApiService) DeleteCategory(ctx context.Context, id string, localVarOptionals *CategoriesApiDeleteCategoryOpts) (*http.Response, error)

func (*CategoriesApiService) GetCategory ¶

func (a *CategoriesApiService) GetCategory(ctx context.Context, id string, localVarOptionals *CategoriesApiGetCategoryOpts) (CategorySingle, *http.Response, error)

func (*CategoriesApiService) ListAttachmentByCategory ¶

func (a *CategoriesApiService) ListAttachmentByCategory(ctx context.Context, id string, localVarOptionals *CategoriesApiListAttachmentByCategoryOpts) (AttachmentArray, *http.Response, error)

func (*CategoriesApiService) ListCategory ¶

func (a *CategoriesApiService) ListCategory(ctx context.Context, localVarOptionals *CategoriesApiListCategoryOpts) (CategoryArray, *http.Response, error)

func (*CategoriesApiService) ListTransactionByCategory ¶

func (a *CategoriesApiService) ListTransactionByCategory(ctx context.Context, id string, localVarOptionals *CategoriesApiListTransactionByCategoryOpts) (TransactionArray, *http.Response, error)

func (*CategoriesApiService) StoreCategory ¶

func (a *CategoriesApiService) StoreCategory(ctx context.Context, body Category, localVarOptionals *CategoriesApiStoreCategoryOpts) (CategorySingle, *http.Response, error)

func (*CategoriesApiService) UpdateCategory ¶

func (a *CategoriesApiService) UpdateCategory(ctx context.Context, body CategoryUpdate, id string, localVarOptionals *CategoriesApiUpdateCategoryOpts) (CategorySingle, *http.Response, error)

type CategoriesApiStoreCategoryOpts ¶

type CategoriesApiStoreCategoryOpts struct {
	XTraceId optional.Interface
}

type CategoriesApiUpdateCategoryOpts ¶

type CategoriesApiUpdateCategoryOpts struct {
	XTraceId optional.Interface
}

type Category ¶

type Category struct {
	CreatedAt time.Time        `json:"created_at,omitempty"`
	UpdatedAt time.Time        `json:"updated_at,omitempty"`
	Name      string           `json:"name"`
	Notes     string           `json:"notes,omitempty"`
	Spent     []CategorySpent  `json:"spent,omitempty"`
	Earned    []CategoryEarned `json:"earned,omitempty"`
}

type CategoryArray ¶

type CategoryArray struct {
	Data []CategoryRead `json:"data"`
	Meta *Meta          `json:"meta"`
}

type CategoryEarned ¶

type CategoryEarned struct {
	CurrencyId     string `json:"currency_id,omitempty"`
	CurrencyCode   string `json:"currency_code,omitempty"`
	CurrencySymbol string `json:"currency_symbol,omitempty"`
	// Number of decimals supported by the currency
	CurrencyDecimalPlaces int32 `json:"currency_decimal_places,omitempty"`
	// The amount earned.
	Sum string `json:"sum,omitempty"`
}

type CategoryRead ¶

type CategoryRead struct {
	// Immutable value
	Type_      string    `json:"type"`
	Id         string    `json:"id"`
	Attributes *Category `json:"attributes"`
}

type CategorySingle ¶

type CategorySingle struct {
	Data *CategoryRead `json:"data"`
}

type CategorySpent ¶

type CategorySpent struct {
	CurrencyId     string `json:"currency_id,omitempty"`
	CurrencyCode   string `json:"currency_code,omitempty"`
	CurrencySymbol string `json:"currency_symbol,omitempty"`
	// Number of decimals supported by the currency
	CurrencyDecimalPlaces int32 `json:"currency_decimal_places,omitempty"`
	// The amount spent.
	Sum string `json:"sum,omitempty"`
}

type CategoryUpdate ¶

type CategoryUpdate struct {
	Name  string `json:"name"`
	Notes string `json:"notes,omitempty"`
}

type ChartDataPoint ¶

type ChartDataPoint struct {
	// The key is the label of the value, so for example: '2018-01-01' => 13 or 'Groceries' => -123.
	Key string `json:"key,omitempty"`
}

type ChartDataSet ¶

type ChartDataSet struct {
	// This is the title of the current set. It can refer to an account, a budget or another object (by name).
	Label string `json:"label,omitempty"`
	// The currency ID of the currency associated to the data in the entries.
	CurrencyId     string `json:"currency_id,omitempty"`
	CurrencyCode   string `json:"currency_code,omitempty"`
	CurrencySymbol string `json:"currency_symbol,omitempty"`
	// Number of decimals for the currency associated to the data in the entries.
	CurrencyDecimalPlaces int32     `json:"currency_decimal_places,omitempty"`
	StartDate             time.Time `json:"start_date,omitempty"`
	EndDate               time.Time `json:"end_date,omitempty"`
	// Indicated the type of chart that is expected to be rendered. You can safely ignore this if you want.
	Type_ string `json:"type,omitempty"`
	// Used to indicate the Y axis for this data set. Is usually between 0 and 1 (left and right side of the chart).
	YAxisID int32 `json:"yAxisID,omitempty"`
	// The actual entries for this data set. They 'key' value is the label for the data point. The value is the actual (numerical) value.
	Entries []ChartDataPoint `json:"entries,omitempty"`
}

type ChartsApiGetChartAccountOverviewOpts ¶

type ChartsApiGetChartAccountOverviewOpts struct {
	XTraceId optional.Interface
}

type ChartsApiService ¶

type ChartsApiService service

func (*ChartsApiService) GetChartAccountOverview ¶

func (a *ChartsApiService) GetChartAccountOverview(ctx context.Context, start string, end string, localVarOptionals *ChartsApiGetChartAccountOverviewOpts) ([]ChartDataSet, *http.Response, error)

type ConfigValueFilter ¶

type ConfigValueFilter string

ConfigValueFilter : Title of the configuration value.

const (
	CONFIGURATIONIS_DEMO_SITE_ConfigValueFilter            ConfigValueFilter = "configuration.is_demo_site"
	CONFIGURATIONPERMISSION_UPDATE_CHECK_ConfigValueFilter ConfigValueFilter = "configuration.permission_update_check"
	CONFIGURATIONLAST_UPDATE_CHECK_ConfigValueFilter       ConfigValueFilter = "configuration.last_update_check"
	CONFIGURATIONSINGLE_USER_MODE_ConfigValueFilter        ConfigValueFilter = "configuration.single_user_mode"
	FIREFLYVERSION_ConfigValueFilter                       ConfigValueFilter = "firefly.version"
	FIREFLYAPI_VERSION_ConfigValueFilter                   ConfigValueFilter = "firefly.api_version"
	FIREFLYDEFAULT_LOCATION_ConfigValueFilter              ConfigValueFilter = "firefly.default_location"
	FIREFLYACCOUNT_TO_TRANSACTION_ConfigValueFilter        ConfigValueFilter = "firefly.account_to_transaction"
	FIREFLYALLOWED_OPPOSING_TYPES_ConfigValueFilter        ConfigValueFilter = "firefly.allowed_opposing_types"
	FIREFLYACCOUNT_ROLES_ConfigValueFilter                 ConfigValueFilter = "firefly.accountRoles"
	FIREFLYVALID_LIABILITIES_ConfigValueFilter             ConfigValueFilter = "firefly.valid_liabilities"
	FIREFLYINTEREST_PERIODS_ConfigValueFilter              ConfigValueFilter = "firefly.interest_periods"
	FIREFLYENABLE_EXTERNAL_MAP_ConfigValueFilter           ConfigValueFilter = "firefly.enable_external_map"
	FIREFLYEXPECTED_SOURCE_TYPES_ConfigValueFilter         ConfigValueFilter = "firefly.expected_source_types"
	APPTIMEZONE_ConfigValueFilter                          ConfigValueFilter = "app.timezone"
	FIREFLYBILL_PERIODS_ConfigValueFilter                  ConfigValueFilter = "firefly.bill_periods"
	FIREFLYCREDIT_CARD_TYPES_ConfigValueFilter             ConfigValueFilter = "firefly.credit_card_types"
	FIREFLYLANGUAGES_ConfigValueFilter                     ConfigValueFilter = "firefly.languages"
	FIREFLYVALID_VIEW_RANGES_ConfigValueFilter             ConfigValueFilter = "firefly.valid_view_ranges"
)

List of ConfigValueFilter

type ConfigValueUpdateFilter ¶

type ConfigValueUpdateFilter string

const (
	IS_DEMO_SITE_ConfigValueUpdateFilter            ConfigValueUpdateFilter = "configuration.is_demo_site"
	PERMISSION_UPDATE_CHECK_ConfigValueUpdateFilter ConfigValueUpdateFilter = "configuration.permission_update_check"
	LAST_UPDATE_CHECK_ConfigValueUpdateFilter       ConfigValueUpdateFilter = "configuration.last_update_check"
	SINGLE_USER_MODE_ConfigValueUpdateFilter        ConfigValueUpdateFilter = "configuration.single_user_mode"
)

List of ConfigValueUpdateFilter

type Configuration ¶

type Configuration struct {
	Title *ConfigValueFilter   `json:"title"`
	Value *PolymorphicProperty `json:"value"`
	// If this config variable can be edited by the user
	Editable bool `json:"editable"`
}

func NewConfiguration ¶

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader ¶

func (c *Configuration) AddDefaultHeader(key string, value string)

type ConfigurationApiGetConfigurationOpts ¶

type ConfigurationApiGetConfigurationOpts struct {
	XTraceId optional.Interface
}

type ConfigurationApiGetSingleConfigurationOpts ¶

type ConfigurationApiGetSingleConfigurationOpts struct {
	XTraceId optional.Interface
}

type ConfigurationApiService ¶

type ConfigurationApiService service

func (*ConfigurationApiService) GetConfiguration ¶

func (a *ConfigurationApiService) GetConfiguration(ctx context.Context, localVarOptionals *ConfigurationApiGetConfigurationOpts) ([]Configuration, *http.Response, error)

func (*ConfigurationApiService) GetSingleConfiguration ¶

func (a *ConfigurationApiService) GetSingleConfiguration(ctx context.Context, name ConfigValueFilter, localVarOptionals *ConfigurationApiGetSingleConfigurationOpts) (ConfigurationSingle, *http.Response, error)

func (*ConfigurationApiService) SetConfiguration ¶

func (a *ConfigurationApiService) SetConfiguration(ctx context.Context, value PolymorphicProperty, name ConfigValueUpdateFilter, localVarOptionals *ConfigurationApiSetConfigurationOpts) (ConfigurationSingle, *http.Response, error)

type ConfigurationApiSetConfigurationOpts ¶

type ConfigurationApiSetConfigurationOpts struct {
	XTraceId optional.Interface
}

type ConfigurationSingle ¶

type ConfigurationSingle struct {
	Data *Configuration `json:"data"`
}

type ConfigurationUpdate ¶

type ConfigurationUpdate struct {
	Value *PolymorphicProperty `json:"value"`
}

type CreditCardTypeProperty ¶

type CreditCardTypeProperty string

CreditCardTypeProperty : Mandatory when the account_role is ccAsset. Can only be monthlyFull or null.

const (
	MONTHLY_FULL_CreditCardTypeProperty CreditCardTypeProperty = "monthlyFull"
	NULL_CreditCardTypeProperty         CreditCardTypeProperty = ""
)

List of CreditCardTypeProperty

type CronResult ¶

type CronResult struct {
	RecurringTransactions *CronResultRow `json:"recurring_transactions,omitempty"`
	AutoBudgets           *CronResultRow `json:"auto_budgets,omitempty"`
	Telemetry             *CronResultRow `json:"telemetry,omitempty"`
}

type CronResultRow ¶

type CronResultRow struct {
	// This value tells you if this specific cron job actually fired. It may not fire. Some cron jobs only fire every 24 hours, for example.
	JobFired bool `json:"job_fired,omitempty"`
	// This value tells you if this specific cron job actually did something. The job may fire but not change anything.
	JobSucceeded bool `json:"job_succeeded,omitempty"`
	// If the cron job ran into some kind of an error, this value will be true.
	JobErrored bool `json:"job_errored,omitempty"`
	// If the cron job ran into some kind of an error, this value will be the error message. The success message if the job actually ran OK.
	Message string `json:"message,omitempty"`
}

type CurrenciesApiDefaultCurrencyOpts ¶

type CurrenciesApiDefaultCurrencyOpts struct {
	XTraceId optional.Interface
}

type CurrenciesApiDeleteCurrencyOpts ¶

type CurrenciesApiDeleteCurrencyOpts struct {
	XTraceId optional.Interface
}

type CurrenciesApiDisableCurrencyOpts ¶

type CurrenciesApiDisableCurrencyOpts struct {
	XTraceId optional.Interface
}

type CurrenciesApiEnableCurrencyOpts ¶

type CurrenciesApiEnableCurrencyOpts struct {
	XTraceId optional.Interface
}

type CurrenciesApiGetCurrencyOpts ¶

type CurrenciesApiGetCurrencyOpts struct {
	XTraceId optional.Interface
}

type CurrenciesApiGetDefaultCurrencyOpts ¶

type CurrenciesApiGetDefaultCurrencyOpts struct {
	XTraceId optional.Interface
}

type CurrenciesApiListAccountByCurrencyOpts ¶

type CurrenciesApiListAccountByCurrencyOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
	Date     optional.String
	Type_    optional.Interface
}

type CurrenciesApiListAvailableBudgetByCurrencyOpts ¶

type CurrenciesApiListAvailableBudgetByCurrencyOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type CurrenciesApiListBillByCurrencyOpts ¶

type CurrenciesApiListBillByCurrencyOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type CurrenciesApiListBudgetLimitByCurrencyOpts ¶

type CurrenciesApiListBudgetLimitByCurrencyOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
	Start    optional.String
	End      optional.String
}

type CurrenciesApiListCurrencyOpts ¶

type CurrenciesApiListCurrencyOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type CurrenciesApiListRecurrenceByCurrencyOpts ¶

type CurrenciesApiListRecurrenceByCurrencyOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type CurrenciesApiListRuleByCurrencyOpts ¶

type CurrenciesApiListRuleByCurrencyOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type CurrenciesApiListTransactionByCurrencyOpts ¶

type CurrenciesApiListTransactionByCurrencyOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
	Start    optional.String
	End      optional.String
	Type_    optional.Interface
}

type CurrenciesApiService ¶

type CurrenciesApiService service

func (*CurrenciesApiService) DefaultCurrency ¶

func (a *CurrenciesApiService) DefaultCurrency(ctx context.Context, code string, localVarOptionals *CurrenciesApiDefaultCurrencyOpts) (CurrencySingle, *http.Response, error)

func (*CurrenciesApiService) DeleteCurrency ¶

func (a *CurrenciesApiService) DeleteCurrency(ctx context.Context, code string, localVarOptionals *CurrenciesApiDeleteCurrencyOpts) (*http.Response, error)

func (*CurrenciesApiService) DisableCurrency ¶

func (a *CurrenciesApiService) DisableCurrency(ctx context.Context, code string, localVarOptionals *CurrenciesApiDisableCurrencyOpts) (CurrencySingle, *http.Response, error)

func (*CurrenciesApiService) EnableCurrency ¶

func (a *CurrenciesApiService) EnableCurrency(ctx context.Context, code string, localVarOptionals *CurrenciesApiEnableCurrencyOpts) (CurrencySingle, *http.Response, error)

func (*CurrenciesApiService) GetCurrency ¶

func (a *CurrenciesApiService) GetCurrency(ctx context.Context, code string, localVarOptionals *CurrenciesApiGetCurrencyOpts) (CurrencySingle, *http.Response, error)

func (*CurrenciesApiService) GetDefaultCurrency ¶

func (a *CurrenciesApiService) GetDefaultCurrency(ctx context.Context, localVarOptionals *CurrenciesApiGetDefaultCurrencyOpts) (CurrencySingle, *http.Response, error)

func (*CurrenciesApiService) ListAccountByCurrency ¶

func (a *CurrenciesApiService) ListAccountByCurrency(ctx context.Context, code string, localVarOptionals *CurrenciesApiListAccountByCurrencyOpts) (AccountArray, *http.Response, error)

func (*CurrenciesApiService) ListAvailableBudgetByCurrency ¶

func (a *CurrenciesApiService) ListAvailableBudgetByCurrency(ctx context.Context, code string, localVarOptionals *CurrenciesApiListAvailableBudgetByCurrencyOpts) (AvailableBudgetArray, *http.Response, error)

func (*CurrenciesApiService) ListBillByCurrency ¶

func (a *CurrenciesApiService) ListBillByCurrency(ctx context.Context, code string, localVarOptionals *CurrenciesApiListBillByCurrencyOpts) (BillArray, *http.Response, error)

func (*CurrenciesApiService) ListBudgetLimitByCurrency ¶

func (a *CurrenciesApiService) ListBudgetLimitByCurrency(ctx context.Context, code string, localVarOptionals *CurrenciesApiListBudgetLimitByCurrencyOpts) (BudgetLimitArray, *http.Response, error)

func (*CurrenciesApiService) ListCurrency ¶

func (a *CurrenciesApiService) ListCurrency(ctx context.Context, localVarOptionals *CurrenciesApiListCurrencyOpts) (CurrencyArray, *http.Response, error)

func (*CurrenciesApiService) ListRecurrenceByCurrency ¶

func (a *CurrenciesApiService) ListRecurrenceByCurrency(ctx context.Context, code string, localVarOptionals *CurrenciesApiListRecurrenceByCurrencyOpts) (RecurrenceArray, *http.Response, error)

func (*CurrenciesApiService) ListRuleByCurrency ¶

func (a *CurrenciesApiService) ListRuleByCurrency(ctx context.Context, code string, localVarOptionals *CurrenciesApiListRuleByCurrencyOpts) (RuleArray, *http.Response, error)

func (*CurrenciesApiService) ListTransactionByCurrency ¶

func (a *CurrenciesApiService) ListTransactionByCurrency(ctx context.Context, code string, localVarOptionals *CurrenciesApiListTransactionByCurrencyOpts) (TransactionArray, *http.Response, error)

func (*CurrenciesApiService) StoreCurrency ¶

func (a *CurrenciesApiService) StoreCurrency(ctx context.Context, body CurrencyStore, localVarOptionals *CurrenciesApiStoreCurrencyOpts) (CurrencySingle, *http.Response, error)

func (*CurrenciesApiService) UpdateCurrency ¶

func (a *CurrenciesApiService) UpdateCurrency(ctx context.Context, body CurrencyUpdate, code string, localVarOptionals *CurrenciesApiUpdateCurrencyOpts) (CurrencySingle, *http.Response, error)

type CurrenciesApiStoreCurrencyOpts ¶

type CurrenciesApiStoreCurrencyOpts struct {
	XTraceId optional.Interface
}

type CurrenciesApiUpdateCurrencyOpts ¶

type CurrenciesApiUpdateCurrencyOpts struct {
	XTraceId optional.Interface
}

type Currency ¶

type Currency struct {
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// Defaults to true
	Enabled bool `json:"enabled,omitempty"`
	// Make this currency the default currency.
	Default_ bool   `json:"default,omitempty"`
	Code     string `json:"code"`
	Name     string `json:"name"`
	Symbol   string `json:"symbol"`
	// Supports 0-16 decimals.
	DecimalPlaces int32 `json:"decimal_places,omitempty"`
}

type CurrencyArray ¶

type CurrencyArray struct {
	Data  []CurrencyRead `json:"data"`
	Meta  *Meta          `json:"meta"`
	Links *PageLink      `json:"links"`
}

type CurrencyRead ¶

type CurrencyRead struct {
	// Immutable value
	Type_      string    `json:"type"`
	Id         string    `json:"id"`
	Attributes *Currency `json:"attributes"`
}

type CurrencySingle ¶

type CurrencySingle struct {
	Data *CurrencyRead `json:"data"`
}

type CurrencyStore ¶

type CurrencyStore struct {
	// Defaults to true
	Enabled bool `json:"enabled,omitempty"`
	// Make this currency the default currency. You can set this value to FALSE, in which case nothing will change to the default currency. If you set it to TRUE, the current default currency will no longer be the default currency.
	Default_ bool   `json:"default,omitempty"`
	Code     string `json:"code"`
	Name     string `json:"name"`
	Symbol   string `json:"symbol"`
	// Supports 0-16 decimals.
	DecimalPlaces int32 `json:"decimal_places,omitempty"`
}

type CurrencyUpdate ¶

type CurrencyUpdate struct {
	// If the currency is enabled
	Enabled bool `json:"enabled,omitempty"`
	// If the currency must be the default for the user. You can only submit TRUE. Submitting FALSE will not drop this currency as the default currency, because then the system would be without one.
	Default_ bool `json:"default,omitempty"`
	// The currency code
	Code string `json:"code,omitempty"`
	// The currency name
	Name string `json:"name,omitempty"`
	// The currency symbol
	Symbol string `json:"symbol,omitempty"`
	// How many decimals to use when displaying this currency. Between 0 and 16.
	DecimalPlaces int32 `json:"decimal_places,omitempty"`
}

type DataApiDestroyDataOpts ¶

type DataApiDestroyDataOpts struct {
	XTraceId optional.Interface
}

type DataApiExportAccountsOpts ¶

type DataApiExportAccountsOpts struct {
	XTraceId optional.Interface
	Type_    optional.Interface
}

type DataApiExportBillsOpts ¶

type DataApiExportBillsOpts struct {
	XTraceId optional.Interface
	Type_    optional.Interface
}

type DataApiExportBudgetsOpts ¶

type DataApiExportBudgetsOpts struct {
	XTraceId optional.Interface
	Type_    optional.Interface
}

type DataApiExportCategoriesOpts ¶

type DataApiExportCategoriesOpts struct {
	XTraceId optional.Interface
	Type_    optional.Interface
}

type DataApiExportPiggiesOpts ¶

type DataApiExportPiggiesOpts struct {
	XTraceId optional.Interface
	Type_    optional.Interface
}

type DataApiExportRecurringOpts ¶

type DataApiExportRecurringOpts struct {
	XTraceId optional.Interface
	Type_    optional.Interface
}

type DataApiExportRulesOpts ¶

type DataApiExportRulesOpts struct {
	XTraceId optional.Interface
	Type_    optional.Interface
}

type DataApiExportTagsOpts ¶

type DataApiExportTagsOpts struct {
	XTraceId optional.Interface
	Type_    optional.Interface
}

type DataApiExportTransactionsOpts ¶

type DataApiExportTransactionsOpts struct {
	XTraceId optional.Interface
	Accounts optional.String
	Type_    optional.Interface
}

type DataApiPurgeDataOpts ¶

type DataApiPurgeDataOpts struct {
	XTraceId optional.Interface
}

type DataApiService ¶

type DataApiService service

func (*DataApiService) BulkUpdateTransactions ¶

func (a *DataApiService) BulkUpdateTransactions(ctx context.Context, query string) (*http.Response, error)

DataApiService Bulk update transaction properties. For more information, see https://docs.firefly-iii.org/references/firefly-iii/api/specials/ Allows you to update transactions in bulk.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@param query The JSON query.

func (*DataApiService) DestroyData ¶

func (a *DataApiService) DestroyData(ctx context.Context, objects DataDestroyObject, localVarOptionals *DataApiDestroyDataOpts) (*http.Response, error)

func (*DataApiService) ExportAccounts ¶

func (a *DataApiService) ExportAccounts(ctx context.Context, localVarOptionals *DataApiExportAccountsOpts) (*os.File, *http.Response, error)

func (*DataApiService) ExportBills ¶

func (a *DataApiService) ExportBills(ctx context.Context, localVarOptionals *DataApiExportBillsOpts) (*os.File, *http.Response, error)

func (*DataApiService) ExportBudgets ¶

func (a *DataApiService) ExportBudgets(ctx context.Context, localVarOptionals *DataApiExportBudgetsOpts) (*os.File, *http.Response, error)

func (*DataApiService) ExportCategories ¶

func (a *DataApiService) ExportCategories(ctx context.Context, localVarOptionals *DataApiExportCategoriesOpts) (*os.File, *http.Response, error)

func (*DataApiService) ExportPiggies ¶

func (a *DataApiService) ExportPiggies(ctx context.Context, localVarOptionals *DataApiExportPiggiesOpts) (*os.File, *http.Response, error)

func (*DataApiService) ExportRecurring ¶

func (a *DataApiService) ExportRecurring(ctx context.Context, localVarOptionals *DataApiExportRecurringOpts) (*os.File, *http.Response, error)

func (*DataApiService) ExportRules ¶

func (a *DataApiService) ExportRules(ctx context.Context, localVarOptionals *DataApiExportRulesOpts) (*os.File, *http.Response, error)

func (*DataApiService) ExportTags ¶

func (a *DataApiService) ExportTags(ctx context.Context, localVarOptionals *DataApiExportTagsOpts) (*os.File, *http.Response, error)

func (*DataApiService) ExportTransactions ¶

func (a *DataApiService) ExportTransactions(ctx context.Context, start string, end string, localVarOptionals *DataApiExportTransactionsOpts) (*os.File, *http.Response, error)

func (*DataApiService) PurgeData ¶

func (a *DataApiService) PurgeData(ctx context.Context, localVarOptionals *DataApiPurgeDataOpts) (*http.Response, error)

type DataDestroyObject ¶

type DataDestroyObject string

const (
	NOT_ASSETS_LIABILITIES_DataDestroyObject DataDestroyObject = "not_assets_liabilities"
	BUDGETS_DataDestroyObject                DataDestroyObject = "budgets"
	BILLS_DataDestroyObject                  DataDestroyObject = "bills"
	PIGGY_BANKS_DataDestroyObject            DataDestroyObject = "piggy_banks"
	RULES_DataDestroyObject                  DataDestroyObject = "rules"
	RECURRING_DataDestroyObject              DataDestroyObject = "recurring"
	CATEGORIES_DataDestroyObject             DataDestroyObject = "categories"
	TAGS_DataDestroyObject                   DataDestroyObject = "tags"
	OBJECT_GROUPS_DataDestroyObject          DataDestroyObject = "object_groups"
	ACCOUNTS_DataDestroyObject               DataDestroyObject = "accounts"
	ASSET_ACCOUNTS_DataDestroyObject         DataDestroyObject = "asset_accounts"
	EXPENSE_ACCOUNTS_DataDestroyObject       DataDestroyObject = "expense_accounts"
	REVENUE_ACCOUNTS_DataDestroyObject       DataDestroyObject = "revenue_accounts"
	LIABILITIES_DataDestroyObject            DataDestroyObject = "liabilities"
	TRANSACTIONS_DataDestroyObject           DataDestroyObject = "transactions"
	WITHDRAWALS_DataDestroyObject            DataDestroyObject = "withdrawals"
	DEPOSITS_DataDestroyObject               DataDestroyObject = "deposits"
	TRANSFERS_DataDestroyObject              DataDestroyObject = "transfers"
)

List of DataDestroyObject

type ExportFileFilter ¶

type ExportFileFilter string

const (
	CSV_ExportFileFilter ExportFileFilter = "csv"
)

List of ExportFileFilter

type GenericSwaggerError ¶

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body ¶

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error ¶

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model ¶

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type InsightApiInsightExpenseAssetOpts ¶

type InsightApiInsightExpenseAssetOpts struct {
	XTraceId optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightExpenseBillOpts ¶

type InsightApiInsightExpenseBillOpts struct {
	XTraceId optional.Interface
	Bills    optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightExpenseBudgetOpts ¶

type InsightApiInsightExpenseBudgetOpts struct {
	XTraceId optional.Interface
	Budgets  optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightExpenseCategoryOpts ¶

type InsightApiInsightExpenseCategoryOpts struct {
	XTraceId   optional.Interface
	Categories optional.Interface
	Accounts   optional.Interface
}

type InsightApiInsightExpenseExpenseOpts ¶

type InsightApiInsightExpenseExpenseOpts struct {
	XTraceId optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightExpenseNoBillOpts ¶

type InsightApiInsightExpenseNoBillOpts struct {
	XTraceId optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightExpenseNoBudgetOpts ¶

type InsightApiInsightExpenseNoBudgetOpts struct {
	XTraceId optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightExpenseNoCategoryOpts ¶

type InsightApiInsightExpenseNoCategoryOpts struct {
	XTraceId optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightExpenseNoTagOpts ¶

type InsightApiInsightExpenseNoTagOpts struct {
	XTraceId optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightExpenseTagOpts ¶

type InsightApiInsightExpenseTagOpts struct {
	XTraceId optional.Interface
	Tags     optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightExpenseTotalOpts ¶

type InsightApiInsightExpenseTotalOpts struct {
	XTraceId optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightIncomeAssetOpts ¶

type InsightApiInsightIncomeAssetOpts struct {
	XTraceId optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightIncomeCategoryOpts ¶

type InsightApiInsightIncomeCategoryOpts struct {
	XTraceId   optional.Interface
	Categories optional.Interface
	Accounts   optional.Interface
}

type InsightApiInsightIncomeNoCategoryOpts ¶

type InsightApiInsightIncomeNoCategoryOpts struct {
	XTraceId optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightIncomeNoTagOpts ¶

type InsightApiInsightIncomeNoTagOpts struct {
	XTraceId optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightIncomeRevenueOpts ¶

type InsightApiInsightIncomeRevenueOpts struct {
	XTraceId optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightIncomeTagOpts ¶

type InsightApiInsightIncomeTagOpts struct {
	XTraceId optional.Interface
	Tags     optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightIncomeTotalOpts ¶

type InsightApiInsightIncomeTotalOpts struct {
	XTraceId optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightTransferCategoryOpts ¶

type InsightApiInsightTransferCategoryOpts struct {
	XTraceId   optional.Interface
	Categories optional.Interface
	Accounts   optional.Interface
}

type InsightApiInsightTransferNoCategoryOpts ¶

type InsightApiInsightTransferNoCategoryOpts struct {
	XTraceId optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightTransferNoTagOpts ¶

type InsightApiInsightTransferNoTagOpts struct {
	XTraceId optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightTransferTagOpts ¶

type InsightApiInsightTransferTagOpts struct {
	XTraceId optional.Interface
	Tags     optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightTransferTotalOpts ¶

type InsightApiInsightTransferTotalOpts struct {
	XTraceId optional.Interface
	Accounts optional.Interface
}

type InsightApiInsightTransfersOpts ¶

type InsightApiInsightTransfersOpts struct {
	XTraceId optional.Interface
	Accounts optional.Interface
}

type InsightApiService ¶

type InsightApiService service

func (*InsightApiService) InsightExpenseAsset ¶

func (a *InsightApiService) InsightExpenseAsset(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightExpenseAssetOpts) ([]InsightGroupEntry, *http.Response, error)

func (*InsightApiService) InsightExpenseBill ¶

func (a *InsightApiService) InsightExpenseBill(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightExpenseBillOpts) ([]InsightGroupEntry, *http.Response, error)

func (*InsightApiService) InsightExpenseBudget ¶

func (a *InsightApiService) InsightExpenseBudget(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightExpenseBudgetOpts) ([]InsightGroupEntry, *http.Response, error)

func (*InsightApiService) InsightExpenseCategory ¶

func (a *InsightApiService) InsightExpenseCategory(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightExpenseCategoryOpts) ([]InsightGroupEntry, *http.Response, error)

func (*InsightApiService) InsightExpenseExpense ¶

func (a *InsightApiService) InsightExpenseExpense(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightExpenseExpenseOpts) ([]InsightGroupEntry, *http.Response, error)

func (*InsightApiService) InsightExpenseNoBill ¶

func (a *InsightApiService) InsightExpenseNoBill(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightExpenseNoBillOpts) ([]InsightTotalEntry, *http.Response, error)

func (*InsightApiService) InsightExpenseNoBudget ¶

func (a *InsightApiService) InsightExpenseNoBudget(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightExpenseNoBudgetOpts) ([]InsightTotalEntry, *http.Response, error)

func (*InsightApiService) InsightExpenseNoCategory ¶

func (a *InsightApiService) InsightExpenseNoCategory(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightExpenseNoCategoryOpts) ([]InsightTotalEntry, *http.Response, error)

func (*InsightApiService) InsightExpenseNoTag ¶

func (a *InsightApiService) InsightExpenseNoTag(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightExpenseNoTagOpts) ([]InsightTotalEntry, *http.Response, error)

func (*InsightApiService) InsightExpenseTag ¶

func (a *InsightApiService) InsightExpenseTag(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightExpenseTagOpts) ([]InsightGroupEntry, *http.Response, error)

func (*InsightApiService) InsightExpenseTotal ¶

func (a *InsightApiService) InsightExpenseTotal(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightExpenseTotalOpts) ([]InsightTotalEntry, *http.Response, error)

func (*InsightApiService) InsightIncomeAsset ¶

func (a *InsightApiService) InsightIncomeAsset(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightIncomeAssetOpts) ([]InsightGroupEntry, *http.Response, error)

func (*InsightApiService) InsightIncomeCategory ¶

func (a *InsightApiService) InsightIncomeCategory(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightIncomeCategoryOpts) ([]InsightGroupEntry, *http.Response, error)

func (*InsightApiService) InsightIncomeNoCategory ¶

func (a *InsightApiService) InsightIncomeNoCategory(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightIncomeNoCategoryOpts) ([]InsightTotalEntry, *http.Response, error)

func (*InsightApiService) InsightIncomeNoTag ¶

func (a *InsightApiService) InsightIncomeNoTag(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightIncomeNoTagOpts) ([]InsightTotalEntry, *http.Response, error)

func (*InsightApiService) InsightIncomeRevenue ¶

func (a *InsightApiService) InsightIncomeRevenue(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightIncomeRevenueOpts) ([]InsightGroupEntry, *http.Response, error)

func (*InsightApiService) InsightIncomeTag ¶

func (a *InsightApiService) InsightIncomeTag(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightIncomeTagOpts) ([]InsightGroupEntry, *http.Response, error)

func (*InsightApiService) InsightIncomeTotal ¶

func (a *InsightApiService) InsightIncomeTotal(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightIncomeTotalOpts) ([]InsightTotalEntry, *http.Response, error)

func (*InsightApiService) InsightTransferCategory ¶

func (a *InsightApiService) InsightTransferCategory(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightTransferCategoryOpts) ([]InsightGroupEntry, *http.Response, error)

func (*InsightApiService) InsightTransferNoCategory ¶

func (a *InsightApiService) InsightTransferNoCategory(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightTransferNoCategoryOpts) ([]InsightTotalEntry, *http.Response, error)

func (*InsightApiService) InsightTransferNoTag ¶

func (a *InsightApiService) InsightTransferNoTag(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightTransferNoTagOpts) ([]InsightTotalEntry, *http.Response, error)

func (*InsightApiService) InsightTransferTag ¶

func (a *InsightApiService) InsightTransferTag(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightTransferTagOpts) ([]InsightGroupEntry, *http.Response, error)

func (*InsightApiService) InsightTransferTotal ¶

func (a *InsightApiService) InsightTransferTotal(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightTransferTotalOpts) ([]InsightTotalEntry, *http.Response, error)

func (*InsightApiService) InsightTransfers ¶

func (a *InsightApiService) InsightTransfers(ctx context.Context, start string, end string, localVarOptionals *InsightApiInsightTransfersOpts) ([]InsightTransferEntry, *http.Response, error)

type InsightGroupEntry ¶

type InsightGroupEntry struct {
	// This ID is a reference to the original object.
	Id string `json:"id,omitempty"`
	// This is the name of the object.
	Name string `json:"name,omitempty"`
	// The amount spent or earned between start date and end date, a number defined as a string, for this object and all asset accounts.
	Difference string `json:"difference,omitempty"`
	// The amount spent or earned between start date and end date, a number as a float, for this object and all asset accounts. May have rounding errors.
	DifferenceFloat float64 `json:"difference_float,omitempty"`
	// The currency ID of the expenses listed for this account.
	CurrencyId string `json:"currency_id,omitempty"`
	// The currency code of the expenses listed for this account.
	CurrencyCode string `json:"currency_code,omitempty"`
}

type InsightTotalEntry ¶

type InsightTotalEntry struct {
	// The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts.
	Difference string `json:"difference,omitempty"`
	// The amount spent between start date and end date, defined as a string, for this expense account and all asset accounts. This number is a float (double) and may have rounding errors.
	DifferenceFloat float64 `json:"difference_float,omitempty"`
	// The currency ID of the expenses listed for this expense account.
	CurrencyId string `json:"currency_id,omitempty"`
	// The currency code of the expenses listed for this expense account.
	CurrencyCode string `json:"currency_code,omitempty"`
}

type InsightTransferEntry ¶

type InsightTransferEntry struct {
	// This ID is a reference to the original object.
	Id string `json:"id,omitempty"`
	// This is the name of the object.
	Name string `json:"name,omitempty"`
	// The total amount transferred between start date and end date, a number defined as a string, for this asset account.
	Difference string `json:"difference,omitempty"`
	// The total amount transferred between start date and end date, a number as a float, for this asset account. May have rounding errors.
	DifferenceFloat float64 `json:"difference_float,omitempty"`
	// The total amount transferred TO this account between start date and end date, a number defined as a string, for this asset account.
	In string `json:"in,omitempty"`
	// The total amount transferred FROM this account between start date and end date, a number as a float, for this asset account. May have rounding errors.
	InFloat float64 `json:"in_float,omitempty"`
	// The total amount transferred FROM this account between start date and end date, a number defined as a string, for this asset account.
	Out string `json:"out,omitempty"`
	// The total amount transferred TO this account between start date and end date, a number as a float, for this asset account. May have rounding errors.
	OutFloat float64 `json:"out_float,omitempty"`
	// The currency ID of the expenses listed for this account.
	CurrencyId string `json:"currency_id,omitempty"`
	// The currency code of the expenses listed for this account.
	CurrencyCode string `json:"currency_code,omitempty"`
}

type InterestPeriodProperty ¶

type InterestPeriodProperty string

InterestPeriodProperty : Mandatory when type is liability. Period over which the interest is calculated.

const (
	WEEKLY_InterestPeriodProperty    InterestPeriodProperty = "weekly"
	MONTHLY_InterestPeriodProperty   InterestPeriodProperty = "monthly"
	QUARTERLY_InterestPeriodProperty InterestPeriodProperty = "quarterly"
	HALF_YEAR_InterestPeriodProperty InterestPeriodProperty = "half-year"
	YEARLY_InterestPeriodProperty    InterestPeriodProperty = "yearly"
	NULL_InterestPeriodProperty      InterestPeriodProperty = ""
)

List of InterestPeriodProperty

type InternalExceptionResponse ¶

type InternalExceptionResponse struct {
	Message   string `json:"message,omitempty"`
	Exception string `json:"exception,omitempty"`
}

type LiabilityDirectionProperty ¶

type LiabilityDirectionProperty string

LiabilityDirectionProperty : 'credit' indicates somebody owes you the liability. 'debit' Indicates you owe this debt yourself. Works only for liabiltiies.

const (
	CREDIT_LiabilityDirectionProperty LiabilityDirectionProperty = "credit"
	DEBIT_LiabilityDirectionProperty  LiabilityDirectionProperty = "debit"
	NULL_LiabilityDirectionProperty   LiabilityDirectionProperty = ""
)

List of LiabilityDirectionProperty

type LiabilityTypeProperty ¶

type LiabilityTypeProperty string

LiabilityTypeProperty : Mandatory when type is liability. Specifies the exact type.

const (
	LOAN_LiabilityTypeProperty     LiabilityTypeProperty = "loan"
	DEBT_LiabilityTypeProperty     LiabilityTypeProperty = "debt"
	MORTGAGE_LiabilityTypeProperty LiabilityTypeProperty = "mortgage"
	NULL_LiabilityTypeProperty     LiabilityTypeProperty = ""
)

List of LiabilityTypeProperty

type LinkType ¶

type LinkType struct {
	Name     string `json:"name"`
	Inward   string `json:"inward"`
	Outward  string `json:"outward"`
	Editable bool   `json:"editable,omitempty"`
}

type LinkTypeArray ¶

type LinkTypeArray struct {
	Data  []LinkTypeRead `json:"data"`
	Meta  *Meta          `json:"meta"`
	Links *PageLink      `json:"links"`
}

type LinkTypeRead ¶

type LinkTypeRead struct {
	// Immutable value
	Type_      string      `json:"type"`
	Id         string      `json:"id"`
	Attributes *LinkType   `json:"attributes"`
	Links      *ObjectLink `json:"links"`
}

type LinkTypeSingle ¶

type LinkTypeSingle struct {
	Data *LinkTypeRead `json:"data"`
}

type LinkTypeUpdate ¶

type LinkTypeUpdate struct {
	Name    string `json:"name,omitempty"`
	Inward  string `json:"inward,omitempty"`
	Outward string `json:"outward,omitempty"`
}

type LinksApiDeleteLinkTypeOpts ¶

type LinksApiDeleteLinkTypeOpts struct {
	XTraceId optional.Interface
}

type LinksApiDeleteTransactionLinkOpts ¶

type LinksApiDeleteTransactionLinkOpts struct {
	XTraceId optional.Interface
}

type LinksApiGetLinkTypeOpts ¶

type LinksApiGetLinkTypeOpts struct {
	XTraceId optional.Interface
}

type LinksApiGetTransactionLinkOpts ¶

type LinksApiGetTransactionLinkOpts struct {
	XTraceId optional.Interface
}

type LinksApiListLinkTypeOpts ¶

type LinksApiListLinkTypeOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type LinksApiListTransactionByLinkTypeOpts ¶

type LinksApiListTransactionByLinkTypeOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
	Start    optional.String
	End      optional.String
	Type_    optional.Interface
}

type LinksApiListTransactionLinkOpts ¶

type LinksApiListTransactionLinkOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type LinksApiService ¶

type LinksApiService service

func (*LinksApiService) DeleteLinkType ¶

func (a *LinksApiService) DeleteLinkType(ctx context.Context, id string, localVarOptionals *LinksApiDeleteLinkTypeOpts) (*http.Response, error)

func (*LinksApiService) DeleteTransactionLink ¶

func (a *LinksApiService) DeleteTransactionLink(ctx context.Context, id string, localVarOptionals *LinksApiDeleteTransactionLinkOpts) (*http.Response, error)

func (*LinksApiService) GetLinkType ¶

func (a *LinksApiService) GetLinkType(ctx context.Context, id string, localVarOptionals *LinksApiGetLinkTypeOpts) (LinkTypeSingle, *http.Response, error)

func (*LinksApiService) GetTransactionLink ¶

func (a *LinksApiService) GetTransactionLink(ctx context.Context, id string, localVarOptionals *LinksApiGetTransactionLinkOpts) (TransactionLinkSingle, *http.Response, error)

func (*LinksApiService) ListLinkType ¶

func (a *LinksApiService) ListLinkType(ctx context.Context, localVarOptionals *LinksApiListLinkTypeOpts) (LinkTypeArray, *http.Response, error)

func (*LinksApiService) ListTransactionByLinkType ¶

func (a *LinksApiService) ListTransactionByLinkType(ctx context.Context, id string, localVarOptionals *LinksApiListTransactionByLinkTypeOpts) (TransactionArray, *http.Response, error)

func (*LinksApiService) ListTransactionLink ¶

func (a *LinksApiService) ListTransactionLink(ctx context.Context, localVarOptionals *LinksApiListTransactionLinkOpts) (TransactionLinkArray, *http.Response, error)

func (*LinksApiService) StoreLinkType ¶

func (a *LinksApiService) StoreLinkType(ctx context.Context, body LinkType, localVarOptionals *LinksApiStoreLinkTypeOpts) (LinkTypeSingle, *http.Response, error)

func (*LinksApiService) StoreTransactionLink ¶

func (a *LinksApiService) StoreTransactionLink(ctx context.Context, body TransactionLinkStore, localVarOptionals *LinksApiStoreTransactionLinkOpts) (TransactionLinkSingle, *http.Response, error)

func (*LinksApiService) UpdateLinkType ¶

func (a *LinksApiService) UpdateLinkType(ctx context.Context, body LinkTypeUpdate, id string, localVarOptionals *LinksApiUpdateLinkTypeOpts) (LinkTypeSingle, *http.Response, error)

func (*LinksApiService) UpdateTransactionLink ¶

func (a *LinksApiService) UpdateTransactionLink(ctx context.Context, body TransactionLinkUpdate, id string, localVarOptionals *LinksApiUpdateTransactionLinkOpts) (TransactionLinkSingle, *http.Response, error)

type LinksApiStoreLinkTypeOpts ¶

type LinksApiStoreLinkTypeOpts struct {
	XTraceId optional.Interface
}

type LinksApiStoreTransactionLinkOpts ¶

type LinksApiStoreTransactionLinkOpts struct {
	XTraceId optional.Interface
}

type LinksApiUpdateLinkTypeOpts ¶

type LinksApiUpdateLinkTypeOpts struct {
	XTraceId optional.Interface
}

type LinksApiUpdateTransactionLinkOpts ¶

type LinksApiUpdateTransactionLinkOpts struct {
	XTraceId optional.Interface
}

type Meta ¶

type Meta struct {
	Pagination *MetaPagination `json:"pagination,omitempty"`
}

type MetaPagination ¶

type MetaPagination struct {
	Total       int32 `json:"total,omitempty"`
	Count       int32 `json:"count,omitempty"`
	PerPage     int32 `json:"per_page,omitempty"`
	CurrentPage int32 `json:"current_page,omitempty"`
	TotalPages  int32 `json:"total_pages,omitempty"`
}

type NotFoundResponse ¶

type NotFoundResponse struct {
	Message   string `json:"message,omitempty"`
	Exception string `json:"exception,omitempty"`
}

type ObjectGroup ¶

type ObjectGroup struct {
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	Title     string    `json:"title"`
	// Order of the object group
	Order int32 `json:"order"`
}

type ObjectGroupArray ¶

type ObjectGroupArray struct {
	Data []ObjectGroupRead `json:"data"`
	Meta *Meta             `json:"meta"`
}

type ObjectGroupRead ¶

type ObjectGroupRead struct {
	// Immutable value
	Type_      string       `json:"type"`
	Id         string       `json:"id"`
	Attributes *ObjectGroup `json:"attributes"`
}

type ObjectGroupSingle ¶

type ObjectGroupSingle struct {
	Data *ObjectGroupRead `json:"data"`
}

type ObjectGroupUpdate ¶

type ObjectGroupUpdate struct {
	Title string `json:"title"`
	// Order of the object group
	Order int32 `json:"order,omitempty"`
}

type ObjectGroupsApiDeleteObjectGroupOpts ¶

type ObjectGroupsApiDeleteObjectGroupOpts struct {
	XTraceId optional.Interface
}

type ObjectGroupsApiGetObjectGroupOpts ¶

type ObjectGroupsApiGetObjectGroupOpts struct {
	XTraceId optional.Interface
}

type ObjectGroupsApiListBillByObjectGroupOpts ¶

type ObjectGroupsApiListBillByObjectGroupOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type ObjectGroupsApiListObjectGroupsOpts ¶

type ObjectGroupsApiListObjectGroupsOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type ObjectGroupsApiListPiggyBankByObjectGroupOpts ¶

type ObjectGroupsApiListPiggyBankByObjectGroupOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type ObjectGroupsApiService ¶

type ObjectGroupsApiService service

func (*ObjectGroupsApiService) DeleteObjectGroup ¶

func (a *ObjectGroupsApiService) DeleteObjectGroup(ctx context.Context, id string, localVarOptionals *ObjectGroupsApiDeleteObjectGroupOpts) (*http.Response, error)

func (*ObjectGroupsApiService) GetObjectGroup ¶

func (a *ObjectGroupsApiService) GetObjectGroup(ctx context.Context, id string, localVarOptionals *ObjectGroupsApiGetObjectGroupOpts) (ObjectGroupSingle, *http.Response, error)

func (*ObjectGroupsApiService) ListBillByObjectGroup ¶

func (a *ObjectGroupsApiService) ListBillByObjectGroup(ctx context.Context, id string, localVarOptionals *ObjectGroupsApiListBillByObjectGroupOpts) (BillArray, *http.Response, error)

func (*ObjectGroupsApiService) ListObjectGroups ¶

func (a *ObjectGroupsApiService) ListObjectGroups(ctx context.Context, localVarOptionals *ObjectGroupsApiListObjectGroupsOpts) (ObjectGroupArray, *http.Response, error)

func (*ObjectGroupsApiService) ListPiggyBankByObjectGroup ¶

func (a *ObjectGroupsApiService) ListPiggyBankByObjectGroup(ctx context.Context, id string, localVarOptionals *ObjectGroupsApiListPiggyBankByObjectGroupOpts) (PiggyBankArray, *http.Response, error)

func (*ObjectGroupsApiService) UpdateObjectGroup ¶

func (a *ObjectGroupsApiService) UpdateObjectGroup(ctx context.Context, body ObjectGroupUpdate, id string, localVarOptionals *ObjectGroupsApiUpdateObjectGroupOpts) (ObjectGroupSingle, *http.Response, error)

type ObjectGroupsApiUpdateObjectGroupOpts ¶

type ObjectGroupsApiUpdateObjectGroupOpts struct {
	XTraceId optional.Interface
}

type ObjectLink ¶

type ObjectLink struct {
	Var0 *ObjectLink0 `json:"0,omitempty"`
	Self string       `json:"self,omitempty"`
}

type ObjectLink0 ¶

type ObjectLink0 struct {
	Rel string `json:"rel,omitempty"`
	Uri string `json:"uri,omitempty"`
}

type PageLink ¶

type PageLink struct {
	Self  string `json:"self,omitempty"`
	First string `json:"first,omitempty"`
	Next  string `json:"next,omitempty"`
	Prev  string `json:"prev,omitempty"`
	Last  string `json:"last,omitempty"`
}

type PiggyBank ¶

type PiggyBank struct {
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// The ID of the asset account this piggy bank is connected to.
	AccountId string `json:"account_id"`
	// The name of the asset account this piggy bank is connected to.
	AccountName    string `json:"account_name,omitempty"`
	Name           string `json:"name"`
	CurrencyId     string `json:"currency_id,omitempty"`
	CurrencyCode   string `json:"currency_code,omitempty"`
	CurrencySymbol string `json:"currency_symbol,omitempty"`
	// Number of decimals supported by the currency
	CurrencyDecimalPlaces int32   `json:"currency_decimal_places,omitempty"`
	TargetAmount          string  `json:"target_amount"`
	Percentage            float32 `json:"percentage,omitempty"`
	CurrentAmount         string  `json:"current_amount,omitempty"`
	LeftToSave            string  `json:"left_to_save,omitempty"`
	SavePerMonth          string  `json:"save_per_month,omitempty"`
	// The date you started with this piggy bank.
	StartDate string `json:"start_date,omitempty"`
	// The date you intend to finish saving money.
	TargetDate string `json:"target_date,omitempty"`
	Order      int32  `json:"order,omitempty"`
	Active     bool   `json:"active,omitempty"`
	Notes      string `json:"notes,omitempty"`
	// The group ID of the group this object is part of. NULL if no group.
	ObjectGroupId string `json:"object_group_id,omitempty"`
	// The order of the group. At least 1, for the highest sorting.
	ObjectGroupOrder int32 `json:"object_group_order,omitempty"`
	// The name of the group. NULL if no group.
	ObjectGroupTitle string `json:"object_group_title,omitempty"`
}

type PiggyBankArray ¶

type PiggyBankArray struct {
	Data  []PiggyBankRead `json:"data"`
	Meta  *Meta           `json:"meta"`
	Links *PageLink       `json:"links"`
}

type PiggyBankEvent ¶

type PiggyBankEvent struct {
	CreatedAt             time.Time `json:"created_at,omitempty"`
	UpdatedAt             time.Time `json:"updated_at,omitempty"`
	CurrencyId            string    `json:"currency_id,omitempty"`
	CurrencyCode          string    `json:"currency_code,omitempty"`
	CurrencySymbol        string    `json:"currency_symbol,omitempty"`
	CurrencyDecimalPlaces int32     `json:"currency_decimal_places,omitempty"`
	Amount                string    `json:"amount,omitempty"`
	// The journal associated with the event.
	TransactionJournalId string `json:"transaction_journal_id,omitempty"`
	// The transaction group associated with the event.
	TransactionGroupId string `json:"transaction_group_id,omitempty"`
}

type PiggyBankEventArray ¶

type PiggyBankEventArray struct {
	Data  []PiggyBankEventRead `json:"data"`
	Meta  *Meta                `json:"meta"`
	Links *PageLink            `json:"links"`
}

type PiggyBankEventRead ¶

type PiggyBankEventRead struct {
	// Immutable value
	Type_      string          `json:"type"`
	Id         string          `json:"id"`
	Attributes *PiggyBankEvent `json:"attributes"`
	Links      *ObjectLink     `json:"links"`
}

type PiggyBankRead ¶

type PiggyBankRead struct {
	// Immutable value
	Type_      string      `json:"type"`
	Id         string      `json:"id"`
	Attributes *PiggyBank  `json:"attributes"`
	Links      *ObjectLink `json:"links"`
}

type PiggyBankSingle ¶

type PiggyBankSingle struct {
	Data *PiggyBankRead `json:"data"`
}

type PiggyBankStore ¶

type PiggyBankStore struct {
	Name string `json:"name"`
	// The ID of the asset account this piggy bank is connected to.
	AccountId     string `json:"account_id"`
	TargetAmount  string `json:"target_amount"`
	CurrentAmount string `json:"current_amount,omitempty"`
	// The date you started with this piggy bank.
	StartDate string `json:"start_date,omitempty"`
	// The date you intend to finish saving money.
	TargetDate string `json:"target_date,omitempty"`
	Order      int32  `json:"order,omitempty"`
	Active     bool   `json:"active,omitempty"`
	Notes      string `json:"notes,omitempty"`
	// The group ID of the group this object is part of. NULL if no group.
	ObjectGroupId string `json:"object_group_id,omitempty"`
	// The name of the group. NULL if no group.
	ObjectGroupTitle string `json:"object_group_title,omitempty"`
}

type PiggyBankUpdate ¶

type PiggyBankUpdate struct {
	Name string `json:"name,omitempty"`
	// The ID of the asset account this piggy bank is connected to.
	AccountId     string `json:"account_id,omitempty"`
	CurrencyId    string `json:"currency_id,omitempty"`
	CurrencyCode  string `json:"currency_code,omitempty"`
	TargetAmount  string `json:"target_amount,omitempty"`
	CurrentAmount string `json:"current_amount,omitempty"`
	// The date you started with this piggy bank.
	StartDate string `json:"start_date,omitempty"`
	// The date you intend to finish saving money.
	TargetDate string `json:"target_date,omitempty"`
	Order      int32  `json:"order,omitempty"`
	Active     bool   `json:"active,omitempty"`
	Notes      string `json:"notes,omitempty"`
	// The group ID of the group this object is part of. NULL if no group.
	ObjectGroupId string `json:"object_group_id,omitempty"`
	// The name of the group. NULL if no group.
	ObjectGroupTitle string `json:"object_group_title,omitempty"`
}

type PiggyBanksApiDeletePiggyBankOpts ¶

type PiggyBanksApiDeletePiggyBankOpts struct {
	XTraceId optional.Interface
}

type PiggyBanksApiGetPiggyBankOpts ¶

type PiggyBanksApiGetPiggyBankOpts struct {
	XTraceId optional.Interface
}

type PiggyBanksApiListAttachmentByPiggyBankOpts ¶

type PiggyBanksApiListAttachmentByPiggyBankOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type PiggyBanksApiListEventByPiggyBankOpts ¶

type PiggyBanksApiListEventByPiggyBankOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type PiggyBanksApiListPiggyBankOpts ¶

type PiggyBanksApiListPiggyBankOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type PiggyBanksApiService ¶

type PiggyBanksApiService service

func (*PiggyBanksApiService) DeletePiggyBank ¶

func (a *PiggyBanksApiService) DeletePiggyBank(ctx context.Context, id string, localVarOptionals *PiggyBanksApiDeletePiggyBankOpts) (*http.Response, error)

func (*PiggyBanksApiService) GetPiggyBank ¶

func (a *PiggyBanksApiService) GetPiggyBank(ctx context.Context, id string, localVarOptionals *PiggyBanksApiGetPiggyBankOpts) (PiggyBankSingle, *http.Response, error)

func (*PiggyBanksApiService) ListAttachmentByPiggyBank ¶

func (a *PiggyBanksApiService) ListAttachmentByPiggyBank(ctx context.Context, id string, localVarOptionals *PiggyBanksApiListAttachmentByPiggyBankOpts) (AttachmentArray, *http.Response, error)

func (*PiggyBanksApiService) ListEventByPiggyBank ¶

func (a *PiggyBanksApiService) ListEventByPiggyBank(ctx context.Context, id string, localVarOptionals *PiggyBanksApiListEventByPiggyBankOpts) (PiggyBankEventArray, *http.Response, error)

func (*PiggyBanksApiService) ListPiggyBank ¶

func (a *PiggyBanksApiService) ListPiggyBank(ctx context.Context, localVarOptionals *PiggyBanksApiListPiggyBankOpts) (PiggyBankArray, *http.Response, error)

func (*PiggyBanksApiService) StorePiggyBank ¶

func (a *PiggyBanksApiService) StorePiggyBank(ctx context.Context, body PiggyBankStore, localVarOptionals *PiggyBanksApiStorePiggyBankOpts) (PiggyBankSingle, *http.Response, error)

func (*PiggyBanksApiService) UpdatePiggyBank ¶

func (a *PiggyBanksApiService) UpdatePiggyBank(ctx context.Context, body PiggyBankUpdate, id string, localVarOptionals *PiggyBanksApiUpdatePiggyBankOpts) (PiggyBankSingle, *http.Response, error)

type PiggyBanksApiStorePiggyBankOpts ¶

type PiggyBanksApiStorePiggyBankOpts struct {
	XTraceId optional.Interface
}

type PiggyBanksApiUpdatePiggyBankOpts ¶

type PiggyBanksApiUpdatePiggyBankOpts struct {
	XTraceId optional.Interface
}

type PolymorphicProperty ¶

type PolymorphicProperty struct {
}

type Preference ¶

type Preference struct {
	CreatedAt time.Time            `json:"created_at,omitempty"`
	UpdatedAt time.Time            `json:"updated_at,omitempty"`
	Name      string               `json:"name"`
	Data      *PolymorphicProperty `json:"data"`
}

type PreferenceArray ¶

type PreferenceArray struct {
	Data  []PreferenceRead `json:"data"`
	Meta  *Meta            `json:"meta"`
	Links *PageLink        `json:"links"`
}

type PreferenceRead ¶

type PreferenceRead struct {
	// Immutable value
	Type_      string      `json:"type"`
	Id         string      `json:"id"`
	Attributes *Preference `json:"attributes"`
}

type PreferenceSingle ¶

type PreferenceSingle struct {
	Data *PreferenceRead `json:"data"`
}

type PreferenceUpdate ¶

type PreferenceUpdate struct {
	Data *PolymorphicProperty `json:"data"`
}

type PreferencesApiGetPreferenceOpts ¶

type PreferencesApiGetPreferenceOpts struct {
	XTraceId optional.Interface
}

type PreferencesApiListPreferenceOpts ¶

type PreferencesApiListPreferenceOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type PreferencesApiService ¶

type PreferencesApiService service

func (*PreferencesApiService) GetPreference ¶

func (a *PreferencesApiService) GetPreference(ctx context.Context, name string, localVarOptionals *PreferencesApiGetPreferenceOpts) (PreferenceSingle, *http.Response, error)

func (*PreferencesApiService) ListPreference ¶

func (a *PreferencesApiService) ListPreference(ctx context.Context, localVarOptionals *PreferencesApiListPreferenceOpts) (PreferenceArray, *http.Response, error)

func (*PreferencesApiService) StorePreference ¶

func (a *PreferencesApiService) StorePreference(ctx context.Context, body Preference, localVarOptionals *PreferencesApiStorePreferenceOpts) (PreferenceSingle, *http.Response, error)

func (*PreferencesApiService) UpdatePreference ¶

func (a *PreferencesApiService) UpdatePreference(ctx context.Context, body PreferenceUpdate, name string, localVarOptionals *PreferencesApiUpdatePreferenceOpts) (PreferenceSingle, *http.Response, error)

type PreferencesApiStorePreferenceOpts ¶

type PreferencesApiStorePreferenceOpts struct {
	XTraceId optional.Interface
}

type PreferencesApiUpdatePreferenceOpts ¶

type PreferencesApiUpdatePreferenceOpts struct {
	XTraceId optional.Interface
}

type Recurrence ¶

type Recurrence struct {
	CreatedAt time.Time                  `json:"created_at,omitempty"`
	UpdatedAt time.Time                  `json:"updated_at,omitempty"`
	Type_     *RecurrenceTransactionType `json:"type,omitempty"`
	Title     string                     `json:"title,omitempty"`
	// Not to be confused with the description of the actual transaction(s) being created.
	Description string `json:"description,omitempty"`
	// First time the recurring transaction will fire. Must be after today.
	FirstDate string `json:"first_date,omitempty"`
	// Last time the recurring transaction has fired.
	LatestDate string `json:"latest_date,omitempty"`
	// Date until the recurring transaction can fire. Use either this field or repetitions.
	RepeatUntil string `json:"repeat_until,omitempty"`
	// Max number of created transactions. Use either this field or repeat_until.
	NrOfRepetitions int32 `json:"nr_of_repetitions,omitempty"`
	// Whether or not to fire the rules after the creation of a transaction.
	ApplyRules bool `json:"apply_rules,omitempty"`
	// If the recurrence is even active.
	Active       bool                    `json:"active,omitempty"`
	Notes        string                  `json:"notes,omitempty"`
	Repetitions  []RecurrenceRepetition  `json:"repetitions,omitempty"`
	Transactions []RecurrenceTransaction `json:"transactions,omitempty"`
}

type RecurrenceArray ¶

type RecurrenceArray struct {
	Data  []RecurrenceRead `json:"data"`
	Meta  *Meta            `json:"meta"`
	Links *PageLink        `json:"links"`
}

type RecurrenceRead ¶

type RecurrenceRead struct {
	// Immutable value
	Type_      string      `json:"type"`
	Id         string      `json:"id"`
	Attributes *Recurrence `json:"attributes"`
	Links      *ObjectLink `json:"links"`
}

type RecurrenceRepetition ¶

type RecurrenceRepetition struct {
	Id        string                    `json:"id,omitempty"`
	CreatedAt time.Time                 `json:"created_at,omitempty"`
	UpdatedAt time.Time                 `json:"updated_at,omitempty"`
	Type_     *RecurrenceRepetitionType `json:"type"`
	// Information that defined the type of repetition. - For 'daily', this is empty. - For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday). - For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month - For 'monthly' it is the day of the month (1 - 31) - For yearly, it is a full date, ie '2018-09-17'. The year you use does not matter.
	Moment string `json:"moment"`
	// How many occurrences to skip. 0 means skip nothing. 1 means every other.
	Skip int32 `json:"skip,omitempty"`
	// How to respond when the recurring transaction falls in the weekend. Possible values: 1. Do nothing, just create it 2. Create no transaction. 3. Skip to the previous Friday. 4. Skip to the next Monday.
	Weekend int32 `json:"weekend,omitempty"`
	// Auto-generated repetition description.
	Description string `json:"description,omitempty"`
	// Array of future dates when the repetition will apply to. Auto generated.
	Occurrences []time.Time `json:"occurrences,omitempty"`
}

type RecurrenceRepetitionStore ¶

type RecurrenceRepetitionStore struct {
	Type_ *RecurrenceRepetitionType `json:"type"`
	// Information that defined the type of repetition. - For 'daily', this is empty. - For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday). - For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month - For 'monthly' it is the day of the month (1 - 31) - For yearly, it is a full date, ie '2018-09-17'. The year you use does not matter.
	Moment string `json:"moment"`
	// How many occurrences to skip. 0 means skip nothing. 1 means every other.
	Skip int32 `json:"skip,omitempty"`
	// How to respond when the recurring transaction falls in the weekend. Possible values: 1. Do nothing, just create it 2. Create no transaction. 3. Skip to the previous Friday. 4. Skip to the next Monday.
	Weekend int32 `json:"weekend,omitempty"`
}

type RecurrenceRepetitionType ¶

type RecurrenceRepetitionType string

RecurrenceRepetitionType : The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week.

const (
	DAILY_RecurrenceRepetitionType   RecurrenceRepetitionType = "daily"
	WEEKLY_RecurrenceRepetitionType  RecurrenceRepetitionType = "weekly"
	NDOM_RecurrenceRepetitionType    RecurrenceRepetitionType = "ndom"
	MONTHLY_RecurrenceRepetitionType RecurrenceRepetitionType = "monthly"
	YEARLY_RecurrenceRepetitionType  RecurrenceRepetitionType = "yearly"
)

List of RecurrenceRepetitionType

type RecurrenceRepetitionUpdate ¶

type RecurrenceRepetitionUpdate struct {
	Type_ *RecurrenceRepetitionType `json:"type,omitempty"`
	// Information that defined the type of repetition. - For 'daily', this is empty. - For 'weekly', it is day of the week between 1 and 7 (Monday - Sunday). - For 'ndom', it is '1,2' or '4,5' or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). '2,3' means: the 2nd Wednesday of the month - For 'monthly' it is the day of the month (1 - 31) - For yearly, it is a full date, ie '2018-09-17'. The year you use does not matter.
	Moment string `json:"moment,omitempty"`
	// How many occurrences to skip. 0 means skip nothing. 1 means every other.
	Skip int32 `json:"skip,omitempty"`
	// How to respond when the recurring transaction falls in the weekend. Possible values: 1. Do nothing, just create it 2. Create no transaction. 3. Skip to the previous Friday. 4. Skip to the next Monday.
	Weekend int32 `json:"weekend,omitempty"`
}

type RecurrenceSingle ¶

type RecurrenceSingle struct {
	Data *RecurrenceRead `json:"data"`
}

type RecurrenceStore ¶

type RecurrenceStore struct {
	Type_ *RecurrenceTransactionType `json:"type"`
	Title string                     `json:"title"`
	// Not to be confused with the description of the actual transaction(s) being created.
	Description string `json:"description,omitempty"`
	// First time the recurring transaction will fire. Must be after today.
	FirstDate string `json:"first_date"`
	// Date until the recurring transaction can fire. Use either this field or repetitions.
	RepeatUntil string `json:"repeat_until"`
	// Max number of created transactions. Use either this field or repeat_until.
	NrOfRepetitions int32 `json:"nr_of_repetitions,omitempty"`
	// Whether or not to fire the rules after the creation of a transaction.
	ApplyRules bool `json:"apply_rules,omitempty"`
	// If the recurrence is even active.
	Active       bool                         `json:"active,omitempty"`
	Notes        string                       `json:"notes,omitempty"`
	Repetitions  []RecurrenceRepetitionStore  `json:"repetitions"`
	Transactions []RecurrenceTransactionStore `json:"transactions"`
}

type RecurrenceTransaction ¶

type RecurrenceTransaction struct {
	Id          string `json:"id,omitempty"`
	Description string `json:"description"`
	// Amount of the transaction.
	Amount string `json:"amount"`
	// Foreign amount of the transaction.
	ForeignAmount string `json:"foreign_amount,omitempty"`
	// Submit either a currency_id or a currency_code.
	CurrencyId string `json:"currency_id,omitempty"`
	// Submit either a currency_id or a currency_code.
	CurrencyCode   string `json:"currency_code,omitempty"`
	CurrencySymbol string `json:"currency_symbol,omitempty"`
	// Number of decimals in the currency
	CurrencyDecimalPlaces int32 `json:"currency_decimal_places,omitempty"`
	// Submit either a foreign_currency_id or a foreign_currency_code, or neither.
	ForeignCurrencyId string `json:"foreign_currency_id,omitempty"`
	// Submit either a foreign_currency_id or a foreign_currency_code, or neither.
	ForeignCurrencyCode   string `json:"foreign_currency_code,omitempty"`
	ForeignCurrencySymbol string `json:"foreign_currency_symbol,omitempty"`
	// Number of decimals in the currency
	ForeignCurrencyDecimalPlaces int32 `json:"foreign_currency_decimal_places,omitempty"`
	// The budget ID for this transaction.
	BudgetId string `json:"budget_id,omitempty"`
	// The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored.
	BudgetName string `json:"budget_name,omitempty"`
	// Category ID for this transaction.
	CategoryId string `json:"category_id,omitempty"`
	// Category name for this transaction.
	CategoryName string `json:"category_name,omitempty"`
	// ID of the source account. Submit either this or source_name.
	SourceId string `json:"source_id,omitempty"`
	// Name of the source account. Submit either this or source_id.
	SourceName string               `json:"source_name,omitempty"`
	SourceIban string               `json:"source_iban,omitempty"`
	SourceType *AccountTypeProperty `json:"source_type,omitempty"`
	// ID of the destination account. Submit either this or destination_name.
	DestinationId string `json:"destination_id,omitempty"`
	// Name of the destination account. Submit either this or destination_id.
	DestinationName string               `json:"destination_name,omitempty"`
	DestinationIban string               `json:"destination_iban,omitempty"`
	DestinationType *AccountTypeProperty `json:"destination_type,omitempty"`
	// Array of tags.
	Tags []string `json:"tags,omitempty"`
	// Optional. Use either this or the piggy_bank_name
	PiggyBankId string `json:"piggy_bank_id,omitempty"`
	// Optional. Use either this or the piggy_bank_id
	PiggyBankName string `json:"piggy_bank_name,omitempty"`
	// Optional. Use either this or the bill_name
	BillId string `json:"bill_id,omitempty"`
	// Optional. Use either this or the bill_id
	BillName string `json:"bill_name,omitempty"`
}

type RecurrenceTransactionStore ¶

type RecurrenceTransactionStore struct {
	Description string `json:"description"`
	// Amount of the transaction.
	Amount string `json:"amount"`
	// Foreign amount of the transaction.
	ForeignAmount string `json:"foreign_amount,omitempty"`
	// Submit either a currency_id or a currency_code.
	CurrencyId string `json:"currency_id,omitempty"`
	// Submit either a currency_id or a currency_code.
	CurrencyCode string `json:"currency_code,omitempty"`
	// Submit either a foreign_currency_id or a foreign_currency_code, or neither.
	ForeignCurrencyId string `json:"foreign_currency_id,omitempty"`
	// Submit either a foreign_currency_id or a foreign_currency_code, or neither.
	ForeignCurrencyCode string `json:"foreign_currency_code,omitempty"`
	// The budget ID for this transaction.
	BudgetId string `json:"budget_id,omitempty"`
	// Category ID for this transaction.
	CategoryId string `json:"category_id,omitempty"`
	// ID of the source account.
	SourceId string `json:"source_id"`
	// ID of the destination account.
	DestinationId string `json:"destination_id"`
	// Array of tags.
	Tags []string `json:"tags,omitempty"`
	// Optional.
	PiggyBankId string `json:"piggy_bank_id,omitempty"`
	// Optional.
	BillId string `json:"bill_id,omitempty"`
}

type RecurrenceTransactionType ¶

type RecurrenceTransactionType string

const (
	WITHDRAWAL_RecurrenceTransactionType RecurrenceTransactionType = "withdrawal"
	TRANSFER_RecurrenceTransactionType   RecurrenceTransactionType = "transfer"
	DEPOSIT_RecurrenceTransactionType    RecurrenceTransactionType = "deposit"
)

List of RecurrenceTransactionType

type RecurrenceTransactionUpdate ¶

type RecurrenceTransactionUpdate struct {
	Id          string `json:"id"`
	Description string `json:"description,omitempty"`
	// Amount of the transaction.
	Amount string `json:"amount,omitempty"`
	// Foreign amount of the transaction.
	ForeignAmount string `json:"foreign_amount,omitempty"`
	// Submit either a currency_id or a currency_code.
	CurrencyId string `json:"currency_id,omitempty"`
	// Submit either a currency_id or a currency_code.
	CurrencyCode string `json:"currency_code,omitempty"`
	// Submit either a foreign_currency_id or a foreign_currency_code, or neither.
	ForeignCurrencyId string `json:"foreign_currency_id,omitempty"`
	// The budget ID for this transaction.
	BudgetId string `json:"budget_id,omitempty"`
	// Category ID for this transaction.
	CategoryId string `json:"category_id,omitempty"`
	// ID of the source account. Submit either this or source_name.
	SourceId string `json:"source_id,omitempty"`
	// ID of the destination account. Submit either this or destination_name.
	DestinationId string `json:"destination_id,omitempty"`
	// Array of tags.
	Tags        []string `json:"tags,omitempty"`
	PiggyBankId string   `json:"piggy_bank_id,omitempty"`
	// Optional.
	BillId string `json:"bill_id,omitempty"`
}

type RecurrenceUpdate ¶

type RecurrenceUpdate struct {
	Title string `json:"title,omitempty"`
	// Not to be confused with the description of the actual transaction(s) being created.
	Description string `json:"description,omitempty"`
	// First time the recurring transaction will fire.
	FirstDate string `json:"first_date,omitempty"`
	// Date until the recurring transaction can fire. After that date, it's basically inactive. Use either this field or repetitions.
	RepeatUntil string `json:"repeat_until,omitempty"`
	// Max number of created transactions. Use either this field or repeat_until.
	NrOfRepetitions int32 `json:"nr_of_repetitions,omitempty"`
	// Whether or not to fire the rules after the creation of a transaction.
	ApplyRules bool `json:"apply_rules,omitempty"`
	// If the recurrence is even active.
	Active       bool                          `json:"active,omitempty"`
	Notes        string                        `json:"notes,omitempty"`
	Repetitions  []RecurrenceRepetitionUpdate  `json:"repetitions,omitempty"`
	Transactions []RecurrenceTransactionUpdate `json:"transactions,omitempty"`
}

type RecurrencesApiDeleteRecurrenceOpts ¶

type RecurrencesApiDeleteRecurrenceOpts struct {
	XTraceId optional.Interface
}

type RecurrencesApiGetRecurrenceOpts ¶

type RecurrencesApiGetRecurrenceOpts struct {
	XTraceId optional.Interface
}

type RecurrencesApiListRecurrenceOpts ¶

type RecurrencesApiListRecurrenceOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type RecurrencesApiListTransactionByRecurrenceOpts ¶

type RecurrencesApiListTransactionByRecurrenceOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
	Start    optional.String
	End      optional.String
	Type_    optional.Interface
}

type RecurrencesApiService ¶

type RecurrencesApiService service

func (*RecurrencesApiService) DeleteRecurrence ¶

func (a *RecurrencesApiService) DeleteRecurrence(ctx context.Context, id string, localVarOptionals *RecurrencesApiDeleteRecurrenceOpts) (*http.Response, error)

func (*RecurrencesApiService) GetRecurrence ¶

func (a *RecurrencesApiService) GetRecurrence(ctx context.Context, id string, localVarOptionals *RecurrencesApiGetRecurrenceOpts) (RecurrenceSingle, *http.Response, error)

func (*RecurrencesApiService) ListRecurrence ¶

func (a *RecurrencesApiService) ListRecurrence(ctx context.Context, localVarOptionals *RecurrencesApiListRecurrenceOpts) (RecurrenceArray, *http.Response, error)

func (*RecurrencesApiService) ListTransactionByRecurrence ¶

func (a *RecurrencesApiService) ListTransactionByRecurrence(ctx context.Context, id string, localVarOptionals *RecurrencesApiListTransactionByRecurrenceOpts) (TransactionArray, *http.Response, error)

func (*RecurrencesApiService) StoreRecurrence ¶

func (a *RecurrencesApiService) StoreRecurrence(ctx context.Context, body RecurrenceStore, localVarOptionals *RecurrencesApiStoreRecurrenceOpts) (RecurrenceSingle, *http.Response, error)

func (*RecurrencesApiService) UpdateRecurrence ¶

func (a *RecurrencesApiService) UpdateRecurrence(ctx context.Context, body RecurrenceUpdate, id string, localVarOptionals *RecurrencesApiUpdateRecurrenceOpts) (RecurrenceSingle, *http.Response, error)

type RecurrencesApiStoreRecurrenceOpts ¶

type RecurrencesApiStoreRecurrenceOpts struct {
	XTraceId optional.Interface
}

type RecurrencesApiUpdateRecurrenceOpts ¶

type RecurrencesApiUpdateRecurrenceOpts struct {
	XTraceId optional.Interface
}

type Rule ¶

type Rule struct {
	CreatedAt   time.Time `json:"created_at,omitempty"`
	UpdatedAt   time.Time `json:"updated_at,omitempty"`
	Title       string    `json:"title"`
	Description string    `json:"description,omitempty"`
	// ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory.
	RuleGroupId string `json:"rule_group_id"`
	// Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory.
	RuleGroupTitle string           `json:"rule_group_title,omitempty"`
	Order          int32            `json:"order,omitempty"`
	Trigger        *RuleTriggerType `json:"trigger"`
	// Whether or not the rule is even active. Default is true.
	Active bool `json:"active,omitempty"`
	// If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true.
	Strict bool `json:"strict,omitempty"`
	// If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false.
	StopProcessing bool          `json:"stop_processing,omitempty"`
	Triggers       []RuleTrigger `json:"triggers"`
	Actions        []RuleAction  `json:"actions"`
}

type RuleAction ¶

type RuleAction struct {
	Id        string             `json:"id,omitempty"`
	CreatedAt time.Time          `json:"created_at,omitempty"`
	UpdatedAt time.Time          `json:"updated_at,omitempty"`
	Type_     *RuleActionKeyword `json:"type"`
	// The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory.
	Value string `json:"value"`
	// Order of the action
	Order int32 `json:"order,omitempty"`
	// If the action is active. Defaults to true.
	Active bool `json:"active,omitempty"`
	// When true, other actions will not be fired after this action has fired. Defaults to false.
	StopProcessing bool `json:"stop_processing,omitempty"`
}

type RuleActionKeyword ¶

type RuleActionKeyword string

RuleActionKeyword : The type of thing this action will do. A limited set is possible.

const (
	USER_ACTION_RuleActionKeyword             RuleActionKeyword = "user_action"
	SET_CATEGORY_RuleActionKeyword            RuleActionKeyword = "set_category"
	CLEAR_CATEGORY_RuleActionKeyword          RuleActionKeyword = "clear_category"
	SET_BUDGET_RuleActionKeyword              RuleActionKeyword = "set_budget"
	CLEAR_BUDGET_RuleActionKeyword            RuleActionKeyword = "clear_budget"
	ADD_TAG_RuleActionKeyword                 RuleActionKeyword = "add_tag"
	REMOVE_TAG_RuleActionKeyword              RuleActionKeyword = "remove_tag"
	REMOVE_ALL_TAGS_RuleActionKeyword         RuleActionKeyword = "remove_all_tags"
	SET_DESCRIPTION_RuleActionKeyword         RuleActionKeyword = "set_description"
	APPEND_DESCRIPTION_RuleActionKeyword      RuleActionKeyword = "append_description"
	PREPEND_DESCRIPTION_RuleActionKeyword     RuleActionKeyword = "prepend_description"
	SET_SOURCE_ACCOUNT_RuleActionKeyword      RuleActionKeyword = "set_source_account"
	SET_DESTINATION_ACCOUNT_RuleActionKeyword RuleActionKeyword = "set_destination_account"
	SET_NOTES_RuleActionKeyword               RuleActionKeyword = "set_notes"
	APPEND_NOTES_RuleActionKeyword            RuleActionKeyword = "append_notes"
	PREPEND_NOTES_RuleActionKeyword           RuleActionKeyword = "prepend_notes"
	CLEAR_NOTES_RuleActionKeyword             RuleActionKeyword = "clear_notes"
	LINK_TO_BILL_RuleActionKeyword            RuleActionKeyword = "link_to_bill"
	CONVERT_WITHDRAWAL_RuleActionKeyword      RuleActionKeyword = "convert_withdrawal"
	CONVERT_DEPOSIT_RuleActionKeyword         RuleActionKeyword = "convert_deposit"
	CONVERT_TRANSFER_RuleActionKeyword        RuleActionKeyword = "convert_transfer"
	DELETE_TRANSACTION_RuleActionKeyword      RuleActionKeyword = "delete_transaction"
)

List of RuleActionKeyword

type RuleActionStore ¶

type RuleActionStore struct {
	Type_ *RuleActionKeyword `json:"type"`
	// The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory.
	Value string `json:"value"`
	// Order of the action
	Order int32 `json:"order,omitempty"`
	// If the action is active. Defaults to true.
	Active bool `json:"active,omitempty"`
	// When true, other actions will not be fired after this action has fired. Defaults to false.
	StopProcessing bool `json:"stop_processing,omitempty"`
}

type RuleActionUpdate ¶

type RuleActionUpdate struct {
	Type_ *RuleActionKeyword `json:"type,omitempty"`
	// The accompanying value the action will set, change or update. Can be empty, but for some types this value is mandatory.
	Value string `json:"value,omitempty"`
	// Order of the action
	Order int32 `json:"order,omitempty"`
	// If the action is active.
	Active bool `json:"active,omitempty"`
	// When true, other actions will not be fired after this action has fired.
	StopProcessing bool `json:"stop_processing,omitempty"`
}

type RuleArray ¶

type RuleArray struct {
	Data  []RuleRead `json:"data"`
	Meta  *Meta      `json:"meta"`
	Links *PageLink  `json:"links"`
}

type RuleGroup ¶

type RuleGroup struct {
	CreatedAt   time.Time `json:"created_at,omitempty"`
	UpdatedAt   time.Time `json:"updated_at,omitempty"`
	Title       string    `json:"title"`
	Description string    `json:"description,omitempty"`
	Order       int32     `json:"order,omitempty"`
	Active      bool      `json:"active,omitempty"`
}

type RuleGroupArray ¶

type RuleGroupArray struct {
	Data  []RuleGroupRead `json:"data"`
	Meta  *Meta           `json:"meta"`
	Links *PageLink       `json:"links"`
}

type RuleGroupRead ¶

type RuleGroupRead struct {
	// Immutable value
	Type_      string      `json:"type"`
	Id         string      `json:"id"`
	Attributes *RuleGroup  `json:"attributes"`
	Links      *ObjectLink `json:"links"`
}

type RuleGroupSingle ¶

type RuleGroupSingle struct {
	Data *RuleGroupRead `json:"data"`
}

type RuleGroupStore ¶

type RuleGroupStore struct {
	Title       string `json:"title"`
	Description string `json:"description,omitempty"`
	Order       int32  `json:"order,omitempty"`
	Active      bool   `json:"active,omitempty"`
}

type RuleGroupUpdate ¶

type RuleGroupUpdate struct {
	Title       string `json:"title,omitempty"`
	Description string `json:"description,omitempty"`
	Order       int32  `json:"order,omitempty"`
	Active      bool   `json:"active,omitempty"`
}

type RuleGroupsApiDeleteRuleGroupOpts ¶

type RuleGroupsApiDeleteRuleGroupOpts struct {
	XTraceId optional.Interface
}

type RuleGroupsApiFireRuleGroupOpts ¶

type RuleGroupsApiFireRuleGroupOpts struct {
	XTraceId optional.Interface
	Start    optional.String
	End      optional.String
	Accounts optional.Interface
}

type RuleGroupsApiGetRuleGroupOpts ¶

type RuleGroupsApiGetRuleGroupOpts struct {
	XTraceId optional.Interface
}

type RuleGroupsApiListRuleByGroupOpts ¶

type RuleGroupsApiListRuleByGroupOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type RuleGroupsApiListRuleGroupOpts ¶

type RuleGroupsApiListRuleGroupOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type RuleGroupsApiService ¶

type RuleGroupsApiService service

func (*RuleGroupsApiService) DeleteRuleGroup ¶

func (a *RuleGroupsApiService) DeleteRuleGroup(ctx context.Context, id string, localVarOptionals *RuleGroupsApiDeleteRuleGroupOpts) (*http.Response, error)

func (*RuleGroupsApiService) FireRuleGroup ¶

func (a *RuleGroupsApiService) FireRuleGroup(ctx context.Context, id string, localVarOptionals *RuleGroupsApiFireRuleGroupOpts) (*http.Response, error)

func (*RuleGroupsApiService) GetRuleGroup ¶

func (a *RuleGroupsApiService) GetRuleGroup(ctx context.Context, id string, localVarOptionals *RuleGroupsApiGetRuleGroupOpts) (RuleGroupSingle, *http.Response, error)

func (*RuleGroupsApiService) ListRuleByGroup ¶

func (a *RuleGroupsApiService) ListRuleByGroup(ctx context.Context, id string, localVarOptionals *RuleGroupsApiListRuleByGroupOpts) (RuleArray, *http.Response, error)

func (*RuleGroupsApiService) ListRuleGroup ¶

func (a *RuleGroupsApiService) ListRuleGroup(ctx context.Context, localVarOptionals *RuleGroupsApiListRuleGroupOpts) (RuleGroupArray, *http.Response, error)

func (*RuleGroupsApiService) StoreRuleGroup ¶

func (a *RuleGroupsApiService) StoreRuleGroup(ctx context.Context, body RuleGroupStore, localVarOptionals *RuleGroupsApiStoreRuleGroupOpts) (RuleGroupSingle, *http.Response, error)

func (*RuleGroupsApiService) TestRuleGroup ¶

func (a *RuleGroupsApiService) TestRuleGroup(ctx context.Context, id string, localVarOptionals *RuleGroupsApiTestRuleGroupOpts) (TransactionArray, *http.Response, error)

func (*RuleGroupsApiService) UpdateRuleGroup ¶

func (a *RuleGroupsApiService) UpdateRuleGroup(ctx context.Context, body RuleGroupUpdate, id string, localVarOptionals *RuleGroupsApiUpdateRuleGroupOpts) (RuleGroupSingle, *http.Response, error)

type RuleGroupsApiStoreRuleGroupOpts ¶

type RuleGroupsApiStoreRuleGroupOpts struct {
	XTraceId optional.Interface
}

type RuleGroupsApiTestRuleGroupOpts ¶

type RuleGroupsApiTestRuleGroupOpts struct {
	XTraceId       optional.Interface
	Limit          optional.Int32
	Page           optional.Int32
	Start          optional.String
	End            optional.String
	SearchLimit    optional.Int32
	TriggeredLimit optional.Int32
	Accounts       optional.Interface
}

type RuleGroupsApiUpdateRuleGroupOpts ¶

type RuleGroupsApiUpdateRuleGroupOpts struct {
	XTraceId optional.Interface
}

type RuleRead ¶

type RuleRead struct {
	// Immutable value
	Type_      string      `json:"type"`
	Id         string      `json:"id"`
	Attributes *Rule       `json:"attributes"`
	Links      *ObjectLink `json:"links"`
}

type RuleSingle ¶

type RuleSingle struct {
	Data *RuleRead `json:"data"`
}

type RuleStore ¶

type RuleStore struct {
	Title       string `json:"title"`
	Description string `json:"description,omitempty"`
	// ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory.
	RuleGroupId string `json:"rule_group_id"`
	// Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory.
	RuleGroupTitle string           `json:"rule_group_title,omitempty"`
	Order          int32            `json:"order,omitempty"`
	Trigger        *RuleTriggerType `json:"trigger"`
	// Whether or not the rule is even active. Default is true.
	Active bool `json:"active,omitempty"`
	// If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true.
	Strict bool `json:"strict,omitempty"`
	// If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false.
	StopProcessing bool               `json:"stop_processing,omitempty"`
	Triggers       []RuleTriggerStore `json:"triggers"`
	Actions        []RuleActionStore  `json:"actions"`
}

type RuleTrigger ¶

type RuleTrigger struct {
	Id        string              `json:"id,omitempty"`
	CreatedAt time.Time           `json:"created_at,omitempty"`
	UpdatedAt time.Time           `json:"updated_at,omitempty"`
	Type_     *RuleTriggerKeyword `json:"type"`
	// The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger.
	Value string `json:"value"`
	// If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc.
	Prohibited bool `json:"prohibited,omitempty"`
	// Order of the trigger
	Order int32 `json:"order,omitempty"`
	// If the trigger is active. Defaults to true.
	Active bool `json:"active,omitempty"`
	// When true, other triggers will not be checked if this trigger was triggered. Defaults to false.
	StopProcessing bool `json:"stop_processing,omitempty"`
}

type RuleTriggerKeyword ¶

type RuleTriggerKeyword string

RuleTriggerKeyword : The type of thing this trigger responds to. A limited set is possible

const (
	FROM_ACCOUNT_STARTS_RuleTriggerKeyword    RuleTriggerKeyword = "from_account_starts"
	FROM_ACCOUNT_ENDS_RuleTriggerKeyword      RuleTriggerKeyword = "from_account_ends"
	FROM_ACCOUNT_IS_RuleTriggerKeyword        RuleTriggerKeyword = "from_account_is"
	FROM_ACCOUNT_CONTAINS_RuleTriggerKeyword  RuleTriggerKeyword = "from_account_contains"
	TO_ACCOUNT_STARTS_RuleTriggerKeyword      RuleTriggerKeyword = "to_account_starts"
	TO_ACCOUNT_ENDS_RuleTriggerKeyword        RuleTriggerKeyword = "to_account_ends"
	TO_ACCOUNT_IS_RuleTriggerKeyword          RuleTriggerKeyword = "to_account_is"
	TO_ACCOUNT_CONTAINS_RuleTriggerKeyword    RuleTriggerKeyword = "to_account_contains"
	AMOUNT_LESS_RuleTriggerKeyword            RuleTriggerKeyword = "amount_less"
	AMOUNT_EXACTLY_RuleTriggerKeyword         RuleTriggerKeyword = "amount_exactly"
	AMOUNT_MORE_RuleTriggerKeyword            RuleTriggerKeyword = "amount_more"
	DESCRIPTION_STARTS_RuleTriggerKeyword     RuleTriggerKeyword = "description_starts"
	DESCRIPTION_ENDS_RuleTriggerKeyword       RuleTriggerKeyword = "description_ends"
	DESCRIPTION_CONTAINS_RuleTriggerKeyword   RuleTriggerKeyword = "description_contains"
	DESCRIPTION_IS_RuleTriggerKeyword         RuleTriggerKeyword = "description_is"
	TRANSACTION_TYPE_RuleTriggerKeyword       RuleTriggerKeyword = "transaction_type"
	CATEGORY_IS_RuleTriggerKeyword            RuleTriggerKeyword = "category_is"
	BUDGET_IS_RuleTriggerKeyword              RuleTriggerKeyword = "budget_is"
	TAG_IS_RuleTriggerKeyword                 RuleTriggerKeyword = "tag_is"
	CURRENCY_IS_RuleTriggerKeyword            RuleTriggerKeyword = "currency_is"
	HAS_ATTACHMENTS_RuleTriggerKeyword        RuleTriggerKeyword = "has_attachments"
	HAS_NO_CATEGORY_RuleTriggerKeyword        RuleTriggerKeyword = "has_no_category"
	HAS_ANY_CATEGORY_RuleTriggerKeyword       RuleTriggerKeyword = "has_any_category"
	HAS_NO_BUDGET_RuleTriggerKeyword          RuleTriggerKeyword = "has_no_budget"
	HAS_ANY_BUDGET_RuleTriggerKeyword         RuleTriggerKeyword = "has_any_budget"
	HAS_NO_TAG_RuleTriggerKeyword             RuleTriggerKeyword = "has_no_tag"
	HAS_ANY_TAG_RuleTriggerKeyword            RuleTriggerKeyword = "has_any_tag"
	NOTES_CONTAINS_RuleTriggerKeyword         RuleTriggerKeyword = "notes_contains"
	NOTES_START_RuleTriggerKeyword            RuleTriggerKeyword = "notes_start"
	NOTES_END_RuleTriggerKeyword              RuleTriggerKeyword = "notes_end"
	NOTES_ARE_RuleTriggerKeyword              RuleTriggerKeyword = "notes_are"
	NO_NOTES_RuleTriggerKeyword               RuleTriggerKeyword = "no_notes"
	ANY_NOTES_RuleTriggerKeyword              RuleTriggerKeyword = "any_notes"
	SOURCE_ACCOUNT_IS_RuleTriggerKeyword      RuleTriggerKeyword = "source_account_is"
	DESTINATION_ACCOUNT_IS_RuleTriggerKeyword RuleTriggerKeyword = "destination_account_is"
	SOURCE_ACCOUNT_STARTS_RuleTriggerKeyword  RuleTriggerKeyword = "source_account_starts"
)

List of RuleTriggerKeyword

type RuleTriggerStore ¶

type RuleTriggerStore struct {
	Type_ *RuleTriggerKeyword `json:"type"`
	// The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger.
	Value string `json:"value"`
	// Order of the trigger
	Order int32 `json:"order,omitempty"`
	// If the trigger is active. Defaults to true.
	Active bool `json:"active,omitempty"`
	// If 'prohibited' is true, this rule trigger will be negated. 'Description is' will become 'Description is NOT' etc.
	Prohibited bool `json:"prohibited,omitempty"`
	// When true, other triggers will not be checked if this trigger was triggered. Defaults to false.
	StopProcessing bool `json:"stop_processing,omitempty"`
}

type RuleTriggerType ¶

type RuleTriggerType string

RuleTriggerType : Which action is necessary for the rule to fire? Use either store-journal or update-journal.

const (
	STORE_JOURNAL_RuleTriggerType  RuleTriggerType = "store-journal"
	UPDATE_JOURNAL_RuleTriggerType RuleTriggerType = "update-journal"
)

List of RuleTriggerType

type RuleTriggerUpdate ¶

type RuleTriggerUpdate struct {
	Type_ *RuleTriggerKeyword `json:"type,omitempty"`
	// The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger. If the rule trigger is something like 'has any tag', submit the string 'true'.
	Value string `json:"value,omitempty"`
	// Order of the trigger
	Order int32 `json:"order,omitempty"`
	// If the trigger is active.
	Active bool `json:"active,omitempty"`
	// When true, other triggers will not be checked if this trigger was triggered.
	StopProcessing bool `json:"stop_processing,omitempty"`
}

type RuleUpdate ¶

type RuleUpdate struct {
	Title       string `json:"title,omitempty"`
	Description string `json:"description,omitempty"`
	// ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory.
	RuleGroupId string           `json:"rule_group_id,omitempty"`
	Order       int32            `json:"order,omitempty"`
	Trigger     *RuleTriggerType `json:"trigger,omitempty"`
	// Whether or not the rule is even active. Default is true.
	Active bool `json:"active,omitempty"`
	// If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true.
	Strict bool `json:"strict,omitempty"`
	// If this value is true and the rule is triggered, other rules  after this one in the group will be skipped. Default value is false.
	StopProcessing bool                `json:"stop_processing,omitempty"`
	Triggers       []RuleTriggerUpdate `json:"triggers,omitempty"`
	Actions        []RuleActionUpdate  `json:"actions,omitempty"`
}

type RulesApiDeleteRuleOpts ¶

type RulesApiDeleteRuleOpts struct {
	XTraceId optional.Interface
}

type RulesApiFireRuleOpts ¶

type RulesApiFireRuleOpts struct {
	XTraceId optional.Interface
	Start    optional.String
	End      optional.String
	Accounts optional.Interface
}

type RulesApiGetRuleOpts ¶

type RulesApiGetRuleOpts struct {
	XTraceId optional.Interface
}

type RulesApiListRuleOpts ¶

type RulesApiListRuleOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type RulesApiService ¶

type RulesApiService service

func (*RulesApiService) DeleteRule ¶

func (a *RulesApiService) DeleteRule(ctx context.Context, id string, localVarOptionals *RulesApiDeleteRuleOpts) (*http.Response, error)

func (*RulesApiService) FireRule ¶

func (a *RulesApiService) FireRule(ctx context.Context, id string, localVarOptionals *RulesApiFireRuleOpts) (*http.Response, error)

func (*RulesApiService) GetRule ¶

func (a *RulesApiService) GetRule(ctx context.Context, id string, localVarOptionals *RulesApiGetRuleOpts) (RuleSingle, *http.Response, error)

func (*RulesApiService) ListRule ¶

func (a *RulesApiService) ListRule(ctx context.Context, localVarOptionals *RulesApiListRuleOpts) (RuleArray, *http.Response, error)

func (*RulesApiService) StoreRule ¶

func (a *RulesApiService) StoreRule(ctx context.Context, body RuleStore, localVarOptionals *RulesApiStoreRuleOpts) (RuleSingle, *http.Response, error)

func (*RulesApiService) TestRule ¶

func (a *RulesApiService) TestRule(ctx context.Context, id string, localVarOptionals *RulesApiTestRuleOpts) (TransactionArray, *http.Response, error)

func (*RulesApiService) UpdateRule ¶

func (a *RulesApiService) UpdateRule(ctx context.Context, body RuleUpdate, id string, localVarOptionals *RulesApiUpdateRuleOpts) (RuleSingle, *http.Response, error)

type RulesApiStoreRuleOpts ¶

type RulesApiStoreRuleOpts struct {
	XTraceId optional.Interface
}

type RulesApiTestRuleOpts ¶

type RulesApiTestRuleOpts struct {
	XTraceId optional.Interface
	Start    optional.String
	End      optional.String
	Accounts optional.Interface
}

type RulesApiUpdateRuleOpts ¶

type RulesApiUpdateRuleOpts struct {
	XTraceId optional.Interface
}

type SearchApiSearchAccountsOpts ¶

type SearchApiSearchAccountsOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
	Type_    optional.Interface
}

type SearchApiSearchTransactionsOpts ¶

type SearchApiSearchTransactionsOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type SearchApiService ¶

type SearchApiService service

func (*SearchApiService) SearchAccounts ¶

func (a *SearchApiService) SearchAccounts(ctx context.Context, query string, field AccountSearchFieldFilter, localVarOptionals *SearchApiSearchAccountsOpts) (AccountArray, *http.Response, error)

func (*SearchApiService) SearchTransactions ¶

func (a *SearchApiService) SearchTransactions(ctx context.Context, query string, localVarOptionals *SearchApiSearchTransactionsOpts) (TransactionArray, *http.Response, error)

type ShortAccountTypeProperty ¶

type ShortAccountTypeProperty string

ShortAccountTypeProperty : Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually.

const (
	ASSET_ShortAccountTypeProperty           ShortAccountTypeProperty = "asset"
	EXPENSE_ShortAccountTypeProperty         ShortAccountTypeProperty = "expense"
	IMPORT__ShortAccountTypeProperty         ShortAccountTypeProperty = "import"
	REVENUE_ShortAccountTypeProperty         ShortAccountTypeProperty = "revenue"
	CASH_ShortAccountTypeProperty            ShortAccountTypeProperty = "cash"
	LIABILITY_ShortAccountTypeProperty       ShortAccountTypeProperty = "liability"
	LIABILITIES_ShortAccountTypeProperty     ShortAccountTypeProperty = "liabilities"
	INITIAL_BALANCE_ShortAccountTypeProperty ShortAccountTypeProperty = "initial-balance"
	RECONCILIATION_ShortAccountTypeProperty  ShortAccountTypeProperty = "reconciliation"
)

List of ShortAccountTypeProperty

type SummaryApiGetBasicSummaryOpts ¶

type SummaryApiGetBasicSummaryOpts struct {
	XTraceId     optional.Interface
	CurrencyCode optional.String
}

type SummaryApiService ¶

type SummaryApiService service

func (*SummaryApiService) GetBasicSummary ¶

func (a *SummaryApiService) GetBasicSummary(ctx context.Context, start string, end string, localVarOptionals *SummaryApiGetBasicSummaryOpts) (map[string]BasicSummaryEntry, *http.Response, error)

type SystemInfo ¶

type SystemInfo struct {
	Data *SystemInfoData `json:"data,omitempty"`
}

type SystemInfoData ¶

type SystemInfoData struct {
	Version    string `json:"version,omitempty"`
	ApiVersion string `json:"api_version,omitempty"`
	PhpVersion string `json:"php_version,omitempty"`
	Os         string `json:"os,omitempty"`
	Driver     string `json:"driver,omitempty"`
}

type TagArray ¶

type TagArray struct {
	Data  []TagRead `json:"data"`
	Meta  *Meta     `json:"meta"`
	Links *PageLink `json:"links"`
}

type TagModel ¶

type TagModel struct {
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// The tag
	Tag string `json:"tag"`
	// The date to which the tag is applicable.
	Date        string `json:"date,omitempty"`
	Description string `json:"description,omitempty"`
	// Latitude of the tag's location, if applicable. Can be used to draw a map.
	Latitude float64 `json:"latitude,omitempty"`
	// Latitude of the tag's location, if applicable. Can be used to draw a map.
	Longitude float64 `json:"longitude,omitempty"`
	// Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels.
	ZoomLevel int32 `json:"zoom_level,omitempty"`
}

type TagModelStore ¶

type TagModelStore struct {
	// The tag
	Tag string `json:"tag"`
	// The date to which the tag is applicable.
	Date        string `json:"date,omitempty"`
	Description string `json:"description,omitempty"`
	// Latitude of the tag's location, if applicable. Can be used to draw a map.
	Latitude float64 `json:"latitude,omitempty"`
	// Latitude of the tag's location, if applicable. Can be used to draw a map.
	Longitude float64 `json:"longitude,omitempty"`
	// Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels.
	ZoomLevel int32 `json:"zoom_level,omitempty"`
}

type TagModelUpdate ¶

type TagModelUpdate struct {
	// The tag
	Tag string `json:"tag,omitempty"`
	// The date to which the tag is applicable.
	Date        string `json:"date,omitempty"`
	Description string `json:"description,omitempty"`
	// Latitude of the tag's location, if applicable. Can be used to draw a map.
	Latitude float64 `json:"latitude,omitempty"`
	// Latitude of the tag's location, if applicable. Can be used to draw a map.
	Longitude float64 `json:"longitude,omitempty"`
	// Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels.
	ZoomLevel int32 `json:"zoom_level,omitempty"`
}

type TagRead ¶

type TagRead struct {
	// Immutable value
	Type_      string      `json:"type"`
	Id         string      `json:"id"`
	Attributes *TagModel   `json:"attributes"`
	Links      *ObjectLink `json:"links"`
}

type TagSingle ¶

type TagSingle struct {
	Data *TagRead `json:"data"`
}

type TagsApiDeleteTagOpts ¶

type TagsApiDeleteTagOpts struct {
	XTraceId optional.Interface
}

type TagsApiGetTagOpts ¶

type TagsApiGetTagOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type TagsApiListAttachmentByTagOpts ¶

type TagsApiListAttachmentByTagOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type TagsApiListTagOpts ¶

type TagsApiListTagOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type TagsApiListTransactionByTagOpts ¶

type TagsApiListTransactionByTagOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
	Start    optional.String
	End      optional.String
	Type_    optional.Interface
}

type TagsApiService ¶

type TagsApiService service

func (*TagsApiService) DeleteTag ¶

func (a *TagsApiService) DeleteTag(ctx context.Context, tag string, localVarOptionals *TagsApiDeleteTagOpts) (*http.Response, error)

func (*TagsApiService) GetTag ¶

func (a *TagsApiService) GetTag(ctx context.Context, tag string, localVarOptionals *TagsApiGetTagOpts) (TagSingle, *http.Response, error)

func (*TagsApiService) ListAttachmentByTag ¶

func (a *TagsApiService) ListAttachmentByTag(ctx context.Context, tag string, localVarOptionals *TagsApiListAttachmentByTagOpts) (AttachmentArray, *http.Response, error)

func (a *TagsApiService) ListTag(ctx context.Context, localVarOptionals *TagsApiListTagOpts) (TagArray, *http.Response, error)

func (*TagsApiService) ListTransactionByTag ¶

func (a *TagsApiService) ListTransactionByTag(ctx context.Context, tag string, localVarOptionals *TagsApiListTransactionByTagOpts) (TransactionArray, *http.Response, error)

func (*TagsApiService) StoreTag ¶

func (a *TagsApiService) StoreTag(ctx context.Context, body TagModelStore, localVarOptionals *TagsApiStoreTagOpts) (TagSingle, *http.Response, error)

func (*TagsApiService) UpdateTag ¶

func (a *TagsApiService) UpdateTag(ctx context.Context, body TagModelUpdate, tag string, localVarOptionals *TagsApiUpdateTagOpts) (TagSingle, *http.Response, error)

type TagsApiStoreTagOpts ¶

type TagsApiStoreTagOpts struct {
	XTraceId optional.Interface
}

type TagsApiUpdateTagOpts ¶

type TagsApiUpdateTagOpts struct {
	XTraceId optional.Interface
}

type Transaction ¶

type Transaction struct {
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// User ID
	User string `json:"user,omitempty"`
	// Title of the transaction if it has been split in more than one piece. Empty otherwise.
	GroupTitle   string             `json:"group_title,omitempty"`
	Transactions []TransactionSplit `json:"transactions"`
}

type TransactionArray ¶

type TransactionArray struct {
	Data  []TransactionRead `json:"data"`
	Meta  *Meta             `json:"meta"`
	Links *PageLink         `json:"links"`
}

type TransactionLink ¶

type TransactionLink struct {
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// The link type ID to use. You can also use the link_type_name field.
	LinkTypeId string `json:"link_type_id"`
	// The link type name to use. You can also use the link_type_id field.
	LinkTypeName string `json:"link_type_name,omitempty"`
	// The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set.
	InwardId string `json:"inward_id"`
	// The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set.
	OutwardId string `json:"outward_id"`
	// Optional. Some notes.
	Notes string `json:"notes,omitempty"`
}

type TransactionLinkArray ¶

type TransactionLinkArray struct {
	Data  []TransactionLinkRead `json:"data"`
	Meta  *Meta                 `json:"meta"`
	Links *PageLink             `json:"links"`
}

type TransactionLinkRead ¶

type TransactionLinkRead struct {
	// Immutable value
	Type_      string           `json:"type"`
	Id         string           `json:"id"`
	Attributes *TransactionLink `json:"attributes"`
	Links      *ObjectLink      `json:"links"`
}

type TransactionLinkSingle ¶

type TransactionLinkSingle struct {
	Data *TransactionLinkRead `json:"data"`
}

type TransactionLinkStore ¶

type TransactionLinkStore struct {
	// The link type ID to use. You can also use the link_type_name field.
	LinkTypeId string `json:"link_type_id"`
	// The link type name to use. You can also use the link_type_id field.
	LinkTypeName string `json:"link_type_name,omitempty"`
	// The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set.
	InwardId string `json:"inward_id"`
	// The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set.
	OutwardId string `json:"outward_id"`
	// Optional. Some notes.
	Notes string `json:"notes,omitempty"`
}

type TransactionLinkUpdate ¶

type TransactionLinkUpdate struct {
	// The link type ID to use. Use this field OR use the link_type_name field.
	LinkTypeId string `json:"link_type_id,omitempty"`
	// The link type name to use. Use this field OR use the link_type_id field.
	LinkTypeName string `json:"link_type_name,omitempty"`
	// The inward transaction transaction_journal_id for the link. This becomes the 'is paid by' transaction of the set.
	InwardId string `json:"inward_id,omitempty"`
	// The outward transaction transaction_journal_id for the link. This becomes the 'pays for' transaction of the set.
	OutwardId string `json:"outward_id,omitempty"`
	// Optional. Some notes. If you submit an empty string the current notes will be removed
	Notes string `json:"notes,omitempty"`
}

type TransactionRead ¶

type TransactionRead struct {
	// Immutable value
	Type_      string       `json:"type"`
	Id         string       `json:"id"`
	Attributes *Transaction `json:"attributes"`
	Links      *ObjectLink  `json:"links"`
}

type TransactionSingle ¶

type TransactionSingle struct {
	Data *TransactionRead `json:"data"`
}

type TransactionSplit ¶

type TransactionSplit struct {
	// User ID
	User string `json:"user,omitempty"`
	// ID of the underlying transaction journal. Each transaction consists of a transaction group (see the top ID) and one or more journals making up the splits of the transaction.
	TransactionJournalId string                   `json:"transaction_journal_id,omitempty"`
	Type_                *TransactionTypeProperty `json:"type"`
	// Date of the transaction
	Date time.Time `json:"date"`
	// Order of this entry in the list of transactions.
	Order int32 `json:"order,omitempty"`
	// Currency ID. Default is the source account's currency, or the user's default currency. Can be used instead of currency_code.
	CurrencyId string `json:"currency_id,omitempty"`
	// Currency code. Default is the source account's currency, or the user's default currency. Can be used instead of currency_id.
	CurrencyCode   string `json:"currency_code,omitempty"`
	CurrencySymbol string `json:"currency_symbol,omitempty"`
	CurrencyName   string `json:"currency_name,omitempty"`
	// Number of decimals used in this currency.
	CurrencyDecimalPlaces int32 `json:"currency_decimal_places,omitempty"`
	// Currency ID of the foreign currency. Default is null. Is required when you submit a foreign amount.
	ForeignCurrencyId string `json:"foreign_currency_id,omitempty"`
	// Currency code of the foreign currency. Default is NULL. Can be used instead of the foreign_currency_id, but this or the ID is required when submitting a foreign amount.
	ForeignCurrencyCode   string `json:"foreign_currency_code,omitempty"`
	ForeignCurrencySymbol string `json:"foreign_currency_symbol,omitempty"`
	// Number of decimals in the currency
	ForeignCurrencyDecimalPlaces int32 `json:"foreign_currency_decimal_places,omitempty"`
	// Amount of the transaction.
	Amount string `json:"amount"`
	// The amount in a foreign currency.
	ForeignAmount string `json:"foreign_amount,omitempty"`
	// Description of the transaction.
	Description string `json:"description"`
	// ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account.
	SourceId string `json:"source_id"`
	// Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name.
	SourceName string               `json:"source_name,omitempty"`
	SourceIban string               `json:"source_iban,omitempty"`
	SourceType *AccountTypeProperty `json:"source_type,omitempty"`
	// ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account.
	DestinationId string `json:"destination_id"`
	// Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough.
	DestinationName string               `json:"destination_name,omitempty"`
	DestinationIban string               `json:"destination_iban,omitempty"`
	DestinationType *AccountTypeProperty `json:"destination_type,omitempty"`
	// The budget ID for this transaction.
	BudgetId string `json:"budget_id,omitempty"`
	// The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored.
	BudgetName string `json:"budget_name,omitempty"`
	// The category ID for this transaction.
	CategoryId string `json:"category_id,omitempty"`
	// The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name.
	CategoryName string `json:"category_name,omitempty"`
	// Optional. Use either this or the bill_name
	BillId string `json:"bill_id,omitempty"`
	// Optional. Use either this or the bill_id
	BillName string `json:"bill_name,omitempty"`
	// If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user.
	Reconciled bool   `json:"reconciled,omitempty"`
	Notes      string `json:"notes,omitempty"`
	// Array of tags.
	Tags []string `json:"tags,omitempty"`
	// Reference to internal reference of other systems.
	InternalReference string `json:"internal_reference,omitempty"`
	// Reference to external ID in other systems.
	ExternalId string `json:"external_id,omitempty"`
	// External, custom URL for this transaction.
	ExternalUrl string `json:"external_url,omitempty"`
	// System generated identifier for original creator of transaction.
	OriginalSource string `json:"original_source,omitempty"`
	// Reference to recurrence that made the transaction.
	RecurrenceId string `json:"recurrence_id,omitempty"`
	// Total number of transactions expected to be created by this recurrence repetition. Will be 0 if infinite.
	RecurrenceTotal int32 `json:"recurrence_total,omitempty"`
	// The # of the current transaction created under this recurrence.
	RecurrenceCount int32 `json:"recurrence_count,omitempty"`
	// Internal ID of bunq transaction. DEPRECATED
	BunqPaymentId string `json:"bunq_payment_id,omitempty"`
	// Hash value of original import transaction (for duplicate detection).
	ImportHashV2 string `json:"import_hash_v2,omitempty"`
	// SEPA Clearing Code
	SepaCc string `json:"sepa_cc,omitempty"`
	// SEPA Opposing Account Identifier
	SepaCtOp string `json:"sepa_ct_op,omitempty"`
	// SEPA end-to-end Identifier
	SepaCtId string `json:"sepa_ct_id,omitempty"`
	// SEPA mandate identifier
	SepaDb string `json:"sepa_db,omitempty"`
	// SEPA Country
	SepaCountry string `json:"sepa_country,omitempty"`
	// SEPA External Purpose indicator
	SepaEp string `json:"sepa_ep,omitempty"`
	// SEPA Creditor Identifier
	SepaCi string `json:"sepa_ci,omitempty"`
	// SEPA Batch ID
	SepaBatchId  string    `json:"sepa_batch_id,omitempty"`
	InterestDate time.Time `json:"interest_date,omitempty"`
	BookDate     time.Time `json:"book_date,omitempty"`
	ProcessDate  time.Time `json:"process_date,omitempty"`
	DueDate      time.Time `json:"due_date,omitempty"`
	PaymentDate  time.Time `json:"payment_date,omitempty"`
	InvoiceDate  time.Time `json:"invoice_date,omitempty"`
	// Latitude of the transaction's location, if applicable. Can be used to draw a map.
	Latitude float64 `json:"latitude,omitempty"`
	// Latitude of the transaction's location, if applicable. Can be used to draw a map.
	Longitude float64 `json:"longitude,omitempty"`
	// Zoom level for the map, if drawn. This to set the box right. Unfortunately this is a proprietary value because each map provider has different zoom levels.
	ZoomLevel int32 `json:"zoom_level,omitempty"`
	// If the transaction has attachments.
	HasAttachments bool `json:"has_attachments,omitempty"`
}

type TransactionSplitStore ¶

type TransactionSplitStore struct {
	Type_ *TransactionTypeProperty `json:"type"`
	// Date of the transaction
	Date time.Time `json:"date"`
	// Amount of the transaction.
	Amount string `json:"amount"`
	// Description of the transaction.
	Description string `json:"description"`
	// Order of this entry in the list of transactions.
	Order int32 `json:"order,omitempty"`
	// Currency ID. Default is the source account's currency, or the user's default currency. The value you submit may be overruled by the source or destination account.
	CurrencyId string `json:"currency_id,omitempty"`
	// Currency code. Default is the source account's currency, or the user's default currency. The value you submit may be overruled by the source or destination account.
	CurrencyCode string `json:"currency_code,omitempty"`
	// The amount in a foreign currency.
	ForeignAmount string `json:"foreign_amount,omitempty"`
	// Currency ID of the foreign currency. Default is null. Is required when you submit a foreign amount.
	ForeignCurrencyId string `json:"foreign_currency_id,omitempty"`
	// Currency code of the foreign currency. Default is NULL. Can be used instead of the foreign_currency_id, but this or the ID is required when submitting a foreign amount.
	ForeignCurrencyCode string `json:"foreign_currency_code,omitempty"`
	// The budget ID for this transaction.
	BudgetId string `json:"budget_id,omitempty"`
	// The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored.
	BudgetName string `json:"budget_name,omitempty"`
	// The category ID for this transaction.
	CategoryId string `json:"category_id,omitempty"`
	// The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name.
	CategoryName string `json:"category_name,omitempty"`
	// ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account.
	SourceId string `json:"source_id,omitempty"`
	// Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name.
	SourceName string `json:"source_name,omitempty"`
	// ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account.
	DestinationId string `json:"destination_id,omitempty"`
	// Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough.
	DestinationName string `json:"destination_name,omitempty"`
	// If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user.
	Reconciled bool `json:"reconciled,omitempty"`
	// Optional. Use either this or the piggy_bank_name
	PiggyBankId int32 `json:"piggy_bank_id,omitempty"`
	// Optional. Use either this or the piggy_bank_id
	PiggyBankName string `json:"piggy_bank_name,omitempty"`
	// Optional. Use either this or the bill_name
	BillId string `json:"bill_id,omitempty"`
	// Optional. Use either this or the bill_id
	BillName string `json:"bill_name,omitempty"`
	// Array of tags.
	Tags  []string `json:"tags,omitempty"`
	Notes string   `json:"notes,omitempty"`
	// Reference to internal reference of other systems.
	InternalReference string `json:"internal_reference,omitempty"`
	// Reference to external ID in other systems.
	ExternalId string `json:"external_id,omitempty"`
	// External, custom URL for this transaction.
	ExternalUrl string `json:"external_url,omitempty"`
	// Internal ID of bunq transaction. Field is no longer used but still works.
	BunqPaymentId string `json:"bunq_payment_id,omitempty"`
	// SEPA Clearing Code
	SepaCc string `json:"sepa_cc,omitempty"`
	// SEPA Opposing Account Identifier
	SepaCtOp string `json:"sepa_ct_op,omitempty"`
	// SEPA end-to-end Identifier
	SepaCtId string `json:"sepa_ct_id,omitempty"`
	// SEPA mandate identifier
	SepaDb string `json:"sepa_db,omitempty"`
	// SEPA Country
	SepaCountry string `json:"sepa_country,omitempty"`
	// SEPA External Purpose indicator
	SepaEp string `json:"sepa_ep,omitempty"`
	// SEPA Creditor Identifier
	SepaCi string `json:"sepa_ci,omitempty"`
	// SEPA Batch ID
	SepaBatchId  string    `json:"sepa_batch_id,omitempty"`
	InterestDate time.Time `json:"interest_date,omitempty"`
	BookDate     time.Time `json:"book_date,omitempty"`
	ProcessDate  time.Time `json:"process_date,omitempty"`
	DueDate      time.Time `json:"due_date,omitempty"`
	PaymentDate  time.Time `json:"payment_date,omitempty"`
	InvoiceDate  time.Time `json:"invoice_date,omitempty"`
}

type TransactionSplitUpdate ¶

type TransactionSplitUpdate struct {
	// Transaction journal ID of current transaction (split).
	TransactionJournalId string                   `json:"transaction_journal_id,omitempty"`
	Type_                *TransactionTypeProperty `json:"type,omitempty"`
	// Date of the transaction
	Date time.Time `json:"date,omitempty"`
	// Amount of the transaction.
	Amount string `json:"amount,omitempty"`
	// Description of the transaction.
	Description string `json:"description,omitempty"`
	// Order of this entry in the list of transactions.
	Order int32 `json:"order,omitempty"`
	// Currency ID. Default is the source account's currency, or the user's default currency. Can be used instead of currency_code.
	CurrencyId string `json:"currency_id,omitempty"`
	// Currency code. Default is the source account's currency, or the user's default currency. Can be used instead of currency_id.
	CurrencyCode   string `json:"currency_code,omitempty"`
	CurrencySymbol string `json:"currency_symbol,omitempty"`
	CurrencyName   string `json:"currency_name,omitempty"`
	// Number of decimals used in this currency.
	CurrencyDecimalPlaces int32 `json:"currency_decimal_places,omitempty"`
	// The amount in a foreign currency.
	ForeignAmount string `json:"foreign_amount,omitempty"`
	// Currency ID of the foreign currency. Default is null. Is required when you submit a foreign amount.
	ForeignCurrencyId string `json:"foreign_currency_id,omitempty"`
	// Currency code of the foreign currency. Default is NULL. Can be used instead of the foreign_currency_id, but this or the ID is required when submitting a foreign amount.
	ForeignCurrencyCode   string `json:"foreign_currency_code,omitempty"`
	ForeignCurrencySymbol string `json:"foreign_currency_symbol,omitempty"`
	// Number of decimals in the currency
	ForeignCurrencyDecimalPlaces int32 `json:"foreign_currency_decimal_places,omitempty"`
	// The budget ID for this transaction.
	BudgetId string `json:"budget_id,omitempty"`
	// The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored.
	BudgetName string `json:"budget_name,omitempty"`
	// The category ID for this transaction.
	CategoryId string `json:"category_id,omitempty"`
	// The name of the category to be used. If the category is unknown, it will be created. If the ID and the name point to different categories, the ID overrules the name.
	CategoryName string `json:"category_name,omitempty"`
	// ID of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account.
	SourceId string `json:"source_id,omitempty"`
	// Name of the source account. For a withdrawal or a transfer, this must always be an asset account. For deposits, this must be a revenue account. Can be used instead of the source_id. If the transaction is a deposit, the source_name can be filled in freely: the account will be created based on the name.
	SourceName string `json:"source_name,omitempty"`
	SourceIban string `json:"source_iban,omitempty"`
	// ID of the destination account. For a deposit or a transfer, this must always be an asset account. For withdrawals this must be an expense account.
	DestinationId string `json:"destination_id,omitempty"`
	// Name of the destination account. You can submit the name instead of the ID. For everything except transfers, the account will be auto-generated if unknown, so submitting a name is enough.
	DestinationName string `json:"destination_name,omitempty"`
	DestinationIban string `json:"destination_iban,omitempty"`
	// If the transaction has been reconciled already. When you set this, the amount can no longer be edited by the user.
	Reconciled bool `json:"reconciled,omitempty"`
	// Optional. Use either this or the bill_name
	BillId string `json:"bill_id,omitempty"`
	// Optional. Use either this or the bill_id
	BillName string `json:"bill_name,omitempty"`
	// Array of tags.
	Tags  []string `json:"tags,omitempty"`
	Notes string   `json:"notes,omitempty"`
	// Reference to internal reference of other systems.
	InternalReference string `json:"internal_reference,omitempty"`
	// Reference to external ID in other systems.
	ExternalId string `json:"external_id,omitempty"`
	// External, custom URL for this transaction.
	ExternalUrl string `json:"external_url,omitempty"`
	// Internal ID of bunq transaction.
	BunqPaymentId string `json:"bunq_payment_id,omitempty"`
	// SEPA Clearing Code
	SepaCc string `json:"sepa_cc,omitempty"`
	// SEPA Opposing Account Identifier
	SepaCtOp string `json:"sepa_ct_op,omitempty"`
	// SEPA end-to-end Identifier
	SepaCtId string `json:"sepa_ct_id,omitempty"`
	// SEPA mandate identifier
	SepaDb string `json:"sepa_db,omitempty"`
	// SEPA Country
	SepaCountry string `json:"sepa_country,omitempty"`
	// SEPA External Purpose indicator
	SepaEp string `json:"sepa_ep,omitempty"`
	// SEPA Creditor Identifier
	SepaCi string `json:"sepa_ci,omitempty"`
	// SEPA Batch ID
	SepaBatchId  string    `json:"sepa_batch_id,omitempty"`
	InterestDate time.Time `json:"interest_date,omitempty"`
	BookDate     time.Time `json:"book_date,omitempty"`
	ProcessDate  time.Time `json:"process_date,omitempty"`
	DueDate      time.Time `json:"due_date,omitempty"`
	PaymentDate  time.Time `json:"payment_date,omitempty"`
	InvoiceDate  time.Time `json:"invoice_date,omitempty"`
}

type TransactionStore ¶

type TransactionStore struct {
	// Break if the submitted transaction exists already.
	ErrorIfDuplicateHash bool `json:"error_if_duplicate_hash,omitempty"`
	// Whether or not to apply rules when submitting transaction.
	ApplyRules bool `json:"apply_rules,omitempty"`
	// Whether or not to fire the webhooks that are related to this event.
	FireWebhooks bool `json:"fire_webhooks,omitempty"`
	// Title of the transaction if it has been split in more than one piece. Empty otherwise.
	GroupTitle   string                  `json:"group_title,omitempty"`
	Transactions []TransactionSplitStore `json:"transactions"`
}

type TransactionTypeFilter ¶

type TransactionTypeFilter string

const (
	ALL_TransactionTypeFilter             TransactionTypeFilter = "all"
	WITHDRAWAL_TransactionTypeFilter      TransactionTypeFilter = "withdrawal"
	WITHDRAWALS_TransactionTypeFilter     TransactionTypeFilter = "withdrawals"
	EXPENSE_TransactionTypeFilter         TransactionTypeFilter = "expense"
	DEPOSIT_TransactionTypeFilter         TransactionTypeFilter = "deposit"
	DEPOSITS_TransactionTypeFilter        TransactionTypeFilter = "deposits"
	INCOME_TransactionTypeFilter          TransactionTypeFilter = "income"
	TRANSFER_TransactionTypeFilter        TransactionTypeFilter = "transfer"
	TRANSFERS_TransactionTypeFilter       TransactionTypeFilter = "transfers"
	OPENING_BALANCE_TransactionTypeFilter TransactionTypeFilter = "opening_balance"
	RECONCILIATION_TransactionTypeFilter  TransactionTypeFilter = "reconciliation"
	SPECIAL_TransactionTypeFilter         TransactionTypeFilter = "special"
	SPECIALS_TransactionTypeFilter        TransactionTypeFilter = "specials"
	DEFAULT__TransactionTypeFilter        TransactionTypeFilter = "default"
)

List of TransactionTypeFilter

type TransactionTypeProperty ¶

type TransactionTypeProperty string

const (
	WITHDRAWAL_TransactionTypeProperty      TransactionTypeProperty = "withdrawal"
	DEPOSIT_TransactionTypeProperty         TransactionTypeProperty = "deposit"
	TRANSFER_TransactionTypeProperty        TransactionTypeProperty = "transfer"
	RECONCILIATION_TransactionTypeProperty  TransactionTypeProperty = "reconciliation"
	OPENING_BALANCE_TransactionTypeProperty TransactionTypeProperty = "opening balance"
)

List of TransactionTypeProperty

type TransactionUpdate ¶

type TransactionUpdate struct {
	// Whether or not to apply rules when submitting transaction.
	ApplyRules bool `json:"apply_rules,omitempty"`
	// Whether or not to fire the webhooks that are related to this event.
	FireWebhooks bool `json:"fire_webhooks,omitempty"`
	// Title of the transaction if it has been split in more than one piece. Empty otherwise.
	GroupTitle   string                   `json:"group_title,omitempty"`
	Transactions []TransactionSplitUpdate `json:"transactions,omitempty"`
}

type TransactionsApiDeleteTransactionJournalOpts ¶

type TransactionsApiDeleteTransactionJournalOpts struct {
	XTraceId optional.Interface
}

type TransactionsApiDeleteTransactionOpts ¶

type TransactionsApiDeleteTransactionOpts struct {
	XTraceId optional.Interface
}

type TransactionsApiGetTransactionByJournalOpts ¶

type TransactionsApiGetTransactionByJournalOpts struct {
	XTraceId optional.Interface
}

type TransactionsApiGetTransactionOpts ¶

type TransactionsApiGetTransactionOpts struct {
	XTraceId optional.Interface
}

type TransactionsApiListAttachmentByTransactionOpts ¶

type TransactionsApiListAttachmentByTransactionOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type TransactionsApiListEventByTransactionOpts ¶

type TransactionsApiListEventByTransactionOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type TransactionsApiListLinksByJournalOpts ¶

type TransactionsApiListLinksByJournalOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type TransactionsApiListTransactionOpts ¶

type TransactionsApiListTransactionOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
	Start    optional.String
	End      optional.String
	Type_    optional.Interface
}

type TransactionsApiService ¶

type TransactionsApiService service

func (*TransactionsApiService) DeleteTransaction ¶

func (a *TransactionsApiService) DeleteTransaction(ctx context.Context, id string, localVarOptionals *TransactionsApiDeleteTransactionOpts) (*http.Response, error)

func (*TransactionsApiService) DeleteTransactionJournal ¶

func (a *TransactionsApiService) DeleteTransactionJournal(ctx context.Context, id string, localVarOptionals *TransactionsApiDeleteTransactionJournalOpts) (*http.Response, error)

func (*TransactionsApiService) GetTransaction ¶

func (a *TransactionsApiService) GetTransaction(ctx context.Context, id string, localVarOptionals *TransactionsApiGetTransactionOpts) (TransactionSingle, *http.Response, error)

func (*TransactionsApiService) GetTransactionByJournal ¶

func (a *TransactionsApiService) GetTransactionByJournal(ctx context.Context, id string, localVarOptionals *TransactionsApiGetTransactionByJournalOpts) (TransactionSingle, *http.Response, error)

func (*TransactionsApiService) ListAttachmentByTransaction ¶

func (a *TransactionsApiService) ListAttachmentByTransaction(ctx context.Context, id string, localVarOptionals *TransactionsApiListAttachmentByTransactionOpts) (AttachmentArray, *http.Response, error)

func (*TransactionsApiService) ListEventByTransaction ¶

func (a *TransactionsApiService) ListEventByTransaction(ctx context.Context, id string, localVarOptionals *TransactionsApiListEventByTransactionOpts) (PiggyBankEventArray, *http.Response, error)

func (*TransactionsApiService) ListLinksByJournal ¶

func (a *TransactionsApiService) ListLinksByJournal(ctx context.Context, id string, localVarOptionals *TransactionsApiListLinksByJournalOpts) (TransactionLinkArray, *http.Response, error)

func (*TransactionsApiService) ListTransaction ¶

func (a *TransactionsApiService) ListTransaction(ctx context.Context, localVarOptionals *TransactionsApiListTransactionOpts) (TransactionArray, *http.Response, error)

func (*TransactionsApiService) StoreTransaction ¶

func (a *TransactionsApiService) StoreTransaction(ctx context.Context, body TransactionStore, localVarOptionals *TransactionsApiStoreTransactionOpts) (TransactionSingle, *http.Response, error)

func (*TransactionsApiService) UpdateTransaction ¶

func (a *TransactionsApiService) UpdateTransaction(ctx context.Context, body TransactionUpdate, id string, localVarOptionals *TransactionsApiUpdateTransactionOpts) (TransactionSingle, *http.Response, error)

type TransactionsApiStoreTransactionOpts ¶

type TransactionsApiStoreTransactionOpts struct {
	XTraceId optional.Interface
}

type TransactionsApiUpdateTransactionOpts ¶

type TransactionsApiUpdateTransactionOpts struct {
	XTraceId optional.Interface
}

type UnauthenticatedResponse ¶

type UnauthenticatedResponse struct {
	Message   string `json:"message,omitempty"`
	Exception string `json:"exception,omitempty"`
}

type User ¶

type User struct {
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// The new users email address.
	Email string `json:"email"`
	// Boolean to indicate if the user is blocked.
	Blocked     bool                     `json:"blocked,omitempty"`
	BlockedCode *UserBlockedCodeProperty `json:"blocked_code,omitempty"`
	Role        *UserRoleProperty        `json:"role,omitempty"`
}

type UserArray ¶

type UserArray struct {
	Data  []UserRead `json:"data"`
	Meta  *Meta      `json:"meta"`
	Links *PageLink  `json:"links"`
}

type UserBlockedCodeProperty ¶

type UserBlockedCodeProperty string

UserBlockedCodeProperty : If you say the user must be blocked, this will be the reason code.

const (
	EMAIL_CHANGED_UserBlockedCodeProperty UserBlockedCodeProperty = "email_changed"
	NULL_UserBlockedCodeProperty          UserBlockedCodeProperty = ""
)

List of UserBlockedCodeProperty

type UserRead ¶

type UserRead struct {
	// Immutable value
	Type_      string      `json:"type"`
	Id         string      `json:"id"`
	Attributes *User       `json:"attributes"`
	Links      *ObjectLink `json:"links"`
}

type UserRoleProperty ¶

type UserRoleProperty string

UserRoleProperty : Role for the user. Can be empty or omitted.

const (
	OWNER_UserRoleProperty UserRoleProperty = "owner"
	DEMO_UserRoleProperty  UserRoleProperty = "demo"
	NULL_UserRoleProperty  UserRoleProperty = ""
)

List of UserRoleProperty

type UserSingle ¶

type UserSingle struct {
	Data *UserRead `json:"data"`
}

type UsersApiDeleteUserOpts ¶

type UsersApiDeleteUserOpts struct {
	XTraceId optional.Interface
}

type UsersApiGetUserOpts ¶

type UsersApiGetUserOpts struct {
	XTraceId optional.Interface
}

type UsersApiListUserOpts ¶

type UsersApiListUserOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type UsersApiService ¶

type UsersApiService service

func (*UsersApiService) DeleteUser ¶

func (a *UsersApiService) DeleteUser(ctx context.Context, id string, localVarOptionals *UsersApiDeleteUserOpts) (*http.Response, error)

func (*UsersApiService) GetUser ¶

func (a *UsersApiService) GetUser(ctx context.Context, id string, localVarOptionals *UsersApiGetUserOpts) (UserSingle, *http.Response, error)

func (*UsersApiService) ListUser ¶

func (a *UsersApiService) ListUser(ctx context.Context, localVarOptionals *UsersApiListUserOpts) (UserArray, *http.Response, error)

func (*UsersApiService) StoreUser ¶

func (a *UsersApiService) StoreUser(ctx context.Context, body User, localVarOptionals *UsersApiStoreUserOpts) (UserSingle, *http.Response, error)

func (*UsersApiService) UpdateUser ¶

func (a *UsersApiService) UpdateUser(ctx context.Context, body User, id string, localVarOptionals *UsersApiUpdateUserOpts) (UserSingle, *http.Response, error)

type UsersApiStoreUserOpts ¶

type UsersApiStoreUserOpts struct {
	XTraceId optional.Interface
}

type UsersApiUpdateUserOpts ¶

type UsersApiUpdateUserOpts struct {
	XTraceId optional.Interface
}

type ValidationErrorResponse ¶

type ValidationErrorResponse struct {
	Message string                         `json:"message,omitempty"`
	Errors  *ValidationErrorResponseErrors `json:"errors,omitempty"`
}

type ValidationErrorResponseErrors ¶

type ValidationErrorResponseErrors struct {
	Email       []string `json:"email,omitempty"`
	Blocked     []string `json:"blocked,omitempty"`
	Role        []string `json:"role,omitempty"`
	BlockedCode []string `json:"blocked_code,omitempty"`
	Name        []string `json:"name,omitempty"`
	Type_       []string `json:"type,omitempty"`
	Iban        []string `json:"iban,omitempty"`
	Start       []string `json:"start,omitempty"`
	End         []string `json:"end,omitempty"`
	Date        []string `json:"date,omitempty"`
}

type Webhook ¶

type Webhook struct {
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// Boolean to indicate if the webhook is active
	Active bool `json:"active,omitempty"`
	// A title for the webhook for easy recognition.
	Title string `json:"title"`
	// A 24-character secret for the webhook. It's generated by Firefly III when saving a new webhook. If you submit a new secret through the PUT endpoint it will generate a new secret for the selected webhook, a new secret bearing no relation to whatever you just submitted.
	Secret   string           `json:"secret,omitempty"`
	Trigger  *WebhookTrigger  `json:"trigger"`
	Response *WebhookResponse `json:"response"`
	Delivery *WebhookDelivery `json:"delivery"`
	// The URL of the webhook. Has to start with `https`.
	Url string `json:"url"`
}

type WebhookArray ¶

type WebhookArray struct {
	Data  []WebhookRead `json:"data"`
	Meta  *Meta         `json:"meta"`
	Links *PageLink     `json:"links"`
}

type WebhookAttempt ¶

type WebhookAttempt struct {
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// The ID of the webhook message this attempt belongs to.
	WebhookMessageId string `json:"webhook_message_id,omitempty"`
	// The HTTP status code of the error, if any.
	StatusCode int32 `json:"status_code,omitempty"`
	// Internal log for this attempt. May contain sensitive user data.
	Logs string `json:"logs,omitempty"`
	// Webhook receiver response for this attempt, if any. May contain sensitive user data.
	Response string `json:"response,omitempty"`
}

type WebhookAttemptArray ¶

type WebhookAttemptArray struct {
	Data []WebhookAttemptRead `json:"data"`
	Meta *Meta                `json:"meta"`
}

type WebhookAttemptRead ¶

type WebhookAttemptRead struct {
	// Immutable value
	Type_      string          `json:"type"`
	Id         string          `json:"id"`
	Attributes *WebhookAttempt `json:"attributes"`
}

type WebhookAttemptSingle ¶

type WebhookAttemptSingle struct {
	Data *WebhookAttemptRead `json:"data"`
}

type WebhookDelivery ¶

type WebhookDelivery string

WebhookDelivery : Format of the delivered response.

const (
	JSON_WebhookDelivery WebhookDelivery = "JSON"
)

List of WebhookDelivery

type WebhookMessage ¶

type WebhookMessage struct {
	CreatedAt time.Time `json:"created_at,omitempty"`
	UpdatedAt time.Time `json:"updated_at,omitempty"`
	// If this message is sent yet.
	Sent bool `json:"sent,omitempty"`
	// If this message has errored out.
	Errored bool `json:"errored,omitempty"`
	// The ID of the webhook this message belongs to.
	WebhookId string `json:"webhook_id,omitempty"`
	// Long UUID string for identification of this webhook message.
	Uuid string `json:"uuid,omitempty"`
	// The actual message that is sent or will be sent as JSON string.
	Message string `json:"message,omitempty"`
}

type WebhookMessageArray ¶

type WebhookMessageArray struct {
	Data []WebhookMessageRead `json:"data"`
	Meta *Meta                `json:"meta"`
}

type WebhookMessageRead ¶

type WebhookMessageRead struct {
	// Immutable value
	Type_      string          `json:"type"`
	Id         string          `json:"id"`
	Attributes *WebhookMessage `json:"attributes"`
}

type WebhookMessageSingle ¶

type WebhookMessageSingle struct {
	Data *WebhookMessageRead `json:"data"`
}

type WebhookRead ¶

type WebhookRead struct {
	// Immutable value
	Type_      string      `json:"type"`
	Id         string      `json:"id"`
	Attributes *Webhook    `json:"attributes"`
	Links      *ObjectLink `json:"links"`
}

type WebhookResponse ¶

type WebhookResponse string

WebhookResponse : Indicator for what Firefly III will deliver to the webhook URL.

const (
	TRANSACTIONS_WebhookResponse WebhookResponse = "TRANSACTIONS"
	ACCOUNTS_WebhookResponse     WebhookResponse = "ACCOUNTS"
	NONE_WebhookResponse         WebhookResponse = "NONE"
)

List of WebhookResponse

type WebhookSingle ¶

type WebhookSingle struct {
	Data *WebhookRead `json:"data"`
}

type WebhookStore ¶

type WebhookStore struct {
	// Boolean to indicate if the webhook is active
	Active bool `json:"active,omitempty"`
	// A title for the webhook for easy recognition.
	Title    string           `json:"title"`
	Trigger  *WebhookTrigger  `json:"trigger"`
	Response *WebhookResponse `json:"response"`
	Delivery *WebhookDelivery `json:"delivery"`
	// The URL of the webhook. Has to start with `https`.
	Url string `json:"url"`
}

type WebhookTrigger ¶

type WebhookTrigger string

WebhookTrigger : The trigger for the webhook.

const (
	STORE_TRANSACTION_WebhookTrigger   WebhookTrigger = "STORE_TRANSACTION"
	UPDATE_TRANSACTION_WebhookTrigger  WebhookTrigger = "UPDATE_TRANSACTION"
	DESTROY_TRANSACTION_WebhookTrigger WebhookTrigger = "DESTROY_TRANSACTION"
)

List of WebhookTrigger

type WebhookUpdate ¶

type WebhookUpdate struct {
	// Boolean to indicate if the webhook is active
	Active bool `json:"active,omitempty"`
	// A title for the webhook for easy recognition.
	Title string `json:"title,omitempty"`
	// A 24-character secret for the webhook. It's generated by Firefly III when saving a new webhook. If you submit a new secret through the PUT endpoint it will generate a new secret for the selected webhook, a new secret bearing no relation to whatever you just submitted.
	Secret   string           `json:"secret,omitempty"`
	Trigger  *WebhookTrigger  `json:"trigger,omitempty"`
	Response *WebhookResponse `json:"response,omitempty"`
	Delivery *WebhookDelivery `json:"delivery,omitempty"`
	// The URL of the webhook. Has to start with `https`.
	Url string `json:"url,omitempty"`
}

type WebhooksApiDeleteWebhookMessageAttemptOpts ¶

type WebhooksApiDeleteWebhookMessageAttemptOpts struct {
	XTraceId optional.Interface
}

type WebhooksApiDeleteWebhookMessageOpts ¶

type WebhooksApiDeleteWebhookMessageOpts struct {
	XTraceId optional.Interface
}

type WebhooksApiDeleteWebhookOpts ¶

type WebhooksApiDeleteWebhookOpts struct {
	XTraceId optional.Interface
}

type WebhooksApiGetSingleWebhookMessageAttemptOpts ¶

type WebhooksApiGetSingleWebhookMessageAttemptOpts struct {
	XTraceId optional.Interface
}

type WebhooksApiGetSingleWebhookMessageOpts ¶

type WebhooksApiGetSingleWebhookMessageOpts struct {
	XTraceId optional.Interface
}

type WebhooksApiGetWebhookMessageAttemptsOpts ¶

type WebhooksApiGetWebhookMessageAttemptsOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type WebhooksApiGetWebhookMessagesOpts ¶

type WebhooksApiGetWebhookMessagesOpts struct {
	XTraceId optional.Interface
}

type WebhooksApiGetWebhookOpts ¶

type WebhooksApiGetWebhookOpts struct {
	XTraceId optional.Interface
}

type WebhooksApiListWebhookOpts ¶

type WebhooksApiListWebhookOpts struct {
	XTraceId optional.Interface
	Limit    optional.Int32
	Page     optional.Int32
}

type WebhooksApiService ¶

type WebhooksApiService service

func (*WebhooksApiService) DeleteWebhook ¶

func (a *WebhooksApiService) DeleteWebhook(ctx context.Context, id string, localVarOptionals *WebhooksApiDeleteWebhookOpts) (*http.Response, error)

func (*WebhooksApiService) DeleteWebhookMessage ¶

func (a *WebhooksApiService) DeleteWebhookMessage(ctx context.Context, id string, messageId int32, localVarOptionals *WebhooksApiDeleteWebhookMessageOpts) (*http.Response, error)

func (*WebhooksApiService) DeleteWebhookMessageAttempt ¶

func (a *WebhooksApiService) DeleteWebhookMessageAttempt(ctx context.Context, id string, messageId int32, attemptId int32, localVarOptionals *WebhooksApiDeleteWebhookMessageAttemptOpts) (*http.Response, error)

func (*WebhooksApiService) GetSingleWebhookMessage ¶

func (a *WebhooksApiService) GetSingleWebhookMessage(ctx context.Context, id string, messageId int32, localVarOptionals *WebhooksApiGetSingleWebhookMessageOpts) (WebhookMessageSingle, *http.Response, error)

func (*WebhooksApiService) GetSingleWebhookMessageAttempt ¶

func (a *WebhooksApiService) GetSingleWebhookMessageAttempt(ctx context.Context, id string, messageId int32, attemptId int32, localVarOptionals *WebhooksApiGetSingleWebhookMessageAttemptOpts) (WebhookAttemptSingle, *http.Response, error)

func (*WebhooksApiService) GetWebhook ¶

func (a *WebhooksApiService) GetWebhook(ctx context.Context, id string, localVarOptionals *WebhooksApiGetWebhookOpts) (WebhookSingle, *http.Response, error)

func (*WebhooksApiService) GetWebhookMessageAttempts ¶

func (a *WebhooksApiService) GetWebhookMessageAttempts(ctx context.Context, id string, messageId int32, localVarOptionals *WebhooksApiGetWebhookMessageAttemptsOpts) (WebhookAttemptArray, *http.Response, error)

func (*WebhooksApiService) GetWebhookMessages ¶

func (a *WebhooksApiService) GetWebhookMessages(ctx context.Context, id string, localVarOptionals *WebhooksApiGetWebhookMessagesOpts) (WebhookMessageArray, *http.Response, error)

func (*WebhooksApiService) ListWebhook ¶

func (a *WebhooksApiService) ListWebhook(ctx context.Context, localVarOptionals *WebhooksApiListWebhookOpts) (WebhookArray, *http.Response, error)

func (*WebhooksApiService) StoreWebhook ¶

func (a *WebhooksApiService) StoreWebhook(ctx context.Context, body WebhookStore, localVarOptionals *WebhooksApiStoreWebhookOpts) (WebhookSingle, *http.Response, error)

func (*WebhooksApiService) SubmitWebook ¶

func (a *WebhooksApiService) SubmitWebook(ctx context.Context, id string, localVarOptionals *WebhooksApiSubmitWebookOpts) (*http.Response, error)

func (*WebhooksApiService) TriggerTransactionWebhook ¶

func (a *WebhooksApiService) TriggerTransactionWebhook(ctx context.Context, id string, transactionId string, localVarOptionals *WebhooksApiTriggerTransactionWebhookOpts) (*http.Response, error)

func (*WebhooksApiService) UpdateWebhook ¶

func (a *WebhooksApiService) UpdateWebhook(ctx context.Context, body WebhookUpdate, id string, localVarOptionals *WebhooksApiUpdateWebhookOpts) (WebhookSingle, *http.Response, error)

type WebhooksApiStoreWebhookOpts ¶

type WebhooksApiStoreWebhookOpts struct {
	XTraceId optional.Interface
}

type WebhooksApiSubmitWebookOpts ¶

type WebhooksApiSubmitWebookOpts struct {
	XTraceId optional.Interface
}

type WebhooksApiTriggerTransactionWebhookOpts ¶

type WebhooksApiTriggerTransactionWebhookOpts struct {
	XTraceId optional.Interface
}

type WebhooksApiUpdateWebhookOpts ¶

type WebhooksApiUpdateWebhookOpts struct {
	XTraceId optional.Interface
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL