APIで請求書等の書類を作成する流れを説明します。
このヘルプでは、API経由で「請求書」を作成するケースで解説しますが、処理の流れは他の書類の場合でも同様ですので、「請求書」の部分を読み替えてください。
1. 案件登録
boardでは、すべての書類は案件ごとに管理する仕組みになっているため、最初に案件登録APIを使って、案件を作成します。
参考：案件登録API
案件登録における必須項目は、「一括請求」「定期請求」「分割請求」によって異なりますので、APIドキュメントでは、共通項目とそれぞれの請求タイミングごとの項目に分けて記載しています。
たとえば、「定期請求」の案件の場合は、「共通＋定期請求のパラメーター」を送信してください。
なお、上記のAPIドキュメントの右カラムにて、それぞれのケースでのリクエストパラメーターのサンプルを記載していますので、それを参考してください。
2. 請求書のIDを取得する
案件登録APIで登録が成功すると、以下のようなレスポンスが返ります。
＊定期請求の例のため請求書ID（invoicesのid）が複数あります
{
"id": 1,
"project_no": 1001,
……,
"invoices": [
{
"id": 111111,
……
},
{
"id": 111112,
……
},
]
}
invoicesのidが請求書IDですので、請求書の内容を登録する際に使用してください。
なお、案件登録時のレスポンス以外にも、「案件リスト取得API」「案件取得API」でも同様の内容を取得することができます。（レスポンスグループを指定してください）
3. 請求書を更新
boardでは、案件登録時に空の書類は自動的に作成されていますので、2で取得した請求書IDを使って「更新」します。
参考：請求書更新API
以下、ケースごとに、board APIの活用例を紹介します。
ケース1：自社のサービスと連携して毎月の請求書を更新
毎月従量制で請求するようなサービスからboard APIを使って請求書を更新するケースは、以下のようにAPIを活用することができます。
1.新規アカウント登録時にboardの顧客・案件を登録
自社のサービス側で新規のアカウントが登録されたら、board APIの顧客登録API・案件登録APIを利用して、board側に顧客・案件を登録します。
案件登録時は、
- 定期請求
- 自動契約更新ON（必要に応じて）
で登録します。
また、「初期費用＋月額費用」という場合は、「初期費用の案件」と「月額費用の案件」を2つ登録すると管理しやすいです。
2.毎月請求書を更新する
金額が確定したら、請求書を更新します。
まずは、請求リストAPIを使って、対象の案件・月の請求書情報を取得します。この際、レスポンスグループにinvoiceを指定すると、請求書IDを取得することができます。
取得した請求書IDを使って、請求書更新APIで内容を登録してください。
‹‹ board APIを利用する board APIファーストガイド ››