X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2FAPI.pm;h=a0f1dba2a4249df889eed4b3fe3bad91b70883de;hb=5f8111de04a4a914c72a1642722476db4728339c;hp=81efd674a8ad3607eae190c7ebe8ec4ee4c71cc6;hpb=fd3a3ce59e41f5116329043787a159fe1e08caad;p=freeside.git diff --git a/FS/FS/API.pm b/FS/FS/API.pm index 81efd674a..a0f1dba2a 100644 --- a/FS/FS/API.pm +++ b/FS/FS/API.pm @@ -28,7 +28,7 @@ integration with other back-office systems. If accessing this API remotely with XML-RPC or JSON-RPC, be careful to block the port by default, only allow access from back-office servers with the same security precations as the Freeside server, and encrypt the communication -channel (for exampple, with an SSH tunnel or VPN) rather than accessing it +channel (for example, with an SSH tunnel or VPN) rather than accessing it in plaintext. =head1 METHODS @@ -37,6 +37,31 @@ in plaintext. =item insert_payment +Adds a new payment to a customers account. Takes a hash reference as parameter with the following keys: + +=over 5 + +=item secret + +API Secret + +=item custnum + +Customer number + +=item payby + +Payment type + +=item paid + +Amount paid + +=item _date + + +Option date for payment + Example: my $result = FS::API->insert_payment( @@ -56,6 +81,8 @@ Example: print "paynum ". $result->{'paynum'}; } +=back + =cut #enter cash payment @@ -107,6 +134,26 @@ sub _by_phonenum { =item insert_credit +Adds a a credit to a customers account. Takes a hash reference as parameter with the following keys + +=over + +=item secret + +API Secret + +=item custnum + +customer number + +=item amount + +Amount of the credit + +=item _date + +The date the credit will be posted + Example: my $result = FS::API->insert_credit( @@ -125,6 +172,8 @@ Example: print "crednum ". $result->{'crednum'}; } +=back + =cut #Enter credit @@ -158,6 +207,8 @@ sub insert_credit_phonenum { =item insert_refund +Adds a a credit to a customers account. Takes a hash reference as parameter with the following keys: custnum,payby,refund + Example: my $result = FS::API->insert_refund( @@ -220,6 +271,133 @@ sub insert_refund_phonenum { =item new_customer +Creates a new customer. Takes a hash reference as parameter with the following keys: + +=over 4 + +=item secret + +API Secret + +=item first + +first name (required) + +=item last + +last name (required) + +=item ss + +(not typically collected; mostly used for ACH transactions) + +=item company + +Company name + +=item address1 (required) + +Address line one + +=item city (required) + +City + +=item county + +County + +=item state (required) + +State + +=item zip (required) + +Zip or postal code + +=item country + +2 Digit Country Code + +=item latitude + +latitude + +=item Longitude + +longitude + +=item geocode + +Currently used for third party tax vendor lookups + +=item censustract + +Used for determining FCC 477 reporting + +=item censusyear + +Used for determining FCC 477 reporting + +=item daytime + +Daytime phone number + +=item night + +Evening phone number + +=item fax + +Fax number + +=item mobile + +Mobile number + +=item invoicing_list + +comma-separated list of email addresses for email invoices. The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses), +postal_invoicing +Set to 1 to enable postal invoicing + +=item payby + +CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY + +=item payinfo + +Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL + +=item paycvv + +Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch) + +=item paydate + +Expiration date for CARD/DCRD + +=item payname + +Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK + +=item referral_custnum + +referring customer number + +=item agentnum + +Agent number + +=item agent_custid + +Agent specific customer number + +=item referral_custnum + +Referring customer number + + =cut #certainly false laziness w/ClientAPI::Signup new_customer/new_customer_minimal @@ -243,7 +421,7 @@ sub new_customer { 'payby' => 'BILL', map { $_ => $opt{$_} } qw( - agentnum refnum agent_custid + agentnum refnum agent_custid referral_custnum last first company daytime night fax mobile payby payinfo paydate paycvv payname @@ -290,22 +468,13 @@ sub new_customer { } -=item customer_info +=back -=cut +=item customer_info -#some false laziness w/ClientAPI::Myaccount customer_info/customer_info_short +Returns general customer information. Takes a hash reference as parameter with the following keys: custnum and API secret -use vars qw( @cust_main_editable_fields @location_editable_fields ); -@cust_main_editable_fields = qw( - first last company daytime night fax mobile -); -# locale -# payby payinfo payname paystart_month paystart_year payissue payip -# ss paytype paystate stateid stateid_state -@location_editable_fields = qw( - address1 address2 city county state zip country -); +=cut sub customer_info { my( $class, %opt ) = @_; @@ -316,41 +485,22 @@ sub customer_info { my $cust_main = qsearchs('cust_main', { 'custnum' => $opt{custnum} }) or return { 'error' => 'Unknown custnum' }; - my %return = ( - 'error' => '', - 'display_custnum' => $cust_main->display_custnum, - 'name' => $cust_main->first. ' '. $cust_main->get('last'), - 'balance' => $cust_main->balance, - 'status' => $cust_main->status, - 'statuscolor' => $cust_main->statuscolor, - ); + $cust_main->API_getinfo; - $return{$_} = $cust_main->get($_) - foreach @cust_main_editable_fields; - - for (@location_editable_fields) { - $return{$_} = $cust_main->bill_location->get($_) - if $cust_main->bill_locationnum; - $return{'ship_'.$_} = $cust_main->ship_location->get($_) - if $cust_main->ship_locationnum; - } +} - my @invoicing_list = $cust_main->invoicing_list; - $return{'invoicing_list'} = - join(', ', grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list ); - $return{'postal_invoicing'} = - 0 < ( grep { $_ eq 'POST' } @invoicing_list ); +=item location_info - #generally, the more useful data from the cust_main record the better. - # well, tell me what you want +Returns location specific information for the customer. Takes a hash reference as parameter with the following keys: custnum,secret - return \%return; +=back -} +=cut #I also monitor for changes to the additional locations that are applied to # packages, and would like for those to be exportable as well. basically the # location data passed with the custnum. + sub location_info { my( $class, %opt ) = @_; my $conf = new FS::Conf; @@ -369,6 +519,5 @@ sub location_info { #Advertising sources? -=back 1;