README

Laravel package for integration with the Zoho v3 API (CRM + Books + Inventory) with multi-organization token support.

Installation

Install the package via Composer:

composer require masmaleki/zoho-one

Publish and run the migrations:

php artisan vendor:publish --tag="zoho-one-migrations"
php artisan migrate

Publish the config file:

php artisan vendor:publish --tag="zoho-one-config"

The config is published to config/zoho-one.php. Reference values in your app via config('zoho-one.*').

Upgrading from masmaleki/zoho-v3 or masmaleki/zoho-v4

This package was previously published as masmaleki/zoho-v3 and briefly as masmaleki/zoho-v4. The package name no longer carries a version suffix; the underlying database table is still named zoho_v4 (it is an internal implementation detail and is not renamed again to avoid forcing another migration on existing installs).

To upgrade:

1. Swap the Composer requirement:

   composer remove masmaleki/zoho-v3   # or masmaleki/zoho-v4
   composer require masmaleki/zoho-one

2. Publish and run the migrations. Two guarded upgrade migrations ship with the package (both are idempotent and safe to re-run):

   php artisan vendor:publish --tag="zoho-one-migrations"
   php artisan migrate

   • rename_zoho_v3_to_zoho_v4_table renames the legacy zoho_v3 table to zoho_v4 (no-op if you are already on zoho_v4 or on a fresh install).
   • add_organization_id_to_zoho_v4_table adds the organization_id column required by the multi-organization feature (no-op if already present).

3. Re-publish the config (it has been renamed to config/zoho-one.php) and copy any custom values from your old config/zoho-v3.php or config/zoho-v4.php:

   php artisan vendor:publish --tag="zoho-one-config"

   Update any config('zoho-v3.*') or config('zoho-v4.*') calls in your application code to config('zoho-one.*').

Compatibility

Zoho Books customization resources

The package includes helpers for Zoho Books customization resources. These methods use the configured Books API base URL from config('zoho-one.books_api_base_url'), the saved Zoho access token, and the Zoho Books organization ID passed to the method.

use Masmaleki\ZohoAllInOne\ZohoAllInOne;

$organizationId = 123456789;

$customField = ZohoAllInOne::createBooksCustomField([
    'label' => 'Internal Number',
    'data_type' => 'string',
], $organizationId);

$webhook = ZohoAllInOne::createBooksWebhook([
    'name' => 'Sales order sync',
    'url' => 'https://example.com/api/zoho/books/webhook',
], $organizationId);

$customFunction = ZohoAllInOne::createBooksCustomFunction([
    'name' => 'Sync sales order',
    'script' => '// Deluge script body',
], $organizationId);

$customAction = ZohoAllInOne::createBooksCustomAction([
    'name' => 'Run sync',
], $organizationId);

Available helper groups:

ZohoAllInOne::getBooksCustomFields($organizationId, $query = []);
ZohoAllInOne::createBooksCustomField($data, $organizationId);
ZohoAllInOne::getBooksCustomField($fieldId, $organizationId);
ZohoAllInOne::updateBooksCustomField($fieldId, $data, $organizationId);
ZohoAllInOne::deleteBooksCustomField($fieldId, $organizationId);

ZohoAllInOne::getBooksWebhooks($organizationId, $query = []);
ZohoAllInOne::createBooksWebhook($data, $organizationId);
ZohoAllInOne::getBooksWebhook($webhookId, $organizationId);
ZohoAllInOne::updateBooksWebhook($webhookId, $data, $organizationId);
ZohoAllInOne::deleteBooksWebhook($webhookId, $organizationId);

ZohoAllInOne::getBooksCustomFunctions($organizationId, $query = []);
ZohoAllInOne::createBooksCustomFunction($data, $organizationId);
ZohoAllInOne::getBooksCustomFunction($functionId, $organizationId);
ZohoAllInOne::updateBooksCustomFunction($functionId, $data, $organizationId);
ZohoAllInOne::deleteBooksCustomFunction($functionId, $organizationId);

ZohoAllInOne::getBooksCustomActions($organizationId, $query = []);
ZohoAllInOne::createBooksCustomAction($data, $organizationId);
ZohoAllInOne::getBooksCustomAction($actionId, $organizationId);
ZohoAllInOne::updateBooksCustomAction($actionId, $data, $organizationId);
ZohoAllInOne::deleteBooksCustomAction($actionId, $organizationId);

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Mohammad Sadegh Maleki
• All Contributors

License

The MIT License (MIT). Please see License File for more information.