NAV Navbar
for developers

Overview

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

エンドポイント

HTTPSのみ利用することができ、ルートエンドポイントは以下です。

https://api.the-board.jp

認証・認可

board APIでは、「APIキー」と「APIトークン」の2つの概念があり、リクエストの際に両方送って頂く必要があります。

項目 説明
APIキー アカウントで1つ発行されます。
リクエスト制限はこのAPIキー単位で管理されています。
APIトークン 任意の数発行することができます。
セキュリティのため、APIトークンごとに許可する操作を指定することができます。
例)
11111111:顧客情報の登録のみ可能
22222222:案件情報の取得のみ可能
Authorization: Bearer API-TOKEN
x-api-key: API-KEY

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

APIキー・APIトークンの発行については、ヘルプをご覧ください。

リクエスト制限

board APIでは、以下のリクエスト制限があります。

1日あたりのリクエスト数のリセットタイミングはJSTではなくUTCですのでご注意ください。
秒間リクエスト数は、「トークンバケット」という流入量制御の仕組みになっています。

制限をオーバーした場合は、429 Too Many Requestsが返却されます。

秒間リクエスト数がオーバーした場合

Status: 429 Too Many Requests
{
  "message": "Too Many Requests"
}

1日のリクエスト数がオーバーした場合

Status: 429 Too Many Requests
{
  "message": "Limit Exceeded"
}

データ形式

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

リクエスト

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

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

/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の仕様を確認してください。

ページネーション

リストを返すAPIでは、ページネーション用のパラメータを指定することができます。 何も指定していない場合は、1ページ目の10件が返されます。

パラメータ 内容 デフォルト
per_page 1ページあたりの要素数(最大100まで) 10
page 現在のページ番号 1
Link: <https://api.the-board.jp/v1/clients?page=1>; rel="first",
      <https://api.the-board.jp/v1/clients?page=3>; rel="prev",
      <https://api.the-board.jp/v1/clients?page=5>; rel="next",
      <https://api.the-board.jp/v1/clients?page=10>; rel="last"
X-Total-Count: 95
X-Page: 4
X-Per-Page: 10

また、レスポンスにLinkヘッダに加え、下記の情報を返します。

ヘッダ 説明
X-Total-Count トータル件数
X-Page 現在のページ番号
X-Per-Page 1ページあたりの件数

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リクエストがあった場合、エラー内容を含むレスポンスを返します。 HTTPステータスは、エラー内容に応じて4xx・5xxを返します。

エラーレスポンス

エラー内容は、JSON形式で返します。

{
  "message": "エラーメッセージ",
  "errors": [
    {
      "field": "name_disp",
      "code": "blank",
      "description": "顧客略称名を入力してください。"
    },
    {
      "field": "zip",
      "code": "invalid",
      "description": "郵便番号が正しくありません。"
    }
  ]
}
パラメータ 内容
message エラーメッセージ
errors 項目ごとにコードと詳細を返します。(入力エラー時のみ)
field:項目名
code:エラーコード(後述)
description:エラーメッセージ詳細

エラーコード・内容は以下の通りです。

エラーコード 内容
blank 必須項目が入力されていません
greater_than 指定の値より大きい値にしてください
greater_than_or_equal_to 指定の値以上の値にしてください
inclusion 不正な値です
例:1・2・3が入力可能な項目に4を送信
invalid 値のフォーマットが正しくありません
例:郵便番号を100-0001ではなく1000001で送信
less_than 指定の値より小さい値にしてください
less_than_or_equal_to 指定の値以下の値にしてください
not_a_number 数値のみ入力可能です
not_an_integer 整数のみ入力可能です
restrict_dependent_destroy 関連するデータが存在しているので削除できません
too_long 指定文字以内で入力してください
too_short 指定文字以上で入力してください
wrong_length 指定の文字数にしてください
invalid_date 日付形式が正しくありません
invalid_time 時刻形式が正しくありません
invalid_datetime 日時形式が正しくありません

顧客

顧客の登録

顧客を新規登録します。

リクエスト

POST /v1/clients
Content-Type: application/json

{
  "name": "サンプル株式会社",
  "name_disp": "サンプル"
}

レスポンス

Status: 201 Created
Location: https://api.the-board.jp/v1/clients/1

  {
    "id": 1,
    "name": "サンプル株式会社",
    "name_disp": "サンプル",
    "title": "御中",
    "zip": "100-0001",
    "pref": "東京都",
    "address1": "千代田区千代田111",
    "address2": "テストビル3階",
    "tel": "03-0000-0001",
    "fax": "03-0000-0002",
    "payment_term_id": 1,
    "payment_term_name": "月末締翌月末払",
    "bank_charge_to_client_flg": 1,
    "nda_flg": 1,
    "basic_agreement_flg": 0,
    "document_send_type": 2,
    "document_send_type_name": "郵送",
    "note": null,
    "tags": [
      "サンプルタグA",
      "サンプルタグB"
    ],
    "wareki_flg": 0,
    "company_number": "1234567890123",
    "accounting_code": "123",
    "to": "example@the-board.jp",
    "cc": "example@the-board.jp",
    "name_en": "Sample, inc",
    "address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
    "phone_country_code": "81",
    "currency": "USD",
    "lang_kbn": 2,
    "lang_kbn_name": "日本語",
    "archive_flg": 0,
    "custom_no": "A00001",
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

POST /v1/clients

パラメータ

パラメータ 必須 説明
name string 顧客名
name_disp string 顧客略称名
title string 敬称
デフォルト:御中
zip string 郵便番号(ハイフン区切り)
例:100-0001
pref string 都道府県名
例:東京都
address1 string 住所1
address2 string 住所2
tel string 電話番号(ハイフン区切り)
例:03-0000-0000
fax string FAX(ハイフン区切り)
例:03-0000-0000
payment_term_id integer デフォルト支払条件ID
未指定の場合は最初の支払条件がセットされる
bank_charge_to_client_flg integer 振込手数料負担
0:当方 1:先方(デフォルト)
nda_flg integer NDA締結
0:未(デフォルト) 1:済
basic_agreement_flg integer 基本契約書締結
0:未(デフォルト) 1:済
document_send_type integer 書類送付方法
1:メール(デフォルト) 2:郵送 3:両方
note string 備考
tags array タグ
wareki_flg integer デフォルト和暦表示
0:OFF(デフォルト) 1:ON
※和暦表示有効時のみ
company_number string 法人番号(13桁)
accounting_code string 会計用名称・コード
to string TO
複数指定する場合はカンマ区切り
cc string CC
複数指定する場合はカンマ区切り
name_en string 顧客名(英語表記)
※英語アドオン有効時のみ
address_en string 住所(英語表記)
※英語アドオン有効時のみ
phone_country_code string 国番号(英語表記)
※英語アドオン有効時のみ
currency string デフォルト通貨
JPY(デフォルト)/ USD / EUR / GBP / CNY / HKD / TWD / KRW / SGD
※英語アドオン有効時のみ
lang_kbn integer デフォルト言語
1:日本語(デフォルト) 2:英語
※英語アドオン有効時のみ
archive_flg integer アーカイブ状態
0:OFF(デフォルト) 1:ON
custom_no string 顧客番号

顧客の更新

既存の顧客を更新します。

リクエスト

PATCH /v1/clients/1
Content-Type: application/json

{
  "basic_agreement_flg": 1
}

レスポンス

Status: 200 OK

  {
    "id": 1,
    "name": "サンプル株式会社",
    "name_disp": "サンプル",
    "title": "御中",
    "zip": "100-0001",
    "pref": "東京都",
    "address1": "千代田区千代田111",
    "address2": "テストビル3階",
    "tel": "03-0000-0001",
    "fax": "03-0000-0002",
    "payment_term_id": 1,
    "payment_term_name": "月末締翌月末払",
    "bank_charge_to_client_flg": 1,
    "nda_flg": 1,
    "basic_agreement_flg": 0,
    "document_send_type": 2,
    "document_send_type_name": "郵送",
    "note": null,
    "tags": [
      "サンプルタグA",
      "サンプルタグB"
    ],
    "wareki_flg": 0,
    "company_number": "1234567890123",
    "accounting_code": "123",
    "to": "example@the-board.jp",
    "cc": "example@the-board.jp",
    "name_en": "Sample, inc",
    "address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
    "phone_country_code": "81",
    "currency": "USD",
    "lang_kbn": 2,
    "lang_kbn_name": "日本語",
    "archive_flg": 0,
    "custom_no": "A00001",
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

PATCH /v1/clients/:id

URLパラメータ

パラメータ 必須 説明
id integer 顧客ID
顧客情報のレスポンスにあるidを指定

パラメータ

更新しない項目は指定する必要はありません。

パラメータ 必須 説明
name string 顧客名
name_disp string 顧客略称名
title string 敬称
デフォルト:御中
zip string 郵便番号(ハイフン区切り)
例:100-0001
pref string 都道府県名
例:東京都
address1 string 住所1
address2 string 住所2
tel string 電話番号(ハイフン区切り)
例:03-0000-0000
fax string FAX(ハイフン区切り)
例:03-0000-0000
payment_term_id integer デフォルト支払条件ID
未指定の場合は最初の支払条件がセットされる
bank_charge_to_client_flg integer 振込手数料負担
0:当方 1:先方(デフォルト)
nda_flg integer NDA締結
0:未(デフォルト) 1:済
basic_agreement_flg integer 基本契約書締結
0:未(デフォルト) 1:済
document_send_type integer 書類送付方法
1:メール(デフォルト) 2:郵送 3:両方
note string 備考
tags array タグ
wareki_flg integer デフォルト和暦表示
0:OFF(デフォルト) 1:ON
※和暦表示有効時のみ
company_number string 法人番号(13桁)
accounting_code string 会計用名称・コード
to string TO
複数指定する場合はカンマ区切り
cc string CC
複数指定する場合はカンマ区切り
name_en string 顧客名(英語表記)
※英語アドオン有効時のみ
address_en string 住所(英語表記)
※英語アドオン有効時のみ
phone_country_code string 国番号(英語表記)
※英語アドオン有効時のみ
currency string デフォルト通貨
JPY(デフォルト)/ USD / EUR / GBP / CNY / HKD / TWD / KRW / SGD
※英語アドオン有効時のみ
lang_kbn integer デフォルト言語
1:日本語(デフォルト) 2:英語
※英語アドオン有効時のみ
archive_flg integer アーカイブ状態
0:OFF(デフォルト) 1:ON
custom_no string 顧客番号

顧客の削除

既存の顧客を削除します。

リクエスト

DELETE /v1/clients/1

レスポンス

Status: 204 No Content

DELETE /v1/clients/:id

URLパラメータ

パラメータ 必須 説明
id integer 顧客ID
顧客情報のレスポンスにあるidを指定

顧客の取得

既存の顧客情報を取得します。

リクエスト

GET /v1/clients/1

レスポンス

Status: 200 OK

  {
    "id": 1,
    "name": "サンプル株式会社",
    "name_disp": "サンプル",
    "title": "御中",
    "zip": "100-0001",
    "pref": "東京都",
    "address1": "千代田区千代田111",
    "address2": "テストビル3階",
    "tel": "03-0000-0001",
    "fax": "03-0000-0002",
    "payment_term_id": 1,
    "payment_term_name": "月末締翌月末払",
    "bank_charge_to_client_flg": 1,
    "nda_flg": 1,
    "basic_agreement_flg": 0,
    "document_send_type": 2,
    "document_send_type_name": "郵送",
    "note": null,
    "tags": [
      "サンプルタグA",
      "サンプルタグB"
    ],
    "wareki_flg": 0,
    "company_number": "1234567890123",
    "accounting_code": "123",
    "to": "example@the-board.jp",
    "cc": "example@the-board.jp",
    "name_en": "Sample, inc",
    "address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
    "phone_country_code": "81",
    "currency": "USD",
    "lang_kbn": 2,
    "lang_kbn_name": "日本語",
    "archive_flg": 0,
    "custom_no": "A00001",
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

GET /v1/clients/:id

URLパラメータ

パラメータ 必須 説明
id integer 顧客ID
顧客情報のレスポンスにあるidを指定

顧客リストの取得

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

リクエスト

GET /v1/clients?include_archive_flg=1&tags[]=サンプルタグA,サンプルタグB"

レスポンス

Status: 200 OK
Link: <https://api.the-board.jp/v1/clients?page=1>; rel="first",
      <https://api.the-board.jp/v1/clients?page=3>; rel="prev",
      <https://api.the-board.jp/v1/clients?page=5>; rel="next",
      <https://api.the-board.jp/v1/clients?page=10>; rel="last"
X-Total-Count: 95
[
  {
    "id": 1,
    "name": "サンプル株式会社",
    "name_disp": "サンプル",
    "title": "御中",
    "zip": "100-0001",
    "pref": "東京都",
    "address1": "千代田区千代田111",
    "address2": "テストビル3階",
    "tel": "03-0000-0001",
    "fax": "03-0000-0002",
    "payment_term_id": 1,
    "payment_term_name": "月末締翌月末払",
    "bank_charge_to_client_flg": 1,
    "nda_flg": 1,
    "basic_agreement_flg": 0,
    "document_send_type": 2,
    "document_send_type_name": "郵送",
    "note": null,
    "tags": [
      "サンプルタグA",
      "サンプルタグB"
    ],
    "wareki_flg": 0,
    "company_number": "1234567890123",
    "accounting_code": "123",
    "to": "example@the-board.jp",
    "cc": "example@the-board.jp",
    "name_en": "Sample, inc",
    "address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
    "phone_country_code": "81",
    "currency": "USD",
    "lang_kbn": 2,
    "lang_kbn_name": "日本語",
    "archive_flg": 0,
    "custom_no": "A00001",
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }
  {・・・},
  {・・・},
]

GET /v1/clients

URLパラメータ

指定のパラメータでフィルタリングします。

パラメータ 必須 説明
tags[] string タグ
※複数の場合はカンマ区切り
include_archive_flg string 0:アーカイブ済は除く
1:アーカイブされたものも含む
updated_at_gteq datetime 更新日時(指定日時以降)
YYYY-MM-DD HH:MM:SS
updated_at_lteq datetime 更新日時(指定日時以前)
YYYY-MM-DD HH:MM:SS
custom_no_eq string 顧客番号

*ページネーション用のパラメータについてはページネーション参照

レスポンスグループ

常に全ての項目を返却するとデータ量が多いため、以下のレスポンスグループをURLパラメータとして指定することができます。

レスポンスグループ 説明 項目
small 基本項目のみ(デフォルト) id
name
name_disp
title
zip
pref
address1
address2
tel
fax
payment_term_id
payment_term_name
company_number
created_at
updated_at
large 全ての項目

顧客担当者

顧客担当者の登録

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

リクエスト

POST /v1/contacts
Content-Type: application/json

{
  "client_id": 1,
  "last_name": "山田",
  "first_name": "太郎",
  "title": "課長",
  "department": "システム部"
}

レスポンス

Status: 201 Created
Location: https://api.the-board.jp/v1/contacts/1

  {
    "id": 1,
    "client": {
      "id": 1,
      "name": "サンプル株式会社",
      "name_disp": "サンプル"
    },
    "last_name": "山田",
    "first_name": "太郎",
    "title": "課長",
    "department": "システム部",
    "email": "example@the-board.jp",
    "note": "",
    "archive_flg": 0,
    "last_name_en": null,
    "first_name_en": null,
    "prefix_en": null,
    "title_en": null,
    "department_en": null,
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

POST /v1/contacts

パラメータ

パラメータ 必須 説明
client_id integer 顧客ID
last_name string
first_name string
title string 肩書
department string 部署
email string メールアドレス
note string 備考
archive_flg integer アーカイブ状態
0:OFF(デフォルト) 1:ON
last_name_en string 姓(英語表記)
first_name_en string 名(英語表記)
prefix_en string 敬称(英語表記)
title_en string 肩書(英語表記)
department_en string 部署(英語表記)

顧客担当者の更新

既存の顧客担当者を更新します。

リクエスト

PATCH /v1/contacts/1
Content-Type: application/json

{
  "title": "部長"
}

レスポンス

Status: 200 OK

  {
    "id": 1,
    "client": {
      "id": 1,
      "name": "サンプル株式会社",
      "name_disp": "サンプル"
    },
    "last_name": "山田",
    "first_name": "太郎",
    "title": "課長",
    "department": "システム部",
    "email": "example@the-board.jp",
    "note": "",
    "archive_flg": 0,
    "last_name_en": null,
    "first_name_en": null,
    "prefix_en": null,
    "title_en": null,
    "department_en": null,
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

PATCH /v1/contacts/:id

URLパラメータ

パラメータ 必須 説明
id integer 顧客担当者ID
顧客担当者情報のレスポンスにあるIDを指定

パラメータ

更新しない項目は指定する必要はありません。

パラメータ 必須 説明
client_id integer 顧客ID
last_name string
first_name string
title string 肩書
department string 部署
email string メールアドレス
note string 備考
archive_flg integer アーカイブ状態
0:OFF(デフォルト) 1:ON
last_name_en string 姓(英語表記)
first_name_en string 名(英語表記)
prefix_en string 敬称(英語表記)
title_en string 肩書(英語表記)
department_en string 部署(英語表記)

顧客担当者の削除

既存の顧客担当者を削除します。

リクエスト

DELETE /v1/contacts/1

レスポンス

Status: 204 No Content

DELETE /v1/contacts/:id

URLパラメータ

パラメータ 必須 説明
id integer 顧客担当者ID
顧客担当者情報のレスポンスにあるIDを指定

顧客担当者の取得

既存の顧客担当者情報を取得します。

リクエスト

GET /v1/contacts/1

レスポンス

Status: 200 OK

  {
    "id": 1,
    "client": {
      "id": 1,
      "name": "サンプル株式会社",
      "name_disp": "サンプル"
    },
    "last_name": "山田",
    "first_name": "太郎",
    "title": "課長",
    "department": "システム部",
    "email": "example@the-board.jp",
    "note": "",
    "archive_flg": 0,
    "last_name_en": null,
    "first_name_en": null,
    "prefix_en": null,
    "title_en": null,
    "department_en": null,
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

GET /v1/contacts/:id

URLパラメータ

パラメータ 必須 説明
id integer 顧客担当者ID
顧客担当者情報のレスポンスにあるIDを指定

顧客担当者リストの取得

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

リクエスト

GET /v1/contactsclient_id_eq=1"

レスポンス

Status: 200 OK
Link: <https://api.the-board.jp/v1/contacts?page=1>; rel="first",
      <https://api.the-board.jp/v1/contacts?page=3>; rel="prev",
      <https://api.the-board.jp/v1/contacts?page=5>; rel="next",
      <https://api.the-board.jp/v1/contacts?page=10>; rel="last"
X-Total-Count: 95
[
  {
    "id": 1,
    "client": {
      "id": 1,
      "name": "サンプル株式会社",
      "name_disp": "サンプル"
    },
    "last_name": "山田",
    "first_name": "太郎",
    "title": "課長",
    "department": "システム部",
    "email": "example@the-board.jp",
    "note": "",
    "archive_flg": 0,
    "last_name_en": null,
    "first_name_en": null,
    "prefix_en": null,
    "title_en": null,
    "department_en": null,
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }
  {・・・},
  {・・・},
]

GET /v1/contacts

URLパラメータ

指定のパラメータでフィルタリングします。

パラメータ 必須 説明
client_id_eq integer 顧客ID
include_archive_flg string 0:アーカイブ済は除く
1:アーカイブされたものも含む
updated_at_gteq datetime 更新日時(指定日時以降)
YYYY-MM-DD HH:MM:SS
updated_at_lteq datetime 更新日時(指定日時以前)
YYYY-MM-DD HH:MM:SS

*ページネーション用のパラメータについてはページネーション参照

レスポンスグループ

顧客担当者は項目数が少ないため、レスポンスグループはありません。常に全ての項目が返ります。

案件

案件の登録

案件を新規登録します。

リクエスト

POST /v1/projects
Content-Type: application/json

// 一括請求の例
{
  "name": "サンプル案件",
  "client_id": 123456,
  "user_id": 123456,
  "estimate_date": "2017-08-11",
  "order_status": 1,
  "invoice_timing_kbn": 1,
  "invoice_date": "2017-08-31",
  "tags": ["テスト1", "テスト2"]
}

// 定期請求の例
{
  "name": "サンプル案件",
  "client_id": 123456,
  "user_id": 123456,
  "estimate_date": "2017-08-11",
  "order_status": 1,
  "invoice_timing_kbn": 2,
  "contract_start_date": "2017-08-01",
  "contract_end_date": "2018-07-31"
}

// 分割請求の例
{
  "name": "サンプル案件",
  "client_id": 123456,
  "user_id": 123456,
  "estimate_date": "2017-08-11",
  "order_status": 1,
  "invoice_timing_kbn": 3,
  "invoice_dates": ["2017-08-31","2017-10-31"]
}

レスポンス

Status: 201 Created
Location: https://api.the-board.jp/v1/projects/1

  {
    "id": 1,
    "project_no": 1001,
    "management_no": "123456",
    "name": "サンプル案件",
    "client": {
        "id": 1,
        "name": "サンプル株式会社",
        "name_disp": "サンプル"
    },
    "client_branch": {
        "id": 1,
        "name":"サンプル支社"
    },
    "client_name_disp_kbn": 2,
    "client_name_disp_kbn_name": "会社名+支社名",
    "client_name_for_post_disp_kbn": 2,
    "client_name_for_post_disp_kbn_name": "会社名+支社名",
    "contact": {
        "id": 1,
        "last_name": "山田",
        "first_name": "太郎"
    },
    "company_branch": {
        "id": 1,
        "name": "テスト支社"
    },
    "company_name_disp_kbn": 2,
    "company_name_disp_kbn_name": "会社名+支社名",
    "company_name_for_post_disp_kbn": 2,
    "company_name_for_post_disp_kbn_name": "会社名+支社名",
    "user": {
        "id": 1,
        "last_name": "サンプル",
        "first_name": "太郎"
    },
    "total": 100000,
    "tax": 8000,
    "cost_total": 0,
    "cost_tax": 0,
    "invoice_total": 100000,
    "invoice_tax": 8000,
    "estimate_date": "2017-01-01",
    "delivery_date": "2017-01-31",
    "invoice_dates": [
      "2017-01-31"
    ],
    "payment_term_id": 1,
    "payment_term_name": "月末締翌月末払",
    "order_status": 1,
    "order_status_name": "見積中(高)",
    "delivery_status": 1,
    "delivery_status_name": "未着手",
    "invoice_timing_kbn": 1,
    "invoice_timing_kbn_name": "一括請求",
    "contract_start_date": null,
    "contract_end_date": null,
    "project_type_id": 1,
    "project_type_name": "サンプル区分A",
    "project_type2_id": 2,
    "project_type2_name": "サンプル区分2",
    "project_type3_id": 3,
    "project_type3_name": "サンプル区分3",
    "group_id": 1,
    "group_name": "グループA",
    "tags": [],
    "in_house_memo": null,
    "ordered_date": "2017-01-10",
    "payment_method_kbn": 1,
    "payment_method_kbn_name": "銀行振込",
    "tax_rule_kbn": 2,
    "tax_rule_kbn_name": "切り捨て",
    "to": "example@the-board.jp",
    "cc": "example@the-board.jp",
    "lock_flg": 0,
    "wareki_flg": 0,
    "archive_flg": 0,
    "currency": "JPY",
    "lang_kbn": 1,
    "lang_kbn_name": "日本語",
    "exchange_rate": 1,
    "total_jpy": 100000,
    "tax_jpy": 8000,
    "invoice_total_jpy": 100000,
    "invoice_tax_jpy": 8000,
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

POST /v1/projects

パラメータについて

一括請求・定期請求・分割請求に応じて必要なパラメータが異なります。
それぞれ、以下のパラメータを送信してください。
一括請求の案件:共通+一括請求のパラメータ
定期請求の案件:共通+定期請求のパラメータ
分割請求の案件:共通+分割請求のパラメータ

パラメータ(共通)

パラメータ 必須 説明
name string 案件名
client_id integer 顧客ID
顧客リストで取得できるid
client_branch_id integer 顧客支社ID
client_name_disp_kbn integer 顧客支社(書類上の表示)
※支社を指定する場合のみ
1: 会社名のみ(デフォルト)
2: 会社名+支社名
3: 支社名のみ
client_name_for_post_disp_kbn integer 顧客支社(郵送時の表示)
※支社を指定する場合のみ
1: 会社名のみ(デフォルト)
2: 会社名+支社名
3: 支社名のみ
contact_id integer 顧客担当者ID
顧客担当者リストで取得できるid
company_branch_id integer 自社支社ID
company_name_disp_kbn integer 自社支社(書類上の表示)
※支社を指定する場合のみ
1: 会社名のみ(デフォルト)
2: 会社名+支社名
3: 支社名のみ
company_name_for_post_disp_kbn integer 自社支社(郵送時の表示)
※支社を指定する場合のみ
1: 会社名のみ(デフォルト)
2: 会社名+支社名
3: 支社名のみ
user_id integer ユーザID(担当者ID)
ユーザリストで取得できるid
estimate_date date 見積日
YYYY-MM-DD
payment_term_id integer 支払条件ID
支払条件リストで取得できるid
※未指定の場合は顧客の「デフォルト支払条件」
order_status integer 受注ステータス
1: 見積中(高)
2: 見積中(中)
3: 見積中(低)
8: 見積中(除)
4: 受注確定
5: 受注済
9: 失注
invoice_timing_kbn integer 請求タイミング
1: 一括請求
2: 定期請求
3: 分割請求
delivery_date date 納期
YYYY-MM-DD
in_house_memo string 社内メモ
management_no string 管理番号
ordered_date date 受注日
YYYY-MM-DD
project_type_id integer 案件区分1ID
案件区分リストで取得できるid
project_type2_id integer 案件区分2ID
案件区分リストで取得できるid
project_type3_id integer 案件区分3ID
案件区分リストで取得できるid
tags array タグ
group_id integer グループID
グループリストで取得できるid
payment_method_kbn integer 支払方法区分
1: 銀行振込(デフォルト)
2: 口座振替
3: クレジットカード
4: 現金支払
5: 代金引換
6: コンビニ支払
7: 郵便振替
delivery_status integer 進捗状況
1: 未着手(デフォルト)
2: 着手中
3: 納品済
4: 検収済
tax_rule_kbn integer 端数処理
1: 四捨五入
2: 切り捨て
3: 切り上げ
※デフォルトはアカウントの設定による
wareki_flg integer 和暦表示
0: OFF(デフォルト)
1: ON
※和暦表示有効時のみ
to string TO
cc string CC
currency string デフォルト通貨
JPY(デフォルト)/ USD / EUR / GBP / CNY / HKD / TWD / KRW / SGD
※英語アドオン有効時のみ
lang_kbn string 言語区分
1: 日本語(デフォルト)
2: 英語
※英語外貨アドオン有効時のみ
exchange_rate decimal 為替レート
※英語外貨アドオン有効時のみ

パラメータ(一括請求の場合のみ)

パラメータ 必須 説明
invoice_date date 請求日
YYYY-MM-DD

パラメータ(定期請求の場合のみ)

パラメータ 必須 説明
contract_start_date date 契約開始日
YYYY-MM-DD
contract_end_date date 契約終了日
YYYY-MM-DD
delivery_document_kbn integer 納品書・検収書の枚数
1: 1枚(デフォルト)
2: 請求回数と同じ
※複数納品書対応ON時のみ
periodical_invoice_interval integer 請求間隔
1〜12の数字(デフォルト: 1)
periodical_invoice_payment_kbn integer 請求間隔内の請求時期
1: 請求間隔の最初の月(デフォルト)
2: 請求間隔の最後の月
contract_end_alert_flg integer 通知対象
0: OFF 1: ON(デフォルト)
auto_renewal_flg integer 自動契約更新
0: OFF(デフォルト) 1: ON
auto_renewal_period_month integer 自動契約更新期間(月数)
1〜12の数字
※自動契約更新ONの場合のみ必須
monthly_invoice_payment_kbn integer 請求書に自動表示される年月表記
1: 請求月(デフォルト)
2: 請求月の翌月
3: 請求月の前月

パラメータ(分割請求の場合のみ)

パラメータ 必須 説明
delivery_document_kbn integer 納品書・検収書の枚数
1: 1枚(デフォルト)
2: 請求回数と同じ
※複数納品書対応ON時のみ
invoice_dates array 請求日
YYYY-MM-DD

案件の更新

既存の案件を更新します。

リクエスト

PATCH /v1/projects/1
Content-Type: application/json

{
  "invoice_date": "2017-09-30",
  "tags": ["テスト3"]
}

レスポンス

Status: 200 OK

  {
    "id": 1,
    "project_no": 1001,
    "management_no": "123456",
    "name": "サンプル案件",
    "client": {
        "id": 1,
        "name": "サンプル株式会社",
        "name_disp": "サンプル"
    },
    "client_branch": {
        "id": 1,
        "name":"サンプル支社"
    },
    "client_name_disp_kbn": 2,
    "client_name_disp_kbn_name": "会社名+支社名",
    "client_name_for_post_disp_kbn": 2,
    "client_name_for_post_disp_kbn_name": "会社名+支社名",
    "contact": {
        "id": 1,
        "last_name": "山田",
        "first_name": "太郎"
    },
    "company_branch": {
        "id": 1,
        "name": "テスト支社"
    },
    "company_name_disp_kbn": 2,
    "company_name_disp_kbn_name": "会社名+支社名",
    "company_name_for_post_disp_kbn": 2,
    "company_name_for_post_disp_kbn_name": "会社名+支社名",
    "user": {
        "id": 1,
        "last_name": "サンプル",
        "first_name": "太郎"
    },
    "total": 100000,
    "tax": 8000,
    "cost_total": 0,
    "cost_tax": 0,
    "invoice_total": 100000,
    "invoice_tax": 8000,
    "estimate_date": "2017-01-01",
    "delivery_date": "2017-01-31",
    "invoice_dates": [
      "2017-01-31"
    ],
    "payment_term_id": 1,
    "payment_term_name": "月末締翌月末払",
    "order_status": 1,
    "order_status_name": "見積中(高)",
    "delivery_status": 1,
    "delivery_status_name": "未着手",
    "invoice_timing_kbn": 1,
    "invoice_timing_kbn_name": "一括請求",
    "contract_start_date": null,
    "contract_end_date": null,
    "project_type_id": 1,
    "project_type_name": "サンプル区分A",
    "project_type2_id": 2,
    "project_type2_name": "サンプル区分2",
    "project_type3_id": 3,
    "project_type3_name": "サンプル区分3",
    "group_id": 1,
    "group_name": "グループA",
    "tags": [],
    "in_house_memo": null,
    "ordered_date": "2017-01-10",
    "payment_method_kbn": 1,
    "payment_method_kbn_name": "銀行振込",
    "tax_rule_kbn": 2,
    "tax_rule_kbn_name": "切り捨て",
    "to": "example@the-board.jp",
    "cc": "example@the-board.jp",
    "lock_flg": 0,
    "wareki_flg": 0,
    "archive_flg": 0,
    "currency": "JPY",
    "lang_kbn": 1,
    "lang_kbn_name": "日本語",
    "exchange_rate": 1,
    "total_jpy": 100000,
    "tax_jpy": 8000,
    "invoice_total_jpy": 100000,
    "invoice_tax_jpy": 8000,
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

PATCH /v1/projects/:id

URLパラメータ

パラメータ 必須 説明
id integer 案件ID
案件情報のレスポンスにあるidを指定

パラメータについて

一括請求・定期請求・分割請求に応じて必要なパラメータが異なります。
それぞれ、以下のパラメータを送信してください。
一括請求の案件:共通+一括請求のパラメータ
定期請求の案件:共通+定期請求のパラメータ
分割請求の案件:共通+分割請求のパラメータ

更新しない項目は指定する必要はありません。

パラメータ(共通)

パラメータ 必須 説明
name string 案件名
client_id integer 顧客ID
顧客リストで取得できるid
client_branch_id integer 顧客支社ID
client_name_disp_kbn integer 顧客支社(書類上の表示)
※支社を指定する場合のみ
1: 会社名のみ(デフォルト)
2: 会社名+支社名
3: 支社名のみ
client_name_for_post_disp_kbn integer 顧客支社(郵送時の表示)
※支社を指定する場合のみ
1: 会社名のみ(デフォルト)
2: 会社名+支社名
3: 支社名のみ
contact_id integer 顧客担当者ID
顧客担当者リストで取得できるid
company_branch_id integer 自社支社ID
company_name_disp_kbn integer 自社支社(書類上の表示)
※支社を指定する場合のみ
1: 会社名のみ(デフォルト)
2: 会社名+支社名
3: 支社名のみ
company_name_for_post_disp_kbn integer 自社支社(郵送時の表示)
※支社を指定する場合のみ
1: 会社名のみ(デフォルト)
2: 会社名+支社名
3: 支社名のみ
user_id integer ユーザID(担当者ID)
ユーザリストで取得できるid
estimate_date date 見積日
YYYY-MM-DD
payment_term_id integer 支払条件ID
支払条件リストで取得できるid
※未指定の場合は顧客の「デフォルト支払条件」
order_status integer 受注ステータス
1: 見積中(高)
2: 見積中(中)
3: 見積中(低)
8: 見積中(除)
4: 受注確定
5: 受注済
9: 失注
invoice_timing_kbn integer 請求タイミング
1: 一括請求
2: 定期請求
3: 分割請求
delivery_date date 納期
YYYY-MM-DD
in_house_memo string 社内メモ
management_no string 管理番号
ordered_date date 受注日
YYYY-MM-DD
project_type_id integer 案件区分1ID
案件区分リストで取得できるid
project_type2_id integer 案件区分2ID
案件区分リストで取得できるid
project_type3_id integer 案件区分3ID
案件区分リストで取得できるid
tags array タグ
group_id integer グループID
グループリストで取得できるid
payment_method_kbn integer 支払方法区分
1: 銀行振込(デフォルト)
2: 口座振替
3: クレジットカード
4: 現金支払
5: 代金引換
6: コンビニ支払
7: 郵便振替
delivery_status integer 進捗状況
1: 未着手(デフォルト)
2: 着手中
3: 納品済
4: 検収済
tax_rule_kbn integer 端数処理
1: 四捨五入
2: 切り捨て
3: 切り上げ
※デフォルトはアカウントの設定による
wareki_flg integer 和暦表示
0: OFF(デフォルト)
1: ON
※和暦表示有効時のみ
to string TO
cc string CC
currency string デフォルト通貨
JPY(デフォルト)/ USD / EUR / GBP / CNY / HKD / TWD / KRW / SGD
※英語アドオン有効時のみ
lang_kbn string 言語区分
1: 日本語(デフォルト)
2: 英語
※英語外貨アドオン有効時のみ
exchange_rate decimal 為替レート
※英語外貨アドオン有効時のみ

パラメータ(一括請求の場合のみ)

パラメータ 必須 説明
invoice_date date 請求日
YYYY-MM-DD

パラメータ(定期請求の場合のみ)

パラメータ 必須 説明
contract_start_date date 契約開始日
YYYY-MM-DD
contract_end_date date 契約終了日
YYYY-MM-DD
delivery_document_kbn integer 納品書・検収書の枚数
1: 1枚(デフォルト)
2: 請求回数と同じ
※複数納品書対応ON時のみ
periodical_invoice_interval integer 請求間隔
1〜12の数字(デフォルト: 1)
periodical_invoice_payment_kbn integer 請求間隔内の請求時期
1: 請求間隔の最初の月(デフォルト)
2: 請求間隔の最後の月
contract_end_alert_flg integer 通知対象
0: OFF 1: ON(デフォルト)
auto_renewal_flg integer 自動契約更新
0: OFF(デフォルト) 1: ON
auto_renewal_period_month integer 自動契約更新期間(月数)
1〜12の数字
※自動契約更新ONの場合のみ必須
monthly_invoice_payment_kbn integer 請求書に自動表示される年月表記
1: 請求月(デフォルト)
2: 請求月の翌月
3: 請求月の前月

パラメータ(分割請求の場合のみ)

現在、APIでの分割回数の変更(請求日・請求回数の変更)には対応していません。

パラメータ 必須 説明
delivery_document_kbn integer 納品書・検収書の枚数
1: 1枚(デフォルト)
2: 請求回数と同じ
※複数納品書対応ON時のみ

案件の削除

既存の案件を削除します。

リクエスト

DELETE /v1/projects/1

レスポンス

Status: 204 No Content

DELETE /v1/projects/:id

URLパラメータ

パラメータ 必須 説明
id integer 案件ID
案件情報のレスポンスにあるidを指定

案件の取得

既存の案件情報を取得します。

リクエスト

GET /v1/projects/1

レスポンス

Status: 200 OK

  {
    "id": 1,
    "project_no": 1001,
    "management_no": "123456",
    "name": "サンプル案件",
    "client": {
        "id": 1,
        "name": "サンプル株式会社",
        "name_disp": "サンプル"
    },
    "client_branch": {
        "id": 1,
        "name":"サンプル支社"
    },
    "client_name_disp_kbn": 2,
    "client_name_disp_kbn_name": "会社名+支社名",
    "client_name_for_post_disp_kbn": 2,
    "client_name_for_post_disp_kbn_name": "会社名+支社名",
    "contact": {
        "id": 1,
        "last_name": "山田",
        "first_name": "太郎"
    },
    "company_branch": {
        "id": 1,
        "name": "テスト支社"
    },
    "company_name_disp_kbn": 2,
    "company_name_disp_kbn_name": "会社名+支社名",
    "company_name_for_post_disp_kbn": 2,
    "company_name_for_post_disp_kbn_name": "会社名+支社名",
    "user": {
        "id": 1,
        "last_name": "サンプル",
        "first_name": "太郎"
    },
    "total": 100000,
    "tax": 8000,
    "cost_total": 0,
    "cost_tax": 0,
    "invoice_total": 100000,
    "invoice_tax": 8000,
    "estimate_date": "2017-01-01",
    "delivery_date": "2017-01-31",
    "invoice_dates": [
      "2017-01-31"
    ],
    "payment_term_id": 1,
    "payment_term_name": "月末締翌月末払",
    "order_status": 1,
    "order_status_name": "見積中(高)",
    "delivery_status": 1,
    "delivery_status_name": "未着手",
    "invoice_timing_kbn": 1,
    "invoice_timing_kbn_name": "一括請求",
    "contract_start_date": null,
    "contract_end_date": null,
    "project_type_id": 1,
    "project_type_name": "サンプル区分A",
    "project_type2_id": 2,
    "project_type2_name": "サンプル区分2",
    "project_type3_id": 3,
    "project_type3_name": "サンプル区分3",
    "group_id": 1,
    "group_name": "グループA",
    "tags": [],
    "in_house_memo": null,
    "ordered_date": "2017-01-10",
    "payment_method_kbn": 1,
    "payment_method_kbn_name": "銀行振込",
    "tax_rule_kbn": 2,
    "tax_rule_kbn_name": "切り捨て",
    "to": "example@the-board.jp",
    "cc": "example@the-board.jp",
    "lock_flg": 0,
    "wareki_flg": 0,
    "archive_flg": 0,
    "currency": "JPY",
    "lang_kbn": 1,
    "lang_kbn_name": "日本語",
    "exchange_rate": 1,
    "total_jpy": 100000,
    "tax_jpy": 8000,
    "invoice_total_jpy": 100000,
    "invoice_tax_jpy": 8000,
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

GET /v1/projects/:id

URLパラメータ

パラメータ 必須 説明
id integer 案件ID
案件情報のレスポンスにあるidを指定

レスポンスグループ

常に全ての項目を返却するとデータ量が多いため、レスポンスグループをURLパラメータとして指定することができます。

案件のレスポンスグループについては、「案件リストの取得」を参照してください。

案件リストの取得

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

リクエスト

GET /v1/projects?response_group=large&created_at_gteq=2016-12-01%2000:00:00"

レスポンス

Status: 200 OK
Link: <https://api.the-board.jp/v1/projects?page=1>; rel="first",
      <https://api.the-board.jp/v1/projects?page=3>; rel="prev",
      <https://api.the-board.jp/v1/projects?page=5>; rel="next",
      <https://api.the-board.jp/v1/projects?page=10>; rel="last"
X-Total-Count: 95
[
  {
    "id": 1,
    "project_no": 1001,
    "management_no": "123456",
    "name": "サンプル案件",
    "client": {
        "id": 1,
        "name": "サンプル株式会社",
        "name_disp": "サンプル"
    },
    "client_branch": {
        "id": 1,
        "name":"サンプル支社"
    },
    "client_name_disp_kbn": 2,
    "client_name_disp_kbn_name": "会社名+支社名",
    "client_name_for_post_disp_kbn": 2,
    "client_name_for_post_disp_kbn_name": "会社名+支社名",
    "contact": {
        "id": 1,
        "last_name": "山田",
        "first_name": "太郎"
    },
    "company_branch": {
        "id": 1,
        "name": "テスト支社"
    },
    "company_name_disp_kbn": 2,
    "company_name_disp_kbn_name": "会社名+支社名",
    "company_name_for_post_disp_kbn": 2,
    "company_name_for_post_disp_kbn_name": "会社名+支社名",
    "user": {
        "id": 1,
        "last_name": "サンプル",
        "first_name": "太郎"
    },
    "total": 100000,
    "tax": 8000,
    "cost_total": 0,
    "cost_tax": 0,
    "invoice_total": 100000,
    "invoice_tax": 8000,
    "estimate_date": "2017-01-01",
    "delivery_date": "2017-01-31",
    "invoice_dates": [
      "2017-01-31"
    ],
    "payment_term_id": 1,
    "payment_term_name": "月末締翌月末払",
    "order_status": 1,
    "order_status_name": "見積中(高)",
    "delivery_status": 1,
    "delivery_status_name": "未着手",
    "invoice_timing_kbn": 1,
    "invoice_timing_kbn_name": "一括請求",
    "contract_start_date": null,
    "contract_end_date": null,
    "project_type_id": 1,
    "project_type_name": "サンプル区分A",
    "project_type2_id": 2,
    "project_type2_name": "サンプル区分2",
    "project_type3_id": 3,
    "project_type3_name": "サンプル区分3",
    "group_id": 1,
    "group_name": "グループA",
    "tags": [],
    "in_house_memo": null,
    "ordered_date": "2017-01-10",
    "payment_method_kbn": 1,
    "payment_method_kbn_name": "銀行振込",
    "tax_rule_kbn": 2,
    "tax_rule_kbn_name": "切り捨て",
    "to": "example@the-board.jp",
    "cc": "example@the-board.jp",
    "lock_flg": 0,
    "wareki_flg": 0,
    "archive_flg": 0,
    "currency": "JPY",
    "lang_kbn": 1,
    "lang_kbn_name": "日本語",
    "exchange_rate": 1,
    "total_jpy": 100000,
    "tax_jpy": 8000,
    "invoice_total_jpy": 100000,
    "invoice_tax_jpy": 8000,
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }
  {・・・},
  {・・・},
]

GET /v1/projects

URLパラメータ

指定のパラメータでフィルタリングします。

パラメータ 必須 説明
order_status_in[] integer 受注ステータス
1: 見積中(高)
2: 見積中(中)
3: 見積中(低)
8: 見積中(除)
4: 受注確定
5: 受注済
9: 失注
※複数の場合はカンマ区切り
project_no_eq integer 案件No
created_at_gteq datetime 作成日時(指定日時以降)
YYYY-MM-DD HH:MM:SS
created_at_lteq datetime 作成日時(指定日時以前)
YYYY-MM-DD HH:MM:SS
include_lost_flg integer 失注ステータス
0:失注は除く(デフォルト)
1:失注も含む
include_archive_flg integer アーカイブ
0:アーカイブは除く(デフォルト)
1:アーカイブも含む

*ページネーション用のパラメータについてはページネーション参照

レスポンスグループ

常に全ての項目を返却するとデータ量が多いため、以下のレスポンスグループをURLパラメータとして指定することができます。

レスポンスグループ 説明 項目
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
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
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 + 全ての書類

受注ステータス変更

受注ステータスを変更します。

リクエスト

PATCH /v1/projects/order_status/1
Content-Type: application/json

{
  "order_status": 4
}

レスポンス

Status: 204 No Content

PATCH /v1/projects/order_status/:id

URLパラメータ

パラメータ 必須 説明
id integer 案件ID
案件情報に含まれているid

パラメータ

パラメータ 必須 説明
order_status integer 受注ステータス
指定されたステータスに変更します
1: 見積中(高)
2: 見積中(中)
3: 見積中(低)
8: 見積中(除)
4: 受注確定
5: 受注済
9: 失注

案件原価

案件原価の登録

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

リクエスト

POST /v1/project_costs
Content-Type: application/json

{
  "project_id": 1,
  "description": "サンプル原価",
  "cost": 10000,
  "invoice_date": "2018-03-31",
  "payment_date": "2018-03-31"
}

レスポンス

Status: 201 Created
Location: https://api.the-board.jp/v1/project_costs/1

  {
    "id": 1,
    "project_id": 1,
    "description": "サンプル原価",
    "cost": 10000,
    "invoice_date": "2018-03-31",
    "payment_date": "2018-03-31",
    "created_at": "2018-04-15T12:50:05.000+09:00",
    "updated_at": "2018-04-15T12:50:05.000+09:00"
  }

POST /v1/project_costs

パラメータ

パラメータ 必須 説明
description string 費用の説明
cost integer 金額
invoice_date date 請求日
YYYY-MM-DD
payment_date date 支払日
YYYY-MM-DD
project_id integer 案件ID

案件原価の更新

既存の案件原価を更新します。

リクエスト

PATCH /v1/project_costs/1
Content-Type: application/json

{
  "cost": 20000
}

レスポンス

Status: 200 OK

  {
    "id": 1,
    "project_id": 1,
    "description": "サンプル原価",
    "cost": 10000,
    "invoice_date": "2018-03-31",
    "payment_date": "2018-03-31",
    "created_at": "2018-04-15T12:50:05.000+09:00",
    "updated_at": "2018-04-15T12:50:05.000+09:00"
  }

PATCH /v1/project_costs/:id

URLパラメータ

パラメータ 必須 説明
id integer 案件原価ID
案件原価情報のレスポンスにあるidを指定

パラメータ

更新しない項目は指定する必要はありません。

パラメータ 必須 説明
description string 費用の説明
cost integer 金額
invoice_date date 請求日
YYYY-MM-DD
payment_date date 支払日
YYYY-MM-DD

案件原価の削除

既存の案件原価を削除します。

リクエスト

DELETE /v1/project_costs/1

レスポンス

Status: 204 No Content

DELETE /v1/project_costs/:id

URLパラメータ

パラメータ 必須 説明
id integer 案件原価ID
案件原価情報のレスポンスにあるidを指定

案件原価の取得

既存の案件原価情報を取得します。

リクエスト

GET /v1/project_costs/1

レスポンス

Status: 200 OK

  {
    "id": 1,
    "project_id": 1,
    "description": "サンプル原価",
    "cost": 10000,
    "invoice_date": "2018-03-31",
    "payment_date": "2018-03-31",
    "created_at": "2018-04-15T12:50:05.000+09:00",
    "updated_at": "2018-04-15T12:50:05.000+09:00"
  }

GET /v1/project_costs/:id

URLパラメータ

パラメータ 必須 説明
id integer 案件原価ID
案件原価情報のレスポンスにあるidを指定

案件原価リストの取得

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

リクエスト

GET /v1/project_costs?project_id=1"

レスポンス

Status: 200 OK
Link: <https://api.the-board.jp/v1/project_costs?page=1>; rel="first",
      <https://api.the-board.jp/v1/project_costs?page=3>; rel="prev",
      <https://api.the-board.jp/v1/project_costs?page=5>; rel="next",
      <https://api.the-board.jp/v1/project_costs?page=10>; rel="last"
X-Total-Count: 95
[
  {
    "id": 1,
    "project_id": 1,
    "description": "サンプル原価",
    "cost": 10000,
    "invoice_date": "2018-03-31",
    "payment_date": "2018-03-31",
    "created_at": "2018-04-15T12:50:05.000+09:00",
    "updated_at": "2018-04-15T12:50:05.000+09:00"
  }
  {・・・},
  {・・・},
]

GET /v1/project_costs

URLパラメータ

指定のパラメータでフィルタリングします。

パラメータ 必須 説明
project_id_eq integer 案件ID
created_at_gteq datetime 作成日時(指定日時以降)
YYYY-MM-DD HH:MM:SS
created_at_lteq datetime 作成日時(指定日時以前)
YYYY-MM-DD HH:MM:SS
invoice_date_gteq date 請求日(指定日以降)
YYYY-MM-DD
invoice_date_lteq date 請求日(指定日以前)
YYYY-MM-DD
payment_date_gteq date 支払日(指定日以降)
YYYY-MM-DD
payment_date_lteq date 支払日(指定日以前)
YYYY-MM-DD

*ページネーション用のパラメータについてはページネーション参照

請求

請求リストの取得

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

リクエスト

GET /v1/invoices?project_order_status_in[]=4,5"

レスポンス

Status: 200 OK
Link: <https://api.the-board.jp/v1/invoices?page=1>; rel="first",
      <https://api.the-board.jp/v1/invoices?page=3>; rel="prev",
      <https://api.the-board.jp/v1/invoices?page=5>; rel="next",
      <https://api.the-board.jp/v1/invoices?page=10>; rel="last"
X-Total-Count: 95
[
  {
    "id": 1,
    "project_no": 1001,
    "management_no": "123456",
    "name": "サンプル案件",
    "client": {
        "id": 1,
        "name": "サンプル株式会社",
        "name_disp": "サンプル"
    },
    "client_branch": {
        "id": 1,
        "name":"サンプル支社"
    },
    "contact": {
        "id": 1,
        "last_name": "山田",
        "first_name": "太郎"
    },
    "company_branch": {
        "id": 1,
        "name": "テスト支社"
    },
    "user": {
        "id": 1,
        "last_name": "サンプル",
        "first_name": "太郎"
    },
    "total": 100000,
    "tax": 8000,
    "invoice_date": "2017-01-31",
    "payment_limit_date": "2017-02-28",
    "order_status": 1,
    "order_status_name": "見積中(高)",
    "invoice_status": 2,
    "invoice_status_name": "請求済",
    "project_type_id": 1,
    "project_type_name": "サンプル区分A",
    "project_type2_id": 2,
    "project_type2_name": "サンプル区分2",
    "project_type3_id": 3,
    "project_type3_name": "サンプル区分3",
    "paid_date": null,
    "tags": [],
    "lock_flg": 0,
    "currency": "JPY",
    "lang_kbn": 1,
    "lang_kbn_name": "日本語",
    "exchange_rate": 120,
    "total_jpy": 100000,
    "tax_jpy": 8000,
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }
  {・・・},
  {・・・},
]

GET /v1/invoices

URLパラメータ

指定のパラメータでフィルタリングします。

パラメータ 必須 説明
invoice_date_gteq date 請求日(指定日以降)
YYYY-MM-DD
invoice_date_lteq date 請求日(指定日以前)
YYYY-MM-DD
project_order_status_in[] integer 受注ステータス
1: 見積中(高)
2: 見積中(中)
3: 見積中(低)
8: 見積中(除)
4: 受注確定
5: 受注済
9: 失注
※複数の場合はカンマ区切り
invoice_status_in[] integer 請求ステータス
1: 未請求
4: 請求OK
2: 請求済
3: 入金済
9: 回収不能
※複数の場合はカンマ区切り
project_project_no_eq integer 案件No

*ページネーション用のパラメータについてはページネーション参照

レスポンスグループ

常に全ての項目を返却するとデータ量が多いため、以下のレスポンスグループをURLパラメータとして指定することができます。

レスポンスグループ 説明 項目
small 基本項目のみ(デフォルト) id
project_no
management_no
name
client
contact
user
total
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
paid_date
currency
created_at
updated_at
medium 主要項目 smallに加え以下の項目
client_branch
company_branch
tags
exchange_rate
total_jpy
tax_jpy
large 書類以外全ての項目
invoice small + 請求書

請求ステータス変更

請求ステータスを変更します。

リクエスト

PATCH /v1/invoices/invoice_status/1
Content-Type: application/json

{
  "invoice_status": 2
}

レスポンス

Status: 204 No Content

PATCH /v1/invoices/invoice_status/:id

URLパラメータ

パラメータ 必須 説明
id integer 請求ID
請求情報に含まれているid

パラメータ

パラメータ 必須 説明
invoice_status integer 請求ステータス
指定されたステータスに変更します
1: 未請求
4: 請求OK
2: 請求済
3: 入金済
9: 回収不能

書類(案件)

見積書の更新

既存の見積書を更新します。

リクエスト

PATCH /v1/documents/estimates/1
Content-Type: application/json

{
  "total": 300000,
  "tax": 24000,
  "message": "サンプル備考です。",
  "details": [
    {
      "description": "サンプル明細1",
      "quantity": 1,
      "unit": "式",
      "unit_price": 100000
    },
    {
      "description": "サンプル明細2",
      "quantity": 1,
      "unit": "式",
      "unit_price": 200000
    }
  ]
}

レスポンス

Status: 200 OK

  {
    "id": 1,
    "message": "サンプル備考。",
    "valid_period": "御見積後2週間",
    "total": 100000,
    "tax": 8000,
    "tax_withholding": 0,
    "seal_approval_status": 1,
    "document_amount_disp_kbn": 1,
    "blank_date_flg": 0,
    "lock_flg": 0,
    "details": [
        {
            "no": 1,
            "description": "サンプル明細1",
            "quantity": 1,
            "unit": "式",
            "unit_price": 100000,
            "price": 100000,
            "tax_rate": 8.0,
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": null,
            "section_subtotal": null,
            "document_detail_kbn": 1,
            "document_detail_kbn_name": "通常"
        },
        {
            "no": 2,
            "description": null,
            "quantity": null,
            "unit": null,
            "unit_price": null,
            "price": null,
            "tax_rate": "8.0",
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": "見出しサンプル",
            "section_subtotal": 0,
            "document_detail_kbn": 2,
            "document_detail_kbn_name": "見出し行"
        }
    ],
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

PATCH /v1/documents/estimates/:id

URLパラメータ

パラメータ 必須 説明
id integer 見積書ID
見積書情報のレスポンスにあるidを指定
※リスト取得APIで、
レスポンスグループに対象の書類を指定すると、
書類のIDが取得できます。

パラメータ

更新しない項目は指定する必要はありません。

パラメータ 必須 説明
total decimal 小計
※自動計算はされないため未指定の場合は0
tax decimal 消費税
※自動計算はされないため未指定の場合は0
tax_withholding decimal 源泉徴収税
※自動計算はされないため未指定の場合は0
message string 備考
document_amount_disp_kbn integer 金額表示(表示設定)
1: 税込表示(デフォルト)
2: 合計欄を税抜表示+明細下の小計・消費税行非表示
3: 合計欄のみ税抜表示
4: 合計表示なし
details array 明細行(各行の項目は、下記「明細行のパラメータ」参照
※detailsは送信された内容に置き換えられますので、更新がない場合でも送信してください。
valid_period string 有効期限
blank_date_flg integer 見積日空欄
0: 表示(デフォルト)
1: 空欄

明細行のパラメータ

パラメータ 必須 説明
description string 摘要
quantity decimal 数量(小数点2桁まで)
unit string 単位
unit_price decimal 単価(小数点5桁まで)
tax_rate integer 消費税
0: 非課税
5: 5%
8: 8%
10: 10%
※未指定の場合は、現在の税率が自動的に設定されます
tax_withholding_flg integer 源泉徴収対象
0: 対象外(デフォルト)
1: 対象
tax_included_flg integer 内税対象
0: 外税(デフォルト)
1: 内税
section_description string 見出し行・小計行のテキスト
section_subtotal decimal 見出し小計の金額
document_detail_kbn integer 書類明細区分
1: 通常行(デフォルト)
2: 見出し行
3: 小計行

見積書の取得

既存の見積書情報を取得します。

リクエスト

GET /v1/documents/estimates/1

レスポンス

Status: 200 OK

  {
    "id": 1,
    "message": "サンプル備考。",
    "valid_period": "御見積後2週間",
    "total": 100000,
    "tax": 8000,
    "tax_withholding": 0,
    "seal_approval_status": 1,
    "document_amount_disp_kbn": 1,
    "blank_date_flg": 0,
    "lock_flg": 0,
    "details": [
        {
            "no": 1,
            "description": "サンプル明細1",
            "quantity": 1,
            "unit": "式",
            "unit_price": 100000,
            "price": 100000,
            "tax_rate": 8.0,
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": null,
            "section_subtotal": null,
            "document_detail_kbn": 1,
            "document_detail_kbn_name": "通常"
        },
        {
            "no": 2,
            "description": null,
            "quantity": null,
            "unit": null,
            "unit_price": null,
            "price": null,
            "tax_rate": "8.0",
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": "見出しサンプル",
            "section_subtotal": 0,
            "document_detail_kbn": 2,
            "document_detail_kbn_name": "見出し行"
        }
    ],
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

GET /v1/documents/estimates/:id

URLパラメータ

パラメータ 必須 説明
id integer 見積書ID
見積書情報のレスポンスにあるidを指定
※リスト取得APIで、
レスポンスグループに対象の書類を指定すると、
書類のIDが取得できます。

発注書の更新

既存の発注書を更新します。

リクエスト

PATCH /v1/documents/orders/1
Content-Type: application/json

{
  "total": 300000,
  "tax": 24000,
  "message": "サンプル備考です。",
  "details": [
    {
      "description": "サンプル明細1",
      "quantity": 1,
      "unit": "式",
      "unit_price": 100000
    },
    {
      "description": "サンプル明細2",
      "quantity": 1,
      "unit": "式",
      "unit_price": 200000
    }
  ]
}

レスポンス

Status: 200 OK

  {
    "id": 1,
    "message": "サンプル備考。",
    "valid_period": "御見積後2週間",
    "total": 100000,
    "tax": 8000,
    "tax_withholding": 0,
    "seal_approval_status": 1,
    "document_amount_disp_kbn": 1,
    "blank_date_flg": 0,
    "lock_flg": 0,
    "details": [
        {
            "no": 1,
            "description": "サンプル明細1",
            "quantity": 1,
            "unit": "式",
            "unit_price": 100000,
            "price": 100000,
            "tax_rate": 8.0,
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": null,
            "section_subtotal": null,
            "document_detail_kbn": 1,
            "document_detail_kbn_name": "通常"
        },
        {
            "no": 2,
            "description": null,
            "quantity": null,
            "unit": null,
            "unit_price": null,
            "price": null,
            "tax_rate": "8.0",
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": "見出しサンプル",
            "section_subtotal": 0,
            "document_detail_kbn": 2,
            "document_detail_kbn_name": "見出し行"
        }
    ],
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

PATCH /v1/documents/orders/:id

URLパラメータ

パラメータ 必須 説明
id integer 発注書ID
発注書情報のレスポンスにあるidを指定
※リスト取得APIで、
レスポンスグループに対象の書類を指定すると、
書類のIDが取得できます。

パラメータ

更新しない項目は指定する必要はありません。

パラメータ 必須 説明
total decimal 小計
※自動計算はされないため未指定の場合は0
tax decimal 消費税
※自動計算はされないため未指定の場合は0
tax_withholding decimal 源泉徴収税
※自動計算はされないため未指定の場合は0
message string 備考
document_amount_disp_kbn integer 金額表示(表示設定)
1: 税込表示(デフォルト)
2: 合計欄を税抜表示+明細下の小計・消費税行非表示
3: 合計欄のみ税抜表示
4: 合計表示なし
details array 明細行(各行の項目は、下記「明細行のパラメータ」参照
※detailsは送信された内容に置き換えられますので、更新がない場合でも送信してください。
disp_order_date date 発注日(表示設定)
disp_order_receive_date date 発注請日(表示設定)
blank_date_flg integer 発注請日空欄
0: 表示(デフォルト)
1: 空欄

明細行のパラメータ

パラメータ 必須 説明
description string 摘要
quantity decimal 数量(小数点2桁まで)
unit string 単位
unit_price decimal 単価(小数点5桁まで)
tax_rate integer 消費税
0: 非課税
5: 5%
8: 8%
10: 10%
※未指定の場合は、現在の税率が自動的に設定されます
tax_withholding_flg integer 源泉徴収対象
0: 対象外(デフォルト)
1: 対象
tax_included_flg integer 内税対象
0: 外税(デフォルト)
1: 内税
section_description string 見出し行・小計行のテキスト
section_subtotal decimal 見出し小計の金額
document_detail_kbn integer 書類明細区分
1: 通常行(デフォルト)
2: 見出し行
3: 小計行

発注書の取得

既存の発注書情報を取得します。

リクエスト

GET /v1/documents/orders/1

レスポンス

Status: 200 OK

  {
    "id": 1,
    "message": "サンプル備考。",
    "valid_period": "御見積後2週間",
    "total": 100000,
    "tax": 8000,
    "tax_withholding": 0,
    "seal_approval_status": 1,
    "document_amount_disp_kbn": 1,
    "blank_date_flg": 0,
    "lock_flg": 0,
    "details": [
        {
            "no": 1,
            "description": "サンプル明細1",
            "quantity": 1,
            "unit": "式",
            "unit_price": 100000,
            "price": 100000,
            "tax_rate": 8.0,
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": null,
            "section_subtotal": null,
            "document_detail_kbn": 1,
            "document_detail_kbn_name": "通常"
        },
        {
            "no": 2,
            "description": null,
            "quantity": null,
            "unit": null,
            "unit_price": null,
            "price": null,
            "tax_rate": "8.0",
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": "見出しサンプル",
            "section_subtotal": 0,
            "document_detail_kbn": 2,
            "document_detail_kbn_name": "見出し行"
        }
    ],
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

GET /v1/documents/orders/:id

URLパラメータ

パラメータ 必須 説明
id integer 発注書ID
発注書情報のレスポンスにあるidを指定
※リスト取得APIで、
レスポンスグループに対象の書類を指定すると、
書類のIDが取得できます。

納品書の更新

既存の納品書を更新します。

リクエスト

PATCH /v1/documents/deliveries/1
Content-Type: application/json

{
  "total": 300000,
  "tax": 24000,
  "message": "サンプル備考です。",
  "details": [
    {
      "description": "サンプル明細1",
      "quantity": 1,
      "unit": "式",
      "unit_price": 100000
    },
    {
      "description": "サンプル明細2",
      "quantity": 1,
      "unit": "式",
      "unit_price": 200000
    }
  ]
}

レスポンス

Status: 200 OK

  {
    "id": 1,
    "message": "サンプル備考。",
    "valid_period": "御見積後2週間",
    "total": 100000,
    "tax": 8000,
    "tax_withholding": 0,
    "seal_approval_status": 1,
    "document_amount_disp_kbn": 1,
    "blank_date_flg": 0,
    "lock_flg": 0,
    "details": [
        {
            "no": 1,
            "description": "サンプル明細1",
            "quantity": 1,
            "unit": "式",
            "unit_price": 100000,
            "price": 100000,
            "tax_rate": 8.0,
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": null,
            "section_subtotal": null,
            "document_detail_kbn": 1,
            "document_detail_kbn_name": "通常"
        },
        {
            "no": 2,
            "description": null,
            "quantity": null,
            "unit": null,
            "unit_price": null,
            "price": null,
            "tax_rate": "8.0",
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": "見出しサンプル",
            "section_subtotal": 0,
            "document_detail_kbn": 2,
            "document_detail_kbn_name": "見出し行"
        }
    ],
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

PATCH /v1/documents/deliveries/:id

URLパラメータ

パラメータ 必須 説明
id integer 納品書ID
納品書情報のレスポンスにあるidを指定
※リスト取得APIで、
レスポンスグループに対象の書類を指定すると、
書類のIDが取得できます。

パラメータ

更新しない項目は指定する必要はありません。

パラメータ 必須 説明
total decimal 小計
※自動計算はされないため未指定の場合は0
tax decimal 消費税
※自動計算はされないため未指定の場合は0
tax_withholding decimal 源泉徴収税
※自動計算はされないため未指定の場合は0
message string 備考
document_amount_disp_kbn integer 金額表示(表示設定)
1: 税込表示(デフォルト)
2: 合計欄を税抜表示+明細下の小計・消費税行非表示
3: 合計欄のみ税抜表示
4: 合計表示なし
details array 明細行(各行の項目は、下記「明細行のパラメータ」参照
※detailsは送信された内容に置き換えられますので、更新がない場合でも送信してください。
disp_delivery_date date 納品日(表示設定)
disp_delivery_receive_date date 検収日(表示設定)
blank_date_flg integer 納品日空欄
0: 表示(デフォルト)
1: 空欄

明細行のパラメータ

パラメータ 必須 説明
description string 摘要
quantity decimal 数量(小数点2桁まで)
unit string 単位
unit_price decimal 単価(小数点5桁まで)
tax_rate integer 消費税
0: 非課税
5: 5%
8: 8%
10: 10%
※未指定の場合は、現在の税率が自動的に設定されます
tax_withholding_flg integer 源泉徴収対象
0: 対象外(デフォルト)
1: 対象
tax_included_flg integer 内税対象
0: 外税(デフォルト)
1: 内税
section_description string 見出し行・小計行のテキスト
section_subtotal decimal 見出し小計の金額
document_detail_kbn integer 書類明細区分
1: 通常行(デフォルト)
2: 見出し行
3: 小計行

納品書の取得

既存の納品書情報を取得します。

リクエスト

GET /v1/documents/deliveries/1

レスポンス

Status: 200 OK

  {
    "id": 1,
    "message": "サンプル備考。",
    "valid_period": "御見積後2週間",
    "total": 100000,
    "tax": 8000,
    "tax_withholding": 0,
    "seal_approval_status": 1,
    "document_amount_disp_kbn": 1,
    "blank_date_flg": 0,
    "lock_flg": 0,
    "details": [
        {
            "no": 1,
            "description": "サンプル明細1",
            "quantity": 1,
            "unit": "式",
            "unit_price": 100000,
            "price": 100000,
            "tax_rate": 8.0,
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": null,
            "section_subtotal": null,
            "document_detail_kbn": 1,
            "document_detail_kbn_name": "通常"
        },
        {
            "no": 2,
            "description": null,
            "quantity": null,
            "unit": null,
            "unit_price": null,
            "price": null,
            "tax_rate": "8.0",
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": "見出しサンプル",
            "section_subtotal": 0,
            "document_detail_kbn": 2,
            "document_detail_kbn_name": "見出し行"
        }
    ],
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

GET /v1/documents/deliveries/:id

URLパラメータ

パラメータ 必須 説明
id integer 納品書ID
納品書情報のレスポンスにあるidを指定
※リスト取得APIで、
レスポンスグループに対象の書類を指定すると、
書類のIDが取得できます。

請求書の更新

既存の請求書を更新します。

リクエスト

PATCH /v1/documents/invoices/1
Content-Type: application/json

{
  "total": 300000,
  "tax": 24000,
  "message": "サンプル備考です。",
  "details": [
    {
      "description": "サンプル明細1",
      "quantity": 1,
      "unit": "式",
      "unit_price": 100000
    },
    {
      "description": "サンプル明細2",
      "quantity": 1,
      "unit": "式",
      "unit_price": 200000
    }
  ]
}

レスポンス

Status: 200 OK

  {
    "id": 1,
    "message": "サンプル備考。",
    "valid_period": "御見積後2週間",
    "total": 100000,
    "tax": 8000,
    "tax_withholding": 0,
    "seal_approval_status": 1,
    "document_amount_disp_kbn": 1,
    "blank_date_flg": 0,
    "lock_flg": 0,
    "details": [
        {
            "no": 1,
            "description": "サンプル明細1",
            "quantity": 1,
            "unit": "式",
            "unit_price": 100000,
            "price": 100000,
            "tax_rate": 8.0,
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": null,
            "section_subtotal": null,
            "document_detail_kbn": 1,
            "document_detail_kbn_name": "通常"
        },
        {
            "no": 2,
            "description": null,
            "quantity": null,
            "unit": null,
            "unit_price": null,
            "price": null,
            "tax_rate": "8.0",
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": "見出しサンプル",
            "section_subtotal": 0,
            "document_detail_kbn": 2,
            "document_detail_kbn_name": "見出し行"
        }
    ],
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

PATCH /v1/documents/invoices/:id

URLパラメータ

パラメータ 必須 説明
id integer 請求書ID
請求書情報のレスポンスにあるidを指定
※リスト取得APIで、
レスポンスグループに対象の書類を指定すると、
書類のIDが取得できます。

パラメータ

更新しない項目は指定する必要はありません。

パラメータ 必須 説明
total decimal 小計
※自動計算はされないため未指定の場合は0
tax decimal 消費税
※自動計算はされないため未指定の場合は0
tax_withholding decimal 源泉徴収税
※自動計算はされないため未指定の場合は0
message string 備考
document_amount_disp_kbn integer 金額表示(表示設定)
1: 税込表示(デフォルト)
2: 合計欄を税抜表示+明細下の小計・消費税行非表示
3: 合計欄のみ税抜表示
4: 合計表示なし
details array 明細行(各行の項目は、下記「明細行のパラメータ」参照
※detailsは送信された内容に置き換えられますので、更新がない場合でも送信してください。
disp_invoice_date date 請求日(表示設定)
blank_date_flg integer 請求日空欄
0: 表示(デフォルト)
1: 空欄
multi_bank_info_flg integer 複数口座表示
0: OFF
1: ON
※デフォルトは設定による

明細行のパラメータ

パラメータ 必須 説明
description string 摘要
quantity decimal 数量(小数点2桁まで)
unit string 単位
unit_price decimal 単価(小数点5桁まで)
tax_rate integer 消費税
0: 非課税
5: 5%
8: 8%
10: 10%
※未指定の場合は、現在の税率が自動的に設定されます
tax_withholding_flg integer 源泉徴収対象
0: 対象外(デフォルト)
1: 対象
tax_included_flg integer 内税対象
0: 外税(デフォルト)
1: 内税
section_description string 見出し行・小計行のテキスト
section_subtotal decimal 見出し小計の金額
document_detail_kbn integer 書類明細区分
1: 通常行(デフォルト)
2: 見出し行
3: 小計行

請求書の取得

既存の請求書情報を取得します。

リクエスト

GET /v1/documents/invoices/1

レスポンス

Status: 200 OK

  {
    "id": 1,
    "message": "サンプル備考。",
    "valid_period": "御見積後2週間",
    "total": 100000,
    "tax": 8000,
    "tax_withholding": 0,
    "seal_approval_status": 1,
    "document_amount_disp_kbn": 1,
    "blank_date_flg": 0,
    "lock_flg": 0,
    "details": [
        {
            "no": 1,
            "description": "サンプル明細1",
            "quantity": 1,
            "unit": "式",
            "unit_price": 100000,
            "price": 100000,
            "tax_rate": 8.0,
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": null,
            "section_subtotal": null,
            "document_detail_kbn": 1,
            "document_detail_kbn_name": "通常"
        },
        {
            "no": 2,
            "description": null,
            "quantity": null,
            "unit": null,
            "unit_price": null,
            "price": null,
            "tax_rate": "8.0",
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": "見出しサンプル",
            "section_subtotal": 0,
            "document_detail_kbn": 2,
            "document_detail_kbn_name": "見出し行"
        }
    ],
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

GET /v1/documents/invoices/:id

URLパラメータ

パラメータ 必須 説明
id integer 請求書ID
請求書情報のレスポンスにあるidを指定
※リスト取得APIで、
レスポンスグループに対象の書類を指定すると、
書類のIDが取得できます。

領収書の更新

既存の領収書を更新します。

リクエスト

PATCH /v1/documents/receipts/1
Content-Type: application/json

{
  "total": 300000,
  "tax": 24000,
  "message": "サンプル備考です。",
  "details": [
    {
      "description": "サンプル明細1",
      "quantity": 1,
      "unit": "式",
      "unit_price": 100000
    },
    {
      "description": "サンプル明細2",
      "quantity": 1,
      "unit": "式",
      "unit_price": 200000
    }
  ]
}

レスポンス

Status: 200 OK

  {
    "id": 1,
    "message": "サンプル備考。",
    "valid_period": "御見積後2週間",
    "total": 100000,
    "tax": 8000,
    "tax_withholding": 0,
    "seal_approval_status": 1,
    "document_amount_disp_kbn": 1,
    "blank_date_flg": 0,
    "lock_flg": 0,
    "details": [
        {
            "no": 1,
            "description": "サンプル明細1",
            "quantity": 1,
            "unit": "式",
            "unit_price": 100000,
            "price": 100000,
            "tax_rate": 8.0,
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": null,
            "section_subtotal": null,
            "document_detail_kbn": 1,
            "document_detail_kbn_name": "通常"
        },
        {
            "no": 2,
            "description": null,
            "quantity": null,
            "unit": null,
            "unit_price": null,
            "price": null,
            "tax_rate": "8.0",
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": "見出しサンプル",
            "section_subtotal": 0,
            "document_detail_kbn": 2,
            "document_detail_kbn_name": "見出し行"
        }
    ],
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

PATCH /v1/documents/receipts/:id

URLパラメータ

パラメータ 必須 説明
id integer 領収書ID
領収書情報のレスポンスにあるidを指定
※リスト取得APIで、
レスポンスグループに対象の書類を指定すると、
書類のIDが取得できます。

パラメータ

更新しない項目は指定する必要はありません。

パラメータ 必須 説明
total decimal 小計
※自動計算はされないため未指定の場合は0
tax decimal 消費税
※自動計算はされないため未指定の場合は0
tax_withholding decimal 源泉徴収税
※自動計算はされないため未指定の場合は0
message string 備考
document_amount_disp_kbn integer 金額表示(表示設定)
1: 税込表示(デフォルト)
2: 合計欄を税抜表示+明細下の小計・消費税行非表示
3: 合計欄のみ税抜表示
4: 合計表示なし
details array 明細行(各行の項目は、下記「明細行のパラメータ」参照
※detailsは送信された内容に置き換えられますので、更新がない場合でも送信してください。
disp_receipt_date date 発行日(表示設定)
blank_date_flg integer 発行日空欄
0: 表示(デフォルト)
1: 空欄

明細行のパラメータ

パラメータ 必須 説明
description string 摘要
quantity decimal 数量(小数点2桁まで)
unit string 単位
unit_price decimal 単価(小数点5桁まで)
tax_rate integer 消費税
0: 非課税
5: 5%
8: 8%
10: 10%
※未指定の場合は、現在の税率が自動的に設定されます
tax_withholding_flg integer 源泉徴収対象
0: 対象外(デフォルト)
1: 対象
tax_included_flg integer 内税対象
0: 外税(デフォルト)
1: 内税
section_description string 見出し行・小計行のテキスト
section_subtotal decimal 見出し小計の金額
document_detail_kbn integer 書類明細区分
1: 通常行(デフォルト)
2: 見出し行
3: 小計行

領収書の取得

既存の領収書情報を取得します。

リクエスト

GET /v1/documents/receipts/1

レスポンス

Status: 200 OK

  {
    "id": 1,
    "message": "サンプル備考。",
    "valid_period": "御見積後2週間",
    "total": 100000,
    "tax": 8000,
    "tax_withholding": 0,
    "seal_approval_status": 1,
    "document_amount_disp_kbn": 1,
    "blank_date_flg": 0,
    "lock_flg": 0,
    "details": [
        {
            "no": 1,
            "description": "サンプル明細1",
            "quantity": 1,
            "unit": "式",
            "unit_price": 100000,
            "price": 100000,
            "tax_rate": 8.0,
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": null,
            "section_subtotal": null,
            "document_detail_kbn": 1,
            "document_detail_kbn_name": "通常"
        },
        {
            "no": 2,
            "description": null,
            "quantity": null,
            "unit": null,
            "unit_price": null,
            "price": null,
            "tax_rate": "8.0",
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": "見出しサンプル",
            "section_subtotal": 0,
            "document_detail_kbn": 2,
            "document_detail_kbn_name": "見出し行"
        }
    ],
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

GET /v1/documents/receipts/:id

URLパラメータ

パラメータ 必須 説明
id integer 領収書ID
領収書情報のレスポンスにあるidを指定
※リスト取得APIで、
レスポンスグループに対象の書類を指定すると、
書類のIDが取得できます。

発注先

発注先の登録

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

リクエスト

POST /v1/payees
Content-Type: application/json

{
  "name": "サンプル株式会社",
  "name_disp": "サンプル"
}

レスポンス

Status: 201 Created
Location: https://api.the-board.jp/v1/payees/1

  {
    "id": 1,
    "name": "サンプル株式会社",
    "name_disp": "サンプル",
    "title": "御中",
    "zip": "100-0001",
    "pref": "東京都",
    "address1": "千代田区千代田111",
    "address2": "テストビル3階",
    "tel": "03-0000-0001",
    "fax": "03-0000-0002",
    "payment_term_id": 1,
    "payment_term_name": "月末締翌月末払",
    "bank_charge_to_client_flg": 1,
    "nda_flg": 1,
    "basic_agreement_flg": 0,
    "document_send_type": 2,
    "document_send_type_name": "郵送",
    "note": null,
    "tags": [
      "サンプルタグA",
      "サンプルタグB"
    ],
    "wareki_flg": 0,
    "company_number": "1234567890123",
    "accounting_code": "123",
    "to": "example@the-board.jp",
    "cc": "example@the-board.jp",
    "name_en": "Sample, inc",
    "address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
    "phone_country_code": "81",
    "currency": "USD",
    "lang_kbn": 2,
    "lang_kbn_name": "日本語",
    "archive_flg": 0,
    "custom_no": "A00001",
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

POST /v1/payees

パラメータ

パラメータ 必須 説明
name string 発注先名
name_disp string 発注先略称名
title string 敬称
デフォルト:御中
zip string 郵便番号(ハイフン区切り)
例:100-0001
pref string 都道府県名
例:東京都
address1 string 住所1
address2 string 住所2
tel string 電話番号(ハイフン区切り)
例:03-0000-0000
fax string FAX(ハイフン区切り)
例:03-0000-0000
payment_term_id integer デフォルト支払条件ID
未指定の場合は最初の支払条件がセットされる
bank_charge_to_client_flg integer 振込手数料負担
0:当方(デフォルト) 1:先方
nda_flg integer NDA締結
0:未(デフォルト) 1:済
basic_agreement_flg integer 基本契約書締結
0:未(デフォルト) 1:済
document_send_type integer 書類送付方法
1:メール(デフォルト) 2:郵送 3:両方
note string 備考
tags array タグ
wareki_flg integer デフォルト和暦表示
0:OFF(デフォルト) 1:ON
※和暦表示有効時のみ
company_number string 法人番号(13桁)
accounting_code string 会計用名称・コード
to string TO
複数指定する場合はカンマ区切り
cc string CC
複数指定する場合はカンマ区切り
name_en string 発注先名(英語表記)
※英語アドオン有効時のみ
address_en string 住所(英語表記)
※英語アドオン有効時のみ
phone_country_code string 国番号(英語表記)
※英語アドオン有効時のみ
currency string デフォルト通貨
JPY(デフォルト)/ USD / EUR / GBP / CNY / HKD / TWD / KRW / SGD
※英語アドオン有効時のみ
lang_kbn integer デフォルト言語
1:日本語(デフォルト) 2:英語
※英語アドオン有効時のみ
archive_flg integer アーカイブ状態
0:OFF(デフォルト) 1:ON
custom_no string 発注先番号
tax_withholding_kbn integer デフォルト源泉徴収
1:なし(デフォルト)
2:源泉徴収(復興特別所得税あり)
3:源泉徴収(復興特別所得税なし)

発注先の更新

既存の発注先を更新します。

リクエスト

PATCH /v1/payees/1
Content-Type: application/json

{
  "basic_agreement_flg": 1
}

レスポンス

Status: 200 OK

  {
    "id": 1,
    "name": "サンプル株式会社",
    "name_disp": "サンプル",
    "title": "御中",
    "zip": "100-0001",
    "pref": "東京都",
    "address1": "千代田区千代田111",
    "address2": "テストビル3階",
    "tel": "03-0000-0001",
    "fax": "03-0000-0002",
    "payment_term_id": 1,
    "payment_term_name": "月末締翌月末払",
    "bank_charge_to_client_flg": 1,
    "nda_flg": 1,
    "basic_agreement_flg": 0,
    "document_send_type": 2,
    "document_send_type_name": "郵送",
    "note": null,
    "tags": [
      "サンプルタグA",
      "サンプルタグB"
    ],
    "wareki_flg": 0,
    "company_number": "1234567890123",
    "accounting_code": "123",
    "to": "example@the-board.jp",
    "cc": "example@the-board.jp",
    "name_en": "Sample, inc",
    "address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
    "phone_country_code": "81",
    "currency": "USD",
    "lang_kbn": 2,
    "lang_kbn_name": "日本語",
    "archive_flg": 0,
    "custom_no": "A00001",
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

PATCH /v1/payees/:id

URLパラメータ

パラメータ 必須 説明
id integer 発注先ID
発注先情報のレスポンスにあるidを指定

パラメータ

更新しない項目は指定する必要はありません。

パラメータ 必須 説明
name string 発注先名
name_disp string 発注先略称名
title string 敬称
デフォルト:御中
zip string 郵便番号(ハイフン区切り)
例:100-0001
pref string 都道府県名
例:東京都
address1 string 住所1
address2 string 住所2
tel string 電話番号(ハイフン区切り)
例:03-0000-0000
fax string FAX(ハイフン区切り)
例:03-0000-0000
payment_term_id integer デフォルト支払条件ID
未指定の場合は最初の支払条件がセットされる
bank_charge_to_client_flg integer 振込手数料負担
0:当方(デフォルト) 1:先方
nda_flg integer NDA締結
0:未(デフォルト) 1:済
basic_agreement_flg integer 基本契約書締結
0:未(デフォルト) 1:済
document_send_type integer 書類送付方法
1:メール(デフォルト) 2:郵送 3:両方
note string 備考
tags array タグ
wareki_flg integer デフォルト和暦表示
0:OFF(デフォルト) 1:ON
※和暦表示有効時のみ
company_number string 法人番号(13桁)
accounting_code string 会計用名称・コード
to string TO
複数指定する場合はカンマ区切り
cc string CC
複数指定する場合はカンマ区切り
name_en string 発注先名(英語表記)
※英語アドオン有効時のみ
address_en string 住所(英語表記)
※英語アドオン有効時のみ
phone_country_code string 国番号(英語表記)
※英語アドオン有効時のみ
currency string デフォルト通貨
JPY(デフォルト)/ USD / EUR / GBP / CNY / HKD / TWD / KRW / SGD
※英語アドオン有効時のみ
lang_kbn integer デフォルト言語
1:日本語(デフォルト) 2:英語
※英語アドオン有効時のみ
archive_flg integer アーカイブ状態
0:OFF(デフォルト) 1:ON
custom_no string 発注先番号
tax_withholding_kbn integer デフォルト源泉徴収
1:なし(デフォルト)
2:源泉徴収(復興特別所得税あり)
3:源泉徴収(復興特別所得税なし)

発注先の削除

既存の発注先を削除します。

リクエスト

DELETE /v1/payees/1

レスポンス

Status: 204 No Content

DELETE /v1/payees/:id

URLパラメータ

パラメータ 必須 説明
id integer 発注先ID
発注先情報のレスポンスにあるidを指定

発注先の取得

既存の発注先情報を取得します。

リクエスト

GET /v1/payees/1

レスポンス

Status: 200 OK

  {
    "id": 1,
    "name": "サンプル株式会社",
    "name_disp": "サンプル",
    "title": "御中",
    "zip": "100-0001",
    "pref": "東京都",
    "address1": "千代田区千代田111",
    "address2": "テストビル3階",
    "tel": "03-0000-0001",
    "fax": "03-0000-0002",
    "payment_term_id": 1,
    "payment_term_name": "月末締翌月末払",
    "bank_charge_to_client_flg": 1,
    "nda_flg": 1,
    "basic_agreement_flg": 0,
    "document_send_type": 2,
    "document_send_type_name": "郵送",
    "note": null,
    "tags": [
      "サンプルタグA",
      "サンプルタグB"
    ],
    "wareki_flg": 0,
    "company_number": "1234567890123",
    "accounting_code": "123",
    "to": "example@the-board.jp",
    "cc": "example@the-board.jp",
    "name_en": "Sample, inc",
    "address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
    "phone_country_code": "81",
    "currency": "USD",
    "lang_kbn": 2,
    "lang_kbn_name": "日本語",
    "archive_flg": 0,
    "custom_no": "A00001",
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

GET /v1/payees/:id

URLパラメータ

パラメータ 必須 説明
id integer 発注先ID
発注先情報のレスポンスにあるidを指定

発注先リストの取得

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

リクエスト

GET /v1/payees?include_archive_flg=1&tags[]=サンプルタグA,サンプルタグB"

レスポンス

Status: 200 OK
Link: <https://api.the-board.jp/v1/payees?page=1>; rel="first",
      <https://api.the-board.jp/v1/payees?page=3>; rel="prev",
      <https://api.the-board.jp/v1/payees?page=5>; rel="next",
      <https://api.the-board.jp/v1/payees?page=10>; rel="last"
X-Total-Count: 95
[
  {
    "id": 1,
    "name": "サンプル株式会社",
    "name_disp": "サンプル",
    "title": "御中",
    "zip": "100-0001",
    "pref": "東京都",
    "address1": "千代田区千代田111",
    "address2": "テストビル3階",
    "tel": "03-0000-0001",
    "fax": "03-0000-0002",
    "payment_term_id": 1,
    "payment_term_name": "月末締翌月末払",
    "bank_charge_to_client_flg": 1,
    "nda_flg": 1,
    "basic_agreement_flg": 0,
    "document_send_type": 2,
    "document_send_type_name": "郵送",
    "note": null,
    "tags": [
      "サンプルタグA",
      "サンプルタグB"
    ],
    "wareki_flg": 0,
    "company_number": "1234567890123",
    "accounting_code": "123",
    "to": "example@the-board.jp",
    "cc": "example@the-board.jp",
    "name_en": "Sample, inc",
    "address_en": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan",
    "phone_country_code": "81",
    "currency": "USD",
    "lang_kbn": 2,
    "lang_kbn_name": "日本語",
    "archive_flg": 0,
    "custom_no": "A00001",
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }
  {・・・},
  {・・・},
]

GET /v1/payees

URLパラメータ

指定のパラメータでフィルタリングします。

パラメータ 必須 説明
tags[] string タグ
※複数の場合はカンマ区切り
include_archive_flg string 0:アーカイブ済は除く
1:アーカイブされたものも含む
updated_at_gteq datetime 更新日時(指定日時以降)
YYYY-MM-DD HH:MM:SS
updated_at_lteq datetime 更新日時(指定日時以前)
YYYY-MM-DD HH:MM:SS
custom_no_eq string 発注先番号

*ページネーション用のパラメータについてはページネーション参照

レスポンスグループ

常に全ての項目を返却するとデータ量が多いため、以下のレスポンスグループをURLパラメータとして指定することができます。

レスポンスグループ 説明 項目
small 基本項目のみ(デフォルト) id
name
name_disp
title
zip
pref
address1
address2
tel
fax
payment_term_id
payment_term_name
company_number
created_at
updated_at
large 全ての項目

発注先担当者

発注先担当者の登録

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

リクエスト

POST /v1/payee_contacts
Content-Type: application/json

{
  "payee_id": 1,
  "last_name": "山田",
  "first_name": "太郎",
  "title": "課長",
  "department": "システム部"
}

レスポンス

Status: 201 Created
Location: https://api.the-board.jp/v1/payee_contacts/1

  {
    "id": 1,
    "payee": {
      "id": 1,
      "name": "サンプル株式会社",
      "name_disp": "サンプル"
    },
    "last_name": "山田",
    "first_name": "太郎",
    "title": "課長",
    "department": "システム部",
    "email": "example@the-board.jp",
    "note": "",
    "archive_flg": 0,
    "last_name_en": null,
    "first_name_en": null,
    "prefix_en": null,
    "title_en": null,
    "department_en": null,
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

POST /v1/payee_contacts

パラメータ

パラメータ 必須 説明
payee_id integer 発注先ID
last_name string
first_name string
title string 肩書
department string 部署
email string メールアドレス
note string 備考
archive_flg integer アーカイブ状態
0:OFF(デフォルト) 1:ON
last_name_en string 姓(英語表記)
first_name_en string 名(英語表記)
prefix_en string 敬称(英語表記)
title_en string 肩書(英語表記)
department_en string 部署(英語表記)

発注先担当者の更新

既存の発注先担当者を更新します。

リクエスト

PATCH /v1/payee_contacts/1
Content-Type: application/json

{
  "title": "部長"
}

レスポンス

Status: 200 OK

  {
    "id": 1,
    "payee": {
      "id": 1,
      "name": "サンプル株式会社",
      "name_disp": "サンプル"
    },
    "last_name": "山田",
    "first_name": "太郎",
    "title": "課長",
    "department": "システム部",
    "email": "example@the-board.jp",
    "note": "",
    "archive_flg": 0,
    "last_name_en": null,
    "first_name_en": null,
    "prefix_en": null,
    "title_en": null,
    "department_en": null,
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

PATCH /v1/payee_contacts/:id

URLパラメータ

パラメータ 必須 説明
id integer 発注先担当者ID
発注先担当者情報のレスポンスにあるIDを指定

パラメータ

更新しない項目は指定する必要はありません。

パラメータ 必須 説明
payee_id integer 発注先ID
last_name string
first_name string
title string 肩書
department string 部署
email string メールアドレス
note string 備考
archive_flg integer アーカイブ状態
0:OFF(デフォルト) 1:ON
last_name_en string 姓(英語表記)
first_name_en string 名(英語表記)
prefix_en string 敬称(英語表記)
title_en string 肩書(英語表記)
department_en string 部署(英語表記)

発注先担当者の削除

既存の発注先担当者を削除します。

リクエスト

DELETE /v1/payee_contacts/1

レスポンス

Status: 204 No Content

DELETE /v1/payee_contacts/:id

URLパラメータ

パラメータ 必須 説明
id integer 発注先担当者ID
発注先担当者情報のレスポンスにあるIDを指定

発注先担当者の取得

既存の発注先担当者情報を取得します。

リクエスト

GET /v1/payee_contacts/1

レスポンス

Status: 200 OK

  {
    "id": 1,
    "payee": {
      "id": 1,
      "name": "サンプル株式会社",
      "name_disp": "サンプル"
    },
    "last_name": "山田",
    "first_name": "太郎",
    "title": "課長",
    "department": "システム部",
    "email": "example@the-board.jp",
    "note": "",
    "archive_flg": 0,
    "last_name_en": null,
    "first_name_en": null,
    "prefix_en": null,
    "title_en": null,
    "department_en": null,
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

GET /v1/payee_contacts/:id

URLパラメータ

パラメータ 必須 説明
id integer 発注先担当者ID
発注先担当者情報のレスポンスにあるIDを指定

発注先担当者リストの取得

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

リクエスト

GET /v1/payee_contactsclient_id_eq=1"

レスポンス

Status: 200 OK
Link: <https://api.the-board.jp/v1/payee_contacts?page=1>; rel="first",
      <https://api.the-board.jp/v1/payee_contacts?page=3>; rel="prev",
      <https://api.the-board.jp/v1/payee_contacts?page=5>; rel="next",
      <https://api.the-board.jp/v1/payee_contacts?page=10>; rel="last"
X-Total-Count: 95
[
  {
    "id": 1,
    "payee": {
      "id": 1,
      "name": "サンプル株式会社",
      "name_disp": "サンプル"
    },
    "last_name": "山田",
    "first_name": "太郎",
    "title": "課長",
    "department": "システム部",
    "email": "example@the-board.jp",
    "note": "",
    "archive_flg": 0,
    "last_name_en": null,
    "first_name_en": null,
    "prefix_en": null,
    "title_en": null,
    "department_en": null,
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }
  {・・・},
  {・・・},
]

GET /v1/payee_contacts

URLパラメータ

指定のパラメータでフィルタリングします。

パラメータ 必須 説明
payee_id_eq integer 発注先ID
include_archive_flg string 0:アーカイブ済は除く
1:アーカイブされたものも含む
updated_at_gteq datetime 更新日時(指定日時以降)
YYYY-MM-DD HH:MM:SS
updated_at_lteq datetime 更新日時(指定日時以前)
YYYY-MM-DD HH:MM:SS

*ページネーション用のパラメータについてはページネーション参照

レスポンスグループ

発注先担当者は項目数が少ないため、レスポンスグループはありません。常に全ての項目が返ります。

発注

発注の登録

発注を新規登録します。

リクエスト

POST /v1/expenditures
Content-Type: application/json

// 一括支払の例
{
  "name": "サンプル発注",
  "payee_id": 123456,
  "user_id": 123456,
  "expenditure_status": 1,
  "payment_timing_kbn": 1,
  "invoice_date": "2017-08-31",
  "total": 100000,
  "tax": 8000,
  "tags": ["テスト1", "テスト2"]
}

// 定期支払の例
{
  "name": "サンプル発注",
  "payee_id": 123456,
  "user_id": 123456,
  "expenditure_status": 1,
  "payment_timing_kbn": 2,
  "contract_start_date": "2017-08-01",
  "contract_end_date": "2017-10-31",
  "total": 100000,
  "tax": 8000
}

// 分割支払の例
{
  "name": "サンプル発注",
  "payee_id": 123456,
  "user_id": 123456,
  "expenditure_status": 1,
  "payment_timing_kbn": 3,
  "invoices": [
    {
      "invoice_date": "2017-08-31",
      "total": 100000,
      "tax": 8000
    },
    {
      "invoice_date": "2017-10-31",
      "total": 200000,
      "tax": 16000
    }
  ]
}

レスポンス

Status: 201 Created
Location: https://api.the-board.jp/v1/expenditures/1

  {
    "id": 1,
    "expenditure_no": 1001,
    "management_no": "123456",
    "name": "サンプル案件",
    "payee": {
        "id": 1,
        "name": "サンプル株式会社",
        "name_disp": "サンプル"
    },
    "payee_branch": {
        "id": 1,
        "name":"サンプル支社"
    },
    "payee_name_disp_kbn": 2,
    "payee_name_disp_kbn_name": "会社名+支社名",
    "payee_name_for_post_disp_kbn": 2,
    "payee_name_for_post_disp_kbn_name": "会社名+支社名",
    "payee_contact": {
        "id": 1,
        "last_name": "山田",
        "first_name": "太郎"
    },
    "company_branch": {
        "id": 1,
        "name": "テスト支社"
    },
    "company_name_disp_kbn": 2,
    "company_name_disp_kbn_name": "会社名+支社名",
    "company_name_for_post_disp_kbn": 2,
    "company_name_for_post_disp_kbn_name": "会社名+支社名",
    "user": {
        "id": 1,
        "last_name": "サンプル",
        "first_name": "太郎"
    },
    "total": 100000,
    "tax": 8000,
    "tax_withholding": 0,
    "tax_withholding_kbn": 1,
    "tax_withholding_kbn_name": "なし",
    "project": {
        "id": 1,
        "name": "サンプル案件",
        "project_no": 1001
    },
    "invoice_dates": [
      "2017-01-31"
    ],
    "payment_term_id": 1,
    "payment_term_name": "月末締翌月末払",
    "expenditure_status": 1,
    "expenditure_status_name": "見積中(高)",
    "delivery_status": 1,
    "delivery_status_name": "未着手",
    "payment_timing_kbn": 1,
    "payment_timing_kbn_name": "一括支払",
    "contract_start_date": null,
    "contract_end_date": null,
    "expenditure_type_id": null,
    "expenditure_type_name": null,
    "expenditure_type2_id": null,
    "expenditure_type2_name": null,
    "expenditure_type3_id": null,
    "expenditure_type3_name": null,
    "group_id": 1,
    "group_name": "グループA",
    "tags": [],
    "in_house_memo": null,
    "tax_rule_kbn": 2,
    "tax_rule_kbn_name": "切り捨て",
    "to": "example@the-board.jp",
    "cc": "example@the-board.jp",
    "lock_flg": 0,
    "wareki_flg": 0,
    "archive_flg": 0,
    "currency": "JPY",
    "lang_kbn": 1,
    "lang_kbn_name": "日本語",
    "exchange_rate": 1,
    "total_jpy": 100000,
    "tax_jpy": 8000,
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

POST /v1/expenditures

パラメータについて

一括支払・定期支払・分割支払に応じて必要なパラメータが異なります。
それぞれ、以下のパラメータを送信してください。
一括支払の発注:共通+一括支払のパラメータ
定期支払の発注:共通+定期支払のパラメータ
分割支払の発注:共通+分割支払のパラメータ

パラメータ(共通)

パラメータ 必須 説明
name string 発注名
payee_id integer 発注先ID
発注先リストで取得できるid
payee_branch_id integer 発注先支社ID
payee_name_disp_kbn integer 発注先支社(書類上の表示)
※支社を指定する場合のみ
1: 会社名のみ(デフォルト)
2: 会社名+支社名
3: 支社名のみ
payee_name_for_post_disp_kbn integer 発注先支社(郵送時の表示)
※支社を指定する場合のみ
1: 会社名のみ(デフォルト)
2: 会社名+支社名
3: 支社名のみ
payee_contact_id integer 発注先担当者ID
発注先担当者リストで取得できるid
company_branch_id integer 自社支社ID
company_name_disp_kbn integer 自社支社(書類上の表示)
※支社を指定する場合のみ
1: 会社名のみ(デフォルト)
2: 会社名+支社名
3: 支社名のみ
company_name_for_post_disp_kbn integer 自社支社(郵送時の表示)
※支社を指定する場合のみ
1: 会社名のみ(デフォルト)
2: 会社名+支社名
3: 支社名のみ
user_id integer 担当者ID
ユーザリストで取得できるid
project_id integer 関連案件ID
案件リストで取得できるid
payment_term_id integer 支払条件ID
支払条件リストで取得できるid
※未指定の場合は顧客の「デフォルト支払条件」
expenditure_status integer 発注ステータス
1: 見積中(高)
2: 見積中(中)
3: 見積中(低)
8: 見積中(除)
4: 発注確定
5: 発注済
9: 見送り
payment_timing_kbn integer 支払タイミング
1: 一括支払
2: 定期支払
3: 分割支払
tax_withholding_kbn integer 源泉徴収区分
1: なし(デフォルト)
2: 源泉徴収(復興特別所得税あり)
3: 源泉徴収(復興特別所得税なし)
in_house_memo string 社内メモ
management_no string 管理番号
expenditure_type_id integer 発注区分1ID
発注区分リストで取得できるid
expenditure_type2_id integer 発注区分2ID
発注区分リストで取得できるid
expenditure_type3_id integer 発注区分3ID
発注区分リストで取得できるid
tags array タグ
group_id integer グループID
グループリストで取得できるid
company_bank_id integer 集計用出金口座(振込口座ID)
delivery_status integer 進捗状況
1: 未着手(デフォルト)
2: 着手中
3: 納品済
4: 検収済
tax_rule_kbn integer 端数処理
1: 四捨五入
2: 切り捨て
3: 切り上げ
※デフォルトはアカウントの設定による
wareki_flg integer 和暦表示
0: OFF(デフォルト)
1: ON
※和暦表示有効時のみ
to string TO
cc string CC
currency string デフォルト通貨
JPY(デフォルト)/ USD / EUR / GBP / CNY / HKD / TWD / KRW / SGD
※英語アドオン有効時のみ
lang_kbn string 言語区分
1: 日本語(デフォルト)
2: 英語
※英語外貨アドオン有効時のみ
exchange_rate decimal 為替レート
※英語外貨アドオン有効時のみ

パラメータ(一括請求の場合のみ)

パラメータ 必須 説明
invoice_date date 請求日
YYYY-MM-DD
total decimal 金額(税抜)
tax decimal 消費税
tax_withholding decimal 源泉徴収税

パラメータ(定期請求の場合のみ)

パラメータ 必須 説明
contract_start_date date 契約開始日
YYYY-MM-DD
contract_end_date date 契約終了日
YYYY-MM-DD
periodical_payment_interval integer 支払間隔
1〜12の数字(デフォルト: 1)
periodical_payment_payment_kbn integer 支払間隔内の請求時期
1: 請求間隔の最初の月(デフォルト)
2: 請求間隔の最後の月
auto_renewal_flg integer 自動契約更新
0: OFF(デフォルト) 1: ON
auto_renewal_period_month integer 自動契約更新期間(月数)
1〜12の数字
※自動契約更新ONの場合のみ必須
total decimal 金額(税抜)
tax decimal 消費税
tax_withholding decimal 源泉徴収税

パラメータ(分割請求の場合のみ)

パラメータ 必須 説明
invoices array 下記「請求情報」参照

「請求情報」のパラメータ

パラメータ 必須 説明
invoice_date string 請求日
YYYY-MM-DD
total decimal 金額(税抜)
tax decimal 消費税
tax_withholding decimal 源泉徴収税

発注の更新

既存の発注を更新します。

リクエスト

PATCH /v1/expenditures/1
Content-Type: application/json

{
  "name": "サンプル発注"
}

レスポンス

Status: 200 OK

  {
    "id": 1,
    "expenditure_no": 1001,
    "management_no": "123456",
    "name": "サンプル案件",
    "payee": {
        "id": 1,
        "name": "サンプル株式会社",
        "name_disp": "サンプル"
    },
    "payee_branch": {
        "id": 1,
        "name":"サンプル支社"
    },
    "payee_name_disp_kbn": 2,
    "payee_name_disp_kbn_name": "会社名+支社名",
    "payee_name_for_post_disp_kbn": 2,
    "payee_name_for_post_disp_kbn_name": "会社名+支社名",
    "payee_contact": {
        "id": 1,
        "last_name": "山田",
        "first_name": "太郎"
    },
    "company_branch": {
        "id": 1,
        "name": "テスト支社"
    },
    "company_name_disp_kbn": 2,
    "company_name_disp_kbn_name": "会社名+支社名",
    "company_name_for_post_disp_kbn": 2,
    "company_name_for_post_disp_kbn_name": "会社名+支社名",
    "user": {
        "id": 1,
        "last_name": "サンプル",
        "first_name": "太郎"
    },
    "total": 100000,
    "tax": 8000,
    "tax_withholding": 0,
    "tax_withholding_kbn": 1,
    "tax_withholding_kbn_name": "なし",
    "project": {
        "id": 1,
        "name": "サンプル案件",
        "project_no": 1001
    },
    "invoice_dates": [
      "2017-01-31"
    ],
    "payment_term_id": 1,
    "payment_term_name": "月末締翌月末払",
    "expenditure_status": 1,
    "expenditure_status_name": "見積中(高)",
    "delivery_status": 1,
    "delivery_status_name": "未着手",
    "payment_timing_kbn": 1,
    "payment_timing_kbn_name": "一括支払",
    "contract_start_date": null,
    "contract_end_date": null,
    "expenditure_type_id": null,
    "expenditure_type_name": null,
    "expenditure_type2_id": null,
    "expenditure_type2_name": null,
    "expenditure_type3_id": null,
    "expenditure_type3_name": null,
    "group_id": 1,
    "group_name": "グループA",
    "tags": [],
    "in_house_memo": null,
    "tax_rule_kbn": 2,
    "tax_rule_kbn_name": "切り捨て",
    "to": "example@the-board.jp",
    "cc": "example@the-board.jp",
    "lock_flg": 0,
    "wareki_flg": 0,
    "archive_flg": 0,
    "currency": "JPY",
    "lang_kbn": 1,
    "lang_kbn_name": "日本語",
    "exchange_rate": 1,
    "total_jpy": 100000,
    "tax_jpy": 8000,
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

PATCH /v1/expenditures/:id

URLパラメータ

パラメータ 必須 説明
id integer 発注ID
発注情報のレスポンスにあるidを指定

パラメータについて

一括支払・定期支払・分割支払に応じて必要なパラメータが異なります。
それぞれ、以下のパラメータを送信してください。
一括支払の発注:共通+一括支払のパラメータ
定期支払の発注:共通+定期支払のパラメータ
分割支払の発注:共通+分割支払のパラメータ

更新しない項目は指定する必要はありません。

パラメータ(共通)

パラメータ 必須 説明
name string 発注名
payee_id integer 発注先ID
発注先リストで取得できるid
payee_branch_id integer 発注先支社ID
payee_name_disp_kbn integer 発注先支社(書類上の表示)
※支社を指定する場合のみ
1: 会社名のみ(デフォルト)
2: 会社名+支社名
3: 支社名のみ
payee_name_for_post_disp_kbn integer 発注先支社(郵送時の表示)
※支社を指定する場合のみ
1: 会社名のみ(デフォルト)
2: 会社名+支社名
3: 支社名のみ
payee_contact_id integer 発注先担当者ID
発注先担当者リストで取得できるid
company_branch_id integer 自社支社ID
company_name_disp_kbn integer 自社支社(書類上の表示)
※支社を指定する場合のみ
1: 会社名のみ(デフォルト)
2: 会社名+支社名
3: 支社名のみ
company_name_for_post_disp_kbn integer 自社支社(郵送時の表示)
※支社を指定する場合のみ
1: 会社名のみ(デフォルト)
2: 会社名+支社名
3: 支社名のみ
user_id integer 担当者ID
ユーザリストで取得できるid
project_id integer 関連案件ID
案件リストで取得できるid
payment_term_id integer 支払条件ID
支払条件リストで取得できるid
※未指定の場合は顧客の「デフォルト支払条件」
expenditure_status integer 発注ステータス
1: 見積中(高)
2: 見積中(中)
3: 見積中(低)
8: 見積中(除)
4: 発注確定
5: 発注済
9: 見送り
payment_timing_kbn integer 支払タイミング
1: 一括支払
2: 定期支払
3: 分割支払
tax_withholding_kbn integer 源泉徴収区分
1: なし(デフォルト)
2: 源泉徴収(復興特別所得税あり)
3: 源泉徴収(復興特別所得税なし)
in_house_memo string 社内メモ
management_no string 管理番号
expenditure_type_id integer 発注区分1ID
発注区分リストで取得できるid
expenditure_type2_id integer 発注区分2ID
発注区分リストで取得できるid
expenditure_type3_id integer 発注区分3ID
発注区分リストで取得できるid
tags array タグ
group_id integer グループID
グループリストで取得できるid
company_bank_id integer 集計用出金口座(振込口座ID)
delivery_status integer 進捗状況
1: 未着手(デフォルト)
2: 着手中
3: 納品済
4: 検収済
tax_rule_kbn integer 端数処理
1: 四捨五入
2: 切り捨て
3: 切り上げ
※デフォルトはアカウントの設定による
wareki_flg integer 和暦表示
0: OFF(デフォルト)
1: ON
※和暦表示有効時のみ
to string TO
cc string CC
currency string デフォルト通貨
JPY(デフォルト)/ USD / EUR / GBP / CNY / HKD / TWD / KRW / SGD
※英語アドオン有効時のみ
lang_kbn string 言語区分
1: 日本語(デフォルト)
2: 英語
※英語外貨アドオン有効時のみ
exchange_rate decimal 為替レート
※英語外貨アドオン有効時のみ

パラメータ(一括請求の場合のみ)

パラメータ 必須 説明
invoice_date date 請求日
YYYY-MM-DD
total decimal 金額(税抜)
tax decimal 消費税
tax_withholding decimal 源泉徴収税

パラメータ(定期請求の場合のみ)

パラメータ 必須 説明
contract_start_date date 契約開始日
YYYY-MM-DD
contract_end_date date 契約終了日
YYYY-MM-DD
periodical_payment_interval integer 支払間隔
1〜12の数字(デフォルト: 1)
periodical_payment_payment_kbn integer 支払間隔内の請求時期
1: 請求間隔の最初の月(デフォルト)
2: 請求間隔の最後の月
auto_renewal_flg integer 自動契約更新
0: OFF(デフォルト) 1: ON
auto_renewal_period_month integer 自動契約更新期間(月数)
1〜12の数字
※自動契約更新ONの場合のみ必須
total decimal 金額(税抜)
tax decimal 消費税
tax_withholding decimal 源泉徴収税

パラメータ(分割請求の場合のみ)

現在、APIでの分割回数の変更(請求日・請求回数の変更)には対応していません。

パラメータ 必須 説明
invoices array 下記「請求情報」参照

「請求情報」のパラメータ

パラメータ 必須 説明
invoice_date string 請求日
YYYY-MM-DD
total decimal 金額(税抜)
tax decimal 消費税
tax_withholding decimal 源泉徴収税

発注の削除

既存の発注を削除します。

リクエスト

DELETE /v1/expenditures/1

レスポンス

Status: 204 No Content

DELETE /v1/expenditures/:id

URLパラメータ

パラメータ 必須 説明
id integer 発注ID
発注情報のレスポンスにあるidを指定

発注の取得

既存の発注情報を取得します。

リクエスト

GET /v1/expenditures/1

レスポンス

Status: 200 OK

  {
    "id": 1,
    "expenditure_no": 1001,
    "management_no": "123456",
    "name": "サンプル案件",
    "payee": {
        "id": 1,
        "name": "サンプル株式会社",
        "name_disp": "サンプル"
    },
    "payee_branch": {
        "id": 1,
        "name":"サンプル支社"
    },
    "payee_name_disp_kbn": 2,
    "payee_name_disp_kbn_name": "会社名+支社名",
    "payee_name_for_post_disp_kbn": 2,
    "payee_name_for_post_disp_kbn_name": "会社名+支社名",
    "payee_contact": {
        "id": 1,
        "last_name": "山田",
        "first_name": "太郎"
    },
    "company_branch": {
        "id": 1,
        "name": "テスト支社"
    },
    "company_name_disp_kbn": 2,
    "company_name_disp_kbn_name": "会社名+支社名",
    "company_name_for_post_disp_kbn": 2,
    "company_name_for_post_disp_kbn_name": "会社名+支社名",
    "user": {
        "id": 1,
        "last_name": "サンプル",
        "first_name": "太郎"
    },
    "total": 100000,
    "tax": 8000,
    "tax_withholding": 0,
    "tax_withholding_kbn": 1,
    "tax_withholding_kbn_name": "なし",
    "project": {
        "id": 1,
        "name": "サンプル案件",
        "project_no": 1001
    },
    "invoice_dates": [
      "2017-01-31"
    ],
    "payment_term_id": 1,
    "payment_term_name": "月末締翌月末払",
    "expenditure_status": 1,
    "expenditure_status_name": "見積中(高)",
    "delivery_status": 1,
    "delivery_status_name": "未着手",
    "payment_timing_kbn": 1,
    "payment_timing_kbn_name": "一括支払",
    "contract_start_date": null,
    "contract_end_date": null,
    "expenditure_type_id": null,
    "expenditure_type_name": null,
    "expenditure_type2_id": null,
    "expenditure_type2_name": null,
    "expenditure_type3_id": null,
    "expenditure_type3_name": null,
    "group_id": 1,
    "group_name": "グループA",
    "tags": [],
    "in_house_memo": null,
    "tax_rule_kbn": 2,
    "tax_rule_kbn_name": "切り捨て",
    "to": "example@the-board.jp",
    "cc": "example@the-board.jp",
    "lock_flg": 0,
    "wareki_flg": 0,
    "archive_flg": 0,
    "currency": "JPY",
    "lang_kbn": 1,
    "lang_kbn_name": "日本語",
    "exchange_rate": 1,
    "total_jpy": 100000,
    "tax_jpy": 8000,
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

GET /v1/expenditures/:id

URLパラメータ

パラメータ 必須 説明
id integer 発注ID
発注情報のレスポンスにあるidを指定

レスポンスグループ

常に全ての項目を返却するとデータ量が多いため、レスポンスグループをURLパラメータとして指定することができます。

発注のレスポンスグループについては、「発注リストの取得」を参照してください。

発注リストの取得

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

リクエスト

GET /v1/expenditures?response_group=large&created_at_gteq=2016-12-01%2000:00:00"

レスポンス

Status: 200 OK
Link: <https://api.the-board.jp/v1/expenditures?page=1>; rel="first",
      <https://api.the-board.jp/v1/expenditures?page=3>; rel="prev",
      <https://api.the-board.jp/v1/expenditures?page=5>; rel="next",
      <https://api.the-board.jp/v1/expenditures?page=10>; rel="last"
X-Total-Count: 95
[
  {
    "id": 1,
    "expenditure_no": 1001,
    "management_no": "123456",
    "name": "サンプル案件",
    "payee": {
        "id": 1,
        "name": "サンプル株式会社",
        "name_disp": "サンプル"
    },
    "payee_branch": {
        "id": 1,
        "name":"サンプル支社"
    },
    "payee_name_disp_kbn": 2,
    "payee_name_disp_kbn_name": "会社名+支社名",
    "payee_name_for_post_disp_kbn": 2,
    "payee_name_for_post_disp_kbn_name": "会社名+支社名",
    "payee_contact": {
        "id": 1,
        "last_name": "山田",
        "first_name": "太郎"
    },
    "company_branch": {
        "id": 1,
        "name": "テスト支社"
    },
    "company_name_disp_kbn": 2,
    "company_name_disp_kbn_name": "会社名+支社名",
    "company_name_for_post_disp_kbn": 2,
    "company_name_for_post_disp_kbn_name": "会社名+支社名",
    "user": {
        "id": 1,
        "last_name": "サンプル",
        "first_name": "太郎"
    },
    "total": 100000,
    "tax": 8000,
    "tax_withholding": 0,
    "tax_withholding_kbn": 1,
    "tax_withholding_kbn_name": "なし",
    "project": {
        "id": 1,
        "name": "サンプル案件",
        "project_no": 1001
    },
    "invoice_dates": [
      "2017-01-31"
    ],
    "payment_term_id": 1,
    "payment_term_name": "月末締翌月末払",
    "expenditure_status": 1,
    "expenditure_status_name": "見積中(高)",
    "delivery_status": 1,
    "delivery_status_name": "未着手",
    "payment_timing_kbn": 1,
    "payment_timing_kbn_name": "一括支払",
    "contract_start_date": null,
    "contract_end_date": null,
    "expenditure_type_id": null,
    "expenditure_type_name": null,
    "expenditure_type2_id": null,
    "expenditure_type2_name": null,
    "expenditure_type3_id": null,
    "expenditure_type3_name": null,
    "group_id": 1,
    "group_name": "グループA",
    "tags": [],
    "in_house_memo": null,
    "tax_rule_kbn": 2,
    "tax_rule_kbn_name": "切り捨て",
    "to": "example@the-board.jp",
    "cc": "example@the-board.jp",
    "lock_flg": 0,
    "wareki_flg": 0,
    "archive_flg": 0,
    "currency": "JPY",
    "lang_kbn": 1,
    "lang_kbn_name": "日本語",
    "exchange_rate": 1,
    "total_jpy": 100000,
    "tax_jpy": 8000,
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }
  {・・・},
  {・・・},
]

GET /v1/expenditures

URLパラメータ

指定のパラメータでフィルタリングします。

パラメータ 必須 説明
expenditure_status_in[] integer 発注ステータス
1: 見積中(高)
2: 見積中(中)
3: 見積中(低)
8: 見積中(除)
4: 発注確定
5: 発注済
9: 見送り
※複数の場合はカンマ区切り
expenditure_no_eq integer 発注No
created_at_gteq datetime 作成日時(指定日時以降)
YYYY-MM-DD HH:MM:SS
created_at_lteq datetime 作成日時(指定日時以前)
YYYY-MM-DD HH:MM:SS
include_not_ordered_flg integer 見送りステータス
0:見送りは除く(デフォルト)
1:見送りも含む
include_archive_flg integer アーカイブ
0:アーカイブは除く(デフォルト)
1:アーカイブも含む

*ページネーション用のパラメータについてはページネーション参照

レスポンスグループ

常に全ての項目を返却するとデータ量が多いため、以下のレスポンスグループをURLパラメータとして指定することができます。

レスポンスグループ 説明 項目
small 基本項目のみ(デフォルト) id
expenditure_no
management_no
name
payee
payee_contact
user
total
tax
tax_withholding
tax_withholding_kbn
tax_withholding_kbn_name
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
delivery_status
delivery_status_name
currency
created_at
updated_at
medium 主要項目 payee_branch
company_branch
project
payment_term_id
payment_term_name
payment_timing_kbn
payment_timing_kbn_name
contract_start_date
contract_end_date
tags
exchange_rate
total_jpy
tax_jpy
large 書類以外全ての項目
order small + 発注書
all large + 全ての書類

発注ステータス変更

発注ステータスを変更します。

リクエスト

PATCH /v1/expenditures/expenditure_status/1
Content-Type: application/json

{
  "expenditure_status": 4
}

レスポンス

Status: 204 No Content

PATCH /v1/expenditures/expenditure_status/:id

URLパラメータ

パラメータ 必須 説明
id integer 発注ID
発注情報に含まれているid

パラメータ

パラメータ 必須 説明
expenditure_status integer 発注ステータス
指定されたステータスに変更します
1: 見積中(高)
2: 見積中(中)
3: 見積中(低)
8: 見積中(除)
4: 発注確定
5: 発注済
9: 見送り

支払

支払リストの取得

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

リクエスト

GET /v1/expenditure_payments?response_group=large&expenditure_expenditure_status_in[]=4,5"

レスポンス

Status: 200 OK
Link: <https://api.the-board.jp/v1/expenditure_payments?page=1>; rel="first",
      <https://api.the-board.jp/v1/expenditure_payments?page=3>; rel="prev",
      <https://api.the-board.jp/v1/expenditure_payments?page=5>; rel="next",
      <https://api.the-board.jp/v1/expenditure_payments?page=10>; rel="last"
X-Total-Count: 95
[
  {
    "id": 1,
    "expenditure_no": 1001,
    "management_no": "123456",
    "name": "サンプル案件",
    "payee": {
        "id": 1,
        "name": "サンプル株式会社",
        "name_disp": "サンプル"
    },
    "payee_branch": {
        "id": 1,
        "name":"サンプル支社"
    },
    "payee_contact": {
        "id": 1,
        "last_name": "山田",
        "first_name": "太郎"
    },
    "company_branch": {
        "id": 1,
        "name": "テスト支社"
    },
    "user": {
        "id": 1,
        "last_name": "サンプル",
        "first_name": "太郎"
    },
    "total": 100000,
    "tax": 8000,
    "tax_withholding": 0,
    "invoice_date": "2017-01-31",
    "payment_date": "2017-02-28",
    "expenditure_status": 1,
    "expenditure_status_name": "見積中(高)",
    "payment_status": 3,
    "payment_status_name": "支払済",
    "expenditure_type_id": 1,
    "expenditure_type_name": "サンプル区分A",
    "expenditure_type2_id": 2,
    "expenditure_type2_name": "サンプル区分2",
    "expenditure_type3_id": 3,
    "expenditure_type3_name": "サンプル区分3",
    "tags": [],
    "lock_flg": 0,
    "currency": "JPY",
    "lang_kbn": 1,
    "lang_kbn_name": "日本語",
    "exchange_rate": 1,
    "total_jpy": 100000,
    "tax_jpy": 8000,
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }
  {・・・},
  {・・・},
]

GET /v1/expenditure_payments

URLパラメータ

指定のパラメータでフィルタリングします。

パラメータ 必須 説明
invoice_date_gteq date 請求日(指定日以降)
YYYY-MM-DD
invoice_date_lteq date 請求日(指定日以前)
YYYY-MM-DD
payment_date_gteq date 支払日(指定日以降)
YYYY-MM-DD
payment_date_lteq date 支払日(指定日以前)
YYYY-MM-DD
expenditure_expenditure_status_in[] integer 発注ステータス
1: 見積中(高)
2: 見積中(中)
3: 見積中(低)
8: 見積中(除)
4: 発注確定
5: 発注済
9: 見送り
※複数の場合はカンマ区切り
payment_status_in[] integer 支払ステータス
1: 請求書未受領
2: 請求書受領済
3: 支払済
※複数の場合はカンマ区切り
expenditure_expenditure_no_eq integer 発注No

*ページネーション用のパラメータについてはページネーション参照

レスポンスグループ

常に全ての項目を返却するとデータ量が多いため、以下のレスポンスグループをURLパラメータとして指定することができます。

レスポンスグループ 説明 項目
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
expenditure_type_id
expenditure_type_name
expenditure_type2_id
expenditure_type2_name
expenditure_type3_id
expenditure_type3_name
currency
created_at
updated_at
medium 主要項目 payee_branch
company_branch
tags
exchange_rate
total_jpy
tax_jpy
large すべての項目

支払ステータス変更

支払ステータスを変更します。

リクエスト

PATCH /v1/expenditure_payments/payment_status/1
Content-Type: application/json

{
  "payment_status": 2
}

レスポンス

Status: 204 No Content

PATCH /v1/expenditure_payments/payment_status/:id

URLパラメータ

パラメータ 必須 説明
id integer 支払ID
支払情報に含まれているid

パラメータ

パラメータ 必須 説明
payment_status integer 支払ステータス
指定されたステータスに変更します
1: 請求書未受領
2: 請求書受領済
3: 支払済

書類(発注)

発注書の更新

既存の発注書を更新します。

リクエスト

PATCH /v1/expenditure_documents/orders/1
Content-Type: application/json

{
  "total": 300000,
  "tax": 24000,
  "message": "サンプル備考です。",
  "details": [
    {
      "description": "サンプル明細1",
      "quantity": 1,
      "unit": "式",
      "unit_price": 100000
    },
    {
      "description": "サンプル明細2",
      "quantity": 1,
      "unit": "式",
      "unit_price": 200000
    }
  ]
}

レスポンス

Status: 200 OK

  {
    "id": 1,
    "message": "サンプル備考。",
    "valid_period": "御見積後2週間",
    "total": 100000,
    "tax": 8000,
    "tax_withholding": 0,
    "seal_approval_status": 1,
    "document_amount_disp_kbn": 1,
    "blank_date_flg": 0,
    "lock_flg": 0,
    "details": [
        {
            "no": 1,
            "description": "サンプル明細1",
            "quantity": 1,
            "unit": "式",
            "unit_price": 100000,
            "price": 100000,
            "tax_rate": 8.0,
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": null,
            "section_subtotal": null,
            "document_detail_kbn": 1,
            "document_detail_kbn_name": "通常"
        },
        {
            "no": 2,
            "description": null,
            "quantity": null,
            "unit": null,
            "unit_price": null,
            "price": null,
            "tax_rate": "8.0",
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": "見出しサンプル",
            "section_subtotal": 0,
            "document_detail_kbn": 2,
            "document_detail_kbn_name": "見出し行"
        }
    ],
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

PATCH /v1/expenditure_documents/orders/:id

URLパラメータ

パラメータ 必須 説明
id integer 発注書ID
発注書情報のレスポンスにあるidを指定
※リスト取得APIで、
レスポンスグループに対象の書類を指定すると、
書類のIDが取得できます。

パラメータ

更新しない項目は指定する必要はありません。

パラメータ 必須 説明
total decimal 小計
※自動計算はされないため未指定の場合は0
tax decimal 消費税
※自動計算はされないため未指定の場合は0
tax_withholding decimal 源泉徴収税
※自動計算はされないため未指定の場合は0
message string 備考
document_amount_disp_kbn integer 金額表示(表示設定)
1: 税込表示(デフォルト)
2: 合計欄を税抜表示+明細下の小計・消費税行非表示
3: 合計欄のみ税抜表示
4: 合計表示なし
details array 明細行(各行の項目は、下記「明細行のパラメータ」参照
※detailsは送信された内容に置き換えられますので、更新がない場合でも送信してください。
disp_order_date date 発注日(表示設定)
disp_order_receive_date date 発注請日(表示設定)
blank_date_flg integer 発注請日空欄
0: 表示(デフォルト)
1: 空欄

明細行のパラメータ

パラメータ 必須 説明
description string 摘要
quantity decimal 数量(小数点2桁まで)
unit string 単位
unit_price decimal 単価(小数点5桁まで)
tax_rate integer 消費税
0: 非課税
5: 5%
8: 8%
10: 10%
※未指定の場合は、現在の税率が自動的に設定されます
tax_withholding_flg integer 源泉徴収対象
0: 対象外(デフォルト)
1: 対象
tax_included_flg integer 内税対象
0: 外税(デフォルト)
1: 内税
section_description string 見出し行・小計行のテキスト
section_subtotal decimal 見出し小計の金額
document_detail_kbn integer 書類明細区分
1: 通常行(デフォルト)
2: 見出し行
3: 小計行

発注書の取得

既存の発注書情報を取得します。

リクエスト

GET /v1/expenditure_documents/orders/1

レスポンス

Status: 200 OK

  {
    "id": 1,
    "message": "サンプル備考。",
    "valid_period": "御見積後2週間",
    "total": 100000,
    "tax": 8000,
    "tax_withholding": 0,
    "seal_approval_status": 1,
    "document_amount_disp_kbn": 1,
    "blank_date_flg": 0,
    "lock_flg": 0,
    "details": [
        {
            "no": 1,
            "description": "サンプル明細1",
            "quantity": 1,
            "unit": "式",
            "unit_price": 100000,
            "price": 100000,
            "tax_rate": 8.0,
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": null,
            "section_subtotal": null,
            "document_detail_kbn": 1,
            "document_detail_kbn_name": "通常"
        },
        {
            "no": 2,
            "description": null,
            "quantity": null,
            "unit": null,
            "unit_price": null,
            "price": null,
            "tax_rate": "8.0",
            "tax_withholding_flg": 0,
            "tax_included_flg": 0,
            "section_description": "見出しサンプル",
            "section_subtotal": 0,
            "document_detail_kbn": 2,
            "document_detail_kbn_name": "見出し行"
        }
    ],
    "created_at": "2016-12-15T12:50:05.000+09:00",
    "updated_at": "2016-12-15T12:50:05.000+09:00"
  }

GET /v1/expenditure_documents/orders/:id

URLパラメータ

パラメータ 必須 説明
id integer 発注書ID
発注書情報のレスポンスにあるidを指定
※リスト取得APIで、
レスポンスグループに対象の書類を指定すると、
書類のIDが取得できます。

ユーザ(担当者)

ユーザリストの取得

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

リクエスト

GET /v1/users

レスポンス

Status: 200 OK
Link: <https://api.the-board.jp/v1/users?page=1>; rel="first",
      <https://api.the-board.jp/v1/users?page=3>; rel="prev",
      <https://api.the-board.jp/v1/users?page=5>; rel="next",
      <https://api.the-board.jp/v1/users?page=10>; rel="last"
X-Total-Count: 95
[
  {
    "id": 1,
    "email": "example@example.com",
    "last_name": "山田",
    "first_name": "太郎",
    "role_id": 1,
    "role_name": "管理者",
    "last_sign_in_at": "2017-09-03T09:53:54.000+09:00",
    "created_at": "2017-09-03T09:53:54.000+09:00",
    "updated_at": "2017-09-03T09:53:54.000+09:00"
  }
  {・・・},
  {・・・},
]

GET /v1/users

URLパラメータ

指定のパラメータでフィルタリングします。

パラメータ 必須 説明
email_eq string メールアドレス

*ページネーション用のパラメータについてはページネーション参照

グループ

グループリストの取得

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

リクエスト

GET /v1/groups

レスポンス

Status: 200 OK
Link: <https://api.the-board.jp/v1/groups?page=1>; rel="first",
      <https://api.the-board.jp/v1/groups?page=3>; rel="prev",
      <https://api.the-board.jp/v1/groups?page=5>; rel="next",
      <https://api.the-board.jp/v1/groups?page=10>; rel="last"
X-Total-Count: 95
[
  {
    "id": 123456,
    "name": "グループA",
    "created_at": "2017-09-03T09:53:54.000+09:00",
    "updated_at": "2017-09-03T09:53:54.000+09:00"
  }
  {・・・},
  {・・・},
]

GET /v1/groups

URLパラメータ

指定のパラメータでフィルタリングします。

パラメータ 必須 説明
name_cont string グループ名

*ページネーション用のパラメータについてはページネーション参照

支払条件

支払条件リストの取得

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

リクエスト

GET /v1/payment_terms

レスポンス

Status: 200 OK
Link: <https://api.the-board.jp/v1/payment_terms?page=1>; rel="first",
      <https://api.the-board.jp/v1/payment_terms?page=3>; rel="prev",
      <https://api.the-board.jp/v1/payment_terms?page=5>; rel="next",
      <https://api.the-board.jp/v1/payment_terms?page=10>; rel="last"
X-Total-Count: 95
[
  {
    "id": 123456,
    "name": "月末締翌月末払",
    "created_at": "2017-09-03T09:53:54.000+09:00",
    "updated_at": "2017-09-03T09:53:54.000+09:00"
  }
  {・・・},
  {・・・},
]

GET /v1/payment_terms

URLパラメータ

指定のパラメータでフィルタリングします。

パラメータ 必須 説明
name_cont string 支払条件名

*ページネーション用のパラメータについてはページネーション参照

案件区分

案件区分リストの取得

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

リクエスト

GET /v1/project_types

レスポンス

Status: 200 OK
Link: <https://api.the-board.jp/v1/project_types?page=1>; rel="first",
      <https://api.the-board.jp/v1/project_types?page=3>; rel="prev",
      <https://api.the-board.jp/v1/project_types?page=5>; rel="next",
      <https://api.the-board.jp/v1/project_types?page=10>; rel="last"
X-Total-Count: 95
[
  {
    "id": 123456,
    "name": "案件区分A",
    "created_at": "2017-09-03T09:53:54.000+09:00",
    "updated_at": "2017-09-03T09:53:54.000+09:00"
  }
  {・・・},
  {・・・},
]

GET /v1/project_types

URLパラメータ

指定のパラメータでフィルタリングします。

パラメータ 必須 説明
project_type_kbn_eq integer 案件区分1〜3の種類
1: 案件区分1(デフォルト)
2: 案件区分2
3: 案件区分3
※未指定時は案件区分1の結果が返ります
name_cont string グループ名

*ページネーション用のパラメータについてはページネーション参照

発注区分

発注区分リストの取得

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

リクエスト

GET /v1/expenditure_types

レスポンス

Status: 200 OK
Link: <https://api.the-board.jp/v1/expenditure_types?page=1>; rel="first",
      <https://api.the-board.jp/v1/expenditure_types?page=3>; rel="prev",
      <https://api.the-board.jp/v1/expenditure_types?page=5>; rel="next",
      <https://api.the-board.jp/v1/expenditure_types?page=10>; rel="last"
X-Total-Count: 95
[
  {
    "id": 123456,
    "name": "発注区分A",
    "created_at": "2017-09-03T09:53:54.000+09:00",
    "updated_at": "2017-09-03T09:53:54.000+09:00"
  }
  {・・・},
  {・・・},
]

GET /v1/expenditure_types

URLパラメータ

指定のパラメータでフィルタリングします。

パラメータ 必須 説明
expenditure_type_kbn_eq integer 発注区分1〜3の種類
1: 発注区分1(デフォルト)
2: 発注区分2
3: 発注区分3
※未指定時は発注区分1の結果が返ります
name_cont string グループ名

*ページネーション用のパラメータについてはページネーション参照