firefly-api/dist/api.d.ts

OpenAPI Autogenerated firefly-iii TypeScript API

/**
 * Firefly III API v2.0.0
 * This is the documentation of the Firefly III API. You can find accompanying documentation on the website of Firefly III itself (see below). Please report any bugs or issues. You may use the \"Authorize\" button to try the API below. This file was last generated on 2023-03-05T14:16:31+00:00
 *
 * The version of the OpenAPI document: 2.0.0
 * Contact: james@firefly-iii.org
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { Configuration } from './configuration';
import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
import type { RequestArgs } from './base';
import { BaseAPI } from './base';
/**
 *
 * @export
 * @interface Account
 */
export interface Account {
    /**
     *
     * @type {string}
     * @memberof Account
     */
    'created_at'?: string;
    /**
     *
     * @type {string}
     * @memberof Account
     */
    'updated_at'?: string;
    /**
     * If omitted, defaults to true.
     * @type {boolean}
     * @memberof Account
     */
    'active'?: boolean;
    /**
     * Order of the account. Is NULL if account is not asset or liability.
     * @type {number}
     * @memberof Account
     */
    'order'?: number | null;
    /**
     *
     * @type {string}
     * @memberof Account
     */
    'name': string;
    /**
     *
     * @type {ShortAccountTypeProperty}
     * @memberof Account
     */
    'type': ShortAccountTypeProperty;
    /**
     *
     * @type {AccountRoleProperty}
     * @memberof Account
     */
    'account_role'?: AccountRoleProperty | null;
    /**
     * Use either currency_id or currency_code. Defaults to the user\'s default currency.
     * @type {string}
     * @memberof Account
     */
    'currency_id'?: string;
    /**
     * Use either currency_id or currency_code. Defaults to the user\'s default currency.
     * @type {string}
     * @memberof Account
     */
    'currency_code'?: string;
    /**
     *
     * @type {string}
     * @memberof Account
     */
    'currency_symbol'?: string;
    /**
     *
     * @type {number}
     * @memberof Account
     */
    'currency_decimal_places'?: number;
    /**
     *
     * @type {string}
     * @memberof Account
     */
    'current_balance'?: string;
    /**
     *
     * @type {string}
     * @memberof Account
     */
    'current_balance_date'?: string;
    /**
     *
     * @type {string}
     * @memberof Account
     */
    'iban'?: string | null;
    /**
     *
     * @type {string}
     * @memberof Account
     */
    'bic'?: string | null;
    /**
     *
     * @type {string}
     * @memberof Account
     */
    'account_number'?: string | null;
    /**
     * Represents the opening balance, the initial amount this account holds.
     * @type {string}
     * @memberof Account
     */
    'opening_balance'?: string;
    /**
     * Represents the current debt for liabilities.
     * @type {string}
     * @memberof Account
     */
    'current_debt'?: string | null;
    /**
     * Represents the date of the opening balance.
     * @type {string}
     * @memberof Account
     */
    'opening_balance_date'?: string | null;
    /**
     *
     * @type {string}
     * @memberof Account
     */
    'virtual_balance'?: string;
    /**
     * If omitted, defaults to true.
     * @type {boolean}
     * @memberof Account
     */
    'include_net_worth'?: boolean;
    /**
     *
     * @type {CreditCardType}
     * @memberof Account
     */
    'credit_card_type'?: CreditCardType | null;
    /**
     * Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank.
     * @type {string}
     * @memberof Account
     */
    'monthly_payment_date'?: string | null;
    /**
     *
     * @type {LiabilityType}
     * @memberof Account
     */
    'liability_type'?: LiabilityType | null;
    /**
     *
     * @type {LiabilityDirection}
     * @memberof Account
     */
    'liability_direction'?: LiabilityDirection | null;
    /**
     * Mandatory when type is liability. Interest percentage.
     * @type {string}
     * @memberof Account
     */
    'interest'?: string | null;
    /**
     *
     * @type {InterestPeriod}
     * @memberof Account
     */
    'interest_period'?: InterestPeriod | null;
    /**
     *
     * @type {string}
     * @memberof Account
     */
    'notes'?: string | null;
    /**
     * Latitude of the accounts\'s location, if applicable. Can be used to draw a map.
     * @type {number}
     * @memberof Account
     */
    'latitude'?: number | null;
    /**
     * Latitude of the accounts\'s location, if applicable. Can be used to draw a map.
     * @type {number}
     * @memberof Account
     */
    'longitude'?: number | null;
    /**
     * 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.
     * @type {number}
     * @memberof Account
     */
    'zoom_level'?: number | null;
}
/**
 *
 * @export
 * @interface AccountArray
 */
export interface AccountArray {
    /**
     *
     * @type {Array<AccountRead>}
     * @memberof AccountArray
     */
    'data': Array<AccountRead>;
    /**
     *
     * @type {Meta}
     * @memberof AccountArray
     */
    'meta': Meta;
}
/**
 *
 * @export
 * @interface AccountRead
 */
export interface AccountRead {
    /**
     * Immutable value
     * @type {string}
     * @memberof AccountRead
     */
    'type': string;
    /**
     *
     * @type {string}
     * @memberof AccountRead
     */
    'id': string;
    /**
     *
     * @type {Account}
     * @memberof AccountRead
     */
    'attributes': Account;
}
/**
 * Is only mandatory when the type is asset.
 * @export
 * @enum {string}
 */
export declare const AccountRoleProperty: {
    readonly DefaultAsset: "defaultAsset";
    readonly SharedAsset: "sharedAsset";
    readonly SavingAsset: "savingAsset";
    readonly CcAsset: "ccAsset";
    readonly CashWalletAsset: "cashWalletAsset";
    readonly Null: "null";
};
export type AccountRoleProperty = typeof AccountRoleProperty[keyof typeof AccountRoleProperty];
/**
 *
 * @export
 * @enum {string}
 */
export declare const AccountSearchFieldFilter: {
    readonly All: "all";
    readonly Iban: "iban";
    readonly Name: "name";
    readonly Number: "number";
    readonly Id: "id";
};
export type AccountSearchFieldFilter = typeof AccountSearchFieldFilter[keyof typeof AccountSearchFieldFilter];
/**
 *
 * @export
 * @interface AccountSingle
 */
export interface AccountSingle {
    /**
     *
     * @type {AccountRead}
     * @memberof AccountSingle
     */
    'data': AccountRead;
}
/**
 *
 * @export
 * @interface AccountStore
 */
export interface AccountStore {
    /**
     *
     * @type {string}
     * @memberof AccountStore
     */
    'name': string;
    /**
     *
     * @type {ShortAccountTypeProperty}
     * @memberof AccountStore
     */
    'type': ShortAccountTypeProperty;
    /**
     *
     * @type {string}
     * @memberof AccountStore
     */
    'iban'?: string | null;
    /**
     *
     * @type {string}
     * @memberof AccountStore
     */
    'bic'?: string | null;
    /**
     *
     * @type {string}
     * @memberof AccountStore
     */
    'account_number'?: string | null;
    /**
     * Represents the opening balance, the initial amount this account holds.
     * @type {string}
     * @memberof AccountStore
     */
    'opening_balance'?: string;
    /**
     * Represents the date of the opening balance.
     * @type {string}
     * @memberof AccountStore
     */
    'opening_balance_date'?: string | null;
    /**
     *
     * @type {string}
     * @memberof AccountStore
     */
    'virtual_balance'?: string;
    /**
     * Use either currency_id or currency_code. Defaults to the user\'s default currency.
     * @type {string}
     * @memberof AccountStore
     */
    'currency_id'?: string;
    /**
     * Use either currency_id or currency_code. Defaults to the user\'s default currency.
     * @type {string}
     * @memberof AccountStore
     */
    'currency_code'?: string;
    /**
     * If omitted, defaults to true.
     * @type {boolean}
     * @memberof AccountStore
     */
    'active'?: boolean;
    /**
     * Order of the account
     * @type {number}
     * @memberof AccountStore
     */
    'order'?: number;
    /**
     * If omitted, defaults to true.
     * @type {boolean}
     * @memberof AccountStore
     */
    'include_net_worth'?: boolean;
    /**
     *
     * @type {AccountRoleProperty}
     * @memberof AccountStore
     */
    'account_role'?: AccountRoleProperty | null;
    /**
     *
     * @type {CreditCardType}
     * @memberof AccountStore
     */
    'credit_card_type'?: CreditCardType | null;
    /**
     * Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank.
     * @type {string}
     * @memberof AccountStore
     */
    'monthly_payment_date'?: string | null;
    /**
     *
     * @type {LiabilityType}
     * @memberof AccountStore
     */
    'liability_type'?: LiabilityType | null;
    /**
     *
     * @type {LiabilityDirection}
     * @memberof AccountStore
     */
    'liability_direction'?: LiabilityDirection | null;
    /**
     * Mandatory when type is liability. Interest percentage.
     * @type {string}
     * @memberof AccountStore
     */
    'interest'?: string | null;
    /**
     *
     * @type {InterestPeriod}
     * @memberof AccountStore
     */
    'interest_period'?: InterestPeriod | null;
    /**
     *
     * @type {string}
     * @memberof AccountStore
     */
    'notes'?: string | null;
    /**
     * Latitude of the accounts\'s location, if applicable. Can be used to draw a map.
     * @type {number}
     * @memberof AccountStore
     */
    'latitude'?: number | null;
    /**
     * Latitude of the accounts\'s location, if applicable. Can be used to draw a map.
     * @type {number}
     * @memberof AccountStore
     */
    'longitude'?: number | null;
    /**
     * 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.
     * @type {number}
     * @memberof AccountStore
     */
    'zoom_level'?: number | null;
}
/**
 *
 * @export
 * @enum {string}
 */
export declare const AccountTypeFilter: {
    readonly All: "all";
    readonly Asset: "asset";
    readonly Cash: "cash";
    readonly Expense: "expense";
    readonly Revenue: "revenue";
    readonly Special: "special";
    readonly Hidden: "hidden";
    readonly Liability: "liability";
    readonly Liabilities: "liabilities";
    readonly DefaultAccount: "Default account";
    readonly CashAccount: "Cash account";
    readonly AssetAccount: "Asset account";
    readonly ExpenseAccount: "Expense account";
    readonly RevenueAccount: "Revenue account";
    readonly InitialBalanceAccount: "Initial balance account";
    readonly BeneficiaryAccount: "Beneficiary account";
    readonly ImportAccount: "Import account";
    readonly ReconciliationAccount: "Reconciliation account";
    readonly Loan: "Loan";
    readonly Debt: "Debt";
    readonly Mortgage: "Mortgage";
};
export type AccountTypeFilter = typeof AccountTypeFilter[keyof typeof AccountTypeFilter];
/**
 *
 * @export
 * @enum {string}
 */
export declare const AccountTypeProperty: {
    readonly DefaultAccount: "Default account";
    readonly CashAccount: "Cash account";
    readonly AssetAccount: "Asset account";
    readonly ExpenseAccount: "Expense account";
    readonly RevenueAccount: "Revenue account";
    readonly InitialBalanceAccount: "Initial balance account";
    readonly BeneficiaryAccount: "Beneficiary account";
    readonly ImportAccount: "Import account";
    readonly ReconciliationAccount: "Reconciliation account";
    readonly Loan: "Loan";
    readonly Debt: "Debt";
    readonly Mortgage: "Mortgage";
};
export type AccountTypeProperty = typeof AccountTypeProperty[keyof typeof AccountTypeProperty];
/**
 *
 * @export
 * @interface AccountUpdate
 */
export interface AccountUpdate {
    /**
     *
     * @type {string}
     * @memberof AccountUpdate
     */
    'name': string;
    /**
     *
     * @type {string}
     * @memberof AccountUpdate
     */
    'iban'?: string | null;
    /**
     *
     * @type {string}
     * @memberof AccountUpdate
     */
    'bic'?: string | null;
    /**
     *
     * @type {string}
     * @memberof AccountUpdate
     */
    'account_number'?: string | null;
    /**
     *
     * @type {string}
     * @memberof AccountUpdate
     */
    'opening_balance'?: string;
    /**
     *
     * @type {string}
     * @memberof AccountUpdate
     */
    'opening_balance_date'?: string | null;
    /**
     *
     * @type {string}
     * @memberof AccountUpdate
     */
    'virtual_balance'?: string;
    /**
     * Use either currency_id or currency_code. Defaults to the user\'s default currency.
     * @type {string}
     * @memberof AccountUpdate
     */
    'currency_id'?: string;
    /**
     * Use either currency_id or currency_code. Defaults to the user\'s default currency.
     * @type {string}
     * @memberof AccountUpdate
     */
    'currency_code'?: string;
    /**
     * If omitted, defaults to true.
     * @type {boolean}
     * @memberof AccountUpdate
     */
    'active'?: boolean;
    /**
     * Order of the account
     * @type {number}
     * @memberof AccountUpdate
     */
    'order'?: number;
    /**
     * If omitted, defaults to true.
     * @type {boolean}
     * @memberof AccountUpdate
     */
    'include_net_worth'?: boolean;
    /**
     *
     * @type {AccountRoleProperty}
     * @memberof AccountUpdate
     */
    'account_role'?: AccountRoleProperty | null;
    /**
     *
     * @type {CreditCardType}
     * @memberof AccountUpdate
     */
    'credit_card_type'?: CreditCardType | null;
    /**
     * Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank.
     * @type {string}
     * @memberof AccountUpdate
     */
    'monthly_payment_date'?: string | null;
    /**
     *
     * @type {LiabilityType}
     * @memberof AccountUpdate
     */
    'liability_type'?: LiabilityType | null;
    /**
     * Mandatory when type is liability. Interest percentage.
     * @type {string}
     * @memberof AccountUpdate
     */
    'interest'?: string | null;
    /**
     *
     * @type {InterestPeriod}
     * @memberof AccountUpdate
     */
    'interest_period'?: InterestPeriod | null;
    /**
     *
     * @type {string}
     * @memberof AccountUpdate
     */
    'notes'?: string | null;
    /**
     * 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.
     * @type {number}
     * @memberof AccountUpdate
     */
    'latitude'?: number | null;
    /**
     * 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.
     * @type {number}
     * @memberof AccountUpdate
     */
    'longitude'?: number | null;
    /**
     * 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.
     * @type {number}
     * @memberof AccountUpdate
     */
    'zoom_level'?: number | null;
}
/**
 * The object class to which the attachment must be linked.
 * @export
 * @enum {string}
 */
export declare const AttachableType: {
    readonly Account: "Account";
    readonly Budget: "Budget";
    readonly Bill: "Bill";
    readonly TransactionJournal: "TransactionJournal";
    readonly PiggyBank: "PiggyBank";
    readonly Tag: "Tag";
};
export type AttachableType = typeof AttachableType[keyof typeof AttachableType];
/**
 *
 * @export
 * @interface Attachment
 */
export interface Attachment {
    /**
     *
     * @type {string}
     * @memberof Attachment
     */
    'created_at'?: string;
    /**
     *
     * @type {string}
     * @memberof Attachment
     */
    'updated_at'?: string;
    /**
     *
     * @type {AttachableType}
     * @memberof Attachment
     */
    'attachable_type': AttachableType;
    /**
     * ID of the model this attachment is linked to.
     * @type {string}
     * @memberof Attachment
     */
    'attachable_id': string;
    /**
     * MD5 hash of the file for basic duplicate detection.
     * @type {string}
     * @memberof Attachment
     */
    'md5'?: string;
    /**
     *
     * @type {string}
     * @memberof Attachment
     */
    'filename': string;
    /**
     *
     * @type {string}
     * @memberof Attachment
     */
    'download_url'?: string;
    /**
     *
     * @type {string}
     * @memberof Attachment
     */
    'upload_url'?: string;
    /**
     *
     * @type {string}
     * @memberof Attachment
     */
    'title'?: string;
    /**
     *
     * @type {string}
     * @memberof Attachment
     */
    'notes'?: string | null;
    /**
     *
     * @type {string}
     * @memberof Attachment
     */
    'mime'?: string;
    /**
     *
     * @type {number}
     * @memberof Attachment
     */
    'size'?: number;
}
/**
 *
 * @export
 * @interface AttachmentArray
 */
export interface AttachmentArray {
    /**
     *
     * @type {Array<AttachmentRead>}
     * @memberof AttachmentArray
     */
    'data': Array<AttachmentRead>;
    /**
     *
     * @type {Meta}
     * @memberof AttachmentArray
     */
    'meta': Meta;
}
/**
 *
 * @export
 * @interface AttachmentRead
 */
export interface AttachmentRead {
    /**
     * Immutable value
     * @type {string}
     * @memberof AttachmentRead
     */
    'type': string;
    /**
     *
     * @type {string}
     * @memberof AttachmentRead
     */
    'id': string;
    /**
     *
     * @type {Attachment}
     * @memberof AttachmentRead
     */
    'attributes': Attachment;
    /**
     *
     * @type {ObjectLink}
     * @memberof AttachmentRead
     */
    'links': ObjectLink;
}
/**
 *
 * @export
 * @interface AttachmentSingle
 */
export interface AttachmentSingle {
    /**
     *
     * @type {AttachmentRead}
     * @memberof AttachmentSingle
     */
    'data': AttachmentRead;
}
/**
 *
 * @export
 * @interface AttachmentStore
 */
export interface AttachmentStore {
    /**
     *
     * @type {string}
     * @memberof AttachmentStore
     */
    'filename': string;
    /**
     *
     * @type {AttachableType}
     * @memberof AttachmentStore
     */
    'attachable_type': AttachableType;
    /**
     * ID of the model this attachment is linked to.
     * @type {string}
     * @memberof AttachmentStore
     */
    'attachable_id': string;
    /**
     *
     * @type {string}
     * @memberof AttachmentStore
     */
    'title'?: string;
    /**
     *
     * @type {string}
     * @memberof AttachmentStore
     */
    'notes'?: string | null;
}
/**
 *
 * @export
 * @interface AttachmentUpdate
 */
export interface AttachmentUpdate {
    /**
     *
     * @type {string}
     * @memberof AttachmentUpdate
     */
    'filename'?: string;
    /**
     *
     * @type {string}
     * @memberof AttachmentUpdate
     */
    'title'?: string;
    /**
     *
     * @type {string}
     * @memberof AttachmentUpdate
     */
    'notes'?: string | null;
}
/**
 * Period for the auto budget
 * @export
 * @enum {string}
 */
export declare const AutoBudgetPeriod: {
    readonly Daily: "daily";
    readonly Weekly: "weekly";
    readonly Monthly: "monthly";
    readonly Quarterly: "quarterly";
    readonly HalfYear: "half-year";
    readonly Yearly: "yearly";
    readonly Null: "null";
};
export type AutoBudgetPeriod = typeof AutoBudgetPeriod[keyof typeof AutoBudgetPeriod];
/**
 * The type of auto-budget that Firefly III must create.
 * @export
 * @enum {string}
 */
export declare const AutoBudgetType: {
    readonly Reset: "reset";
    readonly Rollover: "rollover";
    readonly None: "none";
    readonly Null: "null";
};
export type AutoBudgetType = typeof AutoBudgetType[keyof typeof AutoBudgetType];
/**
 *
 * @export
 * @interface AutocompleteAccount
 */
export interface AutocompleteAccount {
    /**
     *
     * @type {string}
     * @memberof AutocompleteAccount
     */
    'id': string;
    /**
     * Name of the account found by an auto-complete search.
     * @type {string}
     * @memberof AutocompleteAccount
     */
    'name': string;
    /**
     * Asset accounts and liabilities have a second field with the given date\'s account balance.
     * @type {string}
     * @memberof AutocompleteAccount
     */
    'name_with_balance': string;
    /**
     * Account type of the account found by the auto-complete search.
     * @type {string}
     * @memberof AutocompleteAccount
     */
    'type': string;
    /**
     * ID for the currency used by this account.
     * @type {string}
     * @memberof AutocompleteAccount
     */
    'currency_id': string;
    /**
     * Currency name for the currency used by this account.
     * @type {string}
     * @memberof AutocompleteAccount
     */
    'currency_name': string;
    /**
     * Currency code for the currency used by this account.
     * @type {string}
     * @memberof AutocompleteAccount
     */
    'currency_code': string;
    /**
     * Currency symbol for the currency used by this account.
     * @type {string}
     * @memberof AutocompleteAccount
     */
    'currency_symbol': string;
    /**
     * Number of decimal places for the currency used by this account.
     * @type {number}
     * @memberof AutocompleteAccount
     */
    'currency_decimal_places': number;
}
/**
 *
 * @export
 * @interface AutocompleteBill
 */
export interface AutocompleteBill {
    /**
     *
     * @type {string}
     * @memberof AutocompleteBill
     */
    'id': string;
    /**
     * Name of the bill found by an auto-complete search.
     * @type {string}
     * @memberof AutocompleteBill
     */
    'name': string;
    /**
     * Is the bill active or not?
     * @type {boolean}
     * @memberof AutocompleteBill
     */
    'active'?: boolean;
}
/**
 *
 * @export
 * @interface AutocompleteBudget
 */
export interface AutocompleteBudget {
    /**
     *
     * @type {string}
     * @memberof AutocompleteBudget
     */
    'id': string;
    /**
     * Name of the budget found by an auto-complete search.
     * @type {string}
     * @memberof AutocompleteBudget
     */
    'name': string;
}
/**
 *
 * @export
 * @interface AutocompleteCategory
 */
export interface AutocompleteCategory {
    /**
     *
     * @type {string}
     * @memberof AutocompleteCategory
     */
    'id': string;
    /**
     * Name of the category found by an auto-complete search.
     * @type {string}
     * @memberof AutocompleteCategory
     */
    'name': string;
}
/**
 *
 * @export
 * @interface AutocompleteCurrency
 */
export interface AutocompleteCurrency {
    /**
     *
     * @type {string}
     * @memberof AutocompleteCurrency
     */
    'id': string;
    /**
     * Currency name.
     * @type {string}
     * @memberof AutocompleteCurrency
     */
    'name': string;
    /**
     * Currency code.
     * @type {string}
     * @memberof AutocompleteCurrency
     */
    'code': string;
    /**
     *
     * @type {string}
     * @memberof AutocompleteCurrency
     */
    'symbol': string;
    /**
     *
     * @type {number}
     * @memberof AutocompleteCurrency
     */
    'decimal_places': number;
}
/**
 *
 * @export
 * @interface AutocompleteCurrencyCode
 */
export interface AutocompleteCurrencyCode {
    /**
     *
     * @type {string}
     * @memberof AutocompleteCurrencyCode
     */
    'id': string;
    /**
     * Currency name with the code between brackets.
     * @type {string}
     * @memberof AutocompleteCurrencyCode
     */
    'name': string;
    /**
     * Currency code.
     * @type {string}
     * @memberof AutocompleteCurrencyCode
     */
    'code': string;
    /**
     *
     * @type {string}
     * @memberof AutocompleteCurrencyCode
     */
    'symbol': string;
    /**
     *
     * @type {number}
     * @memberof AutocompleteCurrencyCode
     */
    'decimal_places': number;
}
/**
 *
 * @export
 * @interface AutocompleteObjectGroup
 */
export interface AutocompleteObjectGroup {
    /**
     *
     * @type {string}
     * @memberof AutocompleteObjectGroup
     */
    'id': string;
    /**
     * Title of the object group found by an auto-complete search.
     * @type {string}
     * @memberof AutocompleteObjectGroup
     */
    'title': string;
    /**
     * Title of the object group found by an auto-complete search.
     * @type {string}
     * @memberof AutocompleteObjectGroup
     */
    'name': string;
}
/**
 *
 * @export
 * @interface AutocompletePiggy
 */
export interface AutocompletePiggy {
    /**
     *
     * @type {string}
     * @memberof AutocompletePiggy
     */
    'id': string;
    /**
     * Name of the piggy bank found by an auto-complete search.
     * @type {string}
     * @memberof AutocompletePiggy
     */
    'name': string;
    /**
     * Currency ID for this piggy bank.
     * @type {string}
     * @memberof AutocompletePiggy
     */
    'currency_id'?: string;
    /**
     * Currency code for this piggy bank.
     * @type {string}
     * @memberof AutocompletePiggy
     */
    'currency_code'?: string;
    /**
     *
     * @type {string}
     * @memberof AutocompletePiggy
     */
    'currency_symbol'?: string;
    /**
     * Currency name for the currency used by this account.
     * @type {string}
     * @memberof AutocompletePiggy
     */
    'currency_name'?: string;
    /**
     *
     * @type {number}
     * @memberof AutocompletePiggy
     */
    'currency_decimal_places'?: number;
    /**
     * The group ID of the group this object is part of. NULL if no group.
     * @type {string}
     * @memberof AutocompletePiggy
     */
    'object_group_id'?: string | null;
    /**
     * The name of the group. NULL if no group.
     * @type {string}
     * @memberof AutocompletePiggy
     */
    'object_group_title'?: string | null;
}
/**
 *
 * @export
 * @interface AutocompletePiggyBalance
 */
export interface AutocompletePiggyBalance {
    /**
     *
     * @type {string}
     * @memberof AutocompletePiggyBalance
     */
    'id': string;
    /**
     * Name of the piggy bank found by an auto-complete search.
     * @type {string}
     * @memberof AutocompletePiggyBalance
     */
    'name': string;
    /**
     * Name of the piggy bank found by an auto-complete search with the current balance formatted nicely.
     * @type {string}
     * @memberof AutocompletePiggyBalance
     */
    'name_with_balance'?: string;
    /**
     * Currency ID for this piggy bank.
     * @type {string}
     * @memberof AutocompletePiggyBalance
     */
    'currency_id'?: string;
    /**
     * Currency code for this piggy bank.
     * @type {string}
     * @memberof AutocompletePiggyBalance
     */
    'currency_code'?: string;
    /**
     *
     * @type {string}
     * @memberof AutocompletePiggyBalance
     */
    'currency_symbol'?: string;
    /**
     *
     * @type {number}
     * @memberof AutocompletePiggyBalance
     */
    'currency_decimal_places'?: number;
    /**
     * The group ID of the group this object is part of. NULL if no group.
     * @type {string}
     * @memberof AutocompletePiggyBalance
     */
    'object_group_id'?: string | null;
    /**
     * The name of the group. NULL if no group.
     * @type {string}
     * @memberof AutocompletePiggyBalance
     */
    'object_group_title'?: string | null;
}
/**
 *
 * @export
 * @interface AutocompleteRecurrence
 */
export interface AutocompleteRecurrence {
    /**
     *
     * @type {string}
     * @memberof AutocompleteRecurrence
     */
    'id': string;
    /**
     * Name of the recurrence found by an auto-complete search.
     * @type {string}
     * @memberof AutocompleteRecurrence
     */
    'name': string;
    /**
     * Description of the recurrence found by auto-complete.
     * @type {string}
     * @memberof AutocompleteRecurrence
     */
    'description'?: string;
}
/**
 *
 * @export
 * @interface AutocompleteRule
 */
export interface AutocompleteRule {
    /**
     *
     * @type {string}
     * @memberof AutocompleteRule
     */
    'id': string;
    /**
     * Name of the rule found by an auto-complete search.
     * @type {string}
     * @memberof AutocompleteRule
     */
    'name': string;
    /**
     * Description of the rule found by auto-complete.
     * @type {string}
     * @memberof AutocompleteRule
     */
    'description'?: string;
}
/**
 *
 * @export
 * @interface AutocompleteRuleGroup
 */
export interface AutocompleteRuleGroup {
    /**
     *
     * @type {string}
     * @memberof AutocompleteRuleGroup
     */
    'id': string;
    /**
     * Name of the rule group found by an auto-complete search.
     * @type {string}
     * @memberof AutocompleteRuleGroup
     */
    'name': string;
    /**
     * Description of the rule group found by auto-complete.
     * @type {string}
     * @memberof AutocompleteRuleGroup
     */
    'description'?: string;
}
/**
 *
 * @export
 * @interface AutocompleteTag
 */
export interface AutocompleteTag {
    /**
     *
     * @type {string}
     * @memberof AutocompleteTag
     */
    'id': string;
    /**
     * Name of the tag found by an auto-complete search.
     * @type {string}
     * @memberof AutocompleteTag
     */
    'name': string;
    /**
     * Name of the tag found by an auto-complete search.
     * @type {string}
     * @memberof AutocompleteTag
     */
    'tag': string;
}
/**
 *
 * @export
 * @interface AutocompleteTransaction
 */
export interface AutocompleteTransaction {
    /**
     * The ID of a transaction journal (basically a single split).
     * @type {string}
     * @memberof AutocompleteTransaction
     */
    'id': string;
    /**
     * The ID of the underlying transaction group.
     * @type {string}
     * @memberof AutocompleteTransaction
     */
    'transaction_group_id'?: string;
    /**
     * Transaction description
     * @type {string}
     * @memberof AutocompleteTransaction
     */
    'name': string;
    /**
     * Transaction description
     * @type {string}
     * @memberof AutocompleteTransaction
     */
    'description': string;
}
/**
 *
 * @export
 * @interface AutocompleteTransactionID
 */
export interface AutocompleteTransactionID {
    /**
     * The ID of a transaction journal (basically a single split).
     * @type {string}
     * @memberof AutocompleteTransactionID
     */
    'id': string;
    /**
     * The ID of the underlying transaction group.
     * @type {string}
     * @memberof AutocompleteTransactionID
     */
    'transaction_group_id'?: string;
    /**
     * Transaction description with ID in the name.
     * @type {string}
     * @memberof AutocompleteTransactionID
     */
    'name': string;
    /**
     * Transaction description with ID in the name.
     * @type {string}
     * @memberof AutocompleteTransactionID
     */
    'description': string;
}
/**
 *
 * @export
 * @interface AutocompleteTransactionType
 */
export interface AutocompleteTransactionType {
    /**
     *
     * @type {string}
     * @memberof AutocompleteTransactionType
     */
    'id': string;
    /**
     * Type of the object found by an auto-complete search.
     * @type {string}
     * @memberof AutocompleteTransactionType
     */
    'name': string;
    /**
     * Name of the object found by an auto-complete search.
     * @type {string}
     * @memberof AutocompleteTransactionType
     */
    'type': string;
}
/**
 *
 * @export
 * @interface AvailableBudget
 */
export interface AvailableBudget {
    /**
     *
     * @type {string}
     * @memberof AvailableBudget
     */
    'created_at'?: string;
    /**
     *
     * @type {string}
     * @memberof AvailableBudget
     */
    'updated_at'?: string;
    /**
     * Use either currency_id or currency_code.
     * @type {string}
     * @memberof AvailableBudget
     */
    'currency_id'?: string;
    /**
     * Use either currency_id or currency_code.
     * @type {string}
     * @memberof AvailableBudget
     */
    'currency_code'?: string;
    /**
     *
     * @type {string}
     * @memberof AvailableBudget
     */
    'currency_symbol'?: string;
    /**
     *
     * @type {number}
     * @memberof AvailableBudget
     */
    'currency_decimal_places'?: number;
    /**
     *
     * @type {string}
     * @memberof AvailableBudget
     */
    'amount': string;
    /**
     * Start date of the available budget.
     * @type {string}
     * @memberof AvailableBudget
     */
    'start': string;
    /**
     * End date of the available budget.
     * @type {string}
     * @memberof AvailableBudget
     */
    'end': string;
    /**
     *
     * @type {Array<BudgetSpent>}
     * @memberof AvailableBudget
     */
    'spent_in_budgets'?: Array<BudgetSpent>;
    /**
     *
     * @type {Array<BudgetSpent>}
     * @memberof AvailableBudget
     */
    'spent_outside_budget'?: Array<BudgetSpent>;
}
/**
 *
 * @export
 * @interface AvailableBudgetArray
 */
export interface AvailableBudgetArray {
    /**
     *
     * @type {Array<AvailableBudgetRead>}
     * @memberof AvailableBudgetArray
     */
    'data': Array<AvailableBudgetRead>;
    /**
     *
     * @type {Meta}
     * @memberof AvailableBudgetArray
     */
    'meta': Meta;
}
/**
 *
 * @export
 * @interface AvailableBudgetRead
 */
export interface AvailableBudgetRead {
    /**
     * Immutable value
     * @type {string}
     * @memberof AvailableBudgetRead
     */
    'type': string;
    /**
     *
     * @type {string}
     * @memberof AvailableBudgetRead
     */
    'id': string;
    /**
     *
     * @type {AvailableBudget}
     * @memberof AvailableBudgetRead
     */
    'attributes': AvailableBudget;
}
/**
 *
 * @export
 * @interface AvailableBudgetSingle
 */
export interface AvailableBudgetSingle {
    /**
     *
     * @type {AvailableBudgetRead}
     * @memberof AvailableBudgetSingle
     */
    'data': AvailableBudgetRead;
}
/**
 *
 * @export
 * @interface AvailableBudgetStore
 */
export interface AvailableBudgetStore {
    /**
     * Use either currency_id or currency_code.
     * @type {string}
     * @memberof AvailableBudgetStore
     */
    'currency_id'?: string;
    /**
     * Use either currency_id or currency_code.
     * @type {string}
     * @memberof AvailableBudgetStore
     */
    'currency_code'?: string;
    /**
     *
     * @type {string}
     * @memberof AvailableBudgetStore
     */
    'amount': string;
    /**
     * Start date of the available budget.
     * @type {string}
     * @memberof AvailableBudgetStore
     */
    'start': string;
    /**
     * End date of the available budget.
     * @type {string}
     * @memberof AvailableBudgetStore
     */
    'end': string;
}
/**
 *
 * @export
 * @interface AvailableBudgetUpdate
 */
export interface AvailableBudgetUpdate {
    /**
     * Use either currency_id or currency_code.
     * @type {string}
     * @memberof AvailableBudgetUpdate
     */
    'currency_id'?: string;
    /**
     * Use either currency_id or currency_code.
     * @type {string}
     * @memberof AvailableBudgetUpdate
     */
    'currency_code'?: string;
    /**
     *
     * @type {string}
     * @memberof AvailableBudgetUpdate
     */
    'amount'?: string;
    /**
     * Start date of the available budget.
     * @type {string}
     * @memberof AvailableBudgetUpdate
     */
    'start'?: string;
    /**
     * End date of the available budget.
     * @type {string}
     * @memberof AvailableBudgetUpdate
     */
    'end'?: string;
}
/**
 *
 * @export
 * @interface BadRequest
 */
export interface BadRequest {
    /**
     *
     * @type {string}
     * @memberof BadRequest
     */
    'message'?: string;
    /**
     *
     * @type {string}
     * @memberof BadRequest
     */
    'exception'?: string;
}
/**
 *
 * @export
 * @interface BasicSummaryEntry
 */
export interface BasicSummaryEntry {
    /**
     * 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.
     * @type {string}
     * @memberof BasicSummaryEntry
     */
    'key'?: string;
    /**
     * A translated title for the information shared.
     * @type {string}
     * @memberof BasicSummaryEntry
     */
    'title'?: string;
    /**
     * The amount as a float.
     * @type {number}
     * @memberof BasicSummaryEntry
     */
    'monetary_value'?: number;
    /**
     * The currency ID of the associated currency.
     * @type {string}
     * @memberof BasicSummaryEntry
     */
    'currency_id'?: string;
    /**
     *
     * @type {string}
     * @memberof BasicSummaryEntry
     */
    'currency_code'?: string;
    /**
     *
     * @type {string}
     * @memberof BasicSummaryEntry
     */
    'currency_symbol'?: string;
    /**
     * Number of decimals for the associated currency.
     * @type {number}
     * @memberof BasicSummaryEntry
     */
    'currency_decimal_places'?: number;
    /**
     * The amount formatted according to the users locale
     * @type {string}
     * @memberof BasicSummaryEntry
     */
    'value_parsed'?: string;
    /**
     * Reference to a font-awesome icon without the fa- part.
     * @type {string}
     * @memberof BasicSummaryEntry
     */
    'local_icon'?: string;
    /**
     * A short explanation of the amounts origin. Already formatted according to the locale of the user or translated, if relevant.
     * @type {string}
     * @memberof BasicSummaryEntry
     */
    'sub_title'?: string;
}
/**
 *
 * @export
 * @interface Bill
 */
export interface Bill {
    /**
     *
     * @type {string}
     * @memberof Bill
     */
    'created_at'?: string;
    /**
     *
     * @type {string}
     * @memberof Bill
     */
    'updated_at'?: string;
    /**
     * Use either currency_id or currency_code
     * @type {string}
     * @memberof Bill
     */
    'currency_id'?: string;
    /**
     * Use either currency_id or currency_code
     * @type {string}
     * @memberof Bill
     */
    'currency_code'?: string;
    /**
     *
     * @type {string}
     * @memberof Bill
     */
    'currency_symbol'?: string;
    /**
     *
     * @type {number}
     * @memberof Bill
     */
    'currency_decimal_places'?: number;
    /**
     *
     * @type {string}
     * @memberof Bill
     */
    'name': string;
    /**
     *
     * @type {string}
     * @memberof Bill
     */
    'amount_min': string;
    /**
     *
     * @type {string}
     * @memberof Bill
     */
    'amount_max': string;
    /**
     *
     * @type {string}
     * @memberof Bill
     */
    'date': string;
    /**
     * The date after which this bill is no longer valid or applicable
     * @type {string}
     * @memberof Bill
     */
    'end_date'?: string;
    /**
     * The date before which the bill must be renewed (or cancelled)
     * @type {string}
     * @memberof Bill
     */
    'extension_date'?: string;
    /**
     *
     * @type {BillRepeatFrequency}
     * @memberof Bill
     */
    'repeat_freq': BillRepeatFrequency;
    /**
     * How often the bill must be skipped. 1 means a bi-monthly bill.
     * @type {number}
     * @memberof Bill
     */
    'skip'?: number;
    /**
     * If the bill is active.
     * @type {boolean}
     * @memberof Bill
     */
    'active'?: boolean;
    /**
     * Order of the bill.
     * @type {number}
     * @memberof Bill
     */
    'order'?: number;
    /**
     *
     * @type {string}
     * @memberof Bill
     */
    'notes'?: string | null;
    /**
     * When the bill is expected to be due.
     * @type {string}
     * @memberof Bill
     */
    'next_expected_match'?: string | null;
    /**
     * Formatted (locally) when the bill is due.
     * @type {string}
     * @memberof Bill
     */
    'next_expected_match_diff'?: string | null;
    /**
     * The group ID of the group this object is part of. NULL if no group.
     * @type {string}
     * @memberof Bill
     */
    'object_group_id'?: string | null;
    /**
     * The order of the group. At least 1, for the highest sorting.
     * @type {number}
     * @memberof Bill
     */
    'object_group_order'?: number | null;
    /**
     * The name of the group. NULL if no group.
     * @type {string}
     * @memberof Bill
     */
    'object_group_title'?: string | null;
    /**
     * Array of future dates when the bill is expected to be paid. Autogenerated.
     * @type {Array<string>}
     * @memberof Bill
     */
    'pay_dates'?: Array<string>;
    /**
     * Array of past transactions when the bill was paid.
     * @type {Array<BillPaidDatesInner>}
     * @memberof Bill
     */
    'paid_dates'?: Array<BillPaidDatesInner>;
}
/**
 *
 * @export
 * @interface BillArray
 */
export interface BillArray {
    /**
     *
     * @type {Array<BillRead>}
     * @memberof BillArray
     */
    'data': Array<BillRead>;
    /**
     *
     * @type {Meta}
     * @memberof BillArray
     */
    'meta': Meta;
}
/**
 *
 * @export
 * @interface BillPaidDatesInner
 */
export interface BillPaidDatesInner {
    /**
     * Transaction group ID of the paid bill.
     * @type {string}
     * @memberof BillPaidDatesInner
     */
    'transaction_group_id'?: string;
    /**
     * Transaction journal ID of the paid bill.
     * @type {string}
     * @memberof BillPaidDatesInner
     */
    'transaction_journal_id'?: string;
    /**
     * Date the bill was paid.
     * @type {string}
     * @memberof BillPaidDatesInner
     */
    'date'?: string;
}
/**
 *
 * @export
 * @interface BillRead
 */
export interface BillRead {
    /**
     * Immutable value
     * @type {string}
     * @memberof BillRead
     */
    'type': string;
    /**
     *
     * @type {string}
     * @memberof BillRead
     */
    'id': string;
    /**
     *
     * @type {Bill}
     * @memberof BillRead
     */
    'attributes': Bill;
}
/**
 * How often the bill must be paid.
 * @export
 * @enum {string}
 */
export declare const BillRepeatFrequency: {
    readonly Weekly: "weekly";
    readonly Monthly: "monthly";
    readonly Quarterly: "quarterly";
    readonly HalfYear: "half-year";
    readonly Yearly: "yearly";
};
export type BillRepeatFrequency = typeof BillRepeatFrequency[keyof typeof BillRepeatFrequency];
/**
 *
 * @export
 * @interface BillSingle
 */
export interface BillSingle {
    /**
     *
     * @type {BillRead}
     * @memberof BillSingle
     */
    'data': BillRead;
}
/**
 *
 * @export
 * @interface BillStore
 */
export interface BillStore {
    /**
     * Use either currency_id or currency_code
     * @type {string}
     * @memberof BillStore
     */
    'currency_id'?: string;
    /**
     * Use either currency_id or currency_code
     * @type {string}
     * @memberof BillStore
     */
    'currency_code'?: string;
    /**
     *
     * @type {string}
     * @memberof BillStore
     */
    'name': string;
    /**
     *
     * @type {string}
     * @memberof BillStore
     */
    'amount_min': string;
    /**
     *
     * @type {string}
     * @memberof BillStore
     */
    'amount_max': string;
    /**
     *
     * @type {string}
     * @memberof BillStore
     */
    'date': string;
    /**
     * The date after which this bill is no longer valid or applicable
     * @type {string}
     * @memberof BillStore
     */
    'end_date'?: string;
    /**
     * The date before which the bill must be renewed (or cancelled)
     * @type {string}
     * @memberof BillStore
     */
    'extension_date'?: string;
    /**
     *
     * @type {BillRepeatFrequency}
     * @memberof BillStore
     */
    'repeat_freq': BillRepeatFrequency;
    /**
     * How often the bill must be skipped. 1 means a bi-monthly bill.
     * @type {number}
     * @memberof BillStore
     */
    'skip'?: number;
    /**
     * If the bill is active.
     * @type {boolean}
     * @memberof BillStore
     */
    'active'?: boolean;
    /**
     *
     * @type {string}
     * @memberof BillStore
     */
    'notes'?: string | null;
    /**
     * The group ID of the group this object is part of. NULL if no group.
     * @type {string}
     * @memberof BillStore
     */
    'object_group_id'?: string | null;
    /**
     * The name of the group. NULL if no group.
     * @type {string}
     * @memberof BillStore
     */
    'object_group_title'?: string | null;
}
/**
 *
 * @export
 * @interface BillUpdate
 */
export interface BillUpdate {
    /**
     * Use either currency_id or currency_code
     * @type {string}
     * @memberof BillUpdate
     */
    'currency_id'?: string;
    /**
     * Use either currency_id or currency_code
     * @type {string}
     * @memberof BillUpdate
     */
    'currency_code'?: string;
    /**
     *
     * @type {string}
     * @memberof BillUpdate
     */
    'name'?: string;
    /**
     *
     * @type {string}
     * @memberof BillUpdate
     */
    'amount_min'?: string;
    /**
     *
     * @type {string}
     * @memberof BillUpdate
     */
    'amount_max'?: string;
    /**
     *
     * @type {string}
     * @memberof BillUpdate
     */
    'date'?: string;
    /**
     * The date after which this bill is no longer valid or applicable
     * @type {string}
     * @memberof BillUpdate
     */
    'end_date'?: string;
    /**
     * The date before which the bill must be renewed (or cancelled)
     * @type {string}
     * @memberof BillUpdate
     */
    'extension_date'?: string;
    /**
     *
     * @type {BillRepeatFrequency}
     * @memberof BillUpdate
     */
    'repeat_freq'?: BillRepeatFrequency;
    /**
     * How often the bill must be skipped. 1 means a bi-monthly bill.
     * @type {number}
     * @memberof BillUpdate
     */
    'skip'?: number;
    /**
     * If the bill is active.
     * @type {boolean}
     * @memberof BillUpdate
     */
    'active'?: boolean;
    /**
     *
     * @type {string}
     * @memberof BillUpdate
     */
    'notes'?: string | null;
    /**
     * The group ID of the group this object is part of. NULL if no group.
     * @type {string}
     * @memberof BillUpdate
     */
    'object_group_id'?: string | null;
    /**
     * The name of the group. NULL if no group.
     * @type {string}
     * @memberof BillUpdate
     */
    'object_group_title'?: string | null;
}
/**
 *
 * @export
 * @interface Budget
 */
export interface Budget {
    /**
     *
     * @type {string}
     * @memberof Budget
     */
    'created_at'?: string;
    /**
     *
     * @type {string}
     * @memberof Budget
     */
    'updated_at'?: string;
    /**
     *
     * @type {string}
     * @memberof Budget
     */
    'name': string;
    /**
     *
     * @type {boolean}
     * @memberof Budget
     */
    'active'?: boolean;
    /**
     *
     * @type {string}
     * @memberof Budget
     */
    'notes'?: string | null;
    /**
     *
     * @type {number}
     * @memberof Budget
     */
    'order'?: number;
    /**
     *
     * @type {AutoBudgetType}
     * @memberof Budget
     */
    'auto_budget_type'?: AutoBudgetType | null;
    /**
     * Use either currency_id or currency_code. Defaults to the user\'s default currency.
     * @type {string}
     * @memberof Budget
     */
    'auto_budget_currency_id'?: string | null;
    /**
     * Use either currency_id or currency_code. Defaults to the user\'s default currency.
     * @type {string}
     * @memberof Budget
     */
    'auto_budget_currency_code'?: string | null;
    /**
     *
     * @type {string}
     * @memberof Budget
     */
    'auto_budget_amount'?: string | null;
    /**
     *
     * @type {AutoBudgetPeriod}
     * @memberof Budget
     */
    'auto_budget_period'?: AutoBudgetPeriod | null;
    /**
     * Information on how much was spent in this budget. Is only filled in when the start and end date are submitted.
     * @type {Array<BudgetSpent>}
     * @memberof Budget
     */
    'spent'?: Array<BudgetSpent>;
}
/**
 *
 * @export
 * @interface BudgetArray
 */
export interface BudgetArray {
    /**
     *
     * @type {Array<BudgetRead>}
     * @memberof BudgetArray
     */
    'data': Array<BudgetRead>;
    /**
     *
     * @type {Meta}
     * @memberof BudgetArray
     */
    'meta': Meta;
}
/**
 *
 * @export
 * @interface BudgetLimit
 */
export interface BudgetLimit {
    /**
     *
     * @type {string}
     * @memberof BudgetLimit
     */
    'created_at'?: string;
    /**
     *
     * @type {string}
     * @memberof BudgetLimit
     */
    'updated_at'?: string;
    /**
     * Start date of the budget limit.
     * @type {string}
     * @memberof BudgetLimit
     */
    'start': string;
    /**
     * End date of the budget limit.
     * @type {string}
     * @memberof BudgetLimit
     */
    'end': string;
    /**
     * Use either currency_id or currency_code. Defaults to the user\'s default currency.
     * @type {string}
     * @memberof BudgetLimit
     */
    'currency_id'?: string;
    /**
     * Use either currency_id or currency_code. Defaults to the user\'s default currency.
     * @type {string}
     * @memberof BudgetLimit
     */
    'currency_code'?: string;
    /**
     *
     * @type {string}
     * @memberof BudgetLimit
     */
    'currency_name'?: string;
    /**
     *
     * @type {string}
     * @memberof BudgetLimit
     */
    'currency_symbol'?: string;
    /**
     *
     * @type {number}
     * @mem