#Leads

#Overview

Leads represent potential business opportunities that have not yet been qualified. A lead is typically the first point of contact in the sales pipeline, and can be associated with a Person, Organisation, or both. Once qualified, a lead can be converted into a Deal.

Model: VentureDrake\LaravelCrm\Models\Lead Table: {prefix}leads (default: crm_leads)

#Attributes

Note: The amount attribute is stored in cents. When setting the value, the mutator automatically multiplies by 100. For example, setting $lead->amount = 150 stores 15000 in the database.

#Relationships

#Helper Methods

#getPrimaryEmail()

Returns the primary email for the lead. If the lead has an associated person, it returns the person's primary email instead.

$email = $lead->getPrimaryEmail();

#getPrimaryPhone()

Returns the primary phone number. Falls back to the associated person's primary phone.

$phone = $lead->getPrimaryPhone();

#getPrimaryAddress()

Returns the primary address. Falls back to the associated organisation's primary address.

$address = $lead->getPrimaryAddress();

#Creating a Lead

use VentureDrake\LaravelCrm\Models\Lead;

$lead = Lead::create([
    'title' => 'New website project',
    'amount' => 5000, // Stored as 500000 (cents)
    'currency' => 'USD',
    'description' => 'Potential website redesign project',
    'person_id' => $person->id,
    'organisation_id' => $organisation->id,
    'lead_source_id' => $source->id,
    'user_owner_id' => auth()->id(),
]);

#Searching & Filtering

Leads are searchable by lead_id, title, and associated person/organisation names. They can be filtered by user_owner_id and labels.id.

#Views

Leads support both list view (paginated table) and board view (Kanban-style pipeline stages). Toggle between views using the view switcher.

#Traits