#Orders

#Overview

Orders represent confirmed sales. An order can be created from a Quote or independently, and contains line items referencing Products. Orders can generate Invoices and Deliveries, and the model tracks fulfillment completion for both.

Model: VentureDrake\LaravelCrm\Models\Order Table: {prefix}orders (default: crm_orders)

#Attributes

Note: All money fields are stored in cents. Mutators automatically multiply by 100 on set.

#Computed Attributes

#title

Returns a formatted title with the monetary total and client/organisation name.

$order->title; // "$1,500.00 - Acme Corp"

#Relationships

#Helper Methods

#invoiceComplete()

Returns true if all order products have been fully invoiced.

if ($order->invoiceComplete()) {
    // All items have been invoiced
}

#deliveryComplete()

Returns true if all order products have been fully delivered.

if ($order->deliveryComplete()) {
    // All items have been shipped
}

#getBillingAddress()

Returns the billing address (address type 5).

#getShippingAddress()

Returns the shipping address (address type 6).

#Creating an Order

use VentureDrake\LaravelCrm\Models\Order;

$order = Order::create([
    'currency' => 'USD',
    'subtotal' => 10000,
    'tax' => 1000,
    'total' => 11000,
    'person_id' => $person->id,
    'organisation_id' => $organisation->id,
    'quote_id' => $quote->id,
    'user_owner_id' => auth()->id(),
]);

#Searching & Filtering

Searchable by reference, order_id, and associated person/organisation names. Filterable by user_owner_id and labels.id.

#Traits