List of external software interfaces

From GnuCash
Revision as of 10:44, 22 February 2011 by Cstim (talk | contribs) (Current interfaces: remove outdated qof)
Jump to: navigation, search

This article lists past and present external software interfaces of GnuCash, and suggests possible additional interfaces. It was started to figure out how one can "plug in" to gnucash.

This article is just descriptive, and neither normative nor authoritative.

Current interfaces

Legacy/unsupported interfaces

These interfaces were supported in prior versions of GnuCash.

Prospective interfaces

The main place for submitting enhancement requests is the Bugzilla database. Feel free to collect anything you want here on this page, especially any kind of overview, but please keep in mind that single issues are followed by the developers in Bugzilla much more closely.

  • CORBA, to communicate with a running GnuCash instance. E.g., a running GnuCash incarnates a CORBA object of type:
interface GnuCash // simplified
{
  exception GnuCashException

  typedef string Guid;

  struct Split
  {
    Guid id;
    boolean reconciledState;
    string value;
    string quantity;
    Guid account;
  };

  typedef sequence<Split> SplitSeq;

  struct Transaction
  {
    Guid id;
    string datePosted;
    string dateEntered;
    string description;
    SplitSeq splits;
  };

  void submitTransaction(in Transaction t)
    raises (GnuCashException);
};
  • linkable library (see also WishList#Export an API)
      • Note that the modular structure of gnucash "almost" already offers this -- the "engine" module is pretty much exactly this kind of API. Except that nobody recently tried to use it from anywhere outside of gnucash.
    • for communicating with a running GnuCash instance
    • for manipulation of GnuCash database or XML file directly

See also