PHPackages revolution/laravel-freee-sdk - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. revolution/laravel-freee-sdk AbandonedArchivedLibrary[API Development](/categories/api) revolution/laravel-freee-sdk ============================ Freee SDK for Laravel 1.2.0(5y ago)023MITPHPPHP ^7.2||^8.0 Since Jan 8Pushed 5y ago1 watchersCompare [ Source](https://github.com/kawax/laravel-freee-sdk)[ Packagist](https://packagist.org/packages/revolution/laravel-freee-sdk)[ RSS](/packages/revolution-laravel-freee-sdk/feed)WikiDiscussions master Synced yesterday READMEChangelogDependencies (5)Versions (9)Used By (0) Freee SDK for Laravel ===================== [](#freee-sdk-for-laravel) [![Build Status](https://camo.githubusercontent.com/ee4602e078efeaf71ec6b44a0e90fd638ab69f8aacd03dc0eba830577b8fc9f4/68747470733a2f2f7472617669732d63692e636f6d2f6b617761782f6c61726176656c2d66726565652d73646b2e7376673f6272616e63683d6d6173746572)](https://travis-ci.com/kawax/laravel-freee-sdk)[![Maintainability](https://camo.githubusercontent.com/1accd9c5be9b1f3d8e6635c4c9833061bd08defeef1ea0ac51a074077ca65302/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f30346130396331386232663034313339346637342f6d61696e7461696e6162696c697479)](https://codeclimate.com/github/kawax/laravel-freee-sdk/maintainability)[![Test Coverage](https://camo.githubusercontent.com/6f8bc2283be4cf85246ec5950071cd0c1953a024f986aa86a6274e21badd6ad8/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f30346130396331386232663034313339346637342f746573745f636f766572616765)](https://codeclimate.com/github/kawax/laravel-freee-sdk/test_coverage) `freee-accounting-sdk-php`をLaravelから使いやすくするパッケージ。 accounting以外のSDKが登場した場合はこのパッケージのまま対応するかもしれません。 Requirements ------------ [](#requirements) - PHP >= 7.2 - Laravel >= 6.0 Versioning ---------- [](#versioning) - Basic : semver - Drop old PHP or Laravel version : `+0.1`. composer should handle it well. - Support only latest major version (`master` branch), but you can PR to old branches. - 基本はsemver - サポート期限の切れた古いPHPやLaravelをサポート対象から外す時は0.1上げる。composerが上手く処理してくれるはず。 - 最新のメジャーバージョンのみサポート対象。旧バージョンのブランチへのPRは可能。 Installation ------------ [](#installation) ``` composer require revolution/laravel-freee-sdk ``` ### config/services.php [](#configservicesphp) `revolution/socialite-freee`と同じなのでそのまま流用可能。 ``` 'freee-accounting' => [ 'client_id' => env('FREEE_ACCOUNTING_CLIENT_ID'), 'client_secret' => env('FREEE_ACCOUNTING_CLIENT_SECRET'), ], ``` ### .env [](#env) ``` FREEE_ACCOUNTING_CLIENT_ID= FREEE_ACCOUNTING_CLIENT_SECRET= ``` Demo ---- [](#demo) 使い方 --- [](#使い方) Facade・Trait・Macroを使う方法とそれぞれテスト時の注意があるのでよく確認してください。 ### Facade [](#facade) ``` use Freee\Accounting\Configuration; use Revolution\Freee\Facades\Freee; class Controller { public function meFacade(Request $request) { $user = $request->user(); // Freee::driver() // Freee::driver('accounting') // デフォルトはaccountingなのでどちらでも同じ。 // driver()を省略しても同じ。 // 現在はaccounting SDKのみ対応なのでFreee=AccountingClientのインスタンスの認識でいいです。 // 今後SDKが増えたら変わる。 // 以降の使い方はaccountingが前提。 // 普通の使い方と同じように$configを作ってセット。 $config = Configuration::getDefaultConfiguration()->setAccessToken($user->token); // Freee::config($config)->companies()と繋げることも可能 Freee::config($config); // companies()はCompaniesApiクラスのインスタンスを返すマジックメソッド。 // 先頭のみ小文字、最後のApiを除いたメソッド名がルール。TrialBalanceApiならtrialBalance() // getCompanies()はCompaniesApiクラスのメソッド。後の使い方は同じ。 // Responseは(string)でjsonに変換されるのでdecodeしてarrayで取得。Laravelならこの形のほうが扱いやすい。 $companiesResponse = json_decode((string) Freee::companies()->getCompanies(), true); $targetCompanyId = $companiesResponse['companies'][0]['id']; // deals()はDealsApi。変換せずにそのままviewへ。null多すぎの解決方法はmacroで。 $limit = 5; $deals = Freee::deals()->getDeals( $targetCompanyId, null, null, null, null, null, null, null, null, null, null, null, null, $limit)->getDeals(); return view('account.me', compact('user', 'deals')); } } ``` 短いFacadeは自動では登録されないので必要なら手動で`config/app.php`にて登録してください。 ``` 'Freee' => Revolution\Freee\Facades\Freee::class, ``` ### Facadeのテスト [](#facadeのテスト) ``` public function testMeFacade() { Freee::shouldReceive('config'); // shouldReceiveですべてモックするのでAPIは実行されない。 Freee::shouldReceive('companies->getCompanies')->andReturn(json_encode([ 'companies' => [ [ 'id' => 1, 'role' => 'admin', ] ] ])); Freee::shouldReceive('deals->getDeals->getDeals')->andReturn([]); $user = factory(User::class)->create(); $response = $this->actingAs($user) ->get(route('me_facade')); $response->assertStatus(200) ->assertViewHas(['user', 'deals']) ->assertSeeText($user->email); } ``` ### Trait [](#trait) 「traitで機能の有効化」で一段とLaravelらしくなる。 Userモデルに`FreeeSDK`traitを追加。`tokenForFreee()`でtokenを返す。 ``` use Revolution\Freee\Traits\FreeeSDK; class User { use FreeeSDK; /** * @param string $driver * * @return string */ protected function tokenForFreee(string $driver): string { return $this->token ?? ''; } } ``` ``` public function meTrait(Request $request) { $user = $request->user(); // $user->freee()はconfigをセット済のAccountingClientなので後は同じ。freee()もaccountingがデフォルト。 // 他のSDKにも対応したら$user->freee('custom')->で使用。 $companiesResponse = json_decode($user->freee()->companies()->getCompanies(), true); $targetCompanyId = $companiesResponse['companies'][0]['id']; $limit = 5; $deals = $user->freee()->deals()->getDeals( $targetCompanyId, null, null, null, null, null, null, null, null, null, null, null, null, $limit)->getDeals(); return view('account.me', compact('user', 'deals')); } ``` ### Traitのテスト [](#traitのテスト) ``` public function testMeTrait() { // freee()内では毎回driver()->config()が実行されているのでモック時にも必要 Freee::shouldReceive('driver->config->companies->getCompanies')->andReturn(json_encode([ 'companies' => [ [ 'id' => 1, 'role' => 'admin', ] ] ])); Freee::shouldReceive('driver->config->deals->getDeals->getDeals')->andReturn([]); $user = factory(User::class)->create(); $response = $this->actingAs($user) ->get(route('me_trait')); $response->assertStatus(200) ->assertViewHas(['user', 'deals']) ->assertSeeText($user->email); } ``` ### Macro [](#macro) Laravelのmacroと同じなのでどんなメソッドでも追加可能。 `AppServiceProvider@boot`などで定義。 ``` use Revolution\Freee\Facades\Freee; class AppServiceProvider extends ServiceProvider { public function boot() { // AccountingClientへのmacroの追加なことに注意。 // 他のSDKにも対応した場合はFreee::driver('')->macro() Freee::macro('getCompanyId', function ($index = 0) { $companiesApi = $this->companies(); $companiesResponse = $companiesApi->getCompanies(); return $companiesResponse->getCompanies()[$index]->getId(); }); Freee::driver()->macro('getDeals', function ($company_id, $limit = 5) { $dealsApi = $this->deals(); $dealsResponse = $dealsApi->getDeals( $company_id, null, null, null, null, null, null, null, null, null, null, null, null, $limit); return $dealsResponse->getDeals(); }); } } ``` ``` public function meMacro(Request $request) { $user = $request->user(); // 長いコードをmacroに追い出したのでこれだけで済む $company_id = $user->freee()->getCompanyId(); $deals = $user->freee()->getDeals($company_id); return view('account.me', compact('user', 'deals')); } ``` ### Macroのテスト [](#macroのテスト) ``` public function testMeMacro() { // freee()なのでdriver->configは必要だけどその後はmacroのメソッドのみ Freee::shouldReceive('driver->config->getCompanyId')->andReturn(0); Freee::shouldReceive('driver->config->getDeals')->andReturn([]); $user = factory(User::class)->create(); $response = $this->actingAs($user) ->get(route('me_macro')); $response->assertStatus(200) ->assertSeeText($user->email); } ``` ### refreshToken [](#refreshtoken) access tokenの有効期限は24時間。`Freee::refreshToken()`で更新。 ``` public function refresh(Request $request) { $response = Freee::refreshToken($request->user()->refresh_token); $request->user()->fill([ 'token' => $response['access_token'] ?? '', 'refresh_token' => $response['refresh_token'] ?? '', 'expired_at' => now()->addSeconds($response['expires_in']), ])->save(); return back(); } ``` ### Laravel外で使う [](#laravel外で使う) ``` use Freee\Accounting\Configuration; use Revolution\Freee\Drivers\AccountingClient; $freee = new AccountingClient(['client_id' => '', 'client_secret' => '']); $config = Configuration::getDefaultConfiguration()->setAccessToken('token'); $freee->config($config); $companiesResponse = json_decode($freee->companies()->getCompanies(), true); ``` LICENCE ------- [](#licence) MIT ### Health Score 28 — LowBetter than 54% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity6 Limited adoption so far Community7 Small or concentrated contributor base Maturity67 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~33 days Recently: every ~49 days Total 8 Last Release 2084d ago ### Community Maintainers ![](https://avatars.githubusercontent.com/u/77618633?v=4)[Revolution](/maintainers/revolution)[@Revolution](https://github.com/Revolution) --- Top Contributors [![kawax](https://avatars.githubusercontent.com/u/1502086?v=4)](https://github.com/kawax "kawax (21 commits)") --- Tags laravelfreeefreee-accounting ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/revolution-laravel-freee-sdk/health.svg) ``` [![Health](https://phpackages.com/badges/revolution-laravel-freee-sdk/health.svg)](https://phpackages.com/packages/revolution-laravel-freee-sdk) ``` ### Alternatives [andreaselia/laravel-api-to-postman Generate a Postman collection automatically from your Laravel API 1.0k586.2k3](/packages/andreaselia-laravel-api-to-postman)[mollie/laravel-mollie Mollie API client wrapper for Laravel & Mollie Connect provider for Laravel Socialite 3624.1M28](/packages/mollie-laravel-mollie)[api-ecosystem-for-laravel/dingo-api A RESTful API package for the Laravel and Lumen frameworks. 3121.5M10](/packages/api-ecosystem-for-laravel-dingo-api)[essa/api-tool-kit set of tools to build an api with laravel 52680.5k](/packages/essa-api-tool-kit)[mll-lab/laravel-graphiql Easily integrate GraphiQL into your Laravel project 683.2M9](/packages/mll-lab-laravel-graphiql)[kirschbaum-development/laravel-openapi-validator Automatic OpenAPI validation for Laravel HTTP tests 581.1M5](/packages/kirschbaum-development-laravel-openapi-validator) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)