freee Util

freee API用ユーティリティです。認証やAPIクライアント、各リクエストオブジェクトを提供します。

Freee について

freee
freee Developers Community

インストール

composer require ippey/freee-util

利用方法

認証

認可コード生成URL取得

$clientId = 'some client id';
$redirectUri = 'https://www.google.co.jp';
$responseType = 'code'; // default is "code"
$url = Ippey\FreeeUtil\FreeeUtil::getAuthorizationUri(
    $clientId,
    $redirecturi,
    $responseType
);
header('Location:' . $url);

アクセストークン取得

$clientId = 'some client id';
$clientSecret = 'some client secret';
$code = 'authorization code'; // 認可コード生成URLでアクセスして、取得したコード
$erdirectUri = 'https://www.google.co.jp';
$api = Ippey\FreeeUtil\FreeeUtil::getApiClinet();
$request = new Ippey\FreeeUtil\Request\Auth\TokenRequest();
$request->setParameter('client_id', $clientId);
$request->setParameter('client_secret', $clientSecret);
$request->setParameetr('code', $code);
$request->setParameter('redirect_uri', $redirectUri);
$response = $api->sendRequest($request);
print_r($response->getBody()->access_token);
print_r($response->getBody()->refresh_token);

アクセストークン再取得

$clientId = 'some client id';
$clientSecret = 'some client secret';
$refreshToken = 'some refresh token'; // アクセストークン取得結果内のrefresh_token
$redirectUri = 'https://www.google.co.jp';
$api = Ippey\FreeeUtil\FreeeUtil::getApiClinet();
$request = new Ippey\FreeeUtil\Request\Auth\RefreshRequest();
$request->setParameter('client_id', $clientId);
$request->setParameter('client_secret', $clientSecret);
$request->setParameter('refresh_token', $refreshToken);
$request->setParameter('redirect_uri', $redirectUri);
$response = $api->sendRequest($request);
print_r($response->getBody()->access_token); // 再生成されています
print_r($response->getBody()->refresh_token); // 再生成されています

勘定科目

勘定科目一覧取得

$accessToken = 'some access token';
$type = 'bank';
$api = Ippey\FreeeUtil\FreeeUtil::getApiClinet();
$request = new Ippey\FreeeUtil\Request\Accounting\AccountItemsRequest();
$request->setAccessToken($accessToken);
$request->setParameter('company_id', 'some coompany id');
$response = $api->sendRequest($request);
print_r($response->getBody());

勘定科目詳細取得

$accessToken = 'some access token';
$type = 'bank';
$api = Ippey\FreeeUtil\FreeeUtil::getApiClinet();
$request = new Ippey\FreeeUtil\Request\Accounting\AccountItems\GetRequest();
$request->setAccessToken($accessToken);
$request->setParameter('company_id', 'some coompany id');
$request->setParameter('id', 'some id');
$response = $api->sendRequest($request);
print_r($response->getBody());

勘定科目追加

$accessToken = 'some access token';
$type = 'bank';
$api = Ippey\FreeeUtil\FreeeUtil::getApiClinet();
$request = new Ippey\FreeeUtil\Request\Accounting\AccountItems\PostRequest();
$request->setAccessToken($accessToken);
$request->setAccessToken($accessToken);
$request->setParameter('company_id', 'some company id');
$request->setItemParameter('name', 'なまえ');
$request->setItemParameter('shortcut', 'SHORTCUT');
$request->setItemParameter('shortcut_num', '999');
$request->setItemParameter('tax_name', '課税売上');
$request->setItemParameter('group_name', 'その他預金');
$request->setItemParameter('account_category', '現金・預金');
$request->setItemParameter('corresponding_income_name', '売掛金');
$request->setItemParameter('corresponding_expense_name', '買掛金');
$request->setItemParameter('accumulated_dep_account_item_name', '減価償却累計額勘定科目');
$request->setItemParameter('searchable', 2);
$response = $api->sendRequest($request);
print_r($response->getBody());

連携サービス

連携サービス一覧取得

$accessToken = 'some access token';
$type = 'bank';
$api = Ippey\FreeeUtil\FreeeUtil::getApiClinet();
$request = new Ippey\FreeeUtil\Request\Accounting\BanksRequest();
$request->setAccessToken($accessToken);
$request->setParameter('type', 'bank');
$response = $api->sendRequest($request);
print_r($response->getBody());

ユーザ

ログインユーザ情報取得

$accessToken = 'some access token';
$companies = true;
$api = Ippey\FreeeUtil\FreeeUtil::getApiClinet();
$request = new Ippey\FreeeUtil\Request\Account\User\MeRequest();
$request->setParameter('companies', $companies);
$request->setAccessToken($accessToken);
$response = $api->sendRequest($request);
print_r($response->getBody());

ログインユーザ権限情報取得

$accessToken = 'some access token';
$companyId = 12345;
$api = Ippey\FreeeUtil\FreeeUtil::getApiClinet();
$request = new Ippey\FreeeUtil\Request\Account\User\CapabilitiesRequest();
$request->setAccessToken($accessToken);
$request->setParameter('company_id', $companyId);
$response = $api->sendRequest($request);
print_r($response->getBody());