aclindsa/ofxgo
1
0
Fork 0
mirror of https://github.com/aclindsa/ofxgo.git synced 2024-11-14 09:10:05 -05:00
Code Issues Releases Wiki Activity
5009ef3c79
ofxgo/invstmt.go

1050 lines
51 KiB
Go
Raw Normal View History

Add simple investment requests/responses This is lacking (at least) parsing the list of securities frequently sent with investment statements
2017-03-19 21:08:58 -04:00
package ofxgo
import (
"errors"
Switch to own clone of xml encoding library
2017-03-22 20:59:40 -04:00
"github.com/aclindsa/go/src/encoding/xml"
Add simple investment requests/responses This is lacking (at least) parsing the list of securities frequently sent with investment statements
2017-03-19 21:08:58 -04:00
)
type InvStatementRequest struct {
XMLName xml.Name `xml:"INVSTMTTRNRQ"`
TrnUID UID `xml:"TRNUID"`
CltCookie String `xml:"CLTCOOKIE,omitempty"`
TAN String `xml:"TAN,omitempty"` // Transaction authorization number
// TODO `xml:"OFXEXTENSION,omitempty"`
InvAcctFrom InvAcct `xml:"INVSTMTRQ>INVACCTFROM"`
Make optional struct fields pointers This allows encoding/xml to properly comparison against nil to see if they should be marshalled if the 'xml' tag contains ",omitempty" and for users to test against nil to see if a field was present in the parsed OFX. This commit also fixes up cmd/ofx to use the new pointers.
2017-03-29 05:31:01 -04:00
DtStart *Date `xml:"INVSTMTRQ>INCTRAN>DTSTART,omitempty"`
DtEnd *Date `xml:"INVSTMTRQ>INCTRAN>DTEND,omitempty"`
Add simple investment requests/responses This is lacking (at least) parsing the list of securities frequently sent with investment statements
2017-03-19 21:08:58 -04:00
Include Boolean `xml:"INVSTMTRQ>INCTRAN>INCLUDE"` // Include transactions (instead of just balance)
IncludeOO Boolean `xml:"INVSTMTRQ>INCOO"` // Include open orders
Make optional struct fields pointers This allows encoding/xml to properly comparison against nil to see if they should be marshalled if the 'xml' tag contains ",omitempty" and for users to test against nil to see if a field was present in the parsed OFX. This commit also fixes up cmd/ofx to use the new pointers.
2017-03-29 05:31:01 -04:00
PosDtAsOf *Date `xml:"INVSTMTRQ>INCPOS>DTASOF,omitempty"` // Date that positions should be sent down for, if present
Add simple investment requests/responses This is lacking (at least) parsing the list of securities frequently sent with investment statements
2017-03-19 21:08:58 -04:00
IncludePos Boolean `xml:"INVSTMTRQ>INCPOS>INCLUDE"` // Include position data in response
IncludeBalance Boolean `xml:"INVSTMTRQ>INCBAL"` // Include investment balance in response
Include401K Boolean `xml:"INVSTMTRQ>INC401K,omitempty"` // Include 401k information
Include401KBal Boolean `xml:"INVSTMTRQ>INC401KBAL,omitempty"` // Include 401k balance information
IncludeTranImage Boolean `xml:"INVSTMTRQ>INCTRANIMAGE,omitempty"` // Include transaction images
}
func (r *InvStatementRequest) Name() string {
return "INVSTMTTRNRQ"
}
func (r *InvStatementRequest) Valid() (bool, error) {
Don't require UIDs to be 36 characters The spec strongly recommends this, but doesn't strictly require it
2017-03-29 05:41:28 -04:00
// TODO implement
Add simple investment requests/responses This is lacking (at least) parsing the list of securities frequently sent with investment statements
2017-03-19 21:08:58 -04:00
return true, nil
}
Add Type() to Message interface, check types when marshalling requests
2017-03-31 09:25:07 -04:00
func (r *InvStatementRequest) Type() messageType {
return InvStmtRq
}
Add investment transactions
2017-03-21 11:20:24 -04:00
type InvTran struct {
XMLName xml.Name `xml:"INVTRAN"`
FiTId String `xml:"FITID"`
SrvrTId String `xml:"SRVRTID,omitempty"`
DtTrade Date `xml:"DTTRADE"` // trade date; for stock splits, day of record
Make optional struct fields pointers This allows encoding/xml to properly comparison against nil to see if they should be marshalled if the 'xml' tag contains ",omitempty" and for users to test against nil to see if a field was present in the parsed OFX. This commit also fixes up cmd/ofx to use the new pointers.
2017-03-29 05:31:01 -04:00
DtSettle *Date `xml:"DTSETTLE,omitempty"` // settlement date; for stock splits, execution date
Add investment transactions
2017-03-21 11:20:24 -04:00
ReversalFiTId String `xml:"REVERSALFITID,omitempty"` // For a reversal transaction, the FITID of the transaction that is being reversed.
Memo String `xml:"MEMO,omitempty"`
}
type InvBuy struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"INVBUY"`
InvTran InvTran `xml:"INVTRAN"`
SecId SecurityId `xml:"SECID"`
Units Amount `xml:"UNITS"` // For stocks, MFs, other, number of shares held. Bonds = face value. Options = number of contracts
UnitPrice Amount `xml:"UNITPRICE"` // For stocks, MFs, other, price per share. Bonds = percentage of par. Option = premium per share of underlying security
Markup Amount `xml:"MARKUP,omitempty"` // Portion of UNITPRICE that is attributed to the dealer markup
Commission Amount `xml:"COMMISSION,omitempty"`
Taxes Amount `xml:"TAXES,omitempty"`
Fees Amount `xml:"FEES,omitempty"`
Load Amount `xml:"LOAD,omitempty"`
Total Amount `xml:"TOTAL"` // Transaction total. Buys, sells, etc.:((quan. * (price +/- markup/markdown)) +/-(commission + fees + load + taxes + penalty + withholding + statewithholding)). Distributions, interest, margin interest, misc. expense, etc.: amount. Return of cap: cost basis
Currency *Currency `xml:"CURRENCY,omitempty"` // Overriding currency for UNITPRICE
OrigCurrency *Currency `xml:"ORIGCURRENCY,omitempty"` // Overriding currency for UNITPRICE
SubAcctSec subAcctType `xml:"SUBACCTSEC"` // Sub-account type for this security. One of CASH, MARGIN, SHORT, OTHER
SubAcctFund subAcctType `xml:"SUBACCTFUND"` // Where did the money for the transaction come from or go to? CASH, MARGIN, SHORT, OTHER
// The next three elements must either all be provided, or none of them
Add investment transactions
2017-03-21 11:20:24 -04:00
LoanId String `xml:"LOANID,omitempty"` // For 401(k) accounts only. Indicates that the transaction was due to a loan or a loan repayment, and which loan it was
LoanPrincipal Amount `xml:"LOANPRINCIPAL,omitempty"` // For 401(k) accounts only. Indicates how much of the loan repayment was principal
LoanInterest Amount `xml:"LOANINTEREST,omitempty"` // For 401(k) accounts only. Indicates how much of the loan repayment was interest
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
Inv401kSource inv401kSource `xml:"INV401KSOURCE,omitempty"` // Source of money for this transaction. One of PRETAX, AFTERTAX, MATCH, PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST for 401(k) accounts. Default if not present is OTHERNONVEST. The following cash source types are subject to vesting: MATCH, PROFITSHARING, and OTHERVEST
DtPayroll *Date `xml:"DTPAYROLL,omitempty"` // For 401(k)accounts, date the funds for this transaction was obtained via payroll deduction
PriorYearContrib Boolean `xml:"PRIORYEARCONTRIB,omitempty"` // For 401(k) accounts, indicates that this Buy was made with a prior year contribution
Add investment transactions
2017-03-21 11:20:24 -04:00
}
type InvSell struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"INVSELL"`
InvTran InvTran `xml:"INVTRAN"`
SecId SecurityId `xml:"SECID"`
Units Amount `xml:"UNITS"` // For stocks, MFs, other, number of shares held. Bonds = face value. Options = number of contracts
UnitPrice Amount `xml:"UNITPRICE"` // For stocks, MFs, other, price per share. Bonds = percentage of par. Option = premium per share of underlying security
Markdown Amount `xml:"MARKDOWN,omitempty"` // Portion of UNITPRICE that is attributed to the dealer markdown
Commission Amount `xml:"COMMISSION,omitempty"`
Taxes Amount `xml:"TAXES,omitempty"`
Fees Amount `xml:"FEES,omitempty"`
Load Amount `xml:"LOAD,omitempty"`
Witholding Amount `xml:"WITHHOLDING,omitempty"` // Federal tax witholdings
TaxExempt Boolean `xml:"TAXEXEMPT,omitempty"` // Tax-exempt transaction
Total Amount `xml:"TOTAL"` // Transaction total. Buys, sells, etc.:((quan. * (price +/- markup/markdown)) +/-(commission + fees + load + taxes + penalty + withholding + statewithholding)). Distributions, interest, margin interest, misc. expense, etc.: amount. Return of cap: cost basis
Gain Amount `xml:"GAIN,omitempty"` // Total gain
Currency *Currency `xml:"CURRENCY,omitempty"` // Overriding currency for UNITPRICE
OrigCurrency *Currency `xml:"ORIGCURRENCY,omitempty"` // Overriding currency for UNITPRICE
SubAcctSec subAcctType `xml:"SUBACCTSEC"` // Sub-account type for this security. One of CASH, MARGIN, SHORT, OTHER
SubAcctFund subAcctType `xml:"SUBACCTFUND"` // Where did the money for the transaction come from or go to? CASH, MARGIN, SHORT, OTHER
Add investment transactions
2017-03-21 11:20:24 -04:00
LoanId String `xml:"LOANID,omitempty"` // For 401(k) accounts only. Indicates that the transaction was due to a loan or a loan repayment, and which loan it was
StateWitholding Amount `xml:"STATEWITHHOLDING,omitempty"` // State tax witholdings
Spelling mistake
2017-04-06 19:17:52 -04:00
Penalty Amount `xml:"PENALTY,omitempty"` // Amount withheld due to penalty
Add investment transactions
2017-03-21 11:20:24 -04:00
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
Inv401kSource inv401kSource `xml:"INV401KSOURCE,omitempty"` // Source of money for this transaction. One of PRETAX, AFTERTAX, MATCH, PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST for 401(k) accounts. Default if not present is OTHERNONVEST. The following cash source types are subject to vesting: MATCH, PROFITSHARING, and OTHERVEST
Add investment transactions
2017-03-21 11:20:24 -04:00
}
type BuyDebt struct {
XMLName xml.Name `xml:"BUYDEBT"`
InvBuy InvBuy `xml:"INVBUY"`
AccrdInt Amount `xml:"ACCRDINT,omitempty"` // Accrued interest. This amount is not reflected in the <TOTAL> field of a containing aggregate.
}
func (t BuyDebt) TransactionType() string {
return "BUYDEBT"
}
type BuyMF struct {
XMLName xml.Name `xml:"BUYMF"`
InvBuy InvBuy `xml:"INVBUY"`
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
BuyType buyType `xml:"BUYTYPE"` // One of BUY, BUYTOCOVER (BUYTOCOVER used to close short sales.)
Add investment transactions
2017-03-21 11:20:24 -04:00
RelFiTId String `xml:"RELFITID,omitempty"` // used to relate transactions associated with mutual fund exchanges
}
func (t BuyMF) TransactionType() string {
return "BUYMF"
}
type BuyOpt struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"BUYOPT"`
InvBuy InvBuy `xml:"INVBUY"`
OptBuyType optBuyType `xml:"OPTBUYTYPE"` // type of purchase: BUYTOOPEN, BUYTOCLOSE (The BUYTOOPEN buy type is like “ordinary” buying of option and works like stocks.)
ShPerCtrct Int `xml:"SHPERCTRCT"` // Shares per contract
Add investment transactions
2017-03-21 11:20:24 -04:00
}
func (t BuyOpt) TransactionType() string {
return "BUYOPT"
}
type BuyOther struct {
XMLName xml.Name `xml:"BUYOTHER"`
InvBuy InvBuy `xml:"INVBUY"`
}
func (t BuyOther) TransactionType() string {
return "BUYOTHER"
}
type BuyStock struct {
XMLName xml.Name `xml:"BUYSTOCK"`
InvBuy InvBuy `xml:"INVBUY"`
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
BuyType buyType `xml:"BUYTYPE"` // One of BUY, BUYTOCOVER (BUYTOCOVER used to close short sales.)
Add investment transactions
2017-03-21 11:20:24 -04:00
}
func (t BuyStock) TransactionType() string {
return "BUYSTOCK"
}
type ClosureOpt struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"CLOSUREOPT"`
InvTran InvTran `xml:"INVTRAN"`
SecId SecurityId `xml:"SECID"`
OptAction optAction `xml:"OPTACTION"` // One of EXERCISE, ASSIGN, EXPIRE. The EXERCISE action is used to close out an option that is exercised. The ASSIGN action is used when an option writer is assigned. The EXPIRE action is used when the option’s expired date is reached
Units Amount `xml:"UNITS"` // For stocks, MFs, other, number of shares held. Bonds = face value. Options = number of contracts
ShPerCtrct Int `xml:"SHPERCTRCT"` // Shares per contract
SubAcctSec subAcctType `xml:"SUBACCTSEC"` // Sub-account type for this security. One of CASH, MARGIN, SHORT, OTHER
RelFiTId String `xml:"RELFITID,omitempty"` // used to relate transactions associated with mutual fund exchanges
Gain Amount `xml:"GAIN,omitempty"` // Total gain
Add investment transactions
2017-03-21 11:20:24 -04:00
}
func (t ClosureOpt) TransactionType() string {
return "CLOSUREOPT"
}
// Investment income is realized as cash into the investment account
type Income struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"INCOME"`
InvTran InvTran `xml:"INVTRAN"`
SecId SecurityId `xml:"SECID"`
IncomeType incomeType `xml:"INCOMETYPE"` // Type of investment income: CGLONG (capital gains-long term), CGSHORT (capital gains-short term), DIV (dividend), INTEREST, MISC
Total Amount `xml:"TOTAL"`
SubAcctSec subAcctType `xml:"SUBACCTSEC"` // Sub-account type for this security. One of CASH, MARGIN, SHORT, OTHER
SubAcctFund subAcctType `xml:"SUBACCTFUND"` // Where did the money for the transaction come from or go to? CASH, MARGIN, SHORT, OTHER
TaxExempt Boolean `xml:"TAXEXEMPT,omitempty"` // Tax-exempt transaction
Witholding Amount `xml:"WITHHOLDING,omitempty"` // Federal tax witholdings
Currency *Currency `xml:"CURRENCY,omitempty"` // Overriding currency for UNITPRICE
OrigCurrency *Currency `xml:"ORIGCURRENCY,omitempty"` // Overriding currency for UNITPRICE
Inv401kSource inv401kSource `xml:"INV401KSOURCE,omitempty"` // Source of money for this transaction. One of PRETAX, AFTERTAX, MATCH, PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST for 401(k) accounts. Default if not present is OTHERNONVEST. The following cash source types are subject to vesting: MATCH, PROFITSHARING, and OTHERVEST
Add investment transactions
2017-03-21 11:20:24 -04:00
}
func (t Income) TransactionType() string {
return "INCOME"
}
// Expense associated with an investment
type InvExpense struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"INVEXPENSE"`
InvTran InvTran `xml:"INVTRAN"`
SecId SecurityId `xml:"SECID"`
Total Amount `xml:"TOTAL"`
SubAcctSec subAcctType `xml:"SUBACCTSEC"` // Sub-account type for this security. One of CASH, MARGIN, SHORT, OTHER
SubAcctFund subAcctType `xml:"SUBACCTFUND"` // Where did the money for the transaction come from or go to? CASH, MARGIN, SHORT, OTHER
Currency *Currency `xml:"CURRENCY,omitempty"` // Overriding currency for UNITPRICE
OrigCurrency *Currency `xml:"ORIGCURRENCY,omitempty"` // Overriding currency for UNITPRICE
Inv401kSource inv401kSource `xml:"INV401KSOURCE,omitempty"` // Source of money for this transaction. One of PRETAX, AFTERTAX, MATCH, PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST for 401(k) accounts. Default if not present is OTHERNONVEST. The following cash source types are subject to vesting: MATCH, PROFITSHARING, and OTHERVEST
Add investment transactions
2017-03-21 11:20:24 -04:00
}
func (t InvExpense) TransactionType() string {
return "INVEXPENSE"
}
// Journaling cash holdings between sub-accounts within the same investment account.
type JrnlFund struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"JRNLFUND"`
InvTran InvTran `xml:"INVTRAN"`
Total Amount `xml:"TOTAL"`
SubAcctFrom subAcctType `xml:"SUBACCTFROM"` // Sub-account cash is being transferred from: CASH, MARGIN, SHORT, OTHER
SubAcctTo subAcctType `xml:"SUBACCTTO"` // Sub-account cash is being transferred to: CASH, MARGIN, SHORT, OTHER
Add investment transactions
2017-03-21 11:20:24 -04:00
}
func (t JrnlFund) TransactionType() string {
return "JRNLFUND"
}
// Journaling security holdings between sub-accounts within the same investment account.
type JrnlSec struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"JRNLSEC"`
InvTran InvTran `xml:"INVTRAN"`
SecId SecurityId `xml:"SECID"`
SubAcctFrom subAcctType `xml:"SUBACCTFROM"` // Sub-account cash is being transferred from: CASH, MARGIN, SHORT, OTHER
SubAcctTo subAcctType `xml:"SUBACCTTO"` // Sub-account cash is being transferred to: CASH, MARGIN, SHORT, OTHER
Units Amount `xml:"UNITS"` // For stocks, MFs, other, number of shares held. Bonds = face value. Options = number of contracts
Add investment transactions
2017-03-21 11:20:24 -04:00
}
func (t JrnlSec) TransactionType() string {
return "JRNLSEC"
}
type MarginInterest struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"MARGININTEREST"`
InvTran InvTran `xml:"INVTRAN"`
Total Amount `xml:"TOTAL"`
SubAcctFund subAcctType `xml:"SUBACCTFUND"` // Where did the money for the transaction come from or go to? CASH, MARGIN, SHORT, OTHER
Currency *Currency `xml:"CURRENCY,omitempty"` // Overriding currency for UNITPRICE
OrigCurrency *Currency `xml:"ORIGCURRENCY,omitempty"` // Overriding currency for UNITPRICE
Add investment transactions
2017-03-21 11:20:24 -04:00
}
func (t MarginInterest) TransactionType() string {
return "MARGININTEREST"
}
// REINVEST is a single transaction that contains both income and an investment transaction. If servers can’t track this as a single transaction they should return an INCOME transaction and an INVTRAN.
type Reinvest struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"REINVEST"`
InvTran InvTran `xml:"INVTRAN"`
SecId SecurityId `xml:"SECID"`
IncomeType incomeType `xml:"INCOMETYPE"` // Type of investment income: CGLONG (capital gains-long term), CGSHORT (capital gains-short term), DIV (dividend), INTEREST, MISC
Total Amount `xml:"TOTAL"` // Transaction total. Buys, sells, etc.:((quan. * (price +/- markup/markdown)) +/-(commission + fees + load + taxes + penalty + withholding + statewithholding)). Distributions, interest, margin interest, misc. expense, etc.: amount. Return of cap: cost basis
SubAcctSec subAcctType `xml:"SUBACCTSEC"` // Sub-account type for this security. One of CASH, MARGIN, SHORT, OTHER
Units Amount `xml:"UNITS"` // For stocks, MFs, other, number of shares held. Bonds = face value. Options = number of contracts
UnitPrice Amount `xml:"UNITPRICE"` // For stocks, MFs, other, price per share. Bonds = percentage of par. Option = premium per share of underlying security
Commission Amount `xml:"COMMISSION,omitempty"`
Taxes Amount `xml:"TAXES,omitempty"`
Fees Amount `xml:"FEES,omitempty"`
Load Amount `xml:"LOAD,omitempty"`
TaxExempt Boolean `xml:"TAXEXEMPT,omitempty"` // Tax-exempt transaction
Currency *Currency `xml:"CURRENCY,omitempty"` // Overriding currency for UNITPRICE
OrigCurrency *Currency `xml:"ORIGCURRENCY,omitempty"` // Overriding currency for UNITPRICE
Inv401kSource inv401kSource `xml:"INV401KSOURCE,omitempty"` // Source of money for this transaction. One of PRETAX, AFTERTAX, MATCH, PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST for 401(k) accounts. Default if not present is OTHERNONVEST. The following cash source types are subject to vesting: MATCH, PROFITSHARING, and OTHERVEST
Add investment transactions
2017-03-21 11:20:24 -04:00
}
func (t Reinvest) TransactionType() string {
return "REINVEST"
}
type RetOfCap struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"RETOFCAP"`
InvTran InvTran `xml:"INVTRAN"`
SecId SecurityId `xml:"SECID"`
Total Amount `xml:"TOTAL"`
SubAcctSec subAcctType `xml:"SUBACCTSEC"` // Sub-account type for this security. One of CASH, MARGIN, SHORT, OTHER
SubAcctFund subAcctType `xml:"SUBACCTFUND"` // Where did the money for the transaction come from or go to? CASH, MARGIN, SHORT, OTHER
Currency *Currency `xml:"CURRENCY,omitempty"` // Overriding currency for UNITPRICE
OrigCurrency *Currency `xml:"ORIGCURRENCY,omitempty"` // Overriding currency for UNITPRICE
Inv401kSource inv401kSource `xml:"INV401KSOURCE,omitempty"` // Source of money for this transaction. One of PRETAX, AFTERTAX, MATCH, PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST for 401(k) accounts. Default if not present is OTHERNONVEST. The following cash source types are subject to vesting: MATCH, PROFITSHARING, and OTHERVEST
Add investment transactions
2017-03-21 11:20:24 -04:00
}
func (t RetOfCap) TransactionType() string {
return "RETOFCAP"
}
type SellDebt struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"SELLDEBT"`
InvSell InvSell `xml:"INVSELL"`
SellReason sellReason `xml:"SELLREASON"` // CALL (the debt was called), SELL (the debt was sold), MATURITY (the debt reached maturity)
AccrdInt Amount `xml:"ACCRDINT,omitempty"` // Accrued interest
Add investment transactions
2017-03-21 11:20:24 -04:00
}
func (t SellDebt) TransactionType() string {
return "SELLDEBT"
}
type SellMF struct {
XMLName xml.Name `xml:"SELLMF"`
InvSell InvSell `xml:"INVSELL"`
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
SellType sellType `xml:"SELLTYPE"` // Type of sell. SELL, SELLSHORT
Add investment transactions
2017-03-21 11:20:24 -04:00
AvgCostBasis Amount `xml:"AVGCOSTBASIS"`
RelFiTId String `xml:"RELFITID,omitempty"` // used to relate transactions associated with mutual fund exchanges
}
func (t SellMF) TransactionType() string {
return "SELLMF"
}
type SellOpt struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"SELLOPT"`
InvSell InvSell `xml:"INVSELL"`
OptSellType optSellType `xml:"OPTSELLTYPE"` // For options, type of sell: SELLTOCLOSE, SELLTOOPEN. The SELLTOCLOSE action is selling a previously bought option. The SELLTOOPEN action is writing an option
ShPerCtrct Int `xml:"SHPERCTRCT"` // Shares per contract
RelFiTId String `xml:"RELFITID,omitempty"` // used to relate transactions associated with mutual fund exchanges
RelType relType `xml:"RELTYPE,omitempty"` // Related option transaction type: SPREAD, STRADDLE, NONE, OTHER
Secured secured `xml:"SECURED,omitempty"` // NAKED, COVERED
Add investment transactions
2017-03-21 11:20:24 -04:00
}
func (t SellOpt) TransactionType() string {
return "SELLOPT"
}
type SellOther struct {
XMLName xml.Name `xml:"SELLOTHER"`
InvSell InvSell `xml:"INVSELL"`
}
func (t SellOther) TransactionType() string {
return "SELLOTHER"
}
type SellStock struct {
XMLName xml.Name `xml:"SELLSTOCK"`
InvSell InvSell `xml:"INVSELL"`
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
SellType sellType `xml:"SELLTYPE"` // Type of sell. SELL, SELLSHORT
Add investment transactions
2017-03-21 11:20:24 -04:00
}
func (t SellStock) TransactionType() string {
return "SELLSTOCK"
}
type Split struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"SPLIT"`
InvTran InvTran `xml:"INVTRAN"`
SecId SecurityId `xml:"SECID"`
SubAcctSec subAcctType `xml:"SUBACCTSEC"` // Sub-account type for this security. One of CASH, MARGIN, SHORT, OTHER
OldUnits Amount `xml:"OLDUNITS"` // number of shares before the split
NewUnits Amount `xml:"NEWUNITS"` // number of shares after the split
Numerator Int `xml:"NUMERATOR"` // split ratio numerator
Denominator Int `xml:"DENOMINATOR"` // split ratio denominator
Currency *Currency `xml:"CURRENCY,omitempty"` // Overriding currency for UNITPRICE
OrigCurrency *Currency `xml:"ORIGCURRENCY,omitempty"` // Overriding currency for UNITPRICE
FracCash Amount `xml:"FRACCASH,omitempty"` // cash for fractional units
SubAcctFund subAcctType `xml:"SUBACCTFUND,omitempty"` // Where did the money for the transaction come from or go to? CASH, MARGIN, SHORT, OTHER
Inv401kSource inv401kSource `xml:"INV401KSOURCE,omitempty"` // Source of money for this transaction. One of PRETAX, AFTERTAX, MATCH, PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST for 401(k) accounts. Default if not present is OTHERNONVEST. The following cash source types are subject to vesting: MATCH, PROFITSHARING, and OTHERVEST
Add investment transactions
2017-03-21 11:20:24 -04:00
}
func (t Split) TransactionType() string {
return "SPLIT"
}
type Transfer struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"TRANSFER"`
InvTran InvTran `xml:"INVTRAN"`
SecId SecurityId `xml:"SECID"`
SubAcctSec subAcctType `xml:"SUBACCTSEC"` // Sub-account type for this security. One of CASH, MARGIN, SHORT, OTHER
Units Amount `xml:"UNITS"` // For stocks, MFs, other, number of shares held. Bonds = face value. Options = number of contracts
TferAction tferAction `xml:"TFERACTION"` // One of IN, OUT
PosType posType `xml:"POSTYPE"` // Position type. One of LONG, SHORT
InvAcctFrom InvAcct `xml:"INVACCTFROM,omitempty"`
AvgCostBasis Amount `xml:"AVGCOSTBASIS,omitempty"`
UnitPrice Amount `xml:"UNITPRICE,omitempty"` // For stocks, MFs, other, price per share. Bonds = percentage of par. Option = premium per share of underlying security
DtPurchase *Date `xml:"DTPURCHASE,omitempty"`
Inv401kSource inv401kSource `xml:"INV401KSOURCE,omitempty"` // Source of money for this transaction. One of PRETAX, AFTERTAX, MATCH, PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST for 401(k) accounts. Default if not present is OTHERNONVEST. The following cash source types are subject to vesting: MATCH, PROFITSHARING, and OTHERVEST
Add investment transactions
2017-03-21 11:20:24 -04:00
}
func (t Transfer) TransactionType() string {
return "TRANSFER"
}
type InvTransaction interface {
TransactionType() string
}
Add simple investment requests/responses This is lacking (at least) parsing the list of securities frequently sent with investment statements
2017-03-19 21:08:58 -04:00
type InvBankTransaction struct {
XMLName xml.Name `xml:"INVBANKTRAN"`
Transactions []Transaction `xml:"STMTTRN,omitempty"`
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
SubAcctFund subAcctType `xml:"SUBACCTFUND"` // Where did the money for the transaction come from or go to? CASH, MARGIN, SHORT, OTHER
Add simple investment requests/responses This is lacking (at least) parsing the list of securities frequently sent with investment statements
2017-03-19 21:08:58 -04:00
}
Add investment transactions
2017-03-21 11:20:24 -04:00
// Must be unmarshalled manually due to the structure (don't know what kind of
// InvTransaction is coming next)
type InvTranList struct {
DtStart Date
DtEnd Date
InvTransactions []InvTransaction
BankTransactions []InvBankTransaction
}
func (l *InvTranList) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error {
for {
tok, err := nextNonWhitespaceToken(d)
if err != nil {
return err
} else if end, ok := tok.(xml.EndElement); ok && end.Name.Local == start.Name.Local {
// If we found the end of our starting element, we're done parsing
return nil
} else if startElement, ok := tok.(xml.StartElement); ok {
switch startElement.Name.Local {
case "DTSTART":
var dtstart Date
if err := d.DecodeElement(&dtstart, &startElement); err != nil {
return err
}
l.DtStart = dtstart
case "DTEND":
var dtend Date
if err := d.DecodeElement(&dtend, &startElement); err != nil {
return err
}
l.DtEnd = dtend
case "BUYDEBT":
var tran BuyDebt
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "BUYMF":
var tran BuyMF
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "BUYOPT":
var tran BuyOpt
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "BUYOTHER":
var tran BuyOther
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "BUYSTOCK":
var tran BuyStock
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "CLOSUREOPT":
var tran ClosureOpt
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "INCOME":
var tran Income
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "INVEXPENSE":
var tran InvExpense
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "JRNLFUND":
var tran JrnlFund
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "JRNLSEC":
var tran JrnlSec
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "MARGININTEREST":
var tran MarginInterest
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "REINVEST":
var tran Reinvest
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "RETOFCAP":
var tran RetOfCap
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "SELLDEBT":
var tran SellDebt
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "SELLMF":
var tran SellMF
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "SELLOPT":
var tran SellOpt
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "SELLOTHER":
var tran SellOther
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "SELLSTOCK":
var tran SellStock
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "SPLIT":
var tran Split
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "TRANSFER":
var tran Transfer
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.InvTransactions = append(l.InvTransactions, InvTransaction(tran))
case "INVBANKTRAN":
var tran InvBankTransaction
if err := d.DecodeElement(&tran, &startElement); err != nil {
return err
}
l.BankTransactions = append(l.BankTransactions, tran)
default:
return errors.New("Invalid INVTRANLIST child tag: " + startElement.Name.Local)
}
} else {
return errors.New("Didn't find an opening element")
}
}
Add parsing position list
2017-03-20 21:09:08 -04:00
}
type InvPosition struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"INVPOS"`
SecId SecurityId `xml:"SECID"`
HeldInAcct subAcctType `xml:"HELDINACCT"` // Sub-account type, one of CASH, MARGIN, SHORT, OTHER
PosType posType `xml:"POSTYPE"` // SHORT = Writer for options, Short for all others; LONG = Holder for options, Long for all others.
Units Amount `xml:"UNITS"` // For stocks, MFs, other, number of shares held. Bonds = face value. Options = number of contracts
UnitPrice Amount `xml:"UNITPRICE"` // For stocks, MFs, other, price per share. Bonds = percentage of par. Option = premium per share of underlying security
MktVal Amount `xml:"MKTVAL"` // Market value of this position
AvgCostBasis Amount `xml:"AVGCOSTBASIS,omitempty"` //
DtPriceAsOf Date `xml:"DTPRICEASOF"` // Date and time of unit price and market value, and cost basis. If this date is unknown, use 19900101 as the placeholder; do not use 0,
Currency *Currency `xml:"CURRENCY,omitempty"` // Overriding currency for UNITPRICE
Memo String `xml:"MEMO,omitempty"`
Inv401kSource inv401kSource `xml:"INV401KSOURCE,omitempty"` // One of PRETAX, AFTERTAX, MATCH, PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST for 401(k) accounts. Default if not present is OTHERNONVEST. The following cash source types are subject to vesting: MATCH, PROFITSHARING, and OTHERVEST
Add parsing position list
2017-03-20 21:09:08 -04:00
}
type Position interface {
PositionType() string
}
type DebtPosition struct {
XMLName xml.Name `xml:"POSDEBT"`
InvPos InvPosition `xml:"INVPOS"`
}
func (p DebtPosition) PositionType() string {
return "POSDEBT"
}
type MFPosition struct {
XMLName xml.Name `xml:"POSMF"`
InvPos InvPosition `xml:"INVPOS"`
UnitsStreet Amount `xml:"UNITSSTREET,omitempty"` // Units in the FI’s street name
UnitsUser Amount `xml:"UNITSUSER,omitempty"` // Units in the user's name directly
ReinvDiv Boolean `xml:"REINVDIV,omitempty"` // Reinvest dividends
ReinCG Boolean `xml:"REINVCG,omitempty"` // Reinvest capital gains
}
func (p MFPosition) PositionType() string {
return "POSMF"
}
type OptPosition struct {
XMLName xml.Name `xml:"POSOPT"`
InvPos InvPosition `xml:"INVPOS"`
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
Secured secured `xml:"SECURED,omitempty"` // One of NAKED, COVERED
Add parsing position list
2017-03-20 21:09:08 -04:00
}
func (p OptPosition) PositionType() string {
return "POSOPT"
}
type OtherPosition struct {
XMLName xml.Name `xml:"POSOTHER"`
InvPos InvPosition `xml:"INVPOS"`
}
func (p OtherPosition) PositionType() string {
return "POSOTHER"
}
type StockPosition struct {
XMLName xml.Name `xml:"POSSTOCK"`
InvPos InvPosition `xml:"INVPOS"`
UnitsStreet Amount `xml:"UNITSSTREET,omitempty"` // Units in the FI’s street name
UnitsUser Amount `xml:"UNITSUSER,omitempty"` // Units in the user's name directly
ReinvDiv Boolean `xml:"REINVDIV,omitempty"` // Reinvest dividends
}
func (p StockPosition) PositionType() string {
return "POSSTOCK"
}
type PositionList []Position
Add investment transactions
2017-03-21 11:20:24 -04:00
func (p *PositionList) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error {
Add parsing position list
2017-03-20 21:09:08 -04:00
for {
tok, err := nextNonWhitespaceToken(d)
if err != nil {
return err
} else if end, ok := tok.(xml.EndElement); ok && end.Name.Local == start.Name.Local {
// If we found the end of our starting element, we're done parsing
return nil
} else if startElement, ok := tok.(xml.StartElement); ok {
switch startElement.Name.Local {
case "POSDEBT":
var position DebtPosition
if err := d.DecodeElement(&position, &startElement); err != nil {
return err
}
Add investment transactions
2017-03-21 11:20:24 -04:00
*p = append(*p, Position(position))
Add parsing position list
2017-03-20 21:09:08 -04:00
case "POSMF":
var position MFPosition
if err := d.DecodeElement(&position, &startElement); err != nil {
return err
}
Add investment transactions
2017-03-21 11:20:24 -04:00
*p = append(*p, Position(position))
Add parsing position list
2017-03-20 21:09:08 -04:00
case "POSOPT":
var position OptPosition
if err := d.DecodeElement(&position, &startElement); err != nil {
return err
}
Add investment transactions
2017-03-21 11:20:24 -04:00
*p = append(*p, Position(position))
Add parsing position list
2017-03-20 21:09:08 -04:00
case "POSOTHER":
var position OtherPosition
if err := d.DecodeElement(&position, &startElement); err != nil {
return err
}
Add investment transactions
2017-03-21 11:20:24 -04:00
*p = append(*p, Position(position))
Add parsing position list
2017-03-20 21:09:08 -04:00
case "POSSTOCK":
var position StockPosition
if err := d.DecodeElement(&position, &startElement); err != nil {
return err
}
Add investment transactions
2017-03-21 11:20:24 -04:00
*p = append(*p, Position(position))
Add parsing position list
2017-03-20 21:09:08 -04:00
default:
return errors.New("Invalid INVPOSLIST child tag: " + startElement.Name.Local)
}
} else {
return errors.New("Didn't find an opening element")
}
}
Add simple investment requests/responses This is lacking (at least) parsing the list of securities frequently sent with investment statements
2017-03-19 21:08:58 -04:00
}
type InvBalance struct {
XMLName xml.Name `xml:"INVBAL"`
AvailCash Amount `xml:"AVAILCASH"` // Available cash across all sub-accounts, including sweep funds
MarginBalance Amount `xml:"MARGINBALANCE"` // Negative means customer has borrowed funds
ShortBalance Amount `xml:"SHORTBALANCE"` // Always positive, market value of all short positions
BuyPower Amount `xml:"BUYPOWER"`
BalList []Balance `xml:"BALLIST>BAL,omitempty"`
}
Add open orders to investment statment responses
2017-04-01 11:05:40 -04:00
type OO struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"OO"`
FiTId String `xml:"FITID"`
SrvrTId String `xml:"SRVRTID,omitempty"`
SecId SecurityId `xml:"SECID"`
DtPlaced Date `xml:"DTPLACED"` // Date the order was placed
Units Amount `xml:"UNITS"` // Quantity of the security the open order is for
SubAcct subAcctType `xml:"SUBACCT"` // One of CASH, MARGIN, SHORT, OTHER
Duration duration `xml:"DURATION"` // How long the order is good for. One of DAY, GOODTILCANCEL, IMMEDIATE
Restriction restriction `xml:"RESTRICTION"` // Special restriction on the order: One of ALLORNONE, MINUNITS, NONE
MinUnits Amount `xml:"MINUNITS,omitempty"` // Minimum number of units that must be filled for the order
LimitPrice Amount `xml:"LIMITPRICE,omitempty"`
StopPrice Amount `xml:"STOPPRICE,omitempty"`
Memo String `xml:"MEMO,omitempty"`
Currency *Currency `xml:"CURRENCY,omitempty"` // Overriding currency for UNITPRICE
Inv401kSource inv401kSource `xml:"INV401KSOURCE,omitempty"` // One of PRETAX, AFTERTAX, MATCH, PROFITSHARING, ROLLOVER, OTHERVEST, OTHERNONVEST for 401(k) accounts. Default if not present is OTHERNONVEST. The following cash source types are subject to vesting: MATCH, PROFITSHARING, and OTHERVEST
Add open orders to investment statment responses
2017-04-01 11:05:40 -04:00
}
type OpenOrder interface {
OrderType() string
}
type OOBuyDebt struct {
XMLName xml.Name `xml:"OOBUYDEBT"`
OO OO `xml:"OO"`
Auction Boolean `xml:"AUCTION"` // whether the debt should be purchased at the auction
DtAuction *Date `xml:"DTAUCTION,omitempty"`
}
func (o OOBuyDebt) OrderType() string {
return "OOBUYDEBT"
}
type OOBuyMF struct {
XMLName xml.Name `xml:"OOBUYMF"`
OO OO `xml:"OO"`
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
BuyType buyType `xml:"BUYTYPE"` // One of BUY, BUYTOCOVER
UnitType unitType `xml:"UNITTYPE"` // What the units represent: one of SHARES, CURRENCY
Add open orders to investment statment responses
2017-04-01 11:05:40 -04:00
}
func (o OOBuyMF) OrderType() string {
return "OOBUYMF"
}
type OOBuyOpt struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"OOBUYOPT"`
OO OO `xml:"OO"`
OptBuyType optBuyType `xml:"OPTBUYTYPE"` // One of BUYTOOPEN, BUYTOCLOSE
Add open orders to investment statment responses
2017-04-01 11:05:40 -04:00
}
func (o OOBuyOpt) OrderType() string {
return "OOBUYOPT"
}
type OOBuyOther struct {
XMLName xml.Name `xml:"OOBUYOTHER"`
OO OO `xml:"OO"`
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
UnitType unitType `xml:"UNITTYPE"` // What the units represent: one of SHARES, CURRENCY
Add open orders to investment statment responses
2017-04-01 11:05:40 -04:00
}
func (o OOBuyOther) OrderType() string {
return "OOBUYOTHER"
}
type OOBuyStock struct {
XMLName xml.Name `xml:"OOBUYSTOCK"`
OO OO `xml:"OO"`
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
BuyType buyType `xml:"BUYTYPE"` // One of BUY, BUYTOCOVER
Add open orders to investment statment responses
2017-04-01 11:05:40 -04:00
}
func (o OOBuyStock) OrderType() string {
return "OOBUYSTOCK"
}
type OOSellDebt struct {
XMLName xml.Name `xml:"OOSELLDEBT"`
OO OO `xml:"OO"`
}
func (o OOSellDebt) OrderType() string {
return "OOSELLDEBT"
}
type OOSellMF struct {
XMLName xml.Name `xml:"OOSELLMF"`
OO OO `xml:"OO"`
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
SellType sellType `xml:"SELLTYPE"` // One of SELL, SELLSHORT
UnitType unitType `xml:"UNITTYPE"` // What the units represent: one of SHARES, CURRENCY
Add open orders to investment statment responses
2017-04-01 11:05:40 -04:00
SellAll Boolean `xml:"SELLALL"` // Sell entire holding
}
func (o OOSellMF) OrderType() string {
return "OOSELLMF"
}
type OOSellOpt struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"OOSELLOPT"`
OO OO `xml:"OO"`
OptSellType optSellType `xml:"OPTSELLTYPE"` // One of SELLTOOPEN, SELLTOCLOSE
Add open orders to investment statment responses
2017-04-01 11:05:40 -04:00
}
func (o OOSellOpt) OrderType() string {
return "OOSELLOPT"
}
type OOSellOther struct {
XMLName xml.Name `xml:"OOSELLOTHER"`
OO OO `xml:"OO"`
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
UnitType unitType `xml:"UNITTYPE"` // What the units represent: one of SHARES, CURRENCY
Add open orders to investment statment responses
2017-04-01 11:05:40 -04:00
}
func (o OOSellOther) OrderType() string {
return "OOSELLOTHER"
}
type OOSellStock struct {
XMLName xml.Name `xml:"OOSELLSTOCK"`
OO OO `xml:"OO"`
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
SellType sellType `xml:"SELLTYPE"` // One of SELL, SELLSHORT
Add open orders to investment statment responses
2017-04-01 11:05:40 -04:00
}
func (o OOSellStock) OrderType() string {
return "OOSELLSTOCK"
}
type OOSwitchMF struct {
XMLName xml.Name `xml:"SWITCHMF"`
OO OO `xml:"OO"`
SecId SecurityId `xml:"SECID"` // Security ID of the fund to switch to or purchase
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
UnitType unitType `xml:"UNITTYPE"` // What the units represent: one of SHARES, CURRENCY
Add open orders to investment statment responses
2017-04-01 11:05:40 -04:00
SwitchAll Boolean `xml:"SWITCHALL"` // Switch entire holding
}
func (o OOSwitchMF) OrderType() string {
return "SWITCHMF"
}
type OOList []OpenOrder
func (o *OOList) UnmarshalXML(d *xml.Decoder, start xml.StartElement) error {
for {
tok, err := nextNonWhitespaceToken(d)
if err != nil {
return err
} else if end, ok := tok.(xml.EndElement); ok && end.Name.Local == start.Name.Local {
// If we found the end of our starting element, we're done parsing
return nil
} else if startElement, ok := tok.(xml.StartElement); ok {
switch startElement.Name.Local {
case "OOBUYDEBT":
var oo OOBuyDebt
if err := d.DecodeElement(&oo, &startElement); err != nil {
return err
}
*o = append(*o, OpenOrder(oo))
case "OOBUYMF":
var oo OOBuyMF
if err := d.DecodeElement(&oo, &startElement); err != nil {
return err
}
*o = append(*o, OpenOrder(oo))
case "OOBUYOPT":
var oo OOBuyOpt
if err := d.DecodeElement(&oo, &startElement); err != nil {
return err
}
*o = append(*o, OpenOrder(oo))
case "OOBUYOTHER":
var oo OOBuyOther
if err := d.DecodeElement(&oo, &startElement); err != nil {
return err
}
*o = append(*o, OpenOrder(oo))
case "OOBUYSTOCK":
var oo OOBuyStock
if err := d.DecodeElement(&oo, &startElement); err != nil {
return err
}
*o = append(*o, OpenOrder(oo))
case "OOSELLDEBT":
var oo OOSellDebt
if err := d.DecodeElement(&oo, &startElement); err != nil {
return err
}
*o = append(*o, OpenOrder(oo))
case "OOSELLMF":
var oo OOSellMF
if err := d.DecodeElement(&oo, &startElement); err != nil {
return err
}
*o = append(*o, OpenOrder(oo))
case "OOSELLOPT":
var oo OOSellOpt
if err := d.DecodeElement(&oo, &startElement); err != nil {
return err
}
*o = append(*o, OpenOrder(oo))
case "OOSELLOTHER":
var oo OOSellOther
if err := d.DecodeElement(&oo, &startElement); err != nil {
return err
}
*o = append(*o, OpenOrder(oo))
case "OOSELLSTOCK":
var oo OOSellStock
if err := d.DecodeElement(&oo, &startElement); err != nil {
return err
}
*o = append(*o, OpenOrder(oo))
case "SWITCHMF":
var oo OOSwitchMF
if err := d.DecodeElement(&oo, &startElement); err != nil {
return err
}
*o = append(*o, OpenOrder(oo))
default:
return errors.New("Invalid OOList child tag: " + startElement.Name.Local)
}
} else {
return errors.New("Didn't find an opening element")
}
}
}
Add 401K information to INVSTMTTRNRS
2017-03-27 20:13:32 -04:00
type ContribSecurity struct {
XMLName xml.Name `xml:"CONTRIBSECURITY"`
SecId SecurityId `xml:"SECID"`
PreTaxContribPct Amount `xml:"PRETAXCONTRIBPCT,omitempty"` // Percentage of each new employee pretax contribution allocated to this security, rate.
PreTaxContribAmt Amount `xml:"PRETAXCONTRIBAMT,omitempty"` // Fixed amount of each new employee pretax contribution allocated to this security, amount
AfterTaxContribPct Amount `xml:"AFTERTAXCONTRIBPCT,omitempty"` // Percentage of each new employee after tax contribution allocated to this security, rate.
AfterTaxContribAmt Amount `xml:"AFTERTAXCONTRIBAMT,omitempty"` // Fixed amount of each new employee pretax contribution allocated to this security, amount.
MatchContribPct Amount `xml:"MATCHCONTRIBPCT,omitempty"` // Percentage of each new employer match contribution allocated to this security, rate.
MatchContribAmt Amount `xml:"MATCHCONTRIBAMT,omitempty"` // Fixed amount of each new employer match contribution allocated to this security, amount.
ProfitSharingContribPct Amount `xml:"PROFITSHARINGCONTRIBPCT,omitempty"` // Percentage of each new employer profit sharing contribution allocated to this security, rate.
ProfitSharingContribAmt Amount `xml:"PROFITSHARINGCONTRIBAMT,omitempty"` // Fixed amount of each new employer profit sharing contribution allocated to this security, amount.
RolloverContribPct Amount `xml:"ROLLOVERCONTRIBPCT,omitempty"` // Percentage of new rollover contributions allocated to this security, rate.
RolloverContribAmt Amount `xml:"ROLLOVERCONTRIBAMT,omitempty"` // Fixed amount of new rollover contributions allocated to this security, amount.
OtherVestPct Amount `xml:"OTHERVESTPCT,omitempty"` // Percentage of each new other employer contribution allocated to this security, rate.
OtherVestAmt Amount `xml:"OTHERVESTAMT,omitempty"` // Fixed amount of each new other employer contribution allocated to this security, amount.
OtherNonVestPct Amount `xml:"OTHERNONVESTPCT,omitempty"` // Percentage of each new other employee contribution allocated to this security, rate.
OtherNonVestAmt Amount `xml:"OTHERNONVESTAMT,omitempty"` // Fixed amount of each new other employee contribution allocated to this security, amount
}
type VestInfo struct {
XMLName xml.Name `xml:"VESTINFO"`
Make optional struct fields pointers This allows encoding/xml to properly comparison against nil to see if they should be marshalled if the 'xml' tag contains ",omitempty" and for users to test against nil to see if a field was present in the parsed OFX. This commit also fixes up cmd/ofx to use the new pointers.
2017-03-29 05:31:01 -04:00
VestDate *Date `xml:"VESTDATE,omitempty"` // Date at which vesting percentage changes. Default (if empty) is that the vesting percentage below applies to the current date
Add 401K information to INVSTMTTRNRS
2017-03-27 20:13:32 -04:00
VestPct Amount `xml:"VESTPCT"`
}
type LoanInfo struct {
Use named constants instead of strings for enum-like OFX fields This adds a python script to generate constants.go when `go generate` is called, and updates the structs, tests, and command-line client to all use the new named constants.
2017-04-06 05:58:22 -04:00
XMLName xml.Name `xml:"VESTINFO"`
LoanID String `xml:"LOANID"` // Identifier of this loan
LoanDesc String `xml:"LOANDESC,omitempty"` // Loan description
InitialLoanBal Amount `xml:"INITIALLOANBAL,omitempty"` // Initial loan balance
LoanStartDate *Date `xml:"LOANSTARTDATE,omitempty"` // Start date of loan
CurrentLoanBal Amount `xml:"CURRENTLOANBAL"` // Current loan principal balance
DtAsOf *Date `xml:"DTASOF"` // Date and time of the current loan balance
LoanRate Amount `xml:"LOANRATE,omitempty"` // Loan annual interest rate
LoanPmtAmt Amount `xml:"LOANPMTAMT,omitempty"` // Loan payment amount
LoanPmtFreq loanPmtFreq `xml:"LOANPMTFREQ,omitempty"` // Frequency of loan repayments: WEEKLY, BIWEEKLY, TWICEMONTHLY, MONTHLY, FOURWEEKS, BIMONTHLY, QUARTERLY, SEMIANNUALLY, ANNUALLY, OTHER. See section 10.2.1 for calculation rules.
LoanPmtsInitial Int `xml:"LOANPMTSINITIAL,omitempty"` // Initial number of loan payments.
LoanPmtsRemaining Int `xml:"LOANPMTSREMAINING,omitempty"` // Remaining number of loan payments
LoanMaturityDate *Date `xml:"LOANMATURITYDATE,omitempty"` // Expected loan end date
LoanTotalProjInterest Amount `xml:"LOANTOTALPROJINTEREST,omitempty"` // Total projected interest to be paid on this loan
LoanInterestToDate Amount `xml:"LOANINTERESTTODATE,omitempty"` // Total interested paid to date on this loan
LoanExtPmtDate *Date `xml:"LOANNEXTPMTDATE,omitempty"` // Next payment due date
Add 401K information to INVSTMTTRNRS
2017-03-27 20:13:32 -04:00
}
type Inv401KSummaryAggregate struct {
XMLName xml.Name // One of CONTRIBUTIONS, WITHDRAWALS, EARNINGS
PreTax Amount `xml:"PRETAX,omitempty"` // Pretax withdrawals.
AfterTax Amount `xml:"AFTERTAX,omitempty"` // After tax withdrawals.
Match Amount `xml:"MATCH,omitempty"` // Employer matching withdrawals.
ProfitSharing Amount `xml:"PROFITSHARING,omitempty"` // Profit sharing withdrawals.
Rollover Amount `xml:"ROLLOVER,omitempty"` // Rollover withdrawals.
OtherVest Amount `xml:"OTHERVEST,omitempty"` // Other vesting withdrawals.
OtherNonVest Amount `xml:"OTHERNONVEST,omitempty"` // Other non-vesting withdrawals.
Total Amount `xml:"TOTAL"` // Sum of withdrawals from all fund sources.
}
type Inv401KSummaryPeriod struct {
Make optional struct fields pointers This allows encoding/xml to properly comparison against nil to see if they should be marshalled if the 'xml' tag contains ",omitempty" and for users to test against nil to see if a field was present in the parsed OFX. This commit also fixes up cmd/ofx to use the new pointers.
2017-03-29 05:31:01 -04:00
XMLName xml.Name // One of YEARTODATE, INCEPTODATE, or PERIODTODATE
DtStart Date `xml:"DTSTART"`
DtEnd Date `xml:"DTEND"`
Contributions *Inv401KSummaryAggregate `xml:"CONTRIBUTIONS,omitempty"` // 401(k) contribution aggregate. Note: this includes loan payments.
Withdrawls *Inv401KSummaryAggregate `xml:"WITHDRAWLS,omitempty"` // 401(k) withdrawals aggregate. Note: this includes loan withdrawals.
Earnings *Inv401KSummaryAggregate `xml:"EARNINGS,omitempty"` // 401(k) earnings aggregate. This is the market value change. It includes dividends/interest, and capital gains - realized and unrealized.
Add 401K information to INVSTMTTRNRS
2017-03-27 20:13:32 -04:00
}
type Inv401K struct {
XMLName xml.Name `xml:"INV401K"`
EmployerName String `xml:"EMPLOYERNAME"`
PlanID String `xml:"PLANID,omitempty"` // Plan number
Make optional struct fields pointers This allows encoding/xml to properly comparison against nil to see if they should be marshalled if the 'xml' tag contains ",omitempty" and for users to test against nil to see if a field was present in the parsed OFX. This commit also fixes up cmd/ofx to use the new pointers.
2017-03-29 05:31:01 -04:00
PlanJoinDate *Date `xml:"PLANJOINDATE,omitempty"` // Date the employee joined the plan
Add 401K information to INVSTMTTRNRS
2017-03-27 20:13:32 -04:00
EmployerContactInfo String `xml:"EMPLOYERCONTACTINFO,omitempty"` // Name of contact person at employer, plus any available contact information, such as phone number
BrokerContactInfo String `xml:"BROKERCONTACTINFO,omitempty"` // Name of contact person at broker, plus any available contact information, such as phone number
DeferPctPreTax Amount `xml:"DEFERPCTPRETAX,omitempty"` // Percent of employee salary deferred before tax
DeferPctAfterTax Amount `xml:"DEFERPCTAFTERTAX,omitempty"` // Percent of employee salary deferred after tax
//<MATCHINFO> Aggregate containing employer match information. Absent if employer does not contribute matching funds.
Make optional struct fields pointers This allows encoding/xml to properly comparison against nil to see if they should be marshalled if the 'xml' tag contains ",omitempty" and for users to test against nil to see if a field was present in the parsed OFX. This commit also fixes up cmd/ofx to use the new pointers.
2017-03-29 05:31:01 -04:00
MatchPct Amount `xml:"MATCHINFO>MATCHPCT,omitempty"` // Percent of employee contribution matched, e.g., 75% if contribution rate is $0.75/$1.00
MaxMatchAmt Amount `xml:"MATCHINFO>MAXMATCHAMT,omitempty"` // Maximum employer contribution amount in any year
MaxMatchPct Amount `xml:"MATCHINFO>MAXMATCHPCT,omitempty"` // Current maximum employer contribution percentage. Maximum match in a year is MAXMATCHPCT up to the MAXMATCHAMT, if provided
StartOfYear *Date `xml:"MATCHINFO>STARTOFYEAR,omitempty"` // Specifies when the employer contribution max is reset. Some plans have a maximum based on the company fiscal year rather than calendar year. Assume calendar year if omitted. Only the month and day (MMDD) are used; year (YYYY) and time are ignored
BaseMatchAmt Amount `xml:"MATCHINFO>BASEMATCHAMT"` // Specifies a fixed dollar amount contributed by the employer if the employee participates in the plan at all. This may be present in addition to the <MATCHPCT>. $0 if omitted
BaseMatchPct Amount `xml:"MATCHINFO>BASEMATCHPCT"` // Specifies a fixed percent of employee salary matched if the employee participates in the plan at all. This may be present in addition to the MATCHPCT>. 0% if omitted. Base match in a year is BASEMATCHPCT up to the BASEMATCHAMT,if provided
ContribInfo []ContribSecurity `xml:"CONTRIBINTO>CONTRIBSECURITY"` // Aggregate to describe how new contributions are distributed among the available securities.
CurrentVestPct Amount `xml:"CURRENTVESTPCT,omitempty"` // Estimated percentage of employer contributions vested as of the current date. If omitted, assume 100%
VestInfo []VestInfo `xml:"VESTINFO,omitempty"` // Vest change dates. Provides the vesting percentage as of any particular past, current, or future date. 0 or more.
LoanInfo []LoanInfo `xml:"LOANINFO,omitempty"` // List of any loans outstanding against this account
YearToDateSummary Inv401KSummaryPeriod `xml:"INV401KSUMMARY>YEARTODATE"` // Contributions to date for this calendar year.
InceptToDateSummary *Inv401KSummaryPeriod `xml:"INV401KSUMMARY>INCEPTODATE,omitempty"` // Total contributions to date (since inception)
PeriodToDate *Inv401KSummaryPeriod `xml:"INV401KSUMMARY>PERIODTODATE,omitempty"` // Total contributions this contribution period
Add 401K information to INVSTMTTRNRS
2017-03-27 20:13:32 -04:00
}
type Inv401KBal struct {
XMLName xml.Name `xml:"INV401KBAL"`
CashBal Amount `xml:"CASHBAL,omitempty"` // Available cash balance
PreTax Amount `xml:"PRETAX,omitempty"` // Current value of all securities purchased with Before Tax Employee contributions
AfterTax Amount `xml:"AFTERTAX,omitempty"` // Current value of all securities purchased with After Tax Employee contributions
Match Amount `xml:"MATCH,omitempty"` // Current value of all securities purchased with Employer Match contributions
ProfitSharing Amount `xml:"PROFITSHARING,omitempty"` // Current value of all securities purchased with Employer Profit Sharing contributions
Rollover Amount `xml:"ROLLOVER,omitempty"` // Current value of all securities purchased with Rollover contributions
OtherVest Amount `xml:"OTHERVEST,omitempty"` // Current value of all securities purchased with Other (vesting) Employer contributions
OtherNonVest Amount `xml:"OTHERNONVEST,omitempty"` // Current value of all securities purchased with Other (non-vesting) Employer contributions
Total Amount `xml:"TOTAL"` // Current value of all securities purchased with all contributions
BalList []Balance `xml:"BALLIST>BAL,omitempty"`
}
Add simple investment requests/responses This is lacking (at least) parsing the list of securities frequently sent with investment statements
2017-03-19 21:08:58 -04:00
type InvStatementResponse struct {
XMLName xml.Name `xml:"INVSTMTTRNRS"`
TrnUID UID `xml:"TRNUID"`
Status Status `xml:"STATUS"`
CltCookie String `xml:"CLTCOOKIE,omitempty"`
Standardize transaction wrapper fields
2017-03-30 10:24:26 -04:00
// TODO `xml:"OFXEXTENSION,omitempty"`
Add investment transactions
2017-03-21 11:20:24 -04:00
DtAsOf Date `xml:"INVSTMTRS>DTASOF"`
CurDef String `xml:"INVSTMTRS>CURDEF"`
InvAcctFrom InvAcct `xml:"INVSTMTRS>INVACCTFROM"`
Make optional struct fields pointers This allows encoding/xml to properly comparison against nil to see if they should be marshalled if the 'xml' tag contains ",omitempty" and for users to test against nil to see if a field was present in the parsed OFX. This commit also fixes up cmd/ofx to use the new pointers.
2017-03-29 05:31:01 -04:00
InvTranList *InvTranList `xml:"INVSTMTRS>INVTRANLIST,omitempty"`
Add investment transactions
2017-03-21 11:20:24 -04:00
InvPosList PositionList `xml:"INVSTMTRS>INVPOSLIST,omitempty"`
Make optional struct fields pointers This allows encoding/xml to properly comparison against nil to see if they should be marshalled if the 'xml' tag contains ",omitempty" and for users to test against nil to see if a field was present in the parsed OFX. This commit also fixes up cmd/ofx to use the new pointers.
2017-03-29 05:31:01 -04:00
InvBal *InvBalance `xml:"INVSTMTRS>INVBAL,omitempty"`
Add open orders to investment statment responses
2017-04-01 11:05:40 -04:00
InvOOList OOList `xml:"INVSTMTRS>INVOOLIST,omitempty"`
MktgInfo String `xml:"INVSTMTRS>MKTGINFO,omitempty"` // Marketing information
Inv401K *Inv401K `xml:"INVSTMTRS>INV401K,omitempty"`
Inv401KBal *Inv401KBal `xml:"INVSTMTRS>INV401KBAL,omitempty"`
Add simple investment requests/responses This is lacking (at least) parsing the list of securities frequently sent with investment statements
2017-03-19 21:08:58 -04:00
}
Generalize response parsing code This removes the many decodeXXXMessageSet() functions and replaces them with a large map and a single generic decodeMessageSet() function. Also change Responses to satisfy the Message interface as pointer types (instead of the raw types), add the full set of top-level message sets (though most of them still lack any message-parsing ability), adjust the message set names to more closely mirror their OFX names, and fixup tests and the command-line client to match the above changes.
2017-03-31 11:54:43 -04:00
func (sr *InvStatementResponse) Name() string {
Add simple investment requests/responses This is lacking (at least) parsing the list of securities frequently sent with investment statements
2017-03-19 21:08:58 -04:00
return "INVSTMTTRNRS"
}
Generalize response parsing code This removes the many decodeXXXMessageSet() functions and replaces them with a large map and a single generic decodeMessageSet() function. Also change Responses to satisfy the Message interface as pointer types (instead of the raw types), add the full set of top-level message sets (though most of them still lack any message-parsing ability), adjust the message set names to more closely mirror their OFX names, and fixup tests and the command-line client to match the above changes.
2017-03-31 11:54:43 -04:00
func (sr *InvStatementResponse) Valid() (bool, error) {
Add simple investment requests/responses This is lacking (at least) parsing the list of securities frequently sent with investment statements
2017-03-19 21:08:58 -04:00
//TODO implement
return true, nil
}
Generalize response parsing code This removes the many decodeXXXMessageSet() functions and replaces them with a large map and a single generic decodeMessageSet() function. Also change Responses to satisfy the Message interface as pointer types (instead of the raw types), add the full set of top-level message sets (though most of them still lack any message-parsing ability), adjust the message set names to more closely mirror their OFX names, and fixup tests and the command-line client to match the above changes.
2017-03-31 11:54:43 -04:00
func (sr *InvStatementResponse) Type() messageType {
Add Type() to Message interface, check types when marshalling requests
2017-03-31 09:25:07 -04:00
return InvStmtRs
}
Reference in New Issue Copy Permalink