Merge pull request #7 from picqer/salesInvoicePayment-entity

Created Sales Invoice Payments entity

Author: stephangroen

README.md

@@ -115,6 +115,14 @@ var_dump($salesInvoices); // Array with filtered SalesInvoice objects
 // Example: Get import mappings for contacts
 $mappings = $moneybird->importMapping()->setType('contact')->get();
 var_dump($mappings); // Array with ImportMapping objects
+
+// Example: Register a payment for a sales invoice
+$salesInvoicePayment = $moneybird->salesInvoicePayment();
+$salesInvoicePayment->price = 153.75;
+$salesInvoicePayment->payment_date = '2015-12-03';
+
+$salesInvoice = $moneybird->salesInvoice()->find(3498576378625);
+$salesInvoice->registerPayment($salesInvoicePayment);
 ```
 
 ## Code example

src/Picqer/Financials/Moneybird/Entities/SalesInvoice.php

@@ -79,6 +79,10 @@ class SalesInvoice extends Model {
             'entity' => 'SalesInvoiceDetail',
             'type' => self::NESTING_TYPE_ARRAY_OF_OBJECTS,
         ],
+        'payments' => [
+            'entity' => 'SalesInvoicePayment',
+            'type' => self::NESTING_TYPE_ARRAY_OF_OBJECTS,
+        ],
     ];
 
     /**
@@ -112,25 +116,25 @@ public function findByInvoiceId($invoiceId)
 
         return $this->makeFromResponse($result);
     }
-    
+
     /**
      * Register a payment for the current invoice
      *
-     * @param array $data required keys are payment_date and price
+     * @param SalesInvoicePayment $salesInvoicePayment (payment_date and price are required)
      * @throws ApiException
      */
-    public function registerPayment(array $data)
+    public function registerPayment(SalesInvoicePayment $salesInvoicePayment)
     {
-        if  (! isset($data['payment_date'])) {
+        if  (! isset($salesInvoicePayment->payment_date)) {
             throw new ApiException('Required [payment_date] is missing');
         }
 
-        if  (! isset($data['price'])) {
+        if  (! isset($salesInvoicePayment->price)) {
             throw new ApiException('Required [price] is missing');
         }
 
-        $this->connection()->patch($this->url . '/' . $this->id . '/register_payment', json_encode([
-            'payment' => $data
-        ]));
+        $this->connection()->patch($this->url . '/' . $this->id . '/register_payment',
+            $salesInvoicePayment->jsonWithNamespace()
+        );
     }
 }

src/Picqer/Financials/Moneybird/Entities/SalesInvoicePayment.php

@@ -0,0 +1,35 @@
+<?php namespace Picqer\Financials\Moneybird\Entities;
+
+use Picqer\Financials\Moneybird\Model;
+
+/**
+ * Class SalesInvoicePayment
+ * @package Picqer\Financials\Moneybird\Entities
+ */
+class SalesInvoicePayment extends Model {
+
+    /**
+     * @var array
+     */
+    protected $fillable = [
+        'id',
+        'invoice_type',
+        'invoice_id',
+        'financial_account_id',
+        'user_id',
+        'payment_transaction_id',
+        'price',
+        'price_base',
+        'payment_date',
+        'credit_invoice_id',
+        'financial_mutation_id',
+        'created_at',
+        'updated_at',
+    ];
+
+    /**
+     * @var string
+     */
+    protected $namespace = 'payment';
+
+}

src/Picqer/Financials/Moneybird/Model.php

@@ -337,4 +337,15 @@ public function getUrl()
         return $this->url;
     }
 
+    /**
+     * Determine if an attribute exists on the model
+     *
+     * @param $name
+     * @return bool
+     */
+    public function __isset($name)
+    {
+        return (isset($this->attributes[$name]) && !is_null($this->attributes[$name]));
+    }
+
 }

src/Picqer/Financials/Moneybird/Moneybird.php

@@ -18,6 +18,7 @@
 use Picqer\Financials\Moneybird\Entities\RecurringSalesInvoice;
 use Picqer\Financials\Moneybird\Entities\SalesInvoice;
 use Picqer\Financials\Moneybird\Entities\SalesInvoiceDetail;
+use Picqer\Financials\Moneybird\Entities\SalesInvoicePayment;
 use Picqer\Financials\Moneybird\Entities\TaxRate;
 use Picqer\Financials\Moneybird\Entities\TypelessDocument;
 use Picqer\Financials\Moneybird\Entities\Webhook;
@@ -190,6 +191,14 @@ public function salesInvoiceDetail()
         return new SalesInvoiceDetail($this->connection);
     }
 
+    /**
+     * @return SalesInvoicePayment
+     */
+    public function salesInvoicePayment()
+    {
+        return new SalesInvoicePayment($this->connection);
+    }
+
     /**
      * @return TaxRate
      */

tests/EntityTest.php

@@ -104,6 +104,11 @@ public function testSalesInvoiceDetailEntity()
         $this->performEntityTest('\Picqer\Financials\Moneybird\Entities\SalesInvoiceDetail');
     }
 
+    public function testSalesInvoicePaymentEntity()
+    {
+        $this->performEntityTest('\Picqer\Financials\Moneybird\Entities\SalesInvoicePayment');
+    }
+
     public function testTaxRateEntity()
     {
         $this->performEntityTest('\Picqer\Financials\Moneybird\Entities\TaxRate');