Sections
部門
GET /api/1/sections — 部門一覧の取得
概要 指定した事業所に登録されている部門の一覧を取得します。取引や振替伝票の明細に付与する部門マスタを参照する用途を想定しています。
注意点 start_update_date / end_update_date で部門の更新日を範囲指定して絞り込めます。JST の日付を yyyy-mm-dd で指定してください（どちらも指定日を含みます）。部門階層を利用している場合、階層構造を維持するため、更新日が範囲外の親部門を含むことがあります。 部門階層を利用できるプランでは indent_count と parent_id を返します。利用できないプランでは、これらのキー自体が返りません。 部門コード（code）は、事業所の設定で部門コードを使用する設定にしている場合のみレスポンスに含まれます。設定が無効の場合は code キー自体が返りません。
パラメータ
- company_id*: integer(int64) - 事業所ID。取得対象の事業所を指定します。
- start_update_date: string - 更新日で絞り込む開始日 (yyyy-mm-dd, JST)。指定日を含む、それ以降に更新された部門を対象にします。
- end_update_date: string - 更新日で絞り込む終了日 (yyyy-mm-dd, JST)。指定日を含む、それ以前に更新された部門を対象にします。
レスポンス
部門一覧の取得に成功しました。
- sections*: array[object] - 部門の一覧
POST /api/1/sections — 部門の作成
概要 指定した事業所に新しい部門を作成します。作成された部門は使用設定（available）が true の状態で登録され、取引作成時などに指定できるようになります。
注意点 部門名（name）は事業所内で重複できません。既に同名の部門が存在する場合は 400 エラーになります。 部門コード（code）を利用するには、事業所の設定で部門コードを使用する設定にする必要があります。設定が無効の場合、code を指定しても無視され保存されません。 親部門ID（parent_id）は部門階層を利用できるプランでのみ反映されます。利用できないプランでは指定しても親子関係は作成されません。
リクエストボディ
- company_id*: integer(int64) - 事業所ID。部門を作成・更新する対象の事業所を指定します。 例:
1(最小: 1) - name*: string - 部門名 (30文字以内)。事業所内で重複できません。既に同名の部門が存在する場合は 400 エラーになります。 例:
開発部門 - long_name: string - 部門の正式名称 (255文字以内)。作成時に省略した場合は未設定（null）になります。更新時に省略した場合は現在の値を維持し、null を指定した場合は未設定に更新します。 例:
開発本部 - shortcut1: string - ショートカット1 (20文字以内)。Web画面などで部門を検索する際のキーワードとして使用します。更新時に省略または null を指定した場合は未設定（null）に更新されます。 例:
DEVELOPER - shortcut2: string - ショートカット2 (20文字以内)。Web画面などで部門を検索する際のキーワードとして使用します。更新時に省略または null を指定した場合は未設定（null）に更新されます。 例:
123 - code: string - 部門コード (20文字以内、半角英数字・ハイフン・アンダースコアのみ)。事業所内で重複できません。事業所の設定で部門コードを使用する設定にしている場合のみ保存され、設定が無効の場合は指定しても無視されます。更新時に省略または null を指定した場合は未設定（null）に更新されます。 例:
code001(パターン: ^[0-9a-zA-Z_-]+$) - parent_id: integer(int64) - 親部門ID。部門階層を利用できるプランでのみ反映されます。更新時に省略した場合は現在の親子関係を維持し、null を指定した場合は親部門との関係を解除します。 例:
101(最小: 1)
レスポンス
部門の作成に成功しました。作成された部門を返します。
- section*: object
GET /api/1/sections/{id} — 部門の取得
概要 指定した事業所の部門を 1 件取得します。部門ID（id）は部門一覧の取得APIで確認できます。
注意点 部門階層を利用できるプランでは indent_count と parent_id を返します。利用できないプランでは、これらのキー自体が返りません。 部門コード（code）は、事業所の設定で部門コードを使用する設定にしている場合のみレスポンスに含まれます。設定が無効の場合は code キー自体が返りません。 存在しないか既に削除された部門IDを指定した場合は 404 を返します。
パラメータ
- id* (path): integer(int64) - 部門ID。部門一覧の取得APIのレスポンスに含まれる id を指定します。
- company_id*: integer(int64) - 事業所ID。取得対象の事業所を指定します。
レスポンス
部門の取得に成功しました。
- section*: object
PUT /api/1/sections/{id} — 部門の更新
概要 指定した事業所の部門を更新します。このAPIは部門の作成は行いません。部門コードをキーに更新（存在しない場合は作成）したい場合は PUT /api/1/sections/code/upsert を利用してください。
注意点 部門名（name）は事業所内で重複できません。別の部門と同名になる更新は 400 エラーになります。 long_name と parent_id は、省略した場合に現在の値・親子関係を維持します。null を指定すると未設定・親部門なしに更新します。 shortcut1 / shortcut2 / code は、省略または null を指定した場合に未設定（null）へ更新されます。値を維持したい場合は現在の値を指定してください。 部門コード（code）は、事業所の設定で部門コードを使用する設定にしている場合のみ更新されます。設定が無効の場合、code を指定しても無視されます。 親部門ID（parent_id）は部門階層を利用できるプランでのみ反映されます。
パラメータ
- id* (path): integer(int64) - 部門ID。部門一覧の取得APIのレスポンスに含まれる id を指定します。
リクエストボディ
POST /api/1/sections と同じ
レスポンス
部門の更新に成功しました。更新後の部門を返します。
- section*: object
DELETE /api/1/sections/{id} — 部門の削除
概要 指定した事業所の部門を削除します。
注意点 取引明細・申請・配賦設定などで使用されている部門は削除できず、400 エラーになります。部門を入力候補から外したい場合は、Web画面から使用設定（available）を「使用しない」に変更してください。 存在しないか既に削除された部門IDを指定した場合は 404 を返します。
パラメータ
- id* (path): integer(int64) - 部門ID。部門一覧の取得APIのレスポンスに含まれる id を指定します。
- company_id*: integer(int64) - 事業所ID。削除対象の部門が属する事業所を指定します。
レスポンス
部門の削除に成功しました。レスポンスボディはありません。
PUT /api/1/sections/code/upsert — 部門の更新（存在しない場合は作成）
概要 部門コード（code）をキーに、指定した部門の情報を更新します。該当する部門が存在しない場合は新規作成します（upsert）。外部システムとの連携で、部門マスタを一括で登録・更新する用途を想定しています。
注意点 本APIを利用するには、事業所の設定で部門コードを使用する設定にする必要があります。設定が無効な事業所への呼び出しは 400 エラーになります。 section オブジェクト内で code を指定することはできません（部門コードは変更不可）。指定した場合は 400 エラーになります。リクエストボディ直下の code のみが有効です。 更新レスポンスは 200 OK、新規作成レスポンスは 201 Created で返ります。作成・更新のどちらが行われたかは HTTP ステータスコードで判別してください。 long_name と parent_code は、省略した場合に現在の値・親子関係を維持します。null を指定すると未設定・親部門なしに更新します。 shortcut1 / shortcut2 は、省略または null を指定した場合に未設定（null）へ更新されます...
リクエストボディ*
- company_id*: integer(int64) - 事業所ID。部門を更新・作成する対象の事業所を指定します。 例:
1(最小: 1) - code*: string - 部門コード (20文字以内、半角英数字・ハイフン・アンダースコアのみ)。更新・作成対象の部門を特定するキーです。このコードを持つ部門が存在する場合は更新し、存在しない場合は新規作成します。 例:
code001(パターン: ^[0-9a-zA-Z_-]+$) - section*: object - 部門に設定する内容。code（部門コード）はこのオブジェクト内には指定できません（部門コードは変更不可のため、指定すると 400 エラーになります）。
- name*: string - 部門名 (30文字以内)。事業所内で重複できません。既に同名の部門が存在する場合は 400 エラーになります。 例:
開発部門 - long_name: string - 部門の正式名称 (255文字以内)。更新時に省略した場合は現在の値を維持し、null を指定した場合は未設定に更新します。 例:
開発本部 - shortcut1: string - ショートカット1 (20文字以内)。Web画面などで部門を検索する際のキーワードとして使用します。更新時に省略または null を指定した場合は未設定（null）に更新されます。 例:
DEVELOPER - shortcut2: string - ショートカット2 (20文字以内)。Web画面などで部門を検索する際のキーワードとして使用します。更新時に省略または null を指定した場合は未設定（null）に更新されます。 例:
123 - parent_code: string - 親部門コード。部門階層を利用できるプランでのみ反映されます。更新時に省略した場合は現在の親子関係を維持し、null を指定した場合は親部門との関係を解除します。 例:
parent001(パターン: ^[0-9a-zA-Z_-]+$)
- name*: string - 部門名 (30文字以内)。事業所内で重複できません。既に同名の部門が存在する場合は 400 エラーになります。 例:
レスポンス
PUT /api/1/sections/{id} と同じ