X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2FAPI.pm;h=1e960c8d18804793f8debc01acf3e495922cbc5f;hb=ab9aa5b5d55eb7330b3435819663ef03538278e2;hp=609008b0567fc00e7973b844254a4fef7eefd6b7;hpb=f4787c50372862c133f7d020a7014f999f4a704a;p=freeside.git

diff --git a/FS/FS/API.pm b/FS/FS/API.pm
index 609008b05..1e960c8d1 100644
--- a/FS/FS/API.pm
+++ b/FS/FS/API.pm
@@ -23,7 +23,9 @@ This module implements a backend API for advanced back-office integration.
 In contrast to the self-service API, which authenticates an end-user and offers
 functionality to that end user, the backend API performs a simple shared-secret
 authentication and offers full, administrator functionality, enabling
-integration with other back-office systems.
+integration with other back-office systems.  Only access this API from a secure 
+network from other backoffice machines. DON'T use this API to create customer 
+portal functionality.
 
 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
@@ -35,9 +37,10 @@ in plaintext.
 
 =over 4
 
-=item insert_payment
+=item insert_payment OPTION => VALUE, ...
 
-Adds a new payment to a customers account. Takes a hash reference as parameter with the following keys:
+Adds a new payment to a customers account. Takes a list of keys and values as
+paramters with the following keys:
 
 =over 5
 
@@ -59,9 +62,10 @@ Amount paid
 
 =item _date
 
-
 Option date for payment
 
+=back
+
 Example:
 
   my $result = FS::API->insert_payment(
@@ -81,8 +85,6 @@ Example:
     print "paynum ". $result->{'paynum'};
   }
 
-=back
-
 =cut
 
 #enter cash payment
@@ -132,9 +134,10 @@ sub _by_phonenum {
 
 }
 
-=item insert_credit
+=item insert_credit OPTION => VALUE, ...
 
-Adds a a credit to a customers account. Takes a hash reference as parameter with the following keys
+Adds a a credit to a customers account.  Takes a list of keys and values as
+parameters with the following keys
 
 =over 
 
@@ -154,6 +157,8 @@ Amount of the credit
 
 The date the credit will be posted
 
+=back
+
 Example:
 
   my $result = FS::API->insert_credit(
@@ -172,8 +177,6 @@ Example:
     print "crednum ". $result->{'crednum'};
   }
 
-=back
-
 =cut
 
 #Enter credit
@@ -205,9 +208,10 @@ sub insert_credit_phonenum {
 
 }
 
-=item insert_refund
+=item insert_refund OPTION => VALUE, ...
 
-Adds a a credit to a customers account. Takes a hash reference as parameter with the following keys: custnum,payby,refund
+Adds a a credit to a customers account.  Takes a list of keys and values as
+parmeters with the following keys: custnum, payby, refund
 
 Example:
 
@@ -269,9 +273,10 @@ sub insert_refund_phonenum {
 
 # long-term: package changes?
 
-=item new_customer
+=item new_customer OPTION => VALUE, ...
 
-Creates a new customer. Takes a hash reference as parameter with the following keys:
+Creates a new customer. Takes a list of keys and values as parameters with the
+following keys:
 
 =over 4
 
@@ -401,6 +406,7 @@ Agent specific customer number
 
 Referring customer number
 
+=back
 
 =cut
 
@@ -473,11 +479,190 @@ sub new_customer {
 
 }
 
-=back 
+=item update_customer
+
+Updates an existing customer. Passing an empty value clears that field, while
+NOT passing that key/value at all leaves it alone. Takes a list of keys and
+values as parameters with the following keys:
+ 
+=over 4
+
+=item secret
+
+API Secret (required)
+
+=item custnum
+
+Customer number (required)
+
+=item first
+
+first name 
+
+=item last
+
+last name 
+
+=item company
+
+Company name
+
+=item address1 
+
+Address line one
+
+=item city 
+
+City
+
+=item county
+
+County
+
+=item state 
+
+State
+
+=item zip 
+
+Zip or postal code
+
+=item country
+
+2 Digit Country Code
+
+=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)
+
+=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 salesnum
+
+Sales person number
+
+=item agentnum
+
+Agent number
+
+=back
+
+=cut
+
+sub update_customer {
+
+ my( $class, %opt ) = @_;
+
+  my $conf = new FS::Conf;
+  return { 'error' => 'Incorrect shared secret' }
+    unless $opt{secret} eq $conf->config('api_shared_secret');
+
+
+  my $custnum = $opt{'custnum'}
+    or return { 'error' => "no customer record" };
+
+  my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
+    or return { 'error' => "unknown custnum $custnum" };
+
+  my $new = new FS::cust_main { $cust_main->hash };
+
+  $new->set( $_ => $opt{$_} )
+    foreach grep { exists $opt{$_} } qw(
+        agentnum salesnum refnum agent_custid referral_custnum
+        last first company
+        daytime night fax mobile
+        payby payinfo paydate paycvv payname
+      ),
+
+  my @invoicing_list;
+  if ( exists $opt{'invoicing_list'} || exists $opt{'postal_invoicing'} ) {
+    @invoicing_list = split( /\s*\,\s*/, $opt{'invoicing_list'} );
+    push @invoicing_list, 'POST' if $opt{'postal_invoicing'};
+  } else {
+    @invoicing_list = $cust_main->invoicing_list;
+  }
+ 
+  if ( exists( $opt{'address1'} ) ) {
+    my $bill_location = FS::cust_location->new({
+        map { $_ => $opt{$_} } @location_editable_fields
+    });
+    $bill_location->set('custnum' => $custnum);
+    my $error = $bill_location->find_or_insert;
+    die $error if $error;
+
+    # if this is unchanged from before, cust_main::replace will ignore it
+    $new->set('bill_location' => $bill_location);
+  }
+
+  if ( exists($opt{'ship_address1'}) && length($opt{"ship_address1"}) > 0 ) {
+    my $ship_location = FS::cust_location->new({
+        map { $_ => $opt{"ship_$_"} } @location_editable_fields
+    });
+
+    $ship_location->set('custnum' => $custnum);
+    my $error = $ship_location->find_or_insert;
+    die $error if $error;
+
+    $new->set('ship_location' => $ship_location);
+
+   } elsif (exists($opt{'ship_address1'} ) && !grep { length($opt{"ship_$_"}) } @location_editable_fields ) {
+      my $ship_location = $new->bill_location;
+     $new->set('ship_location' => $ship_location);
+    }
+
+  my $error = $new->replace( $cust_main, \@invoicing_list );
+  return { 'error'   => $error } if $error;
+
+  return { 'error'   => '',
+         };  
+}
+
 
 =item customer_info
 
-Returns general customer information. Takes a hash reference as parameter with the following keys: custnum and API secret 
+Returns general customer information. Takes a list of keys and values as
+parameters with the following keys: custnum, secret 
 
 =cut
 
@@ -538,9 +723,8 @@ sub customer_info {
 
 =item location_info
 
-Returns location specific information for the customer. Takes a hash reference as parameter with the following keys: custnum,secret
-
-=back
+Returns location specific information for the customer. Takes a list of keys
+and values as paramters with the following keys: custnum, secret
 
 =cut
 
@@ -564,6 +748,49 @@ sub location_info {
   return \%return;
 }
 
+=item bill_now OPTION => VALUE, ...
+
+Bills a single customer now, in the same fashion as the "Bill now" link in the
+UI.
+
+Returns a hash reference with a single key, 'error'.  If there is an error,   
+the value contains the error, otherwise it is empty. Takes a list of keys and
+values as parameters with the following keys:
+
+=over 4
+
+=item secret
+
+API Secret (required)
+
+=item custnum
+
+Customer number (required)
+
+=back
+
+=cut
+
+sub bill_now {
+  my( $class, %opt ) = @_;
+  my $conf = new FS::Conf;
+  return { 'error' => 'Incorrect shared secret' }
+    unless $opt{secret} eq $conf->config('api_shared_secret');
+
+  my $cust_main = qsearchs('cust_main', { 'custnum' => $opt{custnum} })
+    or return { 'error' => 'Unknown custnum' };
+
+  my $error = $cust_main->bill_and_collect( 'fatal'      => 'return',
+                                            'retry'      => 1,
+                                            'check_freq' =>'1d',
+                                          );
+
+   return { 'error' => $error,
+          };
+
+}
+
+
 #Advertising sources?