README

A handy Laravel wrapper around MYOB AccountRight v2. This is still in alpha stage and will include breaking changes regularily. Full Readme in progress.

Installation

You can install the package via composer:

composer require mandasa2022/drillcutmyob

Setup

ENV requirements:

MYOB_CLIENT_ID=
MYOB_CLIENT_SECRET=
MYOB_REDIRECT_URI=myob/login
MYOB_GRANT_TYPE=authorization_code
MYOB_SCOPE=CompanyFile

Publish the preset configuration to store your MYOB authentication details

php artisan vendor:publish --provider="Mandasa\Drillcutmyob\DrillcutmyobServiceProvider" --tag="migrations"
php artisan migrate

You'll now need to authenticate with something like the following:

use Mandasa\Drillcutmyob\Drillcutmyob;
use Mandasa\Drillcutmyob\Models\Remote\CompanyFile;
use Mandasa\Drillcutmyob\Models\Remote\Contact\Customer;

$drillcutmyob = new Drillcutmyob;
//Redirect your user to MYOB to authenticate account right v2
$drillcutmyob->authenticate()->getCode();
//When the code is returned, get your access token
$drillcutmyob->authenticate()->getToken();
//Now you can save your credentials like so
//You would first load the company files the MYOB user has access to
$drillcutmyob->of(CompanyFile::class)->load();
//Then save them like so (the username and passwords are Base64 encoded in Drillcutmyob)
$drillcutmyob->authenticate()->saveCompanyFileCredentials([
        'username' => 'USERNAME',
        'password' => 'PASSWORD',
        'company_file_guid' => 'COMPANY_FILE_GUID',
        'company_file_name' => 'COMPANY_FILE_NAME',
        'company_file_uri'  => 'COMPANY_FILE_URI''
]);

Usage

Get

Once that's completed you'll be able to query the API as you normally would

//And now query the API with the supported models (and paginate if supported)
$drillcutmyob->of(Customer::class)->page(1); //page 1
//Or (if the Model is a paginted model it will stil default to pagination due to MYOB api restrictions)
$drillcutmyob->of(Customer::class)->load(); //page 1
$drillcutmyob->of(Customer::class)->load(2); //page 2

//You can also load the specified model by UID .. here replace UID with your customer UID
$drillcutmyob->of(Customer::class)->loadByUid('UID');

//Or just return the first from a search
$drillcutmyob->of(TaxCode::class)->whereCode('GST')->first();

//The customer class also has some helper function (whereEmail)
$drillcutmyob->of(Customer::class)->whereEmail('drillcutmyob@gmail.com')->get();

You can also expose the Raw API for MYOB if appropriate

$drillcutmyob->rawGet('/Contact/Employee');
$drillcutmyob->rawPost('/Contact/Employee', $data);

Post

Once you're ready to post you can do the following, to, for example, save a Customer

$taxCode = $this->drillcutmyob->of(TaxCode::class)->whereCode('GST')->first();

$customer = (new Customer)->create([
    'CompanyName'    => 'Drillcut',
    'LastName'       => 'Phillips',
    'FirstName'      => 'Tim',
    'IsIndividual'   => false,
    "TaxCode"        => [
        "UID" => $taxCode['UID'],
    ],
    "FreightTaxCode" => [
        "UID" => $taxCode['UID'],
    ],
])

$drillcutmyob->save($customer);

Testing

composer test

Todo:

Create API Auth.
Create basic model syntax for retrieving data
Implement base model for encodable data
Create request class
Clean up request class.
Create get and set for appropriate models instead of current free-for-all
Write tests
Make OAuth2 request class less dependant on request class

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Credits

Luke Curtis

License

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

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.

mandasa2022 / drillcutmyob

Maintainers

Details