recurring invoices

app/DataMapper/ClientSettings.php

@@ -60,9 +60,6 @@ class ClientSettings extends BaseSettings
 	public $quote_number_pattern;
 	public $quote_number_counter;
 	
-	//public $client_number_prefix;
-	//public $client_number_pattern;
-	
 	public $credit_number_prefix;
 	public $credit_number_pattern;
 	public $credit_number_counter;

app/Factory/RecurringInvoiceFactory.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace App\Factory;
+
+use App\DataMapper\ClientSettings;
+use App\DataMapper\CompanySettings;
+use App\Models\RecurringInvoice;
+
+class RecurringInvoiceFactory
+{
+	public static function create(int $company_id, int $user_id) :RecurringInvoice
+	{
+		$invoice = new RecurringInvoice();
+		$invoice->status_id = RecurringInvoice::STATUS_PENDING;
+		$invoice->discount = 0;
+		$invoice->is_amount_discount = true;
+		$invoice->po_number = '';
+		$invoice->footer = '';
+		$invoice->terms = '';
+		$invoice->public_notes = '';
+		$invoice->private_notes = '';
+		$invoice->invoice_date = null;
+		$invoice->due_date = null;
+		$invoice->partial_due_date = null;
+		$invoice->is_deleted = false;
+		$invoice->line_items = json_encode([]);
+		$invoice->settings = ClientSettings::buildClientSettings(new CompanySettings(CompanySettings::defaults()), new ClientSettings(ClientSettings::defaults())); //todo need to embed the settings here
+		$invoice->backup = json_encode([]);
+		$invoice->tax_name1 = '';
+		$invoice->tax_rate1 = 0;
+		$invoice->tax_name2 = '';
+		$invoice->tax_rate2 = 0;
+		$invoice->custom_value1 = 0;
+		$invoice->custom_value2 = 0;
+		$invoice->custom_value3 = 0;
+		$invoice->custom_value4 = 0;
+		$invoice->amount = 0;
+		$invoice->balance = 0;
+		$invoice->partial = 0;
+		$invoice->user_id = $user_id;
+		$invoice->company_id = $company_id;
+		$invoice->frequency_id = RecurringInvoice::FREQUENCY_MONTHLY;
+		$invoice->start_date = null;
+		$invoice->last_sent_date = null;
+		$invoice->next_send_date = null;
+		$invoice->remaining_cycles = 0;
+
+		return $invoice;
+	}
+
+}

app/Http/Controllers/RecurringInvoiceController.php

@@ -2,83 +2,235 @@
 
 namespace App\Http\Controllers;
 
+use App\Factory\CloneRecurringInvoiceFactory;
+use App\Factory\CloneRecurringInvoiceToQuoteFactory;
+use App\Factory\RecurringInvoiceFactory;
+use App\Filters\RecurringInvoiceFilters;
+use App\Http\Requests\RecurringInvoice\ActionRecurringInvoiceRequest;
+use App\Http\Requests\RecurringInvoice\CreateRecurringInvoiceRequest;
+use App\Http\Requests\RecurringInvoice\DestroyRecurringInvoiceRequest;
+use App\Http\Requests\RecurringInvoice\EditRecurringInvoiceRequest;
+use App\Http\Requests\RecurringInvoice\ShowRecurringInvoiceRequest;
+use App\Http\Requests\RecurringInvoice\StoreRecurringInvoiceRequest;
+use App\Http\Requests\RecurringInvoice\UpdateRecurringInvoiceRequest;
+use App\Jobs\Entity\ActionEntity;
+use App\Models\RecurringInvoice;
+use App\Repositories\BaseRepository;
+use App\Repositories\RecurringInvoiceRepository;
+use App\Transformers\RecurringInvoiceTransformer;
+use App\Utils\Traits\MakesHash;
 use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Log;
 
-class RecurringInvoiceController extends Controller
-{
 /**
-     * Display a listing of the resource.
+ * Class RecurringInvoiceController
+ * @package App\Http\Controllers\RecurringInvoiceController
+ */
+
+class RecurringInvoiceController extends BaseController
+{
+
+    use MakesHash;
+
+    protected $entity_type = RecurringInvoice::class;
+
+    protected $entity_transformer = RecurringInvoiceTransformer::class;
+
+    /**
+     * @var RecurringInvoiceRepository
+     */
+    protected $recurring_invoice_repo;
+
+    protected $base_repo;
+
+    /**
+     * RecurringInvoiceController constructor.
+     *
+     * @param      \App\Repositories\RecurringInvoiceRepository  $recurring_invoice_repo  The RecurringInvoice repo
+     */
+    public function __construct(RecurringInvoiceRepository $recurring_invoice_repo)
+    {
+
+        parent::__construct();
+
+        $this->recurring_invoice_repo = $recurring_invoice_repo;
+
+    }
+
+    /**
+     * Show the list of recurring_invoices
+     *
+     * @param      \App\Filters\RecurringInvoiceFilters  $filters  The filters
      *
      * @return \Illuminate\Http\Response
      */
-    public function index()
+    public function index(RecurringInvoiceFilters $filters)
     {
-        //
+        
+        $recurring_invoices = RecurringInvoice::filter($filters);
+      
+        return $this->listResponse($recurring_invoices);
+
     }
 
     /**
      * Show the form for creating a new resource.
      *
+     * @param      \App\Http\Requests\RecurringInvoice\CreateRecurringInvoiceRequest  $request  The request
+     *
      * @return \Illuminate\Http\Response
      */
-    public function create()
+    public function create(CreateRecurringInvoiceRequest $request)
     {
-        //
+
+        $recurring_invoice = RecurringInvoiceFactory::create(auth()->user()->company()->id, auth()->user()->id);
+
+        return $this->itemResponse($recurring_invoice);
+
     }
 
+
     /**
      * Store a newly created resource in storage.
      *
-     * @param  \Illuminate\Http\Request  $request
+     * @param      \App\Http\Requests\RecurringInvoice\StoreRecurringInvoiceRequest  $request  The request
+     *
      * @return \Illuminate\Http\Response
      */
-    public function store(Request $request)
+    public function store(StoreRecurringInvoiceRequest $request)
     {
-        //
+        
+        $recurring_invoice = $this->RecurringInvoice_repo->save($request, RecurringInvoiceFactory::create(auth()->user()->company()->id, auth()->user()->id));
+
+        return $this->itemResponse($recurring_invoice);
+
     }
 
     /**
      * Display the specified resource.
      *
-     * @param  int  $id
+     * @param      \App\Http\Requests\RecurringInvoice\ShowRecurringInvoiceRequest  $request  The request
+     * @param      \App\Models\RecurringInvoice                            $recurring_invoice  The RecurringInvoice
+     *
      * @return \Illuminate\Http\Response
      */
-    public function show($id)
+    public function show(ShowRecurringInvoiceRequest $request, RecurringInvoice $recurring_invoice)
     {
-        //
+
+        return $this->itemResponse($recurring_invoice);
+
     }
 
     /**
      * Show the form for editing the specified resource.
      *
-     * @param  int  $id
+     * @param      \App\Http\Requests\RecurringInvoice\EditRecurringInvoiceRequest  $request  The request
+     * @param      \App\Models\RecurringInvoice                            $recurring_invoice  The RecurringInvoice
+     *
      * @return \Illuminate\Http\Response
      */
-    public function edit($id)
+    public function edit(EditRecurringInvoiceRequest $request, RecurringInvoice $recurring_invoice)
     {
-        //
+
+        return $this->itemResponse($recurring_invoice);
+
     }
     
     /**
      * Update the specified resource in storage.
      *
-     * @param  \Illuminate\Http\Request  $request
+     * @param      \App\Http\Requests\RecurringInvoice\UpdateRecurringInvoiceRequest  $request  The request
-     * @param  int  $id
+     * @param      \App\Models\RecurringInvoice                              $recurring_invoice  The RecurringInvoice
+     *
      * @return \Illuminate\Http\Response
      */
-    public function update(Request $request, $id)
+    public function update(UpdateRecurringInvoiceRequest $request, RecurringInvoice $recurring_invoice)
     {
-        //
+
+        $recurring_invoice = $this->RecurringInvoice_repo->save(request(), $recurring_invoice);
+
+        return $this->itemResponse($recurring_invoice);
+
     }
 
     /**
      * Remove the specified resource from storage.
      *
-     * @param  int  $id
+     * @param      \App\Http\Requests\RecurringInvoice\DestroyRecurringInvoiceRequest  $request  
+     * @param      \App\Models\RecurringInvoice                               $recurring_invoice  
+     *
      * @return     \Illuminate\Http\Response
      */
-    public function destroy($id)
+    public function destroy(DestroyRecurringInvoiceRequest $request, RecurringInvoice $recurring_invoice)
     {
-        //
+
+        $recurring_invoice->delete();
+
+        return response()->json([], 200);
+
+    }
+
+    /**
+     * Perform bulk actions on the list view
+     * 
+     * @return Collection
+     */
+    public function bulk()
+    {
+
+        $action = request()->input('action');
+        
+        $ids = request()->input('ids');
+
+        $recurring_invoices = RecurringInvoice::withTrashed()->find($ids);
+
+        $recurring_invoices->each(function ($recurring_invoice, $key) use($action){
+
+            if(auth()->user()->can('edit', $recurring_invoice))
+                $this->RecurringInvoice_repo->{$action}($recurring_invoice);
+
+        });
+
+        //todo need to return the updated dataset
+        return $this->listResponse(RecurringInvoice::withTrashed()->whereIn('id', $ids));
+        
+    }
+
+    public function action(ActionRecurringInvoiceRequest $request, RecurringInvoice $recurring_invoice, $action)
+    {
+        
+        switch ($action) {
+            case 'clone_to_RecurringInvoice':
+          //      $recurring_invoice = CloneRecurringInvoiceFactory::create($recurring_invoice, auth()->user()->id);
+          //      return $this->itemResponse($recurring_invoice);
+                break;
+            case 'clone_to_quote':
+            //    $quote = CloneRecurringInvoiceToQuoteFactory::create($recurring_invoice, auth()->user()->id);
+                // todo build the quote transformer and return response here 
+                break;
+            case 'history':
+                # code...
+                break;
+            case 'delivery_note':
+                # code...
+                break;
+            case 'mark_paid':
+                # code...
+                break;
+            case 'archive':
+                # code...
+                break;
+            case 'delete':
+                # code...
+                break;
+            case 'email':
+                //dispatch email to queue
+                break;
+
+            default:
+                # code...
+                break;
         }
     }
+    
+}

app/Http/Requests/RecurringInvoice/ActionRecurringInvoiceRequest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Http\Requests\RecurringInvoice;
+
+use App\Http\Requests\Request;
+use App\Models\RecurringInvoice;
+
+class ActionRecurringInvoiceRequest extends Request
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+
+    public function authorize() : bool
+    {
+        return auth()->user()->can('edit', $this->recurring_invoice);
+    }
+
+}

app/Http/Requests/RecurringInvoice/CreateRecurringInvoiceRequest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Http\Requests\RecurringInvoice;
+
+use App\Http\Requests\Request;
+use App\Models\RecurringInvoice;
+
+class CreateRecurringInvoiceRequest extends Request
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+
+    public function authorize() : bool
+    {
+        return auth()->user()->can('create', RecurringInvoice::class);
+    }
+
+}

app/Http/Requests/RecurringInvoice/DestroyRecurringInvoiceRequest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Http\Requests\RecurringInvoice;
+
+use App\Http\Requests\Request;
+use App\Models\RecurringInvoice;
+
+class DestroyRecurringInvoiceRequest extends Request
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+
+    public function authorize() : bool
+    {
+        return auth()->user()->can('edit', $this->recurring_invoice);
+    }
+
+}

app/Http/Requests/RecurringInvoice/EditRecurringInvoiceRequest.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace App\Http\Requests\RecurringInvoice;
+
+use App\Http\Requests\Request;
+use App\Models\RecurringInvoice;
+
+class EditRecurringInvoiceRequest extends Request
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+
+    public function authorize()
+    {
+        return auth()->user()->can('edit', $this->recurring_invoice);
+    }
+
+    public function rules()
+    {
+        $rules = [];
+        
+        return $rules;
+    }
+
+
+    public function sanitize()
+    {
+        $input = $this->all();
+
+        //$input['id'] = $this->encodePrimaryKey($input['id']);
+
+        //$this->replace($input);
+
+        return $this->all();
+    }
+
+}

app/Http/Requests/RecurringInvoice/ShowRecurringInvoiceRequest.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace App\Http\Requests\RecurringInvoice;
+
+use App\Http\Requests\Request;
+use App\Models\RecurringInvoice;
+
+class ShowRecurringInvoiceRequest extends Request
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+
+    public function authorize() : bool
+    {
+        return auth()->user()->can('view', $this->recurring_invoice);
+    }
+
+}

app/Http/Requests/RecurringInvoice/StoreRecurringInvoiceRequest.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace App\Http\Requests\RecurringInvoice;
+
+use App\Http\Requests\Request;
+use App\Models\RecurringInvoice;
+
+class StoreRecurringInvoiceRequest extends Request
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+
+    public function authorize() : bool
+    {
+        return auth()->user()->can('create', RecurringInvoice::class);
+    }
+
+    public function rules()
+    {
+        return [
+            'documents' => 'mimes:png,ai,svg,jpeg,tiff,pdf,gif,psd,txt,doc,xls,ppt,xlsx,docx,pptx',
+        ];
+    }
+
+
+    public function sanitize()
+    {
+        //do post processing of RecurringInvoice request here, ie. RecurringInvoice_items
+    }
+
+    public function messages()
+    {
+
+    }
+
+
+}
+

app/Http/Requests/RecurringInvoice/UpdateRecurringInvoiceRequest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace App\Http\Requests\RecurringInvoice;
+
+use App\Http\Requests\Request;
+use Illuminate\Support\Facades\Log;
+use Illuminate\Validation\Rule;
+
+class UpdateRecurringInvoiceRequest extends Request
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+
+    public function authorize() : bool
+    {
+
+        return auth()->user()->can('edit', $this->recurring_invoice);
+
+    }
+
+
+    public function rules()
+    {
+        return [
+            'documents' => 'mimes:png,ai,svg,jpeg,tiff,pdf,gif,psd,txt,doc,xls,ppt,xlsx,docx,pptx',
+        ];
+    }
+    
+}

app/Models/RecurringInvoice.php

@@ -7,12 +7,39 @@ use App\Utils\Traits\MakesHash;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\SoftDeletes;
 
+/**
+ * Class for Recurring Invoices.
+ */
 class RecurringInvoice extends BaseModel
 {
     use MakesHash;
     use SoftDeletes;
     use Filterable;
 
+    /**
+     * Invoice Statuses
+     */
+    const STATUS_PENDING = 1;
+    const STATUS_ACTIVE = 2;
+    const STATUS_COMPLETED = 3;
+    const STATUS_CANCELLED = 4;
+
+    /**
+     * Recurring intervals
+     */
+    const FREQUENCY_WEEKLY = 1;
+    const FREQUENCY_TWO_WEEKS = 2;
+    const FREQUENCY_FOUR_WEEKS = 3;
+    const FREQUENCY_MONTHLY = 4;
+    const FREQUENCY_TWO_MONTHS = 5;
+    const FREQUENCY_THREE_MONTHS = 6;
+    const FREQUENCY_FOUR_MONTHS = 7;
+    const FREQUENCY_SIX_MONTHS = 8;
+    const FREQUENCY_ANNUALLY = 9;
+    const FREQUENCY_TWO_YEARS = 10;
+
+    const RECURS_INDEFINITELY = 1;
+    
 	protected $guarded = [
 		'id',
 	];
@@ -21,11 +48,21 @@ class RecurringInvoice extends BaseModel
         'settings' => 'object'
     ];
 
+    protected $with = [
+        'client',
+        'company',
+    ];
+
     public function company()
     {
         return $this->belongsTo(Company::class);
     }
 
+    public function client()
+    {
+        return $this->belongsTo(Client::class);
+    }
+
     public function user()
     {
         return $this->belongsTo(User::class);

app/Policies/RecurringInvoicePolicy.php

@@ -0,0 +1,25 @@
+<?php
+
+namespace App\Policies;
+
+use App\Models\RecurringInvoice;
+use App\Models\User;
+
+/**
+ * Class RecurringInvoiceolicy
+ * @package App\Policies
+ */
+class RecurringInvoicePolicy extends EntityPolicy
+{
+	/**
+	 *  Checks if the user has create permissions
+	 *  
+	 * @param  User $user
+	 * @return bool
+	 */
+	public function create(User $user) : bool
+	{
+		return $user->isAdmin() || $user->hasPermission('create_recurring_invoice');
+	}
+
+}

app/Providers/AuthServiceProvider.php

@@ -6,11 +6,13 @@ use App\Models\Client;
 use App\Models\Invoice;
 use App\Models\Product;
 use App\Models\Quote;
+use App\Models\RecurringInvoice;
 use App\Models\User;
 use App\Policies\ClientPolicy;
 use App\Policies\InvoicePolicy;
 use App\Policies\ProductPolicy;
 use App\Policies\QuotePolicy;
+use App\Policies\RecurringInvoicePolicy;
 use Auth;
 use Illuminate\Foundation\Support\Providers\AuthServiceProvider as ServiceProvider;
 use Illuminate\Support\Facades\Gate;
@@ -26,6 +28,7 @@ class AuthServiceProvider extends ServiceProvider
         Client::class => ClientPolicy::class,
         Product::class => ProductPolicy::class,
         Invoice::class => InvoicePolicy::class,
+        RecurringInvoice::class => RecurringInvoicePolicy::class,
         Quote::class => QuotePolicy::class,
         User::class => UserPolicy::class,
     ];

app/Repositories/RecurringInvoiceRepository.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace App\Repositories;
+
+use App\Helpers\Invoice\InvoiceCalc;
+use App\Models\RecurringInvoice;
+use Illuminate\Http\Request;
+
+/**
+ * RecurringInvoiceRepository
+ */
+class RecurringInvoiceRepository extends BaseRepository
+{
+
+
+    public function getClassName()
+    {
+        return RecurringInvoice::class;
+    }
+    
+	public function save(Request $request, RecurringInvoice $invoice) : ?RecurringInvoice
+	{
+        $invoice->fill($request->input());
+        
+        $invoice->save();
+
+
+        $invoice_calc = new InvoiceCalc($invoice, $invoice->settings);
+
+        $invoice = $invoice_calc->build()->getInvoice();
+
+        //fire events here that cascading from the saving of an invoice
+        //ie. client balance update...
+        
+        return $invoice;
+	}
+
+}

app/Transformers/RecurringInvoiceTransformer.php

@@ -0,0 +1,161 @@
+<?php
+
+namespace App\Transformers;
+
+use App\Models\Invoice;
+use App\Utils\Traits\MakesHash;
+
+/**
+ * @SWG\Definition(definition="Invoice", required={"invoice_number"}, @SWG\Xml(name="Invoice"))
+ */
+class RecurringInvoiceTransformer extends EntityTransformer
+{
+    use MakesHash;
+    /**
+    * @SWG\Property(property="id", type="integer", example=1, readOnly=true)
+    * @SWG\Property(property="amount", type="number", format="float", example=10, readOnly=true)
+    * @SWG\Property(property="balance", type="number", format="float", example=10, readOnly=true)
+    * @SWG\Property(property="updated_at", type="integer", example=1451160233, readOnly=true)
+    * @SWG\Property(property="archived_at", type="integer", example=1451160233, readOnly=true)
+    * @SWG\Property(property="is_deleted", type="boolean", example=false, readOnly=true)
+    * @SWG\Property(property="client_id", type="integer", example=1)
+    * @SWG\Property(property="status_id", type="integer", example=1, readOnly=true)
+    * @SWG\Property(property="invoice_number", type="string", example="0001")
+    * @SWG\Property(property="discount", type="number", format="float", example=10)
+    * @SWG\Property(property="po_number", type="string", example="0001")
+    * @SWG\Property(property="invoice_date", type="string", format="date", example="2018-01-01")
+    * @SWG\Property(property="due_date", type="string", format="date", example="2018-01-01")
+    * @SWG\Property(property="terms", type="string", example="sample")
+    * @SWG\Property(property="private_notes", type="string", example="Notes")
+    * @SWG\Property(property="public_notes", type="string", example="Notes")
+    * @SWG\Property(property="invoice_type_id", type="integer", example=1, readOnly=true)
+    * @SWG\Property(property="is_recurring", type="boolean", example=false)
+    * @SWG\Property(property="frequency_id", type="integer", example=1)
+    * @SWG\Property(property="start_date", type="string", format="date", example="2018-01-01")
+    * @SWG\Property(property="end_date", type="string", format="date", example="2018-01-01")
+    * @SWG\Property(property="last_sent_date", type="string", format="date", example="2018-01-01", readOnly=true)
+    * @SWG\Property(property="recurring_invoice_id", type="integer", example=1, readOnly=true)
+    * @SWG\Property(property="tax_name1", type="string", example="VAT")
+    * @SWG\Property(property="tax_name2", type="string", example="Upkeep")
+    * @SWG\Property(property="tax_rate1", type="number", format="float", example="17.5")
+    * @SWG\Property(property="tax_rate2", type="number", format="float", example="30.0")
+    * @SWG\Property(property="is_amount_discount", type="boolean", example=false)
+    * @SWG\Property(property="invoice_footer", type="string", example="Footer")
+    * @SWG\Property(property="partial", type="number",format="float", example=10)
+    * @SWG\Property(property="partial_due_date", type="string", format="date", example="2018-01-01")
+    * @SWG\Property(property="has_tasks", type="boolean", example=false, readOnly=true)
+    * @SWG\Property(property="auto_bill", type="boolean", example=false)
+    * @SWG\Property(property="custom_value1", type="number",format="float", example=10)
+    * @SWG\Property(property="custom_value2", type="number",format="float", example=10)
+    * @SWG\Property(property="custom_taxes1", type="boolean", example=false)
+    * @SWG\Property(property="custom_taxes2", type="boolean", example=false)
+    * @SWG\Property(property="has_expenses", type="boolean", example=false, readOnly=true)
+    * @SWG\Property(property="quote_invoice_id", type="integer", example=1, readOnly=true)
+    * @SWG\Property(property="custom_text_value1", type="string", example="Custom Text Value")
+    * @SWG\Property(property="custom_text_value2", type="string", example="Custom Text Value")
+    * @SWG\Property(property="is_quote", type="boolean", example=false, readOnly=true)
+    * @SWG\Property(property="is_public", type="boolean", example=false)
+    * @SWG\Property(property="filename", type="string", example="Filename", readOnly=true)
+    */
+    protected $defaultIncludes = [
+    //    'invoice_items',
+    ];
+
+    protected $availableIncludes = [
+    //    'invitations',
+    //    'payments',
+    //    'client',
+    //    'documents',
+    ];
+
+/*
+    public function includeInvoiceItems(Invoice $invoice)
+    {
+        $transformer = new InvoiceItemTransformer($this->serializer);
+
+        return $this->includeCollection($invoice->invoice_items, $transformer, ENTITY_INVOICE_ITEM);
+    }
+
+    public function includeInvitations(Invoice $invoice)
+    {
+        $transformer = new InvitationTransformer($this->account, $this->serializer);
+
+        return $this->includeCollection($invoice->invitations, $transformer, ENTITY_INVITATION);
+    }
+
+    public function includePayments(Invoice $invoice)
+    {
+        $transformer = new PaymentTransformer($this->account, $this->serializer, $invoice);
+
+        return $this->includeCollection($invoice->payments, $transformer, ENTITY_PAYMENT);
+    }
+
+    public function includeClient(Invoice $invoice)
+    {
+        $transformer = new ClientTransformer($this->account, $this->serializer);
+
+        return $this->includeItem($invoice->client, $transformer, ENTITY_CLIENT);
+    }
+
+    public function includeExpenses(Invoice $invoice)
+    {
+        $transformer = new ExpenseTransformer($this->account, $this->serializer);
+
+        return $this->includeCollection($invoice->expenses, $transformer, ENTITY_EXPENSE);
+    }
+
+    public function includeDocuments(Invoice $invoice)
+    {
+        $transformer = new DocumentTransformer($this->account, $this->serializer);
+
+        $invoice->documents->each(function ($document) use ($invoice) {
+            $document->setRelation('invoice', $invoice);
+        });
+
+        return $this->includeCollection($invoice->documents, $transformer, ENTITY_DOCUMENT);
+    }
+*/
+    public function transform(RecurringInvoice $invoice)
+    {
+        return [
+            'id' => $this->encodePrimaryKey($invoice->id),
+            'amount' => (float) $invoice->amount,
+            'balance' => (float) $invoice->balance,
+            'client_id' => (int) $invoice->client_id,
+            'status_id' => (int) ($invoice->status_id ?: 1),
+            'updated_at' => $invoice->updated_at,
+            'archived_at' => $invoice->deleted_at,
+            'discount' => (float) $invoice->discount,
+            'po_number' => $invoice->po_number,
+            'invoice_date' => $invoice->invoice_date ?: '',
+            'due_date' => $invoice->due_date ?: '',
+            'terms' => $invoice->terms ?: '',
+            'public_notes' => $invoice->public_notes ?: '',
+            'private_notes' => $invoice->private_notes ?: '',
+            'is_deleted' => (bool) $invoice->is_deleted,
+            'tax_name1' => $invoice->tax_name1 ? $invoice->tax_name1 : '',
+            'tax_rate1' => (float) $invoice->tax_rate1,
+            'tax_name2' => $invoice->tax_name2 ? $invoice->tax_name2 : '',
+            'tax_rate2' => (float) $invoice->tax_rate2,
+            'is_amount_discount' => (bool) ($invoice->is_amount_discount ?: false),
+            'invoice_footer' => $invoice->invoice_footer ?: '',
+            'partial' => (float) ($invoice->partial ?: 0.0),
+            'partial_due_date' => $invoice->partial_due_date ?: '',
+            'custom_value1' => (float) $invoice->custom_value1,
+            'custom_value2' => (float) $invoice->custom_value2,
+            'custom_taxes1' => (bool) $invoice->custom_taxes1,
+            'custom_taxes2' => (bool) $invoice->custom_taxes2,
+            'has_tasks' => (bool) $invoice->has_tasks,
+            'has_expenses' => (bool) $invoice->has_expenses,
+            'custom_text_value1' => $invoice->custom_text_value1 ?: '',
+            'custom_text_value2' => $invoice->custom_text_value2 ?: '',
+            'backup' => $invoice->backup ?: '',
+            'settings' => $invoice->settings,
+            'frequency_id' => (int) $invoice->frequency_id,
+            'start_date' => $invoice->start_date,
+            'last_sent_date' => $invoice->last_sent_date,
+            'next_send_date' => $invoice->next_send_date,
+            'remaining_cycles' => (int) $invoice->remaining_cycles,
+        ];
+    }
+}

database/factories/RecurringInvoiceFactory.php

@@ -0,0 +1,32 @@
+<?php
+
+use App\DataMapper\ClientSettings;
+use App\DataMapper\CompanySettings;
+use Faker\Generator as Faker;
+
+$factory->define(App\Models\RecurringInvoice::class, function (Faker $faker) {
+    return [
+		'status_id' => App\Models\RecurringInvoice::STATUS_PENDING,
+		'discount' => $faker->numberBetween(1,10),
+		'is_amount_discount' => $faker->boolean(),
+		'tax_name1' => 'GST',
+		'tax_rate1' => 10,
+		'tax_name2' => 'VAT',
+		'tax_rate2' => 17.5,
+		'custom_value1' => $faker->numberBetween(1,4),
+		'custom_value2' => $faker->numberBetween(1,4),
+		'custom_value3' => $faker->numberBetween(1,4),
+		'custom_value4' => $faker->numberBetween(1,4),
+		'is_deleted' => false,
+		'po_number' => $faker->text(10),
+		'invoice_date' => $faker->date(),
+		'due_date' => $faker->date(),
+		'line_items' => false,
+		'backup' => '', 
+		'frequency_id' => App\Models\RecurringInvoice::FREQUENCY_MONTHLY,
+		'start_date' => $faker->date(),
+		'last_sent_date' => $faker->date(),
+		'next_send_date' => $faker->date(),
+		'remaining_cycles' => $faker->numberBetween(1,10),
+    ];
+});

database/migrations/2014_10_13_000000_create_users_table.php

@@ -418,7 +418,8 @@ class CreateUsersTable extends Migration
             $t->unsignedInteger('user_id');
             $t->unsignedInteger('company_id')->index();
 
-            $t->string('invoice_number');
+            $t->unsignedInteger('status_id')->index();
+
             $t->float('discount');
             $t->boolean('is_amount_discount');
 
@@ -469,7 +470,6 @@ class CreateUsersTable extends Migration
             $t->timestamps();
             $t->softDeletes();
 
-            $t->unique(['company_id', 'invoice_number']);
         });
 
         Schema::create('quotes', function ($t) {

tests/Feature/RecurringInvoiceTest.php

@@ -0,0 +1,203 @@
+<?php
+
+namespace Tests\Feature;
+
+use App\DataMapper\ClientSettings;
+use App\DataMapper\CompanySettings;
+use App\Models\Account;
+use App\Models\Client;
+use App\Models\RecurringInvoice;
+use App\Utils\Traits\MakesHash;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Foundation\Testing\DatabaseTransactions;
+use Illuminate\Foundation\Testing\RefreshDatabase;
+use Illuminate\Foundation\Testing\WithFaker;
+use Illuminate\Support\Facades\Log;
+use Illuminate\Support\Facades\Session;
+use Tests\TestCase;
+
+/**
+ * @test
+ * @covers App\Http\Controllers\RecurringInvoiceController
+ */
+    
+class RecurringInvoiceTest extends TestCase
+{
+
+    use MakesHash;
+    use DatabaseTransactions;
+
+    public function setUp() :void
+    {
+
+        parent::setUp();
+
+        Session::start();
+
+        $this->faker = \Faker\Factory::create();
+
+        Model::reguard();
+
+
+    }
+
+    public function testRecurringInvoiceList()
+    {
+        $data = [
+            'first_name' => $this->faker->firstName,
+            'last_name' => $this->faker->lastName,
+            'email' => $this->faker->unique()->safeEmail,
+            'password' => 'ALongAndBrilliantPassword123',
+            '_token' => csrf_token(),
+            'privacy_policy' => 1,
+            'terms_of_service' => 1
+        ];
+
+
+        $response = $this->withHeaders([
+                'X-API-SECRET' => config('ninja.api_secret'),
+            ])->post('/api/v1/signup', $data);
+
+        $acc = $response->json();
+
+        $account = Account::find($this->decodePrimaryKey($acc['data']['id']));        
+
+        $company_token = $account->default_company->tokens()->first();
+        $token = $company_token->token;
+        $company = $company_token->company;
+
+        $user = $company_token->user;
+
+        $this->assertNotNull($company_token);
+        $this->assertNotNull($token);
+        $this->assertNotNull($user);
+        $this->assertNotNull($company);
+        $this->assertNotNull($user->tokens->first()->company);
+
+        factory(\App\Models\Client::class, 1)->create(['user_id' => $user->id, 'company_id' => $company->id])->each(function ($c) use ($user, $company){
+
+            factory(\App\Models\ClientContact::class,1)->create([
+                'user_id' => $user->id,
+                'client_id' => $c->id,
+                'company_id' => $company->id,
+                'is_primary' => 1
+            ]);
+
+            factory(\App\Models\ClientContact::class,1)->create([
+                'user_id' => $user->id,
+                'client_id' => $c->id,
+                'company_id' => $company->id
+            ]);
+
+        });
+        $client = Client::all()->first();
+
+        factory(\App\Models\RecurringInvoice::class, 1)->create(['user_id' => $user->id, 'company_id' => $company->id, 'client_id' => $client->id]);
+
+
+        $response = $this->withHeaders([
+                'X-API-SECRET' => config('ninja.api_secret'),
+                'X-API-TOKEN' => $token,
+            ])->get('/api/v1/recurring_invoices');
+
+        $response->assertStatus(200);
+
+    }
+
+    public function testRecurringInvoiceRESTEndPoints()
+    {
+        $data = [
+            'first_name' => $this->faker->firstName,
+            'last_name' => $this->faker->lastName,
+            'email' => $this->faker->unique()->safeEmail,
+            'password' => 'ALongAndBrilliantPassword123',
+            '_token' => csrf_token(),
+            'privacy_policy' => 1,
+            'terms_of_service' => 1
+        ];
+
+
+        $response = $this->withHeaders([
+                'X-API-SECRET' => config('ninja.api_secret'),
+            ])->post('/api/v1/signup', $data);
+
+        $acc = $response->json();
+
+        $account = Account::find($this->decodePrimaryKey($acc['data']['id']));        
+
+        $company_token = $account->default_company->tokens()->first();
+        $token = $company_token->token;
+        $company = $company_token->company;
+
+        $user = $company_token->user;
+
+        $this->assertNotNull($company_token);
+        $this->assertNotNull($token);
+        $this->assertNotNull($user);
+        $this->assertNotNull($company);
+        $this->assertNotNull($user->tokens->first()->company);
+
+        factory(\App\Models\Client::class, 1)->create(['user_id' => $user->id, 'company_id' => $company->id])->each(function ($c) use ($user, $company){
+
+            factory(\App\Models\ClientContact::class,1)->create([
+                'user_id' => $user->id,
+                'client_id' => $c->id,
+                'company_id' => $company->id,
+                'is_primary' => 1
+            ]);
+
+            factory(\App\Models\ClientContact::class,1)->create([
+                'user_id' => $user->id,
+                'client_id' => $c->id,
+                'company_id' => $company->id
+            ]);
+
+        });
+        $client = Client::all()->first();
+
+        factory(\App\Models\RecurringInvoice::class, 1)->create(['user_id' => $user->id, 'company_id' => $company->id, 'client_id' => $client->id]);
+
+        $RecurringInvoice = RecurringInvoice::where('user_id',$user->id)->first();
+        $RecurringInvoice->settings = $client->getMergedSettings();
+        $RecurringInvoice->save();
+
+        
+        $response = $this->withHeaders([
+                'X-API-SECRET' => config('ninja.api_secret'),
+                'X-API-TOKEN' => $token,
+            ])->get('/api/v1/recurring_invoices/'.$this->encodePrimaryKey($RecurringInvoice->id));
+
+        $response->assertStatus(200);
+
+        $response = $this->withHeaders([
+                'X-API-SECRET' => config('ninja.api_secret'),
+                'X-API-TOKEN' => $token,
+            ])->get('/api/v1/recurring_invoices/'.$this->encodePrimaryKey($RecurringInvoice->id).'/edit');
+
+        $response->assertStatus(200);
+
+        $RecurringInvoice_update = [
+            'status_id' => RecurringInvoice::STATUS_PAID
+        ];
+
+        $this->assertNotNull($RecurringInvoice);
+        $this->assertNotNull($RecurringInvoice->settings);
+
+        $this->assertTrue(property_exists($RecurringInvoice->settings, 'custom_taxes1'));
+
+        $response = $this->withHeaders([
+                'X-API-SECRET' => config('ninja.api_secret'),
+                'X-API-TOKEN' => $token,
+            ])->put('/api/v1/recurring_invoices/'.$this->encodePrimaryKey($RecurringInvoice->id), $RecurringInvoice_update)
+            ->assertStatus(200);
+
+        $response = $this->withHeaders([
+                'X-API-SECRET' => config('ninja.api_secret'),
+                'X-API-TOKEN' => $token,
+            ])->delete('/api/v1/recurring_invoices/'.$this->encodePrimaryKey($RecurringInvoice->id));
+
+        $response->assertStatus(200);
+
+    }
+
+}