board APIドキュメント (1.3.0)

Download OpenAPI specification:Download

概要

このドキュメントではboardのAPI仕様について説明します。

board APIファーストガイドではデータ構造などの全体像の解説をしていますので、まずはじめにファーストガイドをご覧いただくとスムーズです。

当ドキュメントではシステムとしての業務仕様の説明はありません。そのため、とくに、普段業務ではboardを利用していない方がAPI用途のみで利用する場合は、当ドキュメントを読み進める前に、案件の概念や、案件との書類の関係などの基本仕様を、ファーストガイドやヘルプで把握しておくことをお勧めします。

CHANGELOG

APIに関する変更履歴はCHANGELOGをご確認ください。

エンドポイント

https://api.the-board.jp/v1/{各エンドポイントのパス}

OpenAPI

当APIドキュメントは、OpenAPIの仕様に沿って作成されています。

ページトップの「Download OpenAPI specification」から、OpenAPI specificationのJSONデータをダウンロードできます。このJSONデータをPostmanなどOpenAPIに対応しているAPI開発ツールの取り込むことができます。

FAQ：OpenAPIのデータをPostmanにインポートする

認証・認可

board APIでは、「APIキー」と「APIトークン」の2つの概念があり、リクエストの際に両方をヘッダーに指定する必要があります。

x-api-key: API-KEY
Authorization: Bearer API-TOKEN

APIキー

アカウントで1つ発行されます。リクエスト制限はこのAPIキー単位で管理されています。

APIトークン

複数発行でき、APIトークンごとに利用可能なエンドポイントを指定できますので、用途に合わせて発行してください。

APIキー（前述の例のAPI-KEY部分）とAPIトークン（前述の例のAPI-TOKEN部分）は、リクエストヘッダーで指定してください。

※セキュリティーのため、トークンごとに可能な操作は最低限必要なもののみに限定することをお勧めします。

APIキー・APIトークンの発行は「開発者用API設定」画面で行えます。当画面の詳しい説明は、ヘルプ「board APIを利用する」をご覧ください。

リクエスト制限

board APIでは、以下のリクエスト制限があります。制限をオーバーした場合は、429 Too Many Requestsが返却されます。

3000リクエスト / 1日
3リクエスト / 秒　（100バーストまで可能）

1日あたりのリクエスト数のリセットタイミングはJSTではなくUTCですのでご注意ください。

※リクエスト数制限の上限緩和には対応していませんのでご了承ください。

秒間リクエスト数について

秒間リクエスト数は、「トークンバケット」という流入量制御の仕組みになっています。

原則「3リクエスト / 秒」ですが、100リクエストまでは、それをオーバーすることが可能です。

デフォルトで、バケットに100トークンあります。これは100回までバーストが可能な状態で、バースト（3リクエスト/秒をオーバー）すると、このトークンが消費されます。

トークンが0になると、バーストできなくなり、「3リクエスト / 秒」以上のリクエストは送信できなくなります。

一定期間バーストがなければ、このトークンは最大100まで補充されます。

データ形式

リクエストとレスポンスのデータ形式は以下の通りです。なお、データの文字コードはすべてUTF-8です。

リクエスト

リクエストのデータ形式は、メソッドによって異なります。

GETリクエストはURLパラメーターで指定します。

/v1/clients?include_archive_flg=1

POST・PATCHリクエストはリクエストボディーにJSON形式で送信してください。また、リクエストヘッダーに

Content-Type: application/json

を指定してください。

Content-Typeが正しくない場合は、415 Unsupported Media Typeが返却されます。

レスポンス

すべてJSON形式です。

レスポンスグループ

案件情報のように項目数が多い場合、すべての項目を返却すると、データ量が多く扱いにくくなってしまいます。

そこで、リクエストパラメーターにレスポンスグループを指定し、取得する項目を絞り込むことができます。

/v1/projects?response_group=medium

なお、すべてのリスト取得APIで利用可能なわけではありませんので、利用可否については、各リスト取得APIの仕様を確認してください。クエリーパラメーターに「response_group」がある場合のみ利用可能です。

【重要】レスポンスグループが指定可能なエンドポイントの場合、デフォルトは「small」で最小限の項目のみ含まれる状態になっています。一方で、APIドキュメント上では定義を示すためにすべての項目を記載していますのでご注意ください。

参考：FAQ「APIのレスポンスに含まれる項目がドキュメントに記載のものより少ないです」

HTTPステータス・エラー

レスポンス内容に応じて、以下のHTTPステータスを返します。

ステータス	内容
200	OK
201	Created
204	No Content
400	Bad Request
401	Unauthorized
403	Forbidden
404	Not Found
415	Unsupported Media Type
422	Unprocessable Entity
429	Too Many Requests
500	Internal Server Error
503	Service Unavailable

主なエラー原因

エラーとなるAPIリクエストがあった場合、エラー内容を含むレスポンスを返します。

ステータス（例：422）で大まかな原因を把握し、詳細なレスポンスボディの例は各APIのレスポンスセクションをご覧ください。

以下、いくつかの特記事項を記載します。

422エラーの場合

主に、バリデーションチェックに引っかかったケースです。この場合、レスポンスボディにエラー内容が返却されていますので、その内容をご確認ください。

401・403エラーの場合

401・403エラーの場合、レスポンス内容によっていくつかの原因が考えられます。

詳しくはboard APIファーストガイドの「APIキー、APIトークンを指定しているのにエラーになります」をご覧ください。

500エラーの場合

FAQ「APIで500エラーが返ってきて原因がわかりません」をご覧ください。

レスポンスが10MBを超えるサイズの場合

board APIはAWS API Gatewayを使用しており、その仕様上、10MBを超えるレスポンスを返すことができません。この上限を超える場合は、500エラーとなり、レスポンスボディには、以下のようにmessageだけが返ります。この場合は、取得対象を絞る等でご対応ください。

{ "message": "Internal server error" }

メンテナンス

メンテナンス時は、503ステータスを返します。レスポンスボディはメンテナンス内容に依存し変わる可能性があるため、ステータスで判別してください。

なお、障害時も503ステータスが返る可能性があります。

サポート・FAQ

ヘルプ・FAQ

boardのヘルプ・FAQのAPIカテゴリーをご覧ください。

お問い合わせ

APIに関するお問い合わせも、通常のサポート窓口で承っております。

お問い合わせ方法について

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

APIの仕様に関するご質問には対応可能ですが、APIを使った実装に関する技術的なサポートは提供しておりません。具体的な実装・書き方や特定のツールに関するご質問や確認依頼には対応できませんので、ご了承ください。
APIにおいても、基本的な仕様は画面から操作する場合と同様です。APIドキュメントには機能的な仕様は記載されていないため、これについてはboardのヘルプをご覧ください。
具体的なリクエスト内容と合わせてお問い合わせいただくとスムーズです。ただし、その際、APIトークン・APIキーは含めないようにお願いいたします。

顧客

顧客情報を扱うAPIです。

顧客リスト取得

顧客リストを取得します。

query Parameters

tags[]

string

例: tags[]=サンプルタグA,サンプルタグB

タグ（複数の場合はカンマ区切り）

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

include_archive_flg

integer

デフォルト: 0

利用可能な値: 0 1

例: include_archive_flg=1

アーカイブを含むか

0：アーカイブ済みは除く
1：アーカイブ済みも含む

updated_at_gteq

string <YYYY-MM-DD HH:MM:SS>

例: updated_at_gteq=2023-08-01 00:00:00

更新日時（指定日時以降）

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

updated_at_lteq

string <YYYY-MM-DD HH:MM:SS>

例: updated_at_lteq=2023-08-01 00:00:00

更新日時（指定日時以前）

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

custom_no_eq

string

例: custom_no_eq=12345

顧客番号

per_page

integer

デフォルト: 10

例: per_page=20

1ページあたりの要素数（最大100まで）

page

integer

デフォルト: 1

例: page=2

現在のページ番号

response_group

string

デフォルト: "small"

利用可能な値: "small" "large"

例: response_group=large

レスポンスグループ

response_group	項目
small	id, name, name_disp, title, zip, pref, address1, address2, tel, fax, payment_term_id, payment_term_name, company_number, invoice_system_number, invoice_system_number_validated, invoice_system_issuer_type, invoice_system_issuer_type_name, created_at, updated_at
large	すべての項目

※レスポンスグループについて

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/clients' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

[{"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"title": "御中",
"payment_term_id": 123456,
"payment_term_name": "月末締め翌月末払い",
"nda_flg": 0,
"basic_agreement_flg": 0,
"document_send_type": 1,
"document_send_type_name": "メール(DL)",
"note": "備考サンプルです",
"tags": ["タグA",
"タグB"
],
"wareki_flg": 0,
"company_number": "1234567890123",
"accounting_code": "サンプル（株）",
"to": "test@example.com",
"cc": "test@example.com",
"invoice_system_number": "T1234567890123",
"invoice_system_number_validated": true,
"invoice_system_issuer_type": 0,
"invoice_system_issuer_type_name": "未設定",
"bank_charge_to_client_flg": 1,
"custom_no": "C0001",
"company_bank_id": 123456,
"company_bank_name": "サンプル銀行 サンプル支店",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": "81",
"currency": "USD",
"lang_kbn": 1,
"lang_kbn_name": "日本語",
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}
]

顧客登録

顧客を新規登録します。

Request Body schema: application/json
required

name required	string <= 100 characters 顧客名
name_disp required	string <= 50 characters 顧客略称名
zip	string <= 8 characters 郵便番号（ハイフン区切り）
pref	string 都道府県
address1	string <= 100 characters 市区町村・番地
address2	string <= 100 characters 建物名
tel	string <= 15 characters TEL（ハイフン区切り）
fax	string <= 15 characters FAX（ハイフン区切り）
title	string <= 50 characters デフォルト: "御中" 敬称
payment_term_id	integer <int32> デフォルト支払条件ID 新規登録時に未指定の場合は最初の支払条件が使用されます支払条件リスト取得APIのレスポンスにある`id`です
nda_flg	integer <int32> デフォルト: 0 利用可能な値: 0 1 NDA締結 0：未 1：済
basic_agreement_flg	integer <int32> デフォルト: 0 利用可能な値: 0 1 基本契約書締結 0：未 1：済
document_send_type	integer <int32> デフォルト: 1 書類送付方法 1：メール(DL) 2：郵送 3：メール(DL)+郵送 4：メール(添付) 5：メール(添付)+郵送またはカスタム書類送付方法のID
note	string <= 1000 characters 備考
tags	Array of strings タグ ※タグ名の配列
wareki_flg	integer <int32> デフォルト: 0 利用可能な値: 0 1 デフォルト和暦表示 0：西暦 1：和暦 ※「和暦表示」機能有効時のみ
company_number	string = 13 characters 法人番号
accounting_code	string <= 100 characters 会計用名称・コード ※「会計連携機能」機能有効時のみ
to	string <= 1000 characters TO（メールアドレス） ※複数指定する場合はカンマ区切り
cc	string <= 1000 characters CC（メールアドレス） ※複数指定する場合はカンマ区切り
invoice_system_number	string = 14 characters 適格請求書発行事業者の登録番号
invoice_system_issuer_type	integer <int32> デフォルト: 0 利用可能な値: 0 1 2 適格請求書発行事業者 0：未設定 1：該当する 2：該当しない
bank_charge_to_client_flg	integer <int32> デフォルト: 1 利用可能な値: 0 1 振込手数料負担 0：当方 1：先方
custom_no	string <= 100 characters 顧客番号
company_bank_id	integer <int32> デフォルト振込口座ID ※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456
name_en	string <= 100 characters 顧客名（英語表記） ※英語アドオン有効時のみ
address_en	string <= 500 characters 住所（英語表記） ※英語アドオン有効時のみ
phone_country_code	string <= 10 characters 国番号（英語表記） ※英語アドオン有効時のみ
currency	string <= 3 characters デフォルト: "JPY" 利用可能な値: "JPY" "USD" "EUR" "GBP" "CNY" "HKD" "TWD" "KRW" "SGD" "AUD" "IDR" "THB" "CAD" デフォルト通貨 ※英語アドオン有効時のみ
lang_kbn	integer <int32> デフォルト: 1 利用可能な値: 1 2 デフォルト言語 1：日本語 2：英語 ※英語アドオン有効時のみ
archive_flg	integer <int32> 利用可能な値: 0 1 アーカイブ状態 0：未アーカイブ 1：アーカイブ済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"name": "サンプル株式会社",
"name_disp": "サンプル",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"title": "御中",
"payment_term_id": 123456,
"nda_flg": 0,
"basic_agreement_flg": 0,
"document_send_type": 1,
"note": "備考サンプルです",
"tags": ["タグA",
"タグB"
],
"wareki_flg": 0,
"company_number": "1234567890123",
"accounting_code": "サンプル（株）",
"to": "test@example.com",
"cc": "test@example.com",
"invoice_system_number": "T1234567890123",
"invoice_system_issuer_type": 0,
"bank_charge_to_client_flg": 1,
"custom_no": "C0001",
"company_bank_id": 123456,
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": "81",
"currency": "USD",
"lang_kbn": 1,
"archive_flg": 0
}

Response samples

Content type

application/json

{"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"title": "御中",
"payment_term_id": 123456,
"payment_term_name": "月末締め翌月末払い",
"nda_flg": 0,
"basic_agreement_flg": 0,
"document_send_type": 1,
"document_send_type_name": "メール(DL)",
"note": "備考サンプルです",
"tags": ["タグA",
"タグB"
],
"wareki_flg": 0,
"company_number": "1234567890123",
"accounting_code": "サンプル（株）",
"to": "test@example.com",
"cc": "test@example.com",
"invoice_system_number": "T1234567890123",
"invoice_system_number_validated": true,
"invoice_system_issuer_type": 0,
"invoice_system_issuer_type_name": "未設定",
"bank_charge_to_client_flg": 1,
"custom_no": "C0001",
"company_bank_id": 123456,
"company_bank_name": "サンプル銀行 サンプル支店",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": "81",
"currency": "USD",
"lang_kbn": 1,
"lang_kbn_name": "日本語",
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

顧客更新

ID指定で顧客を更新します。

path Parameters

required

integer

顧客ID

※顧客登録API・顧客リスト取得APIのレスポンスにあるid

Request Body schema: application/json

name	string <= 100 characters 顧客名
name_disp	string <= 50 characters 顧客略称名
zip	string <= 8 characters 郵便番号（ハイフン区切り）
pref	string 都道府県
address1	string <= 100 characters 市区町村・番地
address2	string <= 100 characters 建物名
tel	string <= 15 characters TEL（ハイフン区切り）
fax	string <= 15 characters FAX（ハイフン区切り）
title	string <= 50 characters デフォルト: "御中" 敬称
payment_term_id	integer <int32> デフォルト支払条件ID 新規登録時に未指定の場合は最初の支払条件が使用されます支払条件リスト取得APIのレスポンスにある`id`です
nda_flg	integer <int32> デフォルト: 0 利用可能な値: 0 1 NDA締結 0：未 1：済
basic_agreement_flg	integer <int32> デフォルト: 0 利用可能な値: 0 1 基本契約書締結 0：未 1：済
document_send_type	integer <int32> デフォルト: 1 書類送付方法 1：メール(DL) 2：郵送 3：メール(DL)+郵送 4：メール(添付) 5：メール(添付)+郵送またはカスタム書類送付方法のID
note	string <= 1000 characters 備考
tags	Array of strings タグ ※タグ名の配列
wareki_flg	integer <int32> デフォルト: 0 利用可能な値: 0 1 デフォルト和暦表示 0：西暦 1：和暦 ※「和暦表示」機能有効時のみ
company_number	string = 13 characters 法人番号
accounting_code	string <= 100 characters 会計用名称・コード ※「会計連携機能」機能有効時のみ
to	string <= 1000 characters TO（メールアドレス） ※複数指定する場合はカンマ区切り
cc	string <= 1000 characters CC（メールアドレス） ※複数指定する場合はカンマ区切り
invoice_system_number	string = 14 characters 適格請求書発行事業者の登録番号
invoice_system_issuer_type	integer <int32> デフォルト: 0 利用可能な値: 0 1 2 適格請求書発行事業者 0：未設定 1：該当する 2：該当しない
bank_charge_to_client_flg	integer <int32> デフォルト: 1 利用可能な値: 0 1 振込手数料負担 0：当方 1：先方
custom_no	string <= 100 characters 顧客番号
company_bank_id	integer <int32> デフォルト振込口座ID ※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456
name_en	string <= 100 characters 顧客名（英語表記） ※英語アドオン有効時のみ
address_en	string <= 500 characters 住所（英語表記） ※英語アドオン有効時のみ
phone_country_code	string <= 10 characters 国番号（英語表記） ※英語アドオン有効時のみ
currency	string <= 3 characters デフォルト: "JPY" 利用可能な値: "JPY" "USD" "EUR" "GBP" "CNY" "HKD" "TWD" "KRW" "SGD" "AUD" "IDR" "THB" "CAD" デフォルト通貨 ※英語アドオン有効時のみ
lang_kbn	integer <int32> デフォルト: 1 利用可能な値: 1 2 デフォルト言語 1：日本語 2：英語 ※英語アドオン有効時のみ
archive_flg	integer <int32> 利用可能な値: 0 1 アーカイブ状態 0：未アーカイブ 1：アーカイブ済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"name": "サンプル株式会社",
"name_disp": "サンプル",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"title": "御中",
"payment_term_id": 123456,
"nda_flg": 0,
"basic_agreement_flg": 0,
"document_send_type": 1,
"note": "備考サンプルです",
"tags": ["タグA",
"タグB"
],
"wareki_flg": 0,
"company_number": "1234567890123",
"accounting_code": "サンプル（株）",
"to": "test@example.com",
"cc": "test@example.com",
"invoice_system_number": "T1234567890123",
"invoice_system_issuer_type": 0,
"bank_charge_to_client_flg": 1,
"custom_no": "C0001",
"company_bank_id": 123456,
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": "81",
"currency": "USD",
"lang_kbn": 1,
"archive_flg": 0
}

Response samples

Content type

application/json

{"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"title": "御中",
"payment_term_id": 123456,
"payment_term_name": "月末締め翌月末払い",
"nda_flg": 0,
"basic_agreement_flg": 0,
"document_send_type": 1,
"document_send_type_name": "メール(DL)",
"note": "備考サンプルです",
"tags": ["タグA",
"タグB"
],
"wareki_flg": 0,
"company_number": "1234567890123",
"accounting_code": "サンプル（株）",
"to": "test@example.com",
"cc": "test@example.com",
"invoice_system_number": "T1234567890123",
"invoice_system_number_validated": true,
"invoice_system_issuer_type": 0,
"invoice_system_issuer_type_name": "未設定",
"bank_charge_to_client_flg": 1,
"custom_no": "C0001",
"company_bank_id": 123456,
"company_bank_name": "サンプル銀行 サンプル支店",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": "81",
"currency": "USD",
"lang_kbn": 1,
"lang_kbn_name": "日本語",
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

顧客削除

ID指定で顧客を削除します。

path Parameters

required

integer

顧客ID

※顧客登録API・顧客リスト取得APIのレスポンスにあるid

Responses

Request samples

Curl

curl --location --request DELETE 'https://api.the-board.jp/v1/clients/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

顧客取得

ID指定で顧客を取得します。

path Parameters

required

integer

顧客ID

※顧客登録API・顧客リスト取得APIのレスポンスにあるid

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/clients/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"title": "御中",
"payment_term_id": 123456,
"payment_term_name": "月末締め翌月末払い",
"nda_flg": 0,
"basic_agreement_flg": 0,
"document_send_type": 1,
"document_send_type_name": "メール(DL)",
"note": "備考サンプルです",
"tags": ["タグA",
"タグB"
],
"wareki_flg": 0,
"company_number": "1234567890123",
"accounting_code": "サンプル（株）",
"to": "test@example.com",
"cc": "test@example.com",
"invoice_system_number": "T1234567890123",
"invoice_system_number_validated": true,
"invoice_system_issuer_type": 0,
"invoice_system_issuer_type_name": "未設定",
"bank_charge_to_client_flg": 1,
"custom_no": "C0001",
"company_bank_id": 123456,
"company_bank_name": "サンプル銀行 サンプル支店",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": "81",
"currency": "USD",
"lang_kbn": 1,
"lang_kbn_name": "日本語",
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

顧客支社

顧客支社情報を扱うAPIです。

顧客支社リスト取得

顧客支社リストを取得します。

query Parameters

client_id_eq	integer 例: client_id_eq=123456 顧客ID ※顧客登録API・顧客リスト取得APIのレスポンスにある`id`
include_archive_flg	integer デフォルト: 0 利用可能な値: 0 1 例: include_archive_flg=1 アーカイブを含むか 0：アーカイブ済みは除く 1：アーカイブ済みも含む
updated_at_gteq	string <YYYY-MM-DD HH:MM:SS> 例: updated_at_gteq=2023-08-01 00:00:00 更新日時（指定日時以降） ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
updated_at_lteq	string <YYYY-MM-DD HH:MM:SS> 例: updated_at_lteq=2023-08-01 00:00:00 更新日時（指定日時以前） ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
per_page	integer デフォルト: 10 例: per_page=20 1ページあたりの要素数（最大100まで）
page	integer デフォルト: 1 例: page=2 現在のページ番号

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/client_branches' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

[{"id": 12345,
"client": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"name": "サンプル支社",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": 81,
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}
]

顧客支社登録

顧客支社を新規登録します。

Request Body schema: application/json
required

client_id required	integer <int32> 顧客ID ※顧客登録API・顧客リスト取得APIのレスポンスにある`id`
name required	string <= 100 characters 顧客支社名
zip	string <= 8 characters 郵便番号（ハイフン区切り）
pref	string 都道府県
address1	string <= 100 characters 市区町村・番地
address2	string <= 100 characters 建物名
tel	string <= 15 characters TEL（ハイフン区切り）
fax	string <= 15 characters FAX（ハイフン区切り）
name_en	string <= 100 characters 顧客支社名（英語表記） ※英語アドオン有効時のみ
address_en	string <= 500 characters 住所（英語表記） ※英語アドオン有効時のみ
phone_country_code	string <= 10 characters 国番号（英語表記） ※英語アドオン有効時のみ
archive_flg	integer <int32> 利用可能な値: 0 1 アーカイブ状態 0：未アーカイブ 1：アーカイブ済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"client_id": 123456,
"name": "サンプル支社",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": 81,
"archive_flg": 0
}

Response samples

Content type

application/json

{"id": 12345,
"client": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"name": "サンプル支社",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": 81,
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

顧客支社更新

ID指定で顧客支社を更新します。

path Parameters

required

integer

顧客支社ID

※顧客支社登録API・顧客支社リスト取得APIのレスポンスにあるid

Request Body schema: application/json

client_id	integer <int32> 顧客ID ※顧客登録API・顧客リスト取得APIのレスポンスにある`id`
name	string <= 100 characters 顧客支社名
zip	string <= 8 characters 郵便番号（ハイフン区切り）
pref	string 都道府県
address1	string <= 100 characters 市区町村・番地
address2	string <= 100 characters 建物名
tel	string <= 15 characters TEL（ハイフン区切り）
fax	string <= 15 characters FAX（ハイフン区切り）
name_en	string <= 100 characters 顧客支社名（英語表記） ※英語アドオン有効時のみ
address_en	string <= 500 characters 住所（英語表記） ※英語アドオン有効時のみ
phone_country_code	string <= 10 characters 国番号（英語表記） ※英語アドオン有効時のみ
archive_flg	integer <int32> 利用可能な値: 0 1 アーカイブ状態 0：未アーカイブ 1：アーカイブ済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"client_id": 123456,
"name": "サンプル支社",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": 81,
"archive_flg": 0
}

Response samples

Content type

application/json

{"id": 12345,
"client": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"name": "サンプル支社",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": 81,
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

顧客支社削除

ID指定で顧客支社を削除します。

path Parameters

required

integer

顧客支社ID

※顧客支社登録API・顧客支社リスト取得APIのレスポンスにあるid

Responses

Request samples

Curl

curl --location --request DELETE 'https://api.the-board.jp/v1/client_branches/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

顧客支社取得

ID指定で顧客支社を取得します。

path Parameters

required

integer

顧客支社ID

※顧客支社登録API・顧客支社リスト取得APIのレスポンスにあるid

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/client_branches/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"id": 12345,
"client": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"name": "サンプル支社",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": 81,
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

顧客担当者

顧客担当者情報を扱うAPIです。

顧客担当者リスト取得

顧客担当者リストを取得します。

query Parameters

client_id_eq	integer 例: client_id_eq=123456 顧客ID ※顧客登録API・顧客リスト取得APIのレスポンスにある`id`
include_archive_flg	integer デフォルト: 0 利用可能な値: 0 1 例: include_archive_flg=1 アーカイブを含むか 0：アーカイブ済みは除く 1：アーカイブ済みも含む
updated_at_gteq	string <YYYY-MM-DD HH:MM:SS> 例: updated_at_gteq=2023-08-01 00:00:00 更新日時（指定日時以降） ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
updated_at_lteq	string <YYYY-MM-DD HH:MM:SS> 例: updated_at_lteq=2023-08-01 00:00:00 更新日時（指定日時以前） ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
per_page	integer デフォルト: 10 例: per_page=20 1ページあたりの要素数（最大100まで）
page	integer デフォルト: 1 例: page=2 現在のページ番号

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/contacts' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

[{"id": 12345,
"client": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"last_name": "山田",
"first_name": "太郎",
"honorific_title": "様",
"title": "部長",
"department": "システム部",
"email": "yamada@example.com",
"note": "備考サンプルです",
"archive_flg": 0,
"last_name_en": "Yamada",
"first_name_en": "Taro",
"prefix_en": "Mr.",
"title_en": "Manager",
"department_en": "IT Dept.",
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}
]

顧客担当者登録

顧客担当者を新規登録します。

Request Body schema: application/json
required

client_id required	integer <int32> 顧客ID ※顧客登録API・顧客リスト取得APIのレスポンスにある`id`
last_name required	string <= 50 characters 姓
first_name	string <= 50 characters 名
honorific_title	string <= 50 characters 敬称
title	string <= 50 characters 肩書
department	string <= 50 characters 部署
email	string <= 100 characters email
note	string <= 1000 characters 備考
archive_flg	integer <int32> 利用可能な値: 0 1 アーカイブ状態 0：未アーカイブ 1：アーカイブ済み
last_name_en	string <= 50 characters 姓（英語表記） ※英語アドオン有効時のみ
first_name_en	string <= 50 characters 名（英語表記） ※英語アドオン有効時のみ
prefix_en	string <= 50 characters 敬称（英語表記） ※英語アドオン有効時のみ
title_en	string <= 50 characters 肩書（英語表記） ※英語アドオン有効時のみ
department_en	string <= 50 characters 部署（英語表記） ※英語アドオン有効時のみ

Responses

Request samples

Payload
Curl

Content type

application/json

{"client_id": 123456,
"last_name": "山田",
"first_name": "太郎",
"honorific_title": "様",
"title": "部長",
"department": "システム部",
"email": "yamada@example.com",
"note": "備考サンプルです",
"archive_flg": 0,
"last_name_en": "Yamada",
"first_name_en": "Taro",
"prefix_en": "Mr.",
"title_en": "Manager",
"department_en": "IT Dept."
}

Response samples

Content type

application/json

{"id": 12345,
"client": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"last_name": "山田",
"first_name": "太郎",
"honorific_title": "様",
"title": "部長",
"department": "システム部",
"email": "yamada@example.com",
"note": "備考サンプルです",
"archive_flg": 0,
"last_name_en": "Yamada",
"first_name_en": "Taro",
"prefix_en": "Mr.",
"title_en": "Manager",
"department_en": "IT Dept.",
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

顧客担当者更新

ID指定で顧客担当者を更新します。

path Parameters

required

integer

顧客担当者ID

※顧客担当者登録API・顧客担当者リスト取得APIのレスポンスにあるid

Request Body schema: application/json

client_id	integer <int32> 顧客ID ※顧客登録API・顧客リスト取得APIのレスポンスにある`id`
last_name	string <= 50 characters 姓
first_name	string <= 50 characters 名
honorific_title	string <= 50 characters 敬称
title	string <= 50 characters 肩書
department	string <= 50 characters 部署
email	string <= 100 characters email
note	string <= 1000 characters 備考
archive_flg	integer <int32> 利用可能な値: 0 1 アーカイブ状態 0：未アーカイブ 1：アーカイブ済み
last_name_en	string <= 50 characters 姓（英語表記） ※英語アドオン有効時のみ
first_name_en	string <= 50 characters 名（英語表記） ※英語アドオン有効時のみ
prefix_en	string <= 50 characters 敬称（英語表記） ※英語アドオン有効時のみ
title_en	string <= 50 characters 肩書（英語表記） ※英語アドオン有効時のみ
department_en	string <= 50 characters 部署（英語表記） ※英語アドオン有効時のみ

Responses

Request samples

Payload
Curl

Content type

application/json

{"client_id": 123456,
"last_name": "山田",
"first_name": "太郎",
"honorific_title": "様",
"title": "部長",
"department": "システム部",
"email": "yamada@example.com",
"note": "備考サンプルです",
"archive_flg": 0,
"last_name_en": "Yamada",
"first_name_en": "Taro",
"prefix_en": "Mr.",
"title_en": "Manager",
"department_en": "IT Dept."
}

Response samples

Content type

application/json

{"id": 12345,
"client": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"last_name": "山田",
"first_name": "太郎",
"honorific_title": "様",
"title": "部長",
"department": "システム部",
"email": "yamada@example.com",
"note": "備考サンプルです",
"archive_flg": 0,
"last_name_en": "Yamada",
"first_name_en": "Taro",
"prefix_en": "Mr.",
"title_en": "Manager",
"department_en": "IT Dept.",
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

顧客担当者削除

ID指定で顧客担当者を削除します。

path Parameters

required

integer

顧客担当者ID

※顧客担当者登録API・顧客担当者リスト取得APIのレスポンスにあるid

Responses

Request samples

Curl

curl --location --request DELETE 'https://api.the-board.jp/v1/contacts/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

顧客担当者取得

ID指定で顧客担当者を取得します。

path Parameters

required

integer

顧客担当者ID

※顧客担当者登録API・顧客担当者リスト取得APIのレスポンスにあるid

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/contacts/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"id": 12345,
"client": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"last_name": "山田",
"first_name": "太郎",
"honorific_title": "様",
"title": "部長",
"department": "システム部",
"email": "yamada@example.com",
"note": "備考サンプルです",
"archive_flg": 0,
"last_name_en": "Yamada",
"first_name_en": "Taro",
"prefix_en": "Mr.",
"title_en": "Manager",
"department_en": "IT Dept.",
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

案件

案件情報を扱うAPIです。

案件リスト取得

案件リストを取得します。取得結果は新しい順で取得されます。

query Parameters

order_status_in[]

string

例: order_status_in[]=4,5

受注ステータス

1：見積中(高)
2：見積中(中)
3：見積中(低)
8：見積中(除)
4：受注確定
5：受注済
9：失注

※複数の場合はカンマ区切り

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

delivery_status_in[]

string

例: delivery_status_in[]=1,2

進捗状況

1：未着手
2：着手中
3：納品済
4：検収済

※複数の場合はカンマ区切り

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

project_no_eq

integer

例: project_no_eq=1001

案件No

created_at_gteq

string <YYYY-MM-DD HH:MM:SS>

例: created_at_gteq=2023-08-01 00:00:00

作成日時（指定日時以降）

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

created_at_lteq

string <YYYY-MM-DD HH:MM:SS>

例: created_at_lteq=2023-08-01 00:00:00

作成日時（指定日時以前）

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

updated_at_gteq

string <YYYY-MM-DD HH:MM:SS>

例: updated_at_gteq=2023-08-01 00:00:00

更新日時（指定日時以降）

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

updated_at_lteq

string <YYYY-MM-DD HH:MM:SS>

例: updated_at_lteq=2023-08-01 00:00:00

更新日時（指定日時以前）

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

include_lost_flg

integer

デフォルト: 0

例: include_lost_flg=1

失注を含むか

0：失注は除く
1：失注も含む

include_archive_flg

integer

デフォルト: 0

利用可能な値: 0 1

例: include_archive_flg=1

アーカイブを含むか

0：アーカイブ済みは除く
1：アーカイブ済みも含む

per_page

integer

デフォルト: 10

例: per_page=20

1ページあたりの要素数（最大100まで）

page

integer

デフォルト: 1

例: page=2

現在のページ番号

response_group

string

デフォルト: "small"

利用可能な値: "small" "medium" "large" "estimate" "order" "delivery" "invoice" "receipt" "project_cost" "all"

例: response_group=large

レスポンスグループ

response_group	項目
small	id, project_no, management_no, name, client, contact, user, total, tax, estimate_date, invoice_dates, order_status, order_status_name, project_type_id, project_type_name, project_type2_id, project_type2_name, project_type3_id, project_type3_name, delivery_status, delivery_status_name, group_id, group_name, currency, created_at, updated_at
medium	smallに加え以下の項目 client_branch, company_branch, cost_total, cost_tax, invoice_total, invoice_tax, delivery_date, payment_term_id, payment_term_name, invoice_timing_kbn, invoice_timing_kbn_name, contract_start_date, contract_end_date, periodical_invoice_interval, periodical_invoice_payment_kbn, contract_end_alert_flg, auto_renewal_flg, auto_renewal_period_month, monthly_invoice_payment_kbn, delivery_document_kbn, tags, ordered_date, exchange_rate, total_jpy, tax_jpy, invoice_total_jpy, invoice_tax_jpy
large	書類以外すべての項目
estimate	small + 見積書
order	small + 発注書
delivery	small + 納品書
invoice	small + 請求書
receipt	small + 領収書
project_cost	small + 案件原価
all	large + すべての書類

※レスポンスグループについて

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/projects' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

[{"id": 123456,
"project_no": 1001,
"name": "サンプル案件A",
"client": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"client_branch": {"id": 123456,
"name": "サンプル支社"
},
"client_name_disp_kbn": 1,
"client_name_disp_kbn_name": "会社名のみ",
"client_name_for_post_disp_kbn": 1,
"client_name_for_post_disp_kbn_name": "会社名のみ",
"contact": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"company_branch": {"id": 123456,
"name": "サンプル支社"
},
"company_name_disp_kbn": 1,
"company_name_disp_kbn_name": "会社名のみ",
"company_name_for_post_disp_kbn": 1,
"company_name_for_post_disp_kbn_name": "会社名のみ",
"user": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"total": 100000,
"tax": 10000,
"cost_total": 10000,
"cost_tax": 1000,
"invoice_total": 100000,
"invoice_tax": 10000,
"estimate_date": "2023-10-01",
"delivery_date": "2023-10-20",
"delivery_date_text": "サンプル納期",
"payment_term_id": 123456,
"payment_term_name": "月末締め翌月末払い",
"order_status": 1,
"order_status_name": "見積中(高)",
"delivery_status": 1,
"delivery_status_name": "未着手",
"invoice_timing_kbn": 1,
"invoice_timing_kbn_name": "一括請求",
"project_type_id": 123456,
"project_type_name": "サンプル案件区分1",
"project_type2_id": 123456,
"project_type2_name": "サンプル案件区分2",
"project_type3_id": 123456,
"project_type3_name": "サンプル案件区分3",
"group_id": 123456,
"group_name": "サンプルグループ",
"tags": ["タグA",
"タグB"
],
"accounting_type_id": 123456,
"accounting_type_name": "サンプル会計区分1",
"accounting_type2_id": 123456,
"accounting_type2_name": "サンプル会計区分2",
"accounting_type3_id": 123456,
"accounting_type3_name": "サンプル会計区分3",
"in_house_memo": "サンプルメモです。",
"management_no": "TEST0001",
"ordered_date": "2023-10-05",
"payment_method_kbn": 1,
"payment_method_kbn_name": "銀行振込",
"tax_rule_kbn": 2,
"tax_rule_kbn_name": "切り捨て",
"minus_rounding_rule": 1,
"minus_rounding_rule_name": "数値を基準にする",
"to": "test@example.com",
"cc": "test@example.com",
"lock_flg": 0,
"wareki_flg": 0,
"archive_flg": 0,
"reduced_tax_rate_kbn": 1,
"document_setting_id": 123456,
"document_setting_name": "メイン用",
"project_costs": [{"cost": 10000,
"description": "サンプル費用",
"invoice_date": "2023-10-10",
"payment_date": "2023-10-10"
}
],
"currency": "JPY",
"lang_kbn": 1,
"lang_kbn_name": "日本語",
"exchange_rate": 149.43,
"total_jpy": 100000,
"tax_jpy": 10000,
"invoice_total_jpy": 100000,
"invoice_tax_jpy": 10000,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00",
"estimate": {"id": 123456,
"valid_period": "御見積後2週間",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
},
"order": {"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"disp_order_date": "2023-10-01",
"disp_order_receive_date": "2023-10-01",
"blank_date_flg": 0
},
"deliveries": [{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"delivery_date": "2023-10-01",
"disp_delivery_date": "2023-10-01",
"disp_delivery_receive_date": "2023-10-01",
"blank_date_flg": 0
}
],
"invoices": [{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"invoice_date": "2023-10-31",
"payment_limit_date": "2023-11-30",
"disp_invoice_date": "2023-10-01",
"blank_date_flg": 0,
"multi_bank_info_flg": 0
}
],
"receipts": [{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"receipt_date": "2023-10-01",
"disp_receipt_date": "2023-10-01",
"blank_date_flg": 0
}
]
}
]

案件登録

案件を新規登録します。

請求タイミング（一括請求・定期請求・分割請求）に応じてパラメーターが異なります。

下記のリクエストパラメーターリストの上部にある「共通」「一括請求」「定期請求」「分割請求」のボタンでリクエストパラメーターを切り替えることができます。

「共通」は、全請求タイミングで共通して使用するパラメーターです。「一括請求」「定期請求」「分割請求」は、それぞれの請求タイミング固有のパラメーターです。「共通+一括請求」のように組み合わせて使用してください。

Request Body schema: application/json
required

Any of

name required	string <= 100 characters 案件名
client_id required	integer <int32> 顧客ID ※顧客登録API・顧客リスト取得APIのレスポンスにある`id`
user_id required	integer <int32> 担当者ID ※ユーザーリスト取得APIのレスポンスにある`id`
order_status required	integer 利用可能な値: 1 2 3 4 5 8 9 受注ステータス 1：見積中(高) 2：見積中(中) 3：見積中(低) 8：見積中(除) 4：受注確定 5：受注済 9：失注
invoice_timing_kbn required	integer 利用可能な値: 1 2 3 請求タイミング 1：一括請求 2：定期請求 3：分割請求
client_branch_id	integer <int32> 顧客支社ID ※顧客支社登録API・顧客支社リスト取得APIのレスポンスにある`id`
client_name_disp_kbn	integer デフォルト: 1 利用可能な値: 1 2 3 顧客支社（書類上の表示） 1：会社名のみ 2：会社名＋支社名 3：支社名のみ ※顧客支社を指定する場合のみ
client_name_for_post_disp_kbn	integer デフォルト: 1 利用可能な値: 1 2 3 顧客支社（郵送時の表示） 1：会社名のみ 2：会社名＋支社名 3：支社名のみ ※顧客支社を指定する場合のみ
contact_id	integer <int32> 顧客担当者ID ※顧客担当者登録API・顧客担当者リスト取得APIのレスポンスにある`id`
company_branch_id	integer <int32> 自社支社ID ※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456
company_name_disp_kbn	integer 利用可能な値: 1 2 3 自社支社（書類上の表示） 1：会社名のみ 2：会社名＋支社名 3：支社名のみ ※自社支社を指定する場合のみ
company_name_for_post_disp_kbn	integer 利用可能な値: 1 2 3 自社支社（郵送時の表示） 1：会社名のみ 2：会社名＋支社名 3：支社名のみ ※自社支社を指定する場合のみ
estimate_date	string <YYYY-MM-DD> 見積日 ※新規登録時に未指定の場合は、本日の日付がセットされます
delivery_date	string <YYYY-MM-DD> 納期
delivery_date_text	string <= 50 characters 納期テキスト
payment_term_id	integer <int32> 支払条件ID 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます支払条件リスト取得APIのレスポンスにある`id`です
delivery_status	integer 利用可能な値: 1 2 3 4 進捗状況 1：未着手 2：着手中 3：納品済 4：検収済
project_type_id	integer <int32> 案件区分1ID ※案件区分リスト取得APIのレスポンスにある`id`
project_type2_id	integer <int32> 案件区分2ID ※案件区分リスト取得APIのレスポンスにある`id`
project_type3_id	integer <int32> 案件区分3ID ※案件区分リスト取得APIのレスポンスにある`id`
group_id	integer <int32> グループID ※グループリスト取得APIのレスポンスにある`id`
tags	Array of strings タグ ※タグ名の配列
accounting_type_id	integer <int32> 会計区分1ID ※会計区分リスト取得APIのレスポンスにある`id`
accounting_type2_id	integer <int32> 会計区分2ID ※会計区分リスト取得APIのレスポンスにある`id`
accounting_type3_id	integer <int32> 会計区分3ID ※会計区分リスト取得APIのレスポンスにある`id`
in_house_memo	string <= 2000 characters 社内メモ
management_no	string <= 20 characters 管理番号
ordered_date	string <YYYY-MM-DD> 受注日
payment_method_kbn	integer デフォルト: 1 利用可能な値: 1 2 3 4 5 6 7 支払方法 1：銀行振込 2：口座振替 3：クレジットカード 4：現金支払 5：代金引換 6：コンビニ支払 7：郵便振替
tax_rule_kbn	integer 利用可能な値: 1 2 3 端数処理 1：四捨五入 2：切り捨て 3：切り上げ ※デフォルトはアカウントの端数処理設定による
to	string <= 1000 characters TO（メールアドレス） ※複数指定する場合はカンマ区切り
cc	string <= 1000 characters CC（メールアドレス） ※複数指定する場合はカンマ区切り
wareki_flg	integer 利用可能な値: 0 1 和暦表示 0：西暦 1：和暦 ※「和暦表示」機能有効時のみ
archive_flg	integer <int32> 利用可能な値: 0 1 アーカイブ状態 0：未アーカイブ 1：アーカイブ済み
reduced_tax_rate_kbn	integer 利用可能な値: 1 2 軽減税率 1：対象外 2：対象 ※「軽減税率」機能有効時のみ
document_setting_id	integer <int64> 書類詳細設定ID ※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456
currency	string 利用可能な値: "JPY" "USD" "EUR" "GBP" "CNY" "HKD" "TWD" "KRW" "SGD" "AUD" "IDR" "THB" "CAD" 通貨 ※英語アドオン有効時のみ
lang_kbn	integer 利用可能な値: 1 2 言語 1：日本語 2：英語 ※英語アドオン有効時のみ
exchange_rate	number <decimal> 為替レート ※英語アドオン有効時のみ

Responses

Request samples

Payload
Curl

Content type

application/json

Example

共通

{"name": "サンプル案件A",
"client_id": 123456,
"client_branch_id": 123456,
"client_name_disp_kbn": 1,
"client_name_for_post_disp_kbn": 1,
"contact_id": 123456,
"company_branch_id": 123456,
"company_name_disp_kbn": 1,
"company_name_for_post_disp_kbn": 1,
"user_id": 123456,
"estimate_date": "2023-10-01",
"delivery_date": "2023-10-20",
"delivery_date_text": "サンプル納期",
"payment_term_id": 123456,
"order_status": 1,
"delivery_status": 1,
"invoice_timing_kbn": 1,
"project_type_id": 123456,
"project_type2_id": 123456,
"project_type3_id": 123456,
"group_id": 123456,
"tags": ["タグA",
"タグB"
],
"accounting_type_id": 123456,
"accounting_type2_id": 123456,
"accounting_type3_id": 123456,
"in_house_memo": "サンプルメモです。",
"management_no": "TEST0001",
"ordered_date": "2023-10-05",
"payment_method_kbn": 1,
"tax_rule_kbn": 2,
"to": "test@example.com",
"cc": "test@example.com",
"wareki_flg": 0,
"archive_flg": 0,
"reduced_tax_rate_kbn": 1,
"document_setting_id": 123456,
"currency": "JPY",
"lang_kbn": 1,
"exchange_rate": 149.43
}

Response samples

Content type

application/json

{"id": 123456,
"project_no": 1001,
"name": "サンプル案件A",
"client": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"client_branch": {"id": 123456,
"name": "サンプル支社"
},
"client_name_disp_kbn": 1,
"client_name_disp_kbn_name": "会社名のみ",
"client_name_for_post_disp_kbn": 1,
"client_name_for_post_disp_kbn_name": "会社名のみ",
"contact": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"company_branch": {"id": 123456,
"name": "サンプル支社"
},
"company_name_disp_kbn": 1,
"company_name_disp_kbn_name": "会社名のみ",
"company_name_for_post_disp_kbn": 1,
"company_name_for_post_disp_kbn_name": "会社名のみ",
"user": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"total": 100000,
"tax": 10000,
"cost_total": 10000,
"cost_tax": 1000,
"invoice_total": 100000,
"invoice_tax": 10000,
"estimate_date": "2023-10-01",
"delivery_date": "2023-10-20",
"delivery_date_text": "サンプル納期",
"payment_term_id": 123456,
"payment_term_name": "月末締め翌月末払い",
"order_status": 1,
"order_status_name": "見積中(高)",
"delivery_status": 1,
"delivery_status_name": "未着手",
"invoice_timing_kbn": 1,
"invoice_timing_kbn_name": "一括請求",
"project_type_id": 123456,
"project_type_name": "サンプル案件区分1",
"project_type2_id": 123456,
"project_type2_name": "サンプル案件区分2",
"project_type3_id": 123456,
"project_type3_name": "サンプル案件区分3",
"group_id": 123456,
"group_name": "サンプルグループ",
"tags": ["タグA",
"タグB"
],
"accounting_type_id": 123456,
"accounting_type_name": "サンプル会計区分1",
"accounting_type2_id": 123456,
"accounting_type2_name": "サンプル会計区分2",
"accounting_type3_id": 123456,
"accounting_type3_name": "サンプル会計区分3",
"in_house_memo": "サンプルメモです。",
"management_no": "TEST0001",
"ordered_date": "2023-10-05",
"payment_method_kbn": 1,
"payment_method_kbn_name": "銀行振込",
"tax_rule_kbn": 2,
"tax_rule_kbn_name": "切り捨て",
"minus_rounding_rule": 1,
"minus_rounding_rule_name": "数値を基準にする",
"to": "test@example.com",
"cc": "test@example.com",
"lock_flg": 0,
"wareki_flg": 0,
"archive_flg": 0,
"reduced_tax_rate_kbn": 1,
"document_setting_id": 123456,
"document_setting_name": "メイン用",
"project_costs": [{"cost": 10000,
"description": "サンプル費用",
"invoice_date": "2023-10-10",
"payment_date": "2023-10-10"
}
],
"currency": "JPY",
"lang_kbn": 1,
"lang_kbn_name": "日本語",
"exchange_rate": 149.43,
"total_jpy": 100000,
"tax_jpy": 10000,
"invoice_total_jpy": 100000,
"invoice_tax_jpy": 10000,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00",
"estimate": {"id": 123456,
"valid_period": "御見積後2週間",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
},
"order": {"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"disp_order_date": "2023-10-01",
"disp_order_receive_date": "2023-10-01",
"blank_date_flg": 0
},
"deliveries": [{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"delivery_date": "2023-10-01",
"disp_delivery_date": "2023-10-01",
"disp_delivery_receive_date": "2023-10-01",
"blank_date_flg": 0
}
],
"invoices": [{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"invoice_date": "2023-10-31",
"payment_limit_date": "2023-11-30",
"disp_invoice_date": "2023-10-01",
"blank_date_flg": 0,
"multi_bank_info_flg": 0
}
],
"receipts": [{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"receipt_date": "2023-10-01",
"disp_receipt_date": "2023-10-01",
"blank_date_flg": 0
}
]
}

案件更新

案件ID指定で案件を更新します。

分割請求に関する注意事項
現在、API経由でのinvoice_datesの更新（請求日・請求回数の変更）には対応していません。

path Parameters

required

integer

案件ID

※案件登録API・案件リスト取得APIのレスポンスにあるid

Request Body schema: application/json

Any of

name	string <= 100 characters 案件名
client_id	integer <int32> 顧客ID ※顧客登録API・顧客リスト取得APIのレスポンスにある`id`
client_branch_id	integer <int32> 顧客支社ID ※顧客支社登録API・顧客支社リスト取得APIのレスポンスにある`id`
client_name_disp_kbn	integer デフォルト: 1 利用可能な値: 1 2 3 顧客支社（書類上の表示） 1：会社名のみ 2：会社名＋支社名 3：支社名のみ ※顧客支社を指定する場合のみ
client_name_for_post_disp_kbn	integer デフォルト: 1 利用可能な値: 1 2 3 顧客支社（郵送時の表示） 1：会社名のみ 2：会社名＋支社名 3：支社名のみ ※顧客支社を指定する場合のみ
contact_id	integer <int32> 顧客担当者ID ※顧客担当者登録API・顧客担当者リスト取得APIのレスポンスにある`id`
company_branch_id	integer <int32> 自社支社ID ※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456
company_name_disp_kbn	integer 利用可能な値: 1 2 3 自社支社（書類上の表示） 1：会社名のみ 2：会社名＋支社名 3：支社名のみ ※自社支社を指定する場合のみ
company_name_for_post_disp_kbn	integer 利用可能な値: 1 2 3 自社支社（郵送時の表示） 1：会社名のみ 2：会社名＋支社名 3：支社名のみ ※自社支社を指定する場合のみ
user_id	integer <int32> 担当者ID ※ユーザーリスト取得APIのレスポンスにある`id`
estimate_date	string <YYYY-MM-DD> 見積日 ※新規登録時に未指定の場合は、本日の日付がセットされます
delivery_date	string <YYYY-MM-DD> 納期
delivery_date_text	string <= 50 characters 納期テキスト
payment_term_id	integer <int32> 支払条件ID 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます支払条件リスト取得APIのレスポンスにある`id`です
order_status	integer 利用可能な値: 1 2 3 4 5 8 9 受注ステータス 1：見積中(高) 2：見積中(中) 3：見積中(低) 8：見積中(除) 4：受注確定 5：受注済 9：失注
delivery_status	integer 利用可能な値: 1 2 3 4 進捗状況 1：未着手 2：着手中 3：納品済 4：検収済
invoice_timing_kbn	integer 利用可能な値: 1 2 3 請求タイミング 1：一括請求 2：定期請求 3：分割請求
project_type_id	integer <int32> 案件区分1ID ※案件区分リスト取得APIのレスポンスにある`id`
project_type2_id	integer <int32> 案件区分2ID ※案件区分リスト取得APIのレスポンスにある`id`
project_type3_id	integer <int32> 案件区分3ID ※案件区分リスト取得APIのレスポンスにある`id`
group_id	integer <int32> グループID ※グループリスト取得APIのレスポンスにある`id`
tags	Array of strings タグ ※タグ名の配列
accounting_type_id	integer <int32> 会計区分1ID ※会計区分リスト取得APIのレスポンスにある`id`
accounting_type2_id	integer <int32> 会計区分2ID ※会計区分リスト取得APIのレスポンスにある`id`
accounting_type3_id	integer <int32> 会計区分3ID ※会計区分リスト取得APIのレスポンスにある`id`
in_house_memo	string <= 2000 characters 社内メモ
management_no	string <= 20 characters 管理番号
ordered_date	string <YYYY-MM-DD> 受注日
payment_method_kbn	integer デフォルト: 1 利用可能な値: 1 2 3 4 5 6 7 支払方法 1：銀行振込 2：口座振替 3：クレジットカード 4：現金支払 5：代金引換 6：コンビニ支払 7：郵便振替
tax_rule_kbn	integer 利用可能な値: 1 2 3 端数処理 1：四捨五入 2：切り捨て 3：切り上げ ※デフォルトはアカウントの端数処理設定による
to	string <= 1000 characters TO（メールアドレス） ※複数指定する場合はカンマ区切り
cc	string <= 1000 characters CC（メールアドレス） ※複数指定する場合はカンマ区切り
wareki_flg	integer 利用可能な値: 0 1 和暦表示 0：西暦 1：和暦 ※「和暦表示」機能有効時のみ
archive_flg	integer <int32> 利用可能な値: 0 1 アーカイブ状態 0：未アーカイブ 1：アーカイブ済み
reduced_tax_rate_kbn	integer 利用可能な値: 1 2 軽減税率 1：対象外 2：対象 ※「軽減税率」機能有効時のみ
document_setting_id	integer <int64> 書類詳細設定ID ※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456
currency	string 利用可能な値: "JPY" "USD" "EUR" "GBP" "CNY" "HKD" "TWD" "KRW" "SGD" "AUD" "IDR" "THB" "CAD" 通貨 ※英語アドオン有効時のみ
lang_kbn	integer 利用可能な値: 1 2 言語 1：日本語 2：英語 ※英語アドオン有効時のみ
exchange_rate	number <decimal> 為替レート ※英語アドオン有効時のみ

Responses

Request samples

Payload
Curl

Content type

application/json

Example

共通

{"name": "サンプル案件A",
"client_id": 123456,
"client_branch_id": 123456,
"client_name_disp_kbn": 1,
"client_name_for_post_disp_kbn": 1,
"contact_id": 123456,
"company_branch_id": 123456,
"company_name_disp_kbn": 1,
"company_name_for_post_disp_kbn": 1,
"user_id": 123456,
"estimate_date": "2023-10-01",
"delivery_date": "2023-10-20",
"delivery_date_text": "サンプル納期",
"payment_term_id": 123456,
"order_status": 1,
"delivery_status": 1,
"invoice_timing_kbn": 1,
"project_type_id": 123456,
"project_type2_id": 123456,
"project_type3_id": 123456,
"group_id": 123456,
"tags": ["タグA",
"タグB"
],
"accounting_type_id": 123456,
"accounting_type2_id": 123456,
"accounting_type3_id": 123456,
"in_house_memo": "サンプルメモです。",
"management_no": "TEST0001",
"ordered_date": "2023-10-05",
"payment_method_kbn": 1,
"tax_rule_kbn": 2,
"to": "test@example.com",
"cc": "test@example.com",
"wareki_flg": 0,
"archive_flg": 0,
"reduced_tax_rate_kbn": 1,
"document_setting_id": 123456,
"currency": "JPY",
"lang_kbn": 1,
"exchange_rate": 149.43
}

Response samples

Content type

application/json

{"id": 123456,
"project_no": 1001,
"name": "サンプル案件A",
"client": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"client_branch": {"id": 123456,
"name": "サンプル支社"
},
"client_name_disp_kbn": 1,
"client_name_disp_kbn_name": "会社名のみ",
"client_name_for_post_disp_kbn": 1,
"client_name_for_post_disp_kbn_name": "会社名のみ",
"contact": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"company_branch": {"id": 123456,
"name": "サンプル支社"
},
"company_name_disp_kbn": 1,
"company_name_disp_kbn_name": "会社名のみ",
"company_name_for_post_disp_kbn": 1,
"company_name_for_post_disp_kbn_name": "会社名のみ",
"user": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"total": 100000,
"tax": 10000,
"cost_total": 10000,
"cost_tax": 1000,
"invoice_total": 100000,
"invoice_tax": 10000,
"estimate_date": "2023-10-01",
"delivery_date": "2023-10-20",
"delivery_date_text": "サンプル納期",
"payment_term_id": 123456,
"payment_term_name": "月末締め翌月末払い",
"order_status": 1,
"order_status_name": "見積中(高)",
"delivery_status": 1,
"delivery_status_name": "未着手",
"invoice_timing_kbn": 1,
"invoice_timing_kbn_name": "一括請求",
"project_type_id": 123456,
"project_type_name": "サンプル案件区分1",
"project_type2_id": 123456,
"project_type2_name": "サンプル案件区分2",
"project_type3_id": 123456,
"project_type3_name": "サンプル案件区分3",
"group_id": 123456,
"group_name": "サンプルグループ",
"tags": ["タグA",
"タグB"
],
"accounting_type_id": 123456,
"accounting_type_name": "サンプル会計区分1",
"accounting_type2_id": 123456,
"accounting_type2_name": "サンプル会計区分2",
"accounting_type3_id": 123456,
"accounting_type3_name": "サンプル会計区分3",
"in_house_memo": "サンプルメモです。",
"management_no": "TEST0001",
"ordered_date": "2023-10-05",
"payment_method_kbn": 1,
"payment_method_kbn_name": "銀行振込",
"tax_rule_kbn": 2,
"tax_rule_kbn_name": "切り捨て",
"minus_rounding_rule": 1,
"minus_rounding_rule_name": "数値を基準にする",
"to": "test@example.com",
"cc": "test@example.com",
"lock_flg": 0,
"wareki_flg": 0,
"archive_flg": 0,
"reduced_tax_rate_kbn": 1,
"document_setting_id": 123456,
"document_setting_name": "メイン用",
"project_costs": [{"cost": 10000,
"description": "サンプル費用",
"invoice_date": "2023-10-10",
"payment_date": "2023-10-10"
}
],
"currency": "JPY",
"lang_kbn": 1,
"lang_kbn_name": "日本語",
"exchange_rate": 149.43,
"total_jpy": 100000,
"tax_jpy": 10000,
"invoice_total_jpy": 100000,
"invoice_tax_jpy": 10000,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00",
"estimate": {"id": 123456,
"valid_period": "御見積後2週間",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
},
"order": {"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"disp_order_date": "2023-10-01",
"disp_order_receive_date": "2023-10-01",
"blank_date_flg": 0
},
"deliveries": [{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"delivery_date": "2023-10-01",
"disp_delivery_date": "2023-10-01",
"disp_delivery_receive_date": "2023-10-01",
"blank_date_flg": 0
}
],
"invoices": [{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"invoice_date": "2023-10-31",
"payment_limit_date": "2023-11-30",
"disp_invoice_date": "2023-10-01",
"blank_date_flg": 0,
"multi_bank_info_flg": 0
}
],
"receipts": [{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"receipt_date": "2023-10-01",
"disp_receipt_date": "2023-10-01",
"blank_date_flg": 0
}
]
}

案件削除

案件ID指定で案件を削除します。

path Parameters

required

integer

案件ID

※案件登録API・案件リスト取得APIのレスポンスにあるid

Responses

Request samples

Curl

curl --location --request DELETE 'https://api.the-board.jp/v1/projects/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

案件取得

案件ID指定で案件を取得します。

path Parameters

required

integer

案件ID

※案件登録API・案件リスト取得APIのレスポンスにあるid

query Parameters

response_group

string

デフォルト: "small"

利用可能な値: "small" "medium" "large" "estimate" "order" "delivery" "invoice" "receipt" "project_cost" "all"

例: response_group=large

レスポンスグループ

response_group	項目
small	id, project_no, management_no, name, client, contact, user, total, tax, estimate_date, invoice_dates, order_status, order_status_name, project_type_id, project_type_name, project_type2_id, project_type2_name, project_type3_id, project_type3_name, delivery_status, delivery_status_name, group_id, group_name, currency, created_at, updated_at
medium	smallに加え以下の項目 client_branch, company_branch, cost_total, cost_tax, invoice_total, invoice_tax, delivery_date, payment_term_id, payment_term_name, invoice_timing_kbn, invoice_timing_kbn_name, contract_start_date, contract_end_date, periodical_invoice_interval, periodical_invoice_payment_kbn, contract_end_alert_flg, auto_renewal_flg, auto_renewal_period_month, monthly_invoice_payment_kbn, delivery_document_kbn, tags, ordered_date, exchange_rate, total_jpy, tax_jpy, invoice_total_jpy, invoice_tax_jpy
large	書類以外すべての項目
estimate	small + 見積書
order	small + 発注書
delivery	small + 納品書
invoice	small + 請求書
receipt	small + 領収書
project_cost	small + 案件原価
all	large + すべての書類

※レスポンスグループについて

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/projects/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"id": 123456,
"project_no": 1001,
"name": "サンプル案件A",
"client": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"client_branch": {"id": 123456,
"name": "サンプル支社"
},
"client_name_disp_kbn": 1,
"client_name_disp_kbn_name": "会社名のみ",
"client_name_for_post_disp_kbn": 1,
"client_name_for_post_disp_kbn_name": "会社名のみ",
"contact": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"company_branch": {"id": 123456,
"name": "サンプル支社"
},
"company_name_disp_kbn": 1,
"company_name_disp_kbn_name": "会社名のみ",
"company_name_for_post_disp_kbn": 1,
"company_name_for_post_disp_kbn_name": "会社名のみ",
"user": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"total": 100000,
"tax": 10000,
"cost_total": 10000,
"cost_tax": 1000,
"invoice_total": 100000,
"invoice_tax": 10000,
"estimate_date": "2023-10-01",
"delivery_date": "2023-10-20",
"delivery_date_text": "サンプル納期",
"payment_term_id": 123456,
"payment_term_name": "月末締め翌月末払い",
"order_status": 1,
"order_status_name": "見積中(高)",
"delivery_status": 1,
"delivery_status_name": "未着手",
"invoice_timing_kbn": 1,
"invoice_timing_kbn_name": "一括請求",
"project_type_id": 123456,
"project_type_name": "サンプル案件区分1",
"project_type2_id": 123456,
"project_type2_name": "サンプル案件区分2",
"project_type3_id": 123456,
"project_type3_name": "サンプル案件区分3",
"group_id": 123456,
"group_name": "サンプルグループ",
"tags": ["タグA",
"タグB"
],
"accounting_type_id": 123456,
"accounting_type_name": "サンプル会計区分1",
"accounting_type2_id": 123456,
"accounting_type2_name": "サンプル会計区分2",
"accounting_type3_id": 123456,
"accounting_type3_name": "サンプル会計区分3",
"in_house_memo": "サンプルメモです。",
"management_no": "TEST0001",
"ordered_date": "2023-10-05",
"payment_method_kbn": 1,
"payment_method_kbn_name": "銀行振込",
"tax_rule_kbn": 2,
"tax_rule_kbn_name": "切り捨て",
"minus_rounding_rule": 1,
"minus_rounding_rule_name": "数値を基準にする",
"to": "test@example.com",
"cc": "test@example.com",
"lock_flg": 0,
"wareki_flg": 0,
"archive_flg": 0,
"reduced_tax_rate_kbn": 1,
"document_setting_id": 123456,
"document_setting_name": "メイン用",
"project_costs": [{"cost": 10000,
"description": "サンプル費用",
"invoice_date": "2023-10-10",
"payment_date": "2023-10-10"
}
],
"currency": "JPY",
"lang_kbn": 1,
"lang_kbn_name": "日本語",
"exchange_rate": 149.43,
"total_jpy": 100000,
"tax_jpy": 10000,
"invoice_total_jpy": 100000,
"invoice_tax_jpy": 10000,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00",
"estimate": {"id": 123456,
"valid_period": "御見積後2週間",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
},
"order": {"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"disp_order_date": "2023-10-01",
"disp_order_receive_date": "2023-10-01",
"blank_date_flg": 0
},
"deliveries": [{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"delivery_date": "2023-10-01",
"disp_delivery_date": "2023-10-01",
"disp_delivery_receive_date": "2023-10-01",
"blank_date_flg": 0
}
],
"invoices": [{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"invoice_date": "2023-10-31",
"payment_limit_date": "2023-11-30",
"disp_invoice_date": "2023-10-01",
"blank_date_flg": 0,
"multi_bank_info_flg": 0
}
],
"receipts": [{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"receipt_date": "2023-10-01",
"disp_receipt_date": "2023-10-01",
"blank_date_flg": 0
}
]
}

受注ステータス変更

案件ID指定で受注ステータスを変更します。

path Parameters

required

integer

案件ID

※案件登録API・案件リスト取得APIのレスポンスにあるid

Request Body schema: application/json

order_status

required

integer

利用可能な値: 1 2 3 4 5 8 9

受注ステータス

1：見積中(高)
2：見積中(中)
3：見積中(低)
8：見積中(除)
4：受注確定
5：受注済
9：失注

Responses

Request samples

Payload
Curl

Content type

application/json

{"order_status": 1
}

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

案件のロック

案件ID指定で案件情報をロック・ロック解除します。

path Parameters

required

integer

案件ID

※案件登録API・案件リスト取得APIのレスポンスにあるid

Request Body schema: application/json

lock_flg

required

integer

利用可能な値: 0 1

ロックフラグ

0：未ロック
1：ロック済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"lock_flg": 1
}

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

案件原価

案件原価情報を扱うAPIです。

案件原価リスト取得

案件原価リストを取得します。

query Parameters

project_id_eq	integer 例: project_id_eq=123456 案件ID ※案件登録API・案件リスト取得APIのレスポンスにある`id`
created_at_gteq	string <YYYY-MM-DD HH:MM:SS> 例: created_at_gteq=2023-08-01 00:00:00 作成日時（指定日時以降） ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
created_at_lteq	string <YYYY-MM-DD HH:MM:SS> 例: created_at_lteq=2023-08-01 00:00:00 作成日時（指定日時以前） ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
invoice_date_gteq	string <YYYY-MM-DD> 例: invoice_date_gteq=2023-08-01 請求日（指定日時以降）
invoice_date_lteq	string <YYYY-MM-DD> 例: invoice_date_lteq=2023-08-01 請求日（指定日以前）
payment_date_gteq	string <YYYY-MM-DD> 例: payment_date_gteq=2023-08-01 支払日（指定日時以降）
payment_date_lteq	string <YYYY-MM-DD> 例: payment_date_lteq=2023-08-01 支払日（指定日以前）
per_page	integer デフォルト: 10 例: per_page=20 1ページあたりの要素数（最大100まで）
page	integer デフォルト: 1 例: page=2 現在のページ番号

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/project_costs' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

[{"id": 12345,
"project_id": 123456,
"description": "サンプル原価",
"cost": 10000,
"invoice_date": "2023-10-31",
"payment_date": "2023-11-30",
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}
]

案件原価登録

案件原価を新規登録します。

Request Body schema: application/json
required

project_id required	integer <int32> 案件ID ※案件登録API・案件リスト取得APIのレスポンスにある`id`
description required	string <= 100 characters 費用の説明
cost required	integer <int32> 金額
invoice_date required	string <YYYY-MM-DD> 請求日
payment_date required	string <YYYY-MM-DD> 支払日

Responses

Request samples

Payload
Curl

Content type

application/json

{"project_id": 123456,
"description": "サンプル原価",
"cost": 10000,
"invoice_date": "2023-10-31",
"payment_date": "2023-11-30"
}

Response samples

Content type

application/json

{"id": 12345,
"project_id": 123456,
"description": "サンプル原価",
"cost": 10000,
"invoice_date": "2023-10-31",
"payment_date": "2023-11-30",
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

案件原価更新

ID指定で案件原価を更新します。

path Parameters

required

integer

案件原価ID

※案件原価登録API・案件原価リスト取得APIのレスポンスにあるid

Request Body schema: application/json

description	string <= 100 characters 費用の説明
cost	integer <int32> 金額
invoice_date	string <YYYY-MM-DD> 請求日
payment_date	string <YYYY-MM-DD> 支払日

Responses

Request samples

Payload
Curl

Content type

application/json

{"project_id": 123456,
"description": "サンプル原価",
"cost": 10000,
"invoice_date": "2023-10-31",
"payment_date": "2023-11-30"
}

Response samples

Content type

application/json

{"id": 12345,
"project_id": 123456,
"description": "サンプル原価",
"cost": 10000,
"invoice_date": "2023-10-31",
"payment_date": "2023-11-30",
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

案件原価削除

ID指定で案件原価を削除します。

path Parameters

required

integer

案件原価ID

※案件原価登録API・案件原価リスト取得APIのレスポンスにあるid

Responses

Request samples

Curl

curl --location --request DELETE 'https://api.the-board.jp/v1/project_costs/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

案件原価取得

ID指定で案件原価を取得します。

path Parameters

required

integer

案件原価ID

※案件原価登録API・案件原価リスト取得APIのレスポンスにあるid

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/project_costs/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"id": 12345,
"project_id": 123456,
"description": "サンプル原価",
"cost": 10000,
"invoice_date": "2023-10-31",
"payment_date": "2023-11-30",
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

請求

請求情報を扱うAPIです。

請求リスト取得

請求リストを取得します。

query Parameters

invoice_date_gteq

string <YYYY-MM-DD>

例: invoice_date_gteq=2023-10-01

請求日（指定日以降）

invoice_date_lteq

string <YYYY-MM-DD>

例: invoice_date_lteq=2023-10-01

請求日（指定日以前）

invoice_payment_limit_date_gteq

string <YYYY-MM-DD>

例: invoice_payment_limit_date_gteq=2023-10-01

支払期限（指定日以降）

invoice_payment_limit_date_lteq

string <YYYY-MM-DD>

例: invoice_payment_limit_date_lteq=2023-10-01

支払期限（指定日以前）

project_order_status_in[]

string

例: project_order_status_in[]=4,5

受注ステータス

1：見積中(高)
2：見積中(中)
3：見積中(低)
8：見積中(除)
4：受注確定
5：受注済
9：失注

※複数の場合はカンマ区切り

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

invoice_status_in[]

string

例: invoice_status_in[]=4,5

請求ステータス

1：未請求
4：請求OK
2：請求済
5：一部入金済
3：入金済
9：回収不能

※複数の場合はカンマ区切り

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

project_project_no_eq

integer

例: project_project_no_eq=1001

案件No

updated_at_gteq

string <YYYY-MM-DD HH:MM:SS>

例: updated_at_gteq=2023-08-01 00:00:00

更新日時（指定日時以降）

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

updated_at_lteq

string <YYYY-MM-DD HH:MM:SS>

例: updated_at_lteq=2023-08-01 00:00:00

更新日時（指定日時以前）

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

per_page

integer

デフォルト: 10

例: per_page=20

1ページあたりの要素数（最大100まで）

page

integer

デフォルト: 1

例: page=2

現在のページ番号

response_group

string

デフォルト: "small"

利用可能な値: "small" "medium" "large" "estimate" "order" "delivery" "invoice" "receipt" "project_cost" "all"

例: response_group=large

レスポンスグループ

response_group	項目
small	id, project_id, project_no, management_no, name, client, contact, user, total, tax, cost_total, cost_tax, invoice_date, payment_limit_date, order_status, order_status_name, invoice_status, invoice_status_name, project_type_id, project_type_name, project_type2_id, project_type2_name, project_type3_id, project_type3_name, group_id, group_name, paid_date, currency, created_at, updated_at
medium	smallに加え以下の項目 client_branch, company_branch, tags, exchange_rate, total_jpy, tax_jpy
large	書類以外すべての項目
invoice	small + 請求書

※レスポンスグループについて

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/invoices' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

[{"id": 123456,
"project_id": 123456,
"project_no": 1001,
"management_no": "TEST0001",
"name": "サンプル案件A",
"client": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"client_branch": {"id": 123456,
"name": "サンプル支社"
},
"contact": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"company_branch": {"id": 123456,
"name": "サンプル支社"
},
"user": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"total": 100000,
"tax": 10000,
"cost_total": 10000,
"cost_tax": 1000,
"invoice_date": "2023-10-31",
"payment_limit_date": "2023-11-30",
"order_status": 1,
"order_status_name": "見積中(高)",
"invoice_status": 1,
"invoice_status_name": "未請求",
"project_type_id": 123456,
"project_type_name": "サンプル案件区分1",
"project_type2_id": 123456,
"project_type2_name": "サンプル案件区分2",
"project_type3_id": 123456,
"project_type3_name": "サンプル案件区分3",
"group_id": 123456,
"group_name": "サンプルグループ",
"paid_date": "2023-10-01",
"tags": ["タグA",
"タグB"
],
"accounting_type_id": 123456,
"accounting_type_name": "サンプル会計区分1",
"accounting_type2_id": 123456,
"accounting_type2_name": "サンプル会計区分2",
"accounting_type3_id": 123456,
"accounting_type3_name": "サンプル会計区分3",
"lock_flg": 0,
"currency": "JPY",
"lang_kbn": 1,
"lang_kbn_name": "日本語",
"exchange_rate": 149.43,
"total_jpy": 100000,
"tax_jpy": 10000,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00",
"invoice": {"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"invoice_date": "2023-10-31",
"payment_limit_date": "2023-11-30",
"disp_invoice_date": "2023-10-01",
"blank_date_flg": 0,
"multi_bank_info_flg": 0
}
}
]

請求ステータス変更

請求ID指定で請求ステータスを変更します。

path Parameters

required

integer

請求ID

※請求リスト取得APIのレスポンスにあるid

Request Body schema: application/json

invoice_status

required

integer

利用可能な値: 1 2 3 4 5 9

請求ステータス

1：未請求
4：請求OK
2：請求済
5：一部入金済
3：入金済
9：回収不能

Responses

Request samples

Payload
Curl

Content type

application/json

{"invoice_status": 1
}

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

書類（案件）

案件の書類を扱うAPIです。

見積書更新

ID指定で見積書を更新します。

path Parameters

required

integer

見積書ID

※案件登録API・案件リスト取得API・案件取得APIのレスポンスにあるestimate内のid（要レスポンスグループ指定）

Request Body schema: application/json

valid_period	string <= 100 characters 有効期限
message	string <= 5000 characters 備考
total	number <decimal> < 1000000000 小計 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
tax	number <decimal> < 1000000000 消費税 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
tax_withholding	number <decimal> < 1000000000 源泉所得税 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
document_amount_disp_kbn	integer 利用可能な値: 1 2 3 4 金額表示 1：税込表示 2：合計欄を税抜表示＋明細下の小計・消費税行非表示 3：合計欄のみ税抜表示 4：合計表示なし ※デフォルトは「デフォルト設定」によって決まります
delivery_place	string <= 100 characters 納品場所
	Array of objects 明細行
blank_date_flg	integer デフォルト: 0 利用可能な値: 0 1 見積日空欄 0：表示 1：空欄にする

Responses

Request samples

Payload
Curl

Content type

application/json

{"valid_period": "御見積後2週間",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"document_amount_disp_kbn": 1,
"delivery_place": "サンプル倉庫",
"details": [{"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"deduction_applicable": true
}
],
"blank_date_flg": 0
}

Response samples

Content type

application/json

{"id": 123456,
"valid_period": "御見積後2週間",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
}

見積書取得

ID指定で見積書を取得します。

path Parameters

required

integer

見積書ID

※案件登録API・案件リスト取得API・案件取得APIのレスポンスにあるestimate内のid（要レスポンスグループ指定）

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/documents/estimates/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"id": 123456,
"valid_period": "御見積後2週間",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
}

見積書ロック

ID指定で見積書のロック状態を変更します。

path Parameters

required

integer

見積書ID

※案件登録API・案件リスト取得API・案件取得APIのレスポンスにあるestimate内のid（要レスポンスグループ指定）

Request Body schema: application/json

lock_flg

integer

利用可能な値: 0 1

ロックフラグ

0：未ロック
1：ロック済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"lock_flg": 1
}

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

発注書更新

ID指定で発注書を更新します。

path Parameters

required

integer

発注書ID

※案件登録API・案件リスト取得API・案件取得APIのレスポンスにあるorder内のid（要レスポンスグループ指定）

Request Body schema: application/json

message	string <= 5000 characters 備考
total	number <decimal> < 1000000000 小計 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
tax	number <decimal> < 1000000000 消費税 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
tax_withholding	number <decimal> < 1000000000 源泉所得税 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
document_amount_disp_kbn	integer 利用可能な値: 1 2 3 4 金額表示 1：税込表示 2：合計欄を税抜表示＋明細下の小計・消費税行非表示 3：合計欄のみ税抜表示 4：合計表示なし ※デフォルトは「デフォルト設定」によって決まります
delivery_place	string <= 100 characters 納品場所
	Array of objects 明細行
disp_order_date	string <YYYY-MM-DD> 発注日（表示設定）
disp_order_receive_date	string <YYYY-MM-DD> 発注請日（表示設定）
blank_date_flg	integer デフォルト: 0 利用可能な値: 0 1 発注請日空欄 0：表示 1：空欄にする

Responses

Request samples

Payload
Curl

Content type

application/json

{"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"document_amount_disp_kbn": 1,
"delivery_place": "サンプル倉庫",
"details": [{"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"deduction_applicable": true
}
],
"disp_order_date": "2023-10-01",
"disp_order_receive_date": "2023-10-01",
"blank_date_flg": 0
}

Response samples

Content type

application/json

{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"disp_order_date": "2023-10-01",
"disp_order_receive_date": "2023-10-01",
"blank_date_flg": 0
}

発注書取得

ID指定で発注書を取得します。

path Parameters

required

integer

発注書ID

※案件登録API・案件リスト取得API・案件取得APIのレスポンスにあるorder内のid（要レスポンスグループ指定）

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/documents/orders/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"disp_order_date": "2023-10-01",
"disp_order_receive_date": "2023-10-01",
"blank_date_flg": 0
}

発注書ロック

ID指定で発注書のロック状態を変更します。

path Parameters

required

integer

発注書ID

※案件登録API・案件リスト取得API・案件取得APIのレスポンスにあるorder内のid（要レスポンスグループ指定）

Request Body schema: application/json

lock_flg

integer

利用可能な値: 0 1

ロックフラグ

0：未ロック
1：ロック済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"lock_flg": 1
}

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

納品書更新

ID指定で納品書を更新します。

path Parameters

required

integer

納品書ID

※案件登録API・案件リスト取得API・案件取得APIのレスポンスにあるdeliveries内のid（要レスポンスグループ指定）

Request Body schema: application/json

message	string <= 5000 characters 備考
total	number <decimal> < 1000000000 小計 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
tax	number <decimal> < 1000000000 消費税 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
tax_withholding	number <decimal> < 1000000000 源泉所得税 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
document_amount_disp_kbn	integer 利用可能な値: 1 2 3 4 金額表示 1：税込表示 2：合計欄を税抜表示＋明細下の小計・消費税行非表示 3：合計欄のみ税抜表示 4：合計表示なし ※デフォルトは「デフォルト設定」によって決まります
delivery_place	string <= 100 characters 納品場所
	Array of objects 明細行
delivery_date	string <YYYY-MM-DD> 納品日
disp_delivery_date	string <YYYY-MM-DD> 納品日（表示設定）
disp_delivery_receive_date	string <YYYY-MM-DD> 検収日（表示設定）
blank_date_flg	integer デフォルト: 0 利用可能な値: 0 1 納品日空欄 0：表示 1：空欄にする

Responses

Request samples

Payload
Curl

Content type

application/json

{"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"document_amount_disp_kbn": 1,
"delivery_place": "サンプル倉庫",
"details": [{"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"deduction_applicable": true
}
],
"delivery_date": "2023-10-01",
"disp_delivery_date": "2023-10-01",
"disp_delivery_receive_date": "2023-10-01",
"blank_date_flg": 0
}

Response samples

Content type

application/json

{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"delivery_date": "2023-10-01",
"disp_delivery_date": "2023-10-01",
"disp_delivery_receive_date": "2023-10-01",
"blank_date_flg": 0
}

納品書取得

ID指定で納品書を取得します。

path Parameters

required

integer

納品書ID

※案件登録API・案件リスト取得API・案件取得APIのレスポンスにあるdeliveries内のid（要レスポンスグループ指定）

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/documents/deliveries/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"delivery_date": "2023-10-01",
"disp_delivery_date": "2023-10-01",
"disp_delivery_receive_date": "2023-10-01",
"blank_date_flg": 0
}

納品書ロック

ID指定で納品書のロック状態を変更します。

path Parameters

required

integer

納品書ID

※案件登録API・案件リスト取得API・案件取得APIのレスポンスにあるdeliveries内のid（要レスポンスグループ指定）

Request Body schema: application/json

lock_flg

integer

利用可能な値: 0 1

ロックフラグ

0：未ロック
1：ロック済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"lock_flg": 1
}

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

請求書更新

ID指定で請求書を更新します。

path Parameters

required

integer

請求書ID

※案件登録API・案件リスト取得API・案件取得APIのレスポンスにあるinvoices内のid（要レスポンスグループ指定）

Request Body schema: application/json

message	string <= 5000 characters 備考
total	number <decimal> < 1000000000 小計 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
tax	number <decimal> < 1000000000 消費税 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
tax_withholding	number <decimal> < 1000000000 源泉所得税 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
document_amount_disp_kbn	integer 利用可能な値: 1 2 3 4 金額表示 1：税込表示 2：合計欄を税抜表示＋明細下の小計・消費税行非表示 3：合計欄のみ税抜表示 4：合計表示なし ※デフォルトは「デフォルト設定」によって決まります
delivery_place	string <= 100 characters 納品場所
	Array of objects 明細行
disp_invoice_date	string <YYYY-MM-DD> 請求日（表示設定）
blank_date_flg	integer デフォルト: 0 利用可能な値: 0 1 請求日空欄 0：表示 1：空欄にする
multi_bank_info_flg	integer 利用可能な値: 0 1 複数口座表示 0：OFF 1：ON ※デフォルトは設定による

Responses

Request samples

Payload
Curl

Content type

application/json

{"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"document_amount_disp_kbn": 1,
"delivery_place": "サンプル倉庫",
"details": [{"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"deduction_applicable": true
}
],
"disp_invoice_date": "2023-10-01",
"blank_date_flg": 0,
"multi_bank_info_flg": 0
}

Response samples

Content type

application/json

{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"invoice_date": "2023-10-31",
"payment_limit_date": "2023-11-30",
"disp_invoice_date": "2023-10-01",
"blank_date_flg": 0,
"multi_bank_info_flg": 0
}

請求書取得

ID指定で請求書を取得します。

path Parameters

required

integer

請求書ID

※案件登録API・案件リスト取得API・案件取得APIのレスポンスにあるinvoices内のid（要レスポンスグループ指定）

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/documents/invoices/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"invoice_date": "2023-10-31",
"payment_limit_date": "2023-11-30",
"disp_invoice_date": "2023-10-01",
"blank_date_flg": 0,
"multi_bank_info_flg": 0
}

請求書ロック

ID指定で請求書のロック状態を変更します。

path Parameters

required

integer

請求書ID

※案件登録API・案件リスト取得API・案件取得APIのレスポンスにあるinvoices内のid（要レスポンスグループ指定）

Request Body schema: application/json

lock_flg

integer

利用可能な値: 0 1

ロックフラグ

0：未ロック
1：ロック済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"lock_flg": 1
}

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

領収書更新

ID指定で領収書を更新します。

path Parameters

required

integer

領収書ID

※案件登録API・案件リスト取得API・案件取得APIのレスポンスにあるreceipts内のid（要レスポンスグループ指定）

Request Body schema: application/json

message	string <= 5000 characters 備考
total	number <decimal> < 1000000000 小計 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
tax	number <decimal> < 1000000000 消費税 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
tax_withholding	number <decimal> < 1000000000 源泉所得税 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
document_amount_disp_kbn	integer 利用可能な値: 1 2 3 4 金額表示 1：税込表示 2：合計欄を税抜表示＋明細下の小計・消費税行非表示 3：合計欄のみ税抜表示 4：合計表示なし ※デフォルトは「デフォルト設定」によって決まります
delivery_place	string <= 100 characters 納品場所
	Array of objects 明細行
disp_receipt_date	string <YYYY-MM-DD> 発行日（表示設定）
blank_date_flg	integer デフォルト: 0 利用可能な値: 0 1 発行日空欄 0：表示 1：空欄にする

Responses

Request samples

Payload
Curl

Content type

application/json

{"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"document_amount_disp_kbn": 1,
"delivery_place": "サンプル倉庫",
"details": [{"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"deduction_applicable": true
}
],
"disp_receipt_date": "2023-10-01",
"blank_date_flg": 0
}

Response samples

Content type

application/json

{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"receipt_date": "2023-10-01",
"disp_receipt_date": "2023-10-01",
"blank_date_flg": 0
}

領収書取得

ID指定で領収書を取得します。

path Parameters

required

integer

領収書ID

※案件登録API・案件リスト取得API・案件取得APIのレスポンスにあるreceipts内のid（要レスポンスグループ指定）

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/documents/receipts/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"id": 123456,
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"receipt_date": "2023-10-01",
"disp_receipt_date": "2023-10-01",
"blank_date_flg": 0
}

領収書ロック

ID指定で領収書のロック状態を変更します。

path Parameters

required

integer

領収書ID

※案件登録API・案件リスト取得API・案件取得APIのレスポンスにあるreceipts内のid（要レスポンスグループ指定）

Request Body schema: application/json

lock_flg

integer

利用可能な値: 0 1

ロックフラグ

0：未ロック
1：ロック済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"lock_flg": 1
}

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

発注先

発注先情報を扱うAPIです。

発注先リスト取得

発注先リストを取得します。

query Parameters

tags[]

string

例: tags[]=サンプルタグA,サンプルタグB

タグ（複数の場合はカンマ区切り）

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

include_archive_flg

integer

デフォルト: 0

利用可能な値: 0 1

例: include_archive_flg=1

アーカイブを含むか

0：アーカイブ済みは除く
1：アーカイブ済みも含む

updated_at_gteq

string <YYYY-MM-DD HH:MM:SS>

例: updated_at_gteq=2023-08-01 00:00:00

更新日時（指定日時以降）

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

updated_at_lteq

string <YYYY-MM-DD HH:MM:SS>

例: updated_at_lteq=2023-08-01 00:00:00

更新日時（指定日時以前）

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

custom_no_eq

string

例: custom_no_eq=12345

発注先番号

per_page

integer

デフォルト: 10

例: per_page=20

1ページあたりの要素数（最大100まで）

page

integer

デフォルト: 1

例: page=2

現在のページ番号

response_group

string

デフォルト: "small"

利用可能な値: "small" "large"

例: response_group=large

レスポンスグループ

response_group	項目
small	id, name, name_disp, title, zip, pref, address1, address2, tel, fax, payment_term_id, payment_term_name, company_number, invoice_system_number, invoice_system_number_validated, invoice_system_issuer_type, invoice_system_issuer_type_name, created_at, updated_at
large	すべての項目

※レスポンスグループについて

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/payees' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

[{"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"title": "御中",
"payment_term_id": 123456,
"payment_term_name": "月末締め翌月末払い",
"nda_flg": 0,
"basic_agreement_flg": 0,
"document_send_type": 1,
"document_send_type_name": "メール(DL)",
"note": "備考サンプルです",
"tags": ["タグA",
"タグB"
],
"wareki_flg": 0,
"company_number": "1234567890123",
"accounting_code": "サンプル（株）",
"to": "test@example.com",
"cc": "test@example.com",
"invoice_system_number": "T1234567890123",
"invoice_system_number_validated": true,
"invoice_system_issuer_type": 0,
"invoice_system_issuer_type_name": "未設定",
"bank_charge_to_client_flg": 1,
"tax_withholding_kbn": 1,
"tax_withholding_kbn_name": "なし",
"custom_no": "C0001",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": "81",
"currency": "USD",
"lang_kbn": 1,
"lang_kbn_name": "日本語",
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}
]

発注先登録

発注先を新規登録します。

Request Body schema: application/json
required

name required	string <= 100 characters 発注先名
name_disp required	string <= 50 characters 発注先略称名
zip	string <= 8 characters 郵便番号（ハイフン区切り）
pref	string 都道府県
address1	string <= 100 characters 市区町村・番地
address2	string <= 100 characters 建物名
tel	string <= 15 characters TEL（ハイフン区切り）
fax	string <= 15 characters FAX（ハイフン区切り）
title	string <= 50 characters デフォルト: "御中" 敬称
payment_term_id	integer <int32> デフォルト支払条件ID 新規登録時に未指定の場合は最初の支払条件が使用されます支払条件リスト取得APIのレスポンスにある`id`です
nda_flg	integer <int32> デフォルト: 0 利用可能な値: 0 1 NDA締結 0：未 1：済
basic_agreement_flg	integer <int32> デフォルト: 0 利用可能な値: 0 1 基本契約書締結 0：未 1：済
document_send_type	integer <int32> デフォルト: 1 書類送付方法 1：メール(DL) 2：郵送 3：メール(DL)+郵送 4：メール(添付) 5：メール(添付)+郵送またはカスタム書類送付方法のID
note	string <= 1000 characters 備考
tags	Array of strings タグ ※タグ名の配列
wareki_flg	integer <int32> デフォルト: 0 利用可能な値: 0 1 デフォルト和暦表示 0：西暦 1：和暦 ※「和暦表示」機能有効時のみ
company_number	string = 13 characters 法人番号
accounting_code	string <= 100 characters 会計用名称・コード ※「会計連携機能」機能有効時のみ
to	string <= 1000 characters TO（メールアドレス） ※複数指定する場合はカンマ区切り
cc	string <= 1000 characters CC（メールアドレス） ※複数指定する場合はカンマ区切り
invoice_system_number	string = 14 characters 適格請求書発行事業者の登録番号
invoice_system_issuer_type	integer <int32> デフォルト: 0 利用可能な値: 0 1 2 適格請求書発行事業者 0：未設定 1：該当する 2：該当しない
bank_charge_to_client_flg	integer <int32> デフォルト: 0 利用可能な値: 0 1 振込手数料負担 0：当方 1：先方
tax_withholding_kbn	integer <int32> デフォルト: 1 利用可能な値: 1 2 3 デフォルト源泉徴収 1：なし 2：源泉徴収（復興特別所得税あり） 3：源泉徴収（復興特別所得税なし）
custom_no	string <= 100 characters 発注先番号
name_en	string <= 100 characters 発注先名（英語表記） ※英語アドオン有効時のみ
address_en	string <= 500 characters 住所（英語表記） ※英語アドオン有効時のみ
phone_country_code	string <= 10 characters 国番号（英語表記） ※英語アドオン有効時のみ
currency	string <= 3 characters デフォルト: "JPY" 利用可能な値: "JPY" "USD" "EUR" "GBP" "CNY" "HKD" "TWD" "KRW" "SGD" "AUD" "IDR" "THB" "CAD" デフォルト通貨 ※英語アドオン有効時のみ
lang_kbn	integer <int32> デフォルト: 1 利用可能な値: 1 2 デフォルト言語 1：日本語 2：英語 ※英語アドオン有効時のみ
archive_flg	integer <int32> 利用可能な値: 0 1 アーカイブ状態 0：未アーカイブ 1：アーカイブ済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"name": "サンプル株式会社",
"name_disp": "サンプル",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"title": "御中",
"payment_term_id": 123456,
"nda_flg": 0,
"basic_agreement_flg": 0,
"document_send_type": 1,
"note": "備考サンプルです",
"tags": ["タグA",
"タグB"
],
"wareki_flg": 0,
"company_number": "1234567890123",
"accounting_code": "サンプル（株）",
"to": "test@example.com",
"cc": "test@example.com",
"invoice_system_number": "T1234567890123",
"invoice_system_issuer_type": 0,
"bank_charge_to_client_flg": 1,
"tax_withholding_kbn": 1,
"custom_no": "C0001",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": "81",
"currency": "USD",
"lang_kbn": 1,
"archive_flg": 0
}

Response samples

Content type

application/json

{"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"title": "御中",
"payment_term_id": 123456,
"payment_term_name": "月末締め翌月末払い",
"nda_flg": 0,
"basic_agreement_flg": 0,
"document_send_type": 1,
"document_send_type_name": "メール(DL)",
"note": "備考サンプルです",
"tags": ["タグA",
"タグB"
],
"wareki_flg": 0,
"company_number": "1234567890123",
"accounting_code": "サンプル（株）",
"to": "test@example.com",
"cc": "test@example.com",
"invoice_system_number": "T1234567890123",
"invoice_system_number_validated": true,
"invoice_system_issuer_type": 0,
"invoice_system_issuer_type_name": "未設定",
"bank_charge_to_client_flg": 1,
"tax_withholding_kbn": 1,
"tax_withholding_kbn_name": "なし",
"custom_no": "C0001",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": "81",
"currency": "USD",
"lang_kbn": 1,
"lang_kbn_name": "日本語",
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

発注先更新

ID指定で発注先を更新します。

path Parameters

required

integer

発注先ID

※発注先登録API・発注先リスト取得APIのレスポンスにあるid

Request Body schema: application/json

name	string <= 100 characters 発注先名
name_disp	string <= 50 characters 発注先略称名
zip	string <= 8 characters 郵便番号（ハイフン区切り）
pref	string 都道府県
address1	string <= 100 characters 市区町村・番地
address2	string <= 100 characters 建物名
tel	string <= 15 characters TEL（ハイフン区切り）
fax	string <= 15 characters FAX（ハイフン区切り）
title	string <= 50 characters デフォルト: "御中" 敬称
payment_term_id	integer <int32> デフォルト支払条件ID 新規登録時に未指定の場合は最初の支払条件が使用されます支払条件リスト取得APIのレスポンスにある`id`です
nda_flg	integer <int32> デフォルト: 0 利用可能な値: 0 1 NDA締結 0：未 1：済
basic_agreement_flg	integer <int32> デフォルト: 0 利用可能な値: 0 1 基本契約書締結 0：未 1：済
document_send_type	integer <int32> デフォルト: 1 書類送付方法 1：メール(DL) 2：郵送 3：メール(DL)+郵送 4：メール(添付) 5：メール(添付)+郵送またはカスタム書類送付方法のID
note	string <= 1000 characters 備考
tags	Array of strings タグ ※タグ名の配列
wareki_flg	integer <int32> デフォルト: 0 利用可能な値: 0 1 デフォルト和暦表示 0：西暦 1：和暦 ※「和暦表示」機能有効時のみ
company_number	string = 13 characters 法人番号
accounting_code	string <= 100 characters 会計用名称・コード ※「会計連携機能」機能有効時のみ
to	string <= 1000 characters TO（メールアドレス） ※複数指定する場合はカンマ区切り
cc	string <= 1000 characters CC（メールアドレス） ※複数指定する場合はカンマ区切り
invoice_system_number	string = 14 characters 適格請求書発行事業者の登録番号
invoice_system_issuer_type	integer <int32> デフォルト: 0 利用可能な値: 0 1 2 適格請求書発行事業者 0：未設定 1：該当する 2：該当しない
bank_charge_to_client_flg	integer <int32> デフォルト: 0 利用可能な値: 0 1 振込手数料負担 0：当方 1：先方
tax_withholding_kbn	integer <int32> デフォルト: 1 利用可能な値: 1 2 3 デフォルト源泉徴収 1：なし 2：源泉徴収（復興特別所得税あり） 3：源泉徴収（復興特別所得税なし）
custom_no	string <= 100 characters 発注先番号
name_en	string <= 100 characters 発注先名（英語表記） ※英語アドオン有効時のみ
address_en	string <= 500 characters 住所（英語表記） ※英語アドオン有効時のみ
phone_country_code	string <= 10 characters 国番号（英語表記） ※英語アドオン有効時のみ
currency	string <= 3 characters デフォルト: "JPY" 利用可能な値: "JPY" "USD" "EUR" "GBP" "CNY" "HKD" "TWD" "KRW" "SGD" "AUD" "IDR" "THB" "CAD" デフォルト通貨 ※英語アドオン有効時のみ
lang_kbn	integer <int32> デフォルト: 1 利用可能な値: 1 2 デフォルト言語 1：日本語 2：英語 ※英語アドオン有効時のみ
archive_flg	integer <int32> 利用可能な値: 0 1 アーカイブ状態 0：未アーカイブ 1：アーカイブ済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"name": "サンプル株式会社",
"name_disp": "サンプル",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"title": "御中",
"payment_term_id": 123456,
"nda_flg": 0,
"basic_agreement_flg": 0,
"document_send_type": 1,
"note": "備考サンプルです",
"tags": ["タグA",
"タグB"
],
"wareki_flg": 0,
"company_number": "1234567890123",
"accounting_code": "サンプル（株）",
"to": "test@example.com",
"cc": "test@example.com",
"invoice_system_number": "T1234567890123",
"invoice_system_issuer_type": 0,
"bank_charge_to_client_flg": 1,
"tax_withholding_kbn": 1,
"custom_no": "C0001",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": "81",
"currency": "USD",
"lang_kbn": 1,
"archive_flg": 0
}

Response samples

Content type

application/json

{"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"title": "御中",
"payment_term_id": 123456,
"payment_term_name": "月末締め翌月末払い",
"nda_flg": 0,
"basic_agreement_flg": 0,
"document_send_type": 1,
"document_send_type_name": "メール(DL)",
"note": "備考サンプルです",
"tags": ["タグA",
"タグB"
],
"wareki_flg": 0,
"company_number": "1234567890123",
"accounting_code": "サンプル（株）",
"to": "test@example.com",
"cc": "test@example.com",
"invoice_system_number": "T1234567890123",
"invoice_system_number_validated": true,
"invoice_system_issuer_type": 0,
"invoice_system_issuer_type_name": "未設定",
"bank_charge_to_client_flg": 1,
"tax_withholding_kbn": 1,
"tax_withholding_kbn_name": "なし",
"custom_no": "C0001",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": "81",
"currency": "USD",
"lang_kbn": 1,
"lang_kbn_name": "日本語",
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

発注先削除

ID指定で発注先を削除します。

path Parameters

required

integer

発注先ID

※発注先登録API・発注先リスト取得APIのレスポンスにあるid

Responses

Request samples

Curl

curl --location --request DELETE 'https://api.the-board.jp/v1/payees/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

発注先取得

ID指定で発注先を取得します。

path Parameters

required

integer

発注先ID

※発注先登録API・発注先リスト取得APIのレスポンスにあるid

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/payees/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"title": "御中",
"payment_term_id": 123456,
"payment_term_name": "月末締め翌月末払い",
"nda_flg": 0,
"basic_agreement_flg": 0,
"document_send_type": 1,
"document_send_type_name": "メール(DL)",
"note": "備考サンプルです",
"tags": ["タグA",
"タグB"
],
"wareki_flg": 0,
"company_number": "1234567890123",
"accounting_code": "サンプル（株）",
"to": "test@example.com",
"cc": "test@example.com",
"invoice_system_number": "T1234567890123",
"invoice_system_number_validated": true,
"invoice_system_issuer_type": 0,
"invoice_system_issuer_type_name": "未設定",
"bank_charge_to_client_flg": 1,
"tax_withholding_kbn": 1,
"tax_withholding_kbn_name": "なし",
"custom_no": "C0001",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": "81",
"currency": "USD",
"lang_kbn": 1,
"lang_kbn_name": "日本語",
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

発注先支社

発注先支社情報を扱うAPIです。

発注先支社リスト取得

発注先支社リストを取得します。

query Parameters

payee_id_eq	integer 例: payee_id_eq=123456 発注先ID ※発注先登録API・発注先リスト取得APIのレスポンスにある`id`
include_archive_flg	integer デフォルト: 0 利用可能な値: 0 1 例: include_archive_flg=1 アーカイブを含むか 0：アーカイブ済みは除く 1：アーカイブ済みも含む
updated_at_gteq	string <YYYY-MM-DD HH:MM:SS> 例: updated_at_gteq=2023-08-01 00:00:00 更新日時（指定日時以降） ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
updated_at_lteq	string <YYYY-MM-DD HH:MM:SS> 例: updated_at_lteq=2023-08-01 00:00:00 更新日時（指定日時以前） ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
per_page	integer デフォルト: 10 例: per_page=20 1ページあたりの要素数（最大100まで）
page	integer デフォルト: 1 例: page=2 現在のページ番号

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/payee_branches' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

[{"id": 12345,
"payee": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"name": "サンプル支社",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": 81,
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}
]

発注先支社登録

発注先支社を新規登録します。

Request Body schema: application/json
required

payee_id required	integer <int32> 発注先ID ※発注先登録API・発注先リスト取得APIのレスポンスにある`id`
name required	string <= 100 characters 発注先支社名
zip	string <= 8 characters 郵便番号（ハイフン区切り）
pref	string 都道府県
address1	string <= 100 characters 市区町村・番地
address2	string <= 100 characters 建物名
tel	string <= 15 characters TEL（ハイフン区切り）
fax	string <= 15 characters FAX（ハイフン区切り）
name_en	string <= 100 characters 発注先支社名（英語表記） ※英語アドオン有効時のみ
address_en	string <= 500 characters 住所（英語表記） ※英語アドオン有効時のみ
phone_country_code	string <= 10 characters 国番号（英語表記） ※英語アドオン有効時のみ
archive_flg	integer <int32> 利用可能な値: 0 1 アーカイブ状態 0：未アーカイブ 1：アーカイブ済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"payee_id": 123456,
"name": "サンプル支社",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": 81,
"archive_flg": 0
}

Response samples

Content type

application/json

{"id": 12345,
"payee": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"name": "サンプル支社",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": 81,
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

発注先支社更新

ID指定で発注先支社を更新します。

path Parameters

required

integer

発注先支社ID

※発注先支社登録API・発注先支社リスト取得APIのレスポンスにあるid

Request Body schema: application/json

payee_id	integer <int32> 発注先ID ※発注先登録API・発注先リスト取得APIのレスポンスにある`id`
name	string <= 100 characters 発注先支社名
zip	string <= 8 characters 郵便番号（ハイフン区切り）
pref	string 都道府県
address1	string <= 100 characters 市区町村・番地
address2	string <= 100 characters 建物名
tel	string <= 15 characters TEL（ハイフン区切り）
fax	string <= 15 characters FAX（ハイフン区切り）
name_en	string <= 100 characters 発注先支社名（英語表記） ※英語アドオン有効時のみ
address_en	string <= 500 characters 住所（英語表記） ※英語アドオン有効時のみ
phone_country_code	string <= 10 characters 国番号（英語表記） ※英語アドオン有効時のみ
archive_flg	integer <int32> 利用可能な値: 0 1 アーカイブ状態 0：未アーカイブ 1：アーカイブ済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"payee_id": 123456,
"name": "サンプル支社",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": 81,
"archive_flg": 0
}

Response samples

Content type

application/json

{"id": 12345,
"payee": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"name": "サンプル支社",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": 81,
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

発注先支社削除

ID指定で発注先支社を削除します。

path Parameters

required

integer

発注先支社ID

※発注先支社登録API・発注先支社リスト取得APIのレスポンスにあるid

Responses

Request samples

Curl

curl --location --request DELETE 'https://api.the-board.jp/v1/payee_branches/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

発注先支社取得

ID指定で発注先支社を取得します。

path Parameters

required

integer

発注先支社ID

※発注先支社登録API・発注先支社リスト取得APIのレスポンスにあるid

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/payee_branches/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"id": 12345,
"payee": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"name": "サンプル支社",
"zip": "100-0001",
"pref": "東京都",
"address1": "千代田区千代田111",
"address2": "サンプルビル3階",
"tel": "03-0000-0000",
"fax": "03-0000-0000",
"name_en": "Sample, inc",
"address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
"phone_country_code": 81,
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

発注先担当者

発注先担当者情報を扱うAPIです。

発注先担当者リスト取得

発注先担当者リストを取得します。

query Parameters

payee_id_eq	integer 例: payee_id_eq=123456 発注先ID ※発注先登録API・発注先リスト取得APIのレスポンスにある`id`
include_archive_flg	integer デフォルト: 0 利用可能な値: 0 1 例: include_archive_flg=1 アーカイブを含むか 0：アーカイブ済みは除く 1：アーカイブ済みも含む
updated_at_gteq	string <YYYY-MM-DD HH:MM:SS> 例: updated_at_gteq=2023-08-01 00:00:00 更新日時（指定日時以降） ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
updated_at_lteq	string <YYYY-MM-DD HH:MM:SS> 例: updated_at_lteq=2023-08-01 00:00:00 更新日時（指定日時以前） ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
per_page	integer デフォルト: 10 例: per_page=20 1ページあたりの要素数（最大100まで）
page	integer デフォルト: 1 例: page=2 現在のページ番号

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/payee_contacts' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

[{"id": 12345,
"payee": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"last_name": "山田",
"first_name": "太郎",
"honorific_title": "様",
"title": "部長",
"department": "システム部",
"email": "yamada@example.com",
"note": "備考サンプルです",
"archive_flg": 0,
"last_name_en": "Yamada",
"first_name_en": "Taro",
"prefix_en": "Mr.",
"title_en": "Manager",
"department_en": "IT Dept.",
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}
]

発注先担当者登録

発注先担当者を新規登録します。

Request Body schema: application/json
required

payee_id required	integer <int32> 発注先ID ※発注先登録API・発注先リスト取得APIのレスポンスにある`id`
last_name required	string <= 50 characters 姓
first_name	string <= 50 characters 名
honorific_title	string <= 50 characters 敬称
title	string <= 50 characters 肩書
department	string <= 50 characters 部署
email	string <= 100 characters email
note	string <= 1000 characters 備考
archive_flg	integer <int32> 利用可能な値: 0 1 アーカイブ状態 0：未アーカイブ 1：アーカイブ済み
last_name_en	string <= 50 characters 姓（英語表記） ※英語アドオン有効時のみ
first_name_en	string <= 50 characters 名（英語表記） ※英語アドオン有効時のみ
prefix_en	string <= 50 characters 敬称（英語表記） ※英語アドオン有効時のみ
title_en	string <= 50 characters 肩書（英語表記） ※英語アドオン有効時のみ
department_en	string <= 50 characters 部署（英語表記） ※英語アドオン有効時のみ

Responses

Request samples

Payload
Curl

Content type

application/json

{"payee_id": 123456,
"last_name": "山田",
"first_name": "太郎",
"honorific_title": "様",
"title": "部長",
"department": "システム部",
"email": "yamada@example.com",
"note": "備考サンプルです",
"archive_flg": 0,
"last_name_en": "Yamada",
"first_name_en": "Taro",
"prefix_en": "Mr.",
"title_en": "Manager",
"department_en": "IT Dept."
}

Response samples

Content type

application/json

{"id": 12345,
"payee": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"last_name": "山田",
"first_name": "太郎",
"honorific_title": "様",
"title": "部長",
"department": "システム部",
"email": "yamada@example.com",
"note": "備考サンプルです",
"archive_flg": 0,
"last_name_en": "Yamada",
"first_name_en": "Taro",
"prefix_en": "Mr.",
"title_en": "Manager",
"department_en": "IT Dept.",
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

発注先担当者更新

ID指定で発注先担当者を更新します。

path Parameters

required

integer

発注先担当者ID

※発注先担当者登録API・発注先担当者リスト取得APIのレスポンスにあるid

Request Body schema: application/json

payee_id	integer <int32> 発注先ID ※発注先登録API・発注先リスト取得APIのレスポンスにある`id`
last_name	string <= 50 characters 姓
first_name	string <= 50 characters 名
honorific_title	string <= 50 characters 敬称
title	string <= 50 characters 肩書
department	string <= 50 characters 部署
email	string <= 100 characters email
note	string <= 1000 characters 備考
archive_flg	integer <int32> 利用可能な値: 0 1 アーカイブ状態 0：未アーカイブ 1：アーカイブ済み
last_name_en	string <= 50 characters 姓（英語表記） ※英語アドオン有効時のみ
first_name_en	string <= 50 characters 名（英語表記） ※英語アドオン有効時のみ
prefix_en	string <= 50 characters 敬称（英語表記） ※英語アドオン有効時のみ
title_en	string <= 50 characters 肩書（英語表記） ※英語アドオン有効時のみ
department_en	string <= 50 characters 部署（英語表記） ※英語アドオン有効時のみ

Responses

Request samples

Payload
Curl

Content type

application/json

{"payee_id": 123456,
"last_name": "山田",
"first_name": "太郎",
"honorific_title": "様",
"title": "部長",
"department": "システム部",
"email": "yamada@example.com",
"note": "備考サンプルです",
"archive_flg": 0,
"last_name_en": "Yamada",
"first_name_en": "Taro",
"prefix_en": "Mr.",
"title_en": "Manager",
"department_en": "IT Dept."
}

Response samples

Content type

application/json

{"id": 12345,
"payee": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"last_name": "山田",
"first_name": "太郎",
"honorific_title": "様",
"title": "部長",
"department": "システム部",
"email": "yamada@example.com",
"note": "備考サンプルです",
"archive_flg": 0,
"last_name_en": "Yamada",
"first_name_en": "Taro",
"prefix_en": "Mr.",
"title_en": "Manager",
"department_en": "IT Dept.",
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

発注先担当者削除

ID指定で発注先担当者を削除します。

path Parameters

required

integer

発注先担当者ID

※発注先担当者登録API・発注先担当者リスト取得APIのレスポンスにあるid

Responses

Request samples

Curl

curl --location --request DELETE 'https://api.the-board.jp/v1/payee_contacts/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

発注先担当者取得

ID指定で発注先担当者を取得します。

path Parameters

required

integer

発注先担当者ID

※発注先担当者登録API・発注先担当者リスト取得APIのレスポンスにあるid

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/payee_contacts/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"id": 12345,
"payee": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"last_name": "山田",
"first_name": "太郎",
"honorific_title": "様",
"title": "部長",
"department": "システム部",
"email": "yamada@example.com",
"note": "備考サンプルです",
"archive_flg": 0,
"last_name_en": "Yamada",
"first_name_en": "Taro",
"prefix_en": "Mr.",
"title_en": "Manager",
"department_en": "IT Dept.",
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}

発注

発注情報を扱うAPIです。

発注リスト取得

発注リストを取得します。取得結果は新しい順で取得されます。

query Parameters

expenditure_status_in[]

string

例: expenditure_status_in[]=4,5

発注ステータス

1：見積中(高)
2：見積中(中)
3：見積中(低)
8：見積中(除)
4：発注確定
5：発注済
9：見送り

※複数の場合はカンマ区切り

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

delivery_status_in[]

string

例: delivery_status_in[]=1,2

進捗状況

1：未着手
2：着手中
3：納品済
4：検収済

※複数の場合はカンマ区切り

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

expenditure_no_eq

integer

例: expenditure_no_eq=1001

発注No

created_at_gteq

string <YYYY-MM-DD HH:MM:SS>

例: created_at_gteq=2023-08-01 00:00:00

作成日時（指定日時以降）

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

created_at_lteq

string <YYYY-MM-DD HH:MM:SS>

例: created_at_lteq=2023-08-01 00:00:00

作成日時（指定日時以前）

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

updated_at_gteq

string <YYYY-MM-DD HH:MM:SS>

例: updated_at_gteq=2023-08-01 00:00:00

更新日時（指定日時以降）

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

updated_at_lteq

string <YYYY-MM-DD HH:MM:SS>

例: updated_at_lteq=2023-08-01 00:00:00

更新日時（指定日時以前）

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

include_not_ordered_flg

integer

デフォルト: 0

例: include_not_ordered_flg=1

見送りステータスを含むか

0：見送りは除く
1：見送りも含む

include_archive_flg

integer

デフォルト: 0

利用可能な値: 0 1

例: include_archive_flg=1

アーカイブを含むか

0：アーカイブ済みは除く
1：アーカイブ済みも含む

expenditure_order_order_date_gteq

string <YYYY-MM-DD>

例: expenditure_order_order_date_gteq=2023-10-01

発注日（指定日以降）

expenditure_order_order_date_lteq

string <YYYY-MM-DD>

例: expenditure_order_order_date_lteq=2023-10-01

発注日（指定日以前）

per_page

integer

デフォルト: 10

例: per_page=20

1ページあたりの要素数（最大100まで）

page

integer

デフォルト: 1

例: page=2

現在のページ番号

response_group

string

デフォルト: "small"

利用可能な値: "small" "medium" "large" "estimate" "order" "delivery" "invoice" "all"

例: response_group=large

レスポンスグループ

response_group	項目
small	id, expenditure_no, management_no, name, payee, payee_contact, user, total, tax, tax_withholding, tax_withholding_kbn, tax_withholding_kbn_name, order_date, invoice_dates, expenditure_status, expenditure_status_name, expenditure_type_id, expenditure_type_name, expenditure_type2_id, expenditure_type2_name, expenditure_type3_id, expenditure_type3_name, group_id, group_name, delivery_status, delivery_status_name, currency, created_at, updated_at
medium	smallに加え以下の項目 payee_branch, company_branch, project, payment_term_id, payment_term_name, payment_timing_kbn, payment_timing_kbn_name, contract_start_date, contract_end_date, periodical_payment_interval, auto_renewal_flg, auto_renewal_period_month, periodical_payment_payment_kbn, periodical_payment_payment_kbn_name, tags, exchange_rate, total_jpy, tax_jpy
large	書類以外すべての項目
estimate	small + 見積依頼書
order	small + 発注書
delivery	small + 検収書
invoice	small + 支払通知書
all	large + すべての書類

※レスポンスグループについて

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/expenditures' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

[{"id": 123456,
"expenditure_no": 1001,
"name": "サンプル発注A",
"payee": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"payee_branch": {"id": 123456,
"name": "サンプル支社"
},
"payee_name_disp_kbn": 1,
"payee_name_disp_kbn_name": "会社名のみ",
"payee_name_for_post_disp_kbn": 1,
"payee_name_for_post_disp_kbn_name": "会社名のみ",
"payee_contact": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"company_branch": {"id": 123456,
"name": "サンプル支社"
},
"company_name_disp_kbn": 1,
"company_name_disp_kbn_name": "会社名のみ",
"company_name_for_post_disp_kbn": 1,
"company_name_for_post_disp_kbn_name": "会社名のみ",
"user": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"project": {"id": 123456,
"name": "サンプル案件A",
"project_no": 1001,
"management_no": "TEST0001"
},
"invoice_dates": ["2023-10-31",
"2024-01-31"
],
"order_date": "2023-10-01",
"payment_term_id": 123456,
"payment_term_name": "月末締め翌月末払い",
"expenditure_status": 1,
"expenditure_status_name": "見積中(高)",
"payment_timing_kbn": 1,
"payment_timing_kbn_name": "一括支払",
"tax_withholding_kbn": 1,
"tax_withholding_kbn_name": "なし",
"in_house_memo": "サンプルメモです。",
"management_no": "TEST0001",
"expenditure_type_id": 123456,
"expenditure_type_name": "サンプル案件区分1",
"expenditure_type2_id": 123456,
"expenditure_type2_name": "サンプル案件区分2",
"expenditure_type3_id": 123456,
"expenditure_type3_name": "サンプル案件区分3",
"tags": ["タグA",
"タグB"
],
"group_id": 123456,
"group_name": "サンプルグループ",
"accounting_type_id": 123456,
"accounting_type_name": "サンプル会計区分1",
"accounting_type2_id": 123456,
"accounting_type2_name": "サンプル会計区分2",
"accounting_type3_id": 123456,
"accounting_type3_name": "サンプル会計区分3",
"company_bank_id": 123456,
"delivery_status": 1,
"delivery_status_name": "未着手",
"tax_rule_kbn": 2,
"tax_rule_kbn_name": "切り捨て",
"minus_rounding_rule": 1,
"minus_rounding_rule_name": "数値を基準にする",
"lock_flg": 0,
"wareki_flg": 0,
"archive_flg": 0,
"reduced_tax_rate_kbn": 1,
"document_setting_id": 123456,
"document_setting_name": "メイン用",
"to": "test@example.com",
"cc": "test@example.com",
"currency": "JPY",
"lang_kbn": 1,
"lang_kbn_name": "日本語",
"exchange_rate": 149.43,
"total_jpy": 100000,
"tax_jpy": 10000,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00",
"expenditure_estimate": {"id": 123456,
"estimate_request_date": "2023-10-01",
"desired_delivery_date_text": "2週間後",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
},
"expenditure_order": {"id": 123456,
"order_date": "2023-10-01",
"delivery_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
},
"expenditure_deliveries": [{"id": 123456,
"delivery_received_date": "2023-10-01",
"disp_delivery_receive_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
}
],
"expenditure_invoices": [{"id": 123456,
"paid_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
}
]
}
]

発注登録

発注を新規登録します。

支払タイミング（一括支払・定期支払・分割支払）に応じてパラメーターが異なります。

下記のリクエストパラメーターリストの上部にある「共通」「一括支払」「定期支払」「分割支払」のボタンでリクエストパラメーターを切り替えることができます。

「共通」は、全支払タイミングで共通して使用するパラメーターです。「一括支払」「定期支払」「分割支払」は、それぞれの支払タイミング固有のパラメーターです。「共通+一括支払」のように組み合わせて使用してください。

Request Body schema: application/json
required

Any of

name required	string <= 100 characters 発注名
payee_id required	integer <int32> 発注先ID ※発注先登録API・発注先リスト取得APIのレスポンスにある`id`
user_id required	integer <int32> 担当者ID ※ユーザーリスト取得APIのレスポンスにある`id`
expenditure_status required	integer 利用可能な値: 1 2 3 4 5 8 9 発注ステータス 1：見積中(高) 2：見積中(中) 3：見積中(低) 8：見積中(除) 4：発注確定 5：発注済 9：見送り
payment_timing_kbn required	integer 利用可能な値: 1 2 3 支払タイミング 1：一括支払 2：定期支払 3：分割支払
tax_withholding_kbn required	integer デフォルト: 1 利用可能な値: 1 2 3 源泉徴収区分 1：なし 2：源泉徴収（復興特別所得税あり） 3：源泉徴収（復興特別所得税なし）
payee_branch_id	integer <int32> 発注先支社ID ※発注先支社登録API・発注先支社リスト取得APIのレスポンスにある`id`
payee_name_disp_kbn	integer デフォルト: 1 利用可能な値: 1 2 3 発注先支社（書類上の表示） 1：会社名のみ 2：会社名＋支社名 3：支社名のみ ※発注先支社を指定する場合のみ
payee_name_for_post_disp_kbn	integer デフォルト: 1 利用可能な値: 1 2 3 発注先支社（郵送時の表示） 1：会社名のみ 2：会社名＋支社名 3：支社名のみ ※発注先支社を指定する場合のみ
payee_contact_id	integer <int32> 発注先担当者ID ※発注先担当者登録API・発注先担当者リスト取得APIのレスポンスにある`id`
company_branch_id	integer <int32> 自社支社ID ※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456
company_name_disp_kbn	integer 利用可能な値: 1 2 3 自社支社（書類上の表示） 1：会社名のみ 2：会社名＋支社名 3：支社名のみ ※自社支社を指定する場合のみ
company_name_for_post_disp_kbn	integer 利用可能な値: 1 2 3 自社支社（郵送時の表示） 1：会社名のみ 2：会社名＋支社名 3：支社名のみ ※自社支社を指定する場合のみ
project_id	integer <int32> 関連案件ID ※案件登録API・案件リスト取得APIのレスポンスにある`id`
payment_term_id	integer <int32> 支払条件ID 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます支払条件リスト取得APIのレスポンスにある`id`です
in_house_memo	string <= 2000 characters 社内メモ
management_no	string <= 20 characters 管理番号
expenditure_type_id	integer <int32> 発注区分1 ※発注区分リスト取得APIのレスポンスにある`id`
expenditure_type2_id	integer <int32> 発注区分2 ※発注区分リスト取得APIのレスポンスにある`id`
expenditure_type3_id	integer <int32> 発注区分3 ※発注区分リスト取得APIのレスポンスにある`id`
tags	Array of strings タグ ※タグ名の配列
group_id	integer <int32> グループID ※グループリスト取得APIのレスポンスにある`id`
accounting_type_id	integer <int32> 会計区分1ID ※会計区分リスト取得APIのレスポンスにある`id`
accounting_type2_id	integer <int32> 会計区分2ID ※会計区分リスト取得APIのレスポンスにある`id`
accounting_type3_id	integer <int32> 会計区分3ID ※会計区分リスト取得APIのレスポンスにある`id`
company_bank_id	integer <int32> 集計用出金口座（振込口座ID） ※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456
delivery_status	integer 利用可能な値: 1 2 3 4 進捗状況 1：未着手 2：着手中 3：納品済 4：検収済
tax_rule_kbn	integer 利用可能な値: 1 2 3 端数処理 1：四捨五入 2：切り捨て 3：切り上げ ※デフォルトはアカウントの端数処理設定による
wareki_flg	integer 利用可能な値: 0 1 和暦表示 0：西暦 1：和暦 ※「和暦表示」機能有効時のみ
archive_flg	integer <int32> 利用可能な値: 0 1 アーカイブ状態 0：未アーカイブ 1：アーカイブ済み
reduced_tax_rate_kbn	integer 利用可能な値: 1 2 軽減税率 1：対象外 2：対象 ※「軽減税率」機能有効時のみ
document_setting_id	integer <int64> 書類詳細設定ID ※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456
to	string <= 1000 characters TO（メールアドレス） ※複数指定する場合はカンマ区切り
cc	string <= 1000 characters CC（メールアドレス） ※複数指定する場合はカンマ区切り
currency	string 利用可能な値: "JPY" "USD" "EUR" "GBP" "CNY" "HKD" "TWD" "KRW" "SGD" "AUD" "IDR" "THB" "CAD" 通貨 ※英語アドオン有効時のみ
lang_kbn	integer 利用可能な値: 1 2 言語 1：日本語 2：英語 ※英語アドオン有効時のみ
exchange_rate	number <decimal> 為替レート ※英語アドオン有効時のみ

Responses

Request samples

Payload
Curl

Content type

application/json

Example

共通

{"name": "サンプル発注A",
"payee_id": 123456,
"payee_branch_id": 123456,
"payee_name_disp_kbn": 1,
"payee_name_for_post_disp_kbn": 1,
"payee_contact_id": 123456,
"company_branch_id": 123456,
"company_name_disp_kbn": 1,
"company_name_for_post_disp_kbn": 1,
"user_id": 123456,
"project_id": 123456,
"payment_term_id": 123456,
"expenditure_status": 1,
"payment_timing_kbn": 1,
"tax_withholding_kbn": 1,
"in_house_memo": "サンプルメモです。",
"management_no": "TEST0001",
"expenditure_type_id": 123456,
"expenditure_type2_id": 123456,
"expenditure_type3_id": 123456,
"tags": ["タグA",
"タグB"
],
"group_id": 123456,
"accounting_type_id": 123456,
"accounting_type2_id": 123456,
"accounting_type3_id": 123456,
"company_bank_id": 123456,
"delivery_status": 1,
"tax_rule_kbn": 2,
"wareki_flg": 0,
"archive_flg": 0,
"reduced_tax_rate_kbn": 1,
"document_setting_id": 123456,
"to": "test@example.com",
"cc": "test@example.com",
"currency": "JPY",
"lang_kbn": 1,
"exchange_rate": 149.43
}

Response samples

Content type

application/json

{"id": 123456,
"expenditure_no": 1001,
"name": "サンプル発注A",
"payee": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"payee_branch": {"id": 123456,
"name": "サンプル支社"
},
"payee_name_disp_kbn": 1,
"payee_name_disp_kbn_name": "会社名のみ",
"payee_name_for_post_disp_kbn": 1,
"payee_name_for_post_disp_kbn_name": "会社名のみ",
"payee_contact": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"company_branch": {"id": 123456,
"name": "サンプル支社"
},
"company_name_disp_kbn": 1,
"company_name_disp_kbn_name": "会社名のみ",
"company_name_for_post_disp_kbn": 1,
"company_name_for_post_disp_kbn_name": "会社名のみ",
"user": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"project": {"id": 123456,
"name": "サンプル案件A",
"project_no": 1001,
"management_no": "TEST0001"
},
"invoice_dates": ["2023-10-31",
"2024-01-31"
],
"order_date": "2023-10-01",
"payment_term_id": 123456,
"payment_term_name": "月末締め翌月末払い",
"expenditure_status": 1,
"expenditure_status_name": "見積中(高)",
"payment_timing_kbn": 1,
"payment_timing_kbn_name": "一括支払",
"tax_withholding_kbn": 1,
"tax_withholding_kbn_name": "なし",
"in_house_memo": "サンプルメモです。",
"management_no": "TEST0001",
"expenditure_type_id": 123456,
"expenditure_type_name": "サンプル案件区分1",
"expenditure_type2_id": 123456,
"expenditure_type2_name": "サンプル案件区分2",
"expenditure_type3_id": 123456,
"expenditure_type3_name": "サンプル案件区分3",
"tags": ["タグA",
"タグB"
],
"group_id": 123456,
"group_name": "サンプルグループ",
"accounting_type_id": 123456,
"accounting_type_name": "サンプル会計区分1",
"accounting_type2_id": 123456,
"accounting_type2_name": "サンプル会計区分2",
"accounting_type3_id": 123456,
"accounting_type3_name": "サンプル会計区分3",
"company_bank_id": 123456,
"delivery_status": 1,
"delivery_status_name": "未着手",
"tax_rule_kbn": 2,
"tax_rule_kbn_name": "切り捨て",
"minus_rounding_rule": 1,
"minus_rounding_rule_name": "数値を基準にする",
"lock_flg": 0,
"wareki_flg": 0,
"archive_flg": 0,
"reduced_tax_rate_kbn": 1,
"document_setting_id": 123456,
"document_setting_name": "メイン用",
"to": "test@example.com",
"cc": "test@example.com",
"currency": "JPY",
"lang_kbn": 1,
"lang_kbn_name": "日本語",
"exchange_rate": 149.43,
"total_jpy": 100000,
"tax_jpy": 10000,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00",
"expenditure_estimate": {"id": 123456,
"estimate_request_date": "2023-10-01",
"desired_delivery_date_text": "2週間後",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
},
"expenditure_order": {"id": 123456,
"order_date": "2023-10-01",
"delivery_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
},
"expenditure_deliveries": [{"id": 123456,
"delivery_received_date": "2023-10-01",
"disp_delivery_receive_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
}
],
"expenditure_invoices": [{"id": 123456,
"paid_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
}
]
}

発注更新

発注ID指定で発注を更新します。

分割支払に関する注意事項
現在、API経由でのinvoicesの更新（請求日・請求回数の変更）には対応していません。

path Parameters

required

integer

発注ID

※発注登録API・発注リスト取得APIのレスポンスにあるid

Request Body schema: application/json

Any of

name	string <= 100 characters 発注名
payee_id	integer <int32> 発注先ID ※発注先登録API・発注先リスト取得APIのレスポンスにある`id`
payee_branch_id	integer <int32> 発注先支社ID ※発注先支社登録API・発注先支社リスト取得APIのレスポンスにある`id`
payee_name_disp_kbn	integer デフォルト: 1 利用可能な値: 1 2 3 発注先支社（書類上の表示） 1：会社名のみ 2：会社名＋支社名 3：支社名のみ ※発注先支社を指定する場合のみ
payee_name_for_post_disp_kbn	integer デフォルト: 1 利用可能な値: 1 2 3 発注先支社（郵送時の表示） 1：会社名のみ 2：会社名＋支社名 3：支社名のみ ※発注先支社を指定する場合のみ
payee_contact_id	integer <int32> 発注先担当者ID ※発注先担当者登録API・発注先担当者リスト取得APIのレスポンスにある`id`
company_branch_id	integer <int32> 自社支社ID ※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456
company_name_disp_kbn	integer 利用可能な値: 1 2 3 自社支社（書類上の表示） 1：会社名のみ 2：会社名＋支社名 3：支社名のみ ※自社支社を指定する場合のみ
company_name_for_post_disp_kbn	integer 利用可能な値: 1 2 3 自社支社（郵送時の表示） 1：会社名のみ 2：会社名＋支社名 3：支社名のみ ※自社支社を指定する場合のみ
user_id	integer <int32> 担当者ID ※ユーザーリスト取得APIのレスポンスにある`id`
project_id	integer <int32> 関連案件ID ※案件登録API・案件リスト取得APIのレスポンスにある`id`
payment_term_id	integer <int32> 支払条件ID 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます支払条件リスト取得APIのレスポンスにある`id`です
expenditure_status	integer 利用可能な値: 1 2 3 4 5 8 9 発注ステータス 1：見積中(高) 2：見積中(中) 3：見積中(低) 8：見積中(除) 4：発注確定 5：発注済 9：見送り
payment_timing_kbn	integer 利用可能な値: 1 2 3 支払タイミング 1：一括支払 2：定期支払 3：分割支払
tax_withholding_kbn	integer デフォルト: 1 利用可能な値: 1 2 3 源泉徴収区分 1：なし 2：源泉徴収（復興特別所得税あり） 3：源泉徴収（復興特別所得税なし）
in_house_memo	string <= 2000 characters 社内メモ
management_no	string <= 20 characters 管理番号
expenditure_type_id	integer <int32> 発注区分1 ※発注区分リスト取得APIのレスポンスにある`id`
expenditure_type2_id	integer <int32> 発注区分2 ※発注区分リスト取得APIのレスポンスにある`id`
expenditure_type3_id	integer <int32> 発注区分3 ※発注区分リスト取得APIのレスポンスにある`id`
tags	Array of strings タグ ※タグ名の配列
group_id	integer <int32> グループID ※グループリスト取得APIのレスポンスにある`id`
accounting_type_id	integer <int32> 会計区分1ID ※会計区分リスト取得APIのレスポンスにある`id`
accounting_type2_id	integer <int32> 会計区分2ID ※会計区分リスト取得APIのレスポンスにある`id`
accounting_type3_id	integer <int32> 会計区分3ID ※会計区分リスト取得APIのレスポンスにある`id`
company_bank_id	integer <int32> 集計用出金口座（振込口座ID） ※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456
delivery_status	integer 利用可能な値: 1 2 3 4 進捗状況 1：未着手 2：着手中 3：納品済 4：検収済
tax_rule_kbn	integer 利用可能な値: 1 2 3 端数処理 1：四捨五入 2：切り捨て 3：切り上げ ※デフォルトはアカウントの端数処理設定による
wareki_flg	integer 利用可能な値: 0 1 和暦表示 0：西暦 1：和暦 ※「和暦表示」機能有効時のみ
archive_flg	integer <int32> 利用可能な値: 0 1 アーカイブ状態 0：未アーカイブ 1：アーカイブ済み
reduced_tax_rate_kbn	integer 利用可能な値: 1 2 軽減税率 1：対象外 2：対象 ※「軽減税率」機能有効時のみ
document_setting_id	integer <int64> 書類詳細設定ID ※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456
to	string <= 1000 characters TO（メールアドレス） ※複数指定する場合はカンマ区切り
cc	string <= 1000 characters CC（メールアドレス） ※複数指定する場合はカンマ区切り
currency	string 利用可能な値: "JPY" "USD" "EUR" "GBP" "CNY" "HKD" "TWD" "KRW" "SGD" "AUD" "IDR" "THB" "CAD" 通貨 ※英語アドオン有効時のみ
lang_kbn	integer 利用可能な値: 1 2 言語 1：日本語 2：英語 ※英語アドオン有効時のみ
exchange_rate	number <decimal> 為替レート ※英語アドオン有効時のみ

Responses

Request samples

Payload
Curl

Content type

application/json

Example

共通

{"name": "サンプル発注A",
"payee_id": 123456,
"payee_branch_id": 123456,
"payee_name_disp_kbn": 1,
"payee_name_for_post_disp_kbn": 1,
"payee_contact_id": 123456,
"company_branch_id": 123456,
"company_name_disp_kbn": 1,
"company_name_for_post_disp_kbn": 1,
"user_id": 123456,
"project_id": 123456,
"payment_term_id": 123456,
"expenditure_status": 1,
"payment_timing_kbn": 1,
"tax_withholding_kbn": 1,
"in_house_memo": "サンプルメモです。",
"management_no": "TEST0001",
"expenditure_type_id": 123456,
"expenditure_type2_id": 123456,
"expenditure_type3_id": 123456,
"tags": ["タグA",
"タグB"
],
"group_id": 123456,
"accounting_type_id": 123456,
"accounting_type2_id": 123456,
"accounting_type3_id": 123456,
"company_bank_id": 123456,
"delivery_status": 1,
"tax_rule_kbn": 2,
"wareki_flg": 0,
"archive_flg": 0,
"reduced_tax_rate_kbn": 1,
"document_setting_id": 123456,
"to": "test@example.com",
"cc": "test@example.com",
"currency": "JPY",
"lang_kbn": 1,
"exchange_rate": 149.43
}

Response samples

Content type

application/json

{"id": 123456,
"expenditure_no": 1001,
"name": "サンプル発注A",
"payee": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"payee_branch": {"id": 123456,
"name": "サンプル支社"
},
"payee_name_disp_kbn": 1,
"payee_name_disp_kbn_name": "会社名のみ",
"payee_name_for_post_disp_kbn": 1,
"payee_name_for_post_disp_kbn_name": "会社名のみ",
"payee_contact": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"company_branch": {"id": 123456,
"name": "サンプル支社"
},
"company_name_disp_kbn": 1,
"company_name_disp_kbn_name": "会社名のみ",
"company_name_for_post_disp_kbn": 1,
"company_name_for_post_disp_kbn_name": "会社名のみ",
"user": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"project": {"id": 123456,
"name": "サンプル案件A",
"project_no": 1001,
"management_no": "TEST0001"
},
"invoice_dates": ["2023-10-31",
"2024-01-31"
],
"order_date": "2023-10-01",
"payment_term_id": 123456,
"payment_term_name": "月末締め翌月末払い",
"expenditure_status": 1,
"expenditure_status_name": "見積中(高)",
"payment_timing_kbn": 1,
"payment_timing_kbn_name": "一括支払",
"tax_withholding_kbn": 1,
"tax_withholding_kbn_name": "なし",
"in_house_memo": "サンプルメモです。",
"management_no": "TEST0001",
"expenditure_type_id": 123456,
"expenditure_type_name": "サンプル案件区分1",
"expenditure_type2_id": 123456,
"expenditure_type2_name": "サンプル案件区分2",
"expenditure_type3_id": 123456,
"expenditure_type3_name": "サンプル案件区分3",
"tags": ["タグA",
"タグB"
],
"group_id": 123456,
"group_name": "サンプルグループ",
"accounting_type_id": 123456,
"accounting_type_name": "サンプル会計区分1",
"accounting_type2_id": 123456,
"accounting_type2_name": "サンプル会計区分2",
"accounting_type3_id": 123456,
"accounting_type3_name": "サンプル会計区分3",
"company_bank_id": 123456,
"delivery_status": 1,
"delivery_status_name": "未着手",
"tax_rule_kbn": 2,
"tax_rule_kbn_name": "切り捨て",
"minus_rounding_rule": 1,
"minus_rounding_rule_name": "数値を基準にする",
"lock_flg": 0,
"wareki_flg": 0,
"archive_flg": 0,
"reduced_tax_rate_kbn": 1,
"document_setting_id": 123456,
"document_setting_name": "メイン用",
"to": "test@example.com",
"cc": "test@example.com",
"currency": "JPY",
"lang_kbn": 1,
"lang_kbn_name": "日本語",
"exchange_rate": 149.43,
"total_jpy": 100000,
"tax_jpy": 10000,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00",
"expenditure_estimate": {"id": 123456,
"estimate_request_date": "2023-10-01",
"desired_delivery_date_text": "2週間後",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
},
"expenditure_order": {"id": 123456,
"order_date": "2023-10-01",
"delivery_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
},
"expenditure_deliveries": [{"id": 123456,
"delivery_received_date": "2023-10-01",
"disp_delivery_receive_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
}
],
"expenditure_invoices": [{"id": 123456,
"paid_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
}
]
}

発注削除

発注ID指定で発注を削除します。

path Parameters

required

integer

発注ID

※発注登録API・発注リスト取得APIのレスポンスにあるid

Responses

Request samples

Curl

curl --location --request DELETE 'https://api.the-board.jp/v1/expenditures/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

発注取得

発注ID指定で発注を取得します。

path Parameters

required

integer

発注ID

※発注登録API・発注リスト取得APIのレスポンスにあるid

query Parameters

response_group

string

デフォルト: "small"

利用可能な値: "small" "medium" "large" "estimate" "order" "delivery" "invoice" "all"

例: response_group=large

レスポンスグループ

response_group	項目
small	id, expenditure_no, management_no, name, payee, payee_contact, user, total, tax, tax_withholding, tax_withholding_kbn, tax_withholding_kbn_name, order_date, invoice_dates, expenditure_status, expenditure_status_name, expenditure_type_id, expenditure_type_name, expenditure_type2_id, expenditure_type2_name, expenditure_type3_id, expenditure_type3_name, group_id, group_name, delivery_status, delivery_status_name, currency, created_at, updated_at
medium	smallに加え以下の項目 payee_branch, company_branch, project, payment_term_id, payment_term_name, payment_timing_kbn, payment_timing_kbn_name, contract_start_date, contract_end_date, periodical_payment_interval, auto_renewal_flg, auto_renewal_period_month, periodical_payment_payment_kbn, periodical_payment_payment_kbn_name, tags, exchange_rate, total_jpy, tax_jpy
large	書類以外すべての項目
estimate	small + 見積依頼書
order	small + 発注書
delivery	small + 検収書
invoice	small + 支払通知書
all	large + すべての書類

※レスポンスグループについて

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/expenditures/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"id": 123456,
"expenditure_no": 1001,
"name": "サンプル発注A",
"payee": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"payee_branch": {"id": 123456,
"name": "サンプル支社"
},
"payee_name_disp_kbn": 1,
"payee_name_disp_kbn_name": "会社名のみ",
"payee_name_for_post_disp_kbn": 1,
"payee_name_for_post_disp_kbn_name": "会社名のみ",
"payee_contact": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"company_branch": {"id": 123456,
"name": "サンプル支社"
},
"company_name_disp_kbn": 1,
"company_name_disp_kbn_name": "会社名のみ",
"company_name_for_post_disp_kbn": 1,
"company_name_for_post_disp_kbn_name": "会社名のみ",
"user": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"project": {"id": 123456,
"name": "サンプル案件A",
"project_no": 1001,
"management_no": "TEST0001"
},
"invoice_dates": ["2023-10-31",
"2024-01-31"
],
"order_date": "2023-10-01",
"payment_term_id": 123456,
"payment_term_name": "月末締め翌月末払い",
"expenditure_status": 1,
"expenditure_status_name": "見積中(高)",
"payment_timing_kbn": 1,
"payment_timing_kbn_name": "一括支払",
"tax_withholding_kbn": 1,
"tax_withholding_kbn_name": "なし",
"in_house_memo": "サンプルメモです。",
"management_no": "TEST0001",
"expenditure_type_id": 123456,
"expenditure_type_name": "サンプル案件区分1",
"expenditure_type2_id": 123456,
"expenditure_type2_name": "サンプル案件区分2",
"expenditure_type3_id": 123456,
"expenditure_type3_name": "サンプル案件区分3",
"tags": ["タグA",
"タグB"
],
"group_id": 123456,
"group_name": "サンプルグループ",
"accounting_type_id": 123456,
"accounting_type_name": "サンプル会計区分1",
"accounting_type2_id": 123456,
"accounting_type2_name": "サンプル会計区分2",
"accounting_type3_id": 123456,
"accounting_type3_name": "サンプル会計区分3",
"company_bank_id": 123456,
"delivery_status": 1,
"delivery_status_name": "未着手",
"tax_rule_kbn": 2,
"tax_rule_kbn_name": "切り捨て",
"minus_rounding_rule": 1,
"minus_rounding_rule_name": "数値を基準にする",
"lock_flg": 0,
"wareki_flg": 0,
"archive_flg": 0,
"reduced_tax_rate_kbn": 1,
"document_setting_id": 123456,
"document_setting_name": "メイン用",
"to": "test@example.com",
"cc": "test@example.com",
"currency": "JPY",
"lang_kbn": 1,
"lang_kbn_name": "日本語",
"exchange_rate": 149.43,
"total_jpy": 100000,
"tax_jpy": 10000,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00",
"expenditure_estimate": {"id": 123456,
"estimate_request_date": "2023-10-01",
"desired_delivery_date_text": "2週間後",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
},
"expenditure_order": {"id": 123456,
"order_date": "2023-10-01",
"delivery_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
},
"expenditure_deliveries": [{"id": 123456,
"delivery_received_date": "2023-10-01",
"disp_delivery_receive_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
}
],
"expenditure_invoices": [{"id": 123456,
"paid_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
}
]
}

発注ステータス変更

発注ID指定で発注ステータスを変更します。

path Parameters

required

integer

発注ID

※発注登録API・発注リスト取得APIのレスポンスにあるid

Request Body schema: application/json

expenditure_status

required

integer

利用可能な値: 1 2 3 4 5 8 9

発注ステータス

1：見積中(高)
2：見積中(中)
3：見積中(低)
8：見積中(除)
4：発注確定
5：発注済
9：見送り

Responses

Request samples

Payload
Curl

Content type

application/json

{"expenditure_status": 1
}

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

発注のロック

発注ID指定で発注情報をロック・ロック解除します。

path Parameters

required

integer

発注ID

※発注登録API・発注リスト取得APIのレスポンスにあるid

Request Body schema: application/json

lock_flg

required

integer

利用可能な値: 0 1

ロックフラグ

0：未ロック
1：ロック済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"lock_flg": 1
}

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

支払

支払情報を扱うAPIです。

支払リスト取得

支払リストを取得します。

query Parameters

invoice_date_gteq

string <YYYY-MM-DD>

例: invoice_date_gteq=2023-10-01

請求日（指定日以降）

invoice_date_lteq

string <YYYY-MM-DD>

例: invoice_date_lteq=2023-10-01

請求日（指定日以前）

payment_date_gteq

string <YYYY-MM-DD>

例: payment_date_gteq=2023-10-01

支払期限（指定日以降）

payment_date_lteq

string <YYYY-MM-DD>

例: payment_date_lteq=2023-10-01

支払期限（指定日以前）

expenditure_expenditure_status_in[]

string

例: expenditure_expenditure_status_in[]=4,5

発注ステータス

1：見積中(高)
2：見積中(中)
3：見積中(低)
8：見積中(除)
4：発注確定
5：発注済
9：見送り

※複数の場合はカンマ区切り

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

payment_status_in[]

string

例: payment_status_in[]=4,5

支払ステータス

1：請求書未受領
2：請求書受領済
4：振込予約済
3：支払済

※複数の場合はカンマ区切り

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

expenditure_expenditure_no_eq

integer

例: expenditure_expenditure_no_eq=1001

発注No

updated_at_gteq

string <YYYY-MM-DD HH:MM:SS>

例: updated_at_gteq=2023-08-01 00:00:00

更新日時（指定日時以降）

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

updated_at_lteq

string <YYYY-MM-DD HH:MM:SS>

例: updated_at_lteq=2023-08-01 00:00:00

更新日時（指定日時以前）

※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。

per_page

integer

デフォルト: 10

例: per_page=20

1ページあたりの要素数（最大100まで）

page

integer

デフォルト: 1

例: page=2

現在のページ番号

response_group

string

デフォルト: "small"

利用可能な値: "small" "medium" "large" "estimate" "order" "delivery" "invoice" "receipt" "project_cost" "all"

例: response_group=large

レスポンスグループ

response_group	項目
small	id, expenditure_no, management_no, name, payee, payee_contact, user, total, tax, tax_withholding, invoice_date, payment_date, expenditure_status, expenditure_status_name, payment_status, payment_status_name, payment_method_kbn, payment_method_kbn_name, expenditure_type_id, expenditure_type_name, expenditure_type2_id, expenditure_type2_name, expenditure_type3_id, expenditure_type3_name, group_id, group_name, currency, created_at, updated_at
medium	smallに加え以下の項目 payee_branch, company_branch, tags, exchange_rate, total_jpy, tax_jpy
large	書類以外すべての項目
invoice	small + 支払通知書

※レスポンスグループについて

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/expenditure_payments' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

[{"id": 123456,
"expenditure_id": 123456,
"expenditure_no": 1001,
"management_no": "TEST0001",
"name": "サンプル発注A",
"payee": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"payee_branch": {"id": 123456,
"name": "サンプル支社"
},
"payee_contact": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"company_branch": {"id": 123456,
"name": "サンプル支社"
},
"user": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"total": 100000,
"tax": 10000,
"tax_withholding": 10210,
"invoice_date": "2023-10-01",
"payment_date": "2023-10-01",
"expenditure_status": 1,
"expenditure_status_name": "見積中(高)",
"payment_status": 1,
"payment_status_name": "請求書未受領",
"payment_method_kbn": 1,
"payment_method_kbn_name": "銀行振込",
"expenditure_type_id": 123456,
"expenditure_type_name": "サンプル案件区分1",
"expenditure_type2_id": 123456,
"expenditure_type2_name": "サンプル案件区分2",
"expenditure_type3_id": 123456,
"expenditure_type3_name": "サンプル案件区分3",
"group_id": 123456,
"group_name": "サンプルグループ",
"tags": ["タグA",
"タグB"
],
"accounting_type_id": 123456,
"accounting_type_name": "サンプル会計区分1",
"accounting_type2_id": 123456,
"accounting_type2_name": "サンプル会計区分2",
"accounting_type3_id": 123456,
"accounting_type3_name": "サンプル会計区分3",
"lock_flg": 0,
"currency": "JPY",
"lang_kbn": 1,
"lang_kbn_name": "日本語",
"exchange_rate": 149.43,
"total_jpy": 100000,
"tax_jpy": 10000,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}
]

支払ステータス変更

支払ID指定で請求ステータスを変更します。

path Parameters

required

integer

支払ID

※支払リスト取得APIのレスポンスにあるid

Request Body schema: application/json

payment_status

required

integer

利用可能な値: 1 2 3 4

支払ステータス

1：請求書未受領
2：請求書受領済
4：振込予約済
3：支払済

Responses

Request samples

Payload
Curl

Content type

application/json

{"payment_status": 1
}

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

支払のロック

支払ID指定で支払のロック状態を変更します。

path Parameters

required

integer

支払ID

※支払リスト取得APIのレスポンスにあるid

Request Body schema: application/json

lock_flg

required

integer

利用可能な値: 0 1

ロックフラグ

0：未ロック
1：ロック済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"lock_flg": 1
}

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

書類（発注）

発注の書類を扱うAPIです。

見積依頼書更新

ID指定で見積依頼書を更新します。

path Parameters

required

integer

見積依頼書ID

※発注登録API・発注リスト取得API・発注取得APIのレスポンスにあるexpenditure_estimate内のid（要レスポンスグループ指定）

Request Body schema: application/json

estimate_request_date	string <YYYY-MM-DD> 依頼日
desired_delivery_date_text	string <= 100 characters 希望納期
message	string <= 5000 characters 備考
total	number <decimal> < 1000000000 小計 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
tax	number <decimal> < 1000000000 消費税 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
tax_withholding	number <decimal> < 1000000000 源泉所得税 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
document_amount_disp_kbn	integer 利用可能な値: 1 2 3 4 金額表示 1：税込表示 2：合計欄を税抜表示＋明細下の小計・消費税行非表示 3：合計欄のみ税抜表示 4：合計表示なし ※デフォルトは「デフォルト設定」によって決まります
delivery_place	string <= 100 characters 納品場所
	Array of objects 明細行
blank_date_flg	integer デフォルト: 0 利用可能な値: 0 1 依頼日空欄 0：表示 1：空欄にする

Responses

Request samples

Payload
Curl

Content type

application/json

{"estimate_request_date": "2023-10-01",
"desired_delivery_date_text": "2週間後",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"document_amount_disp_kbn": 1,
"delivery_place": "サンプル倉庫",
"details": [{"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"deduction_applicable": true
}
],
"blank_date_flg": 0
}

Response samples

Content type

application/json

{"id": 123456,
"estimate_request_date": "2023-10-01",
"desired_delivery_date_text": "2週間後",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
}

見積依頼書取得

ID指定で見積依頼書を取得します。

path Parameters

required

integer

見積依頼書ID

※発注登録API・発注リスト取得API・発注取得APIのレスポンスにあるexpenditure_estimate内のid（要レスポンスグループ指定）

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/expenditure_documents/estimates/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"id": 123456,
"estimate_request_date": "2023-10-01",
"desired_delivery_date_text": "2週間後",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
}

見積依頼書ロック

ID指定で見積依頼書のロック状態を変更します。

path Parameters

required

integer

見積依頼書ID

※発注登録API・発注リスト取得API・発注取得APIのレスポンスにあるexpenditure_estimate内のid（要レスポンスグループ指定）

Request Body schema: application/json

lock_flg

integer

利用可能な値: 0 1

ロックフラグ

0：未ロック
1：ロック済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"lock_flg": 1
}

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

発注書更新

ID指定で発注書を更新します。

path Parameters

required

integer

発注書ID

※発注登録API・発注リスト取得API・発注取得APIのレスポンスにあるexpenditure_order内のid（要レスポンスグループ指定）

Request Body schema: application/json

order_date	string <YYYY-MM-DD> 発注日
delivery_date	string <YYYY-MM-DD> 納期
message	string <= 5000 characters 備考
total	number <decimal> < 1000000000 小計 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
tax	number <decimal> < 1000000000 消費税 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
tax_withholding	number <decimal> < 1000000000 源泉所得税 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
document_amount_disp_kbn	integer 利用可能な値: 1 2 3 4 金額表示 1：税込表示 2：合計欄を税抜表示＋明細下の小計・消費税行非表示 3：合計欄のみ税抜表示 4：合計表示なし ※デフォルトは「デフォルト設定」によって決まります
delivery_place	string <= 100 characters 納品場所
	Array of objects 明細行
blank_date_flg	integer デフォルト: 0 利用可能な値: 0 1 発注日空欄 0：表示 1：空欄にする

Responses

Request samples

Payload
Curl

Content type

application/json

{"order_date": "2023-10-01",
"delivery_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"document_amount_disp_kbn": 1,
"delivery_place": "サンプル倉庫",
"details": [{"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"deduction_applicable": true
}
],
"blank_date_flg": 0
}

Response samples

Content type

application/json

{"id": 123456,
"order_date": "2023-10-01",
"delivery_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
}

発注書取得

ID指定で発注書を取得します。

path Parameters

required

integer

発注書ID

※発注登録API・発注リスト取得API・発注取得APIのレスポンスにあるexpenditure_order内のid（要レスポンスグループ指定）

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/expenditure_documents/orders/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"id": 123456,
"order_date": "2023-10-01",
"delivery_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
}

発注書ロック

ID指定で発注書のロック状態を変更します。

path Parameters

required

integer

発注書ID

※発注登録API・発注リスト取得API・発注取得APIのレスポンスにあるexpenditure_order内のid（要レスポンスグループ指定）

Request Body schema: application/json

lock_flg

integer

利用可能な値: 0 1

ロックフラグ

0：未ロック
1：ロック済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"lock_flg": 1
}

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

検収書更新

ID指定で検収書を更新します。

path Parameters

required

integer

検収書ID

※発注登録API・発注リスト取得API・発注取得APIのレスポンスにあるexpenditure_delivery内のid（要レスポンスグループ指定）

Request Body schema: application/json

delivery_received_date	string <YYYY-MM-DD> 検収日
disp_delivery_receive_date	string <YYYY-MM-DD> 検収日（表示設定）
message	string <= 5000 characters 備考
total	number <decimal> < 1000000000 小計 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
tax	number <decimal> < 1000000000 消費税 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
tax_withholding	number <decimal> < 1000000000 源泉所得税 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
document_amount_disp_kbn	integer 利用可能な値: 1 2 3 4 金額表示 1：税込表示 2：合計欄を税抜表示＋明細下の小計・消費税行非表示 3：合計欄のみ税抜表示 4：合計表示なし ※デフォルトは「デフォルト設定」によって決まります
delivery_place	string <= 100 characters 納品場所
	Array of objects 明細行
blank_date_flg	integer デフォルト: 0 利用可能な値: 0 1 検収日空欄 0：表示 1：空欄にする

Responses

Request samples

Payload
Curl

Content type

application/json

{"delivery_received_date": "2023-10-01",
"disp_delivery_receive_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"document_amount_disp_kbn": 1,
"delivery_place": "サンプル倉庫",
"details": [{"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"deduction_applicable": true
}
],
"blank_date_flg": 0
}

Response samples

Content type

application/json

{"id": 123456,
"delivery_received_date": "2023-10-01",
"disp_delivery_receive_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
}

検収書取得

ID指定で検収書を取得します。

path Parameters

required

integer

検収書ID

※発注登録API・発注リスト取得API・発注取得APIのレスポンスにあるexpenditure_delivery内のid（要レスポンスグループ指定）

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/expenditure_documents/deliveries/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"id": 123456,
"delivery_received_date": "2023-10-01",
"disp_delivery_receive_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
}

検収書ロック

ID指定で検収書のロック状態を変更します。

path Parameters

required

integer

検収書ID

※発注登録API・発注リスト取得API・発注取得APIのレスポンスにあるexpenditure_delivery内のid（要レスポンスグループ指定）

Request Body schema: application/json

lock_flg

integer

利用可能な値: 0 1

ロックフラグ

0：未ロック
1：ロック済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"lock_flg": 1
}

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

支払通知書更新

ID指定で支払通知書を更新します。

path Parameters

required

integer

支払通知書ID

※発注登録API・発注リスト取得API・発注取得APIのレスポンスにあるexpenditure_invoice内のid（要レスポンスグループ指定）

Request Body schema: application/json

paid_date	string <YYYY-MM-DD> 支払日
message	string <= 5000 characters 備考
total	number <decimal> < 1000000000 小計 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
tax	number <decimal> < 1000000000 消費税 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
tax_withholding	number <decimal> < 1000000000 源泉所得税 ※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります
document_amount_disp_kbn	integer 利用可能な値: 1 2 3 4 金額表示 1：税込表示 2：合計欄を税抜表示＋明細下の小計・消費税行非表示 3：合計欄のみ税抜表示 4：合計表示なし ※デフォルトは「デフォルト設定」によって決まります
delivery_place	string <= 100 characters 納品場所
	Array of objects 明細行
blank_date_flg	integer デフォルト: 0 利用可能な値: 0 1 支払日空欄 0：表示 1：空欄にする

Responses

Request samples

Payload
Curl

Content type

application/json

{"paid_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"document_amount_disp_kbn": 1,
"delivery_place": "サンプル倉庫",
"details": [{"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"deduction_applicable": true
}
],
"blank_date_flg": 0
}

Response samples

Content type

application/json

{"id": 123456,
"paid_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
}

支払通知書取得

ID指定で支払通知書を取得します。

path Parameters

required

integer

支払通知書ID

※発注登録API・発注リスト取得API・発注取得APIのレスポンスにあるexpenditure_invoice内のid（要レスポンスグループ指定）

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/expenditure_documents/invoices/123456' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

{"id": 123456,
"paid_date": "2023-10-01",
"message": "備考サンプルです",
"total": 100000,
"tax": 10000,
"tax_withholding": 0,
"seal_approval_status": 1,
"document_amount_disp_kbn": 1,
"lock_flg": 0,
"delivery_place": "サンプル倉庫",
"details": [{"no": 1,
"detail_date": "2023-12-31",
"description": "サンプル商品A",
"quantity": 1,
"unit": "式",
"unit_price": 100000,
"price": 100000,
"tax_rate": 10,
"tax_withholding_flg": 0,
"tax_included_flg": 0,
"reduced_tax_rate_kbn": 1,
"section_description": "サンプル見出しA",
"section_subtotal": 100000,
"document_detail_kbn": 1,
"document_detail_kbn_name": "通常行",
"deduction_applicable": true
}
],
"blank_date_flg": 0
}

支払通知書ロック

ID指定で支払通知書のロック状態を変更します。

path Parameters

required

integer

支払通知書ID

※発注登録API・発注リスト取得API・発注取得APIのレスポンスにあるexpenditure_invoice内のid（要レスポンスグループ指定）

Request Body schema: application/json

lock_flg

integer

利用可能な値: 0 1

ロックフラグ

0：未ロック
1：ロック済み

Responses

Request samples

Payload
Curl

Content type

application/json

{"lock_flg": 1
}

Response samples

Content type

application/json

{"message": "APIキーまたはAPIトークンが無効です。"
}

計上データ

計上データを扱うAPIです。

計上データリスト取得

計上データリストを取得します。

レスポンスデータに関する補足

計上データ区分に応じた項目

計上データは、案件・案件原価・発注の3種類のデータがあり、それぞれ持っているデータの項目が異なります。

たとえば、案件には、受注ステータス（order_status）・請求ステータス（invoice_status）・案件区分（project_type_id）などがありますが、発注にはそれらはありません。逆に発注には、発注ステータス（expenditure_status）・支払ステータス（payment_status）・発注区分（expenditure_type_id）があります。

それぞれのデータが持っている項目については、画面と対比してご確認ください。

auto_flg

通常は1（自動）ですが、計上情報変更機能を使用して、画面上で手動で計上情報を変更している場合は、0（手動）になります。

auto_renewal_simulation_flg

定期請求・定期支払では、請求期間に応じた請求・支払のデータが生成されますが、自動契約更新がONになっている場合、画面上の集計機能においては、請求期間終了後も継続する想定でシミュレーションする機能があります。

auto_renewal_simulation_flgが1のデータは、このシミュレーションデータに該当します。

query Parameters

report_ym_gteq	string <YYYY-MM> 例: report_ym_gteq=2023-10 計上年月（指定日以降）
report_ym_lteq	string <YYYY-MM> 例: report_ym_lteq=2023-10 計上年月（指定日以前）
analysis_data_kbn_in[]	string 例: analysis_data_kbn_in[]=1,2 計上データ区分 1：案件 2：案件原価 3：発注 ※複数の場合はカンマ区切り ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
order_status_in[]	string 例: order_status_in[]=4,5 受注ステータス 1：見積中(高) 2：見積中(中) 3：見積中(低) 8：見積中(除) 4：受注確定 5：受注済 9：失注 ※複数の場合はカンマ区切り ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
expenditure_status_in[]	string 例: expenditure_status_in[]=4,5 発注ステータス 1：見積中(高) 2：見積中(中) 3：見積中(低) 8：見積中(除) 4：発注確定 5：発注済 9：見送り ※複数の場合はカンマ区切り ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
include_auto_renewal_flg	integer 利用可能な値: 0 1 例: include_auto_renewal_flg=1 自動契約更新を考慮 0：自動契約更新のシミュレーションデータを含まない 1：自動契約更新のシミュレーションデータを含む ※未指定時は`0`指定時と同等の結果
invoice_status_in[]	string 例: invoice_status_in[]=4,5 請求ステータス 1：未請求 4：請求OK 2：請求済 5：一部入金済 3：入金済 9：回収不能 ※複数の場合はカンマ区切り ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
payment_status_in[]	string 例: payment_status_in[]=1,2 支払ステータス 1：請求書未受領 2：請求書受領済 4：振込予約済 3：支払済 ※複数の場合はカンマ区切り ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
updated_at_gteq	string <YYYY-MM-DD HH:MM:SS> 例: updated_at_gteq=2023-08-01 00:00:00 更新日時（指定日時以降） ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
updated_at_lteq	string <YYYY-MM-DD HH:MM:SS> 例: updated_at_lteq=2023-08-01 00:00:00 更新日時（指定日時以前） ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
per_page	integer デフォルト: 10 例: per_page=20 1ページあたりの要素数（最大100まで）
page	integer デフォルト: 1 例: page=2 現在のページ番号

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/analyses' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

[{"id": 123456,
"analysis_data_kbn": 1,
"analysis_data_kbn_name": "案件",
"project": {"id": 123456,
"name": "サンプル案件A",
"project_no": 1001,
"management_no": "TEST0001"
},
"expenditure": {"id": 123456,
"name": "サンプル発注A",
"expenditure_no": 1001,
"management_no": "TEST0001"
},
"project_cost": {"id": 123456,
"name": "サンプル原価"
},
"total": 100000,
"tax": 10000,
"tax_withholding": 10210,
"order_status": 1,
"order_status_name": "見積中(高)",
"invoice_status": 1,
"invoice_status_name": "未請求",
"delivery_status": 1,
"delivery_status_name": "未着手",
"expenditure_status": 1,
"expenditure_status_name": "見積中(高)",
"payment_status": 1,
"payment_status_name": "請求書未受領",
"report_date": "2023-10-01",
"client": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"payee": {"id": 123456,
"name": "サンプル株式会社",
"name_disp": "サンプル",
"custom_no": "C0001"
},
"company_branch": {"id": 123456,
"name": "サンプル支社"
},
"group": {"id": 123456,
"name": "グループA"
},
"user": {"id": 123456,
"last_name": "山田",
"first_name": "太郎"
},
"project_type_id": 123456,
"project_type_name": "サンプル案件区分1",
"project_type2_id": 123456,
"project_type2_name": "サンプル案件区分2",
"project_type3_id": 123456,
"project_type3_name": "サンプル案件区分3",
"expenditure_type_id": 123456,
"expenditure_type_name": "サンプル案件区分1",
"expenditure_type2_id": 123456,
"expenditure_type2_name": "サンプル案件区分2",
"expenditure_type3_id": 123456,
"expenditure_type3_name": "サンプル案件区分3",
"accounting_type_id": 123456,
"accounting_type_name": "サンプル会計区分1",
"accounting_type2_id": 123456,
"accounting_type2_name": "サンプル会計区分2",
"accounting_type3_id": 123456,
"accounting_type3_name": "サンプル会計区分3",
"tags": ["タグA",
"タグB"
],
"auto_flg": 1,
"auto_renewal_simulation_flg": null,
"classification_record_type": 1,
"classification_record_type_name": "オリジナル",
"currency": "JPY",
"total_jpy": 100000,
"tax_jpy": 10000,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}
]

ユーザー（担当者）

ユーザー（担当者）を扱うAPIです。

ユーザーリスト取得

ユーザーリストを取得します。

query Parameters

email_eq	string 例: email_eq=yamada@example.com メールアドレス ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
per_page	integer デフォルト: 10 例: per_page=20 1ページあたりの要素数（最大100まで）
page	integer デフォルト: 1 例: page=2 現在のページ番号

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/users' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

[{"id": 123456,
"email": "yamada@example.com",
"last_name": "山田",
"first_name": "太郎",
"role_id": 123456,
"role_name": "管理者",
"last_sign_in_at": "2023-08-02T16:27:35.000+09:00",
"valid_flg": 1,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}
]

グループ

グループを扱うAPIです。

グループリスト取得

グループリストを取得します。

query Parameters

name_cont	string 例: name_cont=グループA グループ名 ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
include_archive_flg	integer デフォルト: 0 利用可能な値: 0 1 例: include_archive_flg=1 アーカイブを含むか 0：アーカイブ済みは除く 1：アーカイブ済みも含む
per_page	integer デフォルト: 10 例: per_page=20 1ページあたりの要素数（最大100まで）
page	integer デフォルト: 1 例: page=2 現在のページ番号

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/groups' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

[{"id": 123456,
"name": "グループA",
"archive_flg": 0,
"company_bank_id": 123456,
"company_bank_name": "サンプル銀行 サンプル支店",
"accounting_code": "SAMPLE001",
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}
]

支払条件

支払条件を扱うAPIです。

支払条件リスト取得

支払条件リストを取得します。

query Parameters

name_cont	string 例: name_cont=月末締め翌月末払い支払条件名 ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
include_archive_flg	integer デフォルト: 0 利用可能な値: 0 1 例: include_archive_flg=1 アーカイブを含むか 0：アーカイブ済みは除く 1：アーカイブ済みも含む
per_page	integer デフォルト: 10 例: per_page=20 1ページあたりの要素数（最大100まで）
page	integer デフォルト: 1 例: page=2 現在のページ番号

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/payment_terms' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

[{"id": 123456,
"name": "月末締め翌月末払い",
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}
]

案件区分

案件区分を扱うAPIです。

案件区分リスト取得

案件区分リストを取得します。

query Parameters

project_type_kbn_eq	integer 例: project_type_kbn_eq=1 案件区分1〜3の種類 1：案件区分1 2：案件区分2 3：案件区分3 ※未指定時は`1`指定時と同等の結果
name_cont	string 例: name_cont=サンプル区分A 案件区分名 ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
include_archive_flg	integer デフォルト: 0 利用可能な値: 0 1 例: include_archive_flg=1 アーカイブを含むか 0：アーカイブ済みは除く 1：アーカイブ済みも含む
per_page	integer デフォルト: 10 例: per_page=20 1ページあたりの要素数（最大100まで）
page	integer デフォルト: 1 例: page=2 現在のページ番号

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/project_types' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

[{"id": 123456,
"name": "サンプル区分A",
"archive_flg": 0,
"company_bank_id": 123456,
"company_bank_name": "サンプル銀行 サンプル支店",
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}
]

発注区分

発注区分を扱うAPIです。

発注区分リスト取得

発注区分リストを取得します。

query Parameters

expenditure_type_kbn_eq	integer 例: expenditure_type_kbn_eq=1 発注区分1〜3の種類 1：発注区分1 2：発注区分2 3：発注区分3 ※未指定時は`1`指定時と同等の結果
name_cont	string 例: name_cont=サンプル区分A 発注区分名 ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
include_archive_flg	integer デフォルト: 0 利用可能な値: 0 1 例: include_archive_flg=1 アーカイブを含むか 0：アーカイブ済みは除く 1：アーカイブ済みも含む
per_page	integer デフォルト: 10 例: per_page=20 1ページあたりの要素数（最大100まで）
page	integer デフォルト: 1 例: page=2 現在のページ番号

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/expenditure_types' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

[{"id": 123456,
"name": "サンプル区分A",
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}
]

会計区分

会計区分を扱うAPIです。

会計区分リスト取得

会計区分リストを取得します。

query Parameters

accounting_type_kbn_eq	integer 例: accounting_type_kbn_eq=1 会計区分1〜3の種類 1：会計区分1 2：会計区分2 3：会計区分3 ※未指定時は`1`指定時と同等の結果
name_cont	string 例: name_cont=サンプル区分A 会計区分名 ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
include_archive_flg	integer デフォルト: 0 利用可能な値: 0 1 例: include_archive_flg=1 アーカイブを含むか 0：アーカイブ済みは除く 1：アーカイブ済みも含む
per_page	integer デフォルト: 10 例: per_page=20 1ページあたりの要素数（最大100まで）
page	integer デフォルト: 1 例: page=2 現在のページ番号

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/accounting_types' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

[{"id": 123456,
"name": "サンプル区分A",
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}
]

カスタム書類送付方法

カスタム書類送付方法を扱うAPIです。

カスタム書類送付方法リスト取得

カスタム書類送付方法リストを取得します。

query Parameters

name_cont	string 例: name_cont=送付方法A カスタム書類送付方法名 ※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。
include_archive_flg	integer デフォルト: 0 利用可能な値: 0 1 例: include_archive_flg=1 アーカイブを含むか 0：アーカイブ済みは除く 1：アーカイブ済みも含む
per_page	integer デフォルト: 10 例: per_page=20 1ページあたりの要素数（最大100まで）
page	integer デフォルト: 1 例: page=2 現在のページ番号

Responses

Request samples

Curl

curl --location 'https://api.the-board.jp/v1/document_send_channels' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer API-TOKEN' \
--header 'x-api-key: API-KEY'

Response samples

Content type

application/json

[{"id": 123456,
"name": "送付方法A",
"archive_flg": 0,
"created_at": "2023-08-02T16:27:35.000+09:00",
"updated_at": "2023-08-04T11:03:15.000+09:00"
}
]

board APIドキュメント (1.3.0)

概要

CHANGELOG

エンドポイント

OpenAPI

認証・認可

APIキー

APIトークン

リクエスト制限

秒間リクエスト数について

データ形式

リクエスト

レスポンス

レスポンスグループ

HTTPステータス・エラー

主なエラー原因

422エラーの場合

401・403エラーの場合

500エラーの場合

レスポンスが10MBを超えるサイズの場合

メンテナンス

サポート・FAQ

ヘルプ・FAQ

お問い合わせ

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

顧客

顧客リスト取得

query Parameters

Responses

Request samples

Response samples

顧客登録

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

顧客更新

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

顧客削除

path Parameters

Responses

Request samples

Response samples

顧客取得

path Parameters

Responses

Request samples

Response samples

顧客支社

顧客支社リスト取得

query Parameters

Responses

Request samples

Response samples

顧客支社登録

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

顧客支社更新

path Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

顧客支社削除

path Parameters

Responses

Request samples

Response samples

顧客支社取得

path Parameters

Responses

Request samples

Response samples

顧客担当者

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required