models

package
v0.0.0-...-2502b59 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 11, 2023 License: MIT Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// SaveTransactionWithOptionalFieldsClearedCleared captures enum value "cleared"
	SaveTransactionWithOptionalFieldsClearedCleared string = "cleared"

	// SaveTransactionWithOptionalFieldsClearedUncleared captures enum value "uncleared"
	SaveTransactionWithOptionalFieldsClearedUncleared string = "uncleared"

	// SaveTransactionWithOptionalFieldsClearedReconciled captures enum value "reconciled"
	SaveTransactionWithOptionalFieldsClearedReconciled string = "reconciled"
)
View Source 
const (

	// SaveTransactionWithOptionalFieldsFlagColorRed captures enum value "red"
	SaveTransactionWithOptionalFieldsFlagColorRed string = "red"

	// SaveTransactionWithOptionalFieldsFlagColorOrange captures enum value "orange"
	SaveTransactionWithOptionalFieldsFlagColorOrange string = "orange"

	// SaveTransactionWithOptionalFieldsFlagColorYellow captures enum value "yellow"
	SaveTransactionWithOptionalFieldsFlagColorYellow string = "yellow"

	// SaveTransactionWithOptionalFieldsFlagColorGreen captures enum value "green"
	SaveTransactionWithOptionalFieldsFlagColorGreen string = "green"

	// SaveTransactionWithOptionalFieldsFlagColorBlue captures enum value "blue"
	SaveTransactionWithOptionalFieldsFlagColorBlue string = "blue"

	// SaveTransactionWithOptionalFieldsFlagColorPurple captures enum value "purple"
	SaveTransactionWithOptionalFieldsFlagColorPurple string = "purple"
)
View Source 
const (

	// TransactionSummaryClearedCleared captures enum value "cleared"
	TransactionSummaryClearedCleared string = "cleared"

	// TransactionSummaryClearedUncleared captures enum value "uncleared"
	TransactionSummaryClearedUncleared string = "uncleared"

	// TransactionSummaryClearedReconciled captures enum value "reconciled"
	TransactionSummaryClearedReconciled string = "reconciled"
)
View Source 
const (

	// TransactionSummaryDebtTransactionTypePayment captures enum value "payment"
	TransactionSummaryDebtTransactionTypePayment string = "payment"

	// TransactionSummaryDebtTransactionTypeRefund captures enum value "refund"
	TransactionSummaryDebtTransactionTypeRefund string = "refund"

	// TransactionSummaryDebtTransactionTypeFee captures enum value "fee"
	TransactionSummaryDebtTransactionTypeFee string = "fee"

	// TransactionSummaryDebtTransactionTypeInterest captures enum value "interest"
	TransactionSummaryDebtTransactionTypeInterest string = "interest"

	// TransactionSummaryDebtTransactionTypeEscrow captures enum value "escrow"
	TransactionSummaryDebtTransactionTypeEscrow string = "escrow"

	// TransactionSummaryDebtTransactionTypeBalancedAdjustment captures enum value "balancedAdjustment"
	TransactionSummaryDebtTransactionTypeBalancedAdjustment string = "balancedAdjustment"

	// TransactionSummaryDebtTransactionTypeCredit captures enum value "credit"
	TransactionSummaryDebtTransactionTypeCredit string = "credit"

	// TransactionSummaryDebtTransactionTypeCharge captures enum value "charge"
	TransactionSummaryDebtTransactionTypeCharge string = "charge"
)
View Source 
const (

	// TransactionSummaryFlagColorRed captures enum value "red"
	TransactionSummaryFlagColorRed string = "red"

	// TransactionSummaryFlagColorOrange captures enum value "orange"
	TransactionSummaryFlagColorOrange string = "orange"

	// TransactionSummaryFlagColorYellow captures enum value "yellow"
	TransactionSummaryFlagColorYellow string = "yellow"

	// TransactionSummaryFlagColorGreen captures enum value "green"
	TransactionSummaryFlagColorGreen string = "green"

	// TransactionSummaryFlagColorBlue captures enum value "blue"
	TransactionSummaryFlagColorBlue string = "blue"

	// TransactionSummaryFlagColorPurple captures enum value "purple"
	TransactionSummaryFlagColorPurple string = "purple"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Account 

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"`
}

Account account

swagger:model Account

func (*Account) ContextValidate 

func (m *Account) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this account based on the context it is used

func (*Account) MarshalBinary 

func (m *Account) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*Account) UnmarshalBinary 

func (m *Account) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*Account) Validate 

func (m *Account) Validate(formats strfmt.Registry) error

Validate validates this account

type AccountType 

type AccountType string

AccountType The type of account

swagger:model AccountType 

const (

	// AccountTypeChecking captures enum value "checking"
	AccountTypeChecking AccountType = "checking"

	// AccountTypeSavings captures enum value "savings"
	AccountTypeSavings AccountType = "savings"

	// AccountTypeCash captures enum value "cash"
	AccountTypeCash AccountType = "cash"

	// AccountTypeCreditCard captures enum value "creditCard"
	AccountTypeCreditCard AccountType = "creditCard"

	// AccountTypeLineOfCredit captures enum value "lineOfCredit"
	AccountTypeLineOfCredit AccountType = "lineOfCredit"

	// AccountTypeOtherAsset captures enum value "otherAsset"
	AccountTypeOtherAsset AccountType = "otherAsset"

	// AccountTypeOtherLiability captures enum value "otherLiability"
	AccountTypeOtherLiability AccountType = "otherLiability"

	// AccountTypeMortgage captures enum value "mortgage"
	AccountTypeMortgage AccountType = "mortgage"

	// AccountTypeAutoLoan captures enum value "autoLoan"
	AccountTypeAutoLoan AccountType = "autoLoan"

	// AccountTypeStudentLoan captures enum value "studentLoan"
	AccountTypeStudentLoan AccountType = "studentLoan"

	// AccountTypePersonalLoan captures enum value "personalLoan"
	AccountTypePersonalLoan AccountType = "personalLoan"

	// AccountTypeMedicalDebt captures enum value "medicalDebt"
	AccountTypeMedicalDebt AccountType = "medicalDebt"

	// AccountTypeOtherDebt captures enum value "otherDebt"
	AccountTypeOtherDebt AccountType = "otherDebt"
)

func NewAccountType 

func NewAccountType(value AccountType) *AccountType

func (AccountType) ContextValidate 

func (m AccountType) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this account type based on context it is used

func (AccountType) Pointer 

func (m AccountType) Pointer() *AccountType

Pointer returns a pointer to a freshly-allocated AccountType.

func (AccountType) Validate 

func (m AccountType) Validate(formats strfmt.Registry) error

Validate validates this account type

type BudgetSummary 

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"`
}

BudgetSummary budget summary

swagger:model BudgetSummary

func (*BudgetSummary) ContextValidate 

func (m *BudgetSummary) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this budget summary based on the context it is used

func (*BudgetSummary) MarshalBinary 

func (m *BudgetSummary) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BudgetSummary) UnmarshalBinary 

func (m *BudgetSummary) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BudgetSummary) Validate 

func (m *BudgetSummary) Validate(formats strfmt.Registry) error

Validate validates this budget summary

type BudgetSummaryResponse 

type BudgetSummaryResponse struct {

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

BudgetSummaryResponse budget summary response

swagger:model BudgetSummaryResponse

func (*BudgetSummaryResponse) ContextValidate 

func (m *BudgetSummaryResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this budget summary response based on the context it is used

func (*BudgetSummaryResponse) MarshalBinary 

func (m *BudgetSummaryResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BudgetSummaryResponse) UnmarshalBinary 

func (m *BudgetSummaryResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BudgetSummaryResponse) Validate 

func (m *BudgetSummaryResponse) Validate(formats strfmt.Registry) error

Validate validates this budget summary response

type BudgetSummaryResponseData 

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"`
}

BudgetSummaryResponseData budget summary response data

swagger:model BudgetSummaryResponseData

func (*BudgetSummaryResponseData) ContextValidate 

func (m *BudgetSummaryResponseData) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this budget summary response data based on the context it is used

func (*BudgetSummaryResponseData) MarshalBinary 

func (m *BudgetSummaryResponseData) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*BudgetSummaryResponseData) UnmarshalBinary 

func (m *BudgetSummaryResponseData) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*BudgetSummaryResponseData) Validate 

func (m *BudgetSummaryResponseData) Validate(formats strfmt.Registry) error

Validate validates this budget summary response data

type CurrencyFormat 

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"`
}

CurrencyFormat The currency format setting for the budget. In some cases the format will not be available and will be specified as null.

swagger:model CurrencyFormat

func (*CurrencyFormat) ContextValidate 

func (m *CurrencyFormat) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this currency format based on context it is used

func (*CurrencyFormat) MarshalBinary 

func (m *CurrencyFormat) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*CurrencyFormat) UnmarshalBinary 

func (m *CurrencyFormat) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*CurrencyFormat) Validate 

func (m *CurrencyFormat) Validate(formats strfmt.Registry) error

Validate validates this currency format

type DateFormat 

type DateFormat struct {

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

DateFormat The date format setting for the budget. In some cases the format will not be available and will be specified as null.

swagger:model DateFormat

func (*DateFormat) ContextValidate 

func (m *DateFormat) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this date format based on context it is used

func (*DateFormat) MarshalBinary 

func (m *DateFormat) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*DateFormat) UnmarshalBinary 

func (m *DateFormat) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*DateFormat) Validate 

func (m *DateFormat) Validate(formats strfmt.Registry) error

Validate validates this date format

type ErrorDetail 

type ErrorDetail struct {

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

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

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

ErrorDetail error detail

swagger:model ErrorDetail

func (*ErrorDetail) ContextValidate 

func (m *ErrorDetail) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this error detail based on context it is used

func (*ErrorDetail) MarshalBinary 

func (m *ErrorDetail) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ErrorDetail) UnmarshalBinary 

func (m *ErrorDetail) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ErrorDetail) Validate 

func (m *ErrorDetail) Validate(formats strfmt.Registry) error

Validate validates this error detail

type ErrorResponse 

type ErrorResponse struct {

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

ErrorResponse error response

swagger:model ErrorResponse

func (*ErrorResponse) ContextValidate 

func (m *ErrorResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this error response based on the context it is used

func (*ErrorResponse) MarshalBinary 

func (m *ErrorResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*ErrorResponse) UnmarshalBinary 

func (m *ErrorResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*ErrorResponse) Validate 

func (m *ErrorResponse) Validate(formats strfmt.Registry) error

Validate validates this error response

type LoanAccountPeriodicValue 

type LoanAccountPeriodicValue map[string]int64

LoanAccountPeriodicValue loan account periodic value

swagger:model LoanAccountPeriodicValue

func (LoanAccountPeriodicValue) ContextValidate 

func (m LoanAccountPeriodicValue) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this loan account periodic value based on context it is used

func (LoanAccountPeriodicValue) Validate 

func (m LoanAccountPeriodicValue) Validate(formats strfmt.Registry) error

Validate validates this loan account periodic value

type PostTransactionsWrapper 

type PostTransactionsWrapper struct {

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

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

PostTransactionsWrapper post transactions wrapper

swagger:model PostTransactionsWrapper

func (*PostTransactionsWrapper) ContextValidate 

func (m *PostTransactionsWrapper) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this post transactions wrapper based on the context it is used

func (*PostTransactionsWrapper) MarshalBinary 

func (m *PostTransactionsWrapper) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*PostTransactionsWrapper) UnmarshalBinary 

func (m *PostTransactionsWrapper) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*PostTransactionsWrapper) Validate 

func (m *PostTransactionsWrapper) Validate(formats strfmt.Registry) error

Validate validates this post transactions wrapper

type SaveSubTransaction 

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"`
}

SaveSubTransaction save sub transaction

swagger:model SaveSubTransaction

func (*SaveSubTransaction) ContextValidate 

func (m *SaveSubTransaction) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this save sub transaction based on context it is used

func (*SaveSubTransaction) MarshalBinary 

func (m *SaveSubTransaction) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SaveSubTransaction) UnmarshalBinary 

func (m *SaveSubTransaction) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SaveSubTransaction) Validate 

func (m *SaveSubTransaction) Validate(formats strfmt.Registry) error

Validate validates this save sub transaction

type SaveTransaction 

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
}

SaveTransaction save transaction

swagger:model SaveTransaction

func (*SaveTransaction) ContextValidate 

func (m *SaveTransaction) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this save transaction based on the context it is used

func (*SaveTransaction) MarshalBinary 

func (m *SaveTransaction) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (SaveTransaction) MarshalJSON 

func (m SaveTransaction) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

func (*SaveTransaction) UnmarshalBinary 

func (m *SaveTransaction) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SaveTransaction) UnmarshalJSON 

func (m *SaveTransaction) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

func (*SaveTransaction) Validate 

func (m *SaveTransaction) Validate(formats strfmt.Registry) error

Validate validates this save transaction

type 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"`
}

SaveTransactionWithOptionalFields save transaction with optional fields

swagger:model SaveTransactionWithOptionalFields

func (*SaveTransactionWithOptionalFields) ContextValidate 

func (m *SaveTransactionWithOptionalFields) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this save transaction with optional fields based on the context it is used

func (*SaveTransactionWithOptionalFields) MarshalBinary 

func (m *SaveTransactionWithOptionalFields) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SaveTransactionWithOptionalFields) UnmarshalBinary 

func (m *SaveTransactionWithOptionalFields) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SaveTransactionWithOptionalFields) Validate 

func (m *SaveTransactionWithOptionalFields) Validate(formats strfmt.Registry) error

Validate validates this save transaction with optional fields

type SaveTransactionsResponse 

type SaveTransactionsResponse struct {

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

SaveTransactionsResponse save transactions response

swagger:model SaveTransactionsResponse

func (*SaveTransactionsResponse) ContextValidate 

func (m *SaveTransactionsResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this save transactions response based on the context it is used

func (*SaveTransactionsResponse) MarshalBinary 

func (m *SaveTransactionsResponse) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SaveTransactionsResponse) UnmarshalBinary 

func (m *SaveTransactionsResponse) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SaveTransactionsResponse) Validate 

func (m *SaveTransactionsResponse) Validate(formats strfmt.Registry) error

Validate validates this save transactions response

type SaveTransactionsResponseData 

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"`
}

SaveTransactionsResponseData save transactions response data

swagger:model SaveTransactionsResponseData

func (*SaveTransactionsResponseData) ContextValidate 

func (m *SaveTransactionsResponseData) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this save transactions response data based on the context it is used

func (*SaveTransactionsResponseData) MarshalBinary 

func (m *SaveTransactionsResponseData) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SaveTransactionsResponseData) UnmarshalBinary 

func (m *SaveTransactionsResponseData) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SaveTransactionsResponseData) Validate 

func (m *SaveTransactionsResponseData) Validate(formats strfmt.Registry) error

Validate validates this save transactions response data

type SubTransaction 

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"`
}

SubTransaction sub transaction

swagger:model SubTransaction

func (*SubTransaction) ContextValidate 

func (m *SubTransaction) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this sub transaction based on context it is used

func (*SubTransaction) MarshalBinary 

func (m *SubTransaction) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*SubTransaction) UnmarshalBinary 

func (m *SubTransaction) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*SubTransaction) Validate 

func (m *SubTransaction) Validate(formats strfmt.Registry) error

Validate validates this sub transaction

type TransactionDetail 

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"`
}

TransactionDetail transaction detail

swagger:model TransactionDetail

func (*TransactionDetail) ContextValidate 

func (m *TransactionDetail) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validate this transaction detail based on the context it is used

func (*TransactionDetail) MarshalBinary 

func (m *TransactionDetail) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (TransactionDetail) MarshalJSON 

func (m TransactionDetail) MarshalJSON() ([]byte, error)

MarshalJSON marshals this object to a JSON structure

func (*TransactionDetail) UnmarshalBinary 

func (m *TransactionDetail) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionDetail) UnmarshalJSON 

func (m *TransactionDetail) UnmarshalJSON(raw []byte) error

UnmarshalJSON unmarshals this object from a JSON structure

func (*TransactionDetail) Validate 

func (m *TransactionDetail) Validate(formats strfmt.Registry) error

Validate validates this transaction detail

type TransactionSummary 

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"`
}

TransactionSummary transaction summary

swagger:model TransactionSummary

func (*TransactionSummary) ContextValidate 

func (m *TransactionSummary) ContextValidate(ctx context.Context, formats strfmt.Registry) error

ContextValidate validates this transaction summary based on context it is used

func (*TransactionSummary) MarshalBinary 

func (m *TransactionSummary) MarshalBinary() ([]byte, error)

MarshalBinary interface implementation

func (*TransactionSummary) UnmarshalBinary 

func (m *TransactionSummary) UnmarshalBinary(b []byte) error

UnmarshalBinary interface implementation

func (*TransactionSummary) Validate 

func (m *TransactionSummary) Validate(formats strfmt.Registry) error

Validate validates this transaction summary

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.