'start_thirdparty' => 'MyAccount/start_thirdparty',
'finish_thirdparty' => 'MyAccount/finish_thirdparty',
+
+ 'list_quotations' => 'MyAccount/quotation/list_quotations',
+ 'quotation_new' => 'MyAccount/quotation/quotation_new',
+ 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
+ 'quotation_info' => 'MyAccount/quotation/quotation_info',
+ 'quotation_print' => 'MyAccount/quotation/quotation_print',
+ 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
+ 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
+ 'quotation_order' => 'MyAccount/quotation/quotation_order',
+
);
@EXPORT_OK = (
keys(%autoload),
#!!! list_pkgs example
- #!!! order_pkg example
+ #ordering a package with an svc_acct service
+ my $rv = order_pkg( { 'session_id' => $session_id,
+ 'pkgpart' => $pkgpart,
+ 'svcpart' => $svcpart,
+ 'username' => $username,
+ 'domsvc' => $domsvc, #svcnum of svc_domain
+ '_password' => $password,
+ }
+ );
+
+ #!!! ordering a package with an svc_domain service example
+
+ #!!! ordering a package with an svc_phone service example
+
+ #!!! ordering a package with an svc_external service example
+
+ #!!! ordering a package with an svc_pbx service
+
+ #ordering a package with no service
+ my $rv = order_pkg( { 'session_id' => $session_id,
+ 'pkgpart' => $pkgpart,
+ 'svcpart' => 'none',
+ }
+ );
+
+ #quoting a package, then ordering after confirmation
+
+ my $rv = quotation_new({ 'session_id' => $session_id });
+ my $qnum = $rv->{quotationnum};
+ # add packages to the quotation
+ $rv = quotation_add_pkg({ 'session_id' => $session_id,
+ 'quotationnum' => $qnum,
+ 'pkgpart' => $pkgpart,
+ 'quantity' => $quantity, # defaults to 1
+ });
+ # repeat until all packages are added
+ # view the pricing information
+ $rv = quotation_info({ 'session_id' => $session_id,
+ 'quotationnum' => $qnum,
+ });
+ print "Total setup charges: ".$rv->{total_setup}."\n".
+ "Total recurring charges: ".$rv->{total_recur}."\n";
+ # quotation_info also provides a detailed breakdown of charges, in
+ # $rv->{sections}.
+
+ # ask customer for confirmation, then:
+ $rv = quotation_order({ 'session_id' => $session_id,
+ 'quotationnum' => $qnum,
+ });
#!!! cancel_pkg example
# signup functionality
- use FS::SelfService qw( signup_info new_customer );
+ use FS::SelfService qw( signup_info new_customer new_customer_minimal );
my $signup_info = signup_info;
Returns a hash reference with a single key, B<error>, empty on success, or an
error message on errors.
+=item provision_acct
+
+Provisions an account (svc_acct).
+
+Takes a hash references as parameter with the following keys:
+
+=over 4
+
+=item session_id
+
+Session identifier
+
+=item pkgnum
+
+pkgnum of package into which this service is provisioned
+
+=item svcpart
+
+svcpart or service definition to provision
+
+=item username
+
+=item domsvc
+
+=item _password
+
+=back
+
+=item provision_phone
+
+Provisions a phone number (svc_phone).
+
+Takes a hash references as parameter with the following keys:
+
+=over 4
+
+=item session_id
+
+Session identifier
+
+=item pkgnum
+
+pkgnum of package into which this service is provisioned
+
+=item svcpart
+
+svcpart or service definition to provision
+
+=item countrycode
+
+=item phonenum
+
+=item address1
+
+=item address2
+
+=item city
+
+=item county
+
+=item state
+
+=item zip
+
+=item country
+
+E911 Address (optional)
+
+=back
+
+=item provision_external
+
+Provisions an external service (svc_external).
+
+Takes a hash references as parameter with the following keys:
+
+=over 4
+
+=item session_id
+
+Session identifier
+
+=item pkgnum
+
+pkgnum of package into which this service is provisioned
+
+=item svcpart
+
+svcpart or service definition to provision
+
+=item id
+
+=item title
+
+=back
+
+=back
+
+=head2 "MY ACCOUNT" QUOTATION FUNCTIONS
+
+All of these functions require the user to be logged in, and the 'session_id'
+key to be included in the argument hashref.`
+
+=over 4
+
+=item list_quotations HASHREF
+
+Returns a hashref listing this customer's active self-service quotations.
+Contents are:
+
+- 'quotations', an arrayref containing an element for each quotation.
+ - quotationnum, the primary key
+ - _date, the date it was started
+ - num_pkgs, the number of packages
+ - total_setup, the sum of setup fees
+ - total_recur, the sum of recurring charges
+
+=item quotation_new HASHREF
+
+Creates an empty quotation and returns a hashref containing 'quotationnum',
+the primary key of the new quotation.
+
+=item quotation_delete HASHREF
+
+Disables (does not really delete) a quotation. Takes the following arguments:
+
+=over 4
+
+=item session_id
+
+=item quotationnum - the quotation to delete
+
+=back
+
+Returns 'error' => a string, which will be empty on success.
+
+=item quotation_info HASHREF
+
+Returns total and detailed pricing information on a quotation.
+
+Takes the following arguments:
+
+=over 4
+
+=item session_id
+
+=item quotationnum - the quotation to return
+
+=back
+
+Returns a hashref containing:
+
+- total_setup, the total of setup fees (and their taxes)
+- total_recur, the total of all recurring charges (and their taxes)
+- sections, an arrayref containing an element for each quotation section.
+ - description, a line of text describing the group of charges
+ - subtotal, the total of charges in this group (if appropriate)
+ - detail_items, an arrayref of line items
+ - pkgnum, the reference number of the package
+ - description, the package name (or tax name)
+ - quantity
+ - amount, the amount charged
+ If the detail item represents a subtotal, it will instead contain:
+ - total_item: description of the subtotal
+ - total_amount: the subtotal amount
+
+
+=item quotation_print HASHREF
+
+Renders the quotation as HTML or PDF. Takes the following arguments:
+
+=over 4
+
+=item session_id
+
+=item quotationnum - the quotation to return
+
+=item format - 'html' or 'pdf'
+
+=back
+
+Returns a hashref containing 'document', the contents of the file.
+
+=item quotation_add_pkg HASHREF
+
+Adds a package to a quotation. Takes the following arguments:
+
+=over 4
+
+=item session_id
+
+=item pkgpart - the package to add
+
+=item quotationnum - the quotation to add it to
+
+=item quantity - the package quantity (defaults to 1)
+
+=item address1, address2, city, state, zip, country - address fields to set
+the service location
+
+=back
+
+Returns 'error' => a string, which will be empty on success.
+
+=item quotation_remove_pkg HASHREF
+
+Removes a package from a quotation. Takes the following arguments:
+
+=over 4
+
+=item session_id
+
+=item pkgnum - the primary key (quotationpkgnum) of the package to remove
+
+=item quotationnum - the quotation to remove it from
+
+=back
+
+Returns 'error' => a string, which will be empty on success.
+
+=back
+
+=item quotation_order HASHREF
+
+Converts the packages in a quotation into real packages. Takes the following
+arguments:
+
+Takes the following arguments:
+
+=over 4
+
+=item session_id
+
+=item quotationnum - the quotation to order
+
+=back
+
=back
=head1 SIGNUP FUNCTIONS
=back
+=item new_customer_minimal HASHREF
+
+Creates a new customer.
+
+Current differences from new_customer: An address is not required. promo_code
+and reg_code are not supported. If invoicing_list and _password is passed, a
+contact will be created with self-service access (no pkgpart or username is
+necessary). No initial billing is run (this may change in a future version).
+
+Takes a hash reference as parameter with the following keys:
+
+=over 4
+
+=item first
+
+first name (required)
+
+=item last
+
+last name (required)
+
+=item ss
+
+(not typically collected; mostly used for ACH transactions)
+
+=item company
+
+Company name
+
+=item address1
+
+Address line one
+
+=item address2
+
+Address line two
+
+=item city
+
+City
+
+=item county
+
+County
+
+=item state
+
+State
+
+=item zip
+
+Zip or postal code
+
+=item daytime
+
+Daytime phone number
+
+=item night
+
+Evening phone number
+
+=item fax
+
+Fax number
+
+=item payby
+
+CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
+
+=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 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 referral_custnum
+
+referring customer number
+
+=item agentnum
+
+Agent number
+
+=item pkgpart
+
+pkgpart of initial package
+
+=item username
+
+Username
+
+=item _password
+
+Password
+
+=item sec_phrase
+
+Security phrase
+
+=item popnum
+
+Access number (index, not the literal number)
+
+=item countrycode
+
+Country code (to be provisioned as a service)
+
+=item phonenum
+
+Phone number (to be provisioned as a service)
+
+=item pin
+
+Voicemail PIN
+
+=back
+
+Returns a hash reference with the following keys:
+
+=over 4
+
+=item error
+
+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)
+
+=back
+
=item new_customer HASHREF
Creates a new customer. Takes a hash reference as parameter with the
projects / freeside.git / blobdiff