class CLOSUREOPT(INVTRAN, SECID):
optaction = OneOf('EXERCISE', 'ASSIGN', 'EXPIRE')
units = Decimal(required=True)
shperctrct = Integer(required=True)
subacctsec = OneOf(*INVSUBACCTS, required=True)
relfitid = String(255)
gain = Decimal()
class STOCKINFO(SECINFO):
stocktype = OneOf('COMMON', 'PREFERRED', 'CONVERTIBLE', 'OTHER')
yld = Decimal(4)
dtyieldasof = DateTime()
typedesc = String(32)
assetclass = OneOf(*ASSETCLASSES)
fiassetclass = String(32)
def __init__(self, elem):
"""
Rename 'yield' (Python reserved word) to 'yld'
"""
extra_attrs = {}
# Do all XPath searches before removing nodes from the tree
# which seems to mess up the DOM in Python3 and throw an
# AttributeError on subsequent searches.
yld = elem.find('./YIELD')
if yld is not None:
# Rename; save for later
extra_attrs['yld'] = yld.text
elem.remove(yld)
super(STOCKINFO, self).__init__(elem)
# Add back data previously stripped/mangled
for attr, val in extra_attrs.items():
setattr(self, attr, val)
class JRNLFUND(Aggregate):
""" OFX section 13.9.2.4.4 """
invtran = SubAggregate(INVTRAN, required=True)
subacctto = OneOf(*INVSUBACCTS, required=True)
subacctfrom = OneOf(*INVSUBACCTS, required=True)
total = Decimal(required=True)
class OOSELLMF(Aggregate):
""" OFX section 13.9.2.5.2 """
oo = SubAggregate(OO, required=True)
selltype = OneOf(*SELLTYPES, required=True)
unittype = OneOf(*UNITTYPES, required=True)
sellall = Bool(required=True)
class OPTINFO(SECINFO):
opttype = OneOf('CALL', 'PUT', required=True)
strikeprice = Decimal(required=True)
dtexpire = DateTime(required=True)
shperctrct = Integer(required=True)
assetclass = OneOf(*ASSETCLASSES)
fiassetclass = String(32)
def __init__(self, elem):
"""
Strip SECID of underlying so it doesn't overwrite SECID of option
during _flatten()
"""
# Do all XPath searches before removing nodes from the tree
# which seems to mess up the DOM in Python3 and throw an
# AttributeError on subsequent searches.
secid = elem.find('./SECID')
if secid is not None:
# A <SECID> aggregate referring to the security underlying the
# option is, in general, *not* going to be contained in <SECLIST>
# (because you don't necessarily have a position in the underlying).
# Since the <SECID> for the underlying only gives us fields for
# (uniqueidtype, uniqueid) we can't really go ahead and use this
# information to create a corresponding SECINFO instance (since we
# lack information about the security subclass). It's unclear that
# the SECID of the underlying is really needed for anything, so we
# disregard it.
elem.remove(secid)
super(OPTINFO, self).__init__(elem)
class STMTTRN(Aggregate, Origcurrency):
""" OFX section 11.4.3 """
trntype = OneOf(*TRNTYPES, required=True)
dtposted = DateTime(required=True)
dtuser = DateTime()
dtavail = DateTime()
trnamt = Decimal(required=True)
fitid = String(255, required=True)
correctfitid = String(255)
correctaction = OneOf("REPLACE", "DELETE")
srvrtid = String(10)
checknum = String(12)
refnum = String(32)
sic = Integer()
payeeid = String(12)
name = String(32)
payee = SubAggregate(PAYEE)
extdname = String(100)
bankacctto = SubAggregate(BANKACCTTO)
ccacctto = SubAggregate(CCACCTTO)
memo = String(255)
imagedata = Unsupported()
currency = SubAggregate(CURRENCY)
origcurrency = SubAggregate(ORIGCURRENCY)
inv401ksource = OneOf(*INV401KSOURCES)
optionalMutexes = [
("name", "payee"),
("ccacctto", "bankacctto"),
("currency", "origcurrency"),
]
class MSGSETCORE(Aggregate):
""" OFX section 7.2.1 """
ver = Integer(required=True)
url = String(255, required=True)
ofxsec = OneOf("NONE", "TYPE1", required=True)
transpsec = Bool(required=True)
signonrealm = String(32, required=True)
language = OneOf(*LANG_CODES, required=True)
syncmode = OneOf("FULL", "LITE", required=True)
refreshsupt = Bool()
respfileer = Bool(required=True)
spname = String(32)
ofxextension = SubAggregate(OFXEXTENSION)
@staticmethod
def groom(elem):
"""
Remove proprietary tags e.g. INTU.XXX
"""
# Keep input free of side effects
elem = deepcopy(elem)
for child in set(elem):
if "." in child.tag:
elem.remove(child)
return super(MSGSETCORE, MSGSETCORE).groom(elem)
class JRNLSEC(Aggregate):
""" OFX section 13.9.2.4.4 """
invtran = SubAggregate(INVTRAN, required=True)
secid = SubAggregate(SECID, required=True)
subacctto = OneOf(*INVSUBACCTS, required=True)
subacctfrom = OneOf(*INVSUBACCTS, required=True)
units = Decimal(required=True)
class STOCKINFO(Aggregate):
""" OFX Section 13.8.5.6 """
secinfo = SubAggregate(SECINFO, required=True)
stocktype = OneOf('COMMON', 'PREFERRED', 'CONVERTIBLE', 'OTHER')
yld = Decimal()
dtyieldasof = DateTime()
typedesc = String(32)
assetclass = OneOf(*ASSETCLASSES)
fiassetclass = String(32)
@staticmethod
def groom(elem):
"""
Rename all Elements tagged YIELD (reserved Python keyword) to YLD
"""
yld = elem.find('./YIELD')
if yld is not None:
yld.tag = 'YLD'
return super(STOCKINFO, STOCKINFO).groom(elem)
@staticmethod
def ungroom(elem):
"""
Rename YLD back to YLD
"""
yld = elem.find('./YLD')
if yld is not None:
yld.tag = 'YIELD'
return super(STOCKINFO, STOCKINFO).ungroom(elem)
class SELLOPT(Aggregate):
""" OFX section 13.9.2.4.4 """
invsell = SubAggregate(INVSELL, required=True)
optselltype = OneOf(*OPTSELLTYPES, required=True)
shperctrct = Integer(required=True)
relfitid = String(255)
reltype = OneOf('SPREAD', 'STRADDLE', 'NONE', 'OTHER')
secured = OneOf('NAKED', 'COVERED')
class INCOME(INVTRAN, SECID, ORIGCURRENCY):
incometype = OneOf(*INCOMETYPES, required=True)
total = Decimal(required=True)
subacctsec = OneOf(*INVSUBACCTS, required=True)
subacctfund = OneOf(*INVSUBACCTS, required=True)
taxexempt = Bool()
withholding = Decimal()
inv401ksource = OneOf(*INV401KSOURCES)
class INVACCTINFO(Aggregate):
""" OFX section 13.6.2 """
invacctfrom = SubAggregate(INVACCTFROM, required=True)
usproducttype = OneOf(*USPRODUCTTYPES, required=True)
checking = Bool(required=True)
svcstatus = OneOf(*SVCSTATUSES, required=True)
invaccttype = OneOf(*INVACCTTYPES)
optionlevel = String(40)
class SELLOPT(Aggregate):
""" OFX section 13.9.2.4.4 """
invsell = SubAggregate(INVSELL, required=True)
optselltype = OneOf(*OPTSELLTYPES, required=True)
shperctrct = Integer(required=True)
relfitid = String(255)
reltype = OneOf("SPREAD", "STRADDLE", "NONE", "OTHER")
secured = OneOf("NAKED", "COVERED")
class INVPOS(SECID, CURRENCY):
heldinacct = OneOf(*INVSUBACCTS, required=True)
postype = OneOf('SHORT', 'LONG', required=True)
units = Decimal(required=True)
unitprice = Decimal(4, required=True)
mktval = Decimal(required=True)
dtpriceasof = DateTime(required=True)
memo = String(255)
inv401ksource = OneOf(*INV401KSOURCES)
class TRANSFER(INVTRAN, SECID):
subacctsec = OneOf(*INVSUBACCTS, required=True)
units = Decimal(required=True)
tferaction = OneOf('IN', 'OUT', required=True)
postype = OneOf('SHORT', 'LONG', required=True)
avgcostbasis = Decimal()
unitprice = Decimal()
dtpurchase = DateTime()
inv401ksource = OneOf(*INV401KSOURCES)
class SPLIT(INVTRAN, SECID):
subacctsec = OneOf(*INVSUBACCTS, required=True)
oldunits = Decimal(required=True)
newunits = Decimal(required=True)
numerator = Decimal(required=True)
denominator = Decimal(required=True)
fraccash = Decimal()
subacctfund = OneOf(*INVSUBACCTS)
inv401ksource = OneOf(*INV401KSOURCES)
class OPTINFO(Aggregate):
""" OFX Section 13.8.5.4 """
secinfo = SubAggregate(SECINFO, required=True)
opttype = OneOf('CALL', 'PUT', required=True)
strikeprice = Decimal(required=True)
dtexpire = DateTime(required=True)
shperctrct = Integer(required=True)
secid = SubAggregate(SECID)
assetclass = OneOf(*ASSETCLASSES)
fiassetclass = String(32)
class CLOSUREOPT(Aggregate):
""" OFX section 13.9.2.4.4 """
invtran = SubAggregate(INVTRAN, required=True)
secid = SubAggregate(SECID, required=True)
optaction = OneOf('EXERCISE', 'ASSIGN', 'EXPIRE', required=True)
units = Decimal(required=True)
shperctrct = Integer(required=True)
subacctsec = OneOf(*INVSUBACCTS, required=True)
relfitid = String(255)
gain = Decimal()
class RETOFCAP(Aggregate, Origcurrency):
""" OFX section 13.9.2.4.4 """
invtran = SubAggregate(INVTRAN, required=True)
secid = SubAggregate(SECID, required=True)
total = Decimal(required=True)
subacctsec = OneOf(*INVSUBACCTS, required=True)
subacctfund = OneOf(*INVSUBACCTS, required=True)
currency = SubAggregate(CURRENCY)
origcurrency = SubAggregate(ORIGCURRENCY)
inv401ksource = OneOf(*INV401KSOURCES)
class ACCTRS(Aggregate):
"""OFX section 8.6.2"""
svcadd = SubAggregate(SVCADD)
svcchg = SubAggregate(SVCCHG)
svcdel = SubAggregate(SVCDEL)
svc = OneOf(*SVCS, required=True)
svcstatus = OneOf(*SVCSTATUSES, required=True)
requiredMutexes = [["svcadd", "svcchg", "svcdel"]]
class REINVEST(INVTRAN, SECID, ORIGCURRENCY):
incometype = OneOf(*INCOMETYPES, required=True)
total = Decimal(required=True)
subacctsec = OneOf(*INVSUBACCTS, required=True)
units = Decimal(required=True)
unitprice = Decimal(4, required=True)
commission = Decimal()
taxes = Decimal()
fees = Decimal()
load = Decimal()
taxexempt = Bool()
inv401ksource = OneOf(*INV401KSOURCES)
class INCOME(Aggregate, Origcurrency):
""" OFX section 13.9.2.4.4 """
invtran = SubAggregate(INVTRAN, required=True)
secid = SubAggregate(SECID, required=True)
incometype = OneOf(*INCOMETYPES, required=True)
total = Decimal(required=True)
subacctsec = OneOf(*INVSUBACCTS, required=True)
subacctfund = OneOf(*INVSUBACCTS, required=True)
taxexempt = Bool()
withholding = Decimal()
currency = SubAggregate(CURRENCY)
origcurrency = SubAggregate(ORIGCURRENCY)
inv401ksource = OneOf(*INV401KSOURCES)
class INVPOS(Aggregate):
""" OFX section 13.9.2.6.1 """
secid = SubAggregate(SECID)
heldinacct = OneOf(*INVSUBACCTS, required=True)
postype = OneOf('SHORT', 'LONG', required=True)
units = Decimal(required=True)
unitprice = Decimal(4, required=True)
mktval = Decimal(required=True)
avgcostbasis = Decimal()
dtpriceasof = DateTime(required=True)
currency = SubAggregate(CURRENCY)
memo = String(255)
inv401ksource = OneOf(*INV401KSOURCES)
class TRANSFER(Aggregate):
""" OFX section 13.9.2.4.4 """
invtran = SubAggregate(INVTRAN, required=True)
secid = SubAggregate(SECID, required=True)
subacctsec = OneOf(*INVSUBACCTS, required=True)
units = Decimal(required=True)
tferaction = OneOf('IN', 'OUT', required=True)
postype = OneOf('SHORT', 'LONG', required=True)
invacctfrom = SubAggregate(INVACCTFROM)
avgcostbasis = Decimal()
unitprice = Decimal()
dtpurchase = DateTime()
inv401ksource = OneOf(*INV401KSOURCES)
def __init__(self, bankid, acctid, accttype):
self._acct = OrderedDict.fromkeys(self.acctkeys)
accttype = accttype.upper()
accttype = OneOf(*ACCTTYPES).convert(accttype)
self._acct['ACCTTYPE'] = OneOf(*ACCTTYPES).convert(accttype)
bankid = str(bankid)
if not self.routingre.match(bankid):
raise ValueError('Invalid bankid %s' % bankid)
self._acct['BANKID'] = bankid
assert acctid
self._acct['ACCTID'] = str(acctid)
class SPLIT(Aggregate, Origcurrency):
""" OFX section 13.9.2.4.4 """
invtran = SubAggregate(INVTRAN, required=True)
secid = SubAggregate(SECID, required=True)
subacctsec = OneOf(*INVSUBACCTS, required=True)
oldunits = Decimal(required=True)
newunits = Decimal(required=True)
numerator = Decimal(required=True)
denominator = Decimal(required=True)
currency = SubAggregate(CURRENCY)
origcurrency = SubAggregate(ORIGCURRENCY)
fraccash = Decimal()
subacctfund = OneOf(*INVSUBACCTS)
inv401ksource = OneOf(*INV401KSOURCES)
class DEBTINFO(SECINFO):
parvalue = Decimal(required=True)
debttype = OneOf('COUPON', 'ZERO', required=True)
debtclass = OneOf('TREASURY', 'MUNICIPAL', 'CORPORATE', 'OTHER')
couponrt = Decimal(4)
dtcoupon = DateTime()
couponfreq = OneOf('MONTHLY', 'QUARTERLY', 'SEMIANNUAL', 'ANNUAL', 'OTHER')
callprice = Decimal(4)
yieldtocall = Decimal(4)
dtcall = DateTime()
calltype = OneOf('CALL', 'PUT', 'PREFUND', 'MATURITY')
yieldtomat = Decimal(4)
dtmat = DateTime()
assetclass = OneOf(*ASSETCLASSES)
fiassetclass = String(32)
class INVSTMTRS(Aggregate):
""" OFX section 13.9.2.1 """
dtasof = DateTime(required=True)
curdef = OneOf(*CURRENCY_CODES, required=True)
invacctfrom = SubAggregate(INVACCTFROM, required=True)
invtranlist = SubAggregate(INVTRANLIST)
invposlist = SubAggregate(INVPOSLIST)
invbal = SubAggregate(INVBAL)
invoolist = SubAggregate(INVOOLIST)
mktginfo = String(360)
inv401kbal = SubAggregate(INV401KBAL)
inv401k = SubAggregate(INV401K)
@property
def account(self):
return self.invacctfrom
@property
def transactions(self):
return self.invtranlist
@property
def positions(self):
return self.invposlist
@property
def balances(self):
return self.invbal
class CCSTMTRS(Aggregate):
""" OFX section 11.4.3.2 """
curdef = OneOf(*CURRENCY_CODES, required=True)
ccacctfrom = SubAggregate(CCACCTFROM, required=True)
banktranlist = SubAggregate(BANKTRANLIST)
banktranlistp = Unsupported()
ledgerbal = SubAggregate(LEDGERBAL, required=True)
availbal = SubAggregate(AVAILBAL)
cashadvbalamt = Decimal()
intratepurch = Decimal()
intratecash = Decimal()
intratexfer = Decimal()
rewardinfo = SubAggregate(REWARDINFO)
ballist = SubAggregate(BALLIST)
mktginfo = String(360)
@property
def account(self):
return self.ccacctfrom
@property
def transactions(self):
return self.banktranlist
@property
def balance(self):
return self.ledgerbal
class PROCDET_V100(Aggregate):
"""OFX tax extensions section 2.2.11.2"""
form8949code = String(1)
dtaqd = DateTime()
dtvar = Bool()
dtsale = DateTime(required=True)
secname = String(120)
saledescription = String(120)
numshrs = Decimal()
costbasis = Decimal()
salespr = Decimal(required=True)
accruedmktdiscount = Decimal()
longshort = OneOf("LONG", "SHORT")
ordinary = Bool()
washsale = Bool()
fedtaxwh = Decimal()
washsalelossdisallowed = Decimal()
noncoveredsecurity = Bool()
lossnotallowed = Bool()
basisnotshown = Bool()
form1099bnotreceived = Bool()
collectible = Bool()
statecode = String(2)
stateidnum = String(32)
statetaxwheld = Decimal()
statecode2 = String(2)
stateidnum2 = String(32)
statetaxwheld2 = Decimal()
fatca = Bool()
requiredMutexes = [["dtaqd", "dtvar"]]