README

This bundle allows you to use the zoho books api easily from your php code.

Table of content

Installation
Configuration
Usage
Versioning
Contributing
Hacking
License

Installation

This bundle requires at least Symfony 3.0.

You can use composer to install zoho-books-client-bundle:

composer require chaplean/zoho-books-client-bundle

Then add to your AppKernel.php:

new Chaplean\Bundle\ZohoBooksClientBundle\ChapleanZohoBooksClientBundle(),

Configuration

First you will need to import bundle configuration.

config.yml:

imports:
    - { resource: '@ChapleanZohoBooksClientBundle/Resources/config/config.yml' }

You must also create some parameters.

parameters.yml:

parameters:
    chaplean_zoho_books.organization_id: f545ff15s4g
    chaplean_zoho_books.access_token: g45df45g41g5fd

Usage

Here is an example of how to use the getEstimate route.

$response = $zohoBooksApi->getEstimate()
    ->bindUrlParameters(['id' => 'df154f1fds4f54dsf15'])
    ->exec();
    
if ($response->succeeded()) {
    $content = $response->getContent();
    // your code
}

Available functions:

Contacts
- getContacts()
- getContactPersons()
Items
- getItems()
- getItem()
- postItem()
- putItem()
- deleteItem()
- postItemActive()
- postItemInactive()
Estimate
- getEstimate()
- getEstimates()
- postEstimate()
- putEstimate()
- deleteEstimate()
- postEstimateAsDeclined()
- postEstimateAsAccepted()
Invoice
- getInvoice()
- getInvoices()
- postInvoice()
- putInvoice()
- deleteInvoice()

Versioning

zoho-books-client-bundle follows semantic versioning. In short the scheme is MAJOR.MINOR.PATCH where

MAJOR is bumped when there is a breaking change,
MINOR is bumped when a new feature is added in a backward-compatible way,
PATCH is bumped when a bug is fixed in a backward-compatible way.

Versions bellow 1.0.0 are considered experimental and breaking changes may occur at any time.

Contributing

Contributions are welcomed! There are many ways to contribute, and we appreciate all of them. Here are some of the major ones:

Bug Reports: While we strive for quality software, bugs can happen and we can't fix issues we're not aware of. So please report even if you're not sure about it or just want to ask a question. If anything the issue might indicate that the documentation can still be improved!
Feature Request: You have a use case not covered by the current api? Want to suggest a change or add something? We'd be glad to read about it and start a discussion to try to find the best possible solution.
Pull Request: Want to contribute code or documentation? We'd love that! If you need help to get started, GitHub as documentation on pull requests. We use the "fork and pull model" were contributors push changes to their personnal fork and then create pull requests to the main repository. Please make your pull requests against the master branch.

As a reminder, all contributors are expected to follow our Code of Conduct.

Hacking

You might find the following commands usefull when hacking on this project:

# Install dependencies
composer install

# Run tests
bin/phpunit

License

zoho-books-client-bundle is distributed under the terms of the MIT license.

See LICENSE for details.

chaplean / zoho-books-client-bundle

Maintainers

Details