F72X\Sunat\InvoiceDocument

Complexity

Total Complexity

49

Size/Duplication

Total Lines	353
Duplicated Lines	0 %

Importance

Changes

0

45 Methods

Rating	Name	Duplication	Size	Complexity
A	setCustomerDocNumber()	0	3	1
A	getRawItems()	0	2	1
A	getCurrencyType()	0	2	1
A	getPurchaseOrder()	0	2	1
A	getTotalTaxableOperations()	0	2	1
A	getTotalFreeOperations()	0	2	1
A	getTaxedAmount()	0	4	1
A	getVoucherNumber()	0	2	1
A	getItems()	0	2	1
A	getIVAP()	0	2	1
A	getTotalItems()	0	2	1
A	setAllowancesAndCharges()	0	3	1
A	setVoucherSeries()	0	3	1
A	getCustomerRegName()	0	2	1
A	getIssueDate()	0	2	1
A	setCustomerRegName()	0	3	1
A	setIssueDate()	0	3	1
A	getCustomerDocType()	0	2	1
A	getDueDate()	0	2	1
A	getInvoiceType()	0	2	1
A	getAllowancesAndCharges()	0	2	1
A	getBillableValue()	0	2	1
A	getRawData()	0	2	1
A	getIGV()	0	3	1
A	setDueDate()	0	3	1
A	getISC()	0	2	1
A	__construct()	0	21	1
A	getCustomerDocNumber()	0	2	1
A	getTotalExemptedOperations()	0	3	1
A	getVoucherId()	0	2	1
A	getTotalAllowances()	0	5	1
A	setTypeProperties()	0	8	2
A	setOperationType()	0	3	1
A	addDefaults()	0	4	4
A	getVoucherIdPrefix()	0	2	1
A	applyAllowancesAndCharges()	0	2	1
A	setCustomerDocType()	0	3	1
A	getOperationType()	0	2	1
A	getPayableAmount()	0	6	1
A	getTotalTaxes()	0	5	1
A	setVoucherNumber()	0	3	1
A	getTotalUnaffectedOperations()	0	3	1
A	getTaxableAmount()	0	3	1
A	getVoucherSeries()	0	2	1
A	setPurchaseOrder()	0	3	1

<?php

/**
 * MÓDULO DE EMISIÓN ELECTRÓNICA F72X
 * UBL 2.1
 * Version 1.1
 * 
 * Copyright 2018, Jaime Cruz
 */

namespace F72X\Sunat;

use DateTime;
/**
 * InvoiceDocument
 * 
 * Esta clase es una representación interna de una factura o boleta, la cual se
 * encarga de aplicar toda la logica de negocio en cuanto a cálculos de tributos
 * y totales
 * 
 */
class InvoiceDocument {

    const BOLETA_PREFIX = 'B';
    const FACTURA_PREFIX = 'F';

    private $_rawData;
    private $invoiceType;
    private $currencyType;
    private $voucherId;
    private $voucherIdPrefix;
    private $voucherSeries;
    private $voucherNumber;

    /** @var DateTime */
    private $issueDate;

    /** @var DateTime */
    protected $DueDate;
    private $operationType;
    private $customerDocType;
    private $customerDocNumber;
    private $customerRegName;
    private $purchaseOrder;

    /** @var InvoiceItems */
    private $_items;
    private $_rawItems;
    private $allowancesAndCharges = [];

    /**
     * 
     * @param array $data
     * @param string $type Catalogo::CAT1_BOLETA|Catalogo::CAT1_FACTURA
     * @param string $currencyType
     */
    public function __construct(array $data, $type, $currencyType = 'PEN') {
        // Items
        $items = new InvoiceItems();
        $items->populate($data['items'], $currencyType);

        $this->_rawData = $data;
        $this->_rawItems = $data['items'];
        $this->addDefaults($data);
        $this->currencyType = $currencyType;
        $this->voucherSeries = $data['voucherSeries'];
        $this->voucherNumber = $data['voucherNumber'];
        // requires voucherSeries and voucherNumber
        $this->setTypeProperties($type);
        $this->issueDate = $data['issueDate'];
        $this->purchaseOrder = $data['purchaseOrder'];
        $this->operationType = $data['operationType'];
        $this->customerDocType = $data['customerDocType'];
        $this->customerDocNumber = $data['customerDocNumber'];
        $this->customerRegName = mb_strtoupper($data['customerRegName']);
        $this->_items = $items;
        $this->allowancesAndCharges = $data['allowancesCharges'];
    }

    private function addDefaults(array &$data) {
        $data['allowancesCharges'] = isset($data['allowancesCharges']) ? $data['allowancesCharges'] : [];
        $data['issueDate']  = isset($data['issueDate']) ? $data['issueDate'] : new DateTime();
        $data['purchaseOrder'] = isset($data['purchaseOrder']) ? $data['purchaseOrder'] : null;
    }

    private function setTypeProperties($type) {
        $this->invoiceType = $type;
        if ($type === Catalogo::CAT1_BOLETA) {
            $this->voucherIdPrefix = self::BOLETA_PREFIX;
        } else {
            $this->voucherIdPrefix = self::FACTURA_PREFIX;
        }
        $this->voucherId = $this->voucherIdPrefix . str_pad($this->voucherSeries, 3, '0', STR_PAD_LEFT) . '-' . str_pad($this->voucherNumber, 8, '0', STR_PAD_LEFT);
    }

    public function getVoucherId() {
        return $this->voucherId;
    }

    public function getRawData() {
        return $this->_rawData;
    }

    /**
     * Boleta o Factura @CAT1
     * @return string
     */
    public function getInvoiceType() {
        return $this->invoiceType;
    }

    public function getCurrencyType() {
        return $this->currencyType;
    }

    public function getVoucherIdPrefix() {
        return $this->voucherIdPrefix;
    }

    public function getVoucherSeries() {
        return $this->voucherSeries;
    }

    public function setVoucherSeries($voucherSeries) {
        $this->voucherSeries = $voucherSeries;
        return $this;
    }

    public function getVoucherNumber() {
        return $this->voucherNumber;
    }

    public function setVoucherNumber($voucherNumber) {
        $this->voucherNumber = $voucherNumber;
        return $this;
    }

    public function getIssueDate() {
        return $this->issueDate;
    }

    public function setIssueDate(DateTime $IssueDate) {
        $this->issueDate = $IssueDate;
        return $this;
    }

    public function getDueDate() {
        return $this->DueDate;
    }

    public function setDueDate(DateTime $DueDate) {
        $this->DueDate = $DueDate;
        return $this;
    }

    public function getOperationType() {
        return $this->operationType;
    }

    public function setOperationType($operationType) {
        $this->operationType = $operationType;
        return $this;
    }

    public function getCustomerDocType() {
        return $this->customerDocType;
    }

    public function setCustomerDocType($customerDocType) {
        $this->customerDocType = $customerDocType;
        return $this;
    }

    public function getCustomerDocNumber() {
        return $this->customerDocNumber;
    }

    public function setCustomerDocNumber($customerDocNumber) {
        $this->customerDocNumber = $customerDocNumber;
        return $this;
    }

    public function getCustomerRegName() {
        return $this->customerRegName;
    }

    public function setCustomerRegName($customerRegName) {
        $this->customerRegName = $customerRegName;
        return $this;
    }

    public function getPurchaseOrder() {
        return $this->purchaseOrder;
    }

    public function setPurchaseOrder($purchaseOrder) {
        $this->purchaseOrder = $purchaseOrder;
        return $this;
    }

    /**
     * 
     * @return InvoiceItems
     */
    public function getItems() {
        return $this->_items;
    }

    /**
     * Numero de items del documento
     * @return int
     */
    public function getTotalItems() {
        return $this->_items->getCount();
    }

    public function getRawItems() {
        return $this->_rawItems;
    }

    public function getAllowancesAndCharges() {
        return $this->allowancesAndCharges;
    }

    public function setAllowancesAndCharges($allowancesAndCharges) {
        $this->allowancesAndCharges = $allowancesAndCharges;
        return $this;
    }

    /**
     * Base imponible
     * 
     * Formula = SUM(BASE_IMPONIBLE_X_ITEM) - DESCUENTOS_GLOBALES + CARGOS_GLOBALES
     * 
     * @return float
     */
    public function getTaxableAmount() {
        $totalItems = $this->_items->getTotalTaxableOperations();
        return $this->applyAllowancesAndCharges($totalItems);
    }
    /**
     * Monto con impuestos
     * 
     * Formula = BASE_IMPONIBLE + IGV
     * 
     * @return float
     */
    public function getTaxedAmount() {
        $totalTaxableAmount = $this->getTaxableAmount();
        $totalIgv = $this->getIGV();
        return $totalTaxableAmount + $totalIgv;
    }

    /**
     * Total operaciones gravadas
     * @return float
     */
    public function getTotalTaxableOperations() {
        return $this->getTaxableAmount();
    }
    /**
     * Total operaciones gratuitas
     * @return float
     */
    public function getTotalFreeOperations() {
        return $this->_items->getTotalFreeOperations();
    }

    /**
     * Total operationes exoneradas
     * 
     * Formula = SUM(EXEMPTED_OPERATIONS_X_ITEM) - DESCUENTOS_GLOBALES + CARGOS_GLOBALES
     * 
     * @return float
     */
    public function getTotalExemptedOperations() {
        $totalItems = $this->_items->getTotalExemptedOperations();
        return $this->applyAllowancesAndCharges($totalItems);
    }

    /**
     * Total operaciones inafectas
     * @return float
     */
    public function getTotalUnaffectedOperations() {
        $totalItems = $this->_items->getTotalUnaffectedOperations();
        return $this->applyAllowancesAndCharges($totalItems);
    }
    /**
     * Valor de venta
     * 
     * Valor total de la factura sin considerar descuentos impuestos u otros tributos
     * @return float
     */
    public function getBillableValue() {
        return $this->_items->getTotalBillableValue();
    }

    /**
     * Total descuentos
     * 
     * Formula: SUM(DESCUENTOS_X_ITEM) + DESCUENTOS_GLOBALES
     * @return float
     */
    public function getTotalAllowances() {
        $totalItems = $this->_items->getTotalAllowances();
        $totalTaxableAmountItems = $this->_items->getTotalTaxableAmount();
        $globalAllowancesAmount = Operations::getTotalAllowances($totalTaxableAmountItems, $this->allowancesAndCharges);
        return $totalItems + $globalAllowancesAmount;
    }
    /**
     * Total a pagar
     * 
     * El importe que el usuario está obligado a pagar
     * 
     * Formula = OPERACIONES_GRAVADAS + IGV + OPERACIONES_EXONERADAS + OPERACIONES_INAFECTAS
     * 
     * @return float
     */
    public function getPayableAmount() {
        // Totals
        $totalTaxableOperations  = $this->getTotalTaxableOperations();
        $totalIGV                = $this->getIGV();
        $totalExemptedOperations = $this->getTotalExemptedOperations();
        return $totalTaxableOperations + $totalIGV + $totalExemptedOperations;
    }

    /**
     * 
     * Total impuestos
     * 
     * Fórmula: IGV + ISC + IVAP
     * 
     * @return float
     */
    public function getTotalTaxes() {
        $IGV  = $this->getIGV();
        $ISC  = $this->getISC();
        $IVAP = $this->getIVAP();
        return $IGV + $ISC + $IVAP;
    }

    /**
     * IGV
     * @return float
     */
    public function getIGV() {
        $baseAmount = $this->getTaxableAmount();
        return Operations::calcIGV($baseAmount);
    }

    /**
     * ISC
     * @IMP
     * @return float
     */
    public function getISC() {
        return Operations::calcISC();
    }
    /**
     * IVAP
     * @IMP
     * @return float
     */
    public function getIVAP() {
        return Operations::calcIVAP();
    }
    /**
     * 
     * @param float $amount
     * @return float
     */
    private function applyAllowancesAndCharges($amount) {
        return Operations::applyAllowancesAndCharges($amount, $this->allowancesAndCharges);
    }

}