traimmu/mf-cloud-invoice

MFCloud Invoice API wrapper

v0.0.9 2018-04-02 05:36 UTC

Requires

• guzzlehttp/guzzle: ^6.3
• illuminate/support: ^5.5

Requires (Dev)

• phpunit/phpunit: ^6.4

MIT

• gosho-kazuya

README

mf_cloud-invoice-php

MFクラウド請求書API client library for PHP

This library is inspired by moneyforward/mf_cloud-invoice-ruby

Installation

composer require traimmu/mf-cloud-invoice

Usage

Build client

use Traimmu\MfCloud\Invoice\Client;

$client = new Client('YOUR_ACCESS_TOKEN');

$client->billings()->all();
// => your billings

Get My Office

$office = $client->office(); // => returns Traimmu\MfCloud\Invoice\Models\Office instance
echo $office->name; // => '株式会社Traimmu'

$office->update([
    'name' => 'section9',
    'zip' => '101-1111',
]);
echo $office->name; // => 'section9'

Get Partners

$client->partners()->all();
$client->partners()->find('MF INVOICE PARTNER ID');

Get Billings

$client->billings()->all();

Items

$client->items()->all();

Laravel Integration

Add the Traimmu\MfCloud\Invoice\Misc\ServiceProvider provider to the providers array in config/app.php:

'providers' => [
    // ...
    Traimmu\MfCloud\Invoice\Misc\ServiceProvider::class,
],

Then add the facade to your aliases array:

'aliases' => [
    // ...
    'Invoice' => Traimmu\MfCloud\Invoice\Misc\Facade::class,
],

Finally, add the following lines at config/services.php:

// ...
'mfcloud' => [
    'secret' => env('MFCLOUD_INVOICE_API_TOKEN'),
],

Example

Get partners which have more than one departments:

<?php
$client->partners()->all()->filter(function ($partner) {
  return count($partner->departments) > 0;
});

Loadmap

• Add tests
  • client
  • api
  • models
• Add service provider for Laravel
• Add Eloquent model like methods and relationships
  • api->firstOrCreate()
  • Create Department model
  • $client->partners()->first()->departments()->create($params)
  • $client->partners()->first()->departments->first()
  • Partner hasMany Departments
  • Department hasMany Billings
  • Billing hasMany Items
• Add Exceptions
• Add circle.yml and build automatically
• Add more documents
• Add authentication for getting OAuth token

Development

After checking out the repo, run composer install to install dependencies.

Then run vendor/bin/phpunit and ensure all tests success.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Traimmu/mf_cloud-invoice-php

License

The package is available as open source under the terms of the MIT License.