mirror of
https://github.com/invoiceninja/invoiceninja.git
synced 2024-11-10 13:12:50 +01:00
1270 lines
33 KiB
PHP
1270 lines
33 KiB
PHP
<?php namespace App\Models;
|
|
|
|
use Utils;
|
|
use DateTime;
|
|
use Illuminate\Database\Eloquent\SoftDeletes;
|
|
use Laracasts\Presenter\PresentableTrait;
|
|
use App\Events\QuoteWasCreated;
|
|
use App\Events\QuoteWasUpdated;
|
|
use App\Events\InvoiceWasCreated;
|
|
use App\Events\InvoiceWasUpdated;
|
|
use App\Events\InvoiceInvitationWasEmailed;
|
|
use App\Events\QuoteInvitationWasEmailed;
|
|
|
|
/**
|
|
* Class Invoice
|
|
*/
|
|
class Invoice extends EntityModel implements BalanceAffecting
|
|
{
|
|
use PresentableTrait;
|
|
use OwnedByClientTrait;
|
|
use SoftDeletes {
|
|
SoftDeletes::trashed as parentTrashed;
|
|
}
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
protected $presenter = 'App\Ninja\Presenters\InvoicePresenter';
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected $dates = ['deleted_at'];
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected $fillable = [
|
|
'tax_name1',
|
|
'tax_rate1',
|
|
'tax_name2',
|
|
'tax_rate2',
|
|
];
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
protected $casts = [
|
|
'is_recurring' => 'boolean',
|
|
'has_tasks' => 'boolean',
|
|
'client_enable_auto_bill' => 'boolean',
|
|
'has_expenses' => 'boolean',
|
|
];
|
|
|
|
// used for custom invoice numbers
|
|
/**
|
|
* @var array
|
|
*/
|
|
public static $patternFields = [
|
|
'counter',
|
|
'custom1',
|
|
'custom2',
|
|
'userId',
|
|
'year',
|
|
'date:',
|
|
];
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
public static $fieldInvoiceNumber = 'invoice_number';
|
|
/**
|
|
* @var string
|
|
*/
|
|
public static $fieldInvoiceDate = 'invoice_date';
|
|
/**
|
|
* @var string
|
|
*/
|
|
public static $fieldDueDate = 'due_date';
|
|
/**
|
|
* @var string
|
|
*/
|
|
public static $fieldAmount = 'amount';
|
|
/**
|
|
* @var string
|
|
*/
|
|
public static $fieldPaid = 'paid';
|
|
/**
|
|
* @var string
|
|
*/
|
|
public static $fieldNotes = 'notes';
|
|
/**
|
|
* @var string
|
|
*/
|
|
public static $fieldTerms = 'terms';
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public static function getImportColumns()
|
|
{
|
|
return [
|
|
Client::$fieldName,
|
|
Invoice::$fieldInvoiceNumber,
|
|
Invoice::$fieldInvoiceDate,
|
|
Invoice::$fieldDueDate,
|
|
Invoice::$fieldAmount,
|
|
Invoice::$fieldPaid,
|
|
Invoice::$fieldNotes,
|
|
Invoice::$fieldTerms,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
*/
|
|
public static function getImportMap()
|
|
{
|
|
return [
|
|
'number^po' => 'invoice_number',
|
|
'amount' => 'amount',
|
|
'organization' => 'name',
|
|
'paid^date' => 'paid',
|
|
'invoice_date|create_date' => 'invoice_date',
|
|
'terms' => 'terms',
|
|
'notes' => 'notes',
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getRoute()
|
|
{
|
|
if ($this->is_recurring) {
|
|
$entityType = 'recurring_invoice';
|
|
} else {
|
|
$entityType = $this->getEntityType();
|
|
}
|
|
|
|
return "/{$entityType}s/{$this->public_id}/edit";
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function getDisplayName()
|
|
{
|
|
return $this->is_recurring ? trans('texts.recurring') : $this->invoice_number;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function affectsBalance()
|
|
{
|
|
return $this->isType(INVOICE_TYPE_STANDARD) && !$this->is_recurring;
|
|
}
|
|
|
|
/**
|
|
* @return float|int
|
|
*/
|
|
public function getAdjustment()
|
|
{
|
|
if (!$this->affectsBalance()) {
|
|
return 0;
|
|
}
|
|
|
|
return $this->getRawAdjustment();
|
|
}
|
|
|
|
/**
|
|
* @return float
|
|
*/
|
|
private function getRawAdjustment()
|
|
{
|
|
return floatval($this->amount) - floatval($this->getOriginal('amount'));
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isChanged()
|
|
{
|
|
if ($this->getRawAdjustment() != 0) {
|
|
return true;
|
|
}
|
|
|
|
foreach ([
|
|
'invoice_number',
|
|
'po_number',
|
|
'invoice_date',
|
|
'due_date',
|
|
'terms',
|
|
'public_notes',
|
|
'invoice_footer',
|
|
'partial',
|
|
] as $field) {
|
|
if ($this->$field != $this->getOriginal($field)) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @param bool $calculate
|
|
* @return int|mixed
|
|
*/
|
|
public function getAmountPaid($calculate = false)
|
|
{
|
|
if ($this->isType(INVOICE_TYPE_QUOTE) || $this->is_recurring) {
|
|
return 0;
|
|
}
|
|
|
|
if ($calculate) {
|
|
$amount = 0;
|
|
foreach ($this->payments as $payment) {
|
|
if ($payment->payment_status_id == PAYMENT_STATUS_VOIDED || $payment->payment_status_id == PAYMENT_STATUS_FAILED) {
|
|
continue;
|
|
}
|
|
$amount += $payment->getCompletedAmount();
|
|
}
|
|
return $amount;
|
|
} else {
|
|
return ($this->amount - $this->balance);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function trashed()
|
|
{
|
|
if ($this->client && $this->client->trashed()) {
|
|
return true;
|
|
}
|
|
|
|
return self::parentTrashed();
|
|
}
|
|
|
|
/**
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
*/
|
|
public function account()
|
|
{
|
|
return $this->belongsTo('App\Models\Account');
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function user()
|
|
{
|
|
return $this->belongsTo('App\Models\User')->withTrashed();
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function client()
|
|
{
|
|
return $this->belongsTo('App\Models\Client')->withTrashed();
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function invoice_items()
|
|
{
|
|
return $this->hasMany('App\Models\InvoiceItem')->orderBy('id');
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function documents()
|
|
{
|
|
return $this->hasMany('App\Models\Document')->orderBy('id');
|
|
}
|
|
|
|
/**
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
*/
|
|
public function invoice_status()
|
|
{
|
|
return $this->belongsTo('App\Models\InvoiceStatus');
|
|
}
|
|
|
|
/**
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
*/
|
|
public function invoice_design()
|
|
{
|
|
return $this->belongsTo('App\Models\InvoiceDesign');
|
|
}
|
|
|
|
/**
|
|
* @return \Illuminate\Database\Eloquent\Relations\HasMany
|
|
*/
|
|
public function payments()
|
|
{
|
|
return $this->hasMany('App\Models\Payment', 'invoice_id', 'id');
|
|
}
|
|
|
|
/**
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
*/
|
|
public function recurring_invoice()
|
|
{
|
|
return $this->belongsTo('App\Models\Invoice');
|
|
}
|
|
|
|
/**
|
|
* @return \Illuminate\Database\Eloquent\Relations\HasMany
|
|
*/
|
|
public function recurring_invoices()
|
|
{
|
|
return $this->hasMany('App\Models\Invoice', 'recurring_invoice_id');
|
|
}
|
|
|
|
/**
|
|
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
|
|
*/
|
|
public function frequency()
|
|
{
|
|
return $this->belongsTo('App\Models\Frequency');
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function invitations()
|
|
{
|
|
return $this->hasMany('App\Models\Invitation')->orderBy('invitations.contact_id');
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function expenses()
|
|
{
|
|
return $this->hasMany('App\Models\Expense','invoice_id','id')->withTrashed();
|
|
}
|
|
|
|
/**
|
|
* @param $query
|
|
* @return mixed
|
|
*/
|
|
public function scopeInvoices($query)
|
|
{
|
|
return $query->where('invoice_type_id', '=', INVOICE_TYPE_STANDARD)
|
|
->where('is_recurring', '=', false);
|
|
}
|
|
|
|
/**
|
|
* @param $query
|
|
* @return mixed
|
|
*/
|
|
public function scopeQuotes($query)
|
|
{
|
|
return $query->where('invoice_type_id', '=', INVOICE_TYPE_QUOTE)
|
|
->where('is_recurring', '=', false);
|
|
}
|
|
|
|
/**
|
|
* @param $query
|
|
* @param $typeId
|
|
* @return mixed
|
|
*/
|
|
public function scopeInvoiceType($query, $typeId)
|
|
{
|
|
return $query->where('invoice_type_id', '=', $typeId);
|
|
}
|
|
|
|
/**
|
|
* @param $typeId
|
|
* @return bool
|
|
*/
|
|
public function isType($typeId) {
|
|
return $this->invoice_type_id == $typeId;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isQuote() {
|
|
return $this->isType(INVOICE_TYPE_QUOTE);
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isInvoice() {
|
|
return $this->isType(INVOICE_TYPE_STANDARD) && ! $this->is_recurring;
|
|
}
|
|
|
|
/**
|
|
* @param bool $notify
|
|
*/
|
|
public function markInvitationsSent($notify = false)
|
|
{
|
|
foreach ($this->invitations as $invitation) {
|
|
$this->markInvitationSent($invitation, false, $notify);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param $invitation
|
|
* @param bool $messageId
|
|
* @param bool $notify
|
|
*/
|
|
public function markInvitationSent($invitation, $messageId = false, $notify = true)
|
|
{
|
|
if (!$this->isSent()) {
|
|
$this->invoice_status_id = INVOICE_STATUS_SENT;
|
|
$this->save();
|
|
}
|
|
|
|
$invitation->markSent($messageId);
|
|
|
|
// if the user marks it as sent rather than acually sending it
|
|
// then we won't track it in the activity log
|
|
if (!$notify) {
|
|
return;
|
|
}
|
|
|
|
if ($this->isType(INVOICE_TYPE_QUOTE)) {
|
|
event(new QuoteInvitationWasEmailed($invitation));
|
|
} else {
|
|
event(new InvoiceInvitationWasEmailed($invitation));
|
|
}
|
|
}
|
|
|
|
public function markViewed()
|
|
{
|
|
if (!$this->isViewed()) {
|
|
$this->invoice_status_id = INVOICE_STATUS_VIEWED;
|
|
$this->save();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param bool $save
|
|
*/
|
|
public function updatePaidStatus($save = true)
|
|
{
|
|
$statusId = false;
|
|
if ($this->amount > 0 && $this->balance == 0) {
|
|
$statusId = INVOICE_STATUS_PAID;
|
|
} elseif ($this->balance > 0 && $this->balance < $this->amount) {
|
|
$statusId = INVOICE_STATUS_PARTIAL;
|
|
} elseif ($this->isPartial() && $this->balance > 0) {
|
|
$statusId = ($this->balance == $this->amount ? INVOICE_STATUS_SENT : INVOICE_STATUS_PARTIAL);
|
|
}
|
|
|
|
if ($statusId && $statusId != $this->invoice_status_id) {
|
|
$this->invoice_status_id = $statusId;
|
|
if ($save) {
|
|
$this->save();
|
|
}
|
|
}
|
|
}
|
|
|
|
public function markApproved()
|
|
{
|
|
if ($this->isType(INVOICE_TYPE_QUOTE)) {
|
|
$this->invoice_status_id = INVOICE_STATUS_APPROVED;
|
|
$this->save();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param $balanceAdjustment
|
|
* @param int $partial
|
|
*/
|
|
public function updateBalances($balanceAdjustment, $partial = 0)
|
|
{
|
|
if ($this->is_deleted) {
|
|
return;
|
|
}
|
|
|
|
$this->balance = $this->balance + $balanceAdjustment;
|
|
|
|
if ($this->partial > 0) {
|
|
$this->partial = $partial;
|
|
}
|
|
|
|
$this->save();
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function getName()
|
|
{
|
|
return $this->is_recurring ? trans('texts.recurring') : $this->invoice_number;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getFileName()
|
|
{
|
|
$entityType = $this->getEntityType();
|
|
return trans("texts.$entityType") . '_' . $this->invoice_number . '.pdf';
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getPDFPath()
|
|
{
|
|
return storage_path() . '/pdfcache/cache-' . $this->id . '.pdf';
|
|
}
|
|
|
|
/**
|
|
* @param $invoice
|
|
* @return string
|
|
*/
|
|
public static function calcLink($invoice)
|
|
{
|
|
return link_to('invoices/' . $invoice->public_id, $invoice->invoice_number);
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getLink()
|
|
{
|
|
return self::calcLink($this);
|
|
}
|
|
|
|
public function getInvitationLink($type = 'view', $forceOnsite = false)
|
|
{
|
|
if ( ! $this->relationLoaded('invitations')) {
|
|
$this->load('invitations');
|
|
}
|
|
|
|
return $this->invitations[0]->getLink($type, $forceOnsite);
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function getEntityType()
|
|
{
|
|
return $this->isType(INVOICE_TYPE_QUOTE) ? ENTITY_QUOTE : ENTITY_INVOICE;
|
|
}
|
|
|
|
public function subEntityType()
|
|
{
|
|
if ($this->is_recurring) {
|
|
return ENTITY_RECURRING_INVOICE;
|
|
} else {
|
|
return $this->getEntityType();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isSent()
|
|
{
|
|
return $this->invoice_status_id >= INVOICE_STATUS_SENT;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isViewed()
|
|
{
|
|
return $this->invoice_status_id >= INVOICE_STATUS_VIEWED;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isPartial()
|
|
{
|
|
return $this->invoice_status_id >= INVOICE_STATUS_PARTIAL;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isPaid()
|
|
{
|
|
return $this->invoice_status_id >= INVOICE_STATUS_PAID;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function isOverdue()
|
|
{
|
|
if ( ! $this->due_date) {
|
|
return false;
|
|
}
|
|
|
|
return time() > strtotime($this->due_date);
|
|
}
|
|
|
|
/**
|
|
* @return mixed
|
|
*/
|
|
public function getRequestedAmount()
|
|
{
|
|
return $this->partial > 0 ? $this->partial : $this->balance;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
public function getCurrencyCode()
|
|
{
|
|
if ($this->client->currency) {
|
|
return $this->client->currency->code;
|
|
} elseif ($this->account->currency) {
|
|
return $this->account->currency->code;
|
|
} else {
|
|
return 'USD';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return $this
|
|
*/
|
|
public function hidePrivateFields()
|
|
{
|
|
$this->setVisible([
|
|
'invoice_number',
|
|
'discount',
|
|
'is_amount_discount',
|
|
'po_number',
|
|
'invoice_date',
|
|
'due_date',
|
|
'terms',
|
|
'invoice_footer',
|
|
'public_notes',
|
|
'amount',
|
|
'balance',
|
|
'invoice_items',
|
|
'documents',
|
|
'expenses',
|
|
'client',
|
|
'tax_name1',
|
|
'tax_rate1',
|
|
'tax_name2',
|
|
'tax_rate2',
|
|
'account',
|
|
'invoice_design',
|
|
'invoice_design_id',
|
|
'invoice_fonts',
|
|
'features',
|
|
'invoice_type_id',
|
|
'custom_value1',
|
|
'custom_value2',
|
|
'custom_taxes1',
|
|
'custom_taxes2',
|
|
'partial',
|
|
'has_tasks',
|
|
'custom_text_value1',
|
|
'custom_text_value2',
|
|
'has_expenses',
|
|
]);
|
|
|
|
$this->client->setVisible([
|
|
'name',
|
|
'id_number',
|
|
'vat_number',
|
|
'address1',
|
|
'address2',
|
|
'city',
|
|
'state',
|
|
'postal_code',
|
|
'work_phone',
|
|
'payment_terms',
|
|
'contacts',
|
|
'country',
|
|
'currency_id',
|
|
'country_id',
|
|
'custom_value1',
|
|
'custom_value2',
|
|
]);
|
|
|
|
$this->account->setVisible([
|
|
'name',
|
|
'website',
|
|
'id_number',
|
|
'vat_number',
|
|
'address1',
|
|
'address2',
|
|
'city',
|
|
'state',
|
|
'postal_code',
|
|
'work_phone',
|
|
'work_email',
|
|
'country',
|
|
'currency_id',
|
|
'custom_label1',
|
|
'custom_value1',
|
|
'custom_label2',
|
|
'custom_value2',
|
|
'custom_client_label1',
|
|
'custom_client_label2',
|
|
'primary_color',
|
|
'secondary_color',
|
|
'hide_quantity',
|
|
'hide_paid_to_date',
|
|
'all_pages_header',
|
|
'all_pages_footer',
|
|
'custom_invoice_label1',
|
|
'custom_invoice_label2',
|
|
'pdf_email_attachment',
|
|
'show_item_taxes',
|
|
'custom_invoice_text_label1',
|
|
'custom_invoice_text_label2',
|
|
'custom_invoice_item_label1',
|
|
'custom_invoice_item_label2',
|
|
'invoice_embed_documents',
|
|
'page_size',
|
|
'include_item_taxes_inline',
|
|
'invoice_fields',
|
|
]);
|
|
|
|
foreach ($this->invoice_items as $invoiceItem) {
|
|
$invoiceItem->setVisible([
|
|
'product_key',
|
|
'notes',
|
|
'custom_value1',
|
|
'custom_value2',
|
|
'cost',
|
|
'qty',
|
|
'tax_name1',
|
|
'tax_rate1',
|
|
'tax_name2',
|
|
'tax_rate2',
|
|
]);
|
|
}
|
|
|
|
foreach ($this->client->contacts as $contact) {
|
|
$contact->setVisible([
|
|
'first_name',
|
|
'last_name',
|
|
'email',
|
|
'phone',
|
|
]);
|
|
}
|
|
|
|
foreach ($this->documents as $document) {
|
|
$document->setVisible([
|
|
'public_id',
|
|
'name',
|
|
]);
|
|
}
|
|
|
|
foreach ($this->expenses as $expense) {
|
|
$expense->setVisible([
|
|
'documents',
|
|
]);
|
|
|
|
foreach ($expense->documents as $document) {
|
|
$document->setVisible([
|
|
'public_id',
|
|
'name',
|
|
]);
|
|
}
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @return bool|\Recurr\RecurrenceCollection
|
|
* @throws \Recurr\Exception\MissingData
|
|
*/
|
|
public function getSchedule()
|
|
{
|
|
if (!$this->start_date || !$this->is_recurring || !$this->frequency_id) {
|
|
return false;
|
|
}
|
|
|
|
$startDate = $this->getOriginal('last_sent_date') ?: $this->getOriginal('start_date');
|
|
$startDate .= ' ' . $this->account->recurring_hour . ':00:00';
|
|
$startDate = $this->account->getDateTime($startDate);
|
|
$endDate = $this->end_date ? $this->account->getDateTime($this->getOriginal('end_date')) : null;
|
|
$timezone = $this->account->getTimezone();
|
|
|
|
$rule = $this->getRecurrenceRule();
|
|
$rule = new \Recurr\Rule("{$rule}", $startDate, $endDate, $timezone);
|
|
|
|
// Fix for months with less than 31 days
|
|
$transformerConfig = new \Recurr\Transformer\ArrayTransformerConfig();
|
|
$transformerConfig->enableLastDayOfMonthFix();
|
|
|
|
$transformer = new \Recurr\Transformer\ArrayTransformer();
|
|
$transformer->setConfig($transformerConfig);
|
|
$dates = $transformer->transform($rule);
|
|
|
|
if (count($dates) < 2) {
|
|
return false;
|
|
}
|
|
|
|
return $dates;
|
|
}
|
|
|
|
/**
|
|
* @return null
|
|
*/
|
|
public function getNextSendDate()
|
|
{
|
|
if ($this->start_date && !$this->last_sent_date) {
|
|
$startDate = $this->getOriginal('start_date') . ' ' . $this->account->recurring_hour . ':00:00';
|
|
return $this->account->getDateTime($startDate);
|
|
}
|
|
|
|
if (!$schedule = $this->getSchedule()) {
|
|
return null;
|
|
}
|
|
|
|
if (count($schedule) < 2) {
|
|
return null;
|
|
}
|
|
|
|
return $schedule[1]->getStart();
|
|
}
|
|
|
|
/**
|
|
* @param null $invoice_date
|
|
* @return mixed|null
|
|
*/
|
|
public function getDueDate($invoice_date = null){
|
|
if(!$this->is_recurring) {
|
|
return $this->due_date ? $this->due_date : null;
|
|
}
|
|
else{
|
|
$now = time();
|
|
if($invoice_date) {
|
|
// If $invoice_date is specified, all calculations are based on that date
|
|
if(is_numeric($invoice_date)) {
|
|
$now = $invoice_date;
|
|
}
|
|
else if(is_string($invoice_date)) {
|
|
$now = strtotime($invoice_date);
|
|
}
|
|
elseif ($invoice_date instanceof \DateTime) {
|
|
$now = $invoice_date->getTimestamp();
|
|
}
|
|
}
|
|
|
|
if($this->due_date && $this->due_date != '0000-00-00'){
|
|
// This is a recurring invoice; we're using a custom format here.
|
|
// The year is always 1998; January is 1st, 2nd, last day of the month.
|
|
// February is 1st Sunday after, 1st Monday after, ..., through 4th Saturday after.
|
|
$dueDateVal = strtotime($this->due_date);
|
|
$monthVal = (int)date('n', $dueDateVal);
|
|
$dayVal = (int)date('j', $dueDateVal);
|
|
$dueDate = false;
|
|
|
|
if($monthVal == 1) {// January; day of month
|
|
$currentDay = (int)date('j', $now);
|
|
$lastDayOfMonth = (int)date('t', $now);
|
|
|
|
$dueYear = (int)date('Y', $now);// This year
|
|
$dueMonth = (int)date('n', $now);// This month
|
|
$dueDay = $dayVal;// The day specified for the invoice
|
|
|
|
if($dueDay > $lastDayOfMonth) {
|
|
// No later than the end of the month
|
|
$dueDay = $lastDayOfMonth;
|
|
}
|
|
|
|
if($currentDay >= $dueDay) {
|
|
// Wait until next month
|
|
// We don't need to handle the December->January wraparaound, since PHP handles month 13 as January of next year
|
|
$dueMonth++;
|
|
|
|
// Reset the due day
|
|
$dueDay = $dayVal;
|
|
$lastDayOfMonth = (int)date('t', mktime(0, 0, 0, $dueMonth, 1, $dueYear));// The number of days in next month
|
|
|
|
// Check against the last day again
|
|
if($dueDay > $lastDayOfMonth){
|
|
// No later than the end of the month
|
|
$dueDay = $lastDayOfMonth;
|
|
}
|
|
}
|
|
|
|
$dueDate = mktime(0, 0, 0, $dueMonth, $dueDay, $dueYear);
|
|
}
|
|
else if($monthVal == 2) {// February; day of week
|
|
$ordinals = ['first', 'second', 'third', 'fourth'];
|
|
$daysOfWeek = ['sunday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'saturday'];
|
|
|
|
$ordinalIndex = ceil($dayVal / 7) - 1;// 1-7 are "first"; 8-14 are "second", etc.
|
|
$dayOfWeekIndex = ($dayVal - 1) % 7;// 1,8,15,22 are Sunday, 2,9,16,23 are Monday, etc.
|
|
$dayStr = $ordinals[$ordinalIndex] . ' ' . $daysOfWeek[$dayOfWeekIndex];// "first sunday", "first monday", etc.
|
|
|
|
$dueDate = strtotime($dayStr, $now);
|
|
}
|
|
|
|
if($dueDate) {
|
|
return date('Y-m-d', $dueDate);// SQL format
|
|
}
|
|
}
|
|
else if ($this->client->payment_terms != 0) {
|
|
// No custom due date set for this invoice; use the client's payment terms
|
|
$days = $this->client->payment_terms;
|
|
if ($days == -1) {
|
|
$days = 0;
|
|
}
|
|
return date('Y-m-d', strtotime('+'.$days.' day', $now));
|
|
}
|
|
}
|
|
|
|
// Couldn't calculate one
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* @param int $min
|
|
* @param int $max
|
|
* @return null
|
|
*/
|
|
public function getPrettySchedule($min = 1, $max = 10)
|
|
{
|
|
if (!$schedule = $this->getSchedule($max)) {
|
|
return null;
|
|
}
|
|
|
|
$dates = [];
|
|
|
|
for ($i=$min; $i<min($max, count($schedule)); $i++) {
|
|
$date = $schedule[$i];
|
|
$dateStart = $date->getStart();
|
|
$date = $this->account->formatDate($dateStart);
|
|
$dueDate = $this->getDueDate($dateStart);
|
|
|
|
if($dueDate) {
|
|
$date .= ' <small>(' . trans('texts.due') . ' ' . $this->account->formatDate($dueDate) . ')</small>';
|
|
}
|
|
|
|
$dates[] = $date;
|
|
}
|
|
|
|
return implode('<br/>', $dates);
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
private function getRecurrenceRule()
|
|
{
|
|
$rule = '';
|
|
|
|
switch ($this->frequency_id) {
|
|
case FREQUENCY_WEEKLY:
|
|
$rule = 'FREQ=WEEKLY;';
|
|
break;
|
|
case FREQUENCY_TWO_WEEKS:
|
|
$rule = 'FREQ=WEEKLY;INTERVAL=2;';
|
|
break;
|
|
case FREQUENCY_FOUR_WEEKS:
|
|
$rule = 'FREQ=WEEKLY;INTERVAL=4;';
|
|
break;
|
|
case FREQUENCY_MONTHLY:
|
|
$rule = 'FREQ=MONTHLY;';
|
|
break;
|
|
case FREQUENCY_THREE_MONTHS:
|
|
$rule = 'FREQ=MONTHLY;INTERVAL=3;';
|
|
break;
|
|
case FREQUENCY_SIX_MONTHS:
|
|
$rule = 'FREQ=MONTHLY;INTERVAL=6;';
|
|
break;
|
|
case FREQUENCY_ANNUALLY:
|
|
$rule = 'FREQ=YEARLY;';
|
|
break;
|
|
}
|
|
|
|
if ($this->end_date) {
|
|
$rule .= 'UNTIL=' . $this->getOriginal('end_date');
|
|
}
|
|
|
|
return $rule;
|
|
}
|
|
|
|
/*
|
|
public function shouldSendToday()
|
|
{
|
|
if (!$nextSendDate = $this->getNextSendDate()) {
|
|
return false;
|
|
}
|
|
|
|
return $this->account->getDateTime() >= $nextSendDate;
|
|
}
|
|
*/
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function shouldSendToday()
|
|
{
|
|
if ( ! $this->user->confirmed) {
|
|
return false;
|
|
}
|
|
|
|
if ( ! $this->start_date || strtotime($this->start_date) > strtotime('now')) {
|
|
return false;
|
|
}
|
|
|
|
if ($this->end_date && strtotime($this->end_date) < strtotime('now')) {
|
|
return false;
|
|
}
|
|
|
|
$dayOfWeekToday = date('w');
|
|
$dayOfWeekStart = date('w', strtotime($this->start_date));
|
|
|
|
$dayOfMonthToday = date('j');
|
|
$dayOfMonthStart = date('j', strtotime($this->start_date));
|
|
|
|
if (!$this->last_sent_date) {
|
|
return true;
|
|
} else {
|
|
$date1 = new DateTime($this->last_sent_date);
|
|
$date2 = new DateTime();
|
|
$diff = $date2->diff($date1);
|
|
$daysSinceLastSent = $diff->format('%a');
|
|
$monthsSinceLastSent = ($diff->format('%y') * 12) + $diff->format('%m');
|
|
|
|
if ($daysSinceLastSent == 0) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
switch ($this->frequency_id) {
|
|
case FREQUENCY_WEEKLY:
|
|
return $daysSinceLastSent >= 7;
|
|
case FREQUENCY_TWO_WEEKS:
|
|
return $daysSinceLastSent >= 14;
|
|
case FREQUENCY_FOUR_WEEKS:
|
|
return $daysSinceLastSent >= 28;
|
|
case FREQUENCY_MONTHLY:
|
|
return $monthsSinceLastSent >= 1;
|
|
case FREQUENCY_THREE_MONTHS:
|
|
return $monthsSinceLastSent >= 3;
|
|
case FREQUENCY_SIX_MONTHS:
|
|
return $monthsSinceLastSent >= 6;
|
|
case FREQUENCY_ANNUALLY:
|
|
return $monthsSinceLastSent >= 12;
|
|
default:
|
|
return false;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @return bool|string
|
|
*/
|
|
public function getPDFString()
|
|
{
|
|
if (!env('PHANTOMJS_CLOUD_KEY')) {
|
|
return false;
|
|
}
|
|
|
|
$invitation = $this->invitations[0];
|
|
$link = $invitation->getLink('view', true);
|
|
$key = env('PHANTOMJS_CLOUD_KEY');
|
|
|
|
if (Utils::isNinjaDev()) {
|
|
$link = env('TEST_LINK');
|
|
}
|
|
|
|
$url = "http://api.phantomjscloud.com/api/browser/v2/{$key}/?request=%7Burl:%22{$link}?phantomjs=true%22,renderType:%22html%22%7D";
|
|
|
|
$pdfString = file_get_contents($url);
|
|
$pdfString = strip_tags($pdfString);
|
|
|
|
if ( ! $pdfString || strlen($pdfString) < 200) {
|
|
Utils::logError("PhantomJSCloud - failed to create pdf: {$pdfString}");
|
|
return false;
|
|
}
|
|
|
|
return Utils::decodePDF($pdfString);
|
|
}
|
|
|
|
/**
|
|
* @param $invoiceItem
|
|
* @param $invoiceTotal
|
|
* @return float|int
|
|
*/
|
|
public function getItemTaxable($invoiceItem, $invoiceTotal)
|
|
{
|
|
$total = $invoiceItem->qty * $invoiceItem->cost;
|
|
|
|
if ($this->discount > 0) {
|
|
if ($this->is_amount_discount) {
|
|
$total -= $invoiceTotal ? ($total / $invoiceTotal * $this->discount) : 0;
|
|
} else {
|
|
$total *= (100 - $this->discount) / 100;
|
|
$total = round($total, 2);
|
|
}
|
|
}
|
|
|
|
return $total;
|
|
}
|
|
|
|
/**
|
|
* @return float|int|mixed
|
|
*/
|
|
public function getTaxable()
|
|
{
|
|
$total = 0;
|
|
|
|
foreach ($this->invoice_items as $invoiceItem) {
|
|
$total += $invoiceItem->qty * $invoiceItem->cost;
|
|
}
|
|
|
|
if ($this->discount > 0) {
|
|
if ($this->is_amount_discount) {
|
|
$total -= $this->discount;
|
|
} else {
|
|
$total *= (100 - $this->discount) / 100;
|
|
$total = round($total, 2);
|
|
}
|
|
}
|
|
|
|
if ($this->custom_value1 && $this->custom_taxes1) {
|
|
$total += $this->custom_value1;
|
|
}
|
|
|
|
if ($this->custom_value2 && $this->custom_taxes2) {
|
|
$total += $this->custom_value2;
|
|
}
|
|
|
|
return $total;
|
|
}
|
|
|
|
// if $calculatePaid is true we'll loop through each payment to
|
|
// determine the sum, otherwise we'll use the cached paid_to_date amount
|
|
/**
|
|
* @param bool $calculatePaid
|
|
* @return array
|
|
*/
|
|
public function getTaxes($calculatePaid = false)
|
|
{
|
|
$taxes = [];
|
|
$taxable = $this->getTaxable();
|
|
$paidAmount = $this->getAmountPaid($calculatePaid);
|
|
|
|
if ($this->tax_name1) {
|
|
$invoiceTaxAmount = round($taxable * ($this->tax_rate1 / 100), 2);
|
|
$invoicePaidAmount = floatVal($this->amount) && $invoiceTaxAmount ? ($paidAmount / $this->amount * $invoiceTaxAmount) : 0;
|
|
$this->calculateTax($taxes, $this->tax_name1, $this->tax_rate1, $invoiceTaxAmount, $invoicePaidAmount);
|
|
}
|
|
|
|
if ($this->tax_name2) {
|
|
$invoiceTaxAmount = round($taxable * ($this->tax_rate2 / 100), 2);
|
|
$invoicePaidAmount = floatVal($this->amount) && $invoiceTaxAmount ? ($paidAmount / $this->amount * $invoiceTaxAmount) : 0;
|
|
$this->calculateTax($taxes, $this->tax_name2, $this->tax_rate2, $invoiceTaxAmount, $invoicePaidAmount);
|
|
}
|
|
|
|
foreach ($this->invoice_items as $invoiceItem) {
|
|
$itemTaxAmount = $this->getItemTaxable($invoiceItem, $taxable);
|
|
|
|
if ($invoiceItem->tax_name1) {
|
|
$itemTaxAmount = round($taxable * ($invoiceItem->tax_rate1 / 100), 2);
|
|
$itemPaidAmount = floatVal($this->amount) && $itemTaxAmount ? ($paidAmount / $this->amount * $itemTaxAmount) : 0;
|
|
$this->calculateTax($taxes, $invoiceItem->tax_name1, $invoiceItem->tax_rate1, $itemTaxAmount, $itemPaidAmount);
|
|
}
|
|
|
|
if ($invoiceItem->tax_name2) {
|
|
$itemTaxAmount = round($taxable * ($invoiceItem->tax_rate2 / 100), 2);
|
|
$itemPaidAmount = floatVal($this->amount) && $itemTaxAmount ? ($paidAmount / $this->amount * $itemTaxAmount) : 0;
|
|
$this->calculateTax($taxes, $invoiceItem->tax_name2, $invoiceItem->tax_rate2, $itemTaxAmount, $itemPaidAmount);
|
|
}
|
|
}
|
|
|
|
return $taxes;
|
|
}
|
|
|
|
/**
|
|
* @param $taxes
|
|
* @param $name
|
|
* @param $rate
|
|
* @param $amount
|
|
* @param $paid
|
|
*/
|
|
private function calculateTax(&$taxes, $name, $rate, $amount, $paid)
|
|
{
|
|
if ( ! $amount) {
|
|
return;
|
|
}
|
|
|
|
$amount = round($amount, 2);
|
|
$paid = round($paid, 2);
|
|
$key = $rate . ' ' . $name;
|
|
|
|
if ( ! isset($taxes[$key])) {
|
|
$taxes[$key] = [
|
|
'name' => $name,
|
|
'rate' => $rate+0,
|
|
'amount' => 0,
|
|
'paid' => 0
|
|
];
|
|
}
|
|
|
|
$taxes[$key]['amount'] += $amount;
|
|
$taxes[$key]['paid'] += $paid;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function hasDocuments(){
|
|
if(count($this->documents))return true;
|
|
return $this->hasExpenseDocuments();
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function hasExpenseDocuments(){
|
|
foreach($this->expenses as $expense){
|
|
if(count($expense->documents))return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @return bool
|
|
*/
|
|
public function getAutoBillEnabled() {
|
|
if (!$this->is_recurring) {
|
|
$recurInvoice = $this->recurring_invoice;
|
|
} else {
|
|
$recurInvoice = $this;
|
|
}
|
|
|
|
if (!$recurInvoice) {
|
|
return false;
|
|
}
|
|
|
|
return $recurInvoice->auto_bill == AUTO_BILL_ALWAYS || ($recurInvoice->auto_bill != AUTO_BILL_OFF && $recurInvoice->client_enable_auto_bill);
|
|
}
|
|
}
|
|
|
|
Invoice::creating(function ($invoice) {
|
|
if (!$invoice->is_recurring) {
|
|
$invoice->account->incrementCounter($invoice);
|
|
}
|
|
});
|
|
|
|
Invoice::created(function ($invoice) {
|
|
if ($invoice->isType(INVOICE_TYPE_QUOTE)) {
|
|
event(new QuoteWasCreated($invoice));
|
|
} else {
|
|
event(new InvoiceWasCreated($invoice));
|
|
}
|
|
});
|
|
|
|
Invoice::updating(function ($invoice) {
|
|
if ($invoice->isType(INVOICE_TYPE_QUOTE)) {
|
|
event(new QuoteWasUpdated($invoice));
|
|
} else {
|
|
event(new InvoiceWasUpdated($invoice));
|
|
}
|
|
});
|