LibOFX

OfxSecurityData Struct Reference

An abstraction of a security, such as a stock, mutual fund, etc. More...

Data Fields

OFX mandatory elements

The OFX spec defines the following elements as mandatory. The associated variables should all contain valid data but you should not trust the servers. Check if the associated *_valid is true before using them.

char unique_id [OFX_UNIQUE_ID_LENGTH]
int unique_id_valid
char unique_id_type [OFX_UNIQUE_ID_TYPE_LENGTH]
int unique_id_type_valid
char secname [OFX_SECNAME_LENGTH]
int secname_valid
OFX optional elements

The OFX spec defines the following elements as optional. If the associated *_valid is true, the corresponding element is present and the associated variable contains valid data.

char ticker [OFX_TICKER_LENGTH]
int ticker_valid
double unitprice
int unitprice_valid
time_t date_unitprice
int date_unitprice_valid
char currency [OFX_CURRENCY_LENGTH]
int currency_valid
char memo [OFX_MEMO2_LENGTH]
int memo_valid

Detailed Description

An abstraction of a security, such as a stock, mutual fund, etc.

The OfxSecurityData stucture is used to hols the securyty information inside a OfxTransactionData struct for investment transactions.

Definition at line 344 of file inc/libofx.h.


Field Documentation

The currency is a string in ISO-4217 format. It overrides the one defined in the statement for the unit price

Definition at line 380 of file inc/libofx.h.

Referenced by OfxSecurityContainer::add_attribute().

The date as of which the unit price was valid.

Definition at line 375 of file inc/libofx.h.

Referenced by OfxSecurityContainer::add_attribute().

Extra information not included in name

Definition at line 383 of file inc/libofx.h.

Referenced by OfxSecurityContainer::add_attribute().

The full name of the security

Definition at line 360 of file inc/libofx.h.

Referenced by OfxSecurityContainer::add_attribute().

The ticker symbol of the security

Definition at line 368 of file inc/libofx.h.

Referenced by OfxSecurityContainer::add_attribute().

The id of the security being traded.

Definition at line 353 of file inc/libofx.h.

Referenced by OfxSecurityContainer::add_attribute().

Usially "CUSIP" for FIs in north america

Definition at line 356 of file inc/libofx.h.

Referenced by OfxSecurityContainer::add_attribute().

The price of each unit of the security, as of date_unitprice

Definition at line 371 of file inc/libofx.h.

Referenced by OfxSecurityContainer::add_attribute().


The documentation for this struct was generated from the following files: