package FS::API;
+use strict;
use FS::Conf;
use FS::Record qw( qsearch qsearchs );
use FS::cust_main;
=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
=item _date
-
Option date for payment
+=back
+
Example:
my $result = FS::API->insert_payment(
print "paynum ". $result->{'paynum'};
}
-=back
-
=cut
#enter cash payment
}
-=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
The date the credit will be posted
+=back
+
Example:
my $result = FS::API->insert_credit(
print "crednum ". $result->{'crednum'};
}
-=back
-
=cut
#Enter credit
}
-=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:
# 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
=item referral_custnum
-referring customer number
+Referring customer number
+
+=item salesnum
+
+Sales person number
=item agentnum
Referring customer number
+=back
=cut
sub new_customer {
my( $class, %opt ) = @_;
+
my $conf = new FS::Conf;
return { 'error' => 'Incorrect shared secret' }
unless $opt{secret} eq $conf->config('api_shared_secret');
#default agentnum like signup_server-default_agentnum?
+ #$opt{agentnum} ||= $conf->config('signup_server-default_agentnum');
#same for refnum like signup_server-default_refnum
+ $opt{refnum} ||= $conf->config('signup_server-default_refnum');
- my $cust_main = new FS::cust_main ( {
- 'agentnum' => $agentnum,
- 'refnum' => $opt{refnum}
- || $conf->config('signup_server-default_refnum'),
- 'payby' => 'BILL',
-
- map { $_ => $opt{$_} } qw(
- agentnum refnum agent_custid referral_custnum
- last first company
- daytime night fax mobile
- payby payinfo paydate paycvv payname
- ),
-
- } );
-
- my @invoicing_list = $opt{'invoicing_list'}
- ? split( /\s*\,\s*/, $opt{'invoicing_list'} )
- : ();
- push @invoicing_list, 'POST' if $opt{'postal_invoicing'};
-
- my ($bill_hash, $ship_hash);
- foreach my $f (FS::cust_main->location_fields) {
- # avoid having to change this in front-end code
- $bill_hash->{$f} = $opt{"bill_$f"} || $opt{$f};
- $ship_hash->{$f} = $opt{"ship_$f"};
- }
+ $class->API_insert( %opt );
+}
- my $bill_location = FS::cust_location->new($bill_hash);
- my $ship_location;
- # we don't have an equivalent of the "same" checkbox in selfservice^Wthis API
- # so is there a ship address, and if so, is it different from the billing
- # address?
- if ( length($ship_hash->{address1}) > 0 and
- grep { $bill_hash->{$_} ne $ship_hash->{$_} } keys(%$ship_hash)
- ) {
-
- $ship_location = FS::cust_location->new( $ship_hash );
-
- } else {
- $ship_location = $bill_location;
- }
+=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 hash reference as parameter with the following keys:
- $cust_main->set('bill_location' => $bill_location);
- $cust_main->set('ship_location' => $ship_location);
+=over 4
- $error = $cust_main->insert( {}, \@invoicing_list );
- return { 'error' => $error } if $error;
-
- return { 'error' => '',
- 'custnum' => $cust_main->custnum,
- };
+=item secret
-}
+API Secret (required)
-=back
+=item custnum
-=item customer_info
+Customer number (required)
-Returns general customer information. Takes a hash reference as parameter with the following keys: custnum and API secret
+=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 '$
+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 "pi$
+
+=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');
+
+ FS::cust_main->API_update( %opt );
+}
+
+=item customer_info OPTION => VALUE, ...
+
+Returns general customer information. Takes a list of keys and values as
+parameters with the following keys: custnum, secret
=cut
or return { 'error' => 'Unknown custnum' };
$cust_main->API_getinfo;
-
}
=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
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.
+
+=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?
projects / freeside.git / blobdiff