Overview
The Client model represents customers in the ERP system. It manages customer information, credit limits, account balances, payment terms, and integrates with accounting and sales modules.
Namespace: App\Models\Clients\Client
Database Table: clients
Traits: HasFactory, SoftDeletes
Properties
Fillable Attributes
Client type: ‘individual’ or ‘company’
Foreign key to the client status configuration
Commercial or trade name (optional)
Foreign key to the State model for geographic location
Foreign key to TaxIdentifierType (RNC, Cédula, etc.)
Tax identification number (RNC, Cédula, etc.)
Maximum credit amount allowed for this client
Current outstanding balance
Number of days for payment terms (e.g., 30, 60, 90)
Foreign key to a specific AccountingAccount (optional)
Relationships
pos()
Returns all points of sale associated with this client.
Returns a collection of PointOfSale models
$client->pos; // Collection of PointOfSale objects
estadoCliente()
Returns the client status configuration.
Returns an EstadosCliente model instance
$client->estadoCliente; // EstadosCliente object
$client->estadoCliente->nombre; // Status name
state()
Returns the geographic state/province of the client.
Returns a State model instance
$client->state; // State object
$client->state->name; // State name
taxIdentifierType()
Returns the tax identifier type configuration.
Returns a TaxIdentifierType model instance
$client->taxIdentifierType; // TaxIdentifierType object
$client->taxIdentifierType->code; // 'RNC', 'CED', etc.
accountingAccount()
Returns the specific accounting account for this client (if configured).
Returns an AccountingAccount model instance or null
$client->accountingAccount; // AccountingAccount object or null
$client->accountingAccount->code; // Account code
payments()
Returns all payments made by this client.
Returns a collection of Payment models
$client->payments; // Collection of Payment objects
sales()
Returns all sales transactions for this client.
Returns a collection of Sale models
$client->sales; // Collection of Sale objects
receivables()
Returns all accounts receivable for this client.
Returns a collection of Receivable models
$client->receivables; // Collection of Receivable objects
Accessors
displayName
Returns the commercial name if available, otherwise returns the legal name.
$client->displayName; // Returns commercial_name or name
taxLabel
Returns the appropriate tax identifier label based on configuration.
$client->taxLabel; // Returns 'RNC', 'CED', or 'ID Fiscal'
Public Methods
refreshBalance()
Recalculates the client’s current balance based on unpaid and partially paid receivables.
$client->refreshBalance();
// Returns: bool (true if saved successfully)
public function refreshBalance(): bool
{
$this->balance = $this->receivables()
->whereIn('status', [Receivable::STATUS_UNPAID, Receivable::STATUS_PARTIAL])
->sum('current_balance');
return $this->save();
}
hasCustomAccount()
Determines if the client has a specific accounting account or uses the general accounts receivable account.
$client->hasCustomAccount();
// Returns: bool
public function hasCustomAccount(): bool
{
return !is_null($this->accounting_account_id);
}
Scopes
withIndexRelations()
Eager loads all necessary relationships for index pages and list views.
Client::withIndexRelations()->get();
estadoCliente (id, nombre, clase_fondo, clase_texto)state (id, name)taxIdentifierType (id, name, code)accountingAccount (id, code, name)
Usage Examples
Creating a Client
use App\Models\Clients\Client;
$client = Client::create([
'type' => 'company',
'name' => 'Empresa ABC, S.A.',
'commercial_name' => 'ABC Corp',
'email' => 'contacto@abc.com',
'phone' => '809-555-1234',
'tax_id' => '101234567',
'state_id' => 1,
'city' => 'Santo Domingo',
'address' => 'Calle Principal #123',
'credit_limit' => 50000.00,
'payment_terms' => 30
]);
Querying Clients
// Get all clients with relationships
$clients = Client::withIndexRelations()
->orderBy('name')
->get();
// Access client data
foreach ($clients as $client) {
echo $client->displayName;
echo $client->taxLabel . ': ' . $client->tax_id;
echo $client->estadoCliente->nombre;
}
Managing Credit and Balance
// Check if client has available credit
$availableCredit = $client->credit_limit - $client->balance;
if ($availableCredit >= $saleAmount) {
// Process sale
} else {
// Reject or require payment
}
// Refresh balance after payments
$client->refreshBalance();
Working with Client Sales
// Get all sales for a client
$totalSales = $client->sales()
->where('status', 'completed')
->sum('total_amount');
// Get sales from this month
$monthlySales = $client->sales()
->whereMonth('sale_date', now()->month)
->with('items.product')
->get();
Managing Receivables
// Get unpaid receivables
$unpaidReceivables = $client->receivables()
->whereIn('status', ['unpaid', 'partial'])
->get();
// Calculate total debt
$totalDebt = $unpaidReceivables->sum('current_balance');
// Get overdue invoices
$overdueInvoices = $client->receivables()
->where('status', 'unpaid')
->where('due_date', '<', now())
->get();
Client Payment History
// Get all payments
$payments = $client->payments()
->with('receivable')
->orderBy('payment_date', 'desc')
->get();
// Calculate total payments this year
$yearlyPayments = $client->payments()
->whereYear('payment_date', now()->year)
->sum('amount');
Custom Accounting Integration
// Check if client uses custom account
if ($client->hasCustomAccount()) {
$account = $client->accountingAccount;
echo "Account: {$account->code} - {$account->name}";
} else {
echo "Uses general accounts receivable account";
}
Filtering Clients
// Get clients by type
$companies = Client::where('type', 'company')->get();
$individuals = Client::where('type', 'individual')->get();
// Get clients with outstanding balance
$clientsWithDebt = Client::where('balance', '>', 0)
->orderBy('balance', 'desc')
->get();
// Get clients by credit limit
$premiumClients = Client::where('credit_limit', '>=', 100000)
->get();
Client Risk Analysis
// Calculate credit utilization
$utilizationRate = ($client->balance / $client->credit_limit) * 100;
if ($utilizationRate > 80) {
// High risk - approaching credit limit
} elseif ($utilizationRate > 50) {
// Medium risk
} else {
// Low risk
}
// Days since last payment
$lastPayment = $client->payments()->latest('payment_date')->first();
if ($lastPayment) {
$daysSincePayment = now()->diffInDays($lastPayment->payment_date);
}
Related Models
