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
=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
+=over 4
=item secret
=item _date
-
Option date for payment
+=back
+
Example:
my $result = FS::API->insert_payment(
print "paynum ". $result->{'paynum'};
}
-=back
-
=cut
#enter cash payment
sub insert_payment {
my($class, %opt) = @_;
- my $conf = new FS::Conf;
- return { 'error' => 'Incorrect shared secret' }
- unless $opt{secret} eq $conf->config('api_shared_secret');
+ return _shared_secret_error() unless _check_shared_secret($opt{secret});
#less "raw" than this? we are the backoffice API, and aren't worried
# about version migration ala cust_main/cust_location here
# pass the phone number ( from svc_phone )
sub insert_payment_phonenum {
my($class, %opt) = @_;
- my $conf = new FS::Conf;
- return { 'error' => 'Incorrect shared secret' }
- unless $opt{secret} eq $conf->config('api_shared_secret');
-
$class->_by_phonenum('insert_payment', %opt);
-
}
sub _by_phonenum {
my($class, $method, %opt) = @_;
- my $conf = new FS::Conf;
- return { 'error' => 'Incorrect shared secret' }
- unless $opt{secret} eq $conf->config('api_shared_secret');
+ return _shared_secret_error() unless _check_shared_secret($opt{secret});
my $phonenum = delete $opt{'phonenum'};
$opt{'custnum'} = $cust_pkg->custnum;
$class->$method(%opt);
-
}
-=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
sub insert_credit {
my($class, %opt) = @_;
- my $conf = new FS::Conf;
- return { 'error' => 'Incorrect shared secret' }
- unless $opt{secret} eq $conf->config('api_shared_secret');
+ return _shared_secret_error() unless _check_shared_secret($opt{secret});
- $opt{'reasonnum'} ||= $conf->config('api_credit_reason');
+ $opt{'reasonnum'} ||= FS::Conf->new->config('api_credit_reason');
#less "raw" than this? we are the backoffice API, and aren't worried
# about version migration ala cust_main/cust_location here
# pass the phone number ( from svc_phone )
sub insert_credit_phonenum {
my($class, %opt) = @_;
- my $conf = new FS::Conf;
- return { 'error' => 'Incorrect shared secret' }
- unless $opt{secret} eq $conf->config('api_shared_secret');
-
$class->_by_phonenum('insert_credit', %opt);
+}
+
+=item apply_payments_and_credits
+
+Applies payments and credits for this customer. Takes a list of keys and
+values as parameter with the following keys:
+
+=over 4
+
+=item secret
+API secret
+
+=item custnum
+
+Customer number
+
+=back
+
+=cut
+
+#apply payments and credits
+sub apply_payments_and_credits {
+ my($class, %opt) = @_;
+ return _shared_secret_error() unless _check_shared_secret($opt{secret});
+
+ my $cust_main = qsearchs('cust_main', { 'custnum' => $opt{custnum} })
+ or return { 'error' => 'Unknown custnum' };
+
+ my $error = $cust_main->apply_payments_and_credits( 'manual'=>1 );
+ return { 'error' => $error, };
}
-=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:
#Enter cash refund.
sub insert_refund {
my($class, %opt) = @_;
- my $conf = new FS::Conf;
- return { 'error' => 'Incorrect shared secret' }
- unless $opt{secret} eq $conf->config('api_shared_secret');
+ return _shared_secret_error() unless _check_shared_secret($opt{secret});
# when github pull request #24 is merged,
# will have to change over to default reasonnum like credit
# pass the phone number ( from svc_phone )
sub insert_refund_phonenum {
my($class, %opt) = @_;
- my $conf = new FS::Conf;
- return { 'error' => 'Incorrect shared secret' }
- unless $opt{secret} eq $conf->config('api_shared_secret');
-
$class->_by_phonenum('insert_refund', %opt);
-
}
#---
# 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
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
+=item referral_custnum
-Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
+Referring customer number
-=item referral_custnum
+=item salesnum
-referring customer number
+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');
+ return _shared_secret_error() unless _check_shared_secret($opt{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');
+ $opt{refnum} ||= FS::Conf->new->config('signup_server-default_refnum');
$class->API_insert( %opt );
}
-=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
-=item customer_info
+State
+
+=item zip
+
+Zip or postal code
+
+=item country
-Returns general customer information. Takes a hash reference as parameter with the following keys: custnum and API secret
+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),
+postal_invoicing
+Set to 1 to enable postal invoicing
+
+=item referral_custnum
+
+Referring customer number
+
+=item salesnum
+
+Sales person number
+
+=item agentnum
+
+Agent number
+
+=back
+
+=cut
+
+sub update_customer {
+ my( $class, %opt ) = @_;
+ return _shared_secret_error() unless _check_shared_secret($opt{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
sub customer_info {
my( $class, %opt ) = @_;
- my $conf = new FS::Conf;
- return { 'error' => 'Incorrect shared secret' }
- unless $opt{secret} eq $conf->config('api_shared_secret');
+ return _shared_secret_error() unless _check_shared_secret($opt{secret});
my $cust_main = qsearchs('cust_main', { 'custnum' => $opt{custnum} })
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
sub location_info {
my( $class, %opt ) = @_;
- my $conf = new FS::Conf;
- return { 'error' => 'Incorrect shared secret' }
- unless $opt{secret} eq $conf->config('api_shared_secret');
+ return _shared_secret_error() unless _check_shared_secret($opt{secret});
my @cust_location = qsearch('cust_location', { 'custnum' => $opt{custnum} });
return \%return;
}
-#Advertising sources?
+=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 ) = @_;
+ return _shared_secret_error() unless _check_shared_secret($opt{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,
+ };
+
+}
+
+
+#next.. Advertising sources?
+##
+# helper subroutines
+##
+
+sub _check_shared_secret {
+ shift eq FS::Conf->new->config('api_shared_secret');
+}
+
+sub _shared_secret_error {
+ return { 'error' => 'Incorrect shared secret' };
+}
+
1;