invoiceninja/sdk-php

PHP SDK to create a custom module for Invoice Ninja

Invoice Ninja SDK

Installation

Add the Invoice Ninja SDK, _(*1)

composer require invoiceninja/sdk-php

Setup

    require __DIR__ . '/vendor/autoload.php';

    use InvoiceNinja\Config as NinjaConfig;
    use InvoiceNinja\Models\Client;

    NinjaConfig::setURL('https://ninja.dev/api/v1');
    NinjaConfig::setToken('Your Token');
    NinjaConfig::setPerPage(15);
    NinjaConfig::setPage(1);

• To connect to the hosted version use https://app.invoiceninja.com/api/v1 as the URL.
• You can either use the free hosted trial or install the app to create an API token.

Supports

• Clients
• Invoices/Quotes
• Products
• Payments
• Tasks
• Vendors
• Expenses
• TaxRates
• Credits

Retrieving Models

Pagination
To iterate through more than 1 page of results, increment NinjaConfig::setPage(1) value until an empty array of results is returned. Adjust the number of results per page using the NinjaConfig::setPerPage(15); value (maximum 5000)., _(*2)

Retrieve all clients, _(*3)

    $clients = Client::all();

Retrieve a client by its primary key., _(*4)

    $client = Client::find(1);

Retrieving an invoice by it's number:, _(*5)

    $invoice = Invoice::findByCustomQuery(["invoice_number" => "0123"]);

Inserting & Updating Models

Create a new client, _(*6)

    $client = new Client('test@example.com');
    $client->save();

Update an existing client, _(*7)

    $client->vat_number = '123456';
    $client->save();

Create an invoice, _(*8)

    $invoice = $client->createInvoice();
    $invoice->addInvoiceItem('Item', 'Some notes', 10);
    $invoice->save();

Download an invoice PDF, _(*9)

    $pdf = $invoice->download();

Deleting Models

    $client->archive();
    $client->delete();
    $client->restore();

Events

Register subscription for new client, _(*10)

    Client::subscribeCreate('http://example.com/...');

Convert posted data to a model, _(*11)

    $input = file_get_contents('php://input'); 
    $client = Client::hydrate($input);

Currently supported for clients, invoices, quotes and payments, _(*12)

Statics

Retrieve the static dataset Invoice Ninja uses, _(*13)

Get all statics, _(*14)

    Statics::all();

Get specific static, _(*15)

    Statics::countries();

List of available statics, _(*16)

    Statics::currencies();
    Statics::sizes();
    Statics::timezones();
    Statics::dateFormats();
    Statics::datetimeFormats();
    Statics::languages();
    Statics::paymentTerms();
    Statics::paymentTypes();
    Statics::countries();
    Statics::invoiceDesigns();
    Statics::invoiceStatus();
    Statics::frequencies();
    Statics::gateways();
    Statics::fonts();
    Statics::banks();