Brandon Fosdick > Finance-OFX-2a > Finance::OFX

Download:
Finance-OFX-2a.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 2   Source  

NAME ^

Finance::OFX - An OFX client implementation.

SYNOPSIS ^

 use Finance::OFX;
 use Finance::OFX::Institution;
 
 my $fi = Finance::OFX::Institution->new(ORG => $org, FID => $fid, URL => $url);
 my $ofx = Finance::OFX->new(userID=>$user, userPass=>$pass, Institution => $fi);
 my @accounts = $ofx->accounts;

DESCRIPTION ^

Finance::OFX provides several convenience functions for interacting with OFX servers.

CONSTRUCTOR ^

$ua = Finance::OFX->new( %options )

Constructs a new Finance::OFX object and returns it. %options can be anything accepted by Finance::OFX::UserAgent.

ATTRIBUTES ^

$ofx->institution

Get/Set the Finance::OFX::Institution object used by the Finance::OFX::UserAgent object.

$ofx->response

Get the most recent Finance::OFX::Response generated by Finance::OFX::UserAgent.

$ofx->user_id

Get/Set the OFX user ID. Wraps Finance::OFX::UserAgent::user_id().

$ofx->user_pass

Get/Set the OFX user password. Wraps Finance::OFX::UserAgent::user_pass().

METHODS ^

These are convenience functions that wrap calls to Finance::OFX::UserAgent and post-process the results.

$ofx->accounts()

Get a list of the user's accounts at the configured Financial Institution.

$ofx->balance( $acct )

Get the latest balance statement for the given account at the configured Financial Institution.

$ofx->transactions( $acct [ $start [ $end ] ] )

Get the transaction list for the given account. Some Financial Institutions will accept a full, or partial, date range. Others simply ignore the date range.

SEE ALSO ^

Finance::OFX::Account Finance::OFX::Institution Finance::OFX::Parse Finance::OFX::UserAgent http://ofx.net

WARNING ^

From Finance::Bank::LloydsTSB:

This is code for online banking, and that means your money, and that means BE CAREFUL. You are encouraged, nay, expected, to audit the source of this module yourself to reassure yourself that I am not doing anything untoward with your banking data. This software is useful to me, but is provided under NO GUARANTEE, explicit or implied.

AUTHOR ^

Brandon Fosdick, <bfoz@bfoz.net>

COPYRIGHT AND LICENSE ^

Copyright 2008 Brandon Fosdick <bfoz@bfoz.net>

This software is provided under the terms of the BSD License.

syntax highlighting: