use FS::cust_pay;
use FS::cust_credit;
use FS::cust_refund;
+use FS::cust_pkg;
=head1 NAME
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
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
Option date for payment
+=item order_number
+
+Optional order number
+
=back
Example:
#optional
'_date' => 1397977200, #UNIX timestamp
+ 'order_number' => '12345',
);
if ( $result->{'error'} ) {
#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 OPTION => VALUE, ...
#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 OPTION => VALUE, ...
#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);
-
}
#---
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
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 );
}
=item update_customer
-Updates an existing customer. Takes a hash reference as parameter with the foll$
+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
+API Secret (required)
+
+=item custnum
+
+Customer number (required)
=item first
-first name (required)
+first name
=item last
-last name (required)
+last name
=item company
Company name
-=item address1 (required)
+=item address1
Address line one
-=item city (required)
+=item city
City
County
-=item state (required)
+=item state
State
-=item zip (required)
+=item zip
Zip or postal code
=item invoicing_list
-comma-separated list of email addresses for email invoices. The special value '$
+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 "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
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');
+ return _shared_secret_error() unless _check_shared_secret($opt{secret});
FS::cust_main->API_update( %opt );
}
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' };
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;
}
+=item change_package_location
+
+Updates package location. Takes a list of keys and values
+as paramters with the following keys:
+
+pkgnum
+
+secret
+
+locationnum - pass this, or the following keys (don't pass both)
+
+locationname
+
+address1
+
+address2
+
+city
+
+county
+
+state
+
+zip
+
+addr_clean
+
+country
+
+censustract
+
+censusyear
+
+location_type
+
+location_number
+
+location_kind
+
+incorporated
+
+On error, returns a hashref with an 'error' key.
+On success, returns a hashref with 'pkgnum' and 'locationnum' keys,
+containing the new values.
+
+=cut
+
+sub change_package_location {
+ my $class = shift;
+ my %opt = @_;
+ return _shared_secret_error() unless _check_shared_secret($opt{'secret'});
+
+ my $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $opt{'pkgnum'} })
+ or return { 'error' => 'Unknown pkgnum' };
+
+ my %changeopt;
+
+ foreach my $field ( qw(
+ locationnum
+ locationname
+ address1
+ address2
+ city
+ county
+ state
+ zip
+ addr_clean
+ country
+ censustract
+ censusyear
+ location_type
+ location_number
+ location_kind
+ incorporated
+ )) {
+ $changeopt{$field} = $opt{$field} if $opt{$field};
+ }
+
+ $cust_pkg->API_change(%changeopt);
+}
+
=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.
+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');
+ return _shared_secret_error() unless _check_shared_secret($opt{secret});
my $cust_main = qsearchs('cust_main', { 'custnum' => $opt{custnum} })
or return { 'error' => 'Unknown custnum' };
}
-#Advertising sources?
+#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;
projects / freeside.git / blobdiff