Files
opensourcepos/docs/class-Tax_lib.html
2017-07-06 22:13:18 +01:00

647 lines
18 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class Tax_lib</title>
<link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li>
<a href="namespace-emberlabs.html">
emberlabs<span></span>
</a>
<ul>
<li>
<a href="namespace-emberlabs.Barcode.html">
Barcode </a>
</li>
</ul></li>
<li class="active">
<a href="namespace-None.html">
None </a>
</li>
</ul>
</div>
<hr>
<div id="elements">
<h3>Classes</h3>
<ul>
<li><a href="class-Appconfig.html">Appconfig</a></li>
<li><a href="class-Barcode_lib.html">Barcode_lib</a></li>
<li><a href="class-Config.html">Config</a></li>
<li><a href="class-Customer.html">Customer</a></li>
<li><a href="class-Customer_rewards.html">Customer_rewards</a></li>
<li><a href="class-Customers.html">Customers</a></li>
<li><a href="class-Detailed_receivings.html">Detailed_receivings</a></li>
<li><a href="class-Detailed_sales.html">Detailed_sales</a></li>
<li><a href="class-Dinner_table.html">Dinner_table</a></li>
<li><a href="class-Email_lib.html">Email_lib</a></li>
<li><a href="class-Employee.html">Employee</a></li>
<li><a href="class-Employees.html">Employees</a></li>
<li><a href="class-Giftcard.html">Giftcard</a></li>
<li><a href="class-Giftcards.html">Giftcards</a></li>
<li><a href="class-Home.html">Home</a></li>
<li><a href="class-Inventory.html">Inventory</a></li>
<li><a href="class-Inventory_low.html">Inventory_low</a></li>
<li><a href="class-Inventory_summary.html">Inventory_summary</a></li>
<li><a href="class-Item.html">Item</a></li>
<li><a href="class-Item_kit.html">Item_kit</a></li>
<li><a href="class-Item_kit_items.html">Item_kit_items</a></li>
<li><a href="class-Item_kits.html">Item_kits</a></li>
<li><a href="class-Item_lib.html">Item_lib</a></li>
<li><a href="class-Item_quantity.html">Item_quantity</a></li>
<li><a href="class-Item_taxes.html">Item_taxes</a></li>
<li><a href="class-Items.html">Items</a></li>
<li><a href="class-Login.html">Login</a></li>
<li><a href="class-Mailchimp_lib.html">Mailchimp_lib</a></li>
<li><a href="class-MailchimpConnector.html">MailchimpConnector</a></li>
<li><a href="class-Messages.html">Messages</a></li>
<li><a href="class-Migrate.html">Migrate</a></li>
<li><a href="class-Migration_Sales_Tax_Data.html">Migration_Sales_Tax_Data</a></li>
<li><a href="class-Module.html">Module</a></li>
<li><a href="class-MY_Lang.html">MY_Lang</a></li>
<li><a href="class-No_Access.html">No_Access</a></li>
<li><a href="class-Person.html">Person</a></li>
<li><a href="class-Persons.html">Persons</a></li>
<li><a href="class-Receiving.html">Receiving</a></li>
<li><a href="class-Receiving_lib.html">Receiving_lib</a></li>
<li><a href="class-Receivings.html">Receivings</a></li>
<li><a href="class-Report.html">Report</a></li>
<li><a href="class-Reports.html">Reports</a></li>
<li><a href="class-Rewards.html">Rewards</a></li>
<li><a href="class-Rounding_code.html">Rounding_code</a></li>
<li><a href="class-Sale.html">Sale</a></li>
<li><a href="class-Sale_lib.html">Sale_lib</a></li>
<li><a href="class-Sale_suspended.html">Sale_suspended</a></li>
<li><a href="class-Sales.html">Sales</a></li>
<li><a href="class-Secure_Controller.html">Secure_Controller</a></li>
<li><a href="class-Sms_lib.html">Sms_lib</a></li>
<li><a href="class-Specific_customer.html">Specific_customer</a></li>
<li><a href="class-Specific_discount.html">Specific_discount</a></li>
<li><a href="class-Specific_employee.html">Specific_employee</a></li>
<li><a href="class-Stock_location.html">Stock_location</a></li>
<li><a href="class-Summary_categories.html">Summary_categories</a></li>
<li><a href="class-Summary_customers.html">Summary_customers</a></li>
<li><a href="class-Summary_discounts.html">Summary_discounts</a></li>
<li><a href="class-Summary_employees.html">Summary_employees</a></li>
<li><a href="class-Summary_items.html">Summary_items</a></li>
<li><a href="class-Summary_payments.html">Summary_payments</a></li>
<li><a href="class-Summary_report.html">Summary_report</a></li>
<li><a href="class-Summary_sales.html">Summary_sales</a></li>
<li><a href="class-Summary_suppliers.html">Summary_suppliers</a></li>
<li><a href="class-Summary_taxes.html">Summary_taxes</a></li>
<li><a href="class-Supplier.html">Supplier</a></li>
<li><a href="class-Suppliers.html">Suppliers</a></li>
<li><a href="class-Tax.html">Tax</a></li>
<li class="active"><a href="class-Tax_lib.html">Tax_lib</a></li>
<li><a href="class-Taxes.html">Taxes</a></li>
<li><a href="class-Token.html">Token</a></li>
<li><a href="class-Token_customer.html">Token_customer</a></li>
<li><a href="class-Token_invoice_count.html">Token_invoice_count</a></li>
<li><a href="class-Token_invoice_sequence.html">Token_invoice_sequence</a></li>
<li><a href="class-Token_lib.html">Token_lib</a></li>
<li><a href="class-Token_quote_sequence.html">Token_quote_sequence</a></li>
<li><a href="class-Token_suspended_invoice_count.html">Token_suspended_invoice_count</a></li>
<li><a href="class-Token_year_invoice_count.html">Token_year_invoice_count</a></li>
<li><a href="class-Tracking_lib.html">Tracking_lib</a></li>
</ul>
<h3>Functions</h3>
<ul>
<li><a href="function-cash_decimals.html">cash_decimals</a></li>
<li><a href="function-currency_side.html">currency_side</a></li>
<li><a href="function-current_language.html">current_language</a></li>
<li><a href="function-current_language_code.html">current_language_code</a></li>
<li><a href="function-dateformat_bootstrap.html">dateformat_bootstrap</a></li>
<li><a href="function-dateformat_momentjs.html">dateformat_momentjs</a></li>
<li><a href="function-db_log_queries.html">db_log_queries</a></li>
<li><a href="function-get_customer_data_row.html">get_customer_data_row</a></li>
<li><a href="function-get_customer_manage_table_headers.html">get_customer_manage_table_headers</a></li>
<li><a href="function-get_giftcard_data_row.html">get_giftcard_data_row</a></li>
<li><a href="function-get_giftcards_manage_table_headers.html">get_giftcards_manage_table_headers</a></li>
<li><a href="function-get_item_data_row.html">get_item_data_row</a></li>
<li><a href="function-get_item_kit_data_row.html">get_item_kit_data_row</a></li>
<li><a href="function-get_item_kits_manage_table_headers.html">get_item_kits_manage_table_headers</a></li>
<li><a href="function-get_items_manage_table_headers.html">get_items_manage_table_headers</a></li>
<li><a href="function-get_people_manage_table_headers.html">get_people_manage_table_headers</a></li>
<li><a href="function-get_person_data_row.html">get_person_data_row</a></li>
<li><a href="function-get_sale_data_last_row.html">get_sale_data_last_row</a></li>
<li><a href="function-get_sale_data_row.html">get_sale_data_row</a></li>
<li><a href="function-get_sales_manage_payments_summary.html">get_sales_manage_payments_summary</a></li>
<li><a href="function-get_sales_manage_table_headers.html">get_sales_manage_table_headers</a></li>
<li><a href="function-get_supplier_data_row.html">get_supplier_data_row</a></li>
<li><a href="function-get_suppliers_manage_table_headers.html">get_suppliers_manage_table_headers</a></li>
<li><a href="function-get_tax_data_row.html">get_tax_data_row</a></li>
<li><a href="function-get_taxes_manage_table_headers.html">get_taxes_manage_table_headers</a></li>
<li><a href="function-load_config.html">load_config</a></li>
<li><a href="function-load_language_files.html">load_language_files</a></li>
<li><a href="function-load_stats.html">load_stats</a></li>
<li><a href="function-parse_decimals.html">parse_decimals</a></li>
<li><a href="function-pdf_create.html">pdf_create</a></li>
<li><a href="function-quantity_decimals.html">quantity_decimals</a></li>
<li><a href="function-show_report.html">show_report</a></li>
<li><a href="function-show_report_if_allowed.html">show_report_if_allowed</a></li>
<li><a href="function-tax_decimals.html">tax_decimals</a></li>
<li><a href="function-to_currency.html">to_currency</a></li>
<li><a href="function-to_currency_no_money.html">to_currency_no_money</a></li>
<li><a href="function-to_currency_tax.html">to_currency_tax</a></li>
<li><a href="function-to_decimals.html">to_decimals</a></li>
<li><a href="function-to_quantity_decimals.html">to_quantity_decimals</a></li>
<li><a href="function-to_tax_decimals.html">to_tax_decimals</a></li>
<li><a href="function-totals_decimals.html">totals_decimals</a></li>
<li><a href="function-transform_headers.html">transform_headers</a></li>
<li><a href="function-transform_headers_readonly.html">transform_headers_readonly</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="">
<input type="hidden" name="ie" value="UTF-8">
<input type="text" name="q" class="text" placeholder="Search">
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-None.html" title="Summary of None"><span>Namespace</span></a>
</li>
<li class="active">
<span>Class</span> </li>
</ul>
<ul>
</ul>
<ul>
</ul>
</div>
<div id="content" class="class">
<h1>Class Tax_lib</h1>
<div class="description">
<p>Tax library</p>
<p>Library with utilities to manage taxes</p>
</div>
<div class="info">
<b>Located at</b> <a href="source-class-Tax_lib.html#4-323" title="Go to source code">libraries/Tax_lib.php</a>
<br>
</div>
<table class="summary methods" id="methods">
<caption>Methods summary</caption>
<tr data-order="__construct" id="___construct">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#___construct">#</a>
<code><a href="source-class-Tax_lib.html#17-21" title="Go to source code">__construct</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="get_tax_types" id="_get_tax_types">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_get_tax_types">#</a>
<code><a href="source-class-Tax_lib.html#23-30" title="Go to source code">get_tax_types</a>( )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="get_item_sales_tax" id="_get_item_sales_tax">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_get_item_sales_tax">#</a>
<code><a href="source-class-Tax_lib.html#35-43" title="Go to source code">get_item_sales_tax</a>( <span> <var>$quantity</var></span>, <span> <var>$price</var></span>, <span> <var>$discount_percentage</var></span>, <span> <var>$tax_percentage</var></span>, <span> <var>$rounding_code</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="get_sales_tax_for_amount" id="_get_sales_tax_for_amount">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_get_sales_tax_for_amount">#</a>
<code><a href="source-class-Tax_lib.html#48-87" title="Go to source code">get_sales_tax_for_amount</a>( <span> <var>$tax_basis</var></span>, <span> <var>$tax_percentage</var></span>, <span> <var>$rounding_code</var></span>, <span> <var>$decimals</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="update_sales_taxes" id="_update_sales_taxes">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_update_sales_taxes">#</a>
<code><a href="source-class-Tax_lib.html#92-123" title="Go to source code">update_sales_taxes</a>( <span> <var>&amp; $sales_taxes</var></span>, <span> <var>$tax_type</var></span>, <span> <var>$tax_group</var></span>, <span> <var>$tax_rate</var></span>, <span> <var>$tax_basis</var></span>, <span> <var>$item_tax_amount</var></span>, <span> <var>$tax_group_sequence</var></span>, <span> <var>$rounding_code</var></span>, <span> <var>$sale_id</var></span>, <span> <var>$name</var> = <span class="php-quote">''</span></span>, <span> <var>$tax_code</var> = <span class="php-quote">''</span></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="apply_invoice_taxing" id="_apply_invoice_taxing">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_apply_invoice_taxing">#</a>
<code><a href="source-class-Tax_lib.html#128-146" title="Go to source code">apply_invoice_taxing</a>( <span> <var>&amp; $sales_taxes</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="round_sales_taxes" id="_round_sales_taxes">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_round_sales_taxes">#</a>
<code><a href="source-class-Tax_lib.html#151-204" title="Go to source code">round_sales_taxes</a>( <span> <var>&amp; $sales_taxes</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="apply_sales_tax" id="_apply_sales_tax">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_apply_sales_tax">#</a>
<code><a href="source-class-Tax_lib.html#207-293" title="Go to source code">apply_sales_tax</a>( <span> <var>&amp; $item</var></span>, <span> <var>&amp; $city</var></span>, <span> <var>&amp; $state</var></span>, <span> <var>&amp; $sales_tax_code</var></span>, <span> <var>$register_mode</var></span>, <span> <var>$sale_id</var></span>, <span> <var>&amp; $sales_taxes</var></span> )</code>
<div class="description short">
<p>Determine the applicable tax code and then determine the tax amount to be applied.
If a tax amount was identified then accumulate into the sales_taxes array</p>
</div>
<div class="description detailed hidden">
<p>Determine the applicable tax code and then determine the tax amount to be applied.
If a tax amount was identified then accumulate into the sales_taxes array</p>
</div>
</div></td>
</tr>
<tr data-order="get_applicable_tax_mode" id="_get_applicable_tax_mode">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_get_applicable_tax_mode">#</a>
<code><a href="source-class-Tax_lib.html#295-315" title="Go to source code">get_applicable_tax_mode</a>( <span> <var>$register_mode</var></span>, <span> <var>$city</var></span>, <span> <var>$state</var></span>, <span> <var>$sales_tax_code</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
<tr data-order="clean" id="_clean">
<td class="attributes"><code>
public
</code>
</td>
<td class="name"><div>
<a class="anchor" href="#_clean">#</a>
<code><a href="source-class-Tax_lib.html#317-322" title="Go to source code">clean</a>( <span> <var>$string</var></span> )</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</div></td>
</tr>
</table>
<table class="summary constants" id="constants">
<caption>Constants summary</caption>
<tr data-order="TAX_TYPE_SALES" id="TAX_TYPE_SALES">
<td class="attributes"><code>integer</code></td>
<td class="name">
<code>
<a href="source-class-Tax_lib.html#11" title="Go to source code"><b>TAX_TYPE_SALES</b></a>
</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#TAX_TYPE_SALES" class="anchor">#</a>
<code><span class="php-num">1</span></code>
</div>
</td>
</tr>
<tr data-order="TAX_TYPE_SALES_BY_INVOICE" id="TAX_TYPE_SALES_BY_INVOICE">
<td class="attributes"><code>integer</code></td>
<td class="name">
<code>
<a href="source-class-Tax_lib.html#12" title="Go to source code"><b>TAX_TYPE_SALES_BY_INVOICE</b></a>
</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#TAX_TYPE_SALES_BY_INVOICE" class="anchor">#</a>
<code><span class="php-num">2</span></code>
</div>
</td>
</tr>
<tr data-order="TAX_TYPE_VAT" id="TAX_TYPE_VAT">
<td class="attributes"><code>integer</code></td>
<td class="name">
<code>
<a href="source-class-Tax_lib.html#13" title="Go to source code"><b>TAX_TYPE_VAT</b></a>
</code>
<div class="description short">
</div>
<div class="description detailed hidden">
</div>
</td>
<td class="value">
<div>
<a href="#TAX_TYPE_VAT" class="anchor">#</a>
<code><span class="php-num">0</span></code>
</div>
</td>
</tr>
</table>
</div>
<div id="footer">
API documentation generated by <a href="http://apigen.org">ApiGen</a>
</div>
</div>
</div>
<script src="resources/combined.js"></script>
<script src="elementlist.js"></script>
</body>
</html>