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

Latest commit

 

History

History
555 lines (516 loc) · 47.3 KB

README_auto-generated.md

File metadata and controls

555 lines (516 loc) · 47.3 KB

OpenAPIClient-php

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Installation & Usage

Requirements

PHP 7.3 and later. Should also work with PHP 8.0 but has not been tested.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/freee/freee-accounting-sdk-php.git"
    }
  ],
  "require": {
    "freee/freee-accounting-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?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\AccountItemsApi(
    // 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
);
$account_item_create_params = new \Freee\Accounting\Model\AccountItemCreateParams(); // \Freee\Accounting\Model\AccountItemCreateParams | 勘定科目の作成

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

API Endpoints

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

Class Method HTTP request Description
AccountItemsApi createAccountItem POST /api/1/account_items 勘定科目の作成
AccountItemsApi destroyAccountItem DELETE /api/1/account_items/{id} 勘定科目の削除
AccountItemsApi getAccountItem GET /api/1/account_items/{id} 勘定科目の取得
AccountItemsApi getAccountItems GET /api/1/account_items 勘定科目一覧の取得
AccountItemsApi updateAccountItem PUT /api/1/account_items/{id} 勘定科目の更新
ApprovalFlowRoutesApi getApprovalFlowRoute GET /api/1/approval_flow_routes/{id} 申請経路の取得
ApprovalFlowRoutesApi getApprovalFlowRoutes GET /api/1/approval_flow_routes 申請経路一覧の取得
ApprovalRequestsApi createApprovalRequest POST /api/1/approval_requests 各種申請の作成
ApprovalRequestsApi destroyApprovalRequest DELETE /api/1/approval_requests/{id} 各種申請の削除
ApprovalRequestsApi getApprovalRequest GET /api/1/approval_requests/{id} 各種申請の取得
ApprovalRequestsApi getApprovalRequestForm GET /api/1/approval_requests/forms/{id} 各種申請の申請フォームの取得
ApprovalRequestsApi getApprovalRequestForms GET /api/1/approval_requests/forms 各種申請の申請フォーム一覧の取得
ApprovalRequestsApi getApprovalRequests GET /api/1/approval_requests 各種申請一覧の取得
ApprovalRequestsApi updateApprovalRequest PUT /api/1/approval_requests/{id} 各種申請の更新
ApprovalRequestsApi updateApprovalRequestAction POST /api/1/approval_requests/{id}/actions 各種申請の承認操作
BanksApi getBank GET /api/1/banks/{id} 連携サービスの取得
BanksApi getBanks GET /api/1/banks 連携サービス一覧の取得
CompaniesApi getCompanies GET /api/1/companies 事業所一覧の取得
CompaniesApi getCompany GET /api/1/companies/{id} 事業所の取得
DealsApi createDeal POST /api/1/deals 取引（収入・支出）の作成
DealsApi destroyDeal DELETE /api/1/deals/{id} 取引（収入・支出）の削除
DealsApi getDeal GET /api/1/deals/{id} 取引（収入・支出）の取得
DealsApi getDeals GET /api/1/deals 取引（収入・支出）一覧の取得
DealsApi updateDeal PUT /api/1/deals/{id} 取引（収入・支出）の更新
ExpenseApplicationLineTemplatesApi createExpenseApplicationLineTemplate POST /api/1/expense_application_line_templates 経費科目の作成
ExpenseApplicationLineTemplatesApi destroyExpenseApplicationLineTemplate DELETE /api/1/expense_application_line_templates/{id} 経費科目の削除
ExpenseApplicationLineTemplatesApi getExpenseApplicationLineTemplate GET /api/1/expense_application_line_templates/{id} 経費科目の取得
ExpenseApplicationLineTemplatesApi getExpenseApplicationLineTemplates GET /api/1/expense_application_line_templates 経費科目一覧の取得
ExpenseApplicationLineTemplatesApi updateExpenseApplicationLineTemplate PUT /api/1/expense_application_line_templates/{id} 経費科目の更新
ExpenseApplicationsApi createExpenseApplication POST /api/1/expense_applications 経費申請の作成
ExpenseApplicationsApi destroyExpenseApplication DELETE /api/1/expense_applications/{id} 経費申請の削除
ExpenseApplicationsApi getExpenseApplication GET /api/1/expense_applications/{id} 経費申請詳細の取得
ExpenseApplicationsApi getExpenseApplications GET /api/1/expense_applications 経費申請一覧の取得
ExpenseApplicationsApi updateExpenseApplication PUT /api/1/expense_applications/{id} 経費申請の更新
ExpenseApplicationsApi updateExpenseApplicationAction POST /api/1/expense_applications/{id}/actions 経費申請の承認操作
InvoicesApi createInvoice POST /api/1/invoices 請求書の作成
InvoicesApi destroyInvoice DELETE /api/1/invoices/{id} 請求書の削除
InvoicesApi getInvoice GET /api/1/invoices/{id} 請求書の取得
InvoicesApi getInvoices GET /api/1/invoices 請求書一覧の取得
InvoicesApi updateInvoice PUT /api/1/invoices/{id} 請求書の更新
ItemsApi createItem POST /api/1/items 品目の作成
ItemsApi destroyItem DELETE /api/1/items/{id} 品目の削除
ItemsApi getItem GET /api/1/items/{id} 品目の取得
ItemsApi getItems GET /api/1/items 品目一覧の取得
ItemsApi updateItem PUT /api/1/items/{id} 品目の更新
JournalsApi downloadJournal GET /api/1/journals/reports/{id}/download 仕訳帳のダウンロード
JournalsApi getJournalStatus GET /api/1/journals/reports/{id}/status 仕訳帳のステータスの取得
JournalsApi getJournals GET /api/1/journals 仕訳帳のダウンロード要求
ManualJournalsApi createManualJournal POST /api/1/manual_journals 振替伝票の作成
ManualJournalsApi destroyManualJournal DELETE /api/1/manual_journals/{id} 振替伝票の削除
ManualJournalsApi getManualJournal GET /api/1/manual_journals/{id} 振替伝票の取得
ManualJournalsApi getManualJournals GET /api/1/manual_journals 振替伝票一覧の取得
ManualJournalsApi updateManualJournal PUT /api/1/manual_journals/{id} 振替伝票の更新
PartnersApi createPartner POST /api/1/partners 取引先の作成
PartnersApi destroyPartner DELETE /api/1/partners/{id} 取引先の削除
PartnersApi getPartner GET /api/1/partners/{id} 取引先の取得
PartnersApi getPartners GET /api/1/partners 取引先一覧の取得
PartnersApi updatePartner PUT /api/1/partners/{id} 取引先の更新
PartnersApi updatePartnerByCode PUT /api/1/partners/code/{code} 取引先の更新
PaymentRequestsApi createPaymentRequest POST /api/1/payment_requests 支払依頼の作成
PaymentRequestsApi destroyPaymentRequest DELETE /api/1/payment_requests/{id} 支払依頼の削除
PaymentRequestsApi getPaymentRequest GET /api/1/payment_requests/{id} 支払依頼の取得
PaymentRequestsApi getPaymentRequests GET /api/1/payment_requests 支払依頼一覧の取得
PaymentRequestsApi updatePaymentRequest PUT /api/1/payment_requests/{id} 支払依頼の更新
PaymentRequestsApi updatePaymentRequestAction POST /api/1/payment_requests/{id}/actions 支払依頼の承認操作
PaymentsApi createDealPayment POST /api/1/deals/{id}/payments 取引（収入・支出）の支払行の作成
PaymentsApi destroyDealPayment DELETE /api/1/deals/{id}/payments/{payment_id} 取引（収入・支出）の支払行の削除
PaymentsApi updateDealPayment PUT /api/1/deals/{id}/payments/{payment_id} 取引（収入・支出）の支払行の更新
QuotationsApi createQuotation POST /api/1/quotations 見積書の作成
QuotationsApi destroyQuotation DELETE /api/1/quotations/{id} 見積書の削除
QuotationsApi getQuotation GET /api/1/quotations/{id} 見積書の取得
QuotationsApi getQuotations GET /api/1/quotations 見積書一覧の取得
QuotationsApi updateQuotation PUT /api/1/quotations/{id} 見積書の更新
ReceiptsApi createReceipt POST /api/1/receipts ファイルボックス（証憑ファイル）のアップロード
ReceiptsApi destroyReceipt DELETE /api/1/receipts/{id} ファイルボックス（証憑ファイル）の削除
ReceiptsApi downloadReceipt GET /api/1/receipts/{id}/download ファイルボックス（証憑ファイル）のダウンロード
ReceiptsApi getReceipt GET /api/1/receipts/{id} ファイルボックス（証憑ファイル）の取得
ReceiptsApi getReceipts GET /api/1/receipts ファイルボックス（証憑ファイル）一覧の取得
ReceiptsApi updateReceipt PUT /api/1/receipts/{id} ファイルボックス（証憑ファイル）の更新
RenewsApi createDealRenew POST /api/1/deals/{id}/renews 取引（収入・支出）の+更新の作成
RenewsApi deleteDealRenew DELETE /api/1/deals/{id}/renews/{renew_id} 取引（収入・支出）の+更新の削除
RenewsApi updateDealRenew PUT /api/1/deals/{id}/renews/{renew_id} 取引（収入・支出）の+更新の更新
SectionsApi createSection POST /api/1/sections 部門の作成
SectionsApi destroySection DELETE /api/1/sections/{id} 部門の削除
SectionsApi getSection GET /api/1/sections/{id} 部門の取得
SectionsApi getSections GET /api/1/sections 部門一覧の取得
SectionsApi updateSection PUT /api/1/sections/{id} 部門の更新
SegmentTagsApi createSegmentTag POST /api/1/segments/{segment_id}/tags セグメントタグの作成
SegmentTagsApi destroySegmentsTag DELETE /api/1/segments/{segment_id}/tags/{id} セグメントタグの削除
SegmentTagsApi getSegmentTags GET /api/1/segments/{segment_id}/tags セグメントタグ一覧の取得
SegmentTagsApi updateSegmentTag PUT /api/1/segments/{segment_id}/tags/{id} セグメントタグの更新
SelectablesApi getFormsSelectables GET /api/1/forms/selectables フォーム用選択項目情報の取得
TagsApi createTag POST /api/1/tags メモタグの作成
TagsApi destroyTag DELETE /api/1/tags/{id} メモタグの削除
TagsApi getTag GET /api/1/tags/{id} メモタグの取得
TagsApi getTags GET /api/1/tags メモタグ一覧の取得
TagsApi updateTag PUT /api/1/tags/{id} メモタグの更新
TaxesApi getTaxCode GET /api/1/taxes/codes/{code} 税区分の取得
TaxesApi getTaxCodes GET /api/1/taxes/codes 税区分一覧の取得
TaxesApi getTaxesCompanies GET /api/1/taxes/companies/{company_id} 指定した事業所の税区分一覧の取得
TransfersApi createTransfer POST /api/1/transfers 取引（振替）の作成
TransfersApi destroyTransfer DELETE /api/1/transfers/{id} 取引（振替）の削除
TransfersApi getTransfer GET /api/1/transfers/{id} 取引（振替）の取得
TransfersApi getTransfers GET /api/1/transfers 取引（振替）一覧の取得
TransfersApi updateTransfer PUT /api/1/transfers/{id} 取引（振替）の更新
TrialBalanceApi getTrialBs GET /api/1/reports/trial_bs 貸借対照表の取得
TrialBalanceApi getTrialBsThreeYears GET /api/1/reports/trial_bs_three_years 貸借対照表(３期間比較)の取得
TrialBalanceApi getTrialBsTwoYears GET /api/1/reports/trial_bs_two_years 貸借対照表(前年比較)の取得
TrialBalanceApi getTrialCr GET /api/1/reports/trial_cr 製造原価報告書の取得
TrialBalanceApi getTrialCrSections GET /api/1/reports/trial_cr_sections 製造原価報告書(部門比較)の取得
TrialBalanceApi getTrialCrSegment1Tags GET /api/1/reports/trial_cr_segment_1_tags 製造原価報告書(セグメント1比較)の取得
TrialBalanceApi getTrialCrSegment2Tags GET /api/1/reports/trial_cr_segment_2_tags 製造原価報告書(セグメント2比較)の取得
TrialBalanceApi getTrialCrSegment3Tags GET /api/1/reports/trial_cr_segment_3_tags 製造原価報告書(セグメント3比較)の取得
TrialBalanceApi getTrialCrThreeYears GET /api/1/reports/trial_cr_three_years 製造原価報告書(３期間比較)の取得
TrialBalanceApi getTrialCrTwoYears GET /api/1/reports/trial_cr_two_years 製造原価報告書(前年比較)の取得
TrialBalanceApi getTrialPl GET /api/1/reports/trial_pl 損益計算書の取得
TrialBalanceApi getTrialPlSections GET /api/1/reports/trial_pl_sections 損益計算書(部門比較)の取得
TrialBalanceApi getTrialPlSegment1Tags GET /api/1/reports/trial_pl_segment_1_tags 損益計算書(セグメント1比較)の取得
TrialBalanceApi getTrialPlSegment2Tags GET /api/1/reports/trial_pl_segment_2_tags 損益計算書(セグメント2比較)の取得
TrialBalanceApi getTrialPlSegment3Tags GET /api/1/reports/trial_pl_segment_3_tags 損益計算書(セグメント3比較)の取得
TrialBalanceApi getTrialPlThreeYears GET /api/1/reports/trial_pl_three_years 損益計算書(３期間比較)の取得
TrialBalanceApi getTrialPlTwoYears GET /api/1/reports/trial_pl_two_years 損益計算書(前年比較)の取得
UsersApi getUsers GET /api/1/users 事業所に所属するユーザー一覧の取得
UsersApi getUsersCapabilities GET /api/1/users/capabilities ログインユーザーの権限の取得
UsersApi getUsersMe GET /api/1/users/me ログインユーザーの取得
UsersApi updateUser PUT /api/1/users/me ログインユーザーの更新
WalletTxnsApi createWalletTxn POST /api/1/wallet_txns 口座明細の作成
WalletTxnsApi destroyWalletTxn DELETE /api/1/wallet_txns/{id} 口座明細の削除
WalletTxnsApi getWalletTxn GET /api/1/wallet_txns/{id} 口座明細の取得
WalletTxnsApi getWalletTxns GET /api/1/wallet_txns 口座明細一覧の取得
WalletablesApi createWalletable POST /api/1/walletables 口座の作成
WalletablesApi destroyWalletable DELETE /api/1/walletables/{type}/{id} 口座の削除
WalletablesApi getWalletable GET /api/1/walletables/{type}/{id} 口座の取得
WalletablesApi getWalletables GET /api/1/walletables 口座一覧の取得
WalletablesApi updateWalletable PUT /api/1/walletables/{type}/{id} 口座の更新

Models

Authorization

oauth2

  • Type: OAuth
  • Flow: accessCode
  • Authorization URL: https://accounts.secure.freee.co.jp/public_api/authorize
  • Scopes:
    • read: データの読み取り
    • write: データの書き込み

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: v1.0
    • Package version: v2.29.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen