mirror of
https://github.com/wearepixel/laravel-quickbooks.git
synced 2026-11-14 14:01:46 +00:00
Joel Male
bb2d375450
- 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
104 lines
2.9 KiB
Markdown
104 lines
2.9 KiB
Markdown
# Laravel QuickBooks Client
|
|
|
|
[](https://packagist.org/packages/wearepixel/laravel-quickbooks)
|
|
[](https://packagist.org/packages/wearepixel/laravel-quickbooks)
|
|
[](https://packagist.org/packages/wearepixel/laravel-quickbooks)
|
|
[](https://packagist.org/packages/wearepixel/laravel-quickbooks)
|
|
|
|
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.
|
|
|
|
## Compatibility
|
|
|
|
| Laravel | PHP | Package |
|
|
|---------|------|---------|
|
|
| 12.x | ^8.3 | ^1.0 |
|
|
| 11.x | ^8.3 | ^1.0 |
|
|
| 10.x | ^8.3 | ^1.0 |
|
|
|
|
## Installation
|
|
|
|
1. Install the package:
|
|
|
|
```bash
|
|
composer require wearepixel/laravel-quickbooks
|
|
```
|
|
|
|
2. Run the migration to create the `quickbooks_tokens` table:
|
|
|
|
```bash
|
|
php artisan migrate
|
|
```
|
|
|
|
The package uses Laravel's [auto-discovery](https://laravel.com/docs/packages#package-discovery), so no manual provider registration is needed.
|
|
|
|
## Configuration
|
|
|
|
### 1. Add the trait to your User model
|
|
|
|
```php
|
|
use Wearepixel\QuickBooks\HasQuickBooksToken;
|
|
|
|
class User extends Authenticatable
|
|
{
|
|
use HasQuickBooksToken;
|
|
}
|
|
```
|
|
|
|
If your User model is not `App\Models\User`, publish the config and update the `user.model` value.
|
|
|
|
### 2. Set your environment variables
|
|
|
|
```bash
|
|
QUICKBOOKS_CLIENT_ID=<your client id>
|
|
QUICKBOOKS_CLIENT_SECRET=<your client secret>
|
|
```
|
|
|
|
Optional:
|
|
|
|
```bash
|
|
QUICKBOOKS_API_URL=<Development|Production> # Defaults based on APP_ENV
|
|
QUICKBOOKS_DEBUG=<true|false> # Defaults to APP_DEBUG
|
|
```
|
|
|
|
### 3. Publish config and views (optional)
|
|
|
|
```bash
|
|
php artisan vendor:publish --tag=quickbooks-config
|
|
php artisan vendor:publish --tag=quickbooks-views
|
|
```
|
|
|
|
## Usage
|
|
|
|
First, direct users to `/quickbooks/connect` to authorize their QuickBooks account. Once connected, you can access the API:
|
|
|
|
```php
|
|
$quickbooks = app(\Wearepixel\QuickBooks\Client::class);
|
|
|
|
// Get company info
|
|
$company = $quickbooks->getDataService()->getCompanyInfo();
|
|
|
|
// Access reports
|
|
$reportService = $quickbooks->getReportService();
|
|
```
|
|
|
|
You can call any of the resources documented in the [QuickBooks PHP SDK](https://intuit.github.io/QuickBooks-V3-PHP-SDK/quickstart.html).
|
|
|
|
## Middleware
|
|
|
|
Protect routes that require a QuickBooks connection using the `quickbooks` middleware. Users without a valid token will be redirected to the connect page.
|
|
|
|
```php
|
|
Route::get('quickbooks/invoices', InvoiceController::class)
|
|
->middleware('quickbooks');
|
|
```
|
|
|
|
## Testing
|
|
|
|
```bash
|
|
./vendor/bin/pest
|
|
```
|
|
|
|
## License
|
|
|
|
MIT
|