{
"openapi": "3.1.0",
"info": {
"version": "1.9.0",
"title": "board APIドキュメント",
"description": "## 概要\nこのドキュメントではboardのAPI仕様について説明します。\n\n[board APIファーストガイド](https://the-board.jp/helps/help_api_first_guide)ではデータ構造などの全体像の解説をしていますので、まずはじめにファーストガイドをご覧いただくとスムーズです。\n\n当ドキュメントではシステムとしての業務仕様の説明はありません。そのため、とくに、普段業務ではboardを利用していない方がAPI用途のみで利用する場合は、当ドキュメントを読み進める前に、案件の概念や、案件との書類の関係などの基本仕様を、ファーストガイドやヘルプで把握しておくことをお勧めします。\n\n### CHANGELOG\nAPIに関する変更履歴は[CHANGELOG](/changelog)をご確認ください。\n\n### エンドポイント\n\n```\nhttps://api.the-board.jp/v1/{各エンドポイントのパス}\n```\n\n### OpenAPI\n当APIドキュメントは、OpenAPIの仕様に沿って作成されています。\n\nページトップの「Download OpenAPI specification」から、OpenAPI specificationのJSONデータをダウンロードできます。\nこのJSONデータをPostmanなどOpenAPIに対応しているAPI開発ツールの取り込むことができます。\n\nFAQ：[OpenAPIのデータをPostmanにインポートする](https://the-board.jp/helps/faq_import_openapi_data_to_postman)\n\n## 認証・認可\nboard APIでは、「APIキー」と「APIトークン」の2つの概念があり、リクエストの際に両方をヘッダーに指定する必要があります。\n\n```\nx-api-key: API-KEY\nAuthorization: Bearer API-TOKEN\n```\n\n### APIキー\nアカウントで1つ発行されます。リクエスト制限はこのAPIキー単位で管理されています。\n\n### APIトークン\n複数発行でき、APIトークンごとに利用可能なエンドポイントを指定できますので、用途に合わせて発行してください。\n\nAPIキー（前述の例の`API-KEY`部分）とAPIトークン（前述の例の`API-TOKEN`部分）は、リクエストヘッダーで指定してください。\n\n※セキュリティーのため、トークンごとに可能な操作は最低限必要なもののみに限定することをお勧めします。\n\nAPIキー・APIトークンの発行は「[開発者用API設定](https://the-board.jp/api_settings)」画面で行えます。当画面の詳しい説明は、ヘルプ「[board APIを利用する](https://the-board.jp/helps/help_common_api)」をご覧ください。\n\n## リクエスト制限\n\nboard APIでは、以下のリクエスト制限があります。制限をオーバーした場合は、ステータス`429 Too Many Requests`が返却されます。\n\n- 3000リクエスト / 1日（リセットタイミングはJSTではなくUTC）\n- 3リクエスト / 秒\n- リスト取得APIの同時リクエスト数は4まで（詳細は後述）\n\n※リクエスト数制限の上限緩和には対応していませんのでご了承ください。\n\n### 制限理由の切り分け\n\n429エラーが発生した場合は、レスポンスボディの `message` にエラー内容が返却されますので、以下の内容を確認してください。\n\n- 秒間リクエスト数の上限を超えた場合：Too Many Requests\n- 1日あたりのリクエスト数の上限を超えた場合：Limit Exceeded\n- リスト取得APIの同時リクエスト数の上限を超えた場合：リスト取得系APIの同時リクエスト数の上限を超えています\n\n### リスト取得APIの同時リクエスト数制限について\n\n以下のリスト取得APIは、データ量が多くレスポンスが返されるまでに一定の時間を要する可能性があります。そのため、「案件No（発注の場合は発注No）」を指定しないリスト取得系APIにおいて、同時リクエスト数（レスポンスが未返却のリクエスト数）が「5」以上になった場合は、`429 Too Many Requests`を返します。\n\n- 案件リスト取得\n- 請求リスト取得\n- 案件原価リスト取得\n- 発注リスト取得\n- 支払リスト取得\n\n※ 現時点では上記のみが対象ですが、今後の状況によっては他のリスト取得APIも対象となる可能性があります。\n\n## データ形式\nリクエストとレスポンスのデータ形式は以下の通りです。なお、データの文字コードはすべてUTF-8です。\n\n### リクエスト\nリクエストのデータ形式は、メソッドによって異なります。\n\nGETリクエストはURLパラメーターで指定します。\n\n```\n/v1/clients?include_archive_flg=1\n```\n\nPOST・PATCHリクエストはリクエストボディーにJSON形式で送信してください。また、リクエストヘッダーに\n\n```\nContent-Type: application/json\n```\n\nを指定してください。\n\nContent-Typeが正しくない場合は、`415 Unsupported Media Type`が返却されます。\n\n### レスポンス\nすべてJSON形式です。\n\n### decimalの項目の型について\n\ndecimal型は、OpenAPIの定義上、以下のようにstringとして定義しています。\n\n```\ntype: string\nformat: decimal\npattern: '^-?\\d+(\\.\\d+)?$'\n```\n\nこの背景としては、JSONにはdecimal型が存在せず、代わりにnumber型を利用すると、JSONの数値を浮動小数点数として扱う環境においては、精度が失われる可能性があるため、精度維持のため上記のようにstringとして定義しています。\n\nなお、OpenAPIの定義上はstringになっていますが、リクエストに関しては、number型で送信しても問題ありません。\n\n## レスポンスグループ\n案件情報のように項目数が多い場合、すべての項目を返却すると、データ量が多く扱いにくくなってしまいます。\n\nそこで、リクエストパラメーターにレスポンスグループを指定し、取得する項目を絞り込むことができます。\n\n```\n/v1/projects?response_group=medium\n```\n\nなお、すべてのリスト取得APIで利用可能なわけではありませんので、利用可否については、各リスト取得APIの仕様を確認してください。クエリーパラメーターに「response_group」がある場合のみ利用可能です。\n\n**【重要】**レスポンスグループが指定可能なエンドポイントの場合、**デフォルトは「small」で最小限の項目のみ含まれる状態**になっています。一方で、APIドキュメント上では定義を示すためにすべての項目を記載していますのでご注意ください。\n\n参考：FAQ「[APIのレスポンスに含まれる項目がドキュメントに記載のものより少ないです](https://the-board.jp/helps/faq_lack_of_rensponse_fileds)」\n\n## HTTPステータス・エラー\nレスポンス内容に応じて、以下のHTTPステータスを返します。\n\n| ステータス | 内容 |\n|:-----------|:------------|\n| 200\t| OK |\n| 201\t| Created |\n| 204\t| No Content |\n| 400\t| Bad Request |\n| 401\t| Unauthorized |\n| 403\t| Forbidden |\n| 404\t| Not Found |\n| 415\t| Unsupported Media Type |\n| 422\t| Unprocessable Entity |\n| 429\t| Too Many Requests |\n| 500\t| Internal Server Error |\n| 503\t| Service Unavailable |\n\n### 主なエラー原因\nエラーとなるAPIリクエストがあった場合、エラー内容を含むレスポンスを返します。\n\nステータス（例：422）で大まかな原因を把握し、詳細なレスポンスボディの例は各APIのレスポンスセクションをご覧ください。\n\n以下、いくつかの特記事項を記載します。\n\n#### 422エラーの場合\n主に、バリデーションチェックに引っかかったケースです。この場合、レスポンスボディにエラー内容が返却されていますので、その内容をご確認ください。\n\n#### 401・403エラーの場合\n401・403エラーの場合、レスポンス内容によっていくつかの原因が考えられます。\n\n詳しくはboard APIファーストガイドの「[APIキー、APIトークンを指定しているのにエラーになります](https://the-board.jp/helps/help_api_first_guide/#api%E3%82%AD%E3%83%BCapi%E3%83%88%E3%83%BC%E3%82%AF%E3%83%B3%E3%82%92%E6%8C%87%E5%AE%9A%E3%81%97%E3%81%A6%E3%81%84%E3%82%8B%E3%81%AE%E3%81%AB%E3%82%A8%E3%83%A9%E3%83%BC%E3%81%AB%E3%81%AA%E3%82%8A%E3%81%BE%E3%81%99)」をご覧ください。\n\n#### 500エラーの場合\nFAQ「[APIで500エラーが返ってきて原因がわかりません](https://the-board.jp/helps/faq_api_reason_of_500_error)」をご覧ください。\n\n#### レスポンスが10MBを超えるサイズの場合\nboard APIはAWS API Gatewayを使用しており、その仕様上、10MBを超えるレスポンスを返すことができません。 この上限を超える場合は、500エラーとなり、レスポンスボディには、以下のようにmessageだけが返ります。この場合は、取得対象を絞る等でご対応ください。\n\n```\n{ \"message\": \"Internal server error\" }\n```\n\n### メンテナンス\nメンテナンス時は、503ステータスを返します。レスポンスボディはメンテナンス内容に依存し変わる可能性があるため、ステータスで判別してください。\n\nなお、障害時も503ステータスが返る可能性があります。\n\n## 必須項目に関する注意事項\n一部のデータについては、画面上の「[必須項目設定](https://the-board.jp/helps/help-required-field-settings/)」にて各アカウントごとに必須項目を設定できます。\n\n当ドキュメントの必須表示（required）はboard標準の必須項目です。そのため、各アカウントで「必須項目設定」を行っている場合は、当ドキュメントの必須項目以外にも必須項目が存在する可能性がありますので、ご注意ください。\n\n## サポート・FAQ\n### ヘルプ・FAQ\nboardのヘルプ・FAQのAPIカテゴリーをご覧ください。\n- [API関連のヘルプ](https://the-board.jp/helps/category/api)\n- [API関連のFAQ](https://the-board.jp/helps/category/faq_api)\n\n### お問い合わせ\nAPIに関するお問い合わせも、通常のサポート窓口で承っております。\n\n[お問い合わせ方法について](https://the-board.jp/helps/help_how_to_contact)\n\n\n### APIに関するお問い合わせのお願い・注意事項\n- APIの仕様に関するご質問には対応可能ですが、APIを使った実装に関する技術的なサポートは提供しておりません。具体的な実装・書き方や特定のツールに関するご質問や確認依頼には対応できませんので、ご了承ください。\n- APIにおいても、基本的な仕様は画面から操作する場合と同様です。APIドキュメントには機能的な仕様は記載されていないため、これについては[boardのヘルプ](https://the-board.jp/helps)をご覧ください。\n- 具体的なリクエスト内容と合わせてお問い合わせいただくとスムーズです。ただし、その際、APIトークン・APIキーは含めないようにお願いいたします。\n",
"x-logo": {
"url": "https://cdn.the-board.jp/images/blog/cc78116ff821af265616.svg",
"altText": "boardロゴ",
"href": "/"
}
},
"servers": [
{
"url": "https://api.the-board.jp/v1"
}
],
"tags": [
{
"name": "client",
"x-displayName": "顧客",
"description": "顧客情報を扱うAPIです。"
},
{
"name": "client_branch",
"x-displayName": "顧客支社",
"description": "顧客支社情報を扱うAPIです。"
},
{
"name": "contact",
"x-displayName": "顧客担当者",
"description": "顧客担当者情報を扱うAPIです。"
},
{
"name": "project",
"x-displayName": "案件",
"description": "案件情報を扱うAPIです。"
},
{
"name": "project_cost",
"x-displayName": "案件原価",
"description": "案件原価情報を扱うAPIです。"
},
{
"name": "invoice",
"x-displayName": "請求",
"description": "請求情報を扱うAPIです。"
},
{
"name": "project_document",
"x-displayName": "書類（案件）",
"description": "案件の書類を扱うAPIです。"
},
{
"name": "payee",
"x-displayName": "発注先",
"description": "発注先情報を扱うAPIです。"
},
{
"name": "payee_branch",
"x-displayName": "発注先支社",
"description": "発注先支社情報を扱うAPIです。"
},
{
"name": "payee_contact",
"x-displayName": "発注先担当者",
"description": "発注先担当者情報を扱うAPIです。"
},
{
"name": "expenditure",
"x-displayName": "発注",
"description": "発注情報を扱うAPIです。"
},
{
"name": "expenditure_payment",
"x-displayName": "支払",
"description": "支払情報を扱うAPIです。"
},
{
"name": "expenditure_document",
"x-displayName": "書類（発注）",
"description": "発注の書類を扱うAPIです。"
},
{
"name": "analysis",
"x-displayName": "計上データ",
"description": "計上データを扱うAPIです。"
},
{
"name": "user",
"x-displayName": "ユーザー（担当者）",
"description": "ユーザー（担当者）を扱うAPIです。"
},
{
"name": "group",
"x-displayName": "グループ",
"description": "グループを扱うAPIです。"
},
{
"name": "payment_term",
"x-displayName": "支払条件",
"description": "支払条件を扱うAPIです。"
},
{
"name": "project_type",
"x-displayName": "案件区分",
"description": "案件区分を扱うAPIです。"
},
{
"name": "expenditure_type",
"x-displayName": "発注区分",
"description": "発注区分を扱うAPIです。"
},
{
"name": "accounting_type",
"x-displayName": "会計区分",
"description": "会計区分を扱うAPIです。"
},
{
"name": "document_send_channel",
"x-displayName": "カスタム書類送付方法",
"description": "カスタム書類送付方法を扱うAPIです。"
}
],
"paths": {
"/clients": {
"get": {
"tags": [
"client"
],
"summary": "顧客リスト取得",
"description": "顧客リストを取得します。",
"operationId": "getClients",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "name_cont",
"in": "query",
"description": "顧客名（部分一致）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプル株式会社"
}
},
{
"name": "name_disp_cont",
"in": "query",
"description": "顧客略称名（部分一致）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプル"
}
},
{
"name": "invoice_system_number_eq",
"in": "query",
"description": "適格請求書発行事業者の登録番号",
"schema": {
"type": "string",
"example": "T1234567890123"
}
},
{
"name": "tags[]",
"in": "query",
"description": "タグ（複数の場合はカンマ区切り）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプルタグA,サンプルタグB"
}
},
{
"name": "include_archive_flg",
"in": "query",
"description": "アーカイブを含むか\n\n- 0：アーカイブ済みは除く\n- 1：アーカイブ済みも含む\n",
"schema": {
"type": "integer",
"default": 0,
"example": 1,
"enum": [
0,
1
]
}
},
{
"name": "updated_at_gteq",
"in": "query",
"description": "更新日時（指定日時以降）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "updated_at_lteq",
"in": "query",
"description": "更新日時（指定日時以前）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "custom_no_eq",
"in": "query",
"description": "顧客番号",
"schema": {
"type": "string",
"example": "12345"
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
{
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
},
{
"name": "response_group",
"in": "query",
"description": "レスポンスグループ\n\n| response_group | 項目 |\n|:-----------|:------------|\n| small | id, name, name_disp, title, zip, pref, address1, address2, tel, fax, payment_term_id, payment_term_name, company_number, invoice_system_number, invoice_system_number_validated, invoice_system_issuer_type, invoice_system_issuer_type_name, created_at, updated_at |\n| large | すべての項目 |\n",
"schema": {
"type": "string",
"default": "small",
"example": "large",
"enum": [
"small",
"large"
],
"externalDocs": {
"description": "※レスポンスグループについて",
"url": "#section/レスポンスグループ"
}
}
}
],
"responses": {
"200": {
"description": "成功",
"headers": {
"X-Total-Count": {
"description": "トータル件数",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Page": {
"description": "現在のページ番号",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Per-Page": {
"description": "1ページあたりの件数",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"allOf": [
{
"description": "顧客関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "顧客ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"properties": {
"title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"default": "御中",
"example": "御中"
},
"payment_term_id": {
"description": "デフォルト支払条件ID\n\n- 新規登録時に未指定の場合は最初の支払条件が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "デフォルト支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"nda_flg": {
"description": "NDA締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"basic_agreement_flg": {
"description": "基本契約書締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"document_send_type": {
"description": "書類送付方法\n\n- 1：メール(DL)\n- 2：郵送\n- 3：メール(DL)+郵送\n- 4：メール(添付)\n- 5：メール(添付)+郵送\n- または[カスタム書類送付方法](#tag/document_send_channel/operation/getDocumentSendChannels)のID\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1
},
"document_send_type_name": {
"type": "string",
"description": "書類送付方法名",
"example": "メール(DL)",
"readOnly": true
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"wareki_flg": {
"description": "デフォルト和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_number": {
"type": "string",
"description": "法人番号",
"minLength": 13,
"maxLength": 13,
"example": "1234567890123"
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード\n\n※「会計連携機能」機能有効時のみ\n",
"maxLength": 100,
"example": "サンプル（株）"
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"invoice_system_number": {
"type": "string",
"description": "適格請求書発行事業者の登録番号",
"minLength": 14,
"maxLength": 14,
"example": "T1234567890123"
},
"invoice_system_number_validated": {
"type": "boolean",
"description": "登録番号のチェック状況",
"example": true,
"readOnly": true
},
"invoice_system_issuer_type": {
"description": "適格請求書発行事業者\n\n- 0：未設定\n- 1：該当する\n- 2：該当しない\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1,
2
]
},
"invoice_system_issuer_type_name": {
"type": "string",
"description": "適格請求書発行事業者の名称",
"example": "未設定",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"bank_charge_to_client_flg": {
"description": "振込手数料負担\n\n- 0：当方\n- 1：先方\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
},
"company_bank_id": {
"description": "デフォルト振込口座ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"company_bank_name": {
"type": "string",
"description": "デフォルト振込口座（銀行名 支店名）",
"maxLength": 100,
"example": "サンプル銀行 サンプル支店",
"readOnly": true
},
"name_en": {
"type": "string",
"description": "顧客名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
}
}
},
{
"properties": {
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": "81"
},
"currency": {
"type": "string",
"description": "デフォルト通貨\n\n※英語アドオン有効時のみ\n",
"maxLength": 3,
"default": "JPY",
"example": "USD",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"description": "デフォルト言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "デフォルト言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/clients' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
},
"post": {
"tags": [
"client"
],
"summary": "顧客登録",
"description": "顧客を新規登録します。",
"operationId": "postClient",
"security": [
{
"api_token": [],
"api_key": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"name",
"name_disp"
],
"allOf": [
{
"description": "顧客関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "顧客ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"properties": {
"title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"default": "御中",
"example": "御中"
},
"payment_term_id": {
"description": "デフォルト支払条件ID\n\n- 新規登録時に未指定の場合は最初の支払条件が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "デフォルト支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"nda_flg": {
"description": "NDA締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"basic_agreement_flg": {
"description": "基本契約書締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"document_send_type": {
"description": "書類送付方法\n\n- 1：メール(DL)\n- 2：郵送\n- 3：メール(DL)+郵送\n- 4：メール(添付)\n- 5：メール(添付)+郵送\n- または[カスタム書類送付方法](#tag/document_send_channel/operation/getDocumentSendChannels)のID\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1
},
"document_send_type_name": {
"type": "string",
"description": "書類送付方法名",
"example": "メール(DL)",
"readOnly": true
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"wareki_flg": {
"description": "デフォルト和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_number": {
"type": "string",
"description": "法人番号",
"minLength": 13,
"maxLength": 13,
"example": "1234567890123"
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード\n\n※「会計連携機能」機能有効時のみ\n",
"maxLength": 100,
"example": "サンプル（株）"
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"invoice_system_number": {
"type": "string",
"description": "適格請求書発行事業者の登録番号",
"minLength": 14,
"maxLength": 14,
"example": "T1234567890123"
},
"invoice_system_number_validated": {
"type": "boolean",
"description": "登録番号のチェック状況",
"example": true,
"readOnly": true
},
"invoice_system_issuer_type": {
"description": "適格請求書発行事業者\n\n- 0：未設定\n- 1：該当する\n- 2：該当しない\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1,
2
]
},
"invoice_system_issuer_type_name": {
"type": "string",
"description": "適格請求書発行事業者の名称",
"example": "未設定",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"bank_charge_to_client_flg": {
"description": "振込手数料負担\n\n- 0：当方\n- 1：先方\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
},
"company_bank_id": {
"description": "デフォルト振込口座ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"company_bank_name": {
"type": "string",
"description": "デフォルト振込口座（銀行名 支店名）",
"maxLength": 100,
"example": "サンプル銀行 サンプル支店",
"readOnly": true
},
"name_en": {
"type": "string",
"description": "顧客名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
}
}
},
{
"properties": {
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": "81"
},
"currency": {
"type": "string",
"description": "デフォルト通貨\n\n※英語アドオン有効時のみ\n",
"maxLength": 3,
"default": "JPY",
"example": "USD",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"description": "デフォルト言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "デフォルト言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "登録成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "顧客関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "顧客ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"properties": {
"title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"default": "御中",
"example": "御中"
},
"payment_term_id": {
"description": "デフォルト支払条件ID\n\n- 新規登録時に未指定の場合は最初の支払条件が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "デフォルト支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"nda_flg": {
"description": "NDA締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"basic_agreement_flg": {
"description": "基本契約書締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"document_send_type": {
"description": "書類送付方法\n\n- 1：メール(DL)\n- 2：郵送\n- 3：メール(DL)+郵送\n- 4：メール(添付)\n- 5：メール(添付)+郵送\n- または[カスタム書類送付方法](#tag/document_send_channel/operation/getDocumentSendChannels)のID\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1
},
"document_send_type_name": {
"type": "string",
"description": "書類送付方法名",
"example": "メール(DL)",
"readOnly": true
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"wareki_flg": {
"description": "デフォルト和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_number": {
"type": "string",
"description": "法人番号",
"minLength": 13,
"maxLength": 13,
"example": "1234567890123"
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード\n\n※「会計連携機能」機能有効時のみ\n",
"maxLength": 100,
"example": "サンプル（株）"
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"invoice_system_number": {
"type": "string",
"description": "適格請求書発行事業者の登録番号",
"minLength": 14,
"maxLength": 14,
"example": "T1234567890123"
},
"invoice_system_number_validated": {
"type": "boolean",
"description": "登録番号のチェック状況",
"example": true,
"readOnly": true
},
"invoice_system_issuer_type": {
"description": "適格請求書発行事業者\n\n- 0：未設定\n- 1：該当する\n- 2：該当しない\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1,
2
]
},
"invoice_system_issuer_type_name": {
"type": "string",
"description": "適格請求書発行事業者の名称",
"example": "未設定",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"bank_charge_to_client_flg": {
"description": "振込手数料負担\n\n- 0：当方\n- 1：先方\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
},
"company_bank_id": {
"description": "デフォルト振込口座ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"company_bank_name": {
"type": "string",
"description": "デフォルト振込口座（銀行名 支店名）",
"maxLength": 100,
"example": "サンプル銀行 サンプル支店",
"readOnly": true
},
"name_en": {
"type": "string",
"description": "顧客名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
}
}
},
{
"properties": {
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": "81"
},
"currency": {
"type": "string",
"description": "デフォルト通貨\n\n※英語アドオン有効時のみ\n",
"maxLength": 3,
"default": "JPY",
"example": "USD",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"description": "デフォルト言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "デフォルト言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/clients' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"name\": \"サンプル株式会社\",\n \"name_disp\": \"サンプル\"\n}'"
}
]
}
},
"/clients/{id}": {
"patch": {
"tags": [
"client"
],
"summary": "顧客更新",
"description": "ID指定で顧客を更新します。",
"operationId": "patchClient",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "顧客関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "顧客ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"properties": {
"title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"default": "御中",
"example": "御中"
},
"payment_term_id": {
"description": "デフォルト支払条件ID\n\n- 新規登録時に未指定の場合は最初の支払条件が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "デフォルト支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"nda_flg": {
"description": "NDA締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"basic_agreement_flg": {
"description": "基本契約書締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"document_send_type": {
"description": "書類送付方法\n\n- 1：メール(DL)\n- 2：郵送\n- 3：メール(DL)+郵送\n- 4：メール(添付)\n- 5：メール(添付)+郵送\n- または[カスタム書類送付方法](#tag/document_send_channel/operation/getDocumentSendChannels)のID\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1
},
"document_send_type_name": {
"type": "string",
"description": "書類送付方法名",
"example": "メール(DL)",
"readOnly": true
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"wareki_flg": {
"description": "デフォルト和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_number": {
"type": "string",
"description": "法人番号",
"minLength": 13,
"maxLength": 13,
"example": "1234567890123"
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード\n\n※「会計連携機能」機能有効時のみ\n",
"maxLength": 100,
"example": "サンプル（株）"
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"invoice_system_number": {
"type": "string",
"description": "適格請求書発行事業者の登録番号",
"minLength": 14,
"maxLength": 14,
"example": "T1234567890123"
},
"invoice_system_number_validated": {
"type": "boolean",
"description": "登録番号のチェック状況",
"example": true,
"readOnly": true
},
"invoice_system_issuer_type": {
"description": "適格請求書発行事業者\n\n- 0：未設定\n- 1：該当する\n- 2：該当しない\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1,
2
]
},
"invoice_system_issuer_type_name": {
"type": "string",
"description": "適格請求書発行事業者の名称",
"example": "未設定",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"bank_charge_to_client_flg": {
"description": "振込手数料負担\n\n- 0：当方\n- 1：先方\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
},
"company_bank_id": {
"description": "デフォルト振込口座ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"company_bank_name": {
"type": "string",
"description": "デフォルト振込口座（銀行名 支店名）",
"maxLength": 100,
"example": "サンプル銀行 サンプル支店",
"readOnly": true
},
"name_en": {
"type": "string",
"description": "顧客名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
}
}
},
{
"properties": {
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": "81"
},
"currency": {
"type": "string",
"description": "デフォルト通貨\n\n※英語アドオン有効時のみ\n",
"maxLength": 3,
"default": "JPY",
"example": "USD",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"description": "デフォルト言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "デフォルト言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "顧客関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "顧客ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"properties": {
"title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"default": "御中",
"example": "御中"
},
"payment_term_id": {
"description": "デフォルト支払条件ID\n\n- 新規登録時に未指定の場合は最初の支払条件が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "デフォルト支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"nda_flg": {
"description": "NDA締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"basic_agreement_flg": {
"description": "基本契約書締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"document_send_type": {
"description": "書類送付方法\n\n- 1：メール(DL)\n- 2：郵送\n- 3：メール(DL)+郵送\n- 4：メール(添付)\n- 5：メール(添付)+郵送\n- または[カスタム書類送付方法](#tag/document_send_channel/operation/getDocumentSendChannels)のID\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1
},
"document_send_type_name": {
"type": "string",
"description": "書類送付方法名",
"example": "メール(DL)",
"readOnly": true
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"wareki_flg": {
"description": "デフォルト和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_number": {
"type": "string",
"description": "法人番号",
"minLength": 13,
"maxLength": 13,
"example": "1234567890123"
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード\n\n※「会計連携機能」機能有効時のみ\n",
"maxLength": 100,
"example": "サンプル（株）"
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"invoice_system_number": {
"type": "string",
"description": "適格請求書発行事業者の登録番号",
"minLength": 14,
"maxLength": 14,
"example": "T1234567890123"
},
"invoice_system_number_validated": {
"type": "boolean",
"description": "登録番号のチェック状況",
"example": true,
"readOnly": true
},
"invoice_system_issuer_type": {
"description": "適格請求書発行事業者\n\n- 0：未設定\n- 1：該当する\n- 2：該当しない\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1,
2
]
},
"invoice_system_issuer_type_name": {
"type": "string",
"description": "適格請求書発行事業者の名称",
"example": "未設定",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"bank_charge_to_client_flg": {
"description": "振込手数料負担\n\n- 0：当方\n- 1：先方\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
},
"company_bank_id": {
"description": "デフォルト振込口座ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"company_bank_name": {
"type": "string",
"description": "デフォルト振込口座（銀行名 支店名）",
"maxLength": 100,
"example": "サンプル銀行 サンプル支店",
"readOnly": true
},
"name_en": {
"type": "string",
"description": "顧客名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
}
}
},
{
"properties": {
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": "81"
},
"currency": {
"type": "string",
"description": "デフォルト通貨\n\n※英語アドオン有効時のみ\n",
"maxLength": 3,
"default": "JPY",
"example": "USD",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"description": "デフォルト言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "デフォルト言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/clients/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"name\": \"更新サンプル株式会社\"\n}'"
}
]
},
"delete": {
"tags": [
"client"
],
"summary": "顧客削除",
"description": "ID指定で顧客を削除します。",
"operationId": "deleteClient",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "削除成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request DELETE 'https://api.the-board.jp/v1/clients/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'\n"
}
]
},
"get": {
"tags": [
"client"
],
"summary": "顧客取得",
"description": "ID指定で顧客を取得します。",
"operationId": "getClient",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "顧客関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "顧客ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"properties": {
"title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"default": "御中",
"example": "御中"
},
"payment_term_id": {
"description": "デフォルト支払条件ID\n\n- 新規登録時に未指定の場合は最初の支払条件が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "デフォルト支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"nda_flg": {
"description": "NDA締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"basic_agreement_flg": {
"description": "基本契約書締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"document_send_type": {
"description": "書類送付方法\n\n- 1：メール(DL)\n- 2：郵送\n- 3：メール(DL)+郵送\n- 4：メール(添付)\n- 5：メール(添付)+郵送\n- または[カスタム書類送付方法](#tag/document_send_channel/operation/getDocumentSendChannels)のID\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1
},
"document_send_type_name": {
"type": "string",
"description": "書類送付方法名",
"example": "メール(DL)",
"readOnly": true
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"wareki_flg": {
"description": "デフォルト和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_number": {
"type": "string",
"description": "法人番号",
"minLength": 13,
"maxLength": 13,
"example": "1234567890123"
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード\n\n※「会計連携機能」機能有効時のみ\n",
"maxLength": 100,
"example": "サンプル（株）"
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"invoice_system_number": {
"type": "string",
"description": "適格請求書発行事業者の登録番号",
"minLength": 14,
"maxLength": 14,
"example": "T1234567890123"
},
"invoice_system_number_validated": {
"type": "boolean",
"description": "登録番号のチェック状況",
"example": true,
"readOnly": true
},
"invoice_system_issuer_type": {
"description": "適格請求書発行事業者\n\n- 0：未設定\n- 1：該当する\n- 2：該当しない\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1,
2
]
},
"invoice_system_issuer_type_name": {
"type": "string",
"description": "適格請求書発行事業者の名称",
"example": "未設定",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"bank_charge_to_client_flg": {
"description": "振込手数料負担\n\n- 0：当方\n- 1：先方\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
},
"company_bank_id": {
"description": "デフォルト振込口座ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"company_bank_name": {
"type": "string",
"description": "デフォルト振込口座（銀行名 支店名）",
"maxLength": 100,
"example": "サンプル銀行 サンプル支店",
"readOnly": true
},
"name_en": {
"type": "string",
"description": "顧客名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
}
}
},
{
"properties": {
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": "81"
},
"currency": {
"type": "string",
"description": "デフォルト通貨\n\n※英語アドオン有効時のみ\n",
"maxLength": 3,
"default": "JPY",
"example": "USD",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"description": "デフォルト言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "デフォルト言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/clients/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/client_branches": {
"get": {
"tags": [
"client_branch"
],
"summary": "顧客支社リスト取得",
"description": "顧客支社リストを取得します。",
"operationId": "getClientBranches",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "client_id_eq",
"in": "query",
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"schema": {
"type": "integer",
"example": 123456
}
},
{
"name": "include_archive_flg",
"in": "query",
"description": "アーカイブを含むか\n\n- 0：アーカイブ済みは除く\n- 1：アーカイブ済みも含む\n",
"schema": {
"type": "integer",
"default": 0,
"example": 1,
"enum": [
0,
1
]
}
},
{
"name": "updated_at_gteq",
"in": "query",
"description": "更新日時（指定日時以降）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "updated_at_lteq",
"in": "query",
"description": "更新日時（指定日時以前）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
{
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
}
],
"responses": {
"200": {
"description": "成功",
"headers": {
"X-Total-Count": {
"description": "トータル件数",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Page": {
"description": "現在のページ番号",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Per-Page": {
"description": "1ページあたりの件数",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"allOf": [
{
"description": "顧客支社関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "顧客支社ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"type": "object",
"properties": {
"name_en": {
"type": "string",
"description": "顧客支社名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
},
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": 81
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/client_branches' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
},
"post": {
"tags": [
"client_branch"
],
"summary": "顧客支社登録",
"description": "顧客支社を新規登録します。",
"operationId": "postClientBranch",
"security": [
{
"api_token": [],
"api_key": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"client_id",
"name"
],
"allOf": [
{
"description": "顧客支社関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "顧客支社ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"type": "object",
"properties": {
"name_en": {
"type": "string",
"description": "顧客支社名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
},
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": 81
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "登録成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "顧客支社関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "顧客支社ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"type": "object",
"properties": {
"name_en": {
"type": "string",
"description": "顧客支社名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
},
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": 81
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/client_branches' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"client_id\": 123456,\n \"name\": \"サンプル支社\"\n}'"
}
]
}
},
"/client_branches/{id}": {
"patch": {
"tags": [
"client_branch"
],
"summary": "顧客支社更新",
"description": "ID指定で顧客支社を更新します。",
"operationId": "patchClientBranch",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "顧客支社ID\n\n※[顧客支社登録API](#tag/client_branch/operation/postClientBranch)・[顧客支社リスト取得API](#tag/client_branch/operation/getClientBranches)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "顧客支社関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "顧客支社ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"type": "object",
"properties": {
"name_en": {
"type": "string",
"description": "顧客支社名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
},
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": 81
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "顧客支社関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "顧客支社ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"type": "object",
"properties": {
"name_en": {
"type": "string",
"description": "顧客支社名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
},
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": 81
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/client_branches/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"name\": \"更新サンプル支社\"\n}'"
}
]
},
"delete": {
"tags": [
"client_branch"
],
"summary": "顧客支社削除",
"description": "ID指定で顧客支社を削除します。",
"operationId": "deleteClientBranch",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "顧客支社ID\n\n※[顧客支社登録API](#tag/client_branch/operation/postClientBranch)・[顧客支社リスト取得API](#tag/client_branch/operation/getClientBranches)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "削除成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request DELETE 'https://api.the-board.jp/v1/client_branches/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'\n"
}
]
},
"get": {
"tags": [
"client_branch"
],
"summary": "顧客支社取得",
"description": "ID指定で顧客支社を取得します。",
"operationId": "getClientBranch",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "顧客支社ID\n\n※[顧客支社登録API](#tag/client_branch/operation/postClientBranch)・[顧客支社リスト取得API](#tag/client_branch/operation/getClientBranches)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "顧客支社関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "顧客支社ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"type": "object",
"properties": {
"name_en": {
"type": "string",
"description": "顧客支社名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
},
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": 81
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/client_branches/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/contacts": {
"get": {
"tags": [
"contact"
],
"summary": "顧客担当者リスト取得",
"description": "顧客担当者リストを取得します。",
"operationId": "getContacts",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "client_id_eq",
"in": "query",
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"schema": {
"type": "integer",
"example": 123456
}
},
{
"name": "include_archive_flg",
"in": "query",
"description": "アーカイブを含むか\n\n- 0：アーカイブ済みは除く\n- 1：アーカイブ済みも含む\n",
"schema": {
"type": "integer",
"default": 0,
"example": 1,
"enum": [
0,
1
]
}
},
{
"name": "updated_at_gteq",
"in": "query",
"description": "更新日時（指定日時以降）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "updated_at_lteq",
"in": "query",
"description": "更新日時（指定日時以前）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
{
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
}
],
"responses": {
"200": {
"description": "成功",
"headers": {
"X-Total-Count": {
"description": "トータル件数",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Page": {
"description": "現在のページ番号",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Per-Page": {
"description": "1ページあたりの件数",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"description": "顧客担当者ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎"
},
"honorific_title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"example": "様"
},
"title": {
"type": "string",
"description": "肩書",
"maxLength": 50,
"example": "部長"
},
"department": {
"type": "string",
"description": "部署",
"maxLength": 50,
"example": "システム部"
},
"email": {
"type": "string",
"description": "email",
"maxLength": 100,
"example": "yamada@example.com"
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"last_name_en": {
"type": "string",
"description": "姓（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Yamada"
},
"first_name_en": {
"type": "string",
"description": "名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Taro"
},
"prefix_en": {
"type": "string",
"description": "敬称（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Mr."
},
"title_en": {
"type": "string",
"description": "肩書（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Manager"
},
"department_en": {
"type": "string",
"description": "部署（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "IT Dept."
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/contacts' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
},
"post": {
"tags": [
"contact"
],
"summary": "顧客担当者登録",
"description": "顧客担当者を新規登録します。",
"operationId": "postContact",
"security": [
{
"api_token": [],
"api_key": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "顧客担当者関連の定義情報",
"required": [
"client_id",
"last_name"
],
"properties": {
"id": {
"description": "顧客担当者ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎"
},
"honorific_title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"example": "様"
},
"title": {
"type": "string",
"description": "肩書",
"maxLength": 50,
"example": "部長"
},
"department": {
"type": "string",
"description": "部署",
"maxLength": 50,
"example": "システム部"
},
"email": {
"type": "string",
"description": "email",
"maxLength": 100,
"example": "yamada@example.com"
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"last_name_en": {
"type": "string",
"description": "姓（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Yamada"
},
"first_name_en": {
"type": "string",
"description": "名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Taro"
},
"prefix_en": {
"type": "string",
"description": "敬称（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Mr."
},
"title_en": {
"type": "string",
"description": "肩書（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Manager"
},
"department_en": {
"type": "string",
"description": "部署（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "IT Dept."
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "登録成功",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "顧客担当者ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎"
},
"honorific_title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"example": "様"
},
"title": {
"type": "string",
"description": "肩書",
"maxLength": 50,
"example": "部長"
},
"department": {
"type": "string",
"description": "部署",
"maxLength": 50,
"example": "システム部"
},
"email": {
"type": "string",
"description": "email",
"maxLength": 100,
"example": "yamada@example.com"
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"last_name_en": {
"type": "string",
"description": "姓（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Yamada"
},
"first_name_en": {
"type": "string",
"description": "名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Taro"
},
"prefix_en": {
"type": "string",
"description": "敬称（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Mr."
},
"title_en": {
"type": "string",
"description": "肩書（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Manager"
},
"department_en": {
"type": "string",
"description": "部署（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "IT Dept."
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/contacts' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"client_id\": 123456,\n \"last_name\": \"山田\",\n \"first_name\": \"太郎\"\n}'"
}
]
}
},
"/contacts/{id}": {
"patch": {
"tags": [
"contact"
],
"summary": "顧客担当者更新",
"description": "ID指定で顧客担当者を更新します。",
"operationId": "patchContact",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "顧客担当者ID\n\n※[顧客担当者登録API](#tag/contact/operation/postContact)・[顧客担当者リスト取得API](#tag/contact/operation/getContacts)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "顧客担当者関連の定義情報",
"properties": {
"id": {
"description": "顧客担当者ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎"
},
"honorific_title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"example": "様"
},
"title": {
"type": "string",
"description": "肩書",
"maxLength": 50,
"example": "部長"
},
"department": {
"type": "string",
"description": "部署",
"maxLength": 50,
"example": "システム部"
},
"email": {
"type": "string",
"description": "email",
"maxLength": 100,
"example": "yamada@example.com"
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"last_name_en": {
"type": "string",
"description": "姓（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Yamada"
},
"first_name_en": {
"type": "string",
"description": "名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Taro"
},
"prefix_en": {
"type": "string",
"description": "敬称（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Mr."
},
"title_en": {
"type": "string",
"description": "肩書（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Manager"
},
"department_en": {
"type": "string",
"description": "部署（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "IT Dept."
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "顧客担当者ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎"
},
"honorific_title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"example": "様"
},
"title": {
"type": "string",
"description": "肩書",
"maxLength": 50,
"example": "部長"
},
"department": {
"type": "string",
"description": "部署",
"maxLength": 50,
"example": "システム部"
},
"email": {
"type": "string",
"description": "email",
"maxLength": 100,
"example": "yamada@example.com"
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"last_name_en": {
"type": "string",
"description": "姓（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Yamada"
},
"first_name_en": {
"type": "string",
"description": "名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Taro"
},
"prefix_en": {
"type": "string",
"description": "敬称（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Mr."
},
"title_en": {
"type": "string",
"description": "肩書（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Manager"
},
"department_en": {
"type": "string",
"description": "部署（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "IT Dept."
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/contacts/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"first_name\": \"次郎\"\n}'"
}
]
},
"delete": {
"tags": [
"contact"
],
"summary": "顧客担当者削除",
"description": "ID指定で顧客担当者を削除します。",
"operationId": "deleteContact",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "顧客担当者ID\n\n※[顧客担当者登録API](#tag/contact/operation/postContact)・[顧客担当者リスト取得API](#tag/contact/operation/getContacts)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "削除成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request DELETE 'https://api.the-board.jp/v1/contacts/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'\n"
}
]
},
"get": {
"tags": [
"contact"
],
"summary": "顧客担当者取得",
"description": "ID指定で顧客担当者を取得します。",
"operationId": "getContact",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "顧客担当者ID\n\n※[顧客担当者登録API](#tag/contact/operation/postContact)・[顧客担当者リスト取得API](#tag/contact/operation/getContacts)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "顧客担当者ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎"
},
"honorific_title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"example": "様"
},
"title": {
"type": "string",
"description": "肩書",
"maxLength": 50,
"example": "部長"
},
"department": {
"type": "string",
"description": "部署",
"maxLength": 50,
"example": "システム部"
},
"email": {
"type": "string",
"description": "email",
"maxLength": 100,
"example": "yamada@example.com"
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"last_name_en": {
"type": "string",
"description": "姓（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Yamada"
},
"first_name_en": {
"type": "string",
"description": "名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Taro"
},
"prefix_en": {
"type": "string",
"description": "敬称（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Mr."
},
"title_en": {
"type": "string",
"description": "肩書（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Manager"
},
"department_en": {
"type": "string",
"description": "部署（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "IT Dept."
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/contacts/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/projects": {
"get": {
"tags": [
"project"
],
"summary": "案件リスト取得",
"description": "案件リストを取得します。取得結果は新しい順で取得されます。",
"operationId": "getProjects",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "name_cont",
"in": "query",
"description": "案件名（部分一致）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプル案件"
}
},
{
"name": "client_id_eq",
"in": "query",
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"schema": {
"type": "integer",
"example": 123456
}
},
{
"name": "client_name_cont",
"in": "query",
"description": "顧客名（部分一致）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプル株式会社"
}
},
{
"name": "client_name_disp_cont",
"in": "query",
"description": "顧客略称名（部分一致）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプル"
}
},
{
"name": "order_status_in[]",
"in": "query",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n\n※複数の場合はカンマ区切り\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "4,5"
}
},
{
"name": "delivery_status_in[]",
"in": "query",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n\n※複数の場合はカンマ区切り\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "1,2"
}
},
{
"name": "project_no_eq",
"in": "query",
"description": "案件No",
"schema": {
"type": "integer",
"example": 1001
}
},
{
"name": "management_no_eq",
"in": "query",
"description": "管理番号",
"schema": {
"type": "string",
"example": "SAMPLE0001"
}
},
{
"name": "delivery_date_gteq",
"in": "query",
"description": "納期（指定日時以降）",
"schema": {
"type": "string",
"format": "date",
"example": "2026-03-01"
}
},
{
"name": "delivery_date_lteq",
"in": "query",
"description": "納期（指定日時以前）",
"schema": {
"type": "string",
"format": "date",
"example": "2026-03-31"
}
},
{
"name": "invoice_date_gteq",
"in": "query",
"description": "請求日（指定日時以降）",
"schema": {
"type": "string",
"format": "date",
"example": "2026-03-01"
}
},
{
"name": "invoice_date_lteq",
"in": "query",
"description": "請求日（指定日時以前）",
"schema": {
"type": "string",
"format": "date",
"example": "2026-03-31"
}
},
{
"name": "invoice_timing_kbn_in[]",
"in": "query",
"description": "請求タイミング\n\n- 1：一括請求\n- 2：定期請求\n- 3：分割請求\n\n※複数の場合はカンマ区切り\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "1,2"
}
},
{
"name": "tags[]",
"in": "query",
"description": "タグ（OR条件、複数の場合はカンマ区切り）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプルタグA,サンプルタグB"
}
},
{
"name": "created_at_gteq",
"in": "query",
"description": "作成日時（指定日時以降）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "created_at_lteq",
"in": "query",
"description": "作成日時（指定日時以前）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "updated_at_gteq",
"in": "query",
"description": "更新日時（指定日時以降）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "updated_at_lteq",
"in": "query",
"description": "更新日時（指定日時以前）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "include_lost_flg",
"in": "query",
"description": "失注を含むか\n\n- 0：失注は除く\n- 1：失注も含む\n",
"schema": {
"type": "integer",
"default": 0,
"example": 1
}
},
{
"name": "include_archive_flg",
"in": "query",
"description": "アーカイブを含むか\n\n- 0：アーカイブ済みは除く\n- 1：アーカイブ済みも含む\n",
"schema": {
"type": "integer",
"default": 0,
"example": 1,
"enum": [
0,
1
]
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
{
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
},
{
"name": "response_group",
"in": "query",
"description": "レスポンスグループ\n\n| response_group | 項目 |\n|:-----------|:------------|\n| small | id, project_no, management_no, name, client, contact, user, total, tax, estimate_date, invoice_dates, order_status, order_status_name, project_type_id, project_type_name, project_type2_id, project_type2_name, project_type3_id, project_type3_name, delivery_status, delivery_status_name, group_id, group_name, currency, created_at, updated_at |\n| medium | smallに加え以下の項目
client_branch, company_branch, cost_total, cost_tax, invoice_total, invoice_tax, delivery_date, payment_term_id, payment_term_name, invoice_timing_kbn, invoice_timing_kbn_name, contract_start_date, contract_end_date, periodical_invoice_interval, periodical_invoice_payment_kbn, contract_end_alert_flg, auto_renewal_flg, auto_renewal_period_month, monthly_invoice_payment_kbn, delivery_document_kbn, tags, ordered_date, exchange_rate, total_jpy, tax_jpy, invoice_total_jpy, invoice_tax_jpy |\n| large | 書類以外すべての項目 |\n| estimate | small + 見積書 |\n| order | small + 発注書 |\n| delivery | small + 納品書 |\n| invoice | small + 請求書 |\n| receipt | small + 領収書 |\n| project_cost | small + 案件原価 |\n| all | large + すべての書類 |\n",
"schema": {
"type": "string",
"default": "small",
"example": "large",
"enum": [
"small",
"medium",
"large",
"estimate",
"order",
"delivery",
"invoice",
"receipt",
"project_cost",
"all"
],
"externalDocs": {
"description": "※レスポンスグループについて",
"url": "#section/レスポンスグループ"
}
}
}
],
"responses": {
"200": {
"description": "成功",
"headers": {
"X-Total-Count": {
"description": "トータル件数",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Page": {
"description": "現在のページ番号",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Per-Page": {
"description": "1ページあたりの件数",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"allOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "案件ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"client_branch_id": {
"description": "顧客支社ID\n\n※[顧客支社登録API](#tag/client_branch/operation/postClientBranch)・[顧客支社リスト取得API](#tag/client_branch/operation/getClientBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client_branch": {
"description": "顧客支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"client_name_disp_kbn": {
"type": "integer",
"description": "顧客支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_disp_kbn_name": {
"type": "string",
"description": "顧客支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"client_name_for_post_disp_kbn": {
"type": "integer",
"description": "顧客支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_for_post_disp_kbn_name": {
"type": "string",
"description": "顧客支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"contact_id": {
"description": "顧客担当者ID\n\n※[顧客担当者登録API](#tag/contact/operation/postContact)・[顧客担当者リスト取得API](#tag/contact/operation/getContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"contact": {
"description": "顧客担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "顧客担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "顧客担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"cost_total": {
"type": "integer",
"format": "int32",
"description": "原価",
"example": 10000,
"readOnly": true
},
"cost_tax": {
"type": "integer",
"format": "int32",
"description": "原価の消費税",
"example": 1000,
"readOnly": true
},
"invoice_total": {
"type": "string",
"description": "請求額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"invoice_tax": {
"type": "string",
"description": "請求額の消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"estimate_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "見積日\n\n※新規登録時に未指定の場合は、本日の日付がセットされます\n",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期\n",
"example": "2023-10-20"
},
"delivery_date_text": {
"type": "string",
"maxLength": 50,
"description": "納期テキスト\n",
"example": "サンプル納期"
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"order_status": {
"type": "integer",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"order_status_name": {
"type": "string",
"description": "受注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"invoice_timing_kbn": {
"type": "integer",
"description": "請求タイミング\n\n- 1：一括請求\n- 2：定期請求\n- 3：分割請求\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"invoice_timing_kbn_name": {
"type": "string",
"description": "請求タイミングの名称",
"example": "一括請求",
"readOnly": true
},
"project_type_id": {
"type": "integer",
"description": "案件区分1ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type_name": {
"type": "string",
"description": "案件区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"project_type2_id": {
"type": "integer",
"description": "案件区分2ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type2_name": {
"type": "string",
"description": "案件区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"project_type3_id": {
"type": "integer",
"description": "案件区分3ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type3_name": {
"type": "string",
"description": "案件区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"ordered_date": {
"type": "string",
"description": "受注日",
"format": "YYYY-MM-DD",
"example": "2023-10-05"
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"project_costs": {
"description": "案件原価",
"readOnly": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"cost": {
"type": "integer",
"format": "int64",
"description": "金額",
"example": 10000
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル費用"
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-10"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-10"
}
}
}
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"format": "int64",
"description": "見積金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"format": "int32",
"description": "見積金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"invoice_total_jpy": {
"type": "integer",
"format": "int64",
"description": "請求金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"invoice_tax_jpy": {
"type": "integer",
"format": "int32",
"description": "請求金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"hubspot": {
"description": "HubSpotと連携している場合は、その連携情報",
"readOnly": true,
"type": "object",
"properties": {
"hubspot_deal_id": {
"type": "string",
"description": "HubSpotの取引ID",
"example": "123456"
}
}
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"title": "一括請求",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括請求用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
}
}
}
]
},
{
"title": "定期請求",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期請求用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期請求用\n",
"example": "2023-12-31"
},
"periodical_invoice_interval": {
"type": "integer",
"description": "請求間隔\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_invoice_payment_kbn": {
"type": "integer",
"description": "請求間隔内の請求時期\n\n- 1：請求間隔の最初の月\n- 2：請求間隔の最後の月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"contract_end_alert_flg": {
"type": "integer",
"description": "通知対象\n\n- 0：通知しない\n- 1：通知する\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期請求用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期請求用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"monthly_invoice_payment_kbn": {
"type": "integer",
"description": "自動挿入メッセージ年月\n\n- 1：請求月\n- 2：請求月の翌月\n- 3：請求月の前月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
}
}
}
]
},
{
"title": "分割請求",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
]
}
}
}
]
},
{
"properties": {
"estimate": {
"allOf": [
{
"description": "見積書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"valid_period": {
"type": "string",
"description": "有効期限",
"maxLength": 100,
"example": "御見積後2週間"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "見積日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"order": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"disp_order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日（表示設定）",
"example": "2023-10-01"
},
"disp_order_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注請日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発注請日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"deliveries": {
"type": "array",
"items": {
"allOf": [
{
"description": "納品書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "納品書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`deliveries`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日",
"example": "2023-10-01"
},
"disp_delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日（表示設定）",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "納品日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"invoices": {
"type": "array",
"items": {
"allOf": [
{
"description": "請求書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "請求書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`invoices`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31",
"readOnly": true
},
"payment_limit_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払期限",
"example": "2023-11-30",
"readOnly": true
},
"disp_invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "請求日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"multi_bank_info_flg": {
"type": "integer",
"description": "複数口座表示\n\n- 0：OFF\n- 1：ON\n\n※デフォルトは設定による\n",
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"receipts": {
"type": "array",
"items": {
"allOf": [
{
"description": "領収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "領収書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`receipts`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日",
"example": "2023-10-01",
"readOnly": true
},
"disp_receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発行日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/projects' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
},
"post": {
"tags": [
"project"
],
"summary": "案件登録",
"description": "案件を新規登録します。\n\n請求タイミング（一括請求・定期請求・分割請求）に応じてパラメーターが異なります。\n\n下記のリクエストパラメーターリストの上部にある「共通」「一括請求」「定期請求」「分割請求」のボタンでリクエストパラメーターを切り替えることができます。\n\n「共通」は、全請求タイミングで共通して使用するパラメーターです。「一括請求」「定期請求」「分割請求」は、それぞれの請求タイミング固有のパラメーターです。「共通+一括請求」のように組み合わせて使用してください。\n",
"operationId": "postProject",
"security": [
{
"api_token": [],
"api_key": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "案件関連の定義情報",
"anyOf": [
{
"allOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "案件ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"client_branch_id": {
"description": "顧客支社ID\n\n※[顧客支社登録API](#tag/client_branch/operation/postClientBranch)・[顧客支社リスト取得API](#tag/client_branch/operation/getClientBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client_branch": {
"description": "顧客支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"client_name_disp_kbn": {
"type": "integer",
"description": "顧客支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_disp_kbn_name": {
"type": "string",
"description": "顧客支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"client_name_for_post_disp_kbn": {
"type": "integer",
"description": "顧客支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_for_post_disp_kbn_name": {
"type": "string",
"description": "顧客支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"contact_id": {
"description": "顧客担当者ID\n\n※[顧客担当者登録API](#tag/contact/operation/postContact)・[顧客担当者リスト取得API](#tag/contact/operation/getContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"contact": {
"description": "顧客担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "顧客担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "顧客担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"cost_total": {
"type": "integer",
"format": "int32",
"description": "原価",
"example": 10000,
"readOnly": true
},
"cost_tax": {
"type": "integer",
"format": "int32",
"description": "原価の消費税",
"example": 1000,
"readOnly": true
},
"invoice_total": {
"type": "string",
"description": "請求額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"invoice_tax": {
"type": "string",
"description": "請求額の消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"estimate_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "見積日\n\n※新規登録時に未指定の場合は、本日の日付がセットされます\n",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期\n",
"example": "2023-10-20"
},
"delivery_date_text": {
"type": "string",
"maxLength": 50,
"description": "納期テキスト\n",
"example": "サンプル納期"
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"order_status": {
"type": "integer",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"order_status_name": {
"type": "string",
"description": "受注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"invoice_timing_kbn": {
"type": "integer",
"description": "請求タイミング\n\n- 1：一括請求\n- 2：定期請求\n- 3：分割請求\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"invoice_timing_kbn_name": {
"type": "string",
"description": "請求タイミングの名称",
"example": "一括請求",
"readOnly": true
},
"project_type_id": {
"type": "integer",
"description": "案件区分1ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type_name": {
"type": "string",
"description": "案件区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"project_type2_id": {
"type": "integer",
"description": "案件区分2ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type2_name": {
"type": "string",
"description": "案件区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"project_type3_id": {
"type": "integer",
"description": "案件区分3ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type3_name": {
"type": "string",
"description": "案件区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"ordered_date": {
"type": "string",
"description": "受注日",
"format": "YYYY-MM-DD",
"example": "2023-10-05"
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"project_costs": {
"description": "案件原価",
"readOnly": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"cost": {
"type": "integer",
"format": "int64",
"description": "金額",
"example": 10000
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル費用"
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-10"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-10"
}
}
}
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"format": "int64",
"description": "見積金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"format": "int32",
"description": "見積金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"invoice_total_jpy": {
"type": "integer",
"format": "int64",
"description": "請求金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"invoice_tax_jpy": {
"type": "integer",
"format": "int32",
"description": "請求金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"hubspot": {
"description": "HubSpotと連携している場合は、その連携情報",
"readOnly": true,
"type": "object",
"properties": {
"hubspot_deal_id": {
"type": "string",
"description": "HubSpotの取引ID",
"example": "123456"
}
}
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"required": [
"name",
"client_id",
"user_id",
"order_status",
"invoice_timing_kbn"
]
}
]
},
{
"allOf": [
{
"title": "一括請求",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括請求用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
}
}
}
]
},
{
"required": [
"invoice_date"
]
}
]
},
{
"allOf": [
{
"title": "定期請求",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期請求用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期請求用\n",
"example": "2023-12-31"
},
"periodical_invoice_interval": {
"type": "integer",
"description": "請求間隔\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_invoice_payment_kbn": {
"type": "integer",
"description": "請求間隔内の請求時期\n\n- 1：請求間隔の最初の月\n- 2：請求間隔の最後の月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"contract_end_alert_flg": {
"type": "integer",
"description": "通知対象\n\n- 0：通知しない\n- 1：通知する\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期請求用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期請求用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"monthly_invoice_payment_kbn": {
"type": "integer",
"description": "自動挿入メッセージ年月\n\n- 1：請求月\n- 2：請求月の翌月\n- 3：請求月の前月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
}
}
}
]
},
{
"required": [
"contract_start_date",
"contract_end_date"
]
}
]
},
{
"allOf": [
{
"title": "分割請求",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
]
}
}
}
]
},
{
"required": [
"invoice_dates"
]
}
]
}
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "登録成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "案件ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"client_branch_id": {
"description": "顧客支社ID\n\n※[顧客支社登録API](#tag/client_branch/operation/postClientBranch)・[顧客支社リスト取得API](#tag/client_branch/operation/getClientBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client_branch": {
"description": "顧客支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"client_name_disp_kbn": {
"type": "integer",
"description": "顧客支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_disp_kbn_name": {
"type": "string",
"description": "顧客支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"client_name_for_post_disp_kbn": {
"type": "integer",
"description": "顧客支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_for_post_disp_kbn_name": {
"type": "string",
"description": "顧客支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"contact_id": {
"description": "顧客担当者ID\n\n※[顧客担当者登録API](#tag/contact/operation/postContact)・[顧客担当者リスト取得API](#tag/contact/operation/getContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"contact": {
"description": "顧客担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "顧客担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "顧客担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"cost_total": {
"type": "integer",
"format": "int32",
"description": "原価",
"example": 10000,
"readOnly": true
},
"cost_tax": {
"type": "integer",
"format": "int32",
"description": "原価の消費税",
"example": 1000,
"readOnly": true
},
"invoice_total": {
"type": "string",
"description": "請求額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"invoice_tax": {
"type": "string",
"description": "請求額の消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"estimate_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "見積日\n\n※新規登録時に未指定の場合は、本日の日付がセットされます\n",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期\n",
"example": "2023-10-20"
},
"delivery_date_text": {
"type": "string",
"maxLength": 50,
"description": "納期テキスト\n",
"example": "サンプル納期"
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"order_status": {
"type": "integer",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"order_status_name": {
"type": "string",
"description": "受注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"invoice_timing_kbn": {
"type": "integer",
"description": "請求タイミング\n\n- 1：一括請求\n- 2：定期請求\n- 3：分割請求\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"invoice_timing_kbn_name": {
"type": "string",
"description": "請求タイミングの名称",
"example": "一括請求",
"readOnly": true
},
"project_type_id": {
"type": "integer",
"description": "案件区分1ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type_name": {
"type": "string",
"description": "案件区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"project_type2_id": {
"type": "integer",
"description": "案件区分2ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type2_name": {
"type": "string",
"description": "案件区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"project_type3_id": {
"type": "integer",
"description": "案件区分3ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type3_name": {
"type": "string",
"description": "案件区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"ordered_date": {
"type": "string",
"description": "受注日",
"format": "YYYY-MM-DD",
"example": "2023-10-05"
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"project_costs": {
"description": "案件原価",
"readOnly": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"cost": {
"type": "integer",
"format": "int64",
"description": "金額",
"example": 10000
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル費用"
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-10"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-10"
}
}
}
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"format": "int64",
"description": "見積金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"format": "int32",
"description": "見積金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"invoice_total_jpy": {
"type": "integer",
"format": "int64",
"description": "請求金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"invoice_tax_jpy": {
"type": "integer",
"format": "int32",
"description": "請求金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"hubspot": {
"description": "HubSpotと連携している場合は、その連携情報",
"readOnly": true,
"type": "object",
"properties": {
"hubspot_deal_id": {
"type": "string",
"description": "HubSpotの取引ID",
"example": "123456"
}
}
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"title": "一括請求",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括請求用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
}
}
}
]
},
{
"title": "定期請求",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期請求用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期請求用\n",
"example": "2023-12-31"
},
"periodical_invoice_interval": {
"type": "integer",
"description": "請求間隔\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_invoice_payment_kbn": {
"type": "integer",
"description": "請求間隔内の請求時期\n\n- 1：請求間隔の最初の月\n- 2：請求間隔の最後の月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"contract_end_alert_flg": {
"type": "integer",
"description": "通知対象\n\n- 0：通知しない\n- 1：通知する\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期請求用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期請求用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"monthly_invoice_payment_kbn": {
"type": "integer",
"description": "自動挿入メッセージ年月\n\n- 1：請求月\n- 2：請求月の翌月\n- 3：請求月の前月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
}
}
}
]
},
{
"title": "分割請求",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
]
}
}
}
]
},
{
"properties": {
"estimate": {
"allOf": [
{
"description": "見積書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"valid_period": {
"type": "string",
"description": "有効期限",
"maxLength": 100,
"example": "御見積後2週間"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "見積日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"order": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"disp_order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日（表示設定）",
"example": "2023-10-01"
},
"disp_order_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注請日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発注請日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"deliveries": {
"type": "array",
"items": {
"allOf": [
{
"description": "納品書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "納品書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`deliveries`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日",
"example": "2023-10-01"
},
"disp_delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日（表示設定）",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "納品日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"invoices": {
"type": "array",
"items": {
"allOf": [
{
"description": "請求書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "請求書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`invoices`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31",
"readOnly": true
},
"payment_limit_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払期限",
"example": "2023-11-30",
"readOnly": true
},
"disp_invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "請求日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"multi_bank_info_flg": {
"type": "integer",
"description": "複数口座表示\n\n- 0：OFF\n- 1：ON\n\n※デフォルトは設定による\n",
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"receipts": {
"type": "array",
"items": {
"allOf": [
{
"description": "領収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "領収書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`receipts`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日",
"example": "2023-10-01",
"readOnly": true
},
"disp_receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発行日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/projects' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"name\": \"サンプル案件A\",\n \"client_id\": 123456,\n \"user_id\": 111111,\n \"estimate_date\": \"2023-10-01\",\n \"order_status\": 1,\n \"invoice_timing_kbn\": 1,\n \"invoice_date\": \"2023-10-31\"\n}'"
}
]
}
},
"/projects/{id}": {
"patch": {
"tags": [
"project"
],
"summary": "案件更新",
"description": "案件ID指定で案件を更新します。\n\n分割請求に関する注意事項
\n現在、API経由での`invoice_dates`の更新（請求日・請求回数の変更）には対応していません。\n",
"operationId": "patchProject",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "案件関連の定義情報",
"anyOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "案件ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"client_branch_id": {
"description": "顧客支社ID\n\n※[顧客支社登録API](#tag/client_branch/operation/postClientBranch)・[顧客支社リスト取得API](#tag/client_branch/operation/getClientBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client_branch": {
"description": "顧客支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"client_name_disp_kbn": {
"type": "integer",
"description": "顧客支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_disp_kbn_name": {
"type": "string",
"description": "顧客支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"client_name_for_post_disp_kbn": {
"type": "integer",
"description": "顧客支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_for_post_disp_kbn_name": {
"type": "string",
"description": "顧客支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"contact_id": {
"description": "顧客担当者ID\n\n※[顧客担当者登録API](#tag/contact/operation/postContact)・[顧客担当者リスト取得API](#tag/contact/operation/getContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"contact": {
"description": "顧客担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "顧客担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "顧客担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"cost_total": {
"type": "integer",
"format": "int32",
"description": "原価",
"example": 10000,
"readOnly": true
},
"cost_tax": {
"type": "integer",
"format": "int32",
"description": "原価の消費税",
"example": 1000,
"readOnly": true
},
"invoice_total": {
"type": "string",
"description": "請求額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"invoice_tax": {
"type": "string",
"description": "請求額の消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"estimate_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "見積日\n\n※新規登録時に未指定の場合は、本日の日付がセットされます\n",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期\n",
"example": "2023-10-20"
},
"delivery_date_text": {
"type": "string",
"maxLength": 50,
"description": "納期テキスト\n",
"example": "サンプル納期"
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"order_status": {
"type": "integer",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"order_status_name": {
"type": "string",
"description": "受注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"invoice_timing_kbn": {
"type": "integer",
"description": "請求タイミング\n\n- 1：一括請求\n- 2：定期請求\n- 3：分割請求\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"invoice_timing_kbn_name": {
"type": "string",
"description": "請求タイミングの名称",
"example": "一括請求",
"readOnly": true
},
"project_type_id": {
"type": "integer",
"description": "案件区分1ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type_name": {
"type": "string",
"description": "案件区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"project_type2_id": {
"type": "integer",
"description": "案件区分2ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type2_name": {
"type": "string",
"description": "案件区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"project_type3_id": {
"type": "integer",
"description": "案件区分3ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type3_name": {
"type": "string",
"description": "案件区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"ordered_date": {
"type": "string",
"description": "受注日",
"format": "YYYY-MM-DD",
"example": "2023-10-05"
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"project_costs": {
"description": "案件原価",
"readOnly": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"cost": {
"type": "integer",
"format": "int64",
"description": "金額",
"example": 10000
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル費用"
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-10"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-10"
}
}
}
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"format": "int64",
"description": "見積金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"format": "int32",
"description": "見積金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"invoice_total_jpy": {
"type": "integer",
"format": "int64",
"description": "請求金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"invoice_tax_jpy": {
"type": "integer",
"format": "int32",
"description": "請求金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"hubspot": {
"description": "HubSpotと連携している場合は、その連携情報",
"readOnly": true,
"type": "object",
"properties": {
"hubspot_deal_id": {
"type": "string",
"description": "HubSpotの取引ID",
"example": "123456"
}
}
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"title": "一括請求",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括請求用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
}
}
}
]
},
{
"title": "定期請求",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期請求用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期請求用\n",
"example": "2023-12-31"
},
"periodical_invoice_interval": {
"type": "integer",
"description": "請求間隔\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_invoice_payment_kbn": {
"type": "integer",
"description": "請求間隔内の請求時期\n\n- 1：請求間隔の最初の月\n- 2：請求間隔の最後の月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"contract_end_alert_flg": {
"type": "integer",
"description": "通知対象\n\n- 0：通知しない\n- 1：通知する\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期請求用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期請求用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"monthly_invoice_payment_kbn": {
"type": "integer",
"description": "自動挿入メッセージ年月\n\n- 1：請求月\n- 2：請求月の翌月\n- 3：請求月の前月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
}
}
}
]
},
{
"title": "分割請求",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
}
}
}
]
}
]
}
}
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "案件ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"client_branch_id": {
"description": "顧客支社ID\n\n※[顧客支社登録API](#tag/client_branch/operation/postClientBranch)・[顧客支社リスト取得API](#tag/client_branch/operation/getClientBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client_branch": {
"description": "顧客支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"client_name_disp_kbn": {
"type": "integer",
"description": "顧客支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_disp_kbn_name": {
"type": "string",
"description": "顧客支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"client_name_for_post_disp_kbn": {
"type": "integer",
"description": "顧客支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_for_post_disp_kbn_name": {
"type": "string",
"description": "顧客支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"contact_id": {
"description": "顧客担当者ID\n\n※[顧客担当者登録API](#tag/contact/operation/postContact)・[顧客担当者リスト取得API](#tag/contact/operation/getContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"contact": {
"description": "顧客担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "顧客担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "顧客担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"cost_total": {
"type": "integer",
"format": "int32",
"description": "原価",
"example": 10000,
"readOnly": true
},
"cost_tax": {
"type": "integer",
"format": "int32",
"description": "原価の消費税",
"example": 1000,
"readOnly": true
},
"invoice_total": {
"type": "string",
"description": "請求額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"invoice_tax": {
"type": "string",
"description": "請求額の消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"estimate_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "見積日\n\n※新規登録時に未指定の場合は、本日の日付がセットされます\n",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期\n",
"example": "2023-10-20"
},
"delivery_date_text": {
"type": "string",
"maxLength": 50,
"description": "納期テキスト\n",
"example": "サンプル納期"
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"order_status": {
"type": "integer",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"order_status_name": {
"type": "string",
"description": "受注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"invoice_timing_kbn": {
"type": "integer",
"description": "請求タイミング\n\n- 1：一括請求\n- 2：定期請求\n- 3：分割請求\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"invoice_timing_kbn_name": {
"type": "string",
"description": "請求タイミングの名称",
"example": "一括請求",
"readOnly": true
},
"project_type_id": {
"type": "integer",
"description": "案件区分1ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type_name": {
"type": "string",
"description": "案件区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"project_type2_id": {
"type": "integer",
"description": "案件区分2ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type2_name": {
"type": "string",
"description": "案件区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"project_type3_id": {
"type": "integer",
"description": "案件区分3ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type3_name": {
"type": "string",
"description": "案件区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"ordered_date": {
"type": "string",
"description": "受注日",
"format": "YYYY-MM-DD",
"example": "2023-10-05"
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"project_costs": {
"description": "案件原価",
"readOnly": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"cost": {
"type": "integer",
"format": "int64",
"description": "金額",
"example": 10000
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル費用"
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-10"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-10"
}
}
}
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"format": "int64",
"description": "見積金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"format": "int32",
"description": "見積金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"invoice_total_jpy": {
"type": "integer",
"format": "int64",
"description": "請求金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"invoice_tax_jpy": {
"type": "integer",
"format": "int32",
"description": "請求金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"hubspot": {
"description": "HubSpotと連携している場合は、その連携情報",
"readOnly": true,
"type": "object",
"properties": {
"hubspot_deal_id": {
"type": "string",
"description": "HubSpotの取引ID",
"example": "123456"
}
}
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"title": "一括請求",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括請求用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
}
}
}
]
},
{
"title": "定期請求",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期請求用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期請求用\n",
"example": "2023-12-31"
},
"periodical_invoice_interval": {
"type": "integer",
"description": "請求間隔\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_invoice_payment_kbn": {
"type": "integer",
"description": "請求間隔内の請求時期\n\n- 1：請求間隔の最初の月\n- 2：請求間隔の最後の月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"contract_end_alert_flg": {
"type": "integer",
"description": "通知対象\n\n- 0：通知しない\n- 1：通知する\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期請求用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期請求用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"monthly_invoice_payment_kbn": {
"type": "integer",
"description": "自動挿入メッセージ年月\n\n- 1：請求月\n- 2：請求月の翌月\n- 3：請求月の前月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
}
}
}
]
},
{
"title": "分割請求",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
]
}
}
}
]
},
{
"properties": {
"estimate": {
"allOf": [
{
"description": "見積書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"valid_period": {
"type": "string",
"description": "有効期限",
"maxLength": 100,
"example": "御見積後2週間"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "見積日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"order": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"disp_order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日（表示設定）",
"example": "2023-10-01"
},
"disp_order_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注請日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発注請日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"deliveries": {
"type": "array",
"items": {
"allOf": [
{
"description": "納品書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "納品書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`deliveries`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日",
"example": "2023-10-01"
},
"disp_delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日（表示設定）",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "納品日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"invoices": {
"type": "array",
"items": {
"allOf": [
{
"description": "請求書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "請求書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`invoices`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31",
"readOnly": true
},
"payment_limit_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払期限",
"example": "2023-11-30",
"readOnly": true
},
"disp_invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "請求日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"multi_bank_info_flg": {
"type": "integer",
"description": "複数口座表示\n\n- 0：OFF\n- 1：ON\n\n※デフォルトは設定による\n",
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"receipts": {
"type": "array",
"items": {
"allOf": [
{
"description": "領収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "領収書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`receipts`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日",
"example": "2023-10-01",
"readOnly": true
},
"disp_receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発行日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/projects/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"name\": \"サンプル案件B\"\n}'"
}
]
},
"delete": {
"tags": [
"project"
],
"summary": "案件削除",
"description": "案件ID指定で案件を削除します。",
"operationId": "deleteProject",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "削除成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request DELETE 'https://api.the-board.jp/v1/projects/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'\n"
}
]
},
"get": {
"tags": [
"project"
],
"summary": "案件取得",
"description": "案件ID指定で案件を取得します。",
"operationId": "getProject",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "response_group",
"in": "query",
"description": "レスポンスグループ\n\n| response_group | 項目 |\n|:-----------|:------------|\n| small | id, project_no, management_no, name, client, contact, user, total, tax, estimate_date, invoice_dates, order_status, order_status_name, project_type_id, project_type_name, project_type2_id, project_type2_name, project_type3_id, project_type3_name, delivery_status, delivery_status_name, group_id, group_name, currency, created_at, updated_at |\n| medium | smallに加え以下の項目
client_branch, company_branch, cost_total, cost_tax, invoice_total, invoice_tax, delivery_date, payment_term_id, payment_term_name, invoice_timing_kbn, invoice_timing_kbn_name, contract_start_date, contract_end_date, periodical_invoice_interval, periodical_invoice_payment_kbn, contract_end_alert_flg, auto_renewal_flg, auto_renewal_period_month, monthly_invoice_payment_kbn, delivery_document_kbn, tags, ordered_date, exchange_rate, total_jpy, tax_jpy, invoice_total_jpy, invoice_tax_jpy |\n| large | 書類以外すべての項目 |\n| estimate | small + 見積書 |\n| order | small + 発注書 |\n| delivery | small + 納品書 |\n| invoice | small + 請求書 |\n| receipt | small + 領収書 |\n| project_cost | small + 案件原価 |\n| all | large + すべての書類 |\n",
"schema": {
"type": "string",
"default": "small",
"example": "large",
"enum": [
"small",
"medium",
"large",
"estimate",
"order",
"delivery",
"invoice",
"receipt",
"project_cost",
"all"
],
"externalDocs": {
"description": "※レスポンスグループについて",
"url": "#section/レスポンスグループ"
}
}
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "案件ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"client_branch_id": {
"description": "顧客支社ID\n\n※[顧客支社登録API](#tag/client_branch/operation/postClientBranch)・[顧客支社リスト取得API](#tag/client_branch/operation/getClientBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client_branch": {
"description": "顧客支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"client_name_disp_kbn": {
"type": "integer",
"description": "顧客支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_disp_kbn_name": {
"type": "string",
"description": "顧客支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"client_name_for_post_disp_kbn": {
"type": "integer",
"description": "顧客支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_for_post_disp_kbn_name": {
"type": "string",
"description": "顧客支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"contact_id": {
"description": "顧客担当者ID\n\n※[顧客担当者登録API](#tag/contact/operation/postContact)・[顧客担当者リスト取得API](#tag/contact/operation/getContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"contact": {
"description": "顧客担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "顧客担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "顧客担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"cost_total": {
"type": "integer",
"format": "int32",
"description": "原価",
"example": 10000,
"readOnly": true
},
"cost_tax": {
"type": "integer",
"format": "int32",
"description": "原価の消費税",
"example": 1000,
"readOnly": true
},
"invoice_total": {
"type": "string",
"description": "請求額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"invoice_tax": {
"type": "string",
"description": "請求額の消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"estimate_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "見積日\n\n※新規登録時に未指定の場合は、本日の日付がセットされます\n",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期\n",
"example": "2023-10-20"
},
"delivery_date_text": {
"type": "string",
"maxLength": 50,
"description": "納期テキスト\n",
"example": "サンプル納期"
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"order_status": {
"type": "integer",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"order_status_name": {
"type": "string",
"description": "受注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"invoice_timing_kbn": {
"type": "integer",
"description": "請求タイミング\n\n- 1：一括請求\n- 2：定期請求\n- 3：分割請求\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"invoice_timing_kbn_name": {
"type": "string",
"description": "請求タイミングの名称",
"example": "一括請求",
"readOnly": true
},
"project_type_id": {
"type": "integer",
"description": "案件区分1ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type_name": {
"type": "string",
"description": "案件区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"project_type2_id": {
"type": "integer",
"description": "案件区分2ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type2_name": {
"type": "string",
"description": "案件区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"project_type3_id": {
"type": "integer",
"description": "案件区分3ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type3_name": {
"type": "string",
"description": "案件区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"ordered_date": {
"type": "string",
"description": "受注日",
"format": "YYYY-MM-DD",
"example": "2023-10-05"
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"project_costs": {
"description": "案件原価",
"readOnly": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"cost": {
"type": "integer",
"format": "int64",
"description": "金額",
"example": 10000
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル費用"
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-10"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-10"
}
}
}
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"format": "int64",
"description": "見積金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"format": "int32",
"description": "見積金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"invoice_total_jpy": {
"type": "integer",
"format": "int64",
"description": "請求金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"invoice_tax_jpy": {
"type": "integer",
"format": "int32",
"description": "請求金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"hubspot": {
"description": "HubSpotと連携している場合は、その連携情報",
"readOnly": true,
"type": "object",
"properties": {
"hubspot_deal_id": {
"type": "string",
"description": "HubSpotの取引ID",
"example": "123456"
}
}
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"title": "一括請求",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括請求用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
}
}
}
]
},
{
"title": "定期請求",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期請求用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期請求用\n",
"example": "2023-12-31"
},
"periodical_invoice_interval": {
"type": "integer",
"description": "請求間隔\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_invoice_payment_kbn": {
"type": "integer",
"description": "請求間隔内の請求時期\n\n- 1：請求間隔の最初の月\n- 2：請求間隔の最後の月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"contract_end_alert_flg": {
"type": "integer",
"description": "通知対象\n\n- 0：通知しない\n- 1：通知する\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期請求用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期請求用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"monthly_invoice_payment_kbn": {
"type": "integer",
"description": "自動挿入メッセージ年月\n\n- 1：請求月\n- 2：請求月の翌月\n- 3：請求月の前月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
}
}
}
]
},
{
"title": "分割請求",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
]
}
}
}
]
},
{
"properties": {
"estimate": {
"allOf": [
{
"description": "見積書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"valid_period": {
"type": "string",
"description": "有効期限",
"maxLength": 100,
"example": "御見積後2週間"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "見積日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"order": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"disp_order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日（表示設定）",
"example": "2023-10-01"
},
"disp_order_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注請日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発注請日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"deliveries": {
"type": "array",
"items": {
"allOf": [
{
"description": "納品書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "納品書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`deliveries`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日",
"example": "2023-10-01"
},
"disp_delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日（表示設定）",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "納品日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"invoices": {
"type": "array",
"items": {
"allOf": [
{
"description": "請求書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "請求書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`invoices`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31",
"readOnly": true
},
"payment_limit_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払期限",
"example": "2023-11-30",
"readOnly": true
},
"disp_invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "請求日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"multi_bank_info_flg": {
"type": "integer",
"description": "複数口座表示\n\n- 0：OFF\n- 1：ON\n\n※デフォルトは設定による\n",
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"receipts": {
"type": "array",
"items": {
"allOf": [
{
"description": "領収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "領収書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`receipts`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日",
"example": "2023-10-01",
"readOnly": true
},
"disp_receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発行日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/projects/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/project_costs": {
"get": {
"tags": [
"project_cost"
],
"summary": "案件原価リスト取得",
"description": "案件原価リストを取得します。",
"operationId": "getProjectCosts",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "project_id_eq",
"in": "query",
"description": "案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"schema": {
"type": "integer",
"example": 123456
}
},
{
"name": "created_at_gteq",
"in": "query",
"description": "作成日時（指定日時以降）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "created_at_lteq",
"in": "query",
"description": "作成日時（指定日時以前）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "invoice_date_gteq",
"in": "query",
"description": "請求日（指定日時以降）",
"schema": {
"type": "string",
"format": "YYYY-MM-DD",
"example": "2023-08-01"
}
},
{
"name": "invoice_date_lteq",
"in": "query",
"description": "請求日（指定日以前）",
"schema": {
"type": "string",
"format": "YYYY-MM-DD",
"example": "2023-08-01"
}
},
{
"name": "payment_date_gteq",
"in": "query",
"description": "支払日（指定日時以降）",
"schema": {
"type": "string",
"format": "YYYY-MM-DD",
"example": "2023-08-01"
}
},
{
"name": "payment_date_lteq",
"in": "query",
"description": "支払日（指定日以前）",
"schema": {
"type": "string",
"format": "YYYY-MM-DD",
"example": "2023-08-01"
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
{
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
}
],
"responses": {
"200": {
"description": "成功",
"headers": {
"X-Total-Count": {
"description": "トータル件数",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Page": {
"description": "現在のページ番号",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Per-Page": {
"description": "1ページあたりの件数",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"description": "案件原価ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"project_id": {
"description": "案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル原価"
},
"cost": {
"type": "integer",
"description": "金額",
"format": "int32",
"example": 10000
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-11-30"
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/project_costs' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
},
"post": {
"tags": [
"project_cost"
],
"summary": "案件原価登録",
"description": "案件原価を新規登録します。",
"operationId": "postProjectCost",
"security": [
{
"api_token": [],
"api_key": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "案件原価関連の定義情報",
"required": [
"project_id",
"description",
"cost",
"invoice_date",
"payment_date"
],
"properties": {
"id": {
"description": "案件原価ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"project_id": {
"description": "案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル原価"
},
"cost": {
"type": "integer",
"description": "金額",
"format": "int32",
"example": 10000
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-11-30"
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "登録成功",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "案件原価ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"project_id": {
"description": "案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル原価"
},
"cost": {
"type": "integer",
"description": "金額",
"format": "int32",
"example": 10000
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-11-30"
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/project_costs' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"project_id\": 123456,\n \"description\": \"サンプル原価\",\n \"cost\": 10000,\n \"invoice_date\": \"2023-10-31\",\n \"payment_date\": \"2023-10-31\"\n}'"
}
]
}
},
"/project_costs/{id}": {
"patch": {
"tags": [
"project_cost"
],
"summary": "案件原価更新",
"description": "ID指定で案件原価を更新します。",
"operationId": "patchProjectCost",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "案件原価ID\n\n※[案件原価登録API](#tag/project_cost/operation/postProjectCost)・[案件原価リスト取得API](#tag/project_cost/operation/getProjectCosts)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"id": {
"description": "案件原価ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"project_id": {
"description": "案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル原価"
},
"cost": {
"type": "integer",
"description": "金額",
"format": "int32",
"example": 10000
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-11-30"
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"properties": {
"project_id": {
"readOnly": true
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "案件原価ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"project_id": {
"description": "案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル原価"
},
"cost": {
"type": "integer",
"description": "金額",
"format": "int32",
"example": 10000
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-11-30"
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/project_costs/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"cost\": 20000\n}'"
}
]
},
"delete": {
"tags": [
"project_cost"
],
"summary": "案件原価削除",
"description": "ID指定で案件原価を削除します。",
"operationId": "deleteProjectCost",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "案件原価ID\n\n※[案件原価登録API](#tag/project_cost/operation/postProjectCost)・[案件原価リスト取得API](#tag/project_cost/operation/getProjectCosts)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "削除成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request DELETE 'https://api.the-board.jp/v1/project_costs/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'\n"
}
]
},
"get": {
"tags": [
"project_cost"
],
"summary": "案件原価取得",
"description": "ID指定で案件原価を取得します。",
"operationId": "getProjectCost",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "案件原価ID\n\n※[案件原価登録API](#tag/project_cost/operation/postProjectCost)・[案件原価リスト取得API](#tag/project_cost/operation/getProjectCosts)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "案件原価ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"project_id": {
"description": "案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル原価"
},
"cost": {
"type": "integer",
"description": "金額",
"format": "int32",
"example": 10000
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-11-30"
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/project_costs/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/projects/order_status/{id}": {
"patch": {
"tags": [
"project"
],
"summary": "受注ステータス変更",
"description": "案件ID指定で受注ステータスを変更します。",
"operationId": "patchProjectOrderStatus",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"order_status": {
"type": "integer",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
}
},
"required": [
"order_status"
]
}
}
}
},
"responses": {
"204": {
"description": "成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/projects/order_status/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"order_status\": 2\n}'"
}
]
}
},
"/projects/lock_flg/{id}": {
"patch": {
"tags": [
"project"
],
"summary": "案件のロック",
"description": "案件ID指定で案件情報をロック・ロック解除します。",
"operationId": "patchProjectLockFlg",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"example": 1,
"enum": [
0,
1
]
}
},
"required": [
"lock_flg"
]
}
}
}
},
"responses": {
"204": {
"description": "成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/projects/lock_flg/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"lock_flg\": 1\n}'"
}
]
}
},
"/invoices": {
"get": {
"tags": [
"invoice"
],
"summary": "請求リスト取得",
"description": "請求リストを取得します。",
"operationId": "getInvoices",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "invoice_date_gteq",
"in": "query",
"description": "請求日（指定日以降）",
"schema": {
"type": "string",
"format": "YYYY-MM-DD",
"example": "2023-10-01"
}
},
{
"name": "invoice_date_lteq",
"in": "query",
"description": "請求日（指定日以前）",
"schema": {
"type": "string",
"format": "YYYY-MM-DD",
"example": "2023-10-01"
}
},
{
"name": "invoice_payment_limit_date_gteq",
"in": "query",
"description": "支払期限（指定日以降）",
"schema": {
"type": "string",
"format": "YYYY-MM-DD",
"example": "2023-10-01"
}
},
{
"name": "invoice_payment_limit_date_lteq",
"in": "query",
"description": "支払期限（指定日以前）",
"schema": {
"type": "string",
"format": "YYYY-MM-DD",
"example": "2023-10-01"
}
},
{
"name": "project_order_status_in[]",
"in": "query",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n\n※複数の場合はカンマ区切り\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "4,5"
}
},
{
"name": "invoice_status_in[]",
"in": "query",
"description": "請求ステータス\n\n- 1：未請求\n- 4：請求OK\n- 2：請求済\n- 5：一部入金済\n- 3：入金済\n- 9：回収不能\n\n※複数の場合はカンマ区切り\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "4,5"
}
},
{
"name": "project_project_no_eq",
"in": "query",
"description": "案件No",
"schema": {
"type": "integer",
"example": 1001
}
},
{
"name": "project_management_no_eq",
"in": "query",
"description": "管理番号",
"schema": {
"type": "string",
"example": "SAMPLE0001"
}
},
{
"name": "project_name_cont",
"in": "query",
"description": "案件名（部分一致）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプル案件"
}
},
{
"name": "project_client_id_eq",
"in": "query",
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"schema": {
"type": "integer",
"example": 123456
}
},
{
"name": "project_client_name_cont",
"in": "query",
"description": "顧客名（部分一致）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプル株式会社"
}
},
{
"name": "project_client_name_disp_cont",
"in": "query",
"description": "顧客略称名（部分一致）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプル"
}
},
{
"name": "project_tags[]",
"in": "query",
"description": "タグ（OR条件、複数の場合はカンマ区切り）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプルタグA,サンプルタグB"
}
},
{
"name": "updated_at_gteq",
"in": "query",
"description": "更新日時（指定日時以降）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "updated_at_lteq",
"in": "query",
"description": "更新日時（指定日時以前）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
{
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
},
{
"name": "response_group",
"in": "query",
"description": "レスポンスグループ\n\n| response_group | 項目 |\n|:-----------|:------------|\n| small | id, project_id, project_no, management_no, name, client, contact, user, total, tax, cost_total, cost_tax, invoice_date, payment_limit_date, order_status, order_status_name, invoice_status, invoice_status_name, project_type_id, project_type_name, project_type2_id, project_type2_name, project_type3_id, project_type3_name, group_id, group_name, paid_date, currency, created_at, updated_at |\n| medium | smallに加え以下の項目
client_branch, company_branch, tags, exchange_rate, total_jpy, tax_jpy |\n| large | 書類以外すべての項目 |\n| invoice | small + 請求書 |\n",
"schema": {
"type": "string",
"default": "small",
"example": "large",
"enum": [
"small",
"medium",
"large",
"estimate",
"order",
"delivery",
"invoice",
"receipt",
"project_cost",
"all"
],
"externalDocs": {
"description": "※レスポンスグループについて",
"url": "#section/レスポンスグループ"
}
}
}
],
"responses": {
"200": {
"description": "成功",
"headers": {
"X-Total-Count": {
"description": "トータル件数",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Page": {
"description": "現在のページ番号",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Per-Page": {
"description": "1ページあたりの件数",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"description": "請求関連の定義情報",
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "請求ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"project_id": {
"description": "案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"client_branch": {
"description": "顧客支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"contact": {
"description": "顧客担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "顧客担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "顧客担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"total": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"cost_total": {
"type": "integer",
"description": "原価",
"example": 10000,
"readOnly": true
},
"cost_tax": {
"type": "integer",
"description": "原価の消費税",
"example": 1000,
"readOnly": true
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n",
"example": "2023-10-31"
},
"payment_limit_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払期限\n",
"example": "2023-11-30"
},
"order_status": {
"type": "integer",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"order_status_name": {
"type": "string",
"description": "受注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"invoice_status": {
"type": "integer",
"description": "請求ステータス\n\n- 1：未請求\n- 4：請求OK\n- 2：請求済\n- 5：一部入金済\n- 3：入金済\n- 9：回収不能\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
9
]
},
"invoice_status_name": {
"type": "string",
"description": "請求ステータスの名称",
"example": "未請求",
"readOnly": true
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"project_type_id": {
"type": "integer",
"description": "案件区分1ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type_name": {
"type": "string",
"description": "案件区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"project_type2_id": {
"type": "integer",
"description": "案件区分2ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type2_name": {
"type": "string",
"description": "案件区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"project_type3_id": {
"type": "integer",
"description": "案件区分3ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type3_name": {
"type": "string",
"description": "案件区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"paid_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "入金日\n",
"example": "2023-10-01"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"description": "請求金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"description": "請求金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
},
"invoice": {
"allOf": [
{
"description": "請求書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "請求書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`invoices`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31",
"readOnly": true
},
"payment_limit_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払期限",
"example": "2023-11-30",
"readOnly": true
},
"disp_invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "請求日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"multi_bank_info_flg": {
"type": "integer",
"description": "複数口座表示\n\n- 0：OFF\n- 1：ON\n\n※デフォルトは設定による\n",
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/invoices' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/invoices/invoice_status/{id}": {
"patch": {
"tags": [
"invoice"
],
"summary": "請求ステータス変更",
"description": "請求ID指定で請求ステータスを変更します。",
"operationId": "patchInvoiceInvoiceStatus",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "請求ID\n\n※[請求リスト取得API](#tag/invoice/operation/getInvoices)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"invoice_status": {
"type": "integer",
"description": "請求ステータス\n\n- 1：未請求\n- 4：請求OK\n- 2：請求済\n- 5：一部入金済\n- 3：入金済\n- 9：回収不能\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
9
]
}
},
"required": [
"invoice_status"
]
}
}
}
},
"responses": {
"204": {
"description": "成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/invoices/invoice_status/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"invoice_status\": 2\n}'"
}
]
}
},
"/documents/estimates/{id}": {
"patch": {
"tags": [
"project_document"
],
"summary": "見積書更新",
"description": "ID指定で見積書を更新します。",
"operationId": "patchEstimate",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "見積書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`estimate`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "見積書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"valid_period": {
"type": "string",
"description": "有効期限",
"maxLength": 100,
"example": "御見積後2週間"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "見積日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "見積書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"valid_period": {
"type": "string",
"description": "有効期限",
"maxLength": 100,
"example": "御見積後2週間"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "見積日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/documents/estimates/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"total\": 200000,\n \"tax\": 20000,\n \"message\": \"サンプル備考です。\",\n \"details\": [\n {\n \"description\": \"サンプル明細1\",\n \"quantity\": 1,\n \"unit\": \"式\",\n \"unit_price\": 100000\n },\n {\n \"description\": \"サンプル明細2\",\n \"quantity\": 1,\n \"unit\": \"式\",\n \"unit_price\": 100000\n }\n ]\n}'"
}
]
},
"get": {
"tags": [
"project_document"
],
"summary": "見積書取得",
"description": "ID指定で見積書を取得します。",
"operationId": "getEstimate",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "見積書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`estimate`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "見積書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"valid_period": {
"type": "string",
"description": "有効期限",
"maxLength": 100,
"example": "御見積後2週間"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "見積日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/documents/estimates/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/documents/estimates/lock_flg/{id}": {
"patch": {
"tags": [
"project_document"
],
"summary": "見積書ロック",
"description": "ID指定で見積書のロック状態を変更します。",
"operationId": "patchEstimateLockFlg",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "見積書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`estimate`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"example": 1,
"enum": [
0,
1
]
}
}
}
}
}
},
"responses": {
"204": {
"description": "成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/documents/estimates/lock_flg/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"lock_flg\": 1\n}'"
}
]
}
},
"/documents/orders/{id}": {
"patch": {
"tags": [
"project_document"
],
"summary": "発注書更新",
"description": "ID指定で発注書を更新します。",
"operationId": "patchOrder",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`order`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"disp_order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日（表示設定）",
"example": "2023-10-01"
},
"disp_order_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注請日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発注請日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"disp_order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日（表示設定）",
"example": "2023-10-01"
},
"disp_order_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注請日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発注請日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/documents/orders/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"total\": 200000,\n \"tax\": 20000,\n \"message\": \"サンプル備考です。\",\n \"details\": [\n {\n \"description\": \"サンプル明細1\",\n \"quantity\": 1,\n \"unit\": \"式\",\n \"unit_price\": 100000\n },\n {\n \"description\": \"サンプル明細2\",\n \"quantity\": 1,\n \"unit\": \"式\",\n \"unit_price\": 100000\n }\n ]\n}'"
}
]
},
"get": {
"tags": [
"project_document"
],
"summary": "発注書取得",
"description": "ID指定で発注書を取得します。",
"operationId": "getOrder",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`order`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"disp_order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日（表示設定）",
"example": "2023-10-01"
},
"disp_order_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注請日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発注請日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/documents/orders/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/documents/orders/lock_flg/{id}": {
"patch": {
"tags": [
"project_document"
],
"summary": "発注書ロック",
"description": "ID指定で発注書のロック状態を変更します。",
"operationId": "patchOrderLockFlg",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`order`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"example": 1,
"enum": [
0,
1
]
}
}
}
}
}
},
"responses": {
"204": {
"description": "成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/documents/orders/lock_flg/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"lock_flg\": 1\n}'"
}
]
}
},
"/documents/deliveries/{id}": {
"patch": {
"tags": [
"project_document"
],
"summary": "納品書更新",
"description": "ID指定で納品書を更新します。",
"operationId": "patchDelivery",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "納品書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`deliveries`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "納品書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "納品書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`deliveries`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日",
"example": "2023-10-01"
},
"disp_delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日（表示設定）",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "納品日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "納品書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "納品書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`deliveries`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日",
"example": "2023-10-01"
},
"disp_delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日（表示設定）",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "納品日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/documents/deliveries/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"total\": 200000,\n \"tax\": 20000,\n \"message\": \"サンプル備考です。\",\n \"details\": [\n {\n \"description\": \"サンプル明細1\",\n \"quantity\": 1,\n \"unit\": \"式\",\n \"unit_price\": 100000\n },\n {\n \"description\": \"サンプル明細2\",\n \"quantity\": 1,\n \"unit\": \"式\",\n \"unit_price\": 100000\n }\n ]\n}'"
}
]
},
"get": {
"tags": [
"project_document"
],
"summary": "納品書取得",
"description": "ID指定で納品書を取得します。",
"operationId": "getDelivery",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "納品書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`deliveries`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "納品書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "納品書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`deliveries`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日",
"example": "2023-10-01"
},
"disp_delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日（表示設定）",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "納品日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/documents/deliveries/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/documents/deliveries/lock_flg/{id}": {
"patch": {
"tags": [
"project_document"
],
"summary": "納品書ロック",
"description": "ID指定で納品書のロック状態を変更します。",
"operationId": "patchDeliveryLockFlg",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "納品書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`deliveries`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"example": 1,
"enum": [
0,
1
]
}
}
}
}
}
},
"responses": {
"204": {
"description": "成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/documents/deliveries/lock_flg/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"lock_flg\": 1\n}'"
}
]
}
},
"/documents/invoices/{id}": {
"patch": {
"tags": [
"project_document"
],
"summary": "請求書更新",
"description": "ID指定で請求書を更新します。",
"operationId": "patchInvoice",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "請求書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`invoices`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "請求書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "請求書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`invoices`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31",
"readOnly": true
},
"payment_limit_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払期限",
"example": "2023-11-30",
"readOnly": true
},
"disp_invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "請求日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"multi_bank_info_flg": {
"type": "integer",
"description": "複数口座表示\n\n- 0：OFF\n- 1：ON\n\n※デフォルトは設定による\n",
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "請求書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "請求書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`invoices`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31",
"readOnly": true
},
"payment_limit_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払期限",
"example": "2023-11-30",
"readOnly": true
},
"disp_invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "請求日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"multi_bank_info_flg": {
"type": "integer",
"description": "複数口座表示\n\n- 0：OFF\n- 1：ON\n\n※デフォルトは設定による\n",
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/documents/invoices/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"total\": 200000,\n \"tax\": 20000,\n \"message\": \"サンプル備考です。\",\n \"details\": [\n {\n \"description\": \"サンプル明細1\",\n \"quantity\": 1,\n \"unit\": \"式\",\n \"unit_price\": 100000\n },\n {\n \"description\": \"サンプル明細2\",\n \"quantity\": 1,\n \"unit\": \"式\",\n \"unit_price\": 100000\n }\n ]\n}'"
}
]
},
"get": {
"tags": [
"project_document"
],
"summary": "請求書取得",
"description": "ID指定で請求書を取得します。",
"operationId": "getInvoice",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "請求書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`invoices`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "請求書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "請求書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`invoices`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31",
"readOnly": true
},
"payment_limit_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払期限",
"example": "2023-11-30",
"readOnly": true
},
"disp_invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "請求日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"multi_bank_info_flg": {
"type": "integer",
"description": "複数口座表示\n\n- 0：OFF\n- 1：ON\n\n※デフォルトは設定による\n",
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/documents/invoices/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/documents/invoices/lock_flg/{id}": {
"patch": {
"tags": [
"project_document"
],
"summary": "請求書ロック",
"description": "ID指定で請求書のロック状態を変更します。",
"operationId": "patchInvoiceLockFlg",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "請求書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`invoices`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"example": 1,
"enum": [
0,
1
]
}
}
}
}
}
},
"responses": {
"204": {
"description": "成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/documents/invoices/lock_flg/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"lock_flg\": 1\n}'"
}
]
}
},
"/documents/receipts/{id}": {
"patch": {
"tags": [
"project_document"
],
"summary": "領収書更新",
"description": "ID指定で領収書を更新します。",
"operationId": "patchReceipt",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "領収書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`receipts`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "領収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "領収書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`receipts`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日",
"example": "2023-10-01",
"readOnly": true
},
"disp_receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発行日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "領収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "領収書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`receipts`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日",
"example": "2023-10-01",
"readOnly": true
},
"disp_receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発行日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/documents/receipts/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"total\": 200000,\n \"tax\": 20000,\n \"message\": \"サンプル備考です。\",\n \"details\": [\n {\n \"description\": \"サンプル明細1\",\n \"quantity\": 1,\n \"unit\": \"式\",\n \"unit_price\": 100000\n },\n {\n \"description\": \"サンプル明細2\",\n \"quantity\": 1,\n \"unit\": \"式\",\n \"unit_price\": 100000\n }\n ]\n}'"
}
]
},
"get": {
"tags": [
"project_document"
],
"summary": "領収書取得",
"description": "ID指定で領収書を取得します。",
"operationId": "getReceipt",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "領収書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`receipts`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "領収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "領収書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`receipts`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日",
"example": "2023-10-01",
"readOnly": true
},
"disp_receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発行日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/documents/receipts/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/documents/receipts/lock_flg/{id}": {
"patch": {
"tags": [
"project_document"
],
"summary": "領収書ロック",
"description": "ID指定で領収書のロック状態を変更します。",
"operationId": "patchReceiptLockFlg",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "領収書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`receipts`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"example": 1,
"enum": [
0,
1
]
}
}
}
}
}
},
"responses": {
"204": {
"description": "成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/documents/receipts/lock_flg/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"lock_flg\": 1\n}'"
}
]
}
},
"/payees": {
"get": {
"tags": [
"payee"
],
"summary": "発注先リスト取得",
"description": "発注先リストを取得します。",
"operationId": "getPayees",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "name_cont",
"in": "query",
"description": "発注先名（部分一致）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプル株式会社"
}
},
{
"name": "name_disp_cont",
"in": "query",
"description": "発注先略称名（部分一致）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプル"
}
},
{
"name": "invoice_system_number_eq",
"in": "query",
"description": "適格請求書発行事業者の登録番号",
"schema": {
"type": "string",
"example": "T1234567890123"
}
},
{
"name": "tags[]",
"in": "query",
"description": "タグ（複数の場合はカンマ区切り）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプルタグA,サンプルタグB"
}
},
{
"name": "include_archive_flg",
"in": "query",
"description": "アーカイブを含むか\n\n- 0：アーカイブ済みは除く\n- 1：アーカイブ済みも含む\n",
"schema": {
"type": "integer",
"default": 0,
"example": 1,
"enum": [
0,
1
]
}
},
{
"name": "updated_at_gteq",
"in": "query",
"description": "更新日時（指定日時以降）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "updated_at_lteq",
"in": "query",
"description": "更新日時（指定日時以前）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "custom_no_eq",
"in": "query",
"description": "発注先番号",
"schema": {
"type": "string",
"example": "12345"
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
{
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
},
{
"name": "response_group",
"in": "query",
"description": "レスポンスグループ\n\n| response_group | 項目 |\n|:-----------|:------------|\n| small | id, name, name_disp, title, zip, pref, address1, address2, tel, fax, payment_term_id, payment_term_name, company_number, invoice_system_number, invoice_system_number_validated, invoice_system_issuer_type, invoice_system_issuer_type_name, created_at, updated_at |\n| large | すべての項目 |\n",
"schema": {
"type": "string",
"default": "small",
"example": "large",
"enum": [
"small",
"large"
],
"externalDocs": {
"description": "※レスポンスグループについて",
"url": "#section/レスポンスグループ"
}
}
}
],
"responses": {
"200": {
"description": "成功",
"headers": {
"X-Total-Count": {
"description": "トータル件数",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Page": {
"description": "現在のページ番号",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Per-Page": {
"description": "1ページあたりの件数",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"allOf": [
{
"description": "発注先関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "発注先ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"properties": {
"title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"default": "御中",
"example": "御中"
},
"payment_term_id": {
"description": "デフォルト支払条件ID\n\n- 新規登録時に未指定の場合は最初の支払条件が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "デフォルト支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"nda_flg": {
"description": "NDA締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"basic_agreement_flg": {
"description": "基本契約書締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"document_send_type": {
"description": "書類送付方法\n\n- 1：メール(DL)\n- 2：郵送\n- 3：メール(DL)+郵送\n- 4：メール(添付)\n- 5：メール(添付)+郵送\n- または[カスタム書類送付方法](#tag/document_send_channel/operation/getDocumentSendChannels)のID\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1
},
"document_send_type_name": {
"type": "string",
"description": "書類送付方法名",
"example": "メール(DL)",
"readOnly": true
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"wareki_flg": {
"description": "デフォルト和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_number": {
"type": "string",
"description": "法人番号",
"minLength": 13,
"maxLength": 13,
"example": "1234567890123"
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード\n\n※「会計連携機能」機能有効時のみ\n",
"maxLength": 100,
"example": "サンプル（株）"
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"invoice_system_number": {
"type": "string",
"description": "適格請求書発行事業者の登録番号",
"minLength": 14,
"maxLength": 14,
"example": "T1234567890123"
},
"invoice_system_number_validated": {
"type": "boolean",
"description": "登録番号のチェック状況",
"example": true,
"readOnly": true
},
"invoice_system_issuer_type": {
"description": "適格請求書発行事業者\n\n- 0：未設定\n- 1：該当する\n- 2：該当しない\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1,
2
]
},
"invoice_system_issuer_type_name": {
"type": "string",
"description": "適格請求書発行事業者の名称",
"example": "未設定",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"bank_charge_to_client_flg": {
"description": "振込手数料負担\n\n- 0：当方\n- 1：先方\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 1,
"enum": [
0,
1
]
},
"tax_withholding_kbn": {
"description": "デフォルト源泉徴収\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "デフォルト源泉徴収名",
"example": "なし",
"readOnly": true
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
},
"name_en": {
"type": "string",
"description": "発注先名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
}
}
},
{
"properties": {
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": "81"
},
"currency": {
"type": "string",
"description": "デフォルト通貨\n\n※英語アドオン有効時のみ\n",
"maxLength": 3,
"default": "JPY",
"example": "USD",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"description": "デフォルト言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "デフォルト言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/payees' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
},
"post": {
"tags": [
"payee"
],
"summary": "発注先登録",
"description": "発注先を新規登録します。",
"operationId": "postPayee",
"security": [
{
"api_token": [],
"api_key": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"name",
"name_disp"
],
"allOf": [
{
"description": "発注先関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "発注先ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"properties": {
"title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"default": "御中",
"example": "御中"
},
"payment_term_id": {
"description": "デフォルト支払条件ID\n\n- 新規登録時に未指定の場合は最初の支払条件が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "デフォルト支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"nda_flg": {
"description": "NDA締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"basic_agreement_flg": {
"description": "基本契約書締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"document_send_type": {
"description": "書類送付方法\n\n- 1：メール(DL)\n- 2：郵送\n- 3：メール(DL)+郵送\n- 4：メール(添付)\n- 5：メール(添付)+郵送\n- または[カスタム書類送付方法](#tag/document_send_channel/operation/getDocumentSendChannels)のID\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1
},
"document_send_type_name": {
"type": "string",
"description": "書類送付方法名",
"example": "メール(DL)",
"readOnly": true
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"wareki_flg": {
"description": "デフォルト和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_number": {
"type": "string",
"description": "法人番号",
"minLength": 13,
"maxLength": 13,
"example": "1234567890123"
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード\n\n※「会計連携機能」機能有効時のみ\n",
"maxLength": 100,
"example": "サンプル（株）"
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"invoice_system_number": {
"type": "string",
"description": "適格請求書発行事業者の登録番号",
"minLength": 14,
"maxLength": 14,
"example": "T1234567890123"
},
"invoice_system_number_validated": {
"type": "boolean",
"description": "登録番号のチェック状況",
"example": true,
"readOnly": true
},
"invoice_system_issuer_type": {
"description": "適格請求書発行事業者\n\n- 0：未設定\n- 1：該当する\n- 2：該当しない\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1,
2
]
},
"invoice_system_issuer_type_name": {
"type": "string",
"description": "適格請求書発行事業者の名称",
"example": "未設定",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"bank_charge_to_client_flg": {
"description": "振込手数料負担\n\n- 0：当方\n- 1：先方\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 1,
"enum": [
0,
1
]
},
"tax_withholding_kbn": {
"description": "デフォルト源泉徴収\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "デフォルト源泉徴収名",
"example": "なし",
"readOnly": true
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
},
"name_en": {
"type": "string",
"description": "発注先名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
}
}
},
{
"properties": {
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": "81"
},
"currency": {
"type": "string",
"description": "デフォルト通貨\n\n※英語アドオン有効時のみ\n",
"maxLength": 3,
"default": "JPY",
"example": "USD",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"description": "デフォルト言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "デフォルト言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "登録成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注先関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "発注先ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"properties": {
"title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"default": "御中",
"example": "御中"
},
"payment_term_id": {
"description": "デフォルト支払条件ID\n\n- 新規登録時に未指定の場合は最初の支払条件が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "デフォルト支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"nda_flg": {
"description": "NDA締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"basic_agreement_flg": {
"description": "基本契約書締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"document_send_type": {
"description": "書類送付方法\n\n- 1：メール(DL)\n- 2：郵送\n- 3：メール(DL)+郵送\n- 4：メール(添付)\n- 5：メール(添付)+郵送\n- または[カスタム書類送付方法](#tag/document_send_channel/operation/getDocumentSendChannels)のID\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1
},
"document_send_type_name": {
"type": "string",
"description": "書類送付方法名",
"example": "メール(DL)",
"readOnly": true
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"wareki_flg": {
"description": "デフォルト和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_number": {
"type": "string",
"description": "法人番号",
"minLength": 13,
"maxLength": 13,
"example": "1234567890123"
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード\n\n※「会計連携機能」機能有効時のみ\n",
"maxLength": 100,
"example": "サンプル（株）"
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"invoice_system_number": {
"type": "string",
"description": "適格請求書発行事業者の登録番号",
"minLength": 14,
"maxLength": 14,
"example": "T1234567890123"
},
"invoice_system_number_validated": {
"type": "boolean",
"description": "登録番号のチェック状況",
"example": true,
"readOnly": true
},
"invoice_system_issuer_type": {
"description": "適格請求書発行事業者\n\n- 0：未設定\n- 1：該当する\n- 2：該当しない\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1,
2
]
},
"invoice_system_issuer_type_name": {
"type": "string",
"description": "適格請求書発行事業者の名称",
"example": "未設定",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"bank_charge_to_client_flg": {
"description": "振込手数料負担\n\n- 0：当方\n- 1：先方\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 1,
"enum": [
0,
1
]
},
"tax_withholding_kbn": {
"description": "デフォルト源泉徴収\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "デフォルト源泉徴収名",
"example": "なし",
"readOnly": true
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
},
"name_en": {
"type": "string",
"description": "発注先名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
}
}
},
{
"properties": {
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": "81"
},
"currency": {
"type": "string",
"description": "デフォルト通貨\n\n※英語アドオン有効時のみ\n",
"maxLength": 3,
"default": "JPY",
"example": "USD",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"description": "デフォルト言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "デフォルト言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/payees' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"name\": \"サンプル株式会社\",\n \"name_disp\": \"サンプル\"\n}'"
}
]
}
},
"/payees/{id}": {
"patch": {
"tags": [
"payee"
],
"summary": "発注先更新",
"description": "ID指定で発注先を更新します。",
"operationId": "patchPayee",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注先関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "発注先ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"properties": {
"title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"default": "御中",
"example": "御中"
},
"payment_term_id": {
"description": "デフォルト支払条件ID\n\n- 新規登録時に未指定の場合は最初の支払条件が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "デフォルト支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"nda_flg": {
"description": "NDA締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"basic_agreement_flg": {
"description": "基本契約書締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"document_send_type": {
"description": "書類送付方法\n\n- 1：メール(DL)\n- 2：郵送\n- 3：メール(DL)+郵送\n- 4：メール(添付)\n- 5：メール(添付)+郵送\n- または[カスタム書類送付方法](#tag/document_send_channel/operation/getDocumentSendChannels)のID\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1
},
"document_send_type_name": {
"type": "string",
"description": "書類送付方法名",
"example": "メール(DL)",
"readOnly": true
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"wareki_flg": {
"description": "デフォルト和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_number": {
"type": "string",
"description": "法人番号",
"minLength": 13,
"maxLength": 13,
"example": "1234567890123"
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード\n\n※「会計連携機能」機能有効時のみ\n",
"maxLength": 100,
"example": "サンプル（株）"
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"invoice_system_number": {
"type": "string",
"description": "適格請求書発行事業者の登録番号",
"minLength": 14,
"maxLength": 14,
"example": "T1234567890123"
},
"invoice_system_number_validated": {
"type": "boolean",
"description": "登録番号のチェック状況",
"example": true,
"readOnly": true
},
"invoice_system_issuer_type": {
"description": "適格請求書発行事業者\n\n- 0：未設定\n- 1：該当する\n- 2：該当しない\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1,
2
]
},
"invoice_system_issuer_type_name": {
"type": "string",
"description": "適格請求書発行事業者の名称",
"example": "未設定",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"bank_charge_to_client_flg": {
"description": "振込手数料負担\n\n- 0：当方\n- 1：先方\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 1,
"enum": [
0,
1
]
},
"tax_withholding_kbn": {
"description": "デフォルト源泉徴収\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "デフォルト源泉徴収名",
"example": "なし",
"readOnly": true
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
},
"name_en": {
"type": "string",
"description": "発注先名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
}
}
},
{
"properties": {
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": "81"
},
"currency": {
"type": "string",
"description": "デフォルト通貨\n\n※英語アドオン有効時のみ\n",
"maxLength": 3,
"default": "JPY",
"example": "USD",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"description": "デフォルト言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "デフォルト言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注先関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "発注先ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"properties": {
"title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"default": "御中",
"example": "御中"
},
"payment_term_id": {
"description": "デフォルト支払条件ID\n\n- 新規登録時に未指定の場合は最初の支払条件が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "デフォルト支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"nda_flg": {
"description": "NDA締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"basic_agreement_flg": {
"description": "基本契約書締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"document_send_type": {
"description": "書類送付方法\n\n- 1：メール(DL)\n- 2：郵送\n- 3：メール(DL)+郵送\n- 4：メール(添付)\n- 5：メール(添付)+郵送\n- または[カスタム書類送付方法](#tag/document_send_channel/operation/getDocumentSendChannels)のID\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1
},
"document_send_type_name": {
"type": "string",
"description": "書類送付方法名",
"example": "メール(DL)",
"readOnly": true
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"wareki_flg": {
"description": "デフォルト和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_number": {
"type": "string",
"description": "法人番号",
"minLength": 13,
"maxLength": 13,
"example": "1234567890123"
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード\n\n※「会計連携機能」機能有効時のみ\n",
"maxLength": 100,
"example": "サンプル（株）"
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"invoice_system_number": {
"type": "string",
"description": "適格請求書発行事業者の登録番号",
"minLength": 14,
"maxLength": 14,
"example": "T1234567890123"
},
"invoice_system_number_validated": {
"type": "boolean",
"description": "登録番号のチェック状況",
"example": true,
"readOnly": true
},
"invoice_system_issuer_type": {
"description": "適格請求書発行事業者\n\n- 0：未設定\n- 1：該当する\n- 2：該当しない\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1,
2
]
},
"invoice_system_issuer_type_name": {
"type": "string",
"description": "適格請求書発行事業者の名称",
"example": "未設定",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"bank_charge_to_client_flg": {
"description": "振込手数料負担\n\n- 0：当方\n- 1：先方\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 1,
"enum": [
0,
1
]
},
"tax_withholding_kbn": {
"description": "デフォルト源泉徴収\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "デフォルト源泉徴収名",
"example": "なし",
"readOnly": true
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
},
"name_en": {
"type": "string",
"description": "発注先名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
}
}
},
{
"properties": {
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": "81"
},
"currency": {
"type": "string",
"description": "デフォルト通貨\n\n※英語アドオン有効時のみ\n",
"maxLength": 3,
"default": "JPY",
"example": "USD",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"description": "デフォルト言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "デフォルト言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/payees/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"name\": \"更新サンプル株式会社\"\n}'"
}
]
},
"delete": {
"tags": [
"payee"
],
"summary": "発注先削除",
"description": "ID指定で発注先を削除します。",
"operationId": "deletePayee",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "削除成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request DELETE 'https://api.the-board.jp/v1/payees/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'\n"
}
]
},
"get": {
"tags": [
"payee"
],
"summary": "発注先取得",
"description": "ID指定で発注先を取得します。",
"operationId": "getPayee",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注先関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "発注先ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"properties": {
"title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"default": "御中",
"example": "御中"
},
"payment_term_id": {
"description": "デフォルト支払条件ID\n\n- 新規登録時に未指定の場合は最初の支払条件が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "デフォルト支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"nda_flg": {
"description": "NDA締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"basic_agreement_flg": {
"description": "基本契約書締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"document_send_type": {
"description": "書類送付方法\n\n- 1：メール(DL)\n- 2：郵送\n- 3：メール(DL)+郵送\n- 4：メール(添付)\n- 5：メール(添付)+郵送\n- または[カスタム書類送付方法](#tag/document_send_channel/operation/getDocumentSendChannels)のID\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1
},
"document_send_type_name": {
"type": "string",
"description": "書類送付方法名",
"example": "メール(DL)",
"readOnly": true
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"wareki_flg": {
"description": "デフォルト和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_number": {
"type": "string",
"description": "法人番号",
"minLength": 13,
"maxLength": 13,
"example": "1234567890123"
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード\n\n※「会計連携機能」機能有効時のみ\n",
"maxLength": 100,
"example": "サンプル（株）"
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"invoice_system_number": {
"type": "string",
"description": "適格請求書発行事業者の登録番号",
"minLength": 14,
"maxLength": 14,
"example": "T1234567890123"
},
"invoice_system_number_validated": {
"type": "boolean",
"description": "登録番号のチェック状況",
"example": true,
"readOnly": true
},
"invoice_system_issuer_type": {
"description": "適格請求書発行事業者\n\n- 0：未設定\n- 1：該当する\n- 2：該当しない\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1,
2
]
},
"invoice_system_issuer_type_name": {
"type": "string",
"description": "適格請求書発行事業者の名称",
"example": "未設定",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"bank_charge_to_client_flg": {
"description": "振込手数料負担\n\n- 0：当方\n- 1：先方\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 1,
"enum": [
0,
1
]
},
"tax_withholding_kbn": {
"description": "デフォルト源泉徴収\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "デフォルト源泉徴収名",
"example": "なし",
"readOnly": true
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
},
"name_en": {
"type": "string",
"description": "発注先名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
}
}
},
{
"properties": {
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": "81"
},
"currency": {
"type": "string",
"description": "デフォルト通貨\n\n※英語アドオン有効時のみ\n",
"maxLength": 3,
"default": "JPY",
"example": "USD",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"description": "デフォルト言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "デフォルト言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/payees/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/payee_branches": {
"get": {
"tags": [
"payee_branch"
],
"summary": "発注先支社リスト取得",
"description": "発注先支社リストを取得します。",
"operationId": "getPayeeBranches",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "payee_id_eq",
"in": "query",
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"schema": {
"type": "integer",
"example": 123456
}
},
{
"name": "include_archive_flg",
"in": "query",
"description": "アーカイブを含むか\n\n- 0：アーカイブ済みは除く\n- 1：アーカイブ済みも含む\n",
"schema": {
"type": "integer",
"default": 0,
"example": 1,
"enum": [
0,
1
]
}
},
{
"name": "updated_at_gteq",
"in": "query",
"description": "更新日時（指定日時以降）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "updated_at_lteq",
"in": "query",
"description": "更新日時（指定日時以前）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
{
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
}
],
"responses": {
"200": {
"description": "成功",
"headers": {
"X-Total-Count": {
"description": "トータル件数",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Page": {
"description": "現在のページ番号",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Per-Page": {
"description": "1ページあたりの件数",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"allOf": [
{
"description": "発注先支社関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "発注先支社ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"type": "object",
"properties": {
"name_en": {
"type": "string",
"description": "発注先支社名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
},
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": 81
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/payee_branches' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
},
"post": {
"tags": [
"payee_branch"
],
"summary": "発注先支社登録",
"description": "発注先支社を新規登録します。",
"operationId": "postPayeeBranch",
"security": [
{
"api_token": [],
"api_key": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"required": [
"payee_id",
"name"
],
"allOf": [
{
"description": "発注先支社関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "発注先支社ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"type": "object",
"properties": {
"name_en": {
"type": "string",
"description": "発注先支社名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
},
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": 81
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "登録成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注先支社関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "発注先支社ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"type": "object",
"properties": {
"name_en": {
"type": "string",
"description": "発注先支社名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
},
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": 81
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/payee_branches' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"payee_id\": 123456,\n \"name\": \"サンプル支社\"\n}'"
}
]
}
},
"/payee_branches/{id}": {
"patch": {
"tags": [
"payee_branch"
],
"summary": "発注先支社更新",
"description": "ID指定で発注先支社を更新します。",
"operationId": "patchPayeeBranch",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注先支社ID\n\n※[発注先支社登録API](#tag/payee_branch/operation/postPayeeBranch)・[発注先支社リスト取得API](#tag/payee_branch/operation/getPayeeBranches)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注先支社関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "発注先支社ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"type": "object",
"properties": {
"name_en": {
"type": "string",
"description": "発注先支社名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
},
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": 81
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注先支社関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "発注先支社ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"type": "object",
"properties": {
"name_en": {
"type": "string",
"description": "発注先支社名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
},
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": 81
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/payee_branches/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"name\": \"更新サンプル支社\"\n}'"
}
]
},
"delete": {
"tags": [
"payee_branch"
],
"summary": "発注先支社削除",
"description": "ID指定で発注先支社を削除します。",
"operationId": "deletePayeeBranch",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注先支社ID\n\n※[発注先支社登録API](#tag/payee_branch/operation/postPayeeBranch)・[発注先支社リスト取得API](#tag/payee_branch/operation/getPayeeBranches)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "削除成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request DELETE 'https://api.the-board.jp/v1/payee_branches/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'\n"
}
]
},
"get": {
"tags": [
"payee_branch"
],
"summary": "発注先支社取得",
"description": "ID指定で発注先支社を取得します。",
"operationId": "getPayeeBranch",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注先支社ID\n\n※[発注先支社登録API](#tag/payee_branch/operation/postPayeeBranch)・[発注先支社リスト取得API](#tag/payee_branch/operation/getPayeeBranches)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注先支社関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "発注先支社ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"type": "object",
"properties": {
"name_en": {
"type": "string",
"description": "発注先支社名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
},
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": 81
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/payee_branches/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/payee_contacts": {
"get": {
"tags": [
"payee_contact"
],
"summary": "発注先担当者リスト取得",
"description": "発注先担当者リストを取得します。",
"operationId": "getPayeeContacts",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "payee_id_eq",
"in": "query",
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"schema": {
"type": "integer",
"example": 123456
}
},
{
"name": "include_archive_flg",
"in": "query",
"description": "アーカイブを含むか\n\n- 0：アーカイブ済みは除く\n- 1：アーカイブ済みも含む\n",
"schema": {
"type": "integer",
"default": 0,
"example": 1,
"enum": [
0,
1
]
}
},
{
"name": "updated_at_gteq",
"in": "query",
"description": "更新日時（指定日時以降）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "updated_at_lteq",
"in": "query",
"description": "更新日時（指定日時以前）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
{
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
}
],
"responses": {
"200": {
"description": "成功",
"headers": {
"X-Total-Count": {
"description": "トータル件数",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Page": {
"description": "現在のページ番号",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Per-Page": {
"description": "1ページあたりの件数",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"description": "発注先担当者ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎"
},
"honorific_title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"example": "様"
},
"title": {
"type": "string",
"description": "肩書",
"maxLength": 50,
"example": "部長"
},
"department": {
"type": "string",
"description": "部署",
"maxLength": 50,
"example": "システム部"
},
"email": {
"type": "string",
"description": "email",
"maxLength": 100,
"example": "yamada@example.com"
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"last_name_en": {
"type": "string",
"description": "姓（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Yamada"
},
"first_name_en": {
"type": "string",
"description": "名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Taro"
},
"prefix_en": {
"type": "string",
"description": "敬称（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Mr."
},
"title_en": {
"type": "string",
"description": "肩書（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Manager"
},
"department_en": {
"type": "string",
"description": "部署（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "IT Dept."
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/payee_contacts' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
},
"post": {
"tags": [
"payee_contact"
],
"summary": "発注先担当者登録",
"description": "発注先担当者を新規登録します。",
"operationId": "postPayeeContact",
"security": [
{
"api_token": [],
"api_key": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "発注先担当者関連の定義情報",
"required": [
"payee_id",
"last_name"
],
"properties": {
"id": {
"description": "発注先担当者ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎"
},
"honorific_title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"example": "様"
},
"title": {
"type": "string",
"description": "肩書",
"maxLength": 50,
"example": "部長"
},
"department": {
"type": "string",
"description": "部署",
"maxLength": 50,
"example": "システム部"
},
"email": {
"type": "string",
"description": "email",
"maxLength": 100,
"example": "yamada@example.com"
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"last_name_en": {
"type": "string",
"description": "姓（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Yamada"
},
"first_name_en": {
"type": "string",
"description": "名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Taro"
},
"prefix_en": {
"type": "string",
"description": "敬称（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Mr."
},
"title_en": {
"type": "string",
"description": "肩書（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Manager"
},
"department_en": {
"type": "string",
"description": "部署（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "IT Dept."
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
},
"required": true
},
"responses": {
"201": {
"description": "登録成功",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "発注先担当者ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎"
},
"honorific_title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"example": "様"
},
"title": {
"type": "string",
"description": "肩書",
"maxLength": 50,
"example": "部長"
},
"department": {
"type": "string",
"description": "部署",
"maxLength": 50,
"example": "システム部"
},
"email": {
"type": "string",
"description": "email",
"maxLength": 100,
"example": "yamada@example.com"
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"last_name_en": {
"type": "string",
"description": "姓（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Yamada"
},
"first_name_en": {
"type": "string",
"description": "名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Taro"
},
"prefix_en": {
"type": "string",
"description": "敬称（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Mr."
},
"title_en": {
"type": "string",
"description": "肩書（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Manager"
},
"department_en": {
"type": "string",
"description": "部署（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "IT Dept."
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/payee_contacts' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"payee_id\": 123456,\n \"last_name\": \"山田\",\n \"first_name\": \"太郎\"\n}'"
}
]
}
},
"/payee_contacts/{id}": {
"patch": {
"tags": [
"payee_contact"
],
"summary": "発注先担当者更新",
"description": "ID指定で発注先担当者を更新します。",
"operationId": "patchPayeeContact",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注先担当者ID\n\n※[発注先担当者登録API](#tag/payee_contact/operation/postPayeeContact)・[発注先担当者リスト取得API](#tag/payee_contact/operation/getPayeeContacts)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "発注先担当者関連の定義情報",
"properties": {
"id": {
"description": "発注先担当者ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎"
},
"honorific_title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"example": "様"
},
"title": {
"type": "string",
"description": "肩書",
"maxLength": 50,
"example": "部長"
},
"department": {
"type": "string",
"description": "部署",
"maxLength": 50,
"example": "システム部"
},
"email": {
"type": "string",
"description": "email",
"maxLength": 100,
"example": "yamada@example.com"
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"last_name_en": {
"type": "string",
"description": "姓（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Yamada"
},
"first_name_en": {
"type": "string",
"description": "名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Taro"
},
"prefix_en": {
"type": "string",
"description": "敬称（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Mr."
},
"title_en": {
"type": "string",
"description": "肩書（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Manager"
},
"department_en": {
"type": "string",
"description": "部署（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "IT Dept."
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "発注先担当者ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎"
},
"honorific_title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"example": "様"
},
"title": {
"type": "string",
"description": "肩書",
"maxLength": 50,
"example": "部長"
},
"department": {
"type": "string",
"description": "部署",
"maxLength": 50,
"example": "システム部"
},
"email": {
"type": "string",
"description": "email",
"maxLength": 100,
"example": "yamada@example.com"
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"last_name_en": {
"type": "string",
"description": "姓（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Yamada"
},
"first_name_en": {
"type": "string",
"description": "名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Taro"
},
"prefix_en": {
"type": "string",
"description": "敬称（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Mr."
},
"title_en": {
"type": "string",
"description": "肩書（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Manager"
},
"department_en": {
"type": "string",
"description": "部署（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "IT Dept."
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/payee_contacts/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"first_name\": \"次郎\"\n}'"
}
]
},
"delete": {
"tags": [
"payee_contact"
],
"summary": "発注先担当者削除",
"description": "ID指定で発注先担当者を削除します。",
"operationId": "deletePayeeContact",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注先担当者ID\n\n※[発注先担当者登録API](#tag/payee_contact/operation/postPayeeContact)・[発注先担当者リスト取得API](#tag/payee_contact/operation/getPayeeContacts)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "削除成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request DELETE 'https://api.the-board.jp/v1/payee_contacts/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'\n"
}
]
},
"get": {
"tags": [
"payee_contact"
],
"summary": "発注先担当者取得",
"description": "ID指定で発注先担当者を取得します。",
"operationId": "getPayeeContact",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注先担当者ID\n\n※[発注先担当者登録API](#tag/payee_contact/operation/postPayeeContact)・[発注先担当者リスト取得API](#tag/payee_contact/operation/getPayeeContacts)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "発注先担当者ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎"
},
"honorific_title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"example": "様"
},
"title": {
"type": "string",
"description": "肩書",
"maxLength": 50,
"example": "部長"
},
"department": {
"type": "string",
"description": "部署",
"maxLength": 50,
"example": "システム部"
},
"email": {
"type": "string",
"description": "email",
"maxLength": 100,
"example": "yamada@example.com"
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"last_name_en": {
"type": "string",
"description": "姓（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Yamada"
},
"first_name_en": {
"type": "string",
"description": "名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Taro"
},
"prefix_en": {
"type": "string",
"description": "敬称（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Mr."
},
"title_en": {
"type": "string",
"description": "肩書（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Manager"
},
"department_en": {
"type": "string",
"description": "部署（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "IT Dept."
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/payee_contacts/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/expenditures": {
"get": {
"tags": [
"expenditure"
],
"summary": "発注リスト取得",
"description": "発注リストを取得します。取得結果は新しい順で取得されます。",
"operationId": "getExpenditures",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "name_cont",
"in": "query",
"description": "発注名（部分一致）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプル案件"
}
},
{
"name": "payee_id_eq",
"in": "query",
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"schema": {
"type": "integer",
"example": 123456
}
},
{
"name": "payee_name_cont",
"in": "query",
"description": "発注先名（部分一致）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプル株式会社"
}
},
{
"name": "payee_name_disp_cont",
"in": "query",
"description": "発注先略称名（部分一致）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプル"
}
},
{
"name": "expenditure_status_in[]",
"in": "query",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n\n※複数の場合はカンマ区切り\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "4,5"
}
},
{
"name": "delivery_status_in[]",
"in": "query",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n\n※複数の場合はカンマ区切り\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "1,2"
}
},
{
"name": "expenditure_no_eq",
"in": "query",
"description": "発注No",
"schema": {
"type": "integer",
"example": 1001
}
},
{
"name": "management_no_eq",
"in": "query",
"description": "管理番号",
"schema": {
"type": "string",
"example": "SAMPLE0001"
}
},
{
"name": "tags[]",
"in": "query",
"description": "タグ（OR条件、複数の場合はカンマ区切り）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプルタグA,サンプルタグB"
}
},
{
"name": "project_id_eq",
"in": "query",
"description": "関連案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"schema": {
"type": "integer",
"example": 123456
}
},
{
"name": "created_at_gteq",
"in": "query",
"description": "作成日時（指定日時以降）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "created_at_lteq",
"in": "query",
"description": "作成日時（指定日時以前）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "updated_at_gteq",
"in": "query",
"description": "更新日時（指定日時以降）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "updated_at_lteq",
"in": "query",
"description": "更新日時（指定日時以前）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "include_not_ordered_flg",
"in": "query",
"description": "見送りステータスを含むか\n\n- 0：見送りは除く\n- 1：見送りも含む\n",
"schema": {
"type": "integer",
"default": 0,
"example": 1
}
},
{
"name": "include_archive_flg",
"in": "query",
"description": "アーカイブを含むか\n\n- 0：アーカイブ済みは除く\n- 1：アーカイブ済みも含む\n",
"schema": {
"type": "integer",
"default": 0,
"example": 1,
"enum": [
0,
1
]
}
},
{
"name": "expenditure_order_order_date_gteq",
"in": "query",
"description": "発注日（指定日以降）",
"schema": {
"type": "string",
"format": "YYYY-MM-DD",
"example": "2023-10-01"
}
},
{
"name": "expenditure_order_order_date_lteq",
"in": "query",
"description": "発注日（指定日以前）",
"schema": {
"type": "string",
"format": "YYYY-MM-DD",
"example": "2023-10-01"
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
{
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
},
{
"name": "response_group",
"in": "query",
"description": "レスポンスグループ\n\n| response_group | 項目 |\n|:-----------|:------------|\n| small | id, expenditure_no, management_no, name, payee, payee_contact, user, total, tax, tax_withholding, tax_withholding_kbn, tax_withholding_kbn_name, order_date, invoice_dates, expenditure_status, expenditure_status_name, expenditure_type_id, expenditure_type_name, expenditure_type2_id, expenditure_type2_name, expenditure_type3_id, expenditure_type3_name, group_id, group_name, delivery_status, delivery_status_name, currency, created_at, updated_at |\n| medium | smallに加え以下の項目
payee_branch, company_branch, project, payment_term_id, payment_term_name, payment_timing_kbn, payment_timing_kbn_name, contract_start_date, contract_end_date, periodical_payment_interval, auto_renewal_flg, auto_renewal_period_month, periodical_payment_payment_kbn, periodical_payment_payment_kbn_name, tags, exchange_rate, total_jpy, tax_jpy |\n| large | 書類以外すべての項目 |\n| estimate | small + 見積依頼書 |\n| order | small + 発注書 |\n| delivery | small + 検収書 |\n| invoice | small + 支払通知書 |\n| all | large + すべての書類 |\n",
"schema": {
"type": "string",
"default": "small",
"example": "large",
"enum": [
"small",
"medium",
"large",
"estimate",
"order",
"delivery",
"invoice",
"all"
],
"externalDocs": {
"description": "※レスポンスグループについて",
"url": "#section/レスポンスグループ"
}
}
}
],
"responses": {
"200": {
"description": "成功",
"headers": {
"X-Total-Count": {
"description": "トータル件数",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Page": {
"description": "現在のページ番号",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Per-Page": {
"description": "1ページあたりの件数",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"allOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "発注ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"expenditure_no": {
"type": "integer",
"format": "int32",
"description": "発注No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注名",
"maxLength": 100,
"example": "サンプル発注A"
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"payee_branch_id": {
"description": "発注先支社ID\n\n※[発注先支社登録API](#tag/payee_branch/operation/postPayeeBranch)・[発注先支社リスト取得API](#tag/payee_branch/operation/getPayeeBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_branch": {
"description": "発注先支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"payee_name_disp_kbn": {
"type": "integer",
"description": "発注先支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_disp_kbn_name": {
"type": "string",
"description": "発注先支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_name_for_post_disp_kbn": {
"type": "integer",
"description": "発注先支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_for_post_disp_kbn_name": {
"type": "string",
"description": "発注先支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_contact_id": {
"description": "発注先担当者ID\n\n※[発注先担当者登録API](#tag/payee_contact/operation/postPayeeContact)・[発注先担当者リスト取得API](#tag/payee_contact/operation/getPayeeContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_contact": {
"description": "発注先担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "発注先担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "発注先担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"project_id": {
"description": "関連案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"project": {
"description": "案件",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "案件ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
}
}
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
],
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01",
"readOnly": true
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"expenditure_status": {
"type": "integer",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"expenditure_status_name": {
"type": "string",
"description": "発注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"payment_timing_kbn": {
"type": "integer",
"description": "支払タイミング\n\n- 1：一括支払\n- 2：定期支払\n- 3：分割支払\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"payment_timing_kbn_name": {
"type": "string",
"description": "支払タイミングの名称",
"example": "一括支払",
"readOnly": true
},
"tax_withholding_kbn": {
"type": "integer",
"description": "源泉徴収区分\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "源泉徴収区分の名称",
"example": "なし",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"expenditure_type_id": {
"type": "integer",
"description": "発注区分1\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type_name": {
"type": "string",
"description": "発注区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"expenditure_type2_id": {
"type": "integer",
"description": "発注区分2\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type2_name": {
"type": "string",
"description": "発注区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"expenditure_type3_id": {
"type": "integer",
"description": "発注区分3\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type3_name": {
"type": "string",
"description": "発注区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"company_bank_id": {
"type": "integer",
"description": "集計用出金口座（振込口座ID）\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"format": "int32",
"example": 123456
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"description": "発注金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"description": "発注金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"title": "一括支払",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括支払用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"title": "定期支払",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期支払用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期支払用\n",
"example": "2023-12-31"
},
"periodical_payment_interval": {
"type": "integer",
"description": "支払間隔\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_payment_payment_kbn": {
"type": "integer",
"description": "支払間隔内の請求時期\n\n- 1：支払間隔の最初の月\n- 2：支払間隔の最後の月\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"periodical_payment_payment_kbn_name": {
"type": "string",
"description": "請求間隔内の請求時期の名称",
"example": "支払間隔の最初の月",
"readOnly": true
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期支払用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期支払用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"title": "分割支払",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoices": {
"type": "array",
"description": "請求情報\n\n※分割支払用\n",
"writeOnly": true,
"items": {
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31"
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
},
"required": [
"invoice_date",
"total",
"tax"
]
}
}
}
}
]
},
{
"properties": {
"expenditure_estimate": {
"allOf": [
{
"description": "見積依頼書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積依頼書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"estimate_request_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "依頼日",
"example": "2023-10-01"
},
"desired_delivery_date_text": {
"type": "string",
"description": "希望納期",
"maxLength": 100,
"example": "2週間後"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "依頼日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"expenditure_order": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "発注日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"expenditure_deliveries": {
"type": "array",
"items": {
"allOf": [
{
"description": "検収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "検収書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_delivery`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"delivery_received_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "検収日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"expenditure_invoices": {
"type": "array",
"items": {
"allOf": [
{
"description": "支払通知書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "支払通知書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_invoice`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"paid_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "支払日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
}
]
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/expenditures' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
},
"post": {
"tags": [
"expenditure"
],
"summary": "発注登録",
"description": "発注を新規登録します。\n\n支払タイミング（一括支払・定期支払・分割支払）に応じてパラメーターが異なります。\n\n下記のリクエストパラメーターリストの上部にある「共通」「一括支払」「定期支払」「分割支払」のボタンでリクエストパラメーターを切り替えることができます。\n\n「共通」は、全支払タイミングで共通して使用するパラメーターです。「一括支払」「定期支払」「分割支払」は、それぞれの支払タイミング固有のパラメーターです。「共通+一括支払」のように組み合わせて使用してください。\n",
"operationId": "postExpenditure",
"security": [
{
"api_token": [],
"api_key": []
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "発注関連の定義情報",
"anyOf": [
{
"allOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "発注ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"expenditure_no": {
"type": "integer",
"format": "int32",
"description": "発注No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注名",
"maxLength": 100,
"example": "サンプル発注A"
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"payee_branch_id": {
"description": "発注先支社ID\n\n※[発注先支社登録API](#tag/payee_branch/operation/postPayeeBranch)・[発注先支社リスト取得API](#tag/payee_branch/operation/getPayeeBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_branch": {
"description": "発注先支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"payee_name_disp_kbn": {
"type": "integer",
"description": "発注先支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_disp_kbn_name": {
"type": "string",
"description": "発注先支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_name_for_post_disp_kbn": {
"type": "integer",
"description": "発注先支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_for_post_disp_kbn_name": {
"type": "string",
"description": "発注先支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_contact_id": {
"description": "発注先担当者ID\n\n※[発注先担当者登録API](#tag/payee_contact/operation/postPayeeContact)・[発注先担当者リスト取得API](#tag/payee_contact/operation/getPayeeContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_contact": {
"description": "発注先担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "発注先担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "発注先担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"project_id": {
"description": "関連案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"project": {
"description": "案件",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "案件ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
}
}
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
],
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01",
"readOnly": true
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"expenditure_status": {
"type": "integer",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"expenditure_status_name": {
"type": "string",
"description": "発注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"payment_timing_kbn": {
"type": "integer",
"description": "支払タイミング\n\n- 1：一括支払\n- 2：定期支払\n- 3：分割支払\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"payment_timing_kbn_name": {
"type": "string",
"description": "支払タイミングの名称",
"example": "一括支払",
"readOnly": true
},
"tax_withholding_kbn": {
"type": "integer",
"description": "源泉徴収区分\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "源泉徴収区分の名称",
"example": "なし",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"expenditure_type_id": {
"type": "integer",
"description": "発注区分1\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type_name": {
"type": "string",
"description": "発注区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"expenditure_type2_id": {
"type": "integer",
"description": "発注区分2\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type2_name": {
"type": "string",
"description": "発注区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"expenditure_type3_id": {
"type": "integer",
"description": "発注区分3\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type3_name": {
"type": "string",
"description": "発注区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"company_bank_id": {
"type": "integer",
"description": "集計用出金口座（振込口座ID）\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"format": "int32",
"example": 123456
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"description": "発注金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"description": "発注金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"required": [
"name",
"payee_id",
"user_id",
"expenditure_status",
"payment_timing_kbn",
"tax_withholding_kbn"
]
}
]
},
{
"allOf": [
{
"title": "一括支払",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括支払用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"required": [
"invoice_date",
"total",
"tax"
]
}
]
},
{
"allOf": [
{
"title": "定期支払",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期支払用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期支払用\n",
"example": "2023-12-31"
},
"periodical_payment_interval": {
"type": "integer",
"description": "支払間隔\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_payment_payment_kbn": {
"type": "integer",
"description": "支払間隔内の請求時期\n\n- 1：支払間隔の最初の月\n- 2：支払間隔の最後の月\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"periodical_payment_payment_kbn_name": {
"type": "string",
"description": "請求間隔内の請求時期の名称",
"example": "支払間隔の最初の月",
"readOnly": true
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期支払用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期支払用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"required": [
"contract_start_date",
"contract_end_date",
"total",
"tax"
]
}
]
},
{
"allOf": [
{
"title": "分割支払",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoices": {
"type": "array",
"description": "請求情報\n\n※分割支払用\n",
"writeOnly": true,
"items": {
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31"
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
},
"required": [
"invoice_date",
"total",
"tax"
]
}
}
}
}
]
},
{
"required": [
"invoices"
]
}
]
}
]
}
}
},
"required": true
},
"responses": {
"201": {
"description": "登録成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "発注ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"expenditure_no": {
"type": "integer",
"format": "int32",
"description": "発注No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注名",
"maxLength": 100,
"example": "サンプル発注A"
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"payee_branch_id": {
"description": "発注先支社ID\n\n※[発注先支社登録API](#tag/payee_branch/operation/postPayeeBranch)・[発注先支社リスト取得API](#tag/payee_branch/operation/getPayeeBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_branch": {
"description": "発注先支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"payee_name_disp_kbn": {
"type": "integer",
"description": "発注先支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_disp_kbn_name": {
"type": "string",
"description": "発注先支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_name_for_post_disp_kbn": {
"type": "integer",
"description": "発注先支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_for_post_disp_kbn_name": {
"type": "string",
"description": "発注先支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_contact_id": {
"description": "発注先担当者ID\n\n※[発注先担当者登録API](#tag/payee_contact/operation/postPayeeContact)・[発注先担当者リスト取得API](#tag/payee_contact/operation/getPayeeContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_contact": {
"description": "発注先担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "発注先担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "発注先担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"project_id": {
"description": "関連案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"project": {
"description": "案件",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "案件ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
}
}
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
],
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01",
"readOnly": true
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"expenditure_status": {
"type": "integer",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"expenditure_status_name": {
"type": "string",
"description": "発注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"payment_timing_kbn": {
"type": "integer",
"description": "支払タイミング\n\n- 1：一括支払\n- 2：定期支払\n- 3：分割支払\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"payment_timing_kbn_name": {
"type": "string",
"description": "支払タイミングの名称",
"example": "一括支払",
"readOnly": true
},
"tax_withholding_kbn": {
"type": "integer",
"description": "源泉徴収区分\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "源泉徴収区分の名称",
"example": "なし",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"expenditure_type_id": {
"type": "integer",
"description": "発注区分1\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type_name": {
"type": "string",
"description": "発注区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"expenditure_type2_id": {
"type": "integer",
"description": "発注区分2\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type2_name": {
"type": "string",
"description": "発注区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"expenditure_type3_id": {
"type": "integer",
"description": "発注区分3\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type3_name": {
"type": "string",
"description": "発注区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"company_bank_id": {
"type": "integer",
"description": "集計用出金口座（振込口座ID）\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"format": "int32",
"example": 123456
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"description": "発注金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"description": "発注金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"title": "一括支払",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括支払用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"title": "定期支払",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期支払用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期支払用\n",
"example": "2023-12-31"
},
"periodical_payment_interval": {
"type": "integer",
"description": "支払間隔\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_payment_payment_kbn": {
"type": "integer",
"description": "支払間隔内の請求時期\n\n- 1：支払間隔の最初の月\n- 2：支払間隔の最後の月\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"periodical_payment_payment_kbn_name": {
"type": "string",
"description": "請求間隔内の請求時期の名称",
"example": "支払間隔の最初の月",
"readOnly": true
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期支払用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期支払用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"title": "分割支払",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoices": {
"type": "array",
"description": "請求情報\n\n※分割支払用\n",
"writeOnly": true,
"items": {
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31"
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
},
"required": [
"invoice_date",
"total",
"tax"
]
}
}
}
}
]
},
{
"properties": {
"expenditure_estimate": {
"allOf": [
{
"description": "見積依頼書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積依頼書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"estimate_request_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "依頼日",
"example": "2023-10-01"
},
"desired_delivery_date_text": {
"type": "string",
"description": "希望納期",
"maxLength": 100,
"example": "2週間後"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "依頼日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"expenditure_order": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "発注日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"expenditure_deliveries": {
"type": "array",
"items": {
"allOf": [
{
"description": "検収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "検収書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_delivery`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"delivery_received_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "検収日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"expenditure_invoices": {
"type": "array",
"items": {
"allOf": [
{
"description": "支払通知書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "支払通知書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_invoice`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"paid_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "支払日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/expenditures' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"name\": \"サンプル発注A\",\n \"payee_id\": 123456,\n \"user_id\": 111111,\n \"expenditure_status\": 1,\n \"payment_timing_kbn\": 1,\n \"tax_withholding_kbn\": 1,\n \"invoice_date\": \"2023-10-31\",\n \"total\": 100000,\n \"tax\": 10000\n}'"
}
]
}
},
"/expenditures/{id}": {
"patch": {
"tags": [
"expenditure"
],
"summary": "発注更新",
"description": "発注ID指定で発注を更新します。\n\n分割支払に関する注意事項
\n現在、API経由での`invoices`の更新（請求日・請求回数の変更）には対応していません。\n",
"operationId": "patchExpenditure",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "発注関連の定義情報",
"anyOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "発注ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"expenditure_no": {
"type": "integer",
"format": "int32",
"description": "発注No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注名",
"maxLength": 100,
"example": "サンプル発注A"
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"payee_branch_id": {
"description": "発注先支社ID\n\n※[発注先支社登録API](#tag/payee_branch/operation/postPayeeBranch)・[発注先支社リスト取得API](#tag/payee_branch/operation/getPayeeBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_branch": {
"description": "発注先支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"payee_name_disp_kbn": {
"type": "integer",
"description": "発注先支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_disp_kbn_name": {
"type": "string",
"description": "発注先支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_name_for_post_disp_kbn": {
"type": "integer",
"description": "発注先支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_for_post_disp_kbn_name": {
"type": "string",
"description": "発注先支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_contact_id": {
"description": "発注先担当者ID\n\n※[発注先担当者登録API](#tag/payee_contact/operation/postPayeeContact)・[発注先担当者リスト取得API](#tag/payee_contact/operation/getPayeeContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_contact": {
"description": "発注先担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "発注先担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "発注先担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"project_id": {
"description": "関連案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"project": {
"description": "案件",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "案件ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
}
}
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
],
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01",
"readOnly": true
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"expenditure_status": {
"type": "integer",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"expenditure_status_name": {
"type": "string",
"description": "発注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"payment_timing_kbn": {
"type": "integer",
"description": "支払タイミング\n\n- 1：一括支払\n- 2：定期支払\n- 3：分割支払\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"payment_timing_kbn_name": {
"type": "string",
"description": "支払タイミングの名称",
"example": "一括支払",
"readOnly": true
},
"tax_withholding_kbn": {
"type": "integer",
"description": "源泉徴収区分\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "源泉徴収区分の名称",
"example": "なし",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"expenditure_type_id": {
"type": "integer",
"description": "発注区分1\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type_name": {
"type": "string",
"description": "発注区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"expenditure_type2_id": {
"type": "integer",
"description": "発注区分2\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type2_name": {
"type": "string",
"description": "発注区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"expenditure_type3_id": {
"type": "integer",
"description": "発注区分3\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type3_name": {
"type": "string",
"description": "発注区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"company_bank_id": {
"type": "integer",
"description": "集計用出金口座（振込口座ID）\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"format": "int32",
"example": 123456
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"description": "発注金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"description": "発注金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"title": "一括支払",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括支払用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"title": "定期支払",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期支払用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期支払用\n",
"example": "2023-12-31"
},
"periodical_payment_interval": {
"type": "integer",
"description": "支払間隔\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_payment_payment_kbn": {
"type": "integer",
"description": "支払間隔内の請求時期\n\n- 1：支払間隔の最初の月\n- 2：支払間隔の最後の月\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"periodical_payment_payment_kbn_name": {
"type": "string",
"description": "請求間隔内の請求時期の名称",
"example": "支払間隔の最初の月",
"readOnly": true
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期支払用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期支払用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"title": "分割支払",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
}
}
}
]
}
]
}
}
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "発注ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"expenditure_no": {
"type": "integer",
"format": "int32",
"description": "発注No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注名",
"maxLength": 100,
"example": "サンプル発注A"
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"payee_branch_id": {
"description": "発注先支社ID\n\n※[発注先支社登録API](#tag/payee_branch/operation/postPayeeBranch)・[発注先支社リスト取得API](#tag/payee_branch/operation/getPayeeBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_branch": {
"description": "発注先支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"payee_name_disp_kbn": {
"type": "integer",
"description": "発注先支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_disp_kbn_name": {
"type": "string",
"description": "発注先支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_name_for_post_disp_kbn": {
"type": "integer",
"description": "発注先支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_for_post_disp_kbn_name": {
"type": "string",
"description": "発注先支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_contact_id": {
"description": "発注先担当者ID\n\n※[発注先担当者登録API](#tag/payee_contact/operation/postPayeeContact)・[発注先担当者リスト取得API](#tag/payee_contact/operation/getPayeeContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_contact": {
"description": "発注先担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "発注先担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "発注先担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"project_id": {
"description": "関連案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"project": {
"description": "案件",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "案件ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
}
}
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
],
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01",
"readOnly": true
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"expenditure_status": {
"type": "integer",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"expenditure_status_name": {
"type": "string",
"description": "発注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"payment_timing_kbn": {
"type": "integer",
"description": "支払タイミング\n\n- 1：一括支払\n- 2：定期支払\n- 3：分割支払\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"payment_timing_kbn_name": {
"type": "string",
"description": "支払タイミングの名称",
"example": "一括支払",
"readOnly": true
},
"tax_withholding_kbn": {
"type": "integer",
"description": "源泉徴収区分\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "源泉徴収区分の名称",
"example": "なし",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"expenditure_type_id": {
"type": "integer",
"description": "発注区分1\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type_name": {
"type": "string",
"description": "発注区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"expenditure_type2_id": {
"type": "integer",
"description": "発注区分2\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type2_name": {
"type": "string",
"description": "発注区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"expenditure_type3_id": {
"type": "integer",
"description": "発注区分3\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type3_name": {
"type": "string",
"description": "発注区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"company_bank_id": {
"type": "integer",
"description": "集計用出金口座（振込口座ID）\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"format": "int32",
"example": 123456
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"description": "発注金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"description": "発注金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"title": "一括支払",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括支払用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"title": "定期支払",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期支払用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期支払用\n",
"example": "2023-12-31"
},
"periodical_payment_interval": {
"type": "integer",
"description": "支払間隔\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_payment_payment_kbn": {
"type": "integer",
"description": "支払間隔内の請求時期\n\n- 1：支払間隔の最初の月\n- 2：支払間隔の最後の月\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"periodical_payment_payment_kbn_name": {
"type": "string",
"description": "請求間隔内の請求時期の名称",
"example": "支払間隔の最初の月",
"readOnly": true
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期支払用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期支払用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"title": "分割支払",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoices": {
"type": "array",
"description": "請求情報\n\n※分割支払用\n",
"writeOnly": true,
"items": {
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31"
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
},
"required": [
"invoice_date",
"total",
"tax"
]
}
}
}
}
]
},
{
"properties": {
"expenditure_estimate": {
"allOf": [
{
"description": "見積依頼書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積依頼書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"estimate_request_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "依頼日",
"example": "2023-10-01"
},
"desired_delivery_date_text": {
"type": "string",
"description": "希望納期",
"maxLength": 100,
"example": "2週間後"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "依頼日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"expenditure_order": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "発注日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"expenditure_deliveries": {
"type": "array",
"items": {
"allOf": [
{
"description": "検収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "検収書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_delivery`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"delivery_received_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "検収日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"expenditure_invoices": {
"type": "array",
"items": {
"allOf": [
{
"description": "支払通知書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "支払通知書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_invoice`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"paid_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "支払日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/expenditures/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"name\": \"サンプル発注B\"\n}'"
}
]
},
"delete": {
"tags": [
"expenditure"
],
"summary": "発注削除",
"description": "発注ID指定で発注を削除します。",
"operationId": "deleteExpenditure",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"204": {
"description": "削除成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request DELETE 'https://api.the-board.jp/v1/expenditures/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'\n"
}
]
},
"get": {
"tags": [
"expenditure"
],
"summary": "発注取得",
"description": "発注ID指定で発注を取得します。",
"operationId": "getExpenditure",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
},
{
"name": "response_group",
"in": "query",
"description": "レスポンスグループ\n\n| response_group | 項目 |\n|:-----------|:------------|\n| small | id, expenditure_no, management_no, name, payee, payee_contact, user, total, tax, tax_withholding, tax_withholding_kbn, tax_withholding_kbn_name, order_date, invoice_dates, expenditure_status, expenditure_status_name, expenditure_type_id, expenditure_type_name, expenditure_type2_id, expenditure_type2_name, expenditure_type3_id, expenditure_type3_name, group_id, group_name, delivery_status, delivery_status_name, currency, created_at, updated_at |\n| medium | smallに加え以下の項目
payee_branch, company_branch, project, payment_term_id, payment_term_name, payment_timing_kbn, payment_timing_kbn_name, contract_start_date, contract_end_date, periodical_payment_interval, auto_renewal_flg, auto_renewal_period_month, periodical_payment_payment_kbn, periodical_payment_payment_kbn_name, tags, exchange_rate, total_jpy, tax_jpy |\n| large | 書類以外すべての項目 |\n| estimate | small + 見積依頼書 |\n| order | small + 発注書 |\n| delivery | small + 検収書 |\n| invoice | small + 支払通知書 |\n| all | large + すべての書類 |\n",
"schema": {
"type": "string",
"default": "small",
"example": "large",
"enum": [
"small",
"medium",
"large",
"estimate",
"order",
"delivery",
"invoice",
"all"
],
"externalDocs": {
"description": "※レスポンスグループについて",
"url": "#section/レスポンスグループ"
}
}
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "発注ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"expenditure_no": {
"type": "integer",
"format": "int32",
"description": "発注No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注名",
"maxLength": 100,
"example": "サンプル発注A"
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"payee_branch_id": {
"description": "発注先支社ID\n\n※[発注先支社登録API](#tag/payee_branch/operation/postPayeeBranch)・[発注先支社リスト取得API](#tag/payee_branch/operation/getPayeeBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_branch": {
"description": "発注先支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"payee_name_disp_kbn": {
"type": "integer",
"description": "発注先支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_disp_kbn_name": {
"type": "string",
"description": "発注先支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_name_for_post_disp_kbn": {
"type": "integer",
"description": "発注先支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_for_post_disp_kbn_name": {
"type": "string",
"description": "発注先支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_contact_id": {
"description": "発注先担当者ID\n\n※[発注先担当者登録API](#tag/payee_contact/operation/postPayeeContact)・[発注先担当者リスト取得API](#tag/payee_contact/operation/getPayeeContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_contact": {
"description": "発注先担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "発注先担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "発注先担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"project_id": {
"description": "関連案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"project": {
"description": "案件",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "案件ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
}
}
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
],
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01",
"readOnly": true
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"expenditure_status": {
"type": "integer",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"expenditure_status_name": {
"type": "string",
"description": "発注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"payment_timing_kbn": {
"type": "integer",
"description": "支払タイミング\n\n- 1：一括支払\n- 2：定期支払\n- 3：分割支払\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"payment_timing_kbn_name": {
"type": "string",
"description": "支払タイミングの名称",
"example": "一括支払",
"readOnly": true
},
"tax_withholding_kbn": {
"type": "integer",
"description": "源泉徴収区分\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "源泉徴収区分の名称",
"example": "なし",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"expenditure_type_id": {
"type": "integer",
"description": "発注区分1\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type_name": {
"type": "string",
"description": "発注区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"expenditure_type2_id": {
"type": "integer",
"description": "発注区分2\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type2_name": {
"type": "string",
"description": "発注区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"expenditure_type3_id": {
"type": "integer",
"description": "発注区分3\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type3_name": {
"type": "string",
"description": "発注区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"company_bank_id": {
"type": "integer",
"description": "集計用出金口座（振込口座ID）\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"format": "int32",
"example": 123456
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"description": "発注金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"description": "発注金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"title": "一括支払",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括支払用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"title": "定期支払",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期支払用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期支払用\n",
"example": "2023-12-31"
},
"periodical_payment_interval": {
"type": "integer",
"description": "支払間隔\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_payment_payment_kbn": {
"type": "integer",
"description": "支払間隔内の請求時期\n\n- 1：支払間隔の最初の月\n- 2：支払間隔の最後の月\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"periodical_payment_payment_kbn_name": {
"type": "string",
"description": "請求間隔内の請求時期の名称",
"example": "支払間隔の最初の月",
"readOnly": true
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期支払用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期支払用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"title": "分割支払",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoices": {
"type": "array",
"description": "請求情報\n\n※分割支払用\n",
"writeOnly": true,
"items": {
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31"
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
},
"required": [
"invoice_date",
"total",
"tax"
]
}
}
}
}
]
},
{
"properties": {
"expenditure_estimate": {
"allOf": [
{
"description": "見積依頼書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積依頼書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"estimate_request_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "依頼日",
"example": "2023-10-01"
},
"desired_delivery_date_text": {
"type": "string",
"description": "希望納期",
"maxLength": 100,
"example": "2週間後"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "依頼日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"expenditure_order": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "発注日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"expenditure_deliveries": {
"type": "array",
"items": {
"allOf": [
{
"description": "検収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "検収書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_delivery`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"delivery_received_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "検収日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"expenditure_invoices": {
"type": "array",
"items": {
"allOf": [
{
"description": "支払通知書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "支払通知書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_invoice`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"paid_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "支払日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/expenditures/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/expenditures/expenditure_status/{id}": {
"patch": {
"tags": [
"expenditure"
],
"summary": "発注ステータス変更",
"description": "発注ID指定で発注ステータスを変更します。",
"operationId": "patchExpenditureExpenditureStatus",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"expenditure_status": {
"type": "integer",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
}
},
"required": [
"expenditure_status"
]
}
}
}
},
"responses": {
"204": {
"description": "成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/expenditures/expenditure_status/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"expenditure_status\": 2\n}'"
}
]
}
},
"/expenditures/lock_flg/{id}": {
"patch": {
"tags": [
"expenditure"
],
"summary": "発注のロック",
"description": "発注ID指定で発注情報をロック・ロック解除します。",
"operationId": "patchExpenditureLockFlg",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"example": 1,
"enum": [
0,
1
]
}
},
"required": [
"lock_flg"
]
}
}
}
},
"responses": {
"204": {
"description": "成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/expenditures/lock_flg/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"lock_flg\": 1\n}'"
}
]
}
},
"/expenditure_payments": {
"get": {
"tags": [
"expenditure_payment"
],
"summary": "支払リスト取得",
"description": "支払リストを取得します。",
"operationId": "getExpenditurePayments",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "invoice_date_gteq",
"in": "query",
"description": "請求日（指定日以降）",
"schema": {
"type": "string",
"format": "YYYY-MM-DD",
"example": "2023-10-01"
}
},
{
"name": "invoice_date_lteq",
"in": "query",
"description": "請求日（指定日以前）",
"schema": {
"type": "string",
"format": "YYYY-MM-DD",
"example": "2023-10-01"
}
},
{
"name": "payment_date_gteq",
"in": "query",
"description": "支払期限（指定日以降）",
"schema": {
"type": "string",
"format": "YYYY-MM-DD",
"example": "2023-10-01"
}
},
{
"name": "payment_date_lteq",
"in": "query",
"description": "支払期限（指定日以前）",
"schema": {
"type": "string",
"format": "YYYY-MM-DD",
"example": "2023-10-01"
}
},
{
"name": "expenditure_expenditure_status_in[]",
"in": "query",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n\n※複数の場合はカンマ区切り\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "4,5"
}
},
{
"name": "payment_status_in[]",
"in": "query",
"description": "支払ステータス\n\n- 1：請求書未受領\n- 2：請求書受領済\n- 4：振込予約済\n- 3：支払済\n\n※複数の場合はカンマ区切り\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "4,5"
}
},
{
"name": "expenditure_expenditure_no_eq",
"in": "query",
"description": "発注No",
"schema": {
"type": "integer",
"example": 1001
}
},
{
"name": "expenditure_management_no_eq",
"in": "query",
"description": "管理番号",
"schema": {
"type": "string",
"example": "SAMPLE0001"
}
},
{
"name": "expenditure_name_cont",
"in": "query",
"description": "発注名（部分一致）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプル発注"
}
},
{
"name": "expenditure_payee_id_eq",
"in": "query",
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"schema": {
"type": "integer",
"example": 123456
}
},
{
"name": "expenditure_payee_name_cont",
"in": "query",
"description": "発注先名（部分一致）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプル株式会社"
}
},
{
"name": "expenditure_payee_name_disp_cont",
"in": "query",
"description": "発注先略称名（部分一致）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプル"
}
},
{
"name": "expenditure_tags[]",
"in": "query",
"description": "タグ（OR条件、複数の場合はカンマ区切り）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプルタグA,サンプルタグB"
}
},
{
"name": "expenditure_project_id_eq",
"in": "query",
"description": "関連案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"schema": {
"type": "integer",
"example": 123456
}
},
{
"name": "updated_at_gteq",
"in": "query",
"description": "更新日時（指定日時以降）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "updated_at_lteq",
"in": "query",
"description": "更新日時（指定日時以前）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
{
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
},
{
"name": "response_group",
"in": "query",
"description": "レスポンスグループ\n\n| response_group | 項目 |\n|:-----------|:------------|\n| small | id, expenditure_no, management_no, name, payee, payee_contact, user, total, tax, tax_withholding, invoice_date, payment_date, expenditure_status, expenditure_status_name, payment_status, payment_status_name, payment_method_kbn, payment_method_kbn_name, expenditure_type_id, expenditure_type_name, expenditure_type2_id, expenditure_type2_name, expenditure_type3_id, expenditure_type3_name, group_id, group_name, currency, created_at, updated_at |\n| medium | smallに加え以下の項目
payee_branch, company_branch, project, tags, exchange_rate, total_jpy, tax_jpy |\n| large | 書類以外すべての項目 |\n| invoice | small + 支払通知書 |\n",
"schema": {
"type": "string",
"default": "small",
"example": "large",
"enum": [
"small",
"medium",
"large",
"estimate",
"order",
"delivery",
"invoice",
"receipt",
"project_cost",
"all"
],
"externalDocs": {
"description": "※レスポンスグループについて",
"url": "#section/レスポンスグループ"
}
}
}
],
"responses": {
"200": {
"description": "成功",
"headers": {
"X-Total-Count": {
"description": "トータル件数",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Page": {
"description": "現在のページ番号",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Per-Page": {
"description": "1ページあたりの件数",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"description": "支払い関連の定義情報",
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "支払ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"expenditure_id": {
"description": "発注ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"expenditure_no": {
"type": "integer",
"format": "int32",
"description": "発注No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"name": {
"type": "string",
"description": "発注名",
"maxLength": 100,
"example": "サンプル発注A"
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"payee_branch": {
"description": "発注先支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"payee_contact": {
"description": "発注先担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "発注先担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "発注先担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"total": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210,
"readOnly": true
},
"project": {
"description": "案件",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "案件ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
}
}
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n",
"example": "2023-10-01"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払期限\n",
"example": "2023-10-01"
},
"expenditure_status": {
"type": "integer",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"expenditure_status_name": {
"type": "string",
"description": "発注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"payment_status": {
"type": "integer",
"description": "支払ステータス\n\n- 1：請求書未受領\n- 2：請求書受領済\n- 4：振込予約済\n- 3：支払済\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"payment_status_name": {
"type": "string",
"description": "支払ステータスの名称",
"example": "請求書未受領",
"readOnly": true
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"expenditure_type_id": {
"type": "integer",
"description": "発注区分1\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type_name": {
"type": "string",
"description": "発注区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"expenditure_type2_id": {
"type": "integer",
"description": "発注区分2\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type2_name": {
"type": "string",
"description": "発注区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"expenditure_type3_id": {
"type": "integer",
"description": "発注区分3\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type3_name": {
"type": "string",
"description": "発注区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"description": "支払金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"description": "支払金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/expenditure_payments' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/expenditure_payments/payment_status/{id}": {
"patch": {
"tags": [
"expenditure_payment"
],
"summary": "支払ステータス変更",
"description": "支払ID指定で請求ステータスを変更します。",
"operationId": "patchExpenditurePaymentPaymentStatus",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "支払ID\n\n※[支払リスト取得API](#tag/expenditure_payment/operation/getExpenditurePayments)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"payment_status": {
"type": "integer",
"description": "支払ステータス\n\n- 1：請求書未受領\n- 2：請求書受領済\n- 4：振込予約済\n- 3：支払済\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
}
},
"required": [
"payment_status"
]
}
}
}
},
"responses": {
"204": {
"description": "成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/expenditure_payments/payment_status/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"payment_status\": 2\n}'"
}
]
}
},
"/expenditure_payments/lock_flg/{id}": {
"patch": {
"tags": [
"expenditure_payment"
],
"summary": "支払のロック",
"description": "支払ID指定で支払のロック状態を変更します。",
"operationId": "patchExpenditurePaymentLockFlg",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "支払ID\n\n※[支払リスト取得API](#tag/expenditure_payment/operation/getExpenditurePayments)のレスポンスにある`id`\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"example": 1,
"enum": [
0,
1
]
}
},
"required": [
"lock_flg"
]
}
}
}
},
"responses": {
"204": {
"description": "成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/expenditure_payments/lock_flg/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"lock_flg\": 1\n}'"
}
]
}
},
"/expenditure_documents/estimates/{id}": {
"patch": {
"tags": [
"expenditure_document"
],
"summary": "見積依頼書更新",
"description": "ID指定で見積依頼書を更新します。",
"operationId": "patchExpenditureEstimate",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "見積依頼書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_estimate`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "見積依頼書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積依頼書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"estimate_request_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "依頼日",
"example": "2023-10-01"
},
"desired_delivery_date_text": {
"type": "string",
"description": "希望納期",
"maxLength": 100,
"example": "2週間後"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "依頼日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "見積依頼書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積依頼書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"estimate_request_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "依頼日",
"example": "2023-10-01"
},
"desired_delivery_date_text": {
"type": "string",
"description": "希望納期",
"maxLength": 100,
"example": "2週間後"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "依頼日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/expenditure_documents/estimates/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"total\": 200000,\n \"tax\": 20000,\n \"message\": \"サンプル備考です。\",\n \"details\": [\n {\n \"description\": \"サンプル明細1\",\n \"quantity\": 1,\n \"unit\": \"式\",\n \"unit_price\": 100000\n },\n {\n \"description\": \"サンプル明細2\",\n \"quantity\": 1,\n \"unit\": \"式\",\n \"unit_price\": 100000\n }\n ]\n}'"
}
]
},
"get": {
"tags": [
"expenditure_document"
],
"summary": "見積依頼書取得",
"description": "ID指定で見積依頼書を取得します。",
"operationId": "getExpenditureEstimate",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "見積依頼書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_estimate`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "見積依頼書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積依頼書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"estimate_request_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "依頼日",
"example": "2023-10-01"
},
"desired_delivery_date_text": {
"type": "string",
"description": "希望納期",
"maxLength": 100,
"example": "2週間後"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "依頼日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/expenditure_documents/estimates/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/expenditure_documents/estimates/lock_flg/{id}": {
"patch": {
"tags": [
"expenditure_document"
],
"summary": "見積依頼書ロック",
"description": "ID指定で見積依頼書のロック状態を変更します。",
"operationId": "patchExpenditureEstimateLockFlg",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "見積依頼書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_estimate`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"example": 1,
"enum": [
0,
1
]
}
}
}
}
}
},
"responses": {
"204": {
"description": "成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/expenditure_documents/estimates/lock_flg/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"lock_flg\": 1\n}'"
}
]
}
},
"/expenditure_documents/orders/{id}": {
"patch": {
"tags": [
"expenditure_document"
],
"summary": "発注書更新",
"description": "ID指定で発注書を更新します。",
"operationId": "patchExpenditureOrder",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_order`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "発注日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "発注日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/expenditure_documents/orders/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"total\": 200000,\n \"tax\": 20000,\n \"message\": \"サンプル備考です。\",\n \"details\": [\n {\n \"description\": \"サンプル明細1\",\n \"quantity\": 1,\n \"unit\": \"式\",\n \"unit_price\": 100000\n },\n {\n \"description\": \"サンプル明細2\",\n \"quantity\": 1,\n \"unit\": \"式\",\n \"unit_price\": 100000\n }\n ]\n}'"
}
]
},
"get": {
"tags": [
"expenditure_document"
],
"summary": "発注書取得",
"description": "ID指定で発注書を取得します。",
"operationId": "getExpenditureOrder",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_order`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "発注日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/expenditure_documents/orders/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/expenditure_documents/orders/lock_flg/{id}": {
"patch": {
"tags": [
"expenditure_document"
],
"summary": "発注書ロック",
"description": "ID指定で発注書のロック状態を変更します。",
"operationId": "patchExpenditureOrderLockFlg",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "発注書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_order`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"example": 1,
"enum": [
0,
1
]
}
}
}
}
}
},
"responses": {
"204": {
"description": "成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/expenditure_documents/orders/lock_flg/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"lock_flg\": 1\n}'"
}
]
}
},
"/expenditure_documents/deliveries/{id}": {
"patch": {
"tags": [
"expenditure_document"
],
"summary": "検収書更新",
"description": "ID指定で検収書を更新します。",
"operationId": "patchExpenditureDelivery",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "検収書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_delivery`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "検収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "検収書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_delivery`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"delivery_received_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "検収日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "検収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "検収書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_delivery`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"delivery_received_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "検収日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/expenditure_documents/deliveries/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"total\": 200000,\n \"tax\": 20000,\n \"message\": \"サンプル備考です。\",\n \"details\": [\n {\n \"description\": \"サンプル明細1\",\n \"quantity\": 1,\n \"unit\": \"式\",\n \"unit_price\": 100000\n },\n {\n \"description\": \"サンプル明細2\",\n \"quantity\": 1,\n \"unit\": \"式\",\n \"unit_price\": 100000\n }\n ]\n}'"
}
]
},
"get": {
"tags": [
"expenditure_document"
],
"summary": "検収書取得",
"description": "ID指定で検収書を取得します。",
"operationId": "getExpenditureDelivery",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "検収書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_delivery`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "検収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "検収書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_delivery`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"delivery_received_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "検収日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/expenditure_documents/deliveries/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/expenditure_documents/deliveries/lock_flg/{id}": {
"patch": {
"tags": [
"expenditure_document"
],
"summary": "検収書ロック",
"description": "ID指定で検収書のロック状態を変更します。",
"operationId": "patchExpenditureDeliveryLockFlg",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "検収書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_delivery`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"example": 1,
"enum": [
0,
1
]
}
}
}
}
}
},
"responses": {
"204": {
"description": "成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/expenditure_documents/deliveries/lock_flg/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"lock_flg\": 1\n}'"
}
]
}
},
"/expenditure_documents/invoices/{id}": {
"patch": {
"tags": [
"expenditure_document"
],
"summary": "支払通知書更新",
"description": "ID指定で支払通知書を更新します。",
"operationId": "patchExpenditureInvoice",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "支払通知書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_invoice`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "支払通知書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "支払通知書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_invoice`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"paid_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "支払日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "支払通知書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "支払通知書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_invoice`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"paid_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "支払日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/expenditure_documents/invoices/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"total\": 200000,\n \"tax\": 20000,\n \"message\": \"サンプル備考です。\",\n \"details\": [\n {\n \"description\": \"サンプル明細1\",\n \"quantity\": 1,\n \"unit\": \"式\",\n \"unit_price\": 100000\n },\n {\n \"description\": \"サンプル明細2\",\n \"quantity\": 1,\n \"unit\": \"式\",\n \"unit_price\": 100000\n }\n ]\n}'"
}
]
},
"get": {
"tags": [
"expenditure_document"
],
"summary": "支払通知書取得",
"description": "ID指定で支払通知書を取得します。",
"operationId": "getExpenditureInvoice",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "支払通知書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_invoice`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "支払通知書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "支払通知書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_invoice`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"paid_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "支払日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/expenditure_documents/invoices/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/expenditure_documents/invoices/lock_flg/{id}": {
"patch": {
"tags": [
"expenditure_document"
],
"summary": "支払通知書ロック",
"description": "ID指定で支払通知書のロック状態を変更します。",
"operationId": "patchExpenditureInvoiceLockFlg",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "id",
"in": "path",
"description": "支払通知書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_invoice`内の`id`（要レスポンスグループ指定）\n",
"required": true,
"schema": {
"type": "integer"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"example": 1,
"enum": [
0,
1
]
}
}
}
}
}
},
"responses": {
"204": {
"description": "成功"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location --request PATCH 'https://api.the-board.jp/v1/expenditure_documents/invoices/lock_flg/123456' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY' \\\n--data '{\n \"lock_flg\": 1\n}'"
}
]
}
},
"/analyses": {
"get": {
"tags": [
"analysis"
],
"summary": "計上データリスト取得",
"description": "計上データリストを取得します。\n\n### レスポンスデータに関する補足\n#### 計上データ区分に応じた項目\n計上データは、案件・案件原価・発注の3種類のデータがあり、それぞれ持っているデータの項目が異なります。\n\nたとえば、案件には、受注ステータス（`order_status`）・請求ステータス（`invoice_status`）・案件区分（`project_type_id`）などがありますが、発注にはそれらはありません。 逆に発注には、発注ステータス（`expenditure_status`）・支払ステータス（`payment_status`）・発注区分（`expenditure_type_id`）があります。\n\nそれぞれのデータが持っている項目については、画面と対比してご確認ください。\n\n#### auto_flg\n通常は1（自動）ですが、計上情報変更機能を使用して、画面上で手動で計上情報を変更している場合は、0（手動）になります。\n\n#### auto_renewal_simulation_flg\n定期請求・定期支払では、請求期間に応じた請求・支払のデータが生成されますが、自動契約更新がONになっている場合、画面上の集計機能においては、請求期間終了後も継続する想定でシミュレーションする機能があります。\n\n`auto_renewal_simulation_flg`が1のデータは、このシミュレーションデータに該当します。\n",
"operationId": "getAnalyses",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "report_ym_gteq",
"in": "query",
"description": "計上年月（指定日以降）",
"schema": {
"type": "string",
"format": "YYYY-MM",
"example": "2023-10"
}
},
{
"name": "report_ym_lteq",
"in": "query",
"description": "計上年月（指定日以前）",
"schema": {
"type": "string",
"format": "YYYY-MM",
"example": "2023-10"
}
},
{
"name": "analysis_data_kbn_in[]",
"in": "query",
"description": "計上データ区分\n\n- 1：案件\n- 2：案件原価\n- 3：発注\n\n※複数の場合はカンマ区切り\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "1,2"
}
},
{
"name": "order_status_in[]",
"in": "query",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n\n※複数の場合はカンマ区切り\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "4,5"
}
},
{
"name": "expenditure_status_in[]",
"in": "query",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n\n※複数の場合はカンマ区切り\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "4,5"
}
},
{
"name": "include_auto_renewal_flg",
"in": "query",
"description": "自動契約更新を考慮\n\n- 0：自動契約更新のシミュレーションデータを含まない\n- 1：自動契約更新のシミュレーションデータを含む\n\n※未指定時は`0`指定時と同等の結果\n",
"schema": {
"type": "integer",
"example": 1,
"enum": [
0,
1
]
}
},
{
"name": "invoice_status_in[]",
"in": "query",
"description": "請求ステータス\n\n- 1：未請求\n- 4：請求OK\n- 2：請求済\n- 5：一部入金済\n- 3：入金済\n- 9：回収不能\n\n※複数の場合はカンマ区切り\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "4,5"
}
},
{
"name": "payment_status_in[]",
"in": "query",
"description": "支払ステータス\n\n- 1：請求書未受領\n- 2：請求書受領済\n- 4：振込予約済\n- 3：支払済\n\n※複数の場合はカンマ区切り\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "1,2"
}
},
{
"name": "updated_at_gteq",
"in": "query",
"description": "更新日時（指定日時以降）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "updated_at_lteq",
"in": "query",
"description": "更新日時（指定日時以前）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
{
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
}
],
"responses": {
"200": {
"description": "成功",
"headers": {
"X-Total-Count": {
"description": "トータル件数",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Page": {
"description": "現在のページ番号",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Per-Page": {
"description": "1ページあたりの件数",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"description": "計上データ関連の定義情報",
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "計上データID",
"format": "int64",
"example": 123456,
"readOnly": true
},
"analysis_data_kbn": {
"type": "integer",
"description": "データ種類\n\n- 1：案件\n- 2：案件原価\n- 3：発注\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"analysis_data_kbn_name": {
"type": "string",
"description": "データ種類の名称",
"example": "案件",
"readOnly": true
},
"project": {
"description": "案件",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "案件ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
}
}
},
"expenditure": {
"description": "発注",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注名",
"maxLength": 100,
"example": "サンプル発注A"
},
"expenditure_no": {
"type": "integer",
"description": "発注No",
"maxLength": 11,
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001",
"readOnly": true
}
}
},
"project_cost": {
"description": "案件原価",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "案件原価ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件原価の説明",
"maxLength": 100,
"example": "サンプル原価"
}
}
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10210"
},
"order_status": {
"type": "integer",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"order_status_name": {
"type": "string",
"description": "受注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"invoice_status": {
"type": "integer",
"description": "請求ステータス\n\n- 1：未請求\n- 4：請求OK\n- 2：請求済\n- 5：一部入金済\n- 3：入金済\n- 9：回収不能\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
9
]
},
"invoice_status_name": {
"type": "string",
"description": "請求ステータスの名称",
"example": "未請求",
"readOnly": true
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"expenditure_status": {
"type": "integer",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"expenditure_status_name": {
"type": "string",
"description": "発注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"payment_status": {
"type": "integer",
"description": "支払ステータス\n\n- 1：請求書未受領\n- 2：請求書受領済\n- 4：振込予約済\n- 3：支払済\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"payment_status_name": {
"type": "string",
"description": "支払ステータスの名称",
"example": "請求書未受領",
"readOnly": true
},
"report_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "計上日\n",
"example": "2023-10-01"
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"group": {
"description": "グループ",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "グループID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "グループ名",
"maxLength": 100,
"example": "グループA"
}
}
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"project_type_id": {
"type": "integer",
"description": "案件区分1ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type_name": {
"type": "string",
"description": "案件区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"project_type2_id": {
"type": "integer",
"description": "案件区分2ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type2_name": {
"type": "string",
"description": "案件区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"project_type3_id": {
"type": "integer",
"description": "案件区分3ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type3_name": {
"type": "string",
"description": "案件区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"expenditure_type_id": {
"type": "integer",
"description": "発注区分1\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type_name": {
"type": "string",
"description": "発注区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"expenditure_type2_id": {
"type": "integer",
"description": "発注区分2\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type2_name": {
"type": "string",
"description": "発注区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"expenditure_type3_id": {
"type": "integer",
"description": "発注区分3\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type3_name": {
"type": "string",
"description": "発注区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"auto_flg": {
"type": "integer",
"description": "自動/手動\n\n- 0：手動\n- 1：自動\n",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"auto_renewal_simulation_flg": {
"type": "integer",
"description": "自動契約更新シミュレーション\n\n- 0：自動契約更新シミュレーションデータではない\n- 1：自動契約更新シミュレーションデータ\n",
"default": 0,
"example": null,
"enum": [
0,
1
]
},
"classification_record_type": {
"type": "integer",
"description": "データ種別\n\n- 1：オリジナル\n- 2：明細別分類\n- 3：明細別分類（調整）\n- 4：明細別分類（除外）\n- 5：手動追加\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5
]
},
"classification_record_type_name": {
"type": "string",
"description": "データ種別の名称",
"example": "オリジナル",
"readOnly": true
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"total_jpy": {
"type": "integer",
"description": "税抜金額（JPY）",
"example": 100000
},
"tax_jpy": {
"type": "integer",
"description": "消費税（JPY）",
"example": 10000
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/analyses' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/users": {
"get": {
"tags": [
"user"
],
"summary": "ユーザーリスト取得",
"description": "ユーザーリストを取得します。",
"operationId": "getUsers",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "email_eq",
"in": "query",
"description": "メールアドレス\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "yamada@example.com"
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
{
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
}
],
"responses": {
"200": {
"description": "成功",
"headers": {
"X-Total-Count": {
"description": "トータル件数",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Page": {
"description": "現在のページ番号",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Per-Page": {
"description": "1ページあたりの件数",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"description": "ユーザー（担当者）関連の定義情報",
"type": "object",
"properties": {
"id": {
"description": "ユーザーID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"email": {
"type": "string",
"description": "メールアドレス",
"maxLength": 255,
"example": "yamada@example.com",
"readOnly": true
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田",
"readOnly": true
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎",
"readOnly": true
},
"role_id": {
"description": "ユーザー権限ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"role_name": {
"type": "string",
"description": "ユーザー権限名",
"maxLength": 100,
"example": "管理者",
"readOnly": true
},
"last_sign_in_at": {
"type": "string",
"description": "最終ログイン",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"valid_flg": {
"type": "integer",
"description": "有効フラグ\n\n- 0：無効\n- 1：有効\n",
"readOnly": true,
"example": 1,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/users' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/groups": {
"get": {
"tags": [
"group"
],
"summary": "グループリスト取得",
"description": "グループリストを取得します。",
"operationId": "getGroups",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "name_cont",
"in": "query",
"description": "グループ名\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "グループA"
}
},
{
"name": "include_archive_flg",
"in": "query",
"description": "アーカイブを含むか\n\n- 0：アーカイブ済みは除く\n- 1：アーカイブ済みも含む\n",
"schema": {
"type": "integer",
"default": 0,
"example": 1,
"enum": [
0,
1
]
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
{
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
}
],
"responses": {
"200": {
"description": "成功",
"headers": {
"X-Total-Count": {
"description": "トータル件数",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Page": {
"description": "現在のページ番号",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Per-Page": {
"description": "1ページあたりの件数",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"description": "グループ関連の定義情報",
"type": "object",
"properties": {
"id": {
"description": "グループID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "グループ名",
"maxLength": 50,
"example": "グループA",
"readOnly": true
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_bank_id": {
"description": "デフォルト振込口座ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"company_bank_name": {
"type": "string",
"description": "デフォルト振込口座名",
"maxLength": 200,
"example": "サンプル銀行 サンプル支店",
"readOnly": true
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード",
"maxLength": 100,
"example": "SAMPLE001",
"readOnly": true
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/groups' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/payment_terms": {
"get": {
"tags": [
"payment_term"
],
"summary": "支払条件リスト取得",
"description": "支払条件リストを取得します。",
"operationId": "getPaymentTerms",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "name_cont",
"in": "query",
"description": "支払条件名\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "月末締め翌月末払い"
}
},
{
"name": "include_archive_flg",
"in": "query",
"description": "アーカイブを含むか\n\n- 0：アーカイブ済みは除く\n- 1：アーカイブ済みも含む\n",
"schema": {
"type": "integer",
"default": 0,
"example": 1,
"enum": [
0,
1
]
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
{
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
}
],
"responses": {
"200": {
"description": "成功",
"headers": {
"X-Total-Count": {
"description": "トータル件数",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Page": {
"description": "現在のページ番号",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Per-Page": {
"description": "1ページあたりの件数",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"description": "支払条件関連の定義情報",
"type": "object",
"properties": {
"id": {
"description": "支払条件ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/payment_terms' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/project_types": {
"get": {
"tags": [
"project_type"
],
"summary": "案件区分リスト取得",
"description": "案件区分リストを取得します。",
"operationId": "getProjectTypes",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "project_type_kbn_eq",
"in": "query",
"description": "案件区分1〜3の種類\n\n- 1：案件区分1\n- 2：案件区分2\n- 3：案件区分3\n\n※未指定時は`1`指定時と同等の結果\n",
"schema": {
"type": "integer",
"example": 1
}
},
{
"name": "name_cont",
"in": "query",
"description": "案件区分名\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプル区分A"
}
},
{
"name": "include_archive_flg",
"in": "query",
"description": "アーカイブを含むか\n\n- 0：アーカイブ済みは除く\n- 1：アーカイブ済みも含む\n",
"schema": {
"type": "integer",
"default": 0,
"example": 1,
"enum": [
0,
1
]
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
{
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
}
],
"responses": {
"200": {
"description": "成功",
"headers": {
"X-Total-Count": {
"description": "トータル件数",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Page": {
"description": "現在のページ番号",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Per-Page": {
"description": "1ページあたりの件数",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"description": "案件区分関連の定義情報",
"type": "object",
"properties": {
"id": {
"description": "案件区分ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件区分名",
"maxLength": 100,
"example": "サンプル区分A",
"readOnly": true
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_bank_id": {
"description": "デフォルト振込口座ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"company_bank_name": {
"type": "string",
"description": "デフォルト振込口座名",
"maxLength": 200,
"example": "サンプル銀行 サンプル支店",
"readOnly": true
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/project_types' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/expenditure_types": {
"get": {
"tags": [
"expenditure_type"
],
"summary": "発注区分リスト取得",
"description": "発注区分リストを取得します。",
"operationId": "getExpenditureTypes",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "expenditure_type_kbn_eq",
"in": "query",
"description": "発注区分1〜3の種類\n\n- 1：発注区分1\n- 2：発注区分2\n- 3：発注区分3\n\n※未指定時は`1`指定時と同等の結果\n",
"schema": {
"type": "integer",
"example": 1
}
},
{
"name": "name_cont",
"in": "query",
"description": "発注区分名\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプル区分A"
}
},
{
"name": "include_archive_flg",
"in": "query",
"description": "アーカイブを含むか\n\n- 0：アーカイブ済みは除く\n- 1：アーカイブ済みも含む\n",
"schema": {
"type": "integer",
"default": 0,
"example": 1,
"enum": [
0,
1
]
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
{
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
}
],
"responses": {
"200": {
"description": "成功",
"headers": {
"X-Total-Count": {
"description": "トータル件数",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Page": {
"description": "現在のページ番号",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Per-Page": {
"description": "1ページあたりの件数",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"description": "発注区分関連の定義情報",
"type": "object",
"properties": {
"id": {
"description": "発注区分ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注区分名",
"maxLength": 100,
"example": "サンプル区分A",
"readOnly": true
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/expenditure_types' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/accounting_types": {
"get": {
"tags": [
"accounting_type"
],
"summary": "会計区分リスト取得",
"description": "会計区分リストを取得します。",
"operationId": "getAccountingTypes",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "accounting_type_kbn_eq",
"in": "query",
"description": "会計区分1〜3の種類\n\n- 1：会計区分1\n- 2：会計区分2\n- 3：会計区分3\n\n※未指定時は`1`指定時と同等の結果\n",
"schema": {
"type": "integer",
"example": 1
}
},
{
"name": "name_cont",
"in": "query",
"description": "会計区分名\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "サンプル区分A"
}
},
{
"name": "include_archive_flg",
"in": "query",
"description": "アーカイブを含むか\n\n- 0：アーカイブ済みは除く\n- 1：アーカイブ済みも含む\n",
"schema": {
"type": "integer",
"default": 0,
"example": 1,
"enum": [
0,
1
]
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
{
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
}
],
"responses": {
"200": {
"description": "成功",
"headers": {
"X-Total-Count": {
"description": "トータル件数",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Page": {
"description": "現在のページ番号",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Per-Page": {
"description": "1ページあたりの件数",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"description": "会計区分関連の定義情報",
"type": "object",
"properties": {
"id": {
"description": "会計区分ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "会計区分名",
"maxLength": 100,
"example": "サンプル区分A",
"readOnly": true
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/accounting_types' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
},
"/document_send_channels": {
"get": {
"tags": [
"document_send_channel"
],
"summary": "カスタム書類送付方法リスト取得",
"description": "カスタム書類送付方法リストを取得します。",
"operationId": "getDocumentSendChannels",
"security": [
{
"api_token": [],
"api_key": []
}
],
"parameters": [
{
"name": "name_cont",
"in": "query",
"description": "カスタム書類送付方法名\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"example": "送付方法A"
}
},
{
"name": "include_archive_flg",
"in": "query",
"description": "アーカイブを含むか\n\n- 0：アーカイブ済みは除く\n- 1：アーカイブ済みも含む\n",
"schema": {
"type": "integer",
"default": 0,
"example": 1,
"enum": [
0,
1
]
}
},
{
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
{
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
}
],
"responses": {
"200": {
"description": "成功",
"headers": {
"X-Total-Count": {
"description": "トータル件数",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Page": {
"description": "現在のページ番号",
"schema": {
"type": "integer",
"format": "int32"
}
},
"X-Per-Page": {
"description": "1ページあたりの件数",
"schema": {
"type": "integer",
"format": "int32"
}
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"description": "カスタム書類送付方法関連の定義情報",
"type": "object",
"properties": {
"id": {
"description": "カスタム書類送付方法ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "カスタム書類送付方法名",
"maxLength": 100,
"example": "送付方法A",
"readOnly": true
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
}
},
"x-codeSamples": [
{
"lang": "Curl",
"source": "curl --location 'https://api.the-board.jp/v1/document_send_channels' \\\n--header 'Content-Type: application/json' \\\n--header 'Authorization: Bearer API-TOKEN' \\\n--header 'x-api-key: API-KEY'"
}
]
}
}
},
"components": {
"securitySchemes": {
"api_key": {
"description": "「開発者用API設定」画面で発行したAPIキーをリクエストヘッダーに `x-api-key: API-KEY` という形式で指定してください。\n",
"type": "apiKey",
"name": "x-api-key",
"in": "header"
},
"api_token": {
"description": "「開発者用API設定」画面で発行したAPIトークンをリクエストヘッダーに `Authorization: Bearer API-TOKEN` という形式で指定してください。\n",
"type": "http",
"scheme": "bearer"
}
},
"schemas": {
"Client": {
"allOf": [
{
"description": "顧客関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "顧客ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"properties": {
"title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"default": "御中",
"example": "御中"
},
"payment_term_id": {
"description": "デフォルト支払条件ID\n\n- 新規登録時に未指定の場合は最初の支払条件が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "デフォルト支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"nda_flg": {
"description": "NDA締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"basic_agreement_flg": {
"description": "基本契約書締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"document_send_type": {
"description": "書類送付方法\n\n- 1：メール(DL)\n- 2：郵送\n- 3：メール(DL)+郵送\n- 4：メール(添付)\n- 5：メール(添付)+郵送\n- または[カスタム書類送付方法](#tag/document_send_channel/operation/getDocumentSendChannels)のID\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1
},
"document_send_type_name": {
"type": "string",
"description": "書類送付方法名",
"example": "メール(DL)",
"readOnly": true
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"wareki_flg": {
"description": "デフォルト和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_number": {
"type": "string",
"description": "法人番号",
"minLength": 13,
"maxLength": 13,
"example": "1234567890123"
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード\n\n※「会計連携機能」機能有効時のみ\n",
"maxLength": 100,
"example": "サンプル（株）"
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"invoice_system_number": {
"type": "string",
"description": "適格請求書発行事業者の登録番号",
"minLength": 14,
"maxLength": 14,
"example": "T1234567890123"
},
"invoice_system_number_validated": {
"type": "boolean",
"description": "登録番号のチェック状況",
"example": true,
"readOnly": true
},
"invoice_system_issuer_type": {
"description": "適格請求書発行事業者\n\n- 0：未設定\n- 1：該当する\n- 2：該当しない\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1,
2
]
},
"invoice_system_issuer_type_name": {
"type": "string",
"description": "適格請求書発行事業者の名称",
"example": "未設定",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"bank_charge_to_client_flg": {
"description": "振込手数料負担\n\n- 0：当方\n- 1：先方\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
},
"company_bank_id": {
"description": "デフォルト振込口座ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"company_bank_name": {
"type": "string",
"description": "デフォルト振込口座（銀行名 支店名）",
"maxLength": 100,
"example": "サンプル銀行 サンプル支店",
"readOnly": true
},
"name_en": {
"type": "string",
"description": "顧客名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
}
}
},
{
"properties": {
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": "81"
},
"currency": {
"type": "string",
"description": "デフォルト通貨\n\n※英語アドオン有効時のみ\n",
"maxLength": 3,
"default": "JPY",
"example": "USD",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"description": "デフォルト言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "デフォルト言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
},
"ClientBranch": {
"allOf": [
{
"description": "顧客支社関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "顧客支社ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"type": "object",
"properties": {
"name_en": {
"type": "string",
"description": "顧客支社名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
},
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": 81
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
},
"Contact": {
"properties": {
"id": {
"description": "顧客担当者ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎"
},
"honorific_title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"example": "様"
},
"title": {
"type": "string",
"description": "肩書",
"maxLength": 50,
"example": "部長"
},
"department": {
"type": "string",
"description": "部署",
"maxLength": 50,
"example": "システム部"
},
"email": {
"type": "string",
"description": "email",
"maxLength": 100,
"example": "yamada@example.com"
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"last_name_en": {
"type": "string",
"description": "姓（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Yamada"
},
"first_name_en": {
"type": "string",
"description": "名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Taro"
},
"prefix_en": {
"type": "string",
"description": "敬称（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Mr."
},
"title_en": {
"type": "string",
"description": "肩書（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Manager"
},
"department_en": {
"type": "string",
"description": "部署（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "IT Dept."
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
"Project": {
"allOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "案件ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"client_branch_id": {
"description": "顧客支社ID\n\n※[顧客支社登録API](#tag/client_branch/operation/postClientBranch)・[顧客支社リスト取得API](#tag/client_branch/operation/getClientBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client_branch": {
"description": "顧客支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"client_name_disp_kbn": {
"type": "integer",
"description": "顧客支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_disp_kbn_name": {
"type": "string",
"description": "顧客支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"client_name_for_post_disp_kbn": {
"type": "integer",
"description": "顧客支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_for_post_disp_kbn_name": {
"type": "string",
"description": "顧客支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"contact_id": {
"description": "顧客担当者ID\n\n※[顧客担当者登録API](#tag/contact/operation/postContact)・[顧客担当者リスト取得API](#tag/contact/operation/getContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"contact": {
"description": "顧客担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "顧客担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "顧客担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"cost_total": {
"type": "integer",
"format": "int32",
"description": "原価",
"example": 10000,
"readOnly": true
},
"cost_tax": {
"type": "integer",
"format": "int32",
"description": "原価の消費税",
"example": 1000,
"readOnly": true
},
"invoice_total": {
"type": "string",
"description": "請求額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"invoice_tax": {
"type": "string",
"description": "請求額の消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"estimate_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "見積日\n\n※新規登録時に未指定の場合は、本日の日付がセットされます\n",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期\n",
"example": "2023-10-20"
},
"delivery_date_text": {
"type": "string",
"maxLength": 50,
"description": "納期テキスト\n",
"example": "サンプル納期"
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"order_status": {
"type": "integer",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"order_status_name": {
"type": "string",
"description": "受注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"invoice_timing_kbn": {
"type": "integer",
"description": "請求タイミング\n\n- 1：一括請求\n- 2：定期請求\n- 3：分割請求\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"invoice_timing_kbn_name": {
"type": "string",
"description": "請求タイミングの名称",
"example": "一括請求",
"readOnly": true
},
"project_type_id": {
"type": "integer",
"description": "案件区分1ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type_name": {
"type": "string",
"description": "案件区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"project_type2_id": {
"type": "integer",
"description": "案件区分2ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type2_name": {
"type": "string",
"description": "案件区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"project_type3_id": {
"type": "integer",
"description": "案件区分3ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type3_name": {
"type": "string",
"description": "案件区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"ordered_date": {
"type": "string",
"description": "受注日",
"format": "YYYY-MM-DD",
"example": "2023-10-05"
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"project_costs": {
"description": "案件原価",
"readOnly": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"cost": {
"type": "integer",
"format": "int64",
"description": "金額",
"example": 10000
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル費用"
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-10"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-10"
}
}
}
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"format": "int64",
"description": "見積金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"format": "int32",
"description": "見積金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"invoice_total_jpy": {
"type": "integer",
"format": "int64",
"description": "請求金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"invoice_tax_jpy": {
"type": "integer",
"format": "int32",
"description": "請求金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"hubspot": {
"description": "HubSpotと連携している場合は、その連携情報",
"readOnly": true,
"type": "object",
"properties": {
"hubspot_deal_id": {
"type": "string",
"description": "HubSpotの取引ID",
"example": "123456"
}
}
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"title": "一括請求",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括請求用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
}
}
}
]
},
{
"title": "定期請求",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期請求用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期請求用\n",
"example": "2023-12-31"
},
"periodical_invoice_interval": {
"type": "integer",
"description": "請求間隔\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_invoice_payment_kbn": {
"type": "integer",
"description": "請求間隔内の請求時期\n\n- 1：請求間隔の最初の月\n- 2：請求間隔の最後の月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"contract_end_alert_flg": {
"type": "integer",
"description": "通知対象\n\n- 0：通知しない\n- 1：通知する\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期請求用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期請求用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"monthly_invoice_payment_kbn": {
"type": "integer",
"description": "自動挿入メッセージ年月\n\n- 1：請求月\n- 2：請求月の翌月\n- 3：請求月の前月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
}
}
}
]
},
{
"title": "分割請求",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
]
}
}
}
]
},
{
"properties": {
"estimate": {
"allOf": [
{
"description": "見積書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"valid_period": {
"type": "string",
"description": "有効期限",
"maxLength": 100,
"example": "御見積後2週間"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "見積日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"order": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"disp_order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日（表示設定）",
"example": "2023-10-01"
},
"disp_order_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注請日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発注請日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"deliveries": {
"type": "array",
"items": {
"allOf": [
{
"description": "納品書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "納品書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`deliveries`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日",
"example": "2023-10-01"
},
"disp_delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日（表示設定）",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "納品日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"invoices": {
"type": "array",
"items": {
"allOf": [
{
"description": "請求書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "請求書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`invoices`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31",
"readOnly": true
},
"payment_limit_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払期限",
"example": "2023-11-30",
"readOnly": true
},
"disp_invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "請求日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"multi_bank_info_flg": {
"type": "integer",
"description": "複数口座表示\n\n- 0：OFF\n- 1：ON\n\n※デフォルトは設定による\n",
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"receipts": {
"type": "array",
"items": {
"allOf": [
{
"description": "領収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "領収書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`receipts`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日",
"example": "2023-10-01",
"readOnly": true
},
"disp_receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発行日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
}
]
},
"ProjectCost": {
"properties": {
"id": {
"description": "案件原価ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"project_id": {
"description": "案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル原価"
},
"cost": {
"type": "integer",
"description": "金額",
"format": "int32",
"example": 10000
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-11-30"
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
"InvoiceMonth": {
"description": "請求関連の定義情報",
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "請求ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"project_id": {
"description": "案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"client_branch": {
"description": "顧客支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"contact": {
"description": "顧客担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "顧客担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "顧客担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"total": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"cost_total": {
"type": "integer",
"description": "原価",
"example": 10000,
"readOnly": true
},
"cost_tax": {
"type": "integer",
"description": "原価の消費税",
"example": 1000,
"readOnly": true
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n",
"example": "2023-10-31"
},
"payment_limit_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払期限\n",
"example": "2023-11-30"
},
"order_status": {
"type": "integer",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"order_status_name": {
"type": "string",
"description": "受注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"invoice_status": {
"type": "integer",
"description": "請求ステータス\n\n- 1：未請求\n- 4：請求OK\n- 2：請求済\n- 5：一部入金済\n- 3：入金済\n- 9：回収不能\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
9
]
},
"invoice_status_name": {
"type": "string",
"description": "請求ステータスの名称",
"example": "未請求",
"readOnly": true
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"project_type_id": {
"type": "integer",
"description": "案件区分1ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type_name": {
"type": "string",
"description": "案件区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"project_type2_id": {
"type": "integer",
"description": "案件区分2ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type2_name": {
"type": "string",
"description": "案件区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"project_type3_id": {
"type": "integer",
"description": "案件区分3ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type3_name": {
"type": "string",
"description": "案件区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"paid_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "入金日\n",
"example": "2023-10-01"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"description": "請求金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"description": "請求金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
},
"invoice": {
"allOf": [
{
"description": "請求書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "請求書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`invoices`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31",
"readOnly": true
},
"payment_limit_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払期限",
"example": "2023-11-30",
"readOnly": true
},
"disp_invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "請求日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"multi_bank_info_flg": {
"type": "integer",
"description": "複数口座表示\n\n- 0：OFF\n- 1：ON\n\n※デフォルトは設定による\n",
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
},
"Estimate": {
"allOf": [
{
"description": "見積書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"valid_period": {
"type": "string",
"description": "有効期限",
"maxLength": 100,
"example": "御見積後2週間"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "見積日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"Order": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"disp_order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日（表示設定）",
"example": "2023-10-01"
},
"disp_order_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注請日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発注請日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"Delivery": {
"allOf": [
{
"description": "納品書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "納品書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`deliveries`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日",
"example": "2023-10-01"
},
"disp_delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日（表示設定）",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "納品日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"Invoice": {
"allOf": [
{
"description": "請求書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "請求書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`invoices`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31",
"readOnly": true
},
"payment_limit_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払期限",
"example": "2023-11-30",
"readOnly": true
},
"disp_invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "請求日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"multi_bank_info_flg": {
"type": "integer",
"description": "複数口座表示\n\n- 0：OFF\n- 1：ON\n\n※デフォルトは設定による\n",
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"Receipt": {
"allOf": [
{
"description": "領収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "領収書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`receipts`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日",
"example": "2023-10-01",
"readOnly": true
},
"disp_receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発行日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"Payee": {
"allOf": [
{
"description": "発注先関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "発注先ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"properties": {
"title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"default": "御中",
"example": "御中"
},
"payment_term_id": {
"description": "デフォルト支払条件ID\n\n- 新規登録時に未指定の場合は最初の支払条件が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "デフォルト支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"nda_flg": {
"description": "NDA締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"basic_agreement_flg": {
"description": "基本契約書締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"document_send_type": {
"description": "書類送付方法\n\n- 1：メール(DL)\n- 2：郵送\n- 3：メール(DL)+郵送\n- 4：メール(添付)\n- 5：メール(添付)+郵送\n- または[カスタム書類送付方法](#tag/document_send_channel/operation/getDocumentSendChannels)のID\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1
},
"document_send_type_name": {
"type": "string",
"description": "書類送付方法名",
"example": "メール(DL)",
"readOnly": true
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"wareki_flg": {
"description": "デフォルト和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_number": {
"type": "string",
"description": "法人番号",
"minLength": 13,
"maxLength": 13,
"example": "1234567890123"
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード\n\n※「会計連携機能」機能有効時のみ\n",
"maxLength": 100,
"example": "サンプル（株）"
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"invoice_system_number": {
"type": "string",
"description": "適格請求書発行事業者の登録番号",
"minLength": 14,
"maxLength": 14,
"example": "T1234567890123"
},
"invoice_system_number_validated": {
"type": "boolean",
"description": "登録番号のチェック状況",
"example": true,
"readOnly": true
},
"invoice_system_issuer_type": {
"description": "適格請求書発行事業者\n\n- 0：未設定\n- 1：該当する\n- 2：該当しない\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1,
2
]
},
"invoice_system_issuer_type_name": {
"type": "string",
"description": "適格請求書発行事業者の名称",
"example": "未設定",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"bank_charge_to_client_flg": {
"description": "振込手数料負担\n\n- 0：当方\n- 1：先方\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 1,
"enum": [
0,
1
]
},
"tax_withholding_kbn": {
"description": "デフォルト源泉徴収\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "デフォルト源泉徴収名",
"example": "なし",
"readOnly": true
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
},
"name_en": {
"type": "string",
"description": "発注先名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
}
}
},
{
"properties": {
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": "81"
},
"currency": {
"type": "string",
"description": "デフォルト通貨\n\n※英語アドオン有効時のみ\n",
"maxLength": 3,
"default": "JPY",
"example": "USD",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"description": "デフォルト言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "デフォルト言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
},
"PayeeBranch": {
"allOf": [
{
"description": "発注先支社関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "発注先支社ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"type": "object",
"properties": {
"name_en": {
"type": "string",
"description": "発注先支社名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
},
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": 81
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
},
"PayeeContact": {
"properties": {
"id": {
"description": "発注先担当者ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎"
},
"honorific_title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"example": "様"
},
"title": {
"type": "string",
"description": "肩書",
"maxLength": 50,
"example": "部長"
},
"department": {
"type": "string",
"description": "部署",
"maxLength": 50,
"example": "システム部"
},
"email": {
"type": "string",
"description": "email",
"maxLength": 100,
"example": "yamada@example.com"
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"last_name_en": {
"type": "string",
"description": "姓（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Yamada"
},
"first_name_en": {
"type": "string",
"description": "名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Taro"
},
"prefix_en": {
"type": "string",
"description": "敬称（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Mr."
},
"title_en": {
"type": "string",
"description": "肩書（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Manager"
},
"department_en": {
"type": "string",
"description": "部署（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "IT Dept."
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
"Expenditure": {
"allOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "発注ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"expenditure_no": {
"type": "integer",
"format": "int32",
"description": "発注No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注名",
"maxLength": 100,
"example": "サンプル発注A"
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"payee_branch_id": {
"description": "発注先支社ID\n\n※[発注先支社登録API](#tag/payee_branch/operation/postPayeeBranch)・[発注先支社リスト取得API](#tag/payee_branch/operation/getPayeeBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_branch": {
"description": "発注先支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"payee_name_disp_kbn": {
"type": "integer",
"description": "発注先支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_disp_kbn_name": {
"type": "string",
"description": "発注先支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_name_for_post_disp_kbn": {
"type": "integer",
"description": "発注先支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_for_post_disp_kbn_name": {
"type": "string",
"description": "発注先支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_contact_id": {
"description": "発注先担当者ID\n\n※[発注先担当者登録API](#tag/payee_contact/operation/postPayeeContact)・[発注先担当者リスト取得API](#tag/payee_contact/operation/getPayeeContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_contact": {
"description": "発注先担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "発注先担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "発注先担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"project_id": {
"description": "関連案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"project": {
"description": "案件",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "案件ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
}
}
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
],
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01",
"readOnly": true
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"expenditure_status": {
"type": "integer",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"expenditure_status_name": {
"type": "string",
"description": "発注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"payment_timing_kbn": {
"type": "integer",
"description": "支払タイミング\n\n- 1：一括支払\n- 2：定期支払\n- 3：分割支払\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"payment_timing_kbn_name": {
"type": "string",
"description": "支払タイミングの名称",
"example": "一括支払",
"readOnly": true
},
"tax_withholding_kbn": {
"type": "integer",
"description": "源泉徴収区分\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "源泉徴収区分の名称",
"example": "なし",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"expenditure_type_id": {
"type": "integer",
"description": "発注区分1\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type_name": {
"type": "string",
"description": "発注区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"expenditure_type2_id": {
"type": "integer",
"description": "発注区分2\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type2_name": {
"type": "string",
"description": "発注区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"expenditure_type3_id": {
"type": "integer",
"description": "発注区分3\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type3_name": {
"type": "string",
"description": "発注区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"company_bank_id": {
"type": "integer",
"description": "集計用出金口座（振込口座ID）\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"format": "int32",
"example": 123456
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"description": "発注金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"description": "発注金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"title": "一括支払",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括支払用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"title": "定期支払",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期支払用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期支払用\n",
"example": "2023-12-31"
},
"periodical_payment_interval": {
"type": "integer",
"description": "支払間隔\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_payment_payment_kbn": {
"type": "integer",
"description": "支払間隔内の請求時期\n\n- 1：支払間隔の最初の月\n- 2：支払間隔の最後の月\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"periodical_payment_payment_kbn_name": {
"type": "string",
"description": "請求間隔内の請求時期の名称",
"example": "支払間隔の最初の月",
"readOnly": true
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期支払用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期支払用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"title": "分割支払",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoices": {
"type": "array",
"description": "請求情報\n\n※分割支払用\n",
"writeOnly": true,
"items": {
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31"
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
},
"required": [
"invoice_date",
"total",
"tax"
]
}
}
}
}
]
},
{
"properties": {
"expenditure_estimate": {
"allOf": [
{
"description": "見積依頼書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積依頼書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"estimate_request_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "依頼日",
"example": "2023-10-01"
},
"desired_delivery_date_text": {
"type": "string",
"description": "希望納期",
"maxLength": 100,
"example": "2週間後"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "依頼日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"expenditure_order": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "発注日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"expenditure_deliveries": {
"type": "array",
"items": {
"allOf": [
{
"description": "検収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "検収書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_delivery`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"delivery_received_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "検収日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"expenditure_invoices": {
"type": "array",
"items": {
"allOf": [
{
"description": "支払通知書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "支払通知書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_invoice`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"paid_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "支払日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
}
]
},
"ExpenditureMonth": {
"description": "支払い関連の定義情報",
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "支払ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"expenditure_id": {
"description": "発注ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"expenditure_no": {
"type": "integer",
"format": "int32",
"description": "発注No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"name": {
"type": "string",
"description": "発注名",
"maxLength": 100,
"example": "サンプル発注A"
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"payee_branch": {
"description": "発注先支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"payee_contact": {
"description": "発注先担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "発注先担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "発注先担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"total": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210,
"readOnly": true
},
"project": {
"description": "案件",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "案件ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
}
}
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n",
"example": "2023-10-01"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払期限\n",
"example": "2023-10-01"
},
"expenditure_status": {
"type": "integer",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"expenditure_status_name": {
"type": "string",
"description": "発注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"payment_status": {
"type": "integer",
"description": "支払ステータス\n\n- 1：請求書未受領\n- 2：請求書受領済\n- 4：振込予約済\n- 3：支払済\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"payment_status_name": {
"type": "string",
"description": "支払ステータスの名称",
"example": "請求書未受領",
"readOnly": true
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"expenditure_type_id": {
"type": "integer",
"description": "発注区分1\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type_name": {
"type": "string",
"description": "発注区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"expenditure_type2_id": {
"type": "integer",
"description": "発注区分2\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type2_name": {
"type": "string",
"description": "発注区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"expenditure_type3_id": {
"type": "integer",
"description": "発注区分3\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type3_name": {
"type": "string",
"description": "発注区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"description": "支払金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"description": "支払金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
"ExpenditureEstimate": {
"allOf": [
{
"description": "見積依頼書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積依頼書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"estimate_request_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "依頼日",
"example": "2023-10-01"
},
"desired_delivery_date_text": {
"type": "string",
"description": "希望納期",
"maxLength": 100,
"example": "2週間後"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "依頼日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"ExpenditureOrder": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "発注日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"ExpenditureDelivery": {
"allOf": [
{
"description": "検収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "検収書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_delivery`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"delivery_received_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "検収日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"ExpenditureInvoice": {
"allOf": [
{
"description": "支払通知書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "支払通知書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_invoice`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"paid_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "支払日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"Analysis": {
"description": "計上データ関連の定義情報",
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "計上データID",
"format": "int64",
"example": 123456,
"readOnly": true
},
"analysis_data_kbn": {
"type": "integer",
"description": "データ種類\n\n- 1：案件\n- 2：案件原価\n- 3：発注\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"analysis_data_kbn_name": {
"type": "string",
"description": "データ種類の名称",
"example": "案件",
"readOnly": true
},
"project": {
"description": "案件",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "案件ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
}
}
},
"expenditure": {
"description": "発注",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注名",
"maxLength": 100,
"example": "サンプル発注A"
},
"expenditure_no": {
"type": "integer",
"description": "発注No",
"maxLength": 11,
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001",
"readOnly": true
}
}
},
"project_cost": {
"description": "案件原価",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "案件原価ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件原価の説明",
"maxLength": 100,
"example": "サンプル原価"
}
}
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10210"
},
"order_status": {
"type": "integer",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"order_status_name": {
"type": "string",
"description": "受注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"invoice_status": {
"type": "integer",
"description": "請求ステータス\n\n- 1：未請求\n- 4：請求OK\n- 2：請求済\n- 5：一部入金済\n- 3：入金済\n- 9：回収不能\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
9
]
},
"invoice_status_name": {
"type": "string",
"description": "請求ステータスの名称",
"example": "未請求",
"readOnly": true
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"expenditure_status": {
"type": "integer",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"expenditure_status_name": {
"type": "string",
"description": "発注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"payment_status": {
"type": "integer",
"description": "支払ステータス\n\n- 1：請求書未受領\n- 2：請求書受領済\n- 4：振込予約済\n- 3：支払済\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"payment_status_name": {
"type": "string",
"description": "支払ステータスの名称",
"example": "請求書未受領",
"readOnly": true
},
"report_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "計上日\n",
"example": "2023-10-01"
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"group": {
"description": "グループ",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "グループID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "グループ名",
"maxLength": 100,
"example": "グループA"
}
}
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"project_type_id": {
"type": "integer",
"description": "案件区分1ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type_name": {
"type": "string",
"description": "案件区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"project_type2_id": {
"type": "integer",
"description": "案件区分2ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type2_name": {
"type": "string",
"description": "案件区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"project_type3_id": {
"type": "integer",
"description": "案件区分3ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type3_name": {
"type": "string",
"description": "案件区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"expenditure_type_id": {
"type": "integer",
"description": "発注区分1\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type_name": {
"type": "string",
"description": "発注区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"expenditure_type2_id": {
"type": "integer",
"description": "発注区分2\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type2_name": {
"type": "string",
"description": "発注区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"expenditure_type3_id": {
"type": "integer",
"description": "発注区分3\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type3_name": {
"type": "string",
"description": "発注区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"auto_flg": {
"type": "integer",
"description": "自動/手動\n\n- 0：手動\n- 1：自動\n",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"auto_renewal_simulation_flg": {
"type": "integer",
"description": "自動契約更新シミュレーション\n\n- 0：自動契約更新シミュレーションデータではない\n- 1：自動契約更新シミュレーションデータ\n",
"default": 0,
"example": null,
"enum": [
0,
1
]
},
"classification_record_type": {
"type": "integer",
"description": "データ種別\n\n- 1：オリジナル\n- 2：明細別分類\n- 3：明細別分類（調整）\n- 4：明細別分類（除外）\n- 5：手動追加\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5
]
},
"classification_record_type_name": {
"type": "string",
"description": "データ種別の名称",
"example": "オリジナル",
"readOnly": true
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"total_jpy": {
"type": "integer",
"description": "税抜金額（JPY）",
"example": 100000
},
"tax_jpy": {
"type": "integer",
"description": "消費税（JPY）",
"example": 10000
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
"User": {
"description": "ユーザー（担当者）関連の定義情報",
"type": "object",
"properties": {
"id": {
"description": "ユーザーID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"email": {
"type": "string",
"description": "メールアドレス",
"maxLength": 255,
"example": "yamada@example.com",
"readOnly": true
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田",
"readOnly": true
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎",
"readOnly": true
},
"role_id": {
"description": "ユーザー権限ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"role_name": {
"type": "string",
"description": "ユーザー権限名",
"maxLength": 100,
"example": "管理者",
"readOnly": true
},
"last_sign_in_at": {
"type": "string",
"description": "最終ログイン",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"valid_flg": {
"type": "integer",
"description": "有効フラグ\n\n- 0：無効\n- 1：有効\n",
"readOnly": true,
"example": 1,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
"Group": {
"description": "グループ関連の定義情報",
"type": "object",
"properties": {
"id": {
"description": "グループID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "グループ名",
"maxLength": 50,
"example": "グループA",
"readOnly": true
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_bank_id": {
"description": "デフォルト振込口座ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"company_bank_name": {
"type": "string",
"description": "デフォルト振込口座名",
"maxLength": 200,
"example": "サンプル銀行 サンプル支店",
"readOnly": true
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード",
"maxLength": 100,
"example": "SAMPLE001",
"readOnly": true
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
"PaymentTerm": {
"description": "支払条件関連の定義情報",
"type": "object",
"properties": {
"id": {
"description": "支払条件ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
"ProjectType": {
"description": "案件区分関連の定義情報",
"type": "object",
"properties": {
"id": {
"description": "案件区分ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件区分名",
"maxLength": 100,
"example": "サンプル区分A",
"readOnly": true
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_bank_id": {
"description": "デフォルト振込口座ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"company_bank_name": {
"type": "string",
"description": "デフォルト振込口座名",
"maxLength": 200,
"example": "サンプル銀行 サンプル支店",
"readOnly": true
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
"ExpenditureType": {
"description": "発注区分関連の定義情報",
"type": "object",
"properties": {
"id": {
"description": "発注区分ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注区分名",
"maxLength": 100,
"example": "サンプル区分A",
"readOnly": true
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
"AccountingType": {
"description": "会計区分関連の定義情報",
"type": "object",
"properties": {
"id": {
"description": "会計区分ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "会計区分名",
"maxLength": 100,
"example": "サンプル区分A",
"readOnly": true
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
"DocumentSendChannel": {
"description": "カスタム書類送付方法関連の定義情報",
"type": "object",
"properties": {
"id": {
"description": "カスタム書類送付方法ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "カスタム書類送付方法名",
"maxLength": 100,
"example": "送付方法A",
"readOnly": true
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
"Address": {
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"ClientAndPayee": {
"properties": {
"title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"default": "御中",
"example": "御中"
},
"payment_term_id": {
"description": "デフォルト支払条件ID\n\n- 新規登録時に未指定の場合は最初の支払条件が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "デフォルト支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"nda_flg": {
"description": "NDA締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"basic_agreement_flg": {
"description": "基本契約書締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"document_send_type": {
"description": "書類送付方法\n\n- 1：メール(DL)\n- 2：郵送\n- 3：メール(DL)+郵送\n- 4：メール(添付)\n- 5：メール(添付)+郵送\n- または[カスタム書類送付方法](#tag/document_send_channel/operation/getDocumentSendChannels)のID\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1
},
"document_send_type_name": {
"type": "string",
"description": "書類送付方法名",
"example": "メール(DL)",
"readOnly": true
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"wareki_flg": {
"description": "デフォルト和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_number": {
"type": "string",
"description": "法人番号",
"minLength": 13,
"maxLength": 13,
"example": "1234567890123"
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード\n\n※「会計連携機能」機能有効時のみ\n",
"maxLength": 100,
"example": "サンプル（株）"
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"invoice_system_number": {
"type": "string",
"description": "適格請求書発行事業者の登録番号",
"minLength": 14,
"maxLength": 14,
"example": "T1234567890123"
},
"invoice_system_number_validated": {
"type": "boolean",
"description": "登録番号のチェック状況",
"example": true,
"readOnly": true
},
"invoice_system_issuer_type": {
"description": "適格請求書発行事業者\n\n- 0：未設定\n- 1：該当する\n- 2：該当しない\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1,
2
]
},
"invoice_system_issuer_type_name": {
"type": "string",
"description": "適格請求書発行事業者の名称",
"example": "未設定",
"readOnly": true
}
}
},
"ClientAndPayeeEnglish": {
"properties": {
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": "81"
},
"currency": {
"type": "string",
"description": "デフォルト通貨\n\n※英語アドオン有効時のみ\n",
"maxLength": 3,
"default": "JPY",
"example": "USD",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"description": "デフォルト言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "デフォルト言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
}
}
},
"archive_flg_property": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at_property": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at_property": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
},
"client_id_property": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client_object": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎"
},
"honorific_title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"example": "様"
},
"title": {
"type": "string",
"description": "肩書",
"maxLength": 50,
"example": "部長"
},
"department": {
"type": "string",
"description": "部署",
"maxLength": 50,
"example": "システム部"
},
"email": {
"type": "string",
"description": "email",
"maxLength": 100,
"example": "yamada@example.com"
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"last_name_en": {
"type": "string",
"description": "姓（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Yamada"
},
"first_name_en": {
"type": "string",
"description": "名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Taro"
},
"prefix_en": {
"type": "string",
"description": "敬称（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Mr."
},
"title_en": {
"type": "string",
"description": "肩書（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Manager"
},
"department_en": {
"type": "string",
"description": "部署（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "IT Dept."
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"client_branch_object": {
"description": "顧客支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"contact_object": {
"description": "顧客担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "顧客担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "顧客担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch_object": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user_object": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"order_status": {
"type": "integer",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"order_status_name": {
"type": "string",
"description": "受注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"project_type_id": {
"type": "integer",
"description": "案件区分1ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type_name": {
"type": "string",
"description": "案件区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"project_type2_id": {
"type": "integer",
"description": "案件区分2ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type2_name": {
"type": "string",
"description": "案件区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"project_type3_id": {
"type": "integer",
"description": "案件区分3ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type3_name": {
"type": "string",
"description": "案件区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"ProjectCommon": {
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "案件ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"client_branch_id": {
"description": "顧客支社ID\n\n※[顧客支社登録API](#tag/client_branch/operation/postClientBranch)・[顧客支社リスト取得API](#tag/client_branch/operation/getClientBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client_branch": {
"description": "顧客支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"client_name_disp_kbn": {
"type": "integer",
"description": "顧客支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_disp_kbn_name": {
"type": "string",
"description": "顧客支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"client_name_for_post_disp_kbn": {
"type": "integer",
"description": "顧客支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_for_post_disp_kbn_name": {
"type": "string",
"description": "顧客支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"contact_id": {
"description": "顧客担当者ID\n\n※[顧客担当者登録API](#tag/contact/operation/postContact)・[顧客担当者リスト取得API](#tag/contact/operation/getContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"contact": {
"description": "顧客担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "顧客担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "顧客担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"cost_total": {
"type": "integer",
"format": "int32",
"description": "原価",
"example": 10000,
"readOnly": true
},
"cost_tax": {
"type": "integer",
"format": "int32",
"description": "原価の消費税",
"example": 1000,
"readOnly": true
},
"invoice_total": {
"type": "string",
"description": "請求額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"invoice_tax": {
"type": "string",
"description": "請求額の消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"estimate_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "見積日\n\n※新規登録時に未指定の場合は、本日の日付がセットされます\n",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期\n",
"example": "2023-10-20"
},
"delivery_date_text": {
"type": "string",
"maxLength": 50,
"description": "納期テキスト\n",
"example": "サンプル納期"
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"order_status": {
"type": "integer",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"order_status_name": {
"type": "string",
"description": "受注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"invoice_timing_kbn": {
"type": "integer",
"description": "請求タイミング\n\n- 1：一括請求\n- 2：定期請求\n- 3：分割請求\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"invoice_timing_kbn_name": {
"type": "string",
"description": "請求タイミングの名称",
"example": "一括請求",
"readOnly": true
},
"project_type_id": {
"type": "integer",
"description": "案件区分1ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type_name": {
"type": "string",
"description": "案件区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"project_type2_id": {
"type": "integer",
"description": "案件区分2ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type2_name": {
"type": "string",
"description": "案件区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"project_type3_id": {
"type": "integer",
"description": "案件区分3ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type3_name": {
"type": "string",
"description": "案件区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"ordered_date": {
"type": "string",
"description": "受注日",
"format": "YYYY-MM-DD",
"example": "2023-10-05"
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"project_costs": {
"description": "案件原価",
"readOnly": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"cost": {
"type": "integer",
"format": "int64",
"description": "金額",
"example": 10000
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル費用"
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-10"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-10"
}
}
}
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"format": "int64",
"description": "見積金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"format": "int32",
"description": "見積金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"invoice_total_jpy": {
"type": "integer",
"format": "int64",
"description": "請求金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"invoice_tax_jpy": {
"type": "integer",
"format": "int32",
"description": "請求金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"hubspot": {
"description": "HubSpotと連携している場合は、その連携情報",
"readOnly": true,
"type": "object",
"properties": {
"hubspot_deal_id": {
"type": "string",
"description": "HubSpotの取引ID",
"example": "123456"
}
}
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
"ProjectOnce": {
"title": "一括請求",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括請求用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
}
}
}
]
},
"ProjectPeriodical": {
"title": "定期請求",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期請求用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期請求用\n",
"example": "2023-12-31"
},
"periodical_invoice_interval": {
"type": "integer",
"description": "請求間隔\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_invoice_payment_kbn": {
"type": "integer",
"description": "請求間隔内の請求時期\n\n- 1：請求間隔の最初の月\n- 2：請求間隔の最後の月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"contract_end_alert_flg": {
"type": "integer",
"description": "通知対象\n\n- 0：通知しない\n- 1：通知する\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期請求用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期請求用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"monthly_invoice_payment_kbn": {
"type": "integer",
"description": "自動挿入メッセージ年月\n\n- 1：請求月\n- 2：請求月の翌月\n- 3：請求月の前月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
}
}
}
]
},
"ProjectSeveral": {
"title": "分割請求",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
]
}
}
}
]
},
"Document": {
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
"ProjectCommonForCreate": {
"allOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "案件ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"client_branch_id": {
"description": "顧客支社ID\n\n※[顧客支社登録API](#tag/client_branch/operation/postClientBranch)・[顧客支社リスト取得API](#tag/client_branch/operation/getClientBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client_branch": {
"description": "顧客支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"client_name_disp_kbn": {
"type": "integer",
"description": "顧客支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_disp_kbn_name": {
"type": "string",
"description": "顧客支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"client_name_for_post_disp_kbn": {
"type": "integer",
"description": "顧客支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_for_post_disp_kbn_name": {
"type": "string",
"description": "顧客支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"contact_id": {
"description": "顧客担当者ID\n\n※[顧客担当者登録API](#tag/contact/operation/postContact)・[顧客担当者リスト取得API](#tag/contact/operation/getContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"contact": {
"description": "顧客担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "顧客担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "顧客担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"cost_total": {
"type": "integer",
"format": "int32",
"description": "原価",
"example": 10000,
"readOnly": true
},
"cost_tax": {
"type": "integer",
"format": "int32",
"description": "原価の消費税",
"example": 1000,
"readOnly": true
},
"invoice_total": {
"type": "string",
"description": "請求額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"invoice_tax": {
"type": "string",
"description": "請求額の消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"estimate_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "見積日\n\n※新規登録時に未指定の場合は、本日の日付がセットされます\n",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期\n",
"example": "2023-10-20"
},
"delivery_date_text": {
"type": "string",
"maxLength": 50,
"description": "納期テキスト\n",
"example": "サンプル納期"
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"order_status": {
"type": "integer",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"order_status_name": {
"type": "string",
"description": "受注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"invoice_timing_kbn": {
"type": "integer",
"description": "請求タイミング\n\n- 1：一括請求\n- 2：定期請求\n- 3：分割請求\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"invoice_timing_kbn_name": {
"type": "string",
"description": "請求タイミングの名称",
"example": "一括請求",
"readOnly": true
},
"project_type_id": {
"type": "integer",
"description": "案件区分1ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type_name": {
"type": "string",
"description": "案件区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"project_type2_id": {
"type": "integer",
"description": "案件区分2ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type2_name": {
"type": "string",
"description": "案件区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"project_type3_id": {
"type": "integer",
"description": "案件区分3ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type3_name": {
"type": "string",
"description": "案件区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"ordered_date": {
"type": "string",
"description": "受注日",
"format": "YYYY-MM-DD",
"example": "2023-10-05"
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"project_costs": {
"description": "案件原価",
"readOnly": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"cost": {
"type": "integer",
"format": "int64",
"description": "金額",
"example": 10000
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル費用"
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-10"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-10"
}
}
}
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"format": "int64",
"description": "見積金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"format": "int32",
"description": "見積金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"invoice_total_jpy": {
"type": "integer",
"format": "int64",
"description": "請求金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"invoice_tax_jpy": {
"type": "integer",
"format": "int32",
"description": "請求金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"hubspot": {
"description": "HubSpotと連携している場合は、その連携情報",
"readOnly": true,
"type": "object",
"properties": {
"hubspot_deal_id": {
"type": "string",
"description": "HubSpotの取引ID",
"example": "123456"
}
}
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"required": [
"name",
"client_id",
"user_id",
"order_status",
"invoice_timing_kbn"
]
}
]
},
"ProjectOnceForCreate": {
"allOf": [
{
"title": "一括請求",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括請求用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
}
}
}
]
},
{
"required": [
"invoice_date"
]
}
]
},
"ProjectPeriodicalForCreate": {
"allOf": [
{
"title": "定期請求",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期請求用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期請求用\n",
"example": "2023-12-31"
},
"periodical_invoice_interval": {
"type": "integer",
"description": "請求間隔\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_invoice_payment_kbn": {
"type": "integer",
"description": "請求間隔内の請求時期\n\n- 1：請求間隔の最初の月\n- 2：請求間隔の最後の月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"contract_end_alert_flg": {
"type": "integer",
"description": "通知対象\n\n- 0：通知しない\n- 1：通知する\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期請求用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期請求用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"monthly_invoice_payment_kbn": {
"type": "integer",
"description": "自動挿入メッセージ年月\n\n- 1：請求月\n- 2：請求月の翌月\n- 3：請求月の前月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
}
}
}
]
},
{
"required": [
"contract_start_date",
"contract_end_date"
]
}
]
},
"ProjectSeveralForCreate": {
"allOf": [
{
"title": "分割請求",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
]
}
}
}
]
},
{
"required": [
"invoice_dates"
]
}
]
},
"ProjectSeveralForUpdate": {
"title": "分割請求",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
}
}
}
]
},
"lock_flg_request_property": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"example": 1,
"enum": [
0,
1
]
},
"invoice_status": {
"type": "integer",
"description": "請求ステータス\n\n- 1：未請求\n- 4：請求OK\n- 2：請求済\n- 5：一部入金済\n- 3：入金済\n- 9：回収不能\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
9
]
},
"invoice_status_name": {
"type": "string",
"description": "請求ステータスの名称",
"example": "未請求",
"readOnly": true
},
"payee_id_property": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_object": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"expenditure_no": {
"type": "integer",
"format": "int32",
"description": "発注No",
"example": 1001,
"readOnly": true
},
"expenditure_name_property_name": {
"type": "string",
"description": "発注名",
"maxLength": 100,
"example": "サンプル発注A"
},
"payee_branch": {
"description": "発注先支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"payee_contact": {
"description": "発注先担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "発注先担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "発注先担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"project_object": {
"description": "案件",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "案件ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
}
}
},
"expenditure_status": {
"type": "integer",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"expenditure_status_name": {
"type": "string",
"description": "発注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"expenditure_type_id": {
"type": "integer",
"description": "発注区分1\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type_name": {
"type": "string",
"description": "発注区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"expenditure_type2_id": {
"type": "integer",
"description": "発注区分2\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type2_name": {
"type": "string",
"description": "発注区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"expenditure_type3_id": {
"type": "integer",
"description": "発注区分3\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type3_name": {
"type": "string",
"description": "発注区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"ExpenditureCommon": {
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "発注ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"expenditure_no": {
"type": "integer",
"format": "int32",
"description": "発注No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注名",
"maxLength": 100,
"example": "サンプル発注A"
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"payee_branch_id": {
"description": "発注先支社ID\n\n※[発注先支社登録API](#tag/payee_branch/operation/postPayeeBranch)・[発注先支社リスト取得API](#tag/payee_branch/operation/getPayeeBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_branch": {
"description": "発注先支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"payee_name_disp_kbn": {
"type": "integer",
"description": "発注先支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_disp_kbn_name": {
"type": "string",
"description": "発注先支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_name_for_post_disp_kbn": {
"type": "integer",
"description": "発注先支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_for_post_disp_kbn_name": {
"type": "string",
"description": "発注先支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_contact_id": {
"description": "発注先担当者ID\n\n※[発注先担当者登録API](#tag/payee_contact/operation/postPayeeContact)・[発注先担当者リスト取得API](#tag/payee_contact/operation/getPayeeContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_contact": {
"description": "発注先担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "発注先担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "発注先担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"project_id": {
"description": "関連案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"project": {
"description": "案件",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "案件ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
}
}
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
],
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01",
"readOnly": true
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"expenditure_status": {
"type": "integer",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"expenditure_status_name": {
"type": "string",
"description": "発注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"payment_timing_kbn": {
"type": "integer",
"description": "支払タイミング\n\n- 1：一括支払\n- 2：定期支払\n- 3：分割支払\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"payment_timing_kbn_name": {
"type": "string",
"description": "支払タイミングの名称",
"example": "一括支払",
"readOnly": true
},
"tax_withholding_kbn": {
"type": "integer",
"description": "源泉徴収区分\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "源泉徴収区分の名称",
"example": "なし",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"expenditure_type_id": {
"type": "integer",
"description": "発注区分1\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type_name": {
"type": "string",
"description": "発注区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"expenditure_type2_id": {
"type": "integer",
"description": "発注区分2\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type2_name": {
"type": "string",
"description": "発注区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"expenditure_type3_id": {
"type": "integer",
"description": "発注区分3\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type3_name": {
"type": "string",
"description": "発注区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"company_bank_id": {
"type": "integer",
"description": "集計用出金口座（振込口座ID）\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"format": "int32",
"example": 123456
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"description": "発注金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"description": "発注金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
"ExpenditureOnce": {
"title": "一括支払",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括支払用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
"ExpenditurePeriodical": {
"title": "定期支払",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期支払用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期支払用\n",
"example": "2023-12-31"
},
"periodical_payment_interval": {
"type": "integer",
"description": "支払間隔\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_payment_payment_kbn": {
"type": "integer",
"description": "支払間隔内の請求時期\n\n- 1：支払間隔の最初の月\n- 2：支払間隔の最後の月\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"periodical_payment_payment_kbn_name": {
"type": "string",
"description": "請求間隔内の請求時期の名称",
"example": "支払間隔の最初の月",
"readOnly": true
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期支払用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期支払用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
"ExpenditureSeveral": {
"title": "分割支払",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoices": {
"type": "array",
"description": "請求情報\n\n※分割支払用\n",
"writeOnly": true,
"items": {
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31"
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
},
"required": [
"invoice_date",
"total",
"tax"
]
}
}
}
}
]
},
"ExpenditureCommonForCreate": {
"allOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "発注ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"expenditure_no": {
"type": "integer",
"format": "int32",
"description": "発注No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注名",
"maxLength": 100,
"example": "サンプル発注A"
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"payee_branch_id": {
"description": "発注先支社ID\n\n※[発注先支社登録API](#tag/payee_branch/operation/postPayeeBranch)・[発注先支社リスト取得API](#tag/payee_branch/operation/getPayeeBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_branch": {
"description": "発注先支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"payee_name_disp_kbn": {
"type": "integer",
"description": "発注先支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_disp_kbn_name": {
"type": "string",
"description": "発注先支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_name_for_post_disp_kbn": {
"type": "integer",
"description": "発注先支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_for_post_disp_kbn_name": {
"type": "string",
"description": "発注先支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_contact_id": {
"description": "発注先担当者ID\n\n※[発注先担当者登録API](#tag/payee_contact/operation/postPayeeContact)・[発注先担当者リスト取得API](#tag/payee_contact/operation/getPayeeContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_contact": {
"description": "発注先担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "発注先担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "発注先担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"project_id": {
"description": "関連案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"project": {
"description": "案件",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "案件ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
}
}
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
],
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01",
"readOnly": true
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"expenditure_status": {
"type": "integer",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"expenditure_status_name": {
"type": "string",
"description": "発注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"payment_timing_kbn": {
"type": "integer",
"description": "支払タイミング\n\n- 1：一括支払\n- 2：定期支払\n- 3：分割支払\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"payment_timing_kbn_name": {
"type": "string",
"description": "支払タイミングの名称",
"example": "一括支払",
"readOnly": true
},
"tax_withholding_kbn": {
"type": "integer",
"description": "源泉徴収区分\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "源泉徴収区分の名称",
"example": "なし",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"expenditure_type_id": {
"type": "integer",
"description": "発注区分1\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type_name": {
"type": "string",
"description": "発注区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"expenditure_type2_id": {
"type": "integer",
"description": "発注区分2\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type2_name": {
"type": "string",
"description": "発注区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"expenditure_type3_id": {
"type": "integer",
"description": "発注区分3\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type3_name": {
"type": "string",
"description": "発注区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"company_bank_id": {
"type": "integer",
"description": "集計用出金口座（振込口座ID）\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"format": "int32",
"example": 123456
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"description": "発注金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"description": "発注金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"required": [
"name",
"payee_id",
"user_id",
"expenditure_status",
"payment_timing_kbn",
"tax_withholding_kbn"
]
}
]
},
"ExpenditureOnceForCreate": {
"allOf": [
{
"title": "一括支払",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括支払用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"required": [
"invoice_date",
"total",
"tax"
]
}
]
},
"ExpenditurePeriodicalForCreate": {
"allOf": [
{
"title": "定期支払",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期支払用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期支払用\n",
"example": "2023-12-31"
},
"periodical_payment_interval": {
"type": "integer",
"description": "支払間隔\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_payment_payment_kbn": {
"type": "integer",
"description": "支払間隔内の請求時期\n\n- 1：支払間隔の最初の月\n- 2：支払間隔の最後の月\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"periodical_payment_payment_kbn_name": {
"type": "string",
"description": "請求間隔内の請求時期の名称",
"example": "支払間隔の最初の月",
"readOnly": true
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期支払用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期支払用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"required": [
"contract_start_date",
"contract_end_date",
"total",
"tax"
]
}
]
},
"ExpenditureSeveralForCreate": {
"allOf": [
{
"title": "分割支払",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoices": {
"type": "array",
"description": "請求情報\n\n※分割支払用\n",
"writeOnly": true,
"items": {
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31"
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
},
"required": [
"invoice_date",
"total",
"tax"
]
}
}
}
}
]
},
{
"required": [
"invoices"
]
}
]
},
"ExpenditureSeveralForUpdate": {
"title": "分割支払",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
}
}
}
]
},
"payment_status": {
"type": "integer",
"description": "支払ステータス\n\n- 1：請求書未受領\n- 2：請求書受領済\n- 4：振込予約済\n- 3：支払済\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"payment_status_name": {
"type": "string",
"description": "支払ステータスの名称",
"example": "請求書未受領",
"readOnly": true
},
"company_bank_id": {
"description": "デフォルト振込口座ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"company_bank_name": {
"type": "string",
"description": "デフォルト振込口座名",
"maxLength": 200,
"example": "サンプル銀行 サンプル支店",
"readOnly": true
}
},
"parameters": {
"include_archive_flg_query_parameter": {
"name": "include_archive_flg",
"in": "query",
"description": "アーカイブを含むか\n\n- 0：アーカイブ済みは除く\n- 1：アーカイブ済みも含む\n",
"schema": {
"type": "integer",
"default": 0,
"example": 1,
"enum": [
0,
1
]
}
},
"updated_at_gteq_query_parameter": {
"name": "updated_at_gteq",
"in": "query",
"description": "更新日時（指定日時以降）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
"updated_at_lteq_query_parameter": {
"name": "updated_at_lteq",
"in": "query",
"description": "更新日時（指定日時以前）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
"PerPage": {
"name": "per_page",
"in": "query",
"description": "1ページあたりの要素数（最大100まで）",
"schema": {
"type": "integer",
"default": 10,
"example": 20
}
},
"Page": {
"name": "page",
"in": "query",
"description": "現在のページ番号",
"schema": {
"type": "integer",
"default": 1,
"example": 2
}
},
"created_at_gteq_query_parameter": {
"name": "created_at_gteq",
"in": "query",
"description": "作成日時（指定日時以降）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
"created_at_lteq_query_parameter": {
"name": "created_at_lteq",
"in": "query",
"description": "作成日時（指定日時以前）\n\n※例にはURLエンコード前の値が記載されていますが、送信する際はURLエンコードしてください。\n",
"schema": {
"type": "string",
"format": "YYYY-MM-DD HH:MM:SS",
"example": "2023-08-01 00:00:00"
}
},
"project_response_group_property": {
"name": "response_group",
"in": "query",
"description": "レスポンスグループ\n\n| response_group | 項目 |\n|:-----------|:------------|\n| small | id, project_no, management_no, name, client, contact, user, total, tax, estimate_date, invoice_dates, order_status, order_status_name, project_type_id, project_type_name, project_type2_id, project_type2_name, project_type3_id, project_type3_name, delivery_status, delivery_status_name, group_id, group_name, currency, created_at, updated_at |\n| medium | smallに加え以下の項目
client_branch, company_branch, cost_total, cost_tax, invoice_total, invoice_tax, delivery_date, payment_term_id, payment_term_name, invoice_timing_kbn, invoice_timing_kbn_name, contract_start_date, contract_end_date, periodical_invoice_interval, periodical_invoice_payment_kbn, contract_end_alert_flg, auto_renewal_flg, auto_renewal_period_month, monthly_invoice_payment_kbn, delivery_document_kbn, tags, ordered_date, exchange_rate, total_jpy, tax_jpy, invoice_total_jpy, invoice_tax_jpy |\n| large | 書類以外すべての項目 |\n| estimate | small + 見積書 |\n| order | small + 発注書 |\n| delivery | small + 納品書 |\n| invoice | small + 請求書 |\n| receipt | small + 領収書 |\n| project_cost | small + 案件原価 |\n| all | large + すべての書類 |\n",
"schema": {
"type": "string",
"default": "small",
"example": "large",
"enum": [
"small",
"medium",
"large",
"estimate",
"order",
"delivery",
"invoice",
"receipt",
"project_cost",
"all"
],
"externalDocs": {
"description": "※レスポンスグループについて",
"url": "#section/レスポンスグループ"
}
}
},
"invoice_date_gteq_query_parameter": {
"name": "invoice_date_gteq",
"in": "query",
"description": "請求日（指定日時以降）",
"schema": {
"type": "string",
"format": "YYYY-MM-DD",
"example": "2023-08-01"
}
},
"invoice_date_lteq_query_parameter": {
"name": "invoice_date_lteq",
"in": "query",
"description": "請求日（指定日以前）",
"schema": {
"type": "string",
"format": "YYYY-MM-DD",
"example": "2023-08-01"
}
},
"payment_date_gteq_query_parameter": {
"name": "payment_date_gteq",
"in": "query",
"description": "支払日（指定日時以降）",
"schema": {
"type": "string",
"format": "YYYY-MM-DD",
"example": "2023-08-01"
}
},
"payment_date_lteq_query_parameter": {
"name": "payment_date_lteq",
"in": "query",
"description": "支払日（指定日以前）",
"schema": {
"type": "string",
"format": "YYYY-MM-DD",
"example": "2023-08-01"
}
},
"expenditure_response_group_property": {
"name": "response_group",
"in": "query",
"description": "レスポンスグループ\n\n| response_group | 項目 |\n|:-----------|:------------|\n| small | id, expenditure_no, management_no, name, payee, payee_contact, user, total, tax, tax_withholding, tax_withholding_kbn, tax_withholding_kbn_name, order_date, invoice_dates, expenditure_status, expenditure_status_name, expenditure_type_id, expenditure_type_name, expenditure_type2_id, expenditure_type2_name, expenditure_type3_id, expenditure_type3_name, group_id, group_name, delivery_status, delivery_status_name, currency, created_at, updated_at |\n| medium | smallに加え以下の項目
payee_branch, company_branch, project, payment_term_id, payment_term_name, payment_timing_kbn, payment_timing_kbn_name, contract_start_date, contract_end_date, periodical_payment_interval, auto_renewal_flg, auto_renewal_period_month, periodical_payment_payment_kbn, periodical_payment_payment_kbn_name, tags, exchange_rate, total_jpy, tax_jpy |\n| large | 書類以外すべての項目 |\n| estimate | small + 見積依頼書 |\n| order | small + 発注書 |\n| delivery | small + 検収書 |\n| invoice | small + 支払通知書 |\n| all | large + すべての書類 |\n",
"schema": {
"type": "string",
"default": "small",
"example": "large",
"enum": [
"small",
"medium",
"large",
"estimate",
"order",
"delivery",
"invoice",
"all"
],
"externalDocs": {
"description": "※レスポンスグループについて",
"url": "#section/レスポンスグループ"
}
}
}
},
"responses": {
"200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "顧客関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "顧客ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"properties": {
"title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"default": "御中",
"example": "御中"
},
"payment_term_id": {
"description": "デフォルト支払条件ID\n\n- 新規登録時に未指定の場合は最初の支払条件が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "デフォルト支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"nda_flg": {
"description": "NDA締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"basic_agreement_flg": {
"description": "基本契約書締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"document_send_type": {
"description": "書類送付方法\n\n- 1：メール(DL)\n- 2：郵送\n- 3：メール(DL)+郵送\n- 4：メール(添付)\n- 5：メール(添付)+郵送\n- または[カスタム書類送付方法](#tag/document_send_channel/operation/getDocumentSendChannels)のID\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1
},
"document_send_type_name": {
"type": "string",
"description": "書類送付方法名",
"example": "メール(DL)",
"readOnly": true
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"wareki_flg": {
"description": "デフォルト和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_number": {
"type": "string",
"description": "法人番号",
"minLength": 13,
"maxLength": 13,
"example": "1234567890123"
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード\n\n※「会計連携機能」機能有効時のみ\n",
"maxLength": 100,
"example": "サンプル（株）"
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"invoice_system_number": {
"type": "string",
"description": "適格請求書発行事業者の登録番号",
"minLength": 14,
"maxLength": 14,
"example": "T1234567890123"
},
"invoice_system_number_validated": {
"type": "boolean",
"description": "登録番号のチェック状況",
"example": true,
"readOnly": true
},
"invoice_system_issuer_type": {
"description": "適格請求書発行事業者\n\n- 0：未設定\n- 1：該当する\n- 2：該当しない\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1,
2
]
},
"invoice_system_issuer_type_name": {
"type": "string",
"description": "適格請求書発行事業者の名称",
"example": "未設定",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"bank_charge_to_client_flg": {
"description": "振込手数料負担\n\n- 0：当方\n- 1：先方\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
},
"company_bank_id": {
"description": "デフォルト振込口座ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"company_bank_name": {
"type": "string",
"description": "デフォルト振込口座（銀行名 支店名）",
"maxLength": 100,
"example": "サンプル銀行 サンプル支店",
"readOnly": true
},
"name_en": {
"type": "string",
"description": "顧客名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
}
}
},
{
"properties": {
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": "81"
},
"currency": {
"type": "string",
"description": "デフォルト通貨\n\n※英語アドオン有効時のみ\n",
"maxLength": 3,
"default": "JPY",
"example": "USD",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"description": "デフォルト言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "デフォルト言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"201": {
"description": "登録成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "顧客関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "顧客ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"properties": {
"title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"default": "御中",
"example": "御中"
},
"payment_term_id": {
"description": "デフォルト支払条件ID\n\n- 新規登録時に未指定の場合は最初の支払条件が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "デフォルト支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"nda_flg": {
"description": "NDA締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"basic_agreement_flg": {
"description": "基本契約書締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"document_send_type": {
"description": "書類送付方法\n\n- 1：メール(DL)\n- 2：郵送\n- 3：メール(DL)+郵送\n- 4：メール(添付)\n- 5：メール(添付)+郵送\n- または[カスタム書類送付方法](#tag/document_send_channel/operation/getDocumentSendChannels)のID\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1
},
"document_send_type_name": {
"type": "string",
"description": "書類送付方法名",
"example": "メール(DL)",
"readOnly": true
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"wareki_flg": {
"description": "デフォルト和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_number": {
"type": "string",
"description": "法人番号",
"minLength": 13,
"maxLength": 13,
"example": "1234567890123"
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード\n\n※「会計連携機能」機能有効時のみ\n",
"maxLength": 100,
"example": "サンプル（株）"
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"invoice_system_number": {
"type": "string",
"description": "適格請求書発行事業者の登録番号",
"minLength": 14,
"maxLength": 14,
"example": "T1234567890123"
},
"invoice_system_number_validated": {
"type": "boolean",
"description": "登録番号のチェック状況",
"example": true,
"readOnly": true
},
"invoice_system_issuer_type": {
"description": "適格請求書発行事業者\n\n- 0：未設定\n- 1：該当する\n- 2：該当しない\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1,
2
]
},
"invoice_system_issuer_type_name": {
"type": "string",
"description": "適格請求書発行事業者の名称",
"example": "未設定",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"bank_charge_to_client_flg": {
"description": "振込手数料負担\n\n- 0：当方\n- 1：先方\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
},
"company_bank_id": {
"description": "デフォルト振込口座ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"company_bank_name": {
"type": "string",
"description": "デフォルト振込口座（銀行名 支店名）",
"maxLength": 100,
"example": "サンプル銀行 サンプル支店",
"readOnly": true
},
"name_en": {
"type": "string",
"description": "顧客名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
}
}
},
{
"properties": {
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": "81"
},
"currency": {
"type": "string",
"description": "デフォルト通貨\n\n※英語アドオン有効時のみ\n",
"maxLength": 3,
"default": "JPY",
"example": "USD",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"description": "デフォルト言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "デフォルト言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "APIキーまたはAPIトークンが無効です。"
}
}
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "許可されていません。"
}
}
}
}
}
},
"404": {
"description": "指定のIDのデータが存在しない",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "指定のリソースは見つかりません。"
}
}
}
}
}
},
"422": {
"description": "バリデーションエラー",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "パラメータが正しくありません。"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string",
"example": "sample_field"
},
"code": {
"type": "string",
"example": "blank"
},
"description": {
"type": "string",
"example": "サンプル項目を入力してください。"
}
}
}
}
}
}
}
}
},
"204_delete": {
"description": "削除成功"
},
"ClientBranch_201": {
"description": "登録成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "顧客支社関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "顧客支社ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"type": "object",
"properties": {
"name_en": {
"type": "string",
"description": "顧客支社名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
},
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": 81
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"ClientBranch_200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "顧客支社関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "顧客支社ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"type": "object",
"properties": {
"name_en": {
"type": "string",
"description": "顧客支社名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
},
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": 81
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"Contact_201": {
"description": "登録成功",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "顧客担当者ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎"
},
"honorific_title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"example": "様"
},
"title": {
"type": "string",
"description": "肩書",
"maxLength": 50,
"example": "部長"
},
"department": {
"type": "string",
"description": "部署",
"maxLength": 50,
"example": "システム部"
},
"email": {
"type": "string",
"description": "email",
"maxLength": 100,
"example": "yamada@example.com"
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"last_name_en": {
"type": "string",
"description": "姓（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Yamada"
},
"first_name_en": {
"type": "string",
"description": "名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Taro"
},
"prefix_en": {
"type": "string",
"description": "敬称（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Mr."
},
"title_en": {
"type": "string",
"description": "肩書（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Manager"
},
"department_en": {
"type": "string",
"description": "部署（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "IT Dept."
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
},
"Contact_200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "顧客担当者ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎"
},
"honorific_title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"example": "様"
},
"title": {
"type": "string",
"description": "肩書",
"maxLength": 50,
"example": "部長"
},
"department": {
"type": "string",
"description": "部署",
"maxLength": 50,
"example": "システム部"
},
"email": {
"type": "string",
"description": "email",
"maxLength": 100,
"example": "yamada@example.com"
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"last_name_en": {
"type": "string",
"description": "姓（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Yamada"
},
"first_name_en": {
"type": "string",
"description": "名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Taro"
},
"prefix_en": {
"type": "string",
"description": "敬称（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Mr."
},
"title_en": {
"type": "string",
"description": "肩書（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Manager"
},
"department_en": {
"type": "string",
"description": "部署（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "IT Dept."
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
},
"Project_201": {
"description": "登録成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "案件ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"client_branch_id": {
"description": "顧客支社ID\n\n※[顧客支社登録API](#tag/client_branch/operation/postClientBranch)・[顧客支社リスト取得API](#tag/client_branch/operation/getClientBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client_branch": {
"description": "顧客支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"client_name_disp_kbn": {
"type": "integer",
"description": "顧客支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_disp_kbn_name": {
"type": "string",
"description": "顧客支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"client_name_for_post_disp_kbn": {
"type": "integer",
"description": "顧客支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_for_post_disp_kbn_name": {
"type": "string",
"description": "顧客支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"contact_id": {
"description": "顧客担当者ID\n\n※[顧客担当者登録API](#tag/contact/operation/postContact)・[顧客担当者リスト取得API](#tag/contact/operation/getContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"contact": {
"description": "顧客担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "顧客担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "顧客担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"cost_total": {
"type": "integer",
"format": "int32",
"description": "原価",
"example": 10000,
"readOnly": true
},
"cost_tax": {
"type": "integer",
"format": "int32",
"description": "原価の消費税",
"example": 1000,
"readOnly": true
},
"invoice_total": {
"type": "string",
"description": "請求額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"invoice_tax": {
"type": "string",
"description": "請求額の消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"estimate_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "見積日\n\n※新規登録時に未指定の場合は、本日の日付がセットされます\n",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期\n",
"example": "2023-10-20"
},
"delivery_date_text": {
"type": "string",
"maxLength": 50,
"description": "納期テキスト\n",
"example": "サンプル納期"
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"order_status": {
"type": "integer",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"order_status_name": {
"type": "string",
"description": "受注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"invoice_timing_kbn": {
"type": "integer",
"description": "請求タイミング\n\n- 1：一括請求\n- 2：定期請求\n- 3：分割請求\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"invoice_timing_kbn_name": {
"type": "string",
"description": "請求タイミングの名称",
"example": "一括請求",
"readOnly": true
},
"project_type_id": {
"type": "integer",
"description": "案件区分1ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type_name": {
"type": "string",
"description": "案件区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"project_type2_id": {
"type": "integer",
"description": "案件区分2ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type2_name": {
"type": "string",
"description": "案件区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"project_type3_id": {
"type": "integer",
"description": "案件区分3ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type3_name": {
"type": "string",
"description": "案件区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"ordered_date": {
"type": "string",
"description": "受注日",
"format": "YYYY-MM-DD",
"example": "2023-10-05"
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"project_costs": {
"description": "案件原価",
"readOnly": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"cost": {
"type": "integer",
"format": "int64",
"description": "金額",
"example": 10000
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル費用"
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-10"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-10"
}
}
}
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"format": "int64",
"description": "見積金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"format": "int32",
"description": "見積金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"invoice_total_jpy": {
"type": "integer",
"format": "int64",
"description": "請求金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"invoice_tax_jpy": {
"type": "integer",
"format": "int32",
"description": "請求金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"hubspot": {
"description": "HubSpotと連携している場合は、その連携情報",
"readOnly": true,
"type": "object",
"properties": {
"hubspot_deal_id": {
"type": "string",
"description": "HubSpotの取引ID",
"example": "123456"
}
}
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"title": "一括請求",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括請求用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
}
}
}
]
},
{
"title": "定期請求",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期請求用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期請求用\n",
"example": "2023-12-31"
},
"periodical_invoice_interval": {
"type": "integer",
"description": "請求間隔\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_invoice_payment_kbn": {
"type": "integer",
"description": "請求間隔内の請求時期\n\n- 1：請求間隔の最初の月\n- 2：請求間隔の最後の月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"contract_end_alert_flg": {
"type": "integer",
"description": "通知対象\n\n- 0：通知しない\n- 1：通知する\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期請求用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期請求用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"monthly_invoice_payment_kbn": {
"type": "integer",
"description": "自動挿入メッセージ年月\n\n- 1：請求月\n- 2：請求月の翌月\n- 3：請求月の前月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
}
}
}
]
},
{
"title": "分割請求",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
]
}
}
}
]
},
{
"properties": {
"estimate": {
"allOf": [
{
"description": "見積書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"valid_period": {
"type": "string",
"description": "有効期限",
"maxLength": 100,
"example": "御見積後2週間"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "見積日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"order": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"disp_order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日（表示設定）",
"example": "2023-10-01"
},
"disp_order_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注請日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発注請日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"deliveries": {
"type": "array",
"items": {
"allOf": [
{
"description": "納品書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "納品書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`deliveries`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日",
"example": "2023-10-01"
},
"disp_delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日（表示設定）",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "納品日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"invoices": {
"type": "array",
"items": {
"allOf": [
{
"description": "請求書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "請求書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`invoices`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31",
"readOnly": true
},
"payment_limit_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払期限",
"example": "2023-11-30",
"readOnly": true
},
"disp_invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "請求日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"multi_bank_info_flg": {
"type": "integer",
"description": "複数口座表示\n\n- 0：OFF\n- 1：ON\n\n※デフォルトは設定による\n",
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"receipts": {
"type": "array",
"items": {
"allOf": [
{
"description": "領収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "領収書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`receipts`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日",
"example": "2023-10-01",
"readOnly": true
},
"disp_receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発行日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
}
]
}
}
}
},
"Project_200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "案件ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"client_id": {
"description": "顧客ID\n\n※[顧客登録API](#tag/client/operation/postClient)・[顧客リスト取得API](#tag/client/operation/getClients)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client": {
"description": "顧客",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "顧客略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "顧客番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"client_branch_id": {
"description": "顧客支社ID\n\n※[顧客支社登録API](#tag/client_branch/operation/postClientBranch)・[顧客支社リスト取得API](#tag/client_branch/operation/getClientBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"client_branch": {
"description": "顧客支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "顧客支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"client_name_disp_kbn": {
"type": "integer",
"description": "顧客支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_disp_kbn_name": {
"type": "string",
"description": "顧客支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"client_name_for_post_disp_kbn": {
"type": "integer",
"description": "顧客支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※顧客支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"client_name_for_post_disp_kbn_name": {
"type": "string",
"description": "顧客支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"contact_id": {
"description": "顧客担当者ID\n\n※[顧客担当者登録API](#tag/contact/operation/postContact)・[顧客担当者リスト取得API](#tag/contact/operation/getContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"contact": {
"description": "顧客担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "顧客担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "顧客担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "顧客担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"cost_total": {
"type": "integer",
"format": "int32",
"description": "原価",
"example": 10000,
"readOnly": true
},
"cost_tax": {
"type": "integer",
"format": "int32",
"description": "原価の消費税",
"example": 1000,
"readOnly": true
},
"invoice_total": {
"type": "string",
"description": "請求額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"invoice_tax": {
"type": "string",
"description": "請求額の消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000",
"readOnly": true
},
"estimate_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "見積日\n\n※新規登録時に未指定の場合は、本日の日付がセットされます\n",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期\n",
"example": "2023-10-20"
},
"delivery_date_text": {
"type": "string",
"maxLength": 50,
"description": "納期テキスト\n",
"example": "サンプル納期"
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"order_status": {
"type": "integer",
"description": "受注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：受注確定\n- 5：受注済\n- 9：失注\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"order_status_name": {
"type": "string",
"description": "受注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"invoice_timing_kbn": {
"type": "integer",
"description": "請求タイミング\n\n- 1：一括請求\n- 2：定期請求\n- 3：分割請求\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"invoice_timing_kbn_name": {
"type": "string",
"description": "請求タイミングの名称",
"example": "一括請求",
"readOnly": true
},
"project_type_id": {
"type": "integer",
"description": "案件区分1ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type_name": {
"type": "string",
"description": "案件区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"project_type2_id": {
"type": "integer",
"description": "案件区分2ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type2_name": {
"type": "string",
"description": "案件区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"project_type3_id": {
"type": "integer",
"description": "案件区分3ID\n\n※[案件区分リスト取得API](#tag/project_type/operation/getProjectTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"project_type3_name": {
"type": "string",
"description": "案件区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"ordered_date": {
"type": "string",
"description": "受注日",
"format": "YYYY-MM-DD",
"example": "2023-10-05"
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"project_costs": {
"description": "案件原価",
"readOnly": true,
"type": "array",
"items": {
"type": "object",
"properties": {
"cost": {
"type": "integer",
"format": "int64",
"description": "金額",
"example": 10000
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル費用"
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-10"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-10"
}
}
}
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"format": "int64",
"description": "見積金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"format": "int32",
"description": "見積金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"invoice_total_jpy": {
"type": "integer",
"format": "int64",
"description": "請求金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"invoice_tax_jpy": {
"type": "integer",
"format": "int32",
"description": "請求金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"hubspot": {
"description": "HubSpotと連携している場合は、その連携情報",
"readOnly": true,
"type": "object",
"properties": {
"hubspot_deal_id": {
"type": "string",
"description": "HubSpotの取引ID",
"example": "123456"
}
}
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"title": "一括請求",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括請求用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
}
}
}
]
},
{
"title": "定期請求",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期請求用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期請求用\n",
"example": "2023-12-31"
},
"periodical_invoice_interval": {
"type": "integer",
"description": "請求間隔\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_invoice_payment_kbn": {
"type": "integer",
"description": "請求間隔内の請求時期\n\n- 1：請求間隔の最初の月\n- 2：請求間隔の最後の月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"contract_end_alert_flg": {
"type": "integer",
"description": "通知対象\n\n- 0：通知しない\n- 1：通知する\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
0,
1
]
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期請求用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期請求用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"monthly_invoice_payment_kbn": {
"type": "integer",
"description": "自動挿入メッセージ年月\n\n- 1：請求月\n- 2：請求月の翌月\n- 3：請求月の前月\n\n※定期請求用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
}
}
}
]
},
{
"title": "分割請求",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "納品書・検収書の枚数\n\n- 1：1枚\n- 2：請求回数と同じ\n\n※定期請求・分割請求用
\n※複数納品書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
]
}
}
}
]
},
{
"properties": {
"estimate": {
"allOf": [
{
"description": "見積書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"valid_period": {
"type": "string",
"description": "有効期限",
"maxLength": 100,
"example": "御見積後2週間"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "見積日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"order": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"disp_order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日（表示設定）",
"example": "2023-10-01"
},
"disp_order_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注請日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発注請日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"deliveries": {
"type": "array",
"items": {
"allOf": [
{
"description": "納品書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "納品書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`deliveries`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日",
"example": "2023-10-01"
},
"disp_delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日（表示設定）",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "納品日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"invoices": {
"type": "array",
"items": {
"allOf": [
{
"description": "請求書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "請求書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`invoices`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31",
"readOnly": true
},
"payment_limit_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払期限",
"example": "2023-11-30",
"readOnly": true
},
"disp_invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "請求日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"multi_bank_info_flg": {
"type": "integer",
"description": "複数口座表示\n\n- 0：OFF\n- 1：ON\n\n※デフォルトは設定による\n",
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"receipts": {
"type": "array",
"items": {
"allOf": [
{
"description": "領収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "領収書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`receipts`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日",
"example": "2023-10-01",
"readOnly": true
},
"disp_receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発行日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
}
]
}
}
}
},
"ProjectCost_201": {
"description": "登録成功",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "案件原価ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"project_id": {
"description": "案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル原価"
},
"cost": {
"type": "integer",
"description": "金額",
"format": "int32",
"example": 10000
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-11-30"
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
},
"ProjectCost_200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "案件原価ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"project_id": {
"description": "案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"description": {
"type": "string",
"description": "費用の説明",
"maxLength": 100,
"example": "サンプル原価"
},
"cost": {
"type": "integer",
"description": "金額",
"format": "int32",
"example": 10000
},
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31"
},
"payment_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-11-30"
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
},
"204_no_content": {
"description": "成功"
},
"Estimate_200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "見積書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"valid_period": {
"type": "string",
"description": "有効期限",
"maxLength": 100,
"example": "御見積後2週間"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "見積日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"Order_200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"disp_order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日（表示設定）",
"example": "2023-10-01"
},
"disp_order_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注請日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発注請日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"Delivery_200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "納品書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "納品書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`deliveries`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日",
"example": "2023-10-01"
},
"disp_delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納品日（表示設定）",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "納品日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"Invoice_200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "請求書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "請求書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`invoices`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31",
"readOnly": true
},
"payment_limit_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払期限",
"example": "2023-11-30",
"readOnly": true
},
"disp_invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "請求日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"multi_bank_info_flg": {
"type": "integer",
"description": "複数口座表示\n\n- 0：OFF\n- 1：ON\n\n※デフォルトは設定による\n",
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"Receipt_200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "領収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "領収書ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)・[案件取得API](#tag/project/operation/getProject)のレスポンスにある`receipts`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日",
"example": "2023-10-01",
"readOnly": true
},
"disp_receipt_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発行日（表示設定）",
"example": "2023-10-01"
},
"blank_date_flg": {
"type": "integer",
"description": "発行日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"Payee_201": {
"description": "登録成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注先関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "発注先ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"properties": {
"title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"default": "御中",
"example": "御中"
},
"payment_term_id": {
"description": "デフォルト支払条件ID\n\n- 新規登録時に未指定の場合は最初の支払条件が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "デフォルト支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"nda_flg": {
"description": "NDA締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"basic_agreement_flg": {
"description": "基本契約書締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"document_send_type": {
"description": "書類送付方法\n\n- 1：メール(DL)\n- 2：郵送\n- 3：メール(DL)+郵送\n- 4：メール(添付)\n- 5：メール(添付)+郵送\n- または[カスタム書類送付方法](#tag/document_send_channel/operation/getDocumentSendChannels)のID\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1
},
"document_send_type_name": {
"type": "string",
"description": "書類送付方法名",
"example": "メール(DL)",
"readOnly": true
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"wareki_flg": {
"description": "デフォルト和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_number": {
"type": "string",
"description": "法人番号",
"minLength": 13,
"maxLength": 13,
"example": "1234567890123"
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード\n\n※「会計連携機能」機能有効時のみ\n",
"maxLength": 100,
"example": "サンプル（株）"
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"invoice_system_number": {
"type": "string",
"description": "適格請求書発行事業者の登録番号",
"minLength": 14,
"maxLength": 14,
"example": "T1234567890123"
},
"invoice_system_number_validated": {
"type": "boolean",
"description": "登録番号のチェック状況",
"example": true,
"readOnly": true
},
"invoice_system_issuer_type": {
"description": "適格請求書発行事業者\n\n- 0：未設定\n- 1：該当する\n- 2：該当しない\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1,
2
]
},
"invoice_system_issuer_type_name": {
"type": "string",
"description": "適格請求書発行事業者の名称",
"example": "未設定",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"bank_charge_to_client_flg": {
"description": "振込手数料負担\n\n- 0：当方\n- 1：先方\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 1,
"enum": [
0,
1
]
},
"tax_withholding_kbn": {
"description": "デフォルト源泉徴収\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "デフォルト源泉徴収名",
"example": "なし",
"readOnly": true
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
},
"name_en": {
"type": "string",
"description": "発注先名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
}
}
},
{
"properties": {
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": "81"
},
"currency": {
"type": "string",
"description": "デフォルト通貨\n\n※英語アドオン有効時のみ\n",
"maxLength": 3,
"default": "JPY",
"example": "USD",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"description": "デフォルト言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "デフォルト言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"Payee_200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注先関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "発注先ID",
"type": "integer",
"format": "int32",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"properties": {
"title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"default": "御中",
"example": "御中"
},
"payment_term_id": {
"description": "デフォルト支払条件ID\n\n- 新規登録時に未指定の場合は最初の支払条件が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"type": "integer",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "デフォルト支払条件名",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"nda_flg": {
"description": "NDA締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"basic_agreement_flg": {
"description": "基本契約書締結\n\n- 0：未\n- 1：済\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"document_send_type": {
"description": "書類送付方法\n\n- 1：メール(DL)\n- 2：郵送\n- 3：メール(DL)+郵送\n- 4：メール(添付)\n- 5：メール(添付)+郵送\n- または[カスタム書類送付方法](#tag/document_send_channel/operation/getDocumentSendChannels)のID\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1
},
"document_send_type_name": {
"type": "string",
"description": "書類送付方法名",
"example": "メール(DL)",
"readOnly": true
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"wareki_flg": {
"description": "デフォルト和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"company_number": {
"type": "string",
"description": "法人番号",
"minLength": 13,
"maxLength": 13,
"example": "1234567890123"
},
"accounting_code": {
"type": "string",
"description": "会計用名称・コード\n\n※「会計連携機能」機能有効時のみ\n",
"maxLength": 100,
"example": "サンプル（株）"
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"invoice_system_number": {
"type": "string",
"description": "適格請求書発行事業者の登録番号",
"minLength": 14,
"maxLength": 14,
"example": "T1234567890123"
},
"invoice_system_number_validated": {
"type": "boolean",
"description": "登録番号のチェック状況",
"example": true,
"readOnly": true
},
"invoice_system_issuer_type": {
"description": "適格請求書発行事業者\n\n- 0：未設定\n- 1：該当する\n- 2：該当しない\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1,
2
]
},
"invoice_system_issuer_type_name": {
"type": "string",
"description": "適格請求書発行事業者の名称",
"example": "未設定",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"bank_charge_to_client_flg": {
"description": "振込手数料負担\n\n- 0：当方\n- 1：先方\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 1,
"enum": [
0,
1
]
},
"tax_withholding_kbn": {
"description": "デフォルト源泉徴収\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "デフォルト源泉徴収名",
"example": "なし",
"readOnly": true
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
},
"name_en": {
"type": "string",
"description": "発注先名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
}
}
},
{
"properties": {
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": "81"
},
"currency": {
"type": "string",
"description": "デフォルト通貨\n\n※英語アドオン有効時のみ\n",
"maxLength": 3,
"default": "JPY",
"example": "USD",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"description": "デフォルト言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"type": "integer",
"format": "int32",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "デフォルト言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
}
}
},
{
"type": "object",
"properties": {
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"PayeeBranch_201": {
"description": "登録成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注先支社関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "発注先支社ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"type": "object",
"properties": {
"name_en": {
"type": "string",
"description": "発注先支社名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
},
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": 81
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"PayeeBranch_200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注先支社関連の定義情報"
},
{
"type": "object",
"properties": {
"id": {
"description": "発注先支社ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
{
"properties": {
"zip": {
"type": "string",
"description": "郵便番号（ハイフン区切り）",
"maxLength": 8,
"example": "100-0001"
},
"pref": {
"type": "string",
"description": "都道府県",
"example": "東京都"
},
"address1": {
"type": "string",
"description": "市区町村・番地",
"maxLength": 100,
"example": "千代田区千代田111"
},
"address2": {
"type": "string",
"description": "建物名",
"maxLength": 100,
"example": "サンプルビル3階"
},
"tel": {
"type": "string",
"description": "TEL（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
},
"fax": {
"type": "string",
"description": "FAX（ハイフン区切り）",
"maxLength": 15,
"example": "03-0000-0000"
}
}
},
{
"type": "object",
"properties": {
"name_en": {
"type": "string",
"description": "発注先支社名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 100,
"example": "Sample, inc"
},
"address_en": {
"type": "string",
"description": "住所（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 500,
"example": "111 Chiyoda, Chiyoda, Tokyo 100-0001, Japan"
},
"phone_country_code": {
"type": "string",
"description": "国番号（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 10,
"example": 81
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
]
}
}
}
},
"PayeeContact_201": {
"description": "登録成功",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "発注先担当者ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎"
},
"honorific_title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"example": "様"
},
"title": {
"type": "string",
"description": "肩書",
"maxLength": 50,
"example": "部長"
},
"department": {
"type": "string",
"description": "部署",
"maxLength": 50,
"example": "システム部"
},
"email": {
"type": "string",
"description": "email",
"maxLength": 100,
"example": "yamada@example.com"
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"last_name_en": {
"type": "string",
"description": "姓（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Yamada"
},
"first_name_en": {
"type": "string",
"description": "名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Taro"
},
"prefix_en": {
"type": "string",
"description": "敬称（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Mr."
},
"title_en": {
"type": "string",
"description": "肩書（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Manager"
},
"department_en": {
"type": "string",
"description": "部署（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "IT Dept."
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
},
"PayeeContact_200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"properties": {
"id": {
"description": "発注先担当者ID",
"type": "integer",
"format": "int32",
"example": 12345,
"readOnly": true
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"last_name": {
"type": "string",
"description": "姓",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "名",
"maxLength": 50,
"example": "太郎"
},
"honorific_title": {
"type": "string",
"description": "敬称",
"maxLength": 50,
"example": "様"
},
"title": {
"type": "string",
"description": "肩書",
"maxLength": 50,
"example": "部長"
},
"department": {
"type": "string",
"description": "部署",
"maxLength": 50,
"example": "システム部"
},
"email": {
"type": "string",
"description": "email",
"maxLength": 100,
"example": "yamada@example.com"
},
"note": {
"type": "string",
"description": "備考",
"maxLength": 1000,
"example": "備考サンプルです"
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"last_name_en": {
"type": "string",
"description": "姓（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Yamada"
},
"first_name_en": {
"type": "string",
"description": "名（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Taro"
},
"prefix_en": {
"type": "string",
"description": "敬称（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Mr."
},
"title_en": {
"type": "string",
"description": "肩書（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "Manager"
},
"department_en": {
"type": "string",
"description": "部署（英語表記）\n\n※英語アドオン有効時のみ\n",
"maxLength": 50,
"example": "IT Dept."
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
}
}
}
},
"Expenditure_201": {
"description": "登録成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "発注ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"expenditure_no": {
"type": "integer",
"format": "int32",
"description": "発注No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注名",
"maxLength": 100,
"example": "サンプル発注A"
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"payee_branch_id": {
"description": "発注先支社ID\n\n※[発注先支社登録API](#tag/payee_branch/operation/postPayeeBranch)・[発注先支社リスト取得API](#tag/payee_branch/operation/getPayeeBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_branch": {
"description": "発注先支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"payee_name_disp_kbn": {
"type": "integer",
"description": "発注先支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_disp_kbn_name": {
"type": "string",
"description": "発注先支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_name_for_post_disp_kbn": {
"type": "integer",
"description": "発注先支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_for_post_disp_kbn_name": {
"type": "string",
"description": "発注先支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_contact_id": {
"description": "発注先担当者ID\n\n※[発注先担当者登録API](#tag/payee_contact/operation/postPayeeContact)・[発注先担当者リスト取得API](#tag/payee_contact/operation/getPayeeContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_contact": {
"description": "発注先担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "発注先担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "発注先担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"project_id": {
"description": "関連案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"project": {
"description": "案件",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "案件ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
}
}
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
],
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01",
"readOnly": true
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"expenditure_status": {
"type": "integer",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"expenditure_status_name": {
"type": "string",
"description": "発注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"payment_timing_kbn": {
"type": "integer",
"description": "支払タイミング\n\n- 1：一括支払\n- 2：定期支払\n- 3：分割支払\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"payment_timing_kbn_name": {
"type": "string",
"description": "支払タイミングの名称",
"example": "一括支払",
"readOnly": true
},
"tax_withholding_kbn": {
"type": "integer",
"description": "源泉徴収区分\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "源泉徴収区分の名称",
"example": "なし",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"expenditure_type_id": {
"type": "integer",
"description": "発注区分1\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type_name": {
"type": "string",
"description": "発注区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"expenditure_type2_id": {
"type": "integer",
"description": "発注区分2\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type2_name": {
"type": "string",
"description": "発注区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"expenditure_type3_id": {
"type": "integer",
"description": "発注区分3\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type3_name": {
"type": "string",
"description": "発注区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"company_bank_id": {
"type": "integer",
"description": "集計用出金口座（振込口座ID）\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"format": "int32",
"example": 123456
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"description": "発注金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"description": "発注金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"title": "一括支払",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括支払用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"title": "定期支払",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期支払用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期支払用\n",
"example": "2023-12-31"
},
"periodical_payment_interval": {
"type": "integer",
"description": "支払間隔\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_payment_payment_kbn": {
"type": "integer",
"description": "支払間隔内の請求時期\n\n- 1：支払間隔の最初の月\n- 2：支払間隔の最後の月\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"periodical_payment_payment_kbn_name": {
"type": "string",
"description": "請求間隔内の請求時期の名称",
"example": "支払間隔の最初の月",
"readOnly": true
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期支払用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期支払用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"title": "分割支払",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoices": {
"type": "array",
"description": "請求情報\n\n※分割支払用\n",
"writeOnly": true,
"items": {
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31"
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
},
"required": [
"invoice_date",
"total",
"tax"
]
}
}
}
}
]
},
{
"properties": {
"expenditure_estimate": {
"allOf": [
{
"description": "見積依頼書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積依頼書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"estimate_request_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "依頼日",
"example": "2023-10-01"
},
"desired_delivery_date_text": {
"type": "string",
"description": "希望納期",
"maxLength": 100,
"example": "2週間後"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "依頼日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"expenditure_order": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "発注日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"expenditure_deliveries": {
"type": "array",
"items": {
"allOf": [
{
"description": "検収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "検収書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_delivery`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"delivery_received_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "検収日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"expenditure_invoices": {
"type": "array",
"items": {
"allOf": [
{
"description": "支払通知書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "支払通知書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_invoice`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"paid_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "支払日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
}
]
}
}
}
},
"Expenditure_200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"title": "共通",
"properties": {
"id": {
"type": "integer",
"description": "発注ID",
"format": "int32",
"example": 123456,
"readOnly": true
},
"expenditure_no": {
"type": "integer",
"format": "int32",
"description": "発注No",
"example": 1001,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注名",
"maxLength": 100,
"example": "サンプル発注A"
},
"payee_id": {
"description": "発注先ID\n\n※[発注先登録API](#tag/payee/operation/postPayee)・[発注先リスト取得API](#tag/payee/operation/getPayees)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee": {
"description": "発注先",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先名",
"maxLength": 100,
"example": "サンプル株式会社"
},
"name_disp": {
"type": "string",
"description": "発注先略称名",
"maxLength": 50,
"example": "サンプル"
},
"custom_no": {
"type": "string",
"description": "発注先番号",
"maxLength": 100,
"example": "C0001"
}
}
},
"payee_branch_id": {
"description": "発注先支社ID\n\n※[発注先支社登録API](#tag/payee_branch/operation/postPayeeBranch)・[発注先支社リスト取得API](#tag/payee_branch/operation/getPayeeBranches)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_branch": {
"description": "発注先支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "発注先支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"payee_name_disp_kbn": {
"type": "integer",
"description": "発注先支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_disp_kbn_name": {
"type": "string",
"description": "発注先支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_name_for_post_disp_kbn": {
"type": "integer",
"description": "発注先支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※発注先支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"payee_name_for_post_disp_kbn_name": {
"type": "string",
"description": "発注先支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"payee_contact_id": {
"description": "発注先担当者ID\n\n※[発注先担当者登録API](#tag/payee_contact/operation/postPayeeContact)・[発注先担当者リスト取得API](#tag/payee_contact/operation/getPayeeContacts)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"payee_contact": {
"description": "発注先担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "発注先担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "発注先担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "発注先担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"company_branch_id": {
"description": "自社支社ID\n\n※このIDを取得するAPIはありません。画面上の「組織設定→支社管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_branches/123456/edit` → 123456\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"company_branch": {
"description": "自社支社",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "自社支社ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "自社支社名",
"maxLength": 100,
"example": "サンプル支社"
}
}
},
"company_name_disp_kbn": {
"type": "integer",
"description": "自社支社（書類上の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_disp_kbn_name": {
"type": "string",
"description": "自社支社（書類上の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"company_name_for_post_disp_kbn": {
"type": "integer",
"description": "自社支社（郵送時の表示）\n\n- 1：会社名のみ\n- 2：会社名＋支社名\n- 3：支社名のみ\n\n※自社支社を指定する場合のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"company_name_for_post_disp_kbn_name": {
"type": "string",
"description": "自社支社（郵送時の表示）の名称",
"example": "会社名のみ",
"readOnly": true
},
"user_id": {
"description": "担当者ID\n\n※[ユーザーリスト取得API](#tag/user/operation/getUsers)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"user": {
"description": "担当者",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "担当者ID",
"example": 123456,
"readOnly": true
},
"last_name": {
"type": "string",
"description": "担当者名（姓）",
"maxLength": 50,
"example": "山田"
},
"first_name": {
"type": "string",
"description": "担当者名（名）",
"maxLength": 50,
"example": "太郎"
}
}
},
"project_id": {
"description": "関連案件ID\n\n※[案件登録API](#tag/project/operation/postProject)・[案件リスト取得API](#tag/project/operation/getProjects)のレスポンスにある`id`\n",
"type": "integer",
"format": "int32",
"example": 123456,
"writeOnly": true
},
"project": {
"description": "案件",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "案件ID",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "案件名",
"maxLength": 100,
"example": "サンプル案件A"
},
"project_no": {
"type": "integer",
"format": "int32",
"description": "案件No",
"example": 1001,
"readOnly": true
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
}
}
},
"invoice_dates": {
"type": "array",
"description": "請求日（`YYYY-MM-DD`形式の日付）の配列\n",
"items": {
"type": "string"
},
"example": [
"2023-10-31",
"2024-01-31"
],
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01",
"readOnly": true
},
"payment_term_id": {
"type": "integer",
"description": "支払条件ID\n\n- 新規登録時に未指定の場合は「デフォルト支払条件」が使用されます\n- [支払条件リスト取得API](#tag/payment_term/operation/getPaymentTerms)のレスポンスにある`id`です\n",
"format": "int32",
"example": 123456
},
"payment_term_name": {
"type": "string",
"description": "支払条件の名称",
"maxLength": 100,
"example": "月末締め翌月末払い",
"readOnly": true
},
"expenditure_status": {
"type": "integer",
"description": "発注ステータス\n\n- 1：見積中(高)\n- 2：見積中(中)\n- 3：見積中(低)\n- 8：見積中(除)\n- 4：発注確定\n- 5：発注済\n- 9：見送り\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
8,
9
]
},
"expenditure_status_name": {
"type": "string",
"description": "発注ステータスの名称",
"example": "見積中(高)",
"readOnly": true
},
"payment_timing_kbn": {
"type": "integer",
"description": "支払タイミング\n\n- 1：一括支払\n- 2：定期支払\n- 3：分割支払\n",
"example": 1,
"enum": [
1,
2,
3
]
},
"payment_timing_kbn_name": {
"type": "string",
"description": "支払タイミングの名称",
"example": "一括支払",
"readOnly": true
},
"tax_withholding_kbn": {
"type": "integer",
"description": "源泉徴収区分\n\n- 1：なし\n- 2：源泉徴収（復興特別所得税あり）\n- 3：源泉徴収（復興特別所得税なし）\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3
]
},
"tax_withholding_kbn_name": {
"type": "string",
"description": "源泉徴収区分の名称",
"example": "なし",
"readOnly": true
},
"in_house_memo": {
"type": "string",
"description": "社内メモ",
"maxLength": 2000,
"example": "サンプルメモです。"
},
"management_no": {
"type": "string",
"description": "管理番号",
"maxLength": 20,
"example": "TEST0001"
},
"expenditure_type_id": {
"type": "integer",
"description": "発注区分1\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type_name": {
"type": "string",
"description": "発注区分1の名称",
"example": "サンプル案件区分1",
"readOnly": true
},
"expenditure_type2_id": {
"type": "integer",
"description": "発注区分2\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type2_name": {
"type": "string",
"description": "発注区分2の名称",
"example": "サンプル案件区分2",
"readOnly": true
},
"expenditure_type3_id": {
"type": "integer",
"description": "発注区分3\n\n※[発注区分リスト取得API](#tag/expenditure_type/operation/getExpenditureTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"expenditure_type3_name": {
"type": "string",
"description": "発注区分3の名称",
"example": "サンプル案件区分3",
"readOnly": true
},
"tags": {
"type": "array",
"description": "タグ\n\n※タグ名の配列\n",
"items": {
"type": "string"
},
"example": [
"タグA",
"タグB"
]
},
"group_id": {
"type": "integer",
"description": "グループID\n\n※[グループリスト取得API](#tag/group/operation/getGroups)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"group_name": {
"type": "string",
"description": "グループの名称",
"example": "サンプルグループ",
"readOnly": true
},
"accounting_type_id": {
"type": "integer",
"description": "会計区分1ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type_name": {
"type": "string",
"description": "会計区分1の名称",
"example": "サンプル会計区分1",
"readOnly": true
},
"accounting_type2_id": {
"type": "integer",
"description": "会計区分2ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type2_name": {
"type": "string",
"description": "会計区分2の名称",
"example": "サンプル会計区分2",
"readOnly": true
},
"accounting_type3_id": {
"type": "integer",
"description": "会計区分3ID\n\n※[会計区分リスト取得API](#tag/accounting_type/operation/getAccountingTypes)のレスポンスにある`id`\n",
"format": "int32",
"example": 123456
},
"accounting_type3_name": {
"type": "string",
"description": "会計区分3の名称",
"example": "サンプル会計区分3",
"readOnly": true
},
"company_bank_id": {
"type": "integer",
"description": "集計用出金口座（振込口座ID）\n\n※このIDを取得するAPIはありません。画面上の「組織設定→振込口座管理」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/company_banks/123456/edit` → 123456\n",
"format": "int32",
"example": 123456
},
"delivery_status": {
"type": "integer",
"description": "進捗状況\n\n- 1：未着手\n- 2：着手中\n- 3：納品済\n- 4：検収済\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"delivery_status_name": {
"type": "string",
"description": "進捗状況の名称",
"example": "未着手",
"readOnly": true
},
"payment_method_kbn": {
"type": "integer",
"description": "支払方法\n\n- 1：銀行振込\n- 2：口座振替\n- 3：クレジットカード\n- 4：現金支払\n- 5：代金引換\n- 6：コンビニ支払\n- 7：郵便振替\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7
]
},
"payment_method_kbn_name": {
"type": "string",
"description": "支払方法の名称",
"example": "銀行振込",
"readOnly": true
},
"tax_rule_kbn": {
"type": "integer",
"description": "端数処理\n\n- 1：四捨五入\n- 2：切り捨て\n- 3：切り上げ\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 2,
"enum": [
1,
2,
3
]
},
"tax_rule_kbn_name": {
"type": "string",
"description": "端数処理の名称",
"example": "切り捨て",
"readOnly": true
},
"minus_rounding_rule": {
"type": "integer",
"description": "マイナス金額の端数処理\n\n- 1：数値を基準にする\n- 2：絶対値を基準にする\n\n※デフォルトはアカウントの端数処理設定による\n",
"example": 1,
"enum": [
1,
2
],
"readOnly": true
},
"minus_rounding_rule_name": {
"type": "string",
"description": "マイナス金額の端数処理の名称",
"example": "数値を基準にする",
"readOnly": true
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"enum": [
0,
1
],
"readOnly": true
},
"wareki_flg": {
"type": "integer",
"description": "和暦表示\n\n- 0：西暦\n- 1：和暦\n\n※「和暦表示」機能有効時のみ\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"archive_flg": {
"description": "アーカイブ状態\n\n- 0：未アーカイブ\n- 1：アーカイブ済み\n",
"type": "integer",
"format": "int32",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率\n\n- 1：対象外\n- 2：対象\n\n※「軽減税率」機能有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"document_setting_id": {
"type": "integer",
"description": "書類詳細設定ID\n\n※このIDを取得するAPIはありません。画面上の「設定→書類詳細設定」で対象の「編集」に行き、そのURLに含まれるIDを使用してください。例：`https://the-board.jp/document_settings/123456/edit` → 123456\n",
"format": "int64",
"example": 123456
},
"document_setting_name": {
"type": "string",
"description": "書類詳細設定の名称",
"example": "メイン用",
"readOnly": true
},
"to": {
"type": "string",
"description": "TO（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"cc": {
"type": "string",
"description": "CC（メールアドレス）\n\n※複数指定する場合はカンマ区切り\n",
"maxLength": 1000,
"example": "test@example.com"
},
"currency": {
"type": "string",
"description": "通貨\n\n※英語アドオン有効時のみ\n",
"default": "JPY",
"example": "JPY",
"enum": [
"JPY",
"USD",
"EUR",
"GBP",
"CNY",
"HKD",
"TWD",
"KRW",
"SGD",
"AUD",
"IDR",
"THB",
"CAD"
]
},
"lang_kbn": {
"type": "integer",
"description": "言語\n\n- 1：日本語\n- 2：英語\n\n※英語アドオン有効時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"lang_kbn_name": {
"type": "string",
"description": "言語の名称\n\n※英語アドオン有効時のみ\n",
"example": "日本語",
"readOnly": true
},
"exchange_rate": {
"type": "string",
"description": "為替レート\n\n※英語アドオン有効時のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "149.43"
},
"total_jpy": {
"type": "integer",
"description": "発注金額の税抜金額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 100000,
"readOnly": true
},
"tax_jpy": {
"type": "integer",
"description": "発注金額の消費税額（日本円）\n\n※英語アドオン有効時のみ\n",
"example": 10000,
"readOnly": true
},
"created_at": {
"type": "string",
"description": "登録日時",
"example": "2023-08-02T16:27:35.000+09:00",
"readOnly": true
},
"updated_at": {
"type": "string",
"description": "更新日時",
"example": "2023-08-04T11:03:15.000+09:00",
"readOnly": true
}
}
},
{
"title": "一括支払",
"allOf": [
{
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日\n\n※一括支払用\n",
"items": {
"type": "string"
},
"example": "2023-10-31",
"writeOnly": true
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"title": "定期支払",
"allOf": [
{
"properties": {
"contract_start_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求開始日\n\n※定期支払用\n",
"example": "2023-10-01"
},
"contract_end_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求終了日\n\n※定期支払用\n",
"example": "2023-12-31"
},
"periodical_payment_interval": {
"type": "integer",
"description": "支払間隔\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"periodical_payment_payment_kbn": {
"type": "integer",
"description": "支払間隔内の請求時期\n\n- 1：支払間隔の最初の月\n- 2：支払間隔の最後の月\n\n※定期支払用\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"periodical_payment_payment_kbn_name": {
"type": "string",
"description": "請求間隔内の請求時期の名称",
"example": "支払間隔の最初の月",
"readOnly": true
},
"auto_renewal_flg": {
"type": "integer",
"description": "自動契約更新\n\n- 0：OFF\n- 1：ON\n\n※定期支払用\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"auto_renewal_period_month": {
"type": "integer",
"description": "自動契約更新期間（月数）\n\n※定期支払用\n",
"example": 1,
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12
]
},
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
}
}
]
},
{
"title": "分割支払",
"allOf": [
{
"properties": {
"delivery_document_kbn": {
"type": "integer",
"description": "検収書の枚数\n\n- 1：1枚\n- 2：支払回数と同じ\n\n※定期支払・分割支払用
\n※複数検収書対応ON時のみ\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"invoices": {
"type": "array",
"description": "請求情報\n\n※分割支払用\n",
"writeOnly": true,
"items": {
"type": "object",
"properties": {
"invoice_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "請求日",
"example": "2023-10-31"
},
"total": {
"type": "string",
"description": "税抜金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "integer",
"description": "源泉所得税",
"example": 10210
}
},
"required": [
"invoice_date",
"total",
"tax"
]
}
}
}
}
]
},
{
"properties": {
"expenditure_estimate": {
"allOf": [
{
"description": "見積依頼書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積依頼書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"estimate_request_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "依頼日",
"example": "2023-10-01"
},
"desired_delivery_date_text": {
"type": "string",
"description": "希望納期",
"maxLength": 100,
"example": "2週間後"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "依頼日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"expenditure_order": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "発注日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
},
"expenditure_deliveries": {
"type": "array",
"items": {
"allOf": [
{
"description": "検収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "検収書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_delivery`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"delivery_received_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "検収日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
},
"expenditure_invoices": {
"type": "array",
"items": {
"allOf": [
{
"description": "支払通知書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "支払通知書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_invoice`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"paid_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "支払日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
}
]
}
}
}
},
"ExpenditureEstimate_200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "見積依頼書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "見積依頼書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_estimate`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"estimate_request_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "依頼日",
"example": "2023-10-01"
},
"desired_delivery_date_text": {
"type": "string",
"description": "希望納期",
"maxLength": 100,
"example": "2週間後"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "依頼日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"ExpenditureOrder_200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "発注書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "発注書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_order`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"order_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "発注日",
"example": "2023-10-01"
},
"delivery_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "納期",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "発注日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"ExpenditureDelivery_200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "検収書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "検収書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_delivery`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"delivery_received_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日",
"example": "2023-10-01"
},
"disp_delivery_receive_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "検収日（表示設定）",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "検収日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
},
"ExpenditureInvoice_200": {
"description": "成功",
"content": {
"application/json": {
"schema": {
"allOf": [
{
"description": "支払通知書"
},
{
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "支払通知書ID\n\n※[発注登録API](#tag/expenditure/operation/postExpenditure)・[発注リスト取得API](#tag/expenditure/operation/getExpenditures)・[発注取得API](#tag/expenditure/operation/getExpenditure)のレスポンスにある`expenditure_invoice`内の`id`（要レスポンスグループ指定）\n",
"format": "int32",
"example": 123456,
"readOnly": true
},
"paid_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "支払日",
"example": "2023-10-01"
}
}
},
{
"properties": {
"message": {
"type": "string",
"description": "備考",
"maxLength": 5000,
"example": "備考サンプルです"
},
"total": {
"type": "string",
"description": "小計\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"tax": {
"type": "string",
"description": "消費税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "10000"
},
"tax_withholding": {
"type": "string",
"description": "源泉所得税\n\n※APIから登録時は画面上と異なり自動計算されないため未指定の場合は0になります\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "0"
},
"seal_approval_status": {
"type": "integer",
"description": "申請ステータス\n\n- 1：未申請\n- 2：申請中\n- 3：承認済\n- 8：取消\n- 9：否認\n",
"example": 1,
"readOnly": true
},
"document_amount_disp_kbn": {
"type": "integer",
"description": "金額表示\n\n- 1：税込表示\n- 2：合計欄を税抜表示＋明細下の小計・消費税行非表示\n- 3：合計欄のみ税抜表示\n- 4：合計表示なし\n\n※デフォルトは「デフォルト設定」によって決まります\n",
"example": 1,
"enum": [
1,
2,
3,
4
]
},
"lock_flg": {
"type": "integer",
"description": "ロックフラグ\n\n- 0：未ロック\n- 1：ロック済み\n",
"default": 0,
"example": 0,
"readOnly": true,
"enum": [
0,
1
]
},
"delivery_place": {
"type": "string",
"description": "納品場所",
"maxLength": 100,
"example": "サンプル倉庫"
},
"details": {
"type": "array",
"description": "明細行",
"items": {
"type": "object",
"properties": {
"no": {
"type": "integer",
"description": "行番号",
"format": "int32",
"example": 1,
"readOnly": true
},
"detail_date": {
"type": "string",
"format": "YYYY-MM-DD",
"description": "明細日付",
"example": "2023-12-31"
},
"description": {
"type": "string",
"description": "摘要",
"maxLength": 150,
"example": "サンプル商品A"
},
"quantity": {
"type": "string",
"description": "数量\n\n※10,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "1"
},
"unit": {
"type": "string",
"description": "単位",
"maxLength": 4,
"example": "式"
},
"unit_price": {
"type": "string",
"description": "単価\n\n※1,000,000,000未満の値を設定してください\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"price": {
"type": "string",
"description": "金額",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000",
"readOnly": true
},
"tax_rate": {
"type": "string",
"format": "decimal",
"pattern": "^\\d{1,2}(\\.\\d+)?$",
"description": "税率\n\n＊10・8・5・0のいずれかを設定してください\n",
"example": "10"
},
"tax_withholding_flg": {
"type": "integer",
"description": "源泉徴収対象\n\n- 0：源泉徴収対象ではない\n- 1：源泉徴収対象\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"tax_included_flg": {
"type": "integer",
"description": "内税フラグ\n\n- 0：外税\n- 1：内税\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
},
"reduced_tax_rate_kbn": {
"type": "integer",
"description": "軽減税率区分\n\n- 1：軽減税率対象外\n- 2：軽減税率対象\n",
"default": 1,
"example": 1,
"enum": [
1,
2
]
},
"section_description": {
"type": "string",
"description": "見出し行・小計行のテキスト\n\n※`document_detail_kbn`が「2：見出し行」または「3：小計行」の場合のみ\n",
"maxLength": 100,
"example": "サンプル見出しA"
},
"section_subtotal": {
"type": "string",
"description": "見出し小計の金額\n\n※`document_detail_kbn`が「3：小計行」の場合のみ\n",
"format": "decimal",
"pattern": "^-?\\d+(\\.\\d+)?$",
"example": "100000"
},
"document_detail_kbn": {
"type": "integer",
"description": "書類明細区分\n\n- 1：通常行\n- 2：見出し行\n- 3：小計行\n",
"example": 1,
"default": 1,
"enum": [
1,
2,
3
]
},
"document_detail_kbn_name": {
"type": "string",
"description": "書類明細区分名",
"example": "通常行",
"readOnly": true
},
"deduction_applicable": {
"type": "boolean",
"description": "控除対象\n\n- false：控除対象外\n- true：控除対象\n\n※「双方向インボイス」の場合のみ\n",
"default": false,
"example": true,
"enum": [
false,
true
]
}
}
}
}
}
},
{
"type": "object",
"properties": {
"blank_date_flg": {
"type": "integer",
"description": "支払日空欄\n\n- 0：表示\n- 1：空欄にする\n",
"default": 0,
"example": 0,
"enum": [
0,
1
]
}
}
}
]
}
}
}
}
}
},
"x-tagGroups": [
{
"name": "API",
"tags": [
"client",
"client_branch",
"contact",
"project",
"project_cost",
"invoice",
"project_document",
"payee",
"payee_branch",
"payee_contact",
"expenditure",
"expenditure_payment",
"expenditure_document",
"analysis",
"user",
"group",
"payment_term",
"project_type",
"expenditure_type",
"accounting_type",
"document_send_channel"
]
}
]
}