libofx.h

Go to the documentation of this file.

/***************************************************************************
              libofx.h  -  Main header file for the libofx API
                             -------------------
    copyright            : (C) 2002 by Benoit Grégoire
    email                : bock@step.polymtl.ca
***************************************************************************/
/***************************************************************************
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 ***************************************************************************/

#ifndef LIBOFX_H
#define LIBOFX_H
#include <time.h>

#ifdef __cplusplus
#define CFCT extern "C"
#else
#define CFCT
#define true 1
#define false 0
#endif

#define OFX_ELEMENT_NAME_LENGTH         100
#define OFX_SVRTID2_LENGTH             36 + 1
#define OFX_CHECK_NUMBER_LENGTH        12 + 1
#define OFX_REFERENCE_NUMBER_LENGTH    32 + 1
#define OFX_FITID_LENGTH               255 + 1
#define OFX_TOKEN2_LENGTH              36 + 1
#define OFX_MEMO2_LENGTH               390 + 1
#define OFX_BALANCE_NAME_LENGTH        32 + 1
#define OFX_BALANCE_DESCRIPTION_LENGTH 80 + 1
#define OFX_CURRENCY_LENGTH            3 + 1 /* In ISO-4217 format */
#define OFX_BANKID_LENGTH              9
#define OFX_BRANCHID_LENGTH            22 + 1
#define OFX_ACCTID_LENGTH              22 + 1 
#define OFX_ACCTKEY_LENGTH             22 + 1
#define OFX_BROKERID_LENGTH            22 + 1
/* Must be MAX of <BANKID>+<BRANCHID>+<ACCTID>, <ACCTID>+<ACCTKEY> and <ACCTID>+<BROKERID> */
#define OFX_ACCOUNT_ID_LENGTH OFX_BANKID_LENGTH + OFX_BRANCHID_LENGTH + OFX_ACCTID_LENGTH + 1
#define OFX_ACCOUNT_NAME_LENGTH        255
#define OFX_MARKETING_INFO_LENGTH      360 + 1
#define OFX_TRANSACTION_NAME_LENGTH    32 + 1
#define OFX_UNIQUE_ID_LENGTH           32 + 1
#define OFX_UNIQUE_ID_TYPE_LENGTH      10 + 1
#define OFX_SECNAME_LENGTH             32 + 1
#define OFX_TICKER_LENGTH              32 + 1

CFCT void (*OfxCallbackFunc) ();


CFCT int ofx_proc_file(int argc, char *argv[]);


struct OfxStatusData{  
  char ofx_element_name[OFX_ELEMENT_NAME_LENGTH];
  int ofx_element_name_valid;
  
  int code;            
  char* name;          
  char* description;   
  int code_valid;      
    enum Severity{INFO, 
                WARN, 
                ERROR 
  } severity;
  int severity_valid;
  
  char* server_message; 
  int server_message_valid;
};


CFCT int ofx_proc_status_cb(const struct OfxStatusData data);

struct OfxAccountData{
  
  char account_id[OFX_ACCOUNT_ID_LENGTH];
  char account_name[OFX_ACCOUNT_NAME_LENGTH];
  int account_id_valid;/* Use for both account_id and account_name */

    enum AccountType{
    OFX_CHECKING,  
    OFX_SAVINGS,   
    OFX_MONEYMRKT, 
    OFX_CREDITLINE,
    OFX_CMA,       
    OFX_CREDITCARD,
    OFX_INVESTMENT 
  } account_type;
  int account_type_valid;
  char currency[OFX_CURRENCY_LENGTH]; 
  int currency_valid;

};

CFCT int ofx_proc_account_cb(const struct OfxAccountData data);

struct OfxSecurityData{
  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;

  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;
};/* end struct OfxSecurityData */

CFCT int ofx_proc_security_cb(const struct OfxSecurityData data);


struct OfxTransactionData{
  
  char account_id[OFX_ACCOUNT_ID_LENGTH];
  struct OfxAccountData * account_ptr; 
  int account_id_valid;
  enum TransactionType{
    OFX_CREDIT,     
    OFX_DEBIT,      
    OFX_INT,        
    OFX_DIV,        
    OFX_FEE,        
    OFX_SRVCHG,     
    OFX_DEP,        
    OFX_ATM,        
    OFX_POS,        
    OFX_XFER,       
    OFX_CHECK,      
    OFX_PAYMENT,    
    OFX_CASH,       
    OFX_DIRECTDEP,  
    OFX_DIRECTDEBIT,
    OFX_REPEATPMT,  
    OFX_OTHER       
  } transactiontype;
  int transactiontype_valid;
 
  enum InvTransactionType{
    OFX_BUYDEBT,        
    OFX_BUYMF,          
    OFX_BUYOPT,         
    OFX_BUYOTHER,       
    OFX_BUYSTOCK,       
    OFX_CLOSUREOPT,     
    OFX_INCOME,         
    OFX_INVEXPENSE,     
    OFX_JRNLFUND,       
    OFX_JRNLSEC,        
    OFX_MARGININTEREST, 
    OFX_REINVEST,       
    OFX_RETOFCAP,       
    OFX_SELLDEBT,       
    OFX_SELLMF,         
    OFX_SELLOPT,        
    OFX_SELLOTHER,      
    OFX_SELLSTOCK,      
    OFX_SPLIT,          
    OFX_TRANSFER        
  }  invtransactiontype;

 int  invtransactiontype_valid;

  double units;     
  int units_valid;
  double unitprice; 
  int unitprice_valid;
  double amount;    
  int amount_valid;
  char fi_id[256];  
  int fi_id_valid;
  
  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;
  struct OfxSecurityData *security_data_ptr;  
  int security_data_valid;
  
  time_t date_posted;
  int date_posted_valid;
  
  time_t date_initiated;
  int date_initiated_valid;
  time_t date_funds_available;
  int date_funds_available_valid;
  char fi_id_corrected[256];
  int fi_id_corrected_valid;
  enum FiIdCorrectionAction{
    DELETE, 
    REPLACE 
  } fi_id_correction_action;
  int fi_id_correction_action_valid;
  
  char server_transaction_id[OFX_SVRTID2_LENGTH];
  int server_transaction_id_valid;
char check_number[OFX_CHECK_NUMBER_LENGTH];
  int check_number_valid;
  char reference_number[OFX_REFERENCE_NUMBER_LENGTH];
  int reference_number_valid;
  long int standard_industrial_code;
  int standard_industrial_code_valid;
  char payee_id[OFX_SVRTID2_LENGTH];
  int payee_id_valid;
  char name[OFX_TRANSACTION_NAME_LENGTH];
  int name_valid;
  char memo[OFX_MEMO2_LENGTH];
  int memo_valid;

  /*********** NOT YET COMPLETE!!! *********************/
};

CFCT int ofx_proc_transaction_cb(const struct OfxTransactionData data);

struct OfxStatementData{

  char currency[OFX_CURRENCY_LENGTH]; 
  int currency_valid;
  char account_id[OFX_ACCOUNT_ID_LENGTH];
  struct OfxAccountData * account_ptr; 
  int account_id_valid;
  double ledger_balance;
  int ledger_balance_valid;
  time_t ledger_balance_date;
  int ledger_balance_date_valid;
  
  double available_balance; 
  int available_balance_valid;
  time_t available_balance_date;
  int available_balance_date_valid;
  time_t date_start;
  int date_start_valid;
  time_t date_end;
  int date_end_valid;
  char marketing_info[OFX_MARKETING_INFO_LENGTH];
  int marketing_info_valid;
};

CFCT int ofx_proc_statement_cb(const struct OfxStatementData data);

struct OfxCurrency{
  char currency[OFX_CURRENCY_LENGTH]; 
  double exchange_rate;  
  int must_convert;   
};

#endif

---