LibOFX
inc/libofx.h
Go to the documentation of this file.
1 /*-*-c-*-*******************************************************************
2  libofx.h - Main header file for the libofx API
3  -------------------
4  copyright : (C) 2002-2011 by Benoit GrĂ©goire
5  email : benoitg@coeus.ca
6 ***************************************************************************/
26 /***************************************************************************
27  * *
28  * This program is free software; you can redistribute it and/or modify *
29  * it under the terms of the GNU General Public License as published by *
30  * the Free Software Foundation; either version 2 of the License, or *
31  * (at your option) any later version. *
32  * *
33  ***************************************************************************/
34 
35 #ifndef LIBOFX_H
36 #define LIBOFX_H
37 #include <time.h>
38 
39 #define LIBOFX_MAJOR_VERSION 0
40 #define LIBOFX_MINOR_VERSION 9
41 #define LIBOFX_MICRO_VERSION 11
42 #define LIBOFX_BUILD_VERSION 0
43 #define LIBOFX_VERSION_RELEASE_STRING "0.9.11"
44 
45 #ifdef IN_LIBOFX
46 # include "config.h"
47 # ifdef HAVE_GCC_VISIBILITY_EXTS
48 # pragma GCC visibility push(default)
49 # endif
50 #endif
51 
52 #ifdef __cplusplus
53 extern "C" {
54 #else
55 #define true 1
56 #define false 0
57 #endif
58 
59 #define OFX_ELEMENT_NAME_LENGTH 100
60 #define OFX_SVRTID2_LENGTH (36 + 1)
61 #define OFX_CHECK_NUMBER_LENGTH (12 + 1)
62 #define OFX_REFERENCE_NUMBER_LENGTH (32 + 1)
63 #define OFX_FITID_LENGTH (255 + 1)
64 #define OFX_TOKEN2_LENGTH (36 + 1)
65 #define OFX_MEMO_LENGTH (255 + 1)
66 #define OFX_FIID_LENGTH (32 + 1)
67 #define OFX_MEMO2_LENGTH (390 + 1)
68 #define OFX_BALANCE_NAME_LENGTH (32 + 1)
69 #define OFX_BALANCE_DESCRIPTION_LENGTH (80 + 1)
70 #define OFX_CURRENCY_LENGTH (3 + 1) /* In ISO-4217 format */
71 #define OFX_BANKID_LENGTH (9 + 1)
72 #define OFX_BRANCHID_LENGTH (22 + 1)
73 #define OFX_ACCTID_LENGTH (22 + 1)
74 #define OFX_ACCTKEY_LENGTH (22 + 1)
75 #define OFX_BROKERID_LENGTH (22 + 1)
76  /* Must be MAX of <BANKID>+<BRANCHID>+<ACCTID>, <ACCTID>+<ACCTKEY> and <ACCTID>+<BROKERID> */
77 #define OFX_ACCOUNT_ID_LENGTH (OFX_BANKID_LENGTH + OFX_BRANCHID_LENGTH + OFX_ACCTID_LENGTH + 1)
78 #define OFX_ACCOUNT_NAME_LENGTH 255
79 #define OFX_MARKETING_INFO_LENGTH (360 + 1)
80 #define OFX_TRANSACTION_NAME_LENGTH (96 + 1)
81 #define OFX_UNIQUE_ID_LENGTH (32 + 1)
82 #define OFX_UNIQUE_ID_TYPE_LENGTH (10 + 1)
83 #define OFX_SECNAME_LENGTH (32 + 1)
84 #define OFX_TICKER_LENGTH (32 + 1)
85 #define OFX_ORG_LENGTH (32 + 1)
86 #define OFX_FID_LENGTH (32 + 1)
87 #define OFX_USERID_LENGTH (32 + 1)
88 #define OFX_USERPASS_LENGTH (32 + 1)
89 #define OFX_URL_LENGTH (500 + 1)
90 #define OFX_APPID_LENGTH (32)
91 #define OFX_APPVER_LENGTH (32)
92 #define OFX_HEADERVERSION_LENGTH (32)
93 #define OFX_CLIENTUID_LENGTH (36 + 1)
94 
95  /*
96  #define OFX_STATEMENT_CB 0;
97  #define OFX_ACCOUNT_CB 1;
98  #define OFX_TRACSACTION_CB 2;
99  #define OFX_SECURITY_CB 3;
100  #define OFX_STATUS_CB 4;
101  */
102 
103  typedef void * LibofxContextPtr;
104 
110  LibofxContextPtr libofx_get_new_context();
111 
117  int libofx_free_context( LibofxContextPtr );
118 
119  void libofx_set_dtd_dir(LibofxContextPtr libofx_context,
120  const char *s);
121 
124  {
126  OFX,
127  OFC,
128  QIF,
131  };
132 
134  {
136  const char * format_name;
137  const char * description;
138  };
139 
140 
141 #ifndef OFX_AQUAMANIAC_UGLY_HACK1
142 
143  const struct LibofxFileFormatInfo LibofxImportFormatList[] =
144  {
145  {AUTODETECT, "AUTODETECT", "AUTODETECT (File format will be automatically detected later)"},
146  {OFX, "OFX", "OFX (Open Financial eXchange (OFX or QFX))"},
147  {OFC, "OFC", "OFC (Microsoft Open Financial Connectivity)"},
148  {QIF, "QIF", "QIF (Intuit Quicken Interchange Format) NOT IMPLEMENTED"},
149  {LAST, "LAST", "Not a file format, meant as a loop breaking condition"}
150  };
151 
152  const struct LibofxFileFormatInfo LibofxExportFormatList[] =
153  {
154  {QIF, "QIF", "QIF (Intuit Quicken Interchange Format) NOT IMPLEMENTED"},
155  {LAST, "LAST", "Not a file format, meant as a loop breaking condition"}
156  };
157 
169  enum LibofxFileFormat libofx_get_file_format_from_str(const struct LibofxFileFormatInfo format_list[], const char * file_type_string);
170 
182  const char * libofx_get_file_format_description(const struct LibofxFileFormatInfo format_list[], enum LibofxFileFormat file_format);
183 
184 #endif
185 
192  int libofx_proc_file(LibofxContextPtr libofx_context,
193  const char * p_filename,
194  enum LibofxFileFormat ftype);
195 
196 
210  {
215  char ofx_element_name[OFX_ELEMENT_NAME_LENGTH];
218 
223  int code;
224  const char* name;
225  const char* description;
229  enum Severity
230  {
234  } severity;
235  int severity_valid;
236 
244  int server_message_valid;
246  };
247 
248 
258  typedef int (*LibofxProcStatusCallback)(const struct OfxStatusData data, void * status_data);
259 
272  {
273 
285  char account_id[OFX_ACCOUNT_ID_LENGTH];
286 
292  char account_name[OFX_ACCOUNT_NAME_LENGTH];
293  int account_id_valid;/* Use for both account_id and account_name */
294 
298  {
306  } account_type;
307  int account_type_valid;
308 
310  char currency[OFX_CURRENCY_LENGTH];
311  int currency_valid;
312 
314  char account_number[OFX_ACCTID_LENGTH];
315  int account_number_valid;
316 
318  char bank_id[OFX_BANKID_LENGTH];
319  int bank_id_valid;
320 
321  char broker_id[OFX_BROKERID_LENGTH];
322  int broker_id_valid;
323 
324  char branch_id[OFX_BRANCHID_LENGTH];
325  int branch_id_valid;
326 
327  };
328 
343  typedef int (*LibofxProcAccountCallback)(const struct OfxAccountData data, void * account_data);
344 
353  {
361  char unique_id[OFX_UNIQUE_ID_LENGTH];
362  int unique_id_valid;
363 
364  char unique_id_type[OFX_UNIQUE_ID_TYPE_LENGTH];
366  int unique_id_type_valid;
367 
368  char secname[OFX_SECNAME_LENGTH];
369  int secname_valid;
370 
376  char ticker[OFX_TICKER_LENGTH];
377  int ticker_valid;
378 
379  double unitprice;
381  int unitprice_valid;
382 
384  int date_unitprice_valid;
385 
388  char currency[OFX_CURRENCY_LENGTH];
389  int currency_valid;
390 
391  char memo[OFX_MEMO2_LENGTH];
392  int memo_valid;
393 
396  char fiid[OFX_FIID_LENGTH];
397  int fiid_valid;
398 
399  };/* end struct OfxSecurityData */
400 
414  typedef int (*LibofxProcSecurityCallback)(const struct OfxSecurityData data, void * security_data);
415 
416  typedef enum
417  {
435  } TransactionType;
436 
437  typedef enum
438  {
460 
461  typedef enum
462  {
468 
476  {
477 
483  char account_id[OFX_ACCOUNT_ID_LENGTH];
488  int account_id_valid;
489 
490  TransactionType transactiontype;
492 
496  InvTransactionType invtransactiontype;
497  int invtransactiontype_valid;
498 
506  double units;
507  int units_valid;
508 
509  double unitprice;
511  int unitprice_valid;
512 
513  double amount;
517  int amount_valid;
518 
519  char fi_id[256];
522  int fi_id_valid;
523 
531  char unique_id[OFX_UNIQUE_ID_LENGTH];
532  int unique_id_valid;
533  char unique_id_type[OFX_UNIQUE_ID_TYPE_LENGTH];
535  int unique_id_type_valid;
536 
537  struct OfxSecurityData *security_data_ptr;
539 
540  time_t date_posted;
545  int date_posted_valid;
546 
553  int date_initiated_valid;
554 
558  int date_funds_available_valid;
559 
563  char fi_id_corrected[256];
564  int fi_id_corrected_valid;
565 
569  int fi_id_correction_action_valid;
570 
573  char server_transaction_id[OFX_SVRTID2_LENGTH];
574  int server_transaction_id_valid;
575 
579  char check_number[OFX_CHECK_NUMBER_LENGTH];
580  int check_number_valid;
581 
584  char reference_number[OFX_REFERENCE_NUMBER_LENGTH];
585  int reference_number_valid;
586 
589  int standard_industrial_code_valid;
590 
591  char payee_id[OFX_SVRTID2_LENGTH];
592  int payee_id_valid;
593 
594  char name[OFX_TRANSACTION_NAME_LENGTH];
596  int name_valid;
597 
598  char memo[OFX_MEMO2_LENGTH];
599  int memo_valid;
600 
601  double commission;
602  int commission_valid;
603 
604  double fees;
605  int fees_valid;
606 
607  double oldunits; /*number of units held before stock split */
608  int oldunits_valid;
609 
610  double newunits; /*number of units held after stock split */
611  int newunits_valid;
612 
613 
614  /*********** NOT YET COMPLETE!!! *********************/
615  };
616 
626  typedef int (*LibofxProcTransactionCallback)(const struct OfxTransactionData data, void * transaction_data);
627 
638  {
639 
647  char currency[OFX_CURRENCY_LENGTH];
648  int currency_valid;
649 
650  char account_id[OFX_ACCOUNT_ID_LENGTH];
654  int account_id_valid;
655 
659  int ledger_balance_valid;
660 
662  int ledger_balance_date_valid;
663 
672  int available_balance_valid;
673 
674  time_t available_balance_date;
676 
681  time_t date_start;
682  int date_start_valid;
683 
688  time_t date_end;
689  int date_end_valid;
690 
693  char marketing_info[OFX_MARKETING_INFO_LENGTH];
694  int marketing_info_valid;
695  };
696 
704  typedef int (*LibofxProcStatementCallback)(const struct OfxStatementData data, void * statement_data);
705 
709  struct OfxCurrency
710  {
711  char currency[OFX_CURRENCY_LENGTH];
712  double exchange_rate;
714  };
715 
716 
723  void ofx_set_status_cb(LibofxContextPtr ctx,
725  void *user_data);
726 
733  void ofx_set_account_cb(LibofxContextPtr ctx,
735  void *user_data);
736 
743  void ofx_set_security_cb(LibofxContextPtr ctx,
745  void *user_data);
746 
753  void ofx_set_transaction_cb(LibofxContextPtr ctx,
755  void *user_data);
756 
763  void ofx_set_statement_cb(LibofxContextPtr ctx,
765  void *user_data);
766 
767 
771  int libofx_proc_buffer(LibofxContextPtr ctx,
772  const char *s, unsigned int size);
773 
774 
775  /* **************************************** */
776 
782 
787  {
788  char fid[OFX_FID_LENGTH];
789  char org[OFX_ORG_LENGTH];
790  char url[OFX_URL_LENGTH];
793  int billpay;
795  };
796 
806  struct OfxFiLogin
807  {
808  char fid[OFX_FID_LENGTH];
809  char org[OFX_ORG_LENGTH];
810  char userid[OFX_USERID_LENGTH];
811  char userpass[OFX_USERPASS_LENGTH];
812  char header_version[OFX_HEADERVERSION_LENGTH];
813  char appid[OFX_APPID_LENGTH];
814  char appver[OFX_APPVER_LENGTH];
815  char clientuid[OFX_CLIENTUID_LENGTH];
816  };
817 
818 #define OFX_AMOUNT_LENGTH (32 + 1)
819 #define OFX_PAYACCT_LENGTH (32 + 1)
820 #define OFX_STATE_LENGTH (5 + 1)
821 #define OFX_POSTALCODE_LENGTH (11 + 1)
822 #define OFX_NAME_LENGTH (32 + 1)
823 
824  struct OfxPayment
825  {
826  char amount[OFX_AMOUNT_LENGTH];
827  char account[OFX_PAYACCT_LENGTH];
828  char datedue[9];
829  char memo[OFX_MEMO_LENGTH];
830  };
831 
832  struct OfxPayee
833  {
834  char name[OFX_NAME_LENGTH];
835  char address1[OFX_NAME_LENGTH];
836  char city[OFX_NAME_LENGTH];
837  char state[OFX_STATE_LENGTH];
838  char postalcode[OFX_POSTALCODE_LENGTH];
839  char phone[OFX_NAME_LENGTH];
840  };
841 
853  char* libofx_request_statement( const struct OfxFiLogin* fi, const struct OfxAccountData* account, time_t date_from );
854 
865  char* libofx_request_accountinfo( const struct OfxFiLogin* login );
866 
867  char* libofx_request_payment( const struct OfxFiLogin* login, const struct OfxAccountData* account, const struct OfxPayee* payee, const struct OfxPayment* payment );
868 
869  char* libofx_request_payment_status( const struct OfxFiLogin* login, const char* transactionid );
870 
872 
873 extern int ofx_PARSER_msg;
874 extern int ofx_DEBUG_msg;
875 extern int ofx_DEBUG1_msg;
876 extern int ofx_DEBUG2_msg;
877 extern int ofx_DEBUG3_msg;
878 extern int ofx_DEBUG4_msg;
879 extern int ofx_DEBUG5_msg;
880 extern int ofx_STATUS_msg;
881 extern int ofx_INFO_msg;
882 extern int ofx_WARNING_msg;
883 extern int ofx_ERROR_msg;
884 extern int ofx_show_position;
886 #ifdef __cplusplus
887 } // end of extern "C"
888 #endif
889 
890 #if defined(HAVE_GCC_VISIBILITY_EXTS) && defined(IN_LIBOFX)
891 # pragma GCC visibility pop
892 #endif
893 
894 #endif // end of LIBOFX_H
time_t ledger_balance_date
Definition: inc/libofx.h:661
An abstraction of an account.
Definition: inc/libofx.h:271
enum LibofxFileFormat libofx_get_file_format_from_str(const struct LibofxFileFormatInfo format_list[], const char *file_type_string)
libofx_get_file_type returns a proper enum from a file type string.
int ofx_DEBUG1_msg
Definition: messages.cpp:32
enum LibofxFileFormat format
Definition: inc/libofx.h:135
char reference_number[OFX_REFERENCE_NUMBER_LENGTH]
Definition: inc/libofx.h:584
int(* LibofxProcAccountCallback)(const struct OfxAccountData data, void *account_data)
The callback function for the OfxAccountData stucture.
Definition: inc/libofx.h:343
InvTransactionType
Definition: inc/libofx.h:437
double available_balance
Definition: inc/libofx.h:669
char * libofx_request_statement(const struct OfxFiLogin *fi, const struct OfxAccountData *account, time_t date_from)
Creates an OFX statement request in string form.
char unique_id[OFX_UNIQUE_ID_LENGTH]
Definition: inc/libofx.h:531
char account_id[OFX_ACCOUNT_ID_LENGTH]
Definition: inc/libofx.h:285
const char * description
Definition: inc/libofx.h:137
double exchange_rate
Definition: inc/libofx.h:712
const char * description
Definition: inc/libofx.h:225
char fi_id_corrected[256]
Definition: inc/libofx.h:563
int(* LibofxProcTransactionCallback)(const struct OfxTransactionData data, void *transaction_data)
The callback function for the OfxTransactionData stucture.
Definition: inc/libofx.h:626
char currency[OFX_CURRENCY_LENGTH]
Definition: inc/libofx.h:310
char check_number[OFX_CHECK_NUMBER_LENGTH]
Definition: inc/libofx.h:579
char name[OFX_TRANSACTION_NAME_LENGTH]
Definition: inc/libofx.h:594
char marketing_info[OFX_MARKETING_INFO_LENGTH]
Definition: inc/libofx.h:693
char memo[OFX_MEMO2_LENGTH]
Definition: inc/libofx.h:598
FiIdCorrectionAction fi_id_correction_action
Definition: inc/libofx.h:568
char currency[OFX_CURRENCY_LENGTH]
Definition: inc/libofx.h:388
char * libofx_request_accountinfo(const struct OfxFiLogin *login)
Creates an OFX account info (list) request in string form.
int ofx_STATUS_msg
Definition: messages.cpp:37
int ofx_WARNING_msg
Definition: messages.cpp:39
int(* LibofxProcSecurityCallback)(const struct OfxSecurityData data, void *security_data)
The callback function for the OfxSecurityData stucture.
Definition: inc/libofx.h:414
LibofxContextPtr libofx_get_new_context()
Initialise the library and return a new context.
Definition: context.cpp:153
int ofx_PARSER_msg
Definition: messages.cpp:30
const char * libofx_get_file_format_description(const struct LibofxFileFormatInfo format_list[], enum LibofxFileFormat file_format)
get_file_format_description returns a string description of a LibofxFileType.
long int standard_industrial_code
Definition: inc/libofx.h:587
char account_id[OFX_ACCOUNT_ID_LENGTH]
Definition: inc/libofx.h:650
char memo[OFX_MEMO2_LENGTH]
Definition: inc/libofx.h:391
void ofx_set_statement_cb(LibofxContextPtr ctx, LibofxProcStatementCallback cb, void *user_data)
Definition: context.cpp:213
char fiid[OFX_FIID_LENGTH]
Definition: inc/libofx.h:396
void ofx_set_status_cb(LibofxContextPtr ctx, LibofxProcStatusCallback cb, void *user_data)
Definition: context.cpp:178
void ofx_set_account_cb(LibofxContextPtr ctx, LibofxProcAccountCallback cb, void *user_data)
Definition: context.cpp:186
char currency[OFX_CURRENCY_LENGTH]
Definition: inc/libofx.h:711
char account_id[OFX_ACCOUNT_ID_LENGTH]
Definition: inc/libofx.h:483
char unique_id[OFX_UNIQUE_ID_LENGTH]
Definition: inc/libofx.h:361
char account_name[OFX_ACCOUNT_NAME_LENGTH]
Definition: inc/libofx.h:292
FiIdCorrectionAction
Definition: inc/libofx.h:461
char * server_message
Definition: inc/libofx.h:242
struct OfxAccountData * account_ptr
Definition: inc/libofx.h:486
time_t date_unitprice
Definition: inc/libofx.h:383
int libofx_proc_buffer(LibofxContextPtr ctx, const char *s, unsigned int size)
TransactionType
Definition: inc/libofx.h:416
char server_transaction_id[OFX_SVRTID2_LENGTH]
Definition: inc/libofx.h:573
struct OfxAccountData * account_ptr
Definition: inc/libofx.h:652
int ofx_DEBUG5_msg
Definition: messages.cpp:36
char bank_id[OFX_BANKID_LENGTH]
Definition: inc/libofx.h:318
int(* LibofxProcStatusCallback)(const struct OfxStatusData data, void *status_data)
The callback function for the OfxStatusData stucture.
Definition: inc/libofx.h:258
int ofx_show_position
Definition: messages.cpp:41
An abstraction of an OFX STATUS element.
Definition: inc/libofx.h:209
void ofx_set_security_cb(LibofxContextPtr ctx, LibofxProcSecurityCallback cb, void *user_data)
Definition: context.cpp:195
double unitprice
Definition: inc/libofx.h:379
char unique_id_type[OFX_UNIQUE_ID_TYPE_LENGTH]
Definition: inc/libofx.h:364
int ofx_DEBUG4_msg
Definition: messages.cpp:35
const char * format_name
Definition: inc/libofx.h:136
int ofx_ERROR_msg
Definition: messages.cpp:40
int available_balance_date_valid
Definition: inc/libofx.h:675
char ticker[OFX_TICKER_LENGTH]
Definition: inc/libofx.h:376
Information returned by the OFX Partner Server about a financial institution.
Definition: inc/libofx.h:786
char payee_id[OFX_SVRTID2_LENGTH]
Definition: inc/libofx.h:591
An abstraction of a security, such as a stock, mutual fund, etc.
Definition: inc/libofx.h:352
int ofx_element_name_valid
Definition: inc/libofx.h:217
void ofx_set_transaction_cb(LibofxContextPtr ctx, LibofxProcTransactionCallback cb, void *user_data)
Definition: context.cpp:204
int ofx_DEBUG2_msg
Definition: messages.cpp:33
int(* LibofxProcStatementCallback)(const struct OfxStatementData data, void *statement_data)
The callback function for the OfxStatementData stucture.
Definition: inc/libofx.h:704
int ofx_INFO_msg
Definition: messages.cpp:38
An abstraction of a transaction in an account.
Definition: inc/libofx.h:475
int must_convert
Definition: inc/libofx.h:713
time_t date_funds_available
Definition: inc/libofx.h:555
NOT YET SUPPORTED.
Definition: inc/libofx.h:709
LibofxFileFormat
Definition: inc/libofx.h:123
int libofx_proc_file(LibofxContextPtr libofx_context, const char *p_filename, enum LibofxFileFormat ftype)
libofx_proc_file is the entry point of the library.
const char * name
Definition: inc/libofx.h:224
char account_number[OFX_ACCTID_LENGTH]
Definition: inc/libofx.h:314
int ofx_DEBUG_msg
Definition: messages.cpp:31
char unique_id_type[OFX_UNIQUE_ID_TYPE_LENGTH]
Definition: inc/libofx.h:533
char currency[OFX_CURRENCY_LENGTH]
Definition: inc/libofx.h:647
double ledger_balance
Definition: inc/libofx.h:658
int libofx_free_context(LibofxContextPtr)
Free all ressources used by this context.
Definition: context.cpp:158
An abstraction of an account statement.
Definition: inc/libofx.h:637
char secname[OFX_SECNAME_LENGTH]
Definition: inc/libofx.h:368
int ofx_DEBUG3_msg
Definition: messages.cpp:34
Information sufficient to log into an financial institution.
Definition: inc/libofx.h:806