models

type Account struct {

	// The current balance of the account in milliunits format
	// Required: true
	Balance *int64 `json:"balance"`

	// The current cleared balance of the account in milliunits format
	// Required: true
	ClearedBalance *int64 `json:"cleared_balance"`

	// Whether this account is closed or not
	// Required: true
	Closed *bool `json:"closed"`

	// The escrow value(s) for the debt/loan account, by effective date.  The amounts are specified in milliunits format.
	DebtEscrowAmounts LoanAccountPeriodicValue `json:"debt_escrow_amounts,omitempty"`

	// The debt/loan account interest rate(s), by effective date.
	DebtInterestRates LoanAccountPeriodicValue `json:"debt_interest_rates,omitempty"`

	// The minimum payment amount(s) for the debt/loan account, by effective date.  The amounts are specified in milliunits format.
	DebtMinimumPayments LoanAccountPeriodicValue `json:"debt_minimum_payments,omitempty"`

	// The original debt/loan account balance, specified in milliunits format.
	DebtOriginalBalance int64 `json:"debt_original_balance,omitempty"`

	// Whether or not the account has been deleted.  Deleted accounts will only be included in delta requests.
	// Required: true
	Deleted *bool `json:"deleted"`

	// If an account linked to a financial institution (direct_import_linked=true) and the linked connection is not in a healthy state, this will be true.
	DirectImportInError bool `json:"direct_import_in_error,omitempty"`

	// Whether or not the account is linked to a financial institution for automatic transaction import.
	DirectImportLinked bool `json:"direct_import_linked,omitempty"`

	// id
	// Required: true
	// Format: uuid
	ID *strfmt.UUID `json:"id"`

	// A date/time specifying when the account was last reconciled.
	// Format: date-time
	LastReconciledAt strfmt.DateTime `json:"last_reconciled_at,omitempty"`

	// name
	// Required: true
	Name *string `json:"name"`

	// note
	Note string `json:"note,omitempty"`

	// Whether this account is on budget or not
	// Required: true
	OnBudget *bool `json:"on_budget"`

	// The payee id which should be used when transferring to this account
	// Required: true
	// Format: uuid
	TransferPayeeID *strfmt.UUID `json:"transfer_payee_id"`

	// type
	// Required: true
	Type *AccountType `json:"type"`

	// The current uncleared balance of the account in milliunits format
	// Required: true
	UnclearedBalance *int64 `json:"uncleared_balance"`
}

type AccountType string

type BudgetSummary struct {

	// The budget accounts (only included if `include_accounts=true` specified as query parameter)
	Accounts []*Account `json:"accounts"`

	// currency format
	CurrencyFormat *CurrencyFormat `json:"currency_format,omitempty"`

	// date format
	DateFormat *DateFormat `json:"date_format,omitempty"`

	// The earliest budget month
	// Format: date
	FirstMonth strfmt.Date `json:"first_month,omitempty"`

	// id
	// Required: true
	// Format: uuid
	ID *strfmt.UUID `json:"id"`

	// The last time any changes were made to the budget from either a web or mobile client
	// Format: date-time
	LastModifiedOn strfmt.DateTime `json:"last_modified_on,omitempty"`

	// The latest budget month
	// Format: date
	LastMonth strfmt.Date `json:"last_month,omitempty"`

	// name
	// Required: true
	Name *string `json:"name"`
}

type BudgetSummaryResponse struct {

	// data
	// Required: true
	Data *BudgetSummaryResponseData `json:"data"`
}

type BudgetSummaryResponseData struct {

	// budgets
	// Required: true
	Budgets []*BudgetSummary `json:"budgets"`

	// The default budget, if the associated application is configured to support specifying it
	DefaultBudget *BudgetSummary `json:"default_budget,omitempty"`
}

type CurrencyFormat struct {

	// currency symbol
	// Required: true
	CurrencySymbol *string `json:"currency_symbol"`

	// decimal digits
	// Required: true
	DecimalDigits *int32 `json:"decimal_digits"`

	// decimal separator
	// Required: true
	DecimalSeparator *string `json:"decimal_separator"`

	// display symbol
	// Required: true
	DisplaySymbol *bool `json:"display_symbol"`

	// example format
	// Required: true
	ExampleFormat *string `json:"example_format"`

	// group separator
	// Required: true
	GroupSeparator *string `json:"group_separator"`

	// iso code
	// Required: true
	IsoCode *string `json:"iso_code"`

	// symbol first
	// Required: true
	SymbolFirst *bool `json:"symbol_first"`
}

type DateFormat struct {

	// format
	// Required: true
	Format *string `json:"format"`
}

type ErrorDetail struct {

	// detail
	// Required: true
	Detail *string `json:"detail"`

	// id
	// Required: true
	ID *string `json:"id"`

	// name
	// Required: true
	Name *string `json:"name"`
}

type ErrorResponse struct {

	// error
	// Required: true
	Error *ErrorDetail `json:"error"`
}

type LoanAccountPeriodicValue map[string]int64

type PostTransactionsWrapper struct {

	// transaction
	Transaction *SaveTransaction `json:"transaction,omitempty"`

	// transactions
	Transactions []*SaveTransaction `json:"transactions"`
}

type SaveSubTransaction struct {

	// The subtransaction amount in milliunits format.
	// Required: true
	Amount *int64 `json:"amount"`

	// The category for the subtransaction.  Credit Card Payment categories are not permitted and will be ignored if supplied.
	// Format: uuid
	CategoryID strfmt.UUID `json:"category_id,omitempty"`

	// memo
	// Max Length: 200
	Memo string `json:"memo,omitempty"`

	// The payee for the subtransaction.
	// Format: uuid
	PayeeID strfmt.UUID `json:"payee_id,omitempty"`

	// The payee name.  If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if import_id is also specified on parent transaction) or (2) a payee with the same name or (3) creation of a new payee.
	// Max Length: 50
	PayeeName string `json:"payee_name,omitempty"`
}

type SaveTransaction struct {

	// account id
	// Required: true
	// Format: uuid
	AccountID *strfmt.UUID `json:"account_id"`

	// The transaction amount in milliunits format.  Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
	// Required: true
	Amount *int64 `json:"amount"`

	// The transaction date in ISO format (e.g. 2016-12-01).  Future dates (scheduled transactions) are not permitted.  Split transaction dates cannot be changed and if a different date is supplied it will be ignored.
	// Required: true
	// Format: date
	Date *strfmt.Date `json:"date"`

	SaveTransactionWithOptionalFields
}

type SaveTransactionWithOptionalFields struct {

	// Whether or not the transaction is approved.  If not supplied, transaction will be unapproved by default.
	Approved bool `json:"approved,omitempty"`

	// The category for the transaction.  To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object.  If an existing transaction is a split, the `category_id` cannot be changed.  Credit Card Payment categories are not permitted and will be ignored if supplied.
	// Format: uuid
	CategoryID strfmt.UUID `json:"category_id,omitempty"`

	// The cleared status of the transaction
	// Enum: [cleared uncleared reconciled]
	Cleared string `json:"cleared,omitempty"`

	// The transaction flag
	// Enum: [red orange yellow green blue purple]
	FlagColor *string `json:"flag_color,omitempty"`

	// If specified, the new transaction will be assigned this `import_id` and considered "imported".  We will also attempt to match this imported transaction to an existing "user-entered" transation on the same account, with the same amount, and with a date +/-10 days from the imported transaction date.<br><br>Transactions imported through File Based Import or Direct Import (not through the API) are assigned an import_id in the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'. For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'.  If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'.  Using a consistent format will prevent duplicates through Direct Import and File Based Import.<br><br>If import_id is omitted or specified as null, the transaction will be treated as a "user-entered" transaction. As such, it will be eligible to be matched against transactions later being imported (via DI, FBI, or API).
	// Max Length: 36
	ImportID string `json:"import_id,omitempty"`

	// memo
	// Max Length: 200
	Memo string `json:"memo,omitempty"`

	// The payee for the transaction.  To create a transfer between two accounts, use the account transfer payee pointing to the target account.  Account transfer payees are specified as `tranfer_payee_id` on the account resource.
	// Format: uuid
	PayeeID strfmt.UUID `json:"payee_id,omitempty"`

	// The payee name.  If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee.
	// Max Length: 50
	PayeeName string `json:"payee_name,omitempty"`

	// An array of subtransactions to configure a transaction as a split.  Updating `subtransactions` on an existing split transaction is not supported.
	Subtransactions []*SaveSubTransaction `json:"subtransactions"`
}

type SaveTransactionsResponse struct {

	// data
	// Required: true
	Data *SaveTransactionsResponseData `json:"data"`
}

type SaveTransactionsResponseData struct {

	// If multiple transactions were specified, a list of import_ids that were not created because of an existing `import_id` found on the same account
	DuplicateImportIds []string `json:"duplicate_import_ids"`

	// The knowledge of the server
	// Required: true
	ServerKnowledge *int64 `json:"server_knowledge"`

	// If a single transaction was specified, the transaction that was saved
	Transaction *TransactionDetail `json:"transaction,omitempty"`

	// The transaction ids that were saved
	// Required: true
	TransactionIds []string `json:"transaction_ids"`

	// If multiple transactions were specified, the transactions that were saved
	Transactions []*TransactionDetail `json:"transactions"`
}

type SubTransaction struct {

	// The subtransaction amount in milliunits format
	// Required: true
	Amount *int64 `json:"amount"`

	// category id
	// Format: uuid
	CategoryID strfmt.UUID `json:"category_id,omitempty"`

	// category name
	CategoryName string `json:"category_name,omitempty"`

	// Whether or not the subtransaction has been deleted.  Deleted subtransactions will only be included in delta requests.
	// Required: true
	Deleted *bool `json:"deleted"`

	// id
	// Required: true
	ID *string `json:"id"`

	// memo
	Memo string `json:"memo,omitempty"`

	// payee id
	// Format: uuid
	PayeeID strfmt.UUID `json:"payee_id,omitempty"`

	// payee name
	PayeeName string `json:"payee_name,omitempty"`

	// transaction id
	// Required: true
	TransactionID *string `json:"transaction_id"`

	// If a transfer, the account_id which the subtransaction transfers to
	// Format: uuid
	TransferAccountID strfmt.UUID `json:"transfer_account_id,omitempty"`

	// If a transfer, the id of transaction on the other side of the transfer
	TransferTransactionID string `json:"transfer_transaction_id,omitempty"`
}

type TransactionDetail struct {
	TransactionSummary

	// account name
	// Required: true
	AccountName *string `json:"account_name"`

	// category name
	CategoryName string `json:"category_name,omitempty"`

	// payee name
	PayeeName string `json:"payee_name,omitempty"`

	// If a split transaction, the subtransactions.
	// Required: true
	Subtransactions []*SubTransaction `json:"subtransactions"`
}

type TransactionSummary struct {

	// account id
	// Required: true
	// Format: uuid
	AccountID *strfmt.UUID `json:"account_id"`

	// The transaction amount in milliunits format
	// Required: true
	Amount *int64 `json:"amount"`

	// Whether or not the transaction is approved
	// Required: true
	Approved *bool `json:"approved"`

	// category id
	// Format: uuid
	CategoryID strfmt.UUID `json:"category_id,omitempty"`

	// The cleared status of the transaction
	// Required: true
	// Enum: [cleared uncleared reconciled]
	Cleared *string `json:"cleared"`

	// The transaction date in ISO format (e.g. 2016-12-01)
	// Required: true
	// Format: date
	Date *strfmt.Date `json:"date"`

	// If the transaction is a debt/loan account transaction, the type of transaction
	// Enum: [payment refund fee interest escrow balancedAdjustment credit charge]
	DebtTransactionType *string `json:"debt_transaction_type,omitempty"`

	// Whether or not the transaction has been deleted.  Deleted transactions will only be included in delta requests.
	// Required: true
	Deleted *bool `json:"deleted"`

	// The transaction flag
	// Enum: [red orange yellow green blue purple]
	FlagColor *string `json:"flag_color,omitempty"`

	// id
	// Required: true
	ID *string `json:"id"`

	// If the transaction was imported, this field is a unique (by account) import identifier.  If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'.  For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'.  If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'.
	ImportID string `json:"import_id,omitempty"`

	// If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules
	// Max Length: 200
	ImportPayeeName string `json:"import_payee_name,omitempty"`

	// If the transaction was imported, the original payee name as it appeared on the statement
	// Max Length: 200
	ImportPayeeNameOriginal string `json:"import_payee_name_original,omitempty"`

	// If transaction is matched, the id of the matched transaction
	MatchedTransactionID string `json:"matched_transaction_id,omitempty"`

	// memo
	Memo string `json:"memo,omitempty"`

	// payee id
	// Format: uuid
	PayeeID strfmt.UUID `json:"payee_id,omitempty"`

	// If a transfer transaction, the account to which it transfers
	// Format: uuid
	TransferAccountID strfmt.UUID `json:"transfer_account_id,omitempty"`

	// If a transfer transaction, the id of transaction on the other side of the transfer
	TransferTransactionID string `json:"transfer_transaction_id,omitempty"`
}