APIリファレンス

APIリファレンス

エンドポイントごとに、送る項目・返る項目・リクエストの例・起こりうるエラーをまとめています。認証や共通の決まりはTooon APIのガイドにあります。

https://tooon.app/api/v1166のエンドポイント

業務データ

自社のワークスペースのデータを扱う入口です。

APIキー1

キーが有効か、どの権限を持つかを確かめる

GET/v1/me
取引合意12

運営会社の合意内容を準備・確認し、連携先で提示する

GET/v1/agreementsPOST/v1/agreementsGET/v1/agreements/{id}
運営会社の経費12

経費の記録・集計・削除・復元と、証憑の情報

GET/v1/expensesPOST/v1/expensesGET/v1/expenses/deleted
運営会社の支払記録3

支払予定・支払済みの記録と明細を取得する

GET/v1/settlementsGET/v1/settlements/{id}GET/v1/…/{id}/lines
パートナー4

発注先・業務委託先と、その事業者情報

GET/v1/partnersPOST/v1/partnersGET/v1/partners/{id}
業務委託契約3

パートナーとの契約(Tooonの「発注」)

POST/v1/partner-ordersGET/v1/partner-orders/{id}PATCH/v1/partner-orders/{id}
請求書作成依頼11

パートナーに請求書を作ってもらう依頼

GET/v1/partner-invoice-requestsPOST/v1/partner-invoice-requestsGET/v1/partner-invoice-requests/{id}
メンバー4

社員・役員・業務委託のスタッフなど会社の人

GET/v1/peoplePOST/v1/peopleGET/v1/people/{id}
メンバーカード6

会社の人のメンバーカードと、その公開

GET/v1/business-cardsPOST/v1/business-cardsGET/v1/business-cards/{id}
取引先4

運営会社の取引先を登録・参照・更新する

GET/v1/clientsPOST/v1/clientsGET/v1/clients/{id}
プロジェクト4

プロジェクトの作成・内容・日程・状態・親子関係

GET/v1/projectsPOST/v1/projectsGET/v1/projects/{id}
タスク5

運営会社のタスク・担当・期日・状態・案件接続

GET/v1/tasksPOST/v1/tasksGET/v1/tasks/assignees
事業者情報・振込先4

運営会社の請求・契約名義と請求書用振込先

GET/v1/business-profileGET/v1/bank-accountPOST/v1/business-profile
見積書・請求書9

運営会社の帳票を準備し、確認後に発行する

GET/v1/invoicesPOST/v1/invoicesGET/v1/invoices/{id}
会社カード1

会社の紹介と、公開中のメニュー・実績

GET/v1/company-page

Tooon Connect

会員自身の事業を扱う入口です。Connect用のキーで呼びます。Tooon Connectのガイド

Connect 会員事業の経費12

会員自身の経費の記録・集計・削除・復元と、証憑の情報

GET/v1/…/accounts/{accountId}/expensesPOST/v1/…/accounts/{accountId}/expensesGET/v1/…/accounts/{accountId}/expenses/deleted
Connect 会員事業の支払記録3

会員自身の支払予定・支払記録を取得する

GET/v1/…/accounts/{accountId}/settlementsGET/v1/…/accounts/{accountId}/settlements/{id}GET/v1/…/accounts/{accountId}/settlements/{id}/lines
Connect 会員事業の取引合意12

会員自身の合意内容を準備・確認し、連携先で提示する

GET/v1/…/accounts/{accountId}/agreementsPOST/v1/…/accounts/{accountId}/agreementsGET/v1/…/accounts/{accountId}/agreements/{id}
Connect 会員事業の請求書作成依頼8

会員自身の発注について、請求書作成依頼を下書きする

GET/v1/…/accounts/{accountId}/partner-invoice-requestsPOST/v1/…/accounts/{accountId}/partner-invoice-requestsGET/v1/…/accounts/{accountId}/partner-invoice-requests/{id}
Connect 会員事業のパートナー4

会員自身の発注先・委託先を管理する

GET/v1/…/accounts/{accountId}/partnersPOST/v1/…/accounts/{accountId}/partnersGET/v1/…/accounts/{accountId}/partners/{id}
Connect 会員事業の発注条件4

会員自身の発注条件を下書きする

GET/v1/…/accounts/{accountId}/partner-ordersPOST/v1/…/accounts/{accountId}/partner-ordersGET/v1/…/accounts/{accountId}/partner-orders/{id}
Connect 会員4

事業ユニットに紐づくサービスの外部会員。会員向けに発行した専用キーを使う

GET/v1/connect/membersPOST/v1/connect/membersPOST/v1/…/members/{externalId}/public-handle
Connect 取引先4

会員自身の事業の取引先を登録・参照・更新する

GET/v1/…/accounts/{accountId}/clientsPOST/v1/…/accounts/{accountId}/clientsGET/v1/…/accounts/{accountId}/clients/{id}
Connect 事業アカウント5

外部会員の事業を運営会社と分けて管理する。作成だけで公開・決済・規約同意は行わない

GET/v1/connect/accountsGET/v1/…/accounts/{id}PATCH/v1/…/accounts/{id}
Connect 会員名刺5

外部会員の名刺を編集・公開する。下書きの保存と公開は別の操作

GET/v1/…/members/{externalId}/business-cardGET/v1/…/cards/{publicHandle}/publicPATCH/v1/…/members/{externalId}/business-card
Connect 会員事業のプロジェクト4

外部会員自身のプロジェクトを管理する

GET/v1/…/accounts/{accountId}/projectsPOST/v1/…/accounts/{accountId}/projectsGET/v1/…/accounts/{accountId}/projects/{id}
Connect 会員事業のタスク5

会員自身のタスクを作成し、本人への担当と進み具合を管理する

GET/v1/…/accounts/{accountId}/tasksPOST/v1/…/accounts/{accountId}/tasksGET/v1/…/accounts/{accountId}/tasks/assignees
Connect 会員事業の事業者情報・振込先4

会員自身の事業者名義と請求書用振込先を管理する

GET/v1/…/accounts/{accountId}/business-profileGET/v1/…/accounts/{accountId}/bank-accountPOST/v1/…/accounts/{accountId}/business-profile
Connect 会員事業の見積書・請求書9

会員自身の帳票を準備し、本人の確認後に発行する

GET/v1/…/accounts/{accountId}/invoicesPOST/v1/…/accounts/{accountId}/invoicesGET/v1/…/accounts/{accountId}/invoices/{id}

このページは、APIの定義(OpenAPI)から自動で作られています。