Add the Invoice Ninja SDK
composer require invoiceninja/sdk-php
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/v1as the URL. - You can either use the free hosted trial or install the app to create an API token.
- Clients
- Invoices/Quotes
- Products
- Payments
- Tasks
- Vendors
- Expenses
- TaxRates
- Credits
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).
Retrieve all clients
$clients = Client::all();Retrieve a client by its primary key.
$client = Client::find(1);Retrieving an invoice by it's number:
$invoice = Invoice::findByCustomQuery(["invoice_number" => "0123"]);Create a new client
$client = new Client('[email protected]');
$client->save();Update an existing client
$client->vat_number = '123456';
$client->save();Create an invoice
$invoice = $client->createInvoice();
$invoice->addInvoiceItem('Item', 'Some notes', 10);
$invoice->save();Download an invoice PDF
$pdf = $invoice->download(); $client->archive();
$client->delete();
$client->restore();Register subscription for new client
Client::subscribeCreate('http:https://example.com/...');Convert posted data to a model
$input = file_get_contents('php:https://input');
$client = Client::hydrate($input);Currently supported for clients, invoices, quotes and payments
Retrieve the static dataset Invoice Ninja uses
Get all statics
Statics::all();Get specific static
Statics::countries();List of available statics
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();