Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 

README.md

InvoiceNinjaModule

ZF3 Module to consume the InvoiceNinja API (https://www.invoiceninja.com).

GitHub release Build Status Code Coverage Scrutinizer Code Quality Dependency Status Total Downloads Latest Stable Version

Description

Latest release can handle the following api services:

  • Clients
  • Invoices
  • Products
  • Tax rates

Can use basic or digest server authorization.

Installation

The suggested installation method is via composer:

php composer.phar require alexz707/invoiceninja-module

Configure module

  • Copy /vendor/alexz707/invoiceninja-module/config/invoiceninja.global.php.dist into your global autoload folder, remove the dist extension so that Zend Framework picks it up
  • If you use your own instance of invoice ninja change the host url
  • Replace the token with your generated invoice ninja token
  • If you use basic or digest authorization uncomment the used method and fill in your credentials
    Module::INVOICE_NINJA_CONFIG => [
        Module::API_TIMEOUT     => 100,
        Module::TOKEN           => 'YOURTOKEN',
        Module::HOST_URL        => 'http://ninja.dev/api/v1',

        /*
         * If the api is protected by htaccess uncomment
         * ONE of the following code blocks and use your credentials.
         */
        Module::AUTHORIZATION   => [
            /*
             * BASIC authorization
             * \Zend\Http\Client::AUTH_BASIC => [
             *    Module::AUTH_USER => 'YOURUSER',
             *    Module::AUTH_PASS => 'YOURPASSWORD'
             * ]
             */

            /*
             * DIGEST authorization
             * \Zend\Http\ClientClient::AUTH_DIGEST => [
             *    Module::AUTH_USER => 'YOURUSER',
             *    Module::AUTH_PASS => 'YOURPASSWORD'
             * ]
             */
        ]
    ]

Enable module

Register as Zend Framework module inside your config/application.config.php file:

    'modules' => [
        'Zend\Router',
        'InvoiceNinjaModule',
        'YourApplicationModule',
    ],

Use the service managers

        /** @var ClientManager $clientManager */
        $clientManager = $sm->get(ClientManager::class);
        $client = $clientManager->getClientById(1);

About

ZF3 Module to consume the InvoiceNinja API.

Topics

Resources

Packages

No packages published

Languages

You can’t perform that action at this time.