Freee\Accounting\ReceiptsApi

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

Method	HTTP request	Description
createReceipt()	POST /api/1/receipts	ファイルボックス（証憑ファイル）のアップロード
destroyReceipt()	DELETE /api/1/receipts/{id}	ファイルボックス（証憑ファイル）の削除
downloadReceipt()	GET /api/1/receipts/{id}/download	ファイルボックス（証憑ファイル）のダウンロード
getReceipt()	GET /api/1/receipts/{id}	ファイルボックス（証憑ファイル）の取得
getReceipts()	GET /api/1/receipts	ファイルボックス（証憑ファイル）一覧の取得
updateReceipt()	PUT /api/1/receipts/{id}	ファイルボックス（証憑ファイル）の更新

`createReceipt()`

createReceipt($company_id, $receipt, $description, $document_type, $issue_date, $qualified_invoice, $receipt_metadatum_amount, $receipt_metadatum_issue_date, $receipt_metadatum_partner_name): \Freee\Accounting\Model\ReceiptResponse

ファイルボックス（証憑ファイル）のアップロード

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\ReceiptsApi(
    // 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
$receipt = "/path/to/file.txt"; // \SplFileObject | 証憑ファイル
$description = 'description_example'; // string | メモ (255文字以内)
$document_type = 'document_type_example'; // string | この項目はインボイス制度で利用する項目です。2023年4月頃から利用できる予定です。 書類の種類（receipt: 領収書、invoice: 請求書、other: その他）
$issue_date = 'issue_date_example'; // string | 取引日 (yyyy-mm-dd)
$qualified_invoice = 'qualified_invoice_example'; // string | この項目はインボイス制度で利用する項目です。2023年4月頃から利用できる予定です。 適格請求書等（qualified: 該当する、not_qualified: 該当しない、unselected: 未選択）
$receipt_metadatum_amount = 56; // int | 金額
$receipt_metadatum_issue_date = 'receipt_metadatum_issue_date_example'; // string | 発行日 (yyyy-mm-dd)
$receipt_metadatum_partner_name = 'receipt_metadatum_partner_name_example'; // string | 発行元

try {
    $result = $apiInstance->createReceipt($company_id, $receipt, $description, $document_type, $issue_date, $qualified_invoice, $receipt_metadatum_amount, $receipt_metadatum_issue_date, $receipt_metadatum_partner_name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReceiptsApi->createReceipt: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
company_id	int	事業所ID
receipt	\SplFileObject\SplFileObject	証憑ファイル
description	string	メモ (255文字以内)	[optional]
document_type	string	この項目はインボイス制度で利用する項目です。2023年4月頃から利用できる予定です。書類の種類（receipt: 領収書、invoice: 請求書、other: その他）	[optional]
issue_date	string	取引日 (yyyy-mm-dd)	[optional]
qualified_invoice	string	この項目はインボイス制度で利用する項目です。2023年4月頃から利用できる予定です。適格請求書等（qualified: 該当する、not_qualified: 該当しない、unselected: 未選択）	[optional]
receipt_metadatum_amount	int	金額	[optional]
receipt_metadatum_issue_date	string	発行日 (yyyy-mm-dd)	[optional]
receipt_metadatum_partner_name	string	発行元	[optional]

Return type

\Freee\Accounting\Model\ReceiptResponse

Authorization

oauth2

HTTP request headers

Content-Type: multipart/form-data
Accept: application/json

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

`destroyReceipt()`

destroyReceipt($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\ReceiptsApi(
    // 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->destroyReceipt($id, $company_id);
} catch (Exception $e) {
    echo 'Exception when calling ReceiptsApi->destroyReceipt: ', $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]

`downloadReceipt()`

downloadReceipt($id, $company_id): \SplFileObject

ファイルボックス（証憑ファイル）のダウンロード

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\ReceiptsApi(
    // 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->downloadReceipt($id, $company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReceiptsApi->downloadReceipt: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	ファイルボックス（証憑ファイル）ID
company_id	int	事業所ID

Return type

\SplFileObject

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/pdf, image/_*, text/csv, application/json

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

`getReceipt()`

getReceipt($id, $company_id): \Freee\Accounting\Model\ReceiptResponse

ファイルボックス（証憑ファイル）の取得

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\ReceiptsApi(
    // 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->getReceipt($id, $company_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReceiptsApi->getReceipt: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	int	ファイルボックス（証憑ファイル）ID
company_id	int	事業所ID

Return type

\Freee\Accounting\Model\ReceiptResponse

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]

`getReceipts()`

getReceipts($company_id, $start_date, $end_date, $user_name, $number, $comment_type, $comment_important, $category, $offset, $limit): \Freee\Accounting\Model\InlineResponse2005

ファイルボックス（証憑ファイル）一覧の取得

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\ReceiptsApi(
    // 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
$start_date = 'start_date_example'; // string | アップロード日 (yyyy-mm-dd)
$end_date = 'end_date_example'; // string | アップロード日 (yyyy-mm-dd)
$user_name = 'user_name_example'; // string | アップロードしたユーザー名、メールアドレス
$number = 56; // int | アップロードファイルNo
$comment_type = 'comment_type_example'; // string | posted:コメントあり, raised:未解決, resolved:解決済
$comment_important = True; // bool | trueの時、重要コメント付きが対象
$category = 'category_example'; // string | all:すべて、without_deal:未登録、with_expense_application_line:経費申請中, with_deal:登録済み、ignored:無視
$offset = 56; // int | 取得レコードのオフセット (デフォルト: 0)
$limit = 56; // int | 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 3000)

try {
    $result = $apiInstance->getReceipts($company_id, $start_date, $end_date, $user_name, $number, $comment_type, $comment_important, $category, $offset, $limit);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ReceiptsApi->getReceipts: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
company_id	int	事業所ID
start_date	string	アップロード日 (yyyy-mm-dd)
end_date	string	アップロード日 (yyyy-mm-dd)
user_name	string	アップロードしたユーザー名、メールアドレス	[optional]
number	int	アップロードファイルNo	[optional]
comment_type	string	posted:コメントあり, raised:未解決, resolved:解決済	[optional]
comment_important	bool	trueの時、重要コメント付きが対象	[optional]
category	string	all:すべて、without_deal:未登録、with_expense_application_line:経費申請中, with_deal:登録済み、ignored:無視	[optional]
offset	int	取得レコードのオフセット (デフォルト: 0)	[optional]
limit	int	取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 3000)	[optional]

Return type

\Freee\Accounting\Model\InlineResponse2005

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]

`updateReceipt()`

updateReceipt($id, $receipt_update_params): \Freee\Accounting\Model\ReceiptResponse

ファイルボックス（証憑ファイル）の更新

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\ReceiptsApi(
    // 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
$receipt_update_params = new \Freee\Accounting\Model\ReceiptUpdateParams(); // \Freee\Accounting\Model\ReceiptUpdateParams

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

Parameters

Name	Type	Description	Notes
id	int	ファイルボックス（証憑ファイル）ID
receipt_update_params	\Freee\Accounting\Model\ReceiptUpdateParams

Return type

\Freee\Accounting\Model\ReceiptResponse

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

ReceiptsApi.md

Latest commit

History

ReceiptsApi.md

File metadata and controls

Freee\Accounting\ReceiptsApi

createReceipt()

Example

Parameters

Return type

Authorization

HTTP request headers

destroyReceipt()

Example

Parameters

Return type

Authorization

HTTP request headers

downloadReceipt()

Example

Parameters

Return type

Authorization

HTTP request headers

getReceipt()

Example

Parameters

Return type

Authorization

HTTP request headers

getReceipts()

Example

Parameters

Return type

Authorization

HTTP request headers

updateReceipt()

Example

Parameters

Return type

Authorization

HTTP request headers

`createReceipt()`

`destroyReceipt()`

`downloadReceipt()`

`getReceipt()`

`getReceipts()`

`updateReceipt()`