1 package FS::SelfService;
4 use vars qw( $VERSION @ISA @EXPORT_OK $DEBUG
5 $skip_uid_check $dir $socket %autoload $tag );
11 use Storable 2.09 qw(nstore_fd fd_retrieve);
15 @ISA = qw( Exporter );
19 $dir = "/usr/local/freeside";
20 $socket = "$dir/selfservice_socket";
21 $socket .= '.'.$tag if defined $tag && length($tag);
23 #maybe should ask ClientAPI for this list
25 'passwd' => 'passwd/passwd',
26 'chfn' => 'passwd/passwd',
27 'chsh' => 'passwd/passwd',
28 'login_info' => 'MyAccount/login_info',
29 'login_banner_image' => 'MyAccount/login_banner_image',
30 'login' => 'MyAccount/login',
31 'logout' => 'MyAccount/logout',
32 'switch_acct' => 'MyAccount/switch_acct',
33 'customer_info' => 'MyAccount/customer_info',
34 'customer_info_short' => 'MyAccount/customer_info_short',
36 'contact_passwd' => 'MyAccount/contact/contact_passwd',
37 'list_contacts' => 'MyAccount/contact/list_contacts',
38 'edit_contact' => 'MyAccount/contact/edit_contact',
39 'delete_contact' => 'MyAccount/contact/delete_contact',
40 'new_contact' => 'MyAccount/contact/new_contact',
42 'billing_history' => 'MyAccount/billing_history',
43 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
44 'invoice' => 'MyAccount/invoice',
45 'invoice_pdf' => 'MyAccount/invoice_pdf',
46 'legacy_invoice' => 'MyAccount/legacy_invoice',
47 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
48 'invoice_logo' => 'MyAccount/invoice_logo',
49 'list_invoices' => 'MyAccount/list_invoices', #?
50 'cancel' => 'MyAccount/cancel', #add to ss cgi!
51 'payment_info' => 'MyAccount/payment_info',
52 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
53 'process_payment' => 'MyAccount/process_payment',
54 'store_payment' => 'MyAccount/store_payment',
55 'process_stored_payment' => 'MyAccount/process_stored_payment',
56 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
57 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
58 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
59 'process_prepay' => 'MyAccount/process_prepay',
60 'realtime_collect' => 'MyAccount/realtime_collect',
61 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
62 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
63 'list_svc_usage' => 'MyAccount/list_svc_usage',
64 'svc_status_html' => 'MyAccount/svc_status_html',
65 'svc_status_hash' => 'MyAccount/svc_status_hash',
66 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
67 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
68 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
69 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
70 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
71 'acct_forward_info' => 'MyAccount/acct_forward_info',
72 'process_acct_forward' => 'MyAccount/process_acct_forward',
73 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
74 'add_dsl_device' => 'MyAccount/add_dsl_device',
75 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
76 'port_graph' => 'MyAccount/port_graph',
77 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
78 'list_support_usage' => 'MyAccount/list_support_usage',
79 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
80 'change_pkg' => 'MyAccount/change_pkg',
81 'order_recharge' => 'MyAccount/order_recharge',
82 'renew_info' => 'MyAccount/renew_info',
83 'order_renew' => 'MyAccount/order_renew',
84 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
85 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
86 'charge' => 'MyAccount/charge', #?
87 'part_svc_info' => 'MyAccount/part_svc_info',
88 'provision_acct' => 'MyAccount/provision_acct',
89 'provision_phone' => 'MyAccount/provision_phone',
90 'provision_pbx' => 'MyAccount/provision_pbx',
91 'provision_external' => 'MyAccount/provision_external',
92 'provision_forward' => 'MyAccount/provision_forward',
93 'unprovision_svc' => 'MyAccount/unprovision_svc',
94 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
95 'reset_passwd' => 'MyAccount/reset_passwd',
96 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
97 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
98 'validate_passwd' => 'MyAccount/validate_passwd',
99 'list_tickets' => 'MyAccount/list_tickets',
100 'create_ticket' => 'MyAccount/create_ticket',
101 'get_ticket' => 'MyAccount/get_ticket',
102 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
103 'did_report' => 'MyAccount/did_report',
104 'signup_info' => 'Signup/signup_info',
105 'skin_info' => 'MyAccount/skin_info',
106 'access_info' => 'MyAccount/access_info',
107 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
108 'new_customer' => 'Signup/new_customer',
109 'new_customer_minimal' => 'Signup/new_customer_minimal',
110 'capture_payment' => 'Signup/capture_payment',
111 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
112 'new_agent' => 'Agent/new_agent',
113 'agent_login' => 'Agent/agent_login',
114 'agent_logout' => 'Agent/agent_logout',
115 'agent_info' => 'Agent/agent_info',
116 'agent_list_customers' => 'Agent/agent_list_customers',
117 'check_username' => 'Agent/check_username',
118 'suspend_username' => 'Agent/suspend_username',
119 'unsuspend_username' => 'Agent/unsuspend_username',
120 'mason_comp' => 'MasonComponent/mason_comp',
121 'call_time' => 'PrepaidPhone/call_time',
122 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
123 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
125 'start_thirdparty' => 'MyAccount/start_thirdparty',
126 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
128 'list_quotations' => 'MyAccount/quotation/list_quotations',
129 'quotation_new' => 'MyAccount/quotation/quotation_new',
130 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
131 'quotation_info' => 'MyAccount/quotation/quotation_info',
132 'quotation_print' => 'MyAccount/quotation/quotation_print',
133 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
134 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
135 'quotation_order' => 'MyAccount/quotation/quotation_order',
140 qw( regionselector regionselector_hashref location_form
141 expselect popselector domainselector didselector
145 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
146 $ENV{'SHELL'} = '/bin/sh';
147 $ENV{'IFS'} = " \t\n";
150 $ENV{'BASH_ENV'} = '';
152 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
153 #if you grant appropriate permissions to whatever user
154 my $freeside_uid = scalar(getpwnam('freeside'));
155 die "not running as the freeside user\n"
156 if $> != $freeside_uid && ! $skip_uid_check;
158 -e $dir or die "FATAL: $dir doesn't exist!";
159 -d $dir or die "FATAL: $dir isn't a directory!";
160 -r $dir or die "FATAL: Can't read $dir as freeside user!";
161 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
163 foreach my $autoload ( keys %autoload ) {
166 "sub $autoload { ". '
171 #warn scalar(@_). ": ". join(" / ", @_);
175 $param->{_packet} = \''. $autoload{$autoload}. '\';
177 simple_packet($param);
187 warn "sending ". $packet->{_packet}. " to server"
189 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
190 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
191 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
194 #shoudl trap: Magic number checking on storable file failed at blib/lib/Storable.pm (autosplit into blib/lib/auto/Storable/fd_retrieve.al) line 337, at /usr/local/share/perl/5.6.1/FS/SelfService.pm line 71
196 #block until there is a message on socket
197 # my $w = new IO::Select;
199 # my @wait = $w->can_read;
201 warn "reading message from server"
204 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
205 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
207 warn "returning message to client"
215 FS::SelfService - Freeside self-service API
219 # password and shell account changes
220 use FS::SelfService qw(passwd chfn chsh);
222 # "my account" functionality
223 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
225 #new-style login with an email address and password
226 # can also be used for svc_acct login, set $emailaddress to username@domain
227 my $rv = login ( { 'email' => $emailaddress,
228 'password' => $password,
231 if ( $rv->{'error'} ) {
232 #handle login error...
235 $session_id = $rv->{'session_id'};
238 #classic svc_acct-based login with separate username and password
239 my $rv = login( { 'username' => $username,
241 'password' => $password,
244 if ( $rv->{'error'} ) {
245 #handle login error...
248 $session_id = $rv->{'session_id'};
251 #svc_phone login with phone number and PIN
252 my $rv = login( { 'username' => $phone_number,
253 'domain' => 'svc_phone',
257 if ( $rv->{'error'} ) {
258 #handle login error...
261 $session_id = $rv->{'session_id'};
264 my $customer_info = customer_info( { 'session_id' => $session_id } );
266 #payment_info and process_payment are available in 1.5+ only
267 my $payment_info = payment_info( { 'session_id' => $session_id } );
269 #!!! process_payment example
271 #!!! list_pkgs example
273 #!!! order_pkg example
275 #quoting a package, then ordering after confirmation
277 my $rv = quotation_new({ 'session_id' => $session_id });
278 my $qnum = $rv->{quotationnum};
279 # add packages to the quotation
280 $rv = quotation_add_pkg({ 'session_id' => $session_id,
281 'quotationnum' => $qnum,
282 'pkgpart' => $pkgpart,
283 'quantity' => $quantity, # defaults to 1
285 # repeat until all packages are added
286 # view the pricing information
287 $rv = quotation_info({ 'session_id' => $session_id,
288 'quotationnum' => $qnum,
290 print "Total setup charges: ".$rv->{total_setup}."\n".
291 "Total recurring charges: ".$rv->{total_recur}."\n";
292 # quotation_info also provides a detailed breakdown of charges, in
295 # ask customer for confirmation, then:
296 $rv = quotation_order({ 'session_id' => $session_id,
297 'quotationnum' => $qnum,
300 #!!! cancel_pkg example
302 # signup functionality
303 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
305 my $signup_info = signup_info;
307 $rv = new_customer( {
310 'company' => $company,
311 'address1' => $address1,
312 'address2' => $address2,
316 'country' => $country,
317 'daytime' => $daytime,
321 'payinfo' => $payinfo,
323 'paystart_month' => $paystart_month
324 'paystart_year' => $paystart_year,
325 'payissue' => $payissue,
327 'paydate' => $paydate,
328 'payname' => $payname,
329 'invoicing_list' => $invoicing_list,
330 'referral_custnum' => $referral_custnum,
331 'agentnum' => $agentnum,
332 'pkgpart' => $pkgpart,
334 'username' => $username,
335 '_password' => $password,
339 'phonenum' => $phonenum,
344 my $error = $rv->{'error'};
345 if ( $error eq '_decline' ) {
355 Use this API to implement your own client "self-service" module.
357 If you just want to customize the look of the existing "self-service" module,
360 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
366 Changes the password for an existing user in svc_acct. Takes a hash
367 reference with the following keys:
373 Username of the account (required)
377 Domain of the account (required)
381 Old password (required)
385 New password (required)
403 =head1 "MY ACCOUNT" FUNCTIONS
409 Creates a user session. Takes a hash reference as parameter with the
416 Email address (username@domain), instead of username and domain. Required for
417 contact-based self-service login, can also be used for svc_acct-based login.
433 Returns a hash reference with the following keys:
439 Empty on success, or an error message on errors.
443 Session identifier for successful logins
447 =item customer_info HASHREF
449 Returns general customer information.
451 Takes a hash reference as parameter with a single key: B<session_id>
453 Returns a hash reference with the following keys:
467 Array reference of hash references of open inoices. Each hash reference has
468 the following keys: invnum, date, owed
472 An HTML fragment containing shipping and billing addresses.
474 =item The following fields are also returned
476 first last company address1 address2 city county state zip country daytime night fax ship_first ship_last ship_company ship_address1 ship_address2 ship_city ship_state ship_zip ship_country ship_daytime ship_night ship_fax payby payinfo payname month year invoicing_list postal_invoicing
480 =item edit_info HASHREF
482 Takes a hash reference as parameter with any of the following keys:
484 first last company address1 address2 city county state zip country daytime night fax ship_first ship_last ship_company ship_address1 ship_address2 ship_city ship_state ship_zip ship_country ship_daytime ship_night ship_fax payby payinfo paycvv payname month year invoicing_list postal_invoicing
486 If a field exists, the customer record is updated with the new value of that
487 field. If a field does not exist, that field is not changed on the customer
490 Returns a hash reference with a single key, B<error>, empty on success, or an
491 error message on errors
493 =item invoice HASHREF
495 Returns an invoice. Takes a hash reference as parameter with two keys:
496 session_id and invnum
498 Returns a hash reference with the following keys:
504 Empty on success, or an error message on errors
516 =item list_invoices HASHREF
518 Returns a list of all customer invoices. Takes a hash reference with a single
521 Returns a hash reference with the following keys:
527 Empty on success, or an error message on errors
531 Reference to array of hash references with the following keys:
541 Invoice date, in UNIX epoch time
549 Cancels this customer.
551 Takes a hash reference as parameter with a single key: B<session_id>
553 Returns a hash reference with a single key, B<error>, which is empty on
554 success or an error message on errors.
556 =item payment_info HASHREF
558 Returns information that may be useful in displaying a payment page.
560 Takes a hash reference as parameter with a single key: B<session_id>.
562 Returns a hash reference with the following keys:
568 Empty on success, or an error message on errors
576 Exact name on credit card (CARD/DCRD)
600 Customer's current default payment type.
604 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
608 For CARD/DCRD payment types, the card number
612 For CARD/DCRD payment types, expiration month
616 For CARD/DCRD payment types, expiration year
618 =item cust_main_county
620 County/state/country data - array reference of hash references, each of which has the fields of a cust_main_county record (see L<FS::cust_main_county>). Note these are not FS::cust_main_county objects, but hash references of columns and values.
624 Array reference of all states in the current default country.
628 Hash reference of card types; keys are card types, values are the exact strings
629 passed to the process_payment function
633 #this doesn't actually work yet
637 #Unique transaction identifier (prevents multiple charges), passed to the
638 #process_payment function
642 =item process_payment HASHREF
644 Processes a payment and possible change of address or payment type. Takes a
645 hash reference as parameter with the following keys:
659 If true, address and card information entered will be saved for subsequent
664 If true, future credit card payments will be done automatically (sets payby to
665 CARD). If false, future credit card payments will be done on-demand (sets
666 payby to DCRD). This option only has meaning if B<save> is set true.
694 Two-letter country code
702 Card expiration month
710 #this doesn't actually work yet
714 #Unique transaction identifier, returned from the payment_info function.
715 #Prevents multiple charges.
719 Returns a hash reference with a single key, B<error>, empty on success, or an
720 error message on errors.
722 =item process_payment_order_pkg
724 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
725 payment processes sucessfully, the package is ordered. Takes a hash reference
726 as parameter with the keys of both methods.
728 Returns a hash reference with a single key, B<error>, empty on success, or an
729 error message on errors.
731 =item process_payment_change_pkg
733 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
734 payment processes sucessfully, the package is ordered. Takes a hash reference
735 as parameter with the keys of both methods.
737 Returns a hash reference with a single key, B<error>, empty on success, or an
738 error message on errors.
741 =item process_payment_order_renew
743 Combines the B<process_payment> and B<order_renew> functions in one step. If
744 the payment processes sucessfully, the renewal is processed. Takes a hash
745 reference as parameter with the keys of both methods.
747 Returns a hash reference with a single key, B<error>, empty on success, or an
748 error message on errors.
752 Returns package information for this customer. For more detail on services,
755 Takes a hash reference as parameter with a single key: B<session_id>
757 Returns a hash reference containing customer package information. The hash reference contains the following keys:
767 Empty on success, or an error message on errors.
769 =item cust_pkg HASHREF
771 Array reference of hash references, each of which has the fields of a cust_pkg
772 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
773 the internal FS:: objects, but hash references of columns and values.
777 =item part_pkg fields
779 All fields of part_pkg for this specific cust_pkg (be careful with this
780 information - it may reveal more about your available packages than you would
781 like users to know in aggregate)
785 #XXX pare part_pkg fields down to a more secure subset
789 An array of hash references indicating information on unprovisioned services
790 available for provisioning for this specific cust_pkg. Each has the following
795 =item part_svc fields
797 All fields of part_svc (be careful with this information - it may reveal more
798 about your available packages than you would like users to know in aggregate)
802 #XXX pare part_svc fields down to a more secure subset
808 An array of hash references indicating information on the customer services
809 already provisioned for this specific cust_pkg. Each has the following keys:
815 Array reference with three elements: The first element is the name of this service. The second element is a meaningful user-specific identifier for the service (i.e. username, domain or mail alias). The last element is the table name of this service.
821 Primary key for this service
825 Service definition (see L<FS::part_svc>)
829 Customer package (see L<FS::cust_pkg>)
833 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
841 Returns service information for this customer.
843 Takes a hash reference as parameter with a single key: B<session_id>
845 Returns a hash reference containing customer package information. The hash reference contains the following keys:
855 An array of hash references indicating information on all of this customer's
856 services. Each has the following keys:
862 Primary key for this service
870 Meaningful user-specific identifier for the service (i.e. username, domain, or
875 Account (svc_acct) services also have the following keys:
893 Upload bytes remaining
897 Download bytes remaining
901 Total bytes remaining
903 =item recharge_amount
907 =item recharge_seconds
909 Number of seconds gained by recharge
911 =item recharge_upbytes
913 Number of upload bytes gained by recharge
915 =item recharge_downbytes
917 Number of download bytes gained by recharge
919 =item recharge_totalbytes
921 Number of total bytes gained by recharge
929 Orders a package for this customer.
931 Takes a hash reference as parameter with the following keys:
941 Package to order (see L<FS::part_pkg>).
945 Quantity for this package order (default 1).
949 Optional locationnum for this package order, for existing locations.
951 Or, for new locations, pass the following fields: address1*, address2, city*,
952 county, state*, zip*, country. (* = required in this case)
964 Service to order (see L<FS::part_svc>).
966 Normally optional; required only to provision a non-svc_acct service, or if the
967 package definition does not contain one svc_acct service definition with
968 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
969 also be specified to indicate that no initial service should be provisioned.
973 Fields used when provisioning an svc_acct service:
987 Optional security phrase
991 Optional Access number number
995 Fields used when provisioning an svc_domain service:
1005 Fields used when provisioning an svc_phone service:
1023 Fields used when provisioning an svc_external service:
1029 External numeric ID.
1033 External text title.
1037 Fields used when provisioning an svc_pbx service:
1051 Returns a hash reference with a single key, B<error>, empty on success, or an
1052 error message on errors. The special error '_decline' is returned for
1053 declined transactions.
1057 Changes a package for this customer.
1059 Takes a hash reference as parameter with the following keys:
1069 Existing customer package.
1073 New package to order (see L<FS::part_pkg>).
1077 Quantity for this package order (default 1).
1081 Returns a hash reference with the following keys:
1087 Empty on success, or an error message on errors.
1091 On success, the new pkgnum
1098 Provides useful info for early renewals.
1100 Takes a hash reference as parameter with the following keys:
1110 Returns a hash reference. On errors, it contains a single key, B<error>, with
1111 the error message. Otherwise, contains a single key, B<dates>, pointing to
1112 an array refernce of hash references. Each hash reference contains the
1119 (Future) Bill date. Indicates a future date for which billing could be run.
1120 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1123 =item bill_date_pretty
1125 (Future) Bill date as a human-readable string. (Convenience for display;
1126 subject to change, so best not to parse for the date.)
1130 Base amount which will be charged if renewed early as of this date.
1134 Renewal date; i.e. even-futher future date at which the customer will be paid
1135 through if the early renewal is completed with the given B<bill-date>.
1136 Specified as a integer UNIX timestamp.
1138 =item renew_date_pretty
1140 Renewal date as a human-readable string. (Convenience for display;
1141 subject to change, so best not to parse for the date.)
1145 Package that will be renewed.
1149 Expiration date of the package that will be renewed.
1151 =item expire_date_pretty
1153 Expiration date of the package that will be renewed, as a human-readable
1154 string. (Convenience for display; subject to change, so best not to parse for
1161 Renews this customer early; i.e. runs billing for this customer in advance.
1163 Takes a hash reference as parameter with the following keys:
1173 Integer date as returned by the B<renew_info> function, indicating the advance
1174 date for which to run billing.
1178 Returns a hash reference with a single key, B<error>, empty on success, or an
1179 error message on errors.
1183 Cancels a package for this customer.
1185 Takes a hash reference as parameter with the following keys:
1195 pkgpart of package to cancel
1199 Returns a hash reference with a single key, B<error>, empty on success, or an
1200 error message on errors.
1202 =item provision_acct
1204 Provisions an account (svc_acct).
1206 Takes a hash reference as parameter with the following keys:
1216 pkgnum of package into which this service is provisioned
1220 svcpart or service definition to provision
1230 =item provision_phone
1232 Provisions a phone number (svc_phone).
1234 Takes a hash reference as parameter with the following keys:
1244 pkgnum of package into which this service is provisioned
1248 svcpart or service definition to provision
1268 E911 Address (optional)
1274 Provisions a customer PBX (svc_pbx).
1276 Takes a hash reference as parameter with the following keys:
1286 pkgnum of package into which this service is provisioned
1290 svcpart or service definition to provision
1296 =item max_extensions
1298 =item max_simultaneous
1304 =item provision_external
1306 Provisions an external service (svc_external).
1308 Takes a hash reference as parameter with the following keys:
1318 pkgnum of package into which this service is provisioned
1322 svcpart or service definition to provision
1332 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1336 =item contact_passwd
1338 Changes the password for the currently-logged in contact.
1340 Takes a hash reference as parameter with the following keys:
1350 Returns a hash reference with a single parameter, B<error>, which contains an
1351 error message, or empty on success.
1355 Takes a hash reference as parameter with a single key, B<session_id>.
1357 Returns a hash reference with two parameters: B<error>, which contains an error
1358 message, or empty on success, and B<contacts>, a list of contacts.
1360 B<contacts> is an array reference of hash references (i.e. an array of structs,
1361 in XML-RPC). Each hash reference (struct) has the following keys:
1369 Contact class name (contact type).
1381 Position ("Director of Silly Walks"), NOT honorific ("Mr." or "Mrs.")
1385 Comma-separated list of email addresses
1389 =item selfservice_access
1397 Updates information for the currently-logged in contact, or (optionally) the
1400 Takes a hash reference as parameter with the following keys:
1408 If already logged in as a contact, this is optional.
1418 Returns a hash reference with a single parameter, B<error>, which contains an
1419 error message, or empty on success.
1423 Creates a new contact.
1425 Takes a hash reference as parameter with the following keys:
1439 Optional contact classnum (TODO: or name)
1443 =item selfservice_access
1445 Y to enable self-service access
1451 Returns a hash reference with a single parameter, B<error>, which contains an
1452 error message, or empty on success.
1454 =item delete_contact
1456 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1459 Takes a hash reference as parameter with the following keys:
1469 Returns a hash reference with a single parameter, B<error>, which contains an
1470 error message, or empty on success.
1472 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1474 All of these functions require the user to be logged in, and the 'session_id'
1475 key to be included in the argument hashref.`
1479 =item list_quotations HASHREF
1481 Returns a hashref listing this customer's active self-service quotations.
1488 an arrayref containing an element for each quotation.
1496 the date it was started
1500 the number of packages
1504 the sum of setup fees
1508 the sum of recurring charges
1512 =item quotation_new HASHREF
1514 Creates an empty quotation and returns a hashref containing 'quotationnum',
1515 the primary key of the new quotation.
1517 =item quotation_delete HASHREF
1519 Disables (does not really delete) a quotation. Takes the following arguments:
1525 =item quotationnum - the quotation to delete
1529 Returns 'error' => a string, which will be empty on success.
1531 =item quotation_info HASHREF
1533 Returns total and detailed pricing information on a quotation.
1535 Takes the following arguments:
1541 =item quotationnum - the quotation to return
1545 Returns a hashref containing:
1547 - total_setup, the total of setup fees (and their taxes)
1548 - total_recur, the total of all recurring charges (and their taxes)
1549 - sections, an arrayref containing an element for each quotation section.
1550 - description, a line of text describing the group of charges
1551 - subtotal, the total of charges in this group (if appropriate)
1552 - detail_items, an arrayref of line items
1553 - pkgnum, the reference number of the package
1554 - description, the package name (or tax name)
1556 - amount, the amount charged
1557 If the detail item represents a subtotal, it will instead contain:
1558 - total_item: description of the subtotal
1559 - total_amount: the subtotal amount
1562 =item quotation_print HASHREF
1564 Renders the quotation as HTML or PDF. Takes the following arguments:
1570 =item quotationnum - the quotation to return
1572 =item format - 'html' or 'pdf'
1576 Returns a hashref containing 'document', the contents of the file.
1578 =item quotation_add_pkg HASHREF
1580 Adds a package to a quotation. Takes the following arguments:
1586 =item pkgpart - the package to add
1588 =item quotationnum - the quotation to add it to
1590 =item quantity - the package quantity (defaults to 1)
1592 =item address1, address2, city, state, zip, country - address fields to set
1593 the service location
1597 Returns 'error' => a string, which will be empty on success.
1599 =item quotation_remove_pkg HASHREF
1601 Removes a package from a quotation. Takes the following arguments:
1607 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1609 =item quotationnum - the quotation to remove it from
1613 Returns 'error' => a string, which will be empty on success.
1617 =item quotation_order HASHREF
1619 Converts the packages in a quotation into real packages. Takes the following
1622 Takes the following arguments:
1628 =item quotationnum - the quotation to order
1634 =head1 SIGNUP FUNCTIONS
1638 =item signup_info HASHREF
1640 Takes a hash reference as parameter with the following keys:
1644 =item session_id - Optional agent/reseller interface session
1648 Returns a hash reference containing information that may be useful in
1649 displaying a signup page. The hash reference contains the following keys:
1653 =item cust_main_county
1655 County/state/country data - array reference of hash references, each of which has the fields of a cust_main_county record (see L<FS::cust_main_county>). Note these are not FS::cust_main_county objects, but hash references of columns and values.
1659 Available packages - array reference of hash references, each of which has the fields of a part_pkg record (see L<FS::part_pkg>). Each hash reference also has an additional 'payby' field containing an array reference of acceptable payment types specific to this package (see below and L<FS::part_pkg/payby>). Note these are not FS::part_pkg objects, but hash references of columns and values. Requires the 'signup_server-default_agentnum' configuration value to be set, or
1660 an agentnum specified explicitly via reseller interface session_id in the
1665 Array reference of hash references, each of which has the fields of an agent record (see L<FS::agent>). Note these are not FS::agent objects, but hash references of columns and values.
1667 =item agentnum2part_pkg
1669 Hash reference; keys are agentnums, values are array references of available packages for that agent, in the same format as the part_pkg arrayref above.
1673 Access numbers - array reference of hash references, each of which has the fields of an svc_acct_pop record (see L<FS::svc_acct_pop>). Note these are not FS::svc_acct_pop objects, but hash references of columns and values.
1675 =item security_phrase
1677 True if the "security_phrase" feature is enabled
1681 Array reference of acceptable payment types for signup
1687 credit card - automatic
1691 credit card - on-demand - version 1.5+ only
1695 electronic check - automatic
1699 electronic check - on-demand - version 1.5+ only
1707 billing, not recommended for signups
1711 free, definitely not recommended for signups
1715 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1721 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1725 Hash reference of message catalog values, to support error message customization. Currently available keys are: passwords_dont_match, invalid_card, unknown_card_type, and not_a (as in "Not a Discover card"). Values are configured in the web interface under "View/Edit message catalog".
1731 =item countrydefault
1737 =item new_customer_minimal HASHREF
1739 Creates a new customer.
1741 Current differences from new_customer: An address is not required. promo_code
1742 and reg_code are not supported. If invoicing_list and _password is passed, a
1743 contact will be created with self-service access (no pkgpart or username is
1744 necessary). No initial billing is run (this may change in a future version).
1746 Takes a hash reference as parameter with the following keys:
1752 first name (required)
1756 last name (required)
1760 (not typically collected; mostly used for ACH transactions)
1792 Daytime phone number
1796 Evening phone number
1804 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1808 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1812 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1816 Expiration date for CARD/DCRD
1820 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1822 =item invoicing_list
1824 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),
1826 =item referral_custnum
1828 referring customer number
1836 pkgpart of initial package
1852 Access number (index, not the literal number)
1856 Country code (to be provisioned as a service)
1860 Phone number (to be provisioned as a service)
1868 Returns a hash reference with the following keys:
1874 Empty on success, or an error message on errors. The special error '_decline' is returned for declined transactions; other error messages should be suitable for display to the user (and are customizable in under Configuration | View/Edit message catalog)
1878 =item new_customer HASHREF
1880 Creates a new customer. Takes a hash reference as parameter with the
1887 first name (required)
1891 last name (required)
1895 (not typically collected; mostly used for ACH transactions)
1901 =item address1 (required)
1909 =item city (required)
1917 =item state (required)
1921 =item zip (required)
1927 Daytime phone number
1931 Evening phone number
1939 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1943 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1947 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1951 Expiration date for CARD/DCRD
1955 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1957 =item invoicing_list
1959 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),
1961 =item referral_custnum
1963 referring customer number
1971 pkgpart of initial package
1987 Access number (index, not the literal number)
1991 Country code (to be provisioned as a service)
1995 Phone number (to be provisioned as a service)
2003 Returns a hash reference with the following keys:
2009 Empty on success, or an error message on errors. The special error '_decline' is returned for declined transactions; other error messages should be suitable for display to the user (and are customizable in under Configuration | View/Edit message catalog)
2013 =item regionselector HASHREF | LIST
2015 Takes as input a hashref or list of key/value pairs with the following keys:
2019 =item selected_county
2021 Currently selected county
2023 =item selected_state
2025 Currently selected state
2027 =item selected_country
2029 Currently selected country
2033 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2037 Specify a javascript subroutine to call on changes
2043 =item default_country
2049 An arrayref of hash references specifying regions. Normally you can just pass the value of the I<cust_main_county> field returned by B<signup_info>.
2053 Returns a list consisting of three HTML fragments for county selection,
2054 state selection and country selection, respectively.
2058 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2059 sub regionselector {
2066 $param->{'selected_country'} ||= $param->{'default_country'};
2067 $param->{'selected_state'} ||= $param->{'default_state'};
2069 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2073 my %cust_main_county;
2075 # unless ( @cust_main_county ) { #cache
2076 #@cust_main_county = qsearch('cust_main_county', {} );
2077 #foreach my $c ( @cust_main_county ) {
2078 foreach my $c ( @{ $param->{'locales'} } ) {
2079 #$countyflag=1 if $c->county;
2080 $countyflag=1 if $c->{county};
2081 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2082 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2083 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2086 $countyflag=1 if $param->{selected_county};
2088 my $script_html = <<END;
2090 function opt(what,value,text) {
2091 var optionName = new Option(text, value, false, false);
2092 var length = what.length;
2093 what.options[length] = optionName;
2095 function ${prefix}country_changed(what) {
2096 country = what.options[what.selectedIndex].text;
2097 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2098 what.form.${prefix}state.options[i] = null;
2100 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2102 foreach my $country ( sort keys %cust_main_county ) {
2103 $script_html .= "\nif ( country == \"$country\" ) {\n";
2104 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2105 my $text = $state || '(n/a)';
2106 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2108 $script_html .= "}\n";
2111 $script_html .= <<END;
2113 function ${prefix}state_changed(what) {
2116 if ( $countyflag ) {
2117 $script_html .= <<END;
2118 state = what.options[what.selectedIndex].text;
2119 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2120 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2121 what.form.${prefix}county.options[i] = null;
2124 foreach my $country ( sort keys %cust_main_county ) {
2125 $script_html .= "\nif ( country == \"$country\" ) {\n";
2126 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2127 $script_html .= "\nif ( state == \"$state\" ) {\n";
2128 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2129 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2130 my $text = $county || '(n/a)';
2132 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2134 $script_html .= "}\n";
2136 $script_html .= "}\n";
2140 $script_html .= <<END;
2145 my $county_html = $script_html;
2146 if ( $countyflag ) {
2147 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2148 foreach my $county (
2149 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2151 my $text = $county || '(n/a)';
2152 $county_html .= qq!<OPTION VALUE="$county"!.
2153 ($county eq $param->{'selected_county'} ?
2160 $county_html .= '</SELECT>';
2163 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2166 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2167 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2168 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2169 my $text = $state || '(n/a)';
2170 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2171 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
2173 $state_html .= '</SELECT>';
2175 my $country_html = '';
2176 if ( scalar( keys %cust_main_county ) > 1 ) {
2178 $country_html = qq(<SELECT NAME="${prefix}country" ).
2179 qq(onChange="${prefix}country_changed(this); ).
2180 $param->{'onchange'}.
2183 my $countrydefault = $param->{default_country} || 'US';
2184 foreach my $country (
2185 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2186 keys %cust_main_county
2188 my $selected = $country eq $param->{'selected_country'}
2191 $country_html .= "\n<OPTION$selected>$country</OPTION>"
2193 $country_html .= '</SELECT>';
2196 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2197 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2201 ($county_html, $state_html, $country_html);
2205 sub regionselector_hashref {
2206 my ($county_html, $state_html, $country_html) = regionselector(@_);
2208 'county_html' => $county_html,
2209 'state_html' => $state_html,
2210 'country_html' => $country_html,
2214 =item location_form HASHREF | LIST
2216 Takes as input a hashref or list of key/value pairs with the following keys:
2222 Current customer session_id
2226 Omit red asterisks from required fields.
2228 =item address1_label
2230 Label for first address line.
2234 Returns an HTML fragment for a location form (address, city, state, zip,
2247 my $session_id = delete $param->{'session_id'};
2249 my $rv = mason_comp( 'session_id' => $session_id,
2250 'comp' => '/elements/location.html',
2251 'args' => [ %$param ],
2255 $rv->{'error'} || $rv->{'output'};
2260 #=item expselect HASHREF | LIST
2262 #Takes as input a hashref or list of key/value pairs with the following keys:
2266 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2268 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2272 =item expselect PREFIX [ DATE ]
2274 Takes as input a unique prefix string and the current expiration date, in
2275 yyyy-mm-dd or m-d-yyyy format
2277 Returns an HTML fragments for expiration date selection.
2283 #if ( ref($_[0]) ) {
2287 #my $prefix = $param->{'prefix'};
2288 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2289 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2291 my $date = scalar(@_) ? shift : '';
2293 my( $m, $y ) = ( 0, 0 );
2294 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2295 ( $m, $y ) = ( $2, $1 );
2296 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2297 ( $m, $y ) = ( $1, $3 );
2299 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2301 $return .= qq!<OPTION VALUE="$_"!;
2302 $return .= " SELECTED" if $_ == $m;
2305 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2307 my $thisYear = $t[5] + 1900;
2308 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2309 $return .= qq!<OPTION VALUE="$_"!;
2310 $return .= " SELECTED" if $_ == $y;
2313 $return .= "</SELECT>";
2318 =item popselector HASHREF | LIST
2320 Takes as input a hashref or list of key/value pairs with the following keys:
2326 Access number number
2330 An arrayref of hash references specifying access numbers. Normally you can just pass the value of the I<svc_acct_pop> field returned by B<signup_info>.
2334 Returns an HTML fragment for access number selection.
2338 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2346 my $popnum = $param->{'popnum'};
2347 my $pops = $param->{'pops'};
2349 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2350 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2351 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2352 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2353 if scalar(@$pops) == 1;
2356 my %popnum2pop = ();
2358 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2359 $popnum2pop{$_->{popnum}} = $_;
2364 function opt(what,href,text) {
2365 var optionName = new Option(text, href, false, false)
2366 var length = what.length;
2367 what.options[length] = optionName;
2371 my $init_popstate = $param->{'init_popstate'};
2372 if ( $init_popstate ) {
2373 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2374 $init_popstate. '">';
2377 function acstate_changed(what) {
2378 state = what.options[what.selectedIndex].text;
2379 what.form.popac.options.length = 0
2380 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2384 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2385 foreach my $state ( sort { $a cmp $b } @states ) {
2386 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2388 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2389 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2390 if ($ac eq $param->{'popac'}) {
2391 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2394 $text .= "}\n" unless $init_popstate;
2396 $text .= "popac_changed(what.form.popac)}\n";
2399 function popac_changed(what) {
2400 ac = what.options[what.selectedIndex].text;
2401 what.form.popnum.options.length = 0;
2402 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2406 foreach my $state ( @states ) {
2407 foreach my $popac ( keys %{ $pop{$state} } ) {
2408 $text .= "\nif ( ac == \"$popac\" ) {\n";
2410 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2411 my $o_popnum = $pop->{popnum};
2412 my $poptext = $pop->{city}. ', '. $pop->{state}.
2413 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2415 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2416 if ($popnum == $o_popnum) {
2417 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2425 $text .= "}\n</SCRIPT>\n";
2427 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2430 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2431 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2432 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2433 ">$_" foreach sort { $a cmp $b } @states;
2434 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2437 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2438 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2440 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2443 #comment this block to disable initial list polulation
2444 my @initial_select = ();
2445 if ( scalar( @$pops ) > 100 ) {
2446 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2448 @initial_select = @$pops;
2450 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2451 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2452 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2453 $pop->{city}. ', '. $pop->{state}.
2454 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2457 $text .= qq!</SELECT></TD></TR></TABLE>!;
2463 =item domainselector HASHREF | LIST
2465 Takes as input a hashref or list of key/value pairs with the following keys:
2475 Service number of the selected item.
2479 Returns an HTML fragment for domain selection.
2483 sub domainselector {
2490 my $domsvc= $param->{'domsvc'};
2492 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2493 my $domains = $rv->{'domains'};
2494 $domsvc = $rv->{'domsvc'} unless $domsvc;
2496 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2497 unless scalar(keys %$domains);
2499 if (scalar(keys %$domains) == 1) {
2501 foreach(keys %$domains) {
2504 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2505 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2508 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2510 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2512 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2513 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2514 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2515 $domains->{$domain};
2518 $text .= qq!</SELECT></TD></TR>!;
2524 =item didselector HASHREF | LIST
2526 Takes as input a hashref or list of key/value pairs with the following keys:
2532 Field name for the returned HTML fragment.
2536 Service definition (see L<FS::part_svc>)
2540 Returns an HTML fragment for DID selection.
2552 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2553 'args'=>[ %$param ],
2557 $rv->{'error'} || $rv->{'output'};
2563 =head1 RESELLER FUNCTIONS
2565 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2566 with their active session, and the B<customer_info> and B<order_pkg> functions
2567 with their active session and an additional I<custnum> parameter.
2569 For the most part, development of the reseller web interface has been
2570 superceded by agent-virtualized access to the backend.
2582 =item agent_list_customers
2584 List agent's customers.
2592 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>