README

Implémentation de l'API Zoho Invoice pour Laravel

Prérequis

Pour fonctionner, l'ensemble des élements sont nécessaires :

Installation

Lancer la commande Composer require :

composer require babaweb/laravel-zohoinvoice

Modifier le fichier config/app.php pour y ajouter le provider

'providers' => [
    ...
    Babaweb\ZohoInvoice\ZohoInvoiceServiceProvider::class
],

Enfin publier le fichier :

php artisan vendor:publish --provider="Babaweb\ZohoInvoice\ZohoInvoiceServiceProvider"

Et tadaaa ! Le package est prêt.

Configuration

Afin de se connecter à l'API ZohoInvoice, des tokens sont nécessaires. Pour les renseigner, il faut ouvrir le fichier dans config/zohoinvoice.php :

return [
    'authtoken' => env('ZOHO_AUTHTOKEN', 'VOTRE_AUTH_TOKEN'),
    'organization_id' => env('ZOHO_ORGANIZATION', 'VOTRE_ORGANIZATION_ID')
];

Utilisation

Ajouter la facade :

use Babaweb\ZohoInvoice\ZohoInvoice;

Par exemple avec la fonction test :

public function test(ZohoInvoice $client) {
    //Vos requêtes ici 
}

Fonctions

Liste des fonctions disponibles :

getContacts() : Retourne la liste des contacts
getInvoices($customer_id) : Retourne la liste des factures à partir de l'ID du client
getInvoice($invoice_id) : Retourne la facture dont l'ID est passé en paramètre
getInvoicePayments($invoice_id) : Retourne la liste des paiements de facture dont l'ID est passé en paramètre
createItem($parameters) : Créer un item à partir des élements en paramètres
createInvoice($parameters) : Créer une facture à partir des élements en paramètres
createContact($parameters) : Créer un contact à partir des élements en paramètres
updateItem($item_id, $parameters) : Modifie un item à partir des élements en paramètres

Détails des fonctions

createItem($parameters) :

$parameters = [
    //required
    'name' => 'Product 6.1', //Nom de l'item
    'rate' => '300', //Prix unitaire de l'item
    //Optional
    'description' => 'Test product', //Description de l'item
    'tax_id' => 39448000000026222, //ID de la taxe 
    'product_type' => 'service', //Type de l'item
];

createInvoice($parameters) :

$parameters = [
    //required
    'customer_id' => 982000000567001, //ID du client
    //Optional
    'invoice_number' => 'INV-00003', //Numéro de la facture
    'discount' => 0, //Réduction appliquée à la facture. Soit en pourcentage (12.5%) ou un montant (190)
    'is_discount_before_tax' => true, //Vrai si la réduction s'applique au HT
];

createContact($parameters) :

$parameters = [
    //required
    'contact_name' => 'Bowman and Co', //Nom du contact
    //Optional
    'company_name' => 'Bowman and Co', //Nom de la société
];

updateItem($item_id, $parameters) :

$parameters = [
    //required
    'name' => 'Product 6.1', //Nom de l'item
    'rate' => '300', //Prix unitaire de l'item
    //Optional
    'description' => 'Test product', //Description de l'item
    'tax_id' => 39448000000026222, //ID de la taxe 
    'product_type' => 'service', //Type de l'item
];

License

Ce package ZohoInvoice pour Laravel est un logiciel libre sous licence MIT

babaweb / laravel-zohoinvoice

Maintainers

Details