README

This package allows you to connect your Laravel application to the accounting software by Moneybird.

Installation

You can install the package via composer:

composer require sensson/laravel-moneybird

You can publish the config file with:

php artisan vendor:publish --tag="laravel-moneybird-config"

Usage

$moneybirdAdministrationId = '<your-administration-id>';
Moneybird::administration($moneybirdAdministrationId)->contacts()->all();

Authentication / OAuth2

You can use OAuth2 to authorize your application with Moneybird.

$moneybird = Moneybird::auth();
$url = $moneybird->getAuthorizationUrl();

session()->put('moneybird.state', $moneybird->getState());

return redirect()->to($url);

And process the callback from Moneybird:

$code = $request->string('code');
$state = $request->string('state');
$expected = session()->pull('moneybird.state');

$moneybird = Moneybird::auth();
$authorization = $moneybird->getAccessToken($code, $state, $expected);

// Store the $authorization details with a user or team

Both would typically be done in a custom controller. You can use the $authorization to call the Moneybird API:

$auth = $this->moneybird_auth;

if ($auth->hasExpired()) {
    $auth = Moneybird::auth()->make()->refreshAccessToken($auth);
    // Save new auth with the tenant or user
}

Moneybird::make()->authenticate($auth);

Testing

composer test

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

License

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

sensson / laravel-moneybird

Maintainers

Details