osb/app/Models/Account.php

398 lines
10 KiB
PHP
Raw Normal View History

2018-07-06 06:57:49 +00:00
<?php
namespace App\Models;
2024-07-31 12:36:28 +00:00
use Carbon\Carbon;
2024-07-05 06:38:31 +00:00
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
2018-07-06 06:57:49 +00:00
use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Collection;
use Illuminate\Support\Facades\DB;
2021-06-29 06:36:34 +00:00
use Leenooks\Traits\ScopeActive;
2018-07-06 06:57:49 +00:00
2021-06-29 06:36:34 +00:00
use App\Interfaces\IDs;
2018-08-20 12:15:28 +00:00
2021-06-29 06:36:34 +00:00
/**
* Class Account
* Service Accounts
*
* Attributes for accounts:
* + lid : Local ID for account
* + sid : System ID for account
* + name : Account Name
* + taxes : Taxes Applicable to this account
2021-06-29 06:36:34 +00:00
*/
class Account extends Model implements IDs
2018-07-06 06:57:49 +00:00
{
use HasFactory,ScopeActive;
2018-08-20 12:15:28 +00:00
2024-07-05 06:38:31 +00:00
/* STATIC */
/**
* A list of invoices that are in credit for all accounts
*
* @param Collection|NULL $invoices
* @return Collection
*/
public static function InvoicesCredit(Collection $invoices=NULL): Collection
{
return (new self)
->invoiceSummaryCredit($invoices,TRUE)
->get();
}
/**
* A list of invoices that are due for all accounts
*
* @param Collection|NULL $invoices
* @return Collection
*/
2024-07-05 06:38:31 +00:00
public static function InvoicesDue(Collection $invoices=NULL): Collection
{
return (new self)
->invoiceSummaryDue($invoices,TRUE)
->get();
}
/* INTERFACES */
public function getLIDAttribute(): string
{
return sprintf('%04s',$this->id);
}
public function getSIDAttribute(): string
{
return sprintf('%02s-%s',$this->site_id,$this->getLIDAttribute());
}
2018-07-17 04:10:40 +00:00
2021-06-29 06:36:34 +00:00
/* RELATIONS */
/**
* Charges assigned to this account
*
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function charges()
{
return $this->hasMany(Charge::class);
}
2018-07-13 04:53:44 +00:00
/**
* Country this account belongs to
2018-07-13 04:53:44 +00:00
*/
public function country()
{
return $this->belongsTo(Country::class);
}
/**
* Group this account is assigned to
* Groups are used for pricing control
*
* @return \Illuminate\Database\Eloquent\Relations\HasOneThrough
*/
public function group()
{
return $this->hasOneThrough(Group::class,AccountGroup::class,'account_id','id','id','group_id');
}
/**
* Invoices created for this account
*/
2019-06-11 02:36:58 +00:00
public function invoices()
{
return $this->hasMany(Invoice::class)
2024-07-09 10:17:30 +00:00
->with(['items.taxes','payment_items.payment']);
2019-06-11 02:36:58 +00:00
}
/**
* Relation to only return active invoices
*/
public function invoices_active()
2018-07-13 04:53:44 +00:00
{
return $this->invoices()
->with('active',TRUE);;
2018-07-13 04:53:44 +00:00
}
/**
* Payments received and assigned to this account
*/
public function payments()
{
return $this->hasMany(Payment::class)
->with(['items']);
}
/**
* Relation to only return active payments
*/
public function payments_active()
{
return $this->payments()
->with('active',TRUE);
}
/**
* Return the link to a provider's info for this account
*/
public function providers()
{
2023-05-10 07:37:43 +00:00
return $this->belongsToMany(ProviderOauth::class,'account__provider')
->withPivot('ref','synctoken','created_at','updated_at');
}
/**
* Services assigned to this account
*/
public function services()
2018-08-08 23:33:51 +00:00
{
return $this->hasMany(Service::class)
2024-07-05 06:38:31 +00:00
->with(['product.translate','product.type.supplied']);
2018-08-08 23:33:51 +00:00
}
/**
* Relation to only return active services
*/
public function services_active()
{
return $this->services()
->ServiceActive();
}
/**
* Supplier configuration for this account
*/
public function suppliers()
{
return $this->belongsToMany(Supplier::class)
->withPivot('supplier_ref','created_at');
}
/**
* Taxes applicable for this account
*/
public function taxes()
{
return $this->hasMany(Tax::class,'country_id','country_id')
->select(['id','zone','rate','country_id']);
}
/**
* User that owns this account
*/
2018-07-13 04:53:44 +00:00
public function user()
{
2021-06-29 03:18:52 +00:00
return $this->belongsTo(User::class);
2018-07-13 04:53:44 +00:00
}
2018-07-17 04:10:40 +00:00
2021-06-29 06:36:34 +00:00
/* SCOPES */
2020-04-01 12:35:06 +00:00
/**
* Search for a record
*
2019-06-29 00:14:12 +00:00
* @param $query
* @param string $term
* @return mixed
*/
public function scopeSearch($query,string $term)
{
// Build our where clause
2021-07-07 07:45:16 +00:00
if (is_numeric($term)) {
$query->where('id','like','%'.$term.'%');
} else {
$query->where('company','ilike','%'.$term.'%')
->orWhere('address1','ilike','%'.$term.'%')
->orWhere('address2','ilike','%'.$term.'%')
->orWhere('city','ilike','%'.$term.'%');
}
return $query;
}
2021-06-29 06:36:34 +00:00
/* ATTRIBUTES */
/**
* Get the address for the account
*
2024-07-07 05:14:55 +00:00
* @return Collection
*/
2024-07-07 05:14:55 +00:00
public function getAddressAttribute(): Collection
{
return collect([
'address1' => $this->address1,
'address2' => $this->address2,
'location' => sprintf('%s %s %s',
$this->city.(($this->state || $this->zip) ? ',' : ''),
$this->state,
$this->zip)
])
2024-07-07 05:14:55 +00:00
->filter();
}
2021-06-29 06:36:34 +00:00
/**
* Return the account name
2021-06-29 06:36:34 +00:00
*
* @return string
2021-06-29 06:36:34 +00:00
*/
public function getNameAttribute(): string
{
return $this->company ?: ($this->user_id ? $this->user->getNameSurFirstAttribute() : 'LID:'.$this->id);
2018-08-08 23:33:51 +00:00
}
/**
* Return the type of account this is - if it has a company name, then its a business account.
*
* @return string
*/
public function getTypeAttribute(): string
2019-06-12 06:25:15 +00:00
{
return $this->company ? 'Business' : 'Private';
}
/* METHODS */
2019-06-11 02:36:58 +00:00
2024-07-31 12:36:28 +00:00
public function invoice_next(): Collection
{
// Collect all the invoice items for our active services
$nextdate = ($x=$this
->services_active
->filter(fn($item)=>$item->isBilled() && $item->invoice_next)
->sortBy(fn($item)=>(string)$item->invoice_next))
->first()
?->invoice_next
->clone();
// Add any additional items that will be invoiced 30 days
$nextitemsdate = max($nextdate,Carbon::now())
->clone()
->addMonth()
->subDay()
->endOfday();
$items = $x
->filter(fn($item)=>$item->invoice_next->lessThan($nextitemsdate))
->sortBy(fn($item)=>$item->invoice_next.$item->name)
->map(fn($item)=>$item->next_invoice_items($nextitemsdate))
->flatten();
// Add any account charges (charges with no active service)
foreach ($this->charges->filter(function($item) { return $item->unprocessed && ((! $this->service_id) || (! $item->service->isBilled())); }) as $oo) {
$ii = new InvoiceItem;
$ii->active = TRUE;
$ii->service_id = $oo->service_id;
$ii->product_id = $this->product_id;
$ii->quantity = $oo->quantity;
$ii->item_type = $oo->type;
$ii->price_base = $oo->amount;
$ii->start_at = $oo->start_at;
$ii->stop_at = $oo->stop_at;
$ii->module_id = 30; // @todo This shouldnt be hard coded
$ii->module_ref = $oo->id;
$ii->site_id = 1; // @todo
$ii->addTaxes($this->country->taxes);
$items->push($ii);
}
return $items;
}
/**
* List of invoices (summary) for this account
*
* @param Collection|NULL $invoices
2024-07-31 12:36:28 +00:00
* @param bool $all
* @return Builder
*/
2024-07-05 06:38:31 +00:00
public function invoiceSummary(Collection $invoices=NULL,bool $all=FALSE): Builder
{
return (new Invoice)
->select([
2024-07-05 06:38:31 +00:00
'invoices.account_id',
'invoices.id as id',
DB::raw('SUM(item) AS _item'),
DB::raw('SUM(tax) AS _tax'),
DB::raw('SUM(payments) AS _payment'),
DB::raw('SUM(discount)+COALESCE(invoices.discount_amt,0) AS _discount'),
DB::raw('SUM(item_total) AS _item_total'),
DB::raw('SUM(payment_fees) AS _payment_fee'),
DB::raw('ROUND(CAST(SUM(item_total)-COALESCE(invoices.discount_amt,0) AS NUMERIC),2) AS _total'),
DB::raw('ROUND(CAST(SUM(item_total)-COALESCE(invoices.discount_amt,0)-SUM(payments) AS NUMERIC),2) AS _balance'),
2024-07-05 06:38:31 +00:00
'invoices.due_at',
'invoices.created_at',
])
->from(
(new Payment)
->select([
'invoice_id',
DB::raw('0 as item'),
DB::raw('0 as tax'),
DB::raw('0 as discount'),
DB::raw('0 as item_total'),
DB::raw('SUM(amount) AS payments'),
DB::raw('SUM(fees_amt) AS payment_fees'),
])
->leftjoin('payment_items',['payment_items.payment_id'=>'payments.id'])
->where('payments.active',TRUE)
->where('payment_items.active',TRUE)
->groupBy(['payment_items.invoice_id'])
->union(
(new InvoiceItem)
->select([
'invoice_id',
DB::raw('ROUND(CAST(SUM(quantity*price_base) AS NUMERIC),2) AS item'),
DB::raw('ROUND(CAST(SUM(COALESCE(amount,0)) AS NUMERIC),2) AS tax'),
DB::raw('ROUND(CAST(SUM(COALESCE(invoice_items.discount_amt,0)) AS NUMERIC),2) AS discount'),
DB::raw('ROUND(CAST(SUM(ROUND(CAST(quantity*(price_base-COALESCE(invoice_items.discount_amt,0)) AS NUMERIC),2))+SUM(ROUND(CAST(COALESCE(amount,0) AS NUMERIC),2)) AS NUMERIC),2) AS item_total'),
DB::raw('0 as payments'),
DB::raw('0 as payment_fees'),
])
->leftjoin('invoice_item_taxes',['invoice_item_taxes.invoice_item_id'=>'invoice_items.id'])
->rightjoin('invoices',['invoices.id'=>'invoice_items.invoice_id'])
->where('invoice_items.active',TRUE)
->where(fn($query)=>$query->where('invoice_item_taxes.active',TRUE)->orWhereNull('invoice_item_taxes.active'))
->where('invoices.active',TRUE)
->groupBy(['invoice_items.invoice_id']),
),'p')
->join('invoices',['invoices.id'=>'invoice_id'])
2024-07-05 06:38:31 +00:00
->when(($all === FALSE),fn($query)=>$query->where('invoices.account_id',$this->id))
->orderBy('due_at')
->groupBy(['invoices.account_id','invoices.id','invoices.created_at','invoices.due_at','invoices.discount_amt'])
->with(['account']);
}
public function invoiceSummaryDue(Collection $invoices=NULL,bool $all=FALSE): Builder
{
return $this->invoiceSummary($invoices,$all)
->havingRaw('ROUND(CAST(SUM(item_total)-COALESCE(invoices.discount_amt,0)-SUM(payments) AS NUMERIC),2) > 0');
}
public function invoiceSummaryCredit(Collection $invoices=NULL,bool $all=FALSE): Builder
{
return $this->invoiceSummary($invoices,$all)
->havingRaw('ROUND(CAST(SUM(item_total)-COALESCE(invoices.discount_amt,0)-SUM(payments) AS NUMERIC),2) < 0');
2024-07-05 06:38:31 +00:00
}
public function invoiceSummaryPast(Collection $invoices=NULL,bool $all=FALSE): Builder
{
return $this->invoiceSummary($invoices,$all)
->join('payment_items',['payment_items.invoice_id'=>'invoices.id'])
->join('payments',['payments.id'=>'payment_items.payment_id'])
->addSelect(DB::raw('max(paid_at) as _paid_at'))
->havingRaw('ROUND(CAST(SUM(item_total)-COALESCE(invoices.discount_amt,0)-SUM(payments) AS NUMERIC),2) <= 0');
}
2023-05-05 05:48:24 +00:00
/**
* Return the taxed value of a value
*
* @param float $value
* @return float
*/
public function taxed(float $value): float
{
return Tax::calc($value,$this->taxes);
}
2018-07-06 06:57:49 +00:00
}