mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-11-10 21:22:58 +01:00
470 lines
12 KiB
PHP
470 lines
12 KiB
PHP
<?php
|
|
/**
|
|
* Invoice Ninja (https://invoiceninja.com).
|
|
*
|
|
* @link https://github.com/invoiceninja/invoiceninja source repository
|
|
*
|
|
* @copyright Copyright (c) 2023. Invoice Ninja LLC (https://invoiceninja.com)
|
|
*
|
|
* @license https://www.elastic.co/licensing/elastic-license
|
|
*/
|
|
|
|
namespace App\Helpers\Invoice;
|
|
|
|
use App\DataMapper\BaseSettings;
|
|
use App\DataMapper\InvoiceItem;
|
|
use App\DataMapper\Tax\RuleInterface;
|
|
use App\Models\Client;
|
|
use App\Models\Credit;
|
|
use App\Models\Invoice;
|
|
use App\Models\PurchaseOrder;
|
|
use App\Models\Quote;
|
|
use App\Models\RecurringInvoice;
|
|
use App\Models\RecurringQuote;
|
|
use App\Utils\Traits\NumberFormatter;
|
|
|
|
class InvoiceItemSum
|
|
{
|
|
use NumberFormatter;
|
|
use Discounter;
|
|
use Taxer;
|
|
|
|
private array $eu_tax_jurisdictions = [
|
|
'AT', // Austria
|
|
'BE', // Belgium
|
|
'BG', // Bulgaria
|
|
'CY', // Cyprus
|
|
'CZ', // Czech Republic
|
|
'DE', // Germany
|
|
'DK', // Denmark
|
|
'EE', // Estonia
|
|
'ES', // Spain
|
|
'FI', // Finland
|
|
'FR', // France
|
|
'GR', // Greece
|
|
'HR', // Croatia
|
|
'HU', // Hungary
|
|
'IE', // Ireland
|
|
'IT', // Italy
|
|
'LT', // Lithuania
|
|
'LU', // Luxembourg
|
|
'LV', // Latvia
|
|
'MT', // Malta
|
|
'NL', // Netherlands
|
|
'PL', // Poland
|
|
'PT', // Portugal
|
|
'RO', // Romania
|
|
'SE', // Sweden
|
|
'SI', // Slovenia
|
|
'SK', // Slovakia
|
|
];
|
|
|
|
private array $tax_jurisdictions = [
|
|
'AT', // Austria
|
|
'BE', // Belgium
|
|
'BG', // Bulgaria
|
|
'CY', // Cyprus
|
|
'CZ', // Czech Republic
|
|
'DE', // Germany
|
|
'DK', // Denmark
|
|
'EE', // Estonia
|
|
'ES', // Spain
|
|
'FI', // Finland
|
|
'FR', // France
|
|
'GR', // Greece
|
|
'HR', // Croatia
|
|
'HU', // Hungary
|
|
'IE', // Ireland
|
|
'IT', // Italy
|
|
'LT', // Lithuania
|
|
'LU', // Luxembourg
|
|
'LV', // Latvia
|
|
'MT', // Malta
|
|
'NL', // Netherlands
|
|
'PL', // Poland
|
|
'PT', // Portugal
|
|
'RO', // Romania
|
|
'SE', // Sweden
|
|
'SI', // Slovenia
|
|
'SK', // Slovakia
|
|
|
|
'US', // USA
|
|
|
|
'AU', // Australia
|
|
];
|
|
|
|
protected RecurringInvoice | Invoice | Quote | Credit | PurchaseOrder | RecurringQuote $invoice;
|
|
|
|
private $items;
|
|
|
|
private $line_total;
|
|
|
|
private $gross_line_total;
|
|
|
|
private $tax_amount;
|
|
|
|
private $currency;
|
|
|
|
private $total_taxes;
|
|
|
|
private $item;
|
|
|
|
private $line_items;
|
|
|
|
private $sub_total;
|
|
|
|
private $gross_sub_total;
|
|
|
|
private $total_discount;
|
|
|
|
private $tax_collection;
|
|
|
|
private ?Client $client;
|
|
|
|
private bool $calc_tax = false;
|
|
|
|
private RuleInterface $rule;
|
|
|
|
public function __construct(RecurringInvoice | Invoice | Quote | Credit | PurchaseOrder | RecurringQuote $invoice)
|
|
{
|
|
$this->tax_collection = collect([]);
|
|
|
|
$this->invoice = $invoice;
|
|
|
|
if ($this->invoice->client) {
|
|
$this->currency = $this->invoice->client->currency();
|
|
$this->client = $this->invoice->client;
|
|
$this->shouldCalculateTax();
|
|
} else {
|
|
$this->currency = $this->invoice->vendor->currency();
|
|
}
|
|
|
|
$this->line_items = [];
|
|
}
|
|
|
|
public function process(): self
|
|
{
|
|
if (!$this->invoice->line_items || !is_iterable($this->invoice->line_items)) {
|
|
$this->items = [];
|
|
return $this;
|
|
}
|
|
|
|
$this->calcLineItems();
|
|
|
|
return $this;
|
|
}
|
|
|
|
private function calcLineItems(): self
|
|
{
|
|
foreach ($this->invoice->line_items as $this->item) {
|
|
$this->cleanLineItem()
|
|
->sumLineItem()
|
|
->setDiscount()
|
|
->calcTaxes()
|
|
->push();
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
private function shouldCalculateTax(): self
|
|
{
|
|
|
|
if (!$this->invoice->company?->calculate_taxes || $this->invoice->company->account->isFreeHostedClient()) {
|
|
$this->calc_tax = false;
|
|
return $this;
|
|
}
|
|
|
|
if (in_array($this->client->company->country()->iso_3166_2, $this->tax_jurisdictions)) { //only calculate for supported tax jurisdictions
|
|
|
|
|
|
/** @var \App\DataMapper\Tax\BaseRule $class */
|
|
$class = "App\DataMapper\Tax\\".$this->client->company->country()->iso_3166_2."\\Rule";
|
|
|
|
$this->rule = new $class();
|
|
|
|
if($this->rule->regionWithNoTaxCoverage($this->client->country->iso_3166_2)) {
|
|
return $this;
|
|
}
|
|
|
|
$this->rule
|
|
->setEntity($this->invoice)
|
|
->init();
|
|
|
|
$this->calc_tax = $this->rule->shouldCalcTax();
|
|
|
|
return $this;
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
private function push(): self
|
|
{
|
|
$this->sub_total += round($this->getLineTotal(), $this->currency->precision);
|
|
|
|
$this->gross_sub_total += $this->getGrossLineTotal();
|
|
|
|
$this->line_items[] = $this->item;
|
|
|
|
return $this;
|
|
}
|
|
|
|
private function sumLineItem()
|
|
{
|
|
$this->setLineTotal($this->item->cost * $this->item->quantity);
|
|
|
|
return $this;
|
|
}
|
|
|
|
private function setDiscount()
|
|
{
|
|
if ($this->invoice->is_amount_discount) {
|
|
$this->setLineTotal($this->getLineTotal() - $this->formatValue($this->item->discount, $this->currency->precision));
|
|
} else {
|
|
$discount = ($this->item->line_total * ($this->item->discount / 100));
|
|
|
|
$this->setLineTotal($this->formatValue(($this->getLineTotal() - $discount), $this->currency->precision));
|
|
}
|
|
|
|
$this->item->is_amount_discount = $this->invoice->is_amount_discount;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Attempts to calculate taxes based on the clients location
|
|
*
|
|
* @return self
|
|
*/
|
|
private function calcTaxesAutomatically(): self
|
|
{
|
|
$this->rule->tax($this->item);
|
|
|
|
$precision = strlen(substr(strrchr($this->rule->tax_rate1, "."), 1));
|
|
|
|
$this->item->tax_name1 = $this->rule->tax_name1;
|
|
$this->item->tax_rate1 = round($this->rule->tax_rate1, $precision);
|
|
|
|
$precision = strlen(substr(strrchr($this->rule->tax_rate2, "."), 1));
|
|
|
|
$this->item->tax_name2 = $this->rule->tax_name2;
|
|
$this->item->tax_rate2 = round($this->rule->tax_rate2, $precision);
|
|
|
|
$precision = strlen(substr(strrchr($this->rule->tax_rate3, "."), 1));
|
|
|
|
$this->item->tax_name3 = $this->rule->tax_name3;
|
|
$this->item->tax_rate3 = round($this->rule->tax_rate3, $precision);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* calcTaxes
|
|
*
|
|
* @return self
|
|
*/
|
|
private function calcTaxes()
|
|
{
|
|
if ($this->calc_tax) {
|
|
$this->calcTaxesAutomatically();
|
|
}
|
|
|
|
$item_tax = 0;
|
|
|
|
$amount = $this->item->line_total - ($this->item->line_total * ($this->invoice->discount / 100));
|
|
$item_tax_rate1_total = $this->calcAmountLineTax($this->item->tax_rate1, $amount);
|
|
|
|
$item_tax += $item_tax_rate1_total;
|
|
|
|
if (strlen($this->item->tax_name1) > 1) {
|
|
$this->groupTax($this->item->tax_name1, $this->item->tax_rate1, $item_tax_rate1_total);
|
|
}
|
|
|
|
$item_tax_rate2_total = $this->calcAmountLineTax($this->item->tax_rate2, $amount);
|
|
|
|
$item_tax += $item_tax_rate2_total;
|
|
|
|
if (strlen($this->item->tax_name2) > 1) {
|
|
$this->groupTax($this->item->tax_name2, $this->item->tax_rate2, $item_tax_rate2_total);
|
|
}
|
|
|
|
$item_tax_rate3_total = $this->calcAmountLineTax($this->item->tax_rate3, $amount);
|
|
|
|
$item_tax += $item_tax_rate3_total;
|
|
|
|
if (strlen($this->item->tax_name3) > 1) {
|
|
$this->groupTax($this->item->tax_name3, $this->item->tax_rate3, $item_tax_rate3_total);
|
|
}
|
|
|
|
$this->setTotalTaxes($this->formatValue($item_tax, $this->currency->precision));
|
|
|
|
$this->item->gross_line_total = $this->getLineTotal() + $item_tax;
|
|
|
|
$this->item->tax_amount = $item_tax;
|
|
|
|
return $this;
|
|
}
|
|
|
|
private function groupTax($tax_name, $tax_rate, $tax_total)
|
|
{
|
|
$group_tax = [];
|
|
|
|
$key = str_replace(' ', '', $tax_name.$tax_rate);
|
|
|
|
$group_tax = ['key' => $key, 'total' => $tax_total, 'tax_name' => $tax_name.' '.floatval($tax_rate).'%'];
|
|
|
|
$this->tax_collection->push(collect($group_tax));
|
|
}
|
|
|
|
public function getTotalTaxes()
|
|
{
|
|
return $this->total_taxes;
|
|
}
|
|
|
|
public function setTotalTaxes($total)
|
|
{
|
|
$this->total_taxes = $total;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function setLineTotal($total)
|
|
{
|
|
$this->item->line_total = $total;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function getLineTotal()
|
|
{
|
|
return $this->item->line_total;
|
|
}
|
|
|
|
public function getGrossLineTotal()
|
|
{
|
|
return $this->item->gross_line_total;
|
|
}
|
|
|
|
public function getLineItems()
|
|
{
|
|
return $this->line_items;
|
|
}
|
|
|
|
public function getGroupedTaxes()
|
|
{
|
|
return $this->tax_collection;
|
|
}
|
|
|
|
public function setGroupedTaxes($group_taxes)
|
|
{
|
|
$this->tax_collection = $group_taxes;
|
|
|
|
return $this;
|
|
}
|
|
|
|
public function getSubTotal()
|
|
{
|
|
return $this->sub_total;
|
|
}
|
|
|
|
public function getGrossSubTotal()
|
|
{
|
|
return $this->gross_sub_total;
|
|
}
|
|
|
|
public function setSubTotal($value)
|
|
{
|
|
$this->sub_total = $value;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Invoice Amount Discount.
|
|
*
|
|
* The problem, when calculating invoice level discounts,
|
|
* the tax collected changes.
|
|
*
|
|
* We need to synthetically reduce the line_total amounts
|
|
* and recalculate the taxes and then pass back
|
|
* the updated map
|
|
*/
|
|
public function calcTaxesWithAmountDiscount()
|
|
{
|
|
$this->setGroupedTaxes(collect([]));
|
|
|
|
foreach ($this->line_items as $key => $this->item) {
|
|
if ($this->item->line_total == 0) {
|
|
continue;
|
|
}
|
|
|
|
$item_tax = 0;
|
|
|
|
try {
|
|
$amount = $this->item->line_total - ($this->item->line_total * ($this->invoice->discount / $this->sub_total));
|
|
} catch(\DivisionByZeroError $e) {
|
|
$amount = $this->item->line_total;
|
|
}
|
|
|
|
//$amount = ($this->sub_total > 0) ? $this->item->line_total - ($this->invoice->discount * ($this->item->line_total / $this->sub_total)) : 0;
|
|
|
|
$item_tax_rate1_total = $this->calcAmountLineTax($this->item->tax_rate1, $amount);
|
|
|
|
$item_tax += $item_tax_rate1_total;
|
|
|
|
if ($item_tax_rate1_total != 0) {
|
|
$this->groupTax($this->item->tax_name1, $this->item->tax_rate1, $item_tax_rate1_total);
|
|
}
|
|
|
|
$item_tax_rate2_total = $this->calcAmountLineTax($this->item->tax_rate2, $amount);
|
|
|
|
$item_tax += $item_tax_rate2_total;
|
|
|
|
if ($item_tax_rate2_total != 0) {
|
|
$this->groupTax($this->item->tax_name2, $this->item->tax_rate2, $item_tax_rate2_total);
|
|
}
|
|
|
|
$item_tax_rate3_total = $this->calcAmountLineTax($this->item->tax_rate3, $amount);
|
|
|
|
$item_tax += $item_tax_rate3_total;
|
|
|
|
if ($item_tax_rate3_total != 0) {
|
|
$this->groupTax($this->item->tax_name3, $this->item->tax_rate3, $item_tax_rate3_total);
|
|
}
|
|
|
|
$this->item->gross_line_total = $this->getLineTotal() + $item_tax;
|
|
$this->item->tax_amount = $item_tax;
|
|
|
|
$this->line_items[$key] = $this->item;
|
|
|
|
$this->setTotalTaxes($this->getTotalTaxes() + $item_tax);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Sets default casts for the values in the line_items.
|
|
*
|
|
* @return $this
|
|
*/
|
|
private function cleanLineItem()
|
|
{
|
|
$invoice_item = (object) get_class_vars(InvoiceItem::class);
|
|
unset($invoice_item->casts);
|
|
|
|
foreach ($invoice_item as $key => $value) {
|
|
if (! property_exists($this->item, $key) || ! isset($this->item->{$key})) {
|
|
$this->item->{$key} = $value;
|
|
$this->item->{$key} = BaseSettings::castAttribute(InvoiceItem::$casts[$key], $value);
|
|
}
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
}
|