board APIファーストガイド

APIの仕様はAPIドキュメントに記載されていますが、当ヘルプでは、board APIを利用するにあたって、データの関連等の全体像を把握することを目的としていますので、APIドキュメントをご覧になる前にお読み頂くとスムーズです。

なお、機能的な仕様の詳細については、それぞれ該当するヘルプをご覧ください。

 

案件と発注

boardのトランザクションデータは、大きく「案件」と「発注」に分類されます。

案件は、受注や請求のための機能で、顧客へ発行する見積書や請求書などの書類を作成することができます。

発注は、発注や支払のための機能で、取引先への発注書などの書類を作成することができます。

 

当ヘルプでは、「案件」の例で説明していきますが、発注でも基本的な構造は同じですので、適宜読み替えてお読みください。

 

案件と書類の関係

boardでは、見積書や請求書などの各書類を「案件ごと」に管理する仕組みになっています。そのため、必ず「案件」が存在し、それに紐付く形で見積書や請求書などの各書類のデータが存在します。見積書や請求書などの書類単体では作成することはできません。

また、案件には一括請求・定期請求・分割請求という3つのタイプがあり、定期請求・分割請求の場合、納品書・検収書・請求書・領収書は1案件内に複数枚あります。

 

なお、発注書と発注請書、納品書と検収書は対になる書類のためデータは共通で、データ構造としては以下のような形になります。
*発注請書は発注書(orders)のデータ、検収書は納品書(deliveries)のデータを使用して出力されます。

 

案件と請求

前述の通り、定期請求・分割請求においては1案件で複数の請求を行うため、案件と請求は1:Nの関係になります。

そのため、画面上では、

案件一覧:1行1案件
請求一覧:1行1請求

となっており、APIでは、

案件リスト取得:1レコード1案件
請求リスト取得:1レコード1請求

となります。

 

機能的な仕様

APIドキュメントでは、boardの機能的な仕様の説明の記載はありませんので、機能的な仕様の把握には、ヘルプをご覧ください。

以下、APIの利用に際して関連しそうな機能のうち、基本的な仕様の理解に役立つヘルプをピックアップします。

 

認証・認可

APIキーとAPIトークンの2つがあり、リクエストの際に両方を指定する必要があります。

発行方法についてはヘルプ「board APIを利用する」をご覧ください。

 

よくあるご質問

■見積書や請求書の新規作成(POST)がありません

前述の通り、boardでは、見積書や請求書などの各書類を「案件ごと」に管理する仕組みのため、書類単体で作成するという概念はなく、案件を作成すると、その中に、見積書や請求書などが空の状態で作成されます。

そのため、見積書や請求書を作成するにあたっては、まずは案件を登録してください。そのレスポンスの中に、各書類のIDが含まれていますので、それを各書類の更新APIで指定して書類の内容を登録してください。

 

■APIキー、APIトークンを指定しているのにエラーになります

以下のお間違えがないかご確認ください。

  • APIキーとAPIトークンが逆になっている
  • APIトークンの前に「Bearer 」が指定されていない
  • APIキーまたはAPIトークンのどちらかしか指定されていない

 

ステータスおよびレスポンスボディによって、以下のように切り分けができます。

ステータス レスポンスボディのmessage 考えられる原因
401 APIキーまたはAPIトークンが無効です。
  • APIトークン(Authorizationヘッダ)が指定されていないか、正しくない
  • Authorizationヘッダに「Bearer」が未指定
  • API設定画面でAPIトークンが「無効」になっている
403 Forbidden
  • APIキー(x-api-keyヘッダ)が指定されていないか、正しくない
403 許可されていません。
  • API設定で「アクセス可能な操作」にチェックが入っていない

 

■curlコマンド(その他特定の言語・ライブラリ)での書き方を教えてください

申し訳ありませんが、技術サポートは提供しておりませんので、API呼び出し元の具体的な記述に関しては、サポートにお問い合わせ頂いてもお答えできませんのでご了承ください。

 

■見積書や請求書APIのURLパラメータに指定するidはどこで取得できますか

見積書や請求書などの書類は、案件に紐付く情報になりますので、案件登録APIのレスポンスに、それぞれの書類ごとの情報が返ってきます。

たとえば、請求書の場合は、下記のような形です。

{
    "id": 1,
    "project_no": 1001,
    ……,
    "invoices": [
      {
        "id": 111111,
        ……
      },
      {
        "id": 111112,
        ……
      },
    ]
}  

 

前述の通り、書類ごとに、案件に対して1:1か1:Nかが変わってきますのでご注意ください。

 

また、案件登録時だけでなく、「案件リスト取得」「案件の取得」でレスポンスグループに「invoice」などの書類の種類を指定することで、上記と同様の形で取得することができます。

 

■より詳細なドキュメントを開示してください

申し訳ありませんが、現状、APIドキュメントとして公開しているものがすべてとなり、別途それ以上のドキュメントは用意しておりませんのでご了承ください。

 

■テスト環境・サンドボックス環境はありますか

申し訳ありませんが、現状ではテスト環境は用意しておりませんので、実際のアカウントでお使い頂くか、別アカウントを取得するかでご対応頂けますでしょうか。

 

APIに関するお問い合わせのお願い・注意事項

  • APIに関するお問い合わせは、通常のお問い合わせ窓口より承っていますが、APIを使った実装に関する技術サポートは提供しておりません。curlコマンドや特定言語・ライブラリでの書き方をご質問頂くことがありますが、具体的な実装・書き方に関するご質問やレビュー依頼には対応できませんので、あらかじめご了承ください。

  • 何かうまくいかない場合、具体的なリクエスト・レスポンスの内容を合わせてご質問をお願いします。なお、その際、APIキー・APIトークンはダミーの内容に置き換えて頂きますようお願い致します。

  • APIを使った場合でも、基本的な仕様は画面側と同様です。基本的な仕様についてはAPIドキュメントには記載がありませんので、仕様の確認には、当記事およびその他ヘルプをご参照ください。


‹‹ APIで請求書等の書類を作成する
一覧に戻る