aarongrtech/qbwc-laravel

Laravel-flavored QuickBooks Web Connector package

dev-main 2024-10-06 15:44 UTC

Requires

• php: >=7.4
• ext-dom: *
• ext-mbstring: *
• ext-soap: *
• nesbot/carbon: ^3.8
• wsdltophp/packagebase: ~5.0

MIT

• AaronGRTech

README

QBWC Laravel is a Laravel-flavored QuickBooks Web Connector package. This library is still a work in progress but is largely complete and stable, offering communication with QuickBooks Desktop through SOAP services.

Installation

To install the package, run:

composer require aarongrtech/qbwc-laravel

Ensure that your composer.json includes the necessary autoload settings:

"autoload": {
    "psr-4": {
        "AaronGRTech\\QbwcLaravel\\": "./src/AaronGRTech/QbwcLaravel"
    }
},
"extra": {
    "laravel": {
        "providers": [
            "AaronGRTech\\QbwcLaravel\\Providers\\QbwcServiceProvider"
        ]
    }
}

After updating Composer, add the service provider to the config/app.php file:

'providers' => [
    // Other Service Providers

    AaronGRTech\QbwcLaravel\Providers\QbwcServiceProvider::class,
],

Usage

Setting Up WSDL File

Ensure that the WSDL file is available at storage_path('app/wsdl/QBWebConnectorSvc.wsdl'). You can publish the WSDL file to the storage directory using:

php artisan vendor:publish --provider="AaronGRTech\QbwcLaravel\Providers\QbwcServiceProvider"

Routes

This package provides routes to handle SOAP requests. These routes are automatically registered by the QbwcServiceProvider.

Controller

The SoapController handles various SOAP requests:

• Server Version

  • Route: /soap/serverVersion
  • Method: serverVersion
  • Request: POST

• Client Version

  • Route: /soap/clientVersion
  • Method: clientVersion
  • Request: POST

• Authenticate

  • Route: /soap/authenticate
  • Method: authenticate
  • Request: POST

• Send Request XML

  • Route: /soap/sendRequestXML
  • Method: sendRequestXML
  • Request: POST

• Receive Response XML

  • Route: /soap/receiveResponseXML
  • Method: receiveResponseXML
  • Request: POST

Post-Installation Steps

After installing this package, please update your application's composer.json file to autoload the callbacks:

{
    "autoload": {
        "psr-4": {
            "App\\Callbacks\\": "app/Callbacks/"
        }
    }
}

Requirements

• PHP >= 7.4
• Laravel framework
• Extensions: ext-dom, ext-mbstring, ext-soap
• Dependency: wsdltophp/packagebase ~5.0

License

This package is licensed under the MIT License. See the LICENSE file for more information.

Authors

• AaronGRTech - [e-mail]

Contributing

Please read the CONTRIBUTING file for details on our code of conduct, and the process for submitting pull requests.