pixel/laravel-quickbooks
1
0
Fork 0
mirror of https://github.com/wearepixel/laravel-quickbooks.git synced 2026-11-14 22:11:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: rewrite README for current package state

Browse Source 
- Replace broken Scrutinizer/poser.pugx badges with shields.io
- Add PHP version badge
- Add Laravel/PHP compatibility table
- Fix migration command (remove deprecated --package flag)
- Modernize usage example with FQCN resolution
- Simplify and tighten all sections
- Remove outdated Psy Shell version references
- Fix middleware class path reference
- Add testing section
This commit is contained in:
Joel Male
2026-02-18 10:45:27 +10:00
parent 861a08e083
commit bb2d375450
1 changed files with 59 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+59 -71
View File
@@ -1,115 +1,103 @@
# Wearepixel's Laravel QuickBooks Client # Laravel QuickBooks Client
[![Latest Stable Version](https://poser.pugx.org/wearepixel/laravel-quickbooks/v/stable)](https://packagist.org/packages/wearepixel/laravel-quickbooks) [![Latest Stable Version](https://img.shields.io/packagist/v/wearepixel/laravel-quickbooks.svg)](https://packagist.org/packages/wearepixel/laravel-quickbooks)
[![Latest Unstable Version](https://poser.pugx.org/wearepixel/laravel-quickbooks/v/unstable)](https://packagist.org/packages/wearepixel/laravel-quickbooks) [![Total Downloads](https://img.shields.io/packagist/dt/wearepixel/laravel-quickbooks.svg)](https://packagist.org/packages/wearepixel/laravel-quickbooks)
[![Total Downloads](https://poser.pugx.org/wearepixel/laravel-quickbooks/downloads)](https://packagist.org/packages/wearepixel/laravel-quickbooks) [![License](https://img.shields.io/packagist/l/wearepixel/laravel-quickbooks.svg)](https://packagist.org/packages/wearepixel/laravel-quickbooks)
[![License](https://poser.pugx.org/wearepixel/laravel-quickbooks/license)](https://packagist.org/packages/wearepixel/laravel-quickbooks) [![PHP Version](https://img.shields.io/packagist/dependency-v/wearepixel/laravel-quickbooks/php.svg)](https://packagist.org/packages/wearepixel/laravel-quickbooks)
PHP client wrapping the [QuickBooks PHP SDK](https://github.com/intuit/QuickBooks-V3-PHP-SDK). A Laravel package wrapping the [QuickBooks PHP SDK](https://github.com/intuit/QuickBooks-V3-PHP-SDK). Provides OAuth 2.0 authentication, automatic token management, and access to the QuickBooks Online API.
We solely use [Laravel](https://www.laravel.com) for our applications, so this package is written with Laravel in mind. If there is a request from the community to split this package into 2 parts to allow it to be used outside of Laravel, then we will consider doing that work. ## Compatibility
## Build Status | Laravel | PHP | Package |
|---------|------|---------|
| Branch | Status | Coverage | Code Quality | | 12.x | ^8.3 | ^1.0 |
| ------ | :----: | :------: | :----------: | | 11.x | ^8.3 | ^1.0 |
| Master | [![Build Status](https://github.com/wearepixel/laravel-quickbooks/workflows/CI/badge.svg?branch=master)](https://github.com/wearepixel/laravel-quickbooks/workflows/CI/badge.svg?branch=master) | [![Code Coverage](https://scrutinizer-ci.com/g/wearepixel/laravel-quickbooks/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/wearepixel/laravel-quickbooks/?branch=master) | [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/wearepixel/laravel-quickbooks/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/wearepixel/laravel-quickbooks/?branch=main) | | 10.x | ^8.3 | ^1.0 |
## Installation ## Installation
1. Install QuickBooks PHP Client: 1. Install the package:
```bash ```bash
$ composer require wearepixel/laravel-quickbooks composer require wearepixel/laravel-quickbooks
``` ```
2. Run our migration to install the `quickbooks_tokens` table: 2. Run the migration to create the `quickbooks_tokens` table:
```bash ```bash
$ php artisan migrate --package=wearepixel/laravel-quickbooks php artisan migrate
``` ```
The package uses the [auto registration feature](https://laravel.com/docs/packages#package-discovery) of Laravel. The package uses Laravel's [auto-discovery](https://laravel.com/docs/packages#package-discovery), so no manual provider registration is needed.
## Configuration ## Configuration
1. You will need a ```quickBooksToken``` relationship on your ```User``` model. There is a trait named ```Wearepixel\QuickBooks\HasQuickBooksToken```, which you can include on your ```User``` model, which will setup the relationship. To do this implement the following: ### 1. Add the trait to your User model
Add ```use Wearepixel\QuickBooks\HasQuickBooksToken;``` to your service container at the top of User.php
and also add the trait within the class. For example:
```php ```php
use Wearepixel\QuickBooks\HasQuickBooksToken;
class User extends Authenticatable class User extends Authenticatable
{ {
use Notifiable, HasQuickBooksToken; use HasQuickBooksToken;
}
``` ```
**NOTE: If your ```User``` model is not ```App\Models\User```, then you will need to configure the path in the ```configs/quickbooks.php```.** If your User model is not `App\Models\User`, publish the config and update the `user.model` value.
2. Add the appropriate values to your ```.env``` ### 2. Set your environment variables
#### Minimal Keys ```bash
```bash QUICKBOOKS_CLIENT_ID=<your client id>
QUICKBOOKS_CLIENT_ID=<client id given by QuickBooks> QUICKBOOKS_CLIENT_SECRET=<your client secret>
QUICKBOOKS_CLIENT_SECRET=<client secret> ```
```
#### Optional Keys Optional:
```bash
QUICKBOOKS_API_URL=<Development|Production> # Defaults to App's env value
QUICKBOOKS_DEBUG=<true|false> # Defaults to App's debug value
```
3. _[Optional]_ Publish configs & views ```bash
QUICKBOOKS_API_URL=<Development|Production> # Defaults based on APP_ENV
QUICKBOOKS_DEBUG=<true|false> # Defaults to APP_DEBUG
```
#### Config ### 3. Publish config and views (optional)
A configuration file named ```quickbooks.php``` can be published to ```config/``` by running...
```bash ```bash
php artisan vendor:publish --tag=quickbooks-config php artisan vendor:publish --tag=quickbooks-config
``` php artisan vendor:publish --tag=quickbooks-views
```
#### Views
View files can be published by running...
```bash
php artisan vendor:publish --tag=quickbooks-views
```
## Usage ## Usage
Here is an example of getting the company information from QuickBooks: First, direct users to `/quickbooks/connect` to authorize their QuickBooks account. Once connected, you can access the API:
### NOTE: Before doing these commands, go to your connect route (default: /quickbooks/connect) to get a QuickBooks token for your user
```php ```php
php artisan tinker $quickbooks = app(\Wearepixel\QuickBooks\Client::class);
Psy Shell v0.8.17 (PHP 7.1.14 — cli) by Justin Hileman
>>> Auth::logInUsingId(1) // Get company info
=> App\Models\User {#1668 $company = $quickbooks->getDataService()->getCompanyInfo();
id: 1,
// Other keys removed for example // Access reports
} $reportService = $quickbooks->getReportService();
>>> $quickbooks = app('Wearepixel\QuickBooks\Client') // or app('QuickBooks')
=> Wearepixel\QuickBooks\Client {#1613}
>>> $quickbooks->getDataService()->getCompanyInfo();
=> QuickBooksOnline\API\Data\IPPCompanyInfo {#1673
+CompanyName: "Sandbox Company_US_1",
+LegalName: "Sandbox Company_US_1",
// Other properties removed for example
}
>>>
``` ```
You can call any of the resources as documented [in the SDK](https://intuit.github.io/QuickBooks-V3-PHP-SDK/quickstart.html). You can call any of the resources documented in the [QuickBooks PHP SDK](https://intuit.github.io/QuickBooks-V3-PHP-SDK/quickstart.html).
## Middleware ## Middleware
If you have routes that will be dependent on the user's account having a usable QuickBooks OAuth token, there is an included middleware ```Wearepixel\QuickBooks\Laravel\Filter``` that gets registered as ```quickbooks``` that will ensure the account is linked and redirect them to the `connect` route if needed. Protect routes that require a QuickBooks connection using the `quickbooks` middleware. Users without a valid token will be redirected to the connect page.
Here is an example route definition:
```php ```php
Route::view('some/route/needing/quickbooks/token/before/using', 'some.view') Route::get('quickbooks/invoices', InvoiceController::class)
->middleware('quickbooks'); ->middleware('quickbooks');
``` ```
## Testing
```bash
./vendor/bin/pest
```
## License
MIT