Freee\Accounting\ApprovalRequestsApi

All URIs are relative to https://api.freee.co.jp.

Method	HTTP request	Description
createApprovalRequest()	POST /api/1/approval_requests	各種申請の作成
destroyApprovalRequest()	DELETE /api/1/approval_requests/{id}	各種申請の削除
getApprovalRequest()	GET /api/1/approval_requests/{id}	各種申請の取得
getApprovalRequestForm()	GET /api/1/approval_requests/forms/{id}	各種申請の申請フォームの取得
getApprovalRequestForms()	GET /api/1/approval_requests/forms	各種申請の申請フォーム一覧の取得
getApprovalRequests()	GET /api/1/approval_requests	各種申請一覧の取得
updateApprovalRequest()	PUT /api/1/approval_requests/{id}	各種申請の更新
updateApprovalRequestAction()	POST /api/1/approval_requests/{id}/actions	各種申請の承認操作

`createApprovalRequest()`

createApprovalRequest($approval_request_create_params): \Freee\Accounting\Model\ApprovalRequestResponse

各種申請の作成

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = Freee\Accounting\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Freee\Accounting\Api\ApprovalRequestsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$approval_request_create_params = new \Freee\Accounting\Model\ApprovalRequestCreateParams(); // \Freee\Accounting\Model\ApprovalRequestCreateParams | 各種申請の作成

try {
    $result = $apiInstance->createApprovalRequest($approval_request_create_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApprovalRequestsApi->createApprovalRequest: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
approval_request_create_params	\Freee\Accounting\Model\ApprovalRequestCreateParams	各種申請の作成	[optional]

Return type

\Freee\Accounting\Model\ApprovalRequestResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`destroyApprovalRequest()`

destroyApprovalRequest($id, $company_id)

各種申請の削除

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = Freee\Accounting\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Freee\Accounting\Api\ApprovalRequestsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | 各種申請ID
$company_id = 56; // int | 事業所ID

try {
    $apiInstance->destroyApprovalRequest($id, $company_id);
} catch (Exception $e) {
    echo 'Exception when calling ApprovalRequestsApi->destroyApprovalRequest: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	各種申請ID
company_id	int	事業所ID

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getApprovalRequest()`

getApprovalRequest($id, $company_id): \Freee\Accounting\Model\ApprovalRequestResponse

各種申請の取得

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = Freee\Accounting\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Freee\Accounting\Api\ApprovalRequestsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | 各種申請ID
$company_id = 56; // int | 事業所ID

try {
    $result = $apiInstance->getApprovalRequest($id, $company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApprovalRequestsApi->getApprovalRequest: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	各種申請ID
company_id	int	事業所ID

Return type

\Freee\Accounting\Model\ApprovalRequestResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getApprovalRequestForm()`

getApprovalRequestForm($id, $company_id): \Freee\Accounting\Model\ApprovalRequestFormResponse

各種申請の申請フォームの取得

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = Freee\Accounting\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Freee\Accounting\Api\ApprovalRequestsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | 申請フォームID
$company_id = 56; // int | 事業所ID

try {
    $result = $apiInstance->getApprovalRequestForm($id, $company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApprovalRequestsApi->getApprovalRequestForm: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	申請フォームID
company_id	int	事業所ID

Return type

\Freee\Accounting\Model\ApprovalRequestFormResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getApprovalRequestForms()`

getApprovalRequestForms($company_id): \Freee\Accounting\Model\ApprovalRequestFormIndexResponse

各種申請の申請フォーム一覧の取得

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = Freee\Accounting\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Freee\Accounting\Api\ApprovalRequestsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$company_id = 56; // int | 事業所ID

try {
    $result = $apiInstance->getApprovalRequestForms($company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApprovalRequestsApi->getApprovalRequestForms: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
company_id	int	事業所ID

Return type

\Freee\Accounting\Model\ApprovalRequestFormIndexResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getApprovalRequests()`

getApprovalRequests($company_id, $status, $application_number, $title, $form_id, $start_application_date, $end_application_date, $applicant_id, $min_amount, $max_amount, $approver_id, $offset, $limit): \Freee\Accounting\Model\ApprovalRequestsIndexResponse

各種申請一覧の取得

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = Freee\Accounting\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Freee\Accounting\Api\ApprovalRequestsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$company_id = 56; // int | 事業所ID
$status = draft; // string | 申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し) 承認者指定時には無効です。
$application_number = 2; // int | 申請No.
$title = 大阪出張; // string | 申請タイトル
$form_id = 56; // int | 申請フォームID
$start_application_date = 'start_application_date_example'; // string | 申請日で絞込：開始日(yyyy-mm-dd)
$end_application_date = 'end_application_date_example'; // string | 申請日で絞込：終了日(yyyy-mm-dd)
$applicant_id = 56; // int | 申請者のユーザーID
$min_amount = 56; // int | 金額で絞込：以上
$max_amount = 56; // int | 金額で絞込：以下
$approver_id = 1; // int | 承認者のユーザーID 承認者指定時には申請ステータスが申請中のものだけが取得可能です。
$offset = 56; // int | 取得レコードのオフセット (デフォルト: 0)
$limit = 56; // int | 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 500)

try {
    $result = $apiInstance->getApprovalRequests($company_id, $status, $application_number, $title, $form_id, $start_application_date, $end_application_date, $applicant_id, $min_amount, $max_amount, $approver_id, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApprovalRequestsApi->getApprovalRequests: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
company_id	int	事業所ID
status	string	申請ステータス(draft:下書き, in_progress:申請中, approved:承認済, rejected:却下, feedback:差戻し) 承認者指定時には無効です。	[optional]
application_number	int	申請No.	[optional]
title	string	申請タイトル	[optional]
form_id	int	申請フォームID	[optional]
start_application_date	string	申請日で絞込：開始日(yyyy-mm-dd)	[optional]
end_application_date	string	申請日で絞込：終了日(yyyy-mm-dd)	[optional]
applicant_id	int	申請者のユーザーID	[optional]
min_amount	int	金額で絞込：以上	[optional]
max_amount	int	金額で絞込：以下	[optional]
approver_id	int	承認者のユーザーID 承認者指定時には申請ステータスが申請中のものだけが取得可能です。	[optional]
offset	int	取得レコードのオフセット (デフォルト: 0)	[optional]
limit	int	取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 500)	[optional]

Return type

\Freee\Accounting\Model\ApprovalRequestsIndexResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateApprovalRequest()`

updateApprovalRequest($id, $approval_request_update_params): \Freee\Accounting\Model\ApprovalRequestResponse

各種申請の更新

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = Freee\Accounting\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Freee\Accounting\Api\ApprovalRequestsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | 各種申請ID
$approval_request_update_params = new \Freee\Accounting\Model\ApprovalRequestUpdateParams(); // \Freee\Accounting\Model\ApprovalRequestUpdateParams | 各種申請の更新

try {
    $result = $apiInstance->updateApprovalRequest($id, $approval_request_update_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApprovalRequestsApi->updateApprovalRequest: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	各種申請ID
approval_request_update_params	\Freee\Accounting\Model\ApprovalRequestUpdateParams	各種申請の更新

Return type

\Freee\Accounting\Model\ApprovalRequestResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateApprovalRequestAction()`

updateApprovalRequestAction($id, $approval_request_action_create_params): \Freee\Accounting\Model\ApprovalRequestResponse

各種申請の承認操作

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure OAuth2 access token for authorization: oauth2
$config = Freee\Accounting\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Freee\Accounting\Api\ApprovalRequestsApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | 各種申請ID
$approval_request_action_create_params = new \Freee\Accounting\Model\ApprovalRequestActionCreateParams(); // \Freee\Accounting\Model\ApprovalRequestActionCreateParams | 各種申請の承認操作

try {
    $result = $apiInstance->updateApprovalRequestAction($id, $approval_request_action_create_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApprovalRequestsApi->updateApprovalRequestAction: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	各種申請ID
approval_request_action_create_params	\Freee\Accounting\Model\ApprovalRequestActionCreateParams	各種申請の承認操作

Return type

\Freee\Accounting\Model\ApprovalRequestResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

ApprovalRequestsApi.md

Latest commit

History

ApprovalRequestsApi.md

File metadata and controls

Freee\Accounting\ApprovalRequestsApi

createApprovalRequest()

Example

Parameters

Return type

Authorization

HTTP request headers

destroyApprovalRequest()

Example

Parameters

Return type

Authorization

HTTP request headers

getApprovalRequest()

Example

Parameters

Return type

Authorization

HTTP request headers

getApprovalRequestForm()

Example

Parameters

Return type

Authorization

HTTP request headers

getApprovalRequestForms()

Example

Parameters

Return type

Authorization

HTTP request headers

getApprovalRequests()

Example

Parameters

Return type

Authorization

HTTP request headers

updateApprovalRequest()

Example

Parameters

Return type

Authorization

HTTP request headers

updateApprovalRequestAction()

Example

Parameters

Return type

Authorization

HTTP request headers

`createApprovalRequest()`

`destroyApprovalRequest()`

`getApprovalRequest()`

`getApprovalRequestForm()`

`getApprovalRequestForms()`

`getApprovalRequests()`

`updateApprovalRequest()`

`updateApprovalRequestAction()`