Skip to content
This repository was archived by the owner on Jul 24, 2023. It is now read-only.

Latest commit

 

History

History
317 lines (219 loc) · 9.88 KB

WalletablesApi.md

File metadata and controls

317 lines (219 loc) · 9.88 KB

Freee\Accounting\WalletablesApi

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

Method HTTP request Description
createWalletable() POST /api/1/walletables 口座の作成
destroyWalletable() DELETE /api/1/walletables/{type}/{id} 口座の削除
getWalletable() GET /api/1/walletables/{type}/{id} 口座の取得
getWalletables() GET /api/1/walletables 口座一覧の取得
updateWalletable() PUT /api/1/walletables/{type}/{id} 口座の更新

createWalletable()

createWalletable($walletable_create_params): \Freee\Accounting\Model\WalletableCreateResponse

口座の作成

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\WalletablesApi(
    // 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
);
$walletable_create_params = new \Freee\Accounting\Model\WalletableCreateParams(); // \Freee\Accounting\Model\WalletableCreateParams | 口座の作成

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

Parameters

Name Type Description Notes
walletable_create_params \Freee\Accounting\Model\WalletableCreateParams 口座の作成 [optional]

Return type

\Freee\Accounting\Model\WalletableCreateResponse

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]

destroyWalletable()

destroyWalletable($id, $type, $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\WalletablesApi(
    // 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
$type = 'type_example'; // string | 口座種別（bank_account : 銀行口座, credit_card : クレジットカード, wallet : その他の決済口座）
$company_id = 56; // int | 事業所ID

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

Parameters

Name Type Description Notes
id int 口座ID
type string 口座種別（bank_account : 銀行口座, credit_card : クレジットカード, wallet : その他の決済口座）
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]

getWalletable()

getWalletable($id, $type, $company_id): \Freee\Accounting\Model\InlineResponse20016

口座の取得

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\WalletablesApi(
    // 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
$type = 'type_example'; // string | 口座種別（bank_account : 銀行口座, credit_card : クレジットカード, wallet : その他の決済口座）
$company_id = 56; // int | 事業所ID

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

Parameters

Name Type Description Notes
id int 口座ID
type string 口座種別（bank_account : 銀行口座, credit_card : クレジットカード, wallet : その他の決済口座）
company_id int 事業所ID

Return type

\Freee\Accounting\Model\InlineResponse20016

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]

getWalletables()

getWalletables($company_id, $with_balance, $type): \Freee\Accounting\Model\InlineResponse20015

口座一覧の取得

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\WalletablesApi(
    // 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
$with_balance = True; // bool | 残高情報を含める
$type = 'type_example'; // string | 口座種別（bank_account : 銀行口座, credit_card : クレジットカード, wallet : その他の決済口座）

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

Parameters

Name Type Description Notes
company_id int 事業所ID
with_balance bool 残高情報を含める [optional]
type string 口座種別（bank_account : 銀行口座, credit_card : クレジットカード, wallet : その他の決済口座） [optional]

Return type

\Freee\Accounting\Model\InlineResponse20015

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]

updateWalletable()

updateWalletable($id, $type, $walletable_update_params): \Freee\Accounting\Model\InlineResponse20016

口座の更新

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\WalletablesApi(
    // 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
$type = 'type_example'; // string | 口座種別（bank_account : 銀行口座, credit_card : クレジットカード, wallet : その他の決済口座）
$walletable_update_params = new \Freee\Accounting\Model\WalletableUpdateParams(); // \Freee\Accounting\Model\WalletableUpdateParams | 口座の更新

try {
    $result = $apiInstance->updateWalletable($id, $type, $walletable_update_params);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WalletablesApi->updateWalletable: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
id int
type string 口座種別（bank_account : 銀行口座, credit_card : クレジットカード, wallet : その他の決済口座）
walletable_update_params \Freee\Accounting\Model\WalletableUpdateParams 口座の更新 [optional]

Return type

\Freee\Accounting\Model\InlineResponse20016

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]