<% include( '/elements/header.html', 'Developer Documentation' ) %> <& /elements/menubar.html, 'Freeside Perl Modules' => $fsurl.'docs/library/FS.html', 'Complete Index' => $fsurl.'docs/library/index.html', &>

blib::lib::FS::ClientAPI::MyAccount::quotation

list_quotations { session }

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

quotation_new { session }

Creates a quotation and returns its quotationnum.

quotation_delete { session, quotationnum }

Disables (doesn't actually delete) the specified quotationnum.

quotation_info { session, quotationnum }

Returns a hashref describing the specified quotation, containing:

- "sections", an arrayref containing one section for each billing frequency. Each one will have: - "description" - "subtotal" - "detail_items", an arrayref of detail items, each with: - "pkgnum", the reference number (actually the quotationpkgnum field) - "description", the package name (or tax name) - "quantity" - "amount" - "num_pkgs", the number of packages in the quotation - "total_setup", the sum of setup/one-time charges and their taxes - "total_recur", the sum of all recurring charges and their taxes

quotation_print { session, 'format' }

Renders the quotation. 'format' can be either 'html' or 'pdf'; the resulting hashref will contain 'document' => the HTML or PDF contents.

quotation_add_pkg { session, 'pkgpart', 'quantity', [ location opts ] }

Adds a package to the user's current quotation. Session info and 'pkgpart' are required. 'quantity' defaults to 1.

Location can be specified as 'locationnum' to use an existing location, or 'address1', 'address2', 'city', 'state', 'zip', 'country' to create a new one, or it will default to the customer's service location.

quotation_remove_pkg { session, 'pkgnum' }

Removes the package from the user's current quotation. 'pkgnum' is required.

quotation_order

Convert the current quotation to a package order.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 38:

'=item' outside of any '=over'

=over without closing =back

<% include ('/elements/footer.html' ) %>