---
canonical_url: "https://docs.composio.dev/toolkits/freee"
markdown_url: "https://docs.composio.dev/toolkits/freee.md"
product: "platform"
version: null
last_updated: null
---

# freee

Read freee Accounting and HR data, and manage Accounting partners and HR organizational groups.

- **Category:** accounting
- **Auth:** OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 267
- **Triggers:** 0
- **Slug:** `FREEE`
- **Version:** 00000000_00

## Tools

### Act On Approval Request

**Slug:** `FREEE_ACT_ON_APPROVAL_REQUEST`

Execute Approval Request Action; this changes an existing approval state and may not be reversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `target_round` | integer | Yes | Official freee field `target_round`. |
| `next_group_id` | integer | No | Official freee field `next_group_id`. |
| `target_step_id` | integer | Yes | Official freee field `target_step_id`. |
| `approval_action` | string ("approve" | "force_approve" | "cancel" | "reject" | "feedback" | "force_feedback") | Yes | Official freee field `approval_action`. |
| `next_approver_id` | integer | No | Official freee field `next_approver_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Act On Approval Requests Monthly Attendance

**Slug:** `FREEE_ACT_ON_APPROVAL_REQUESTS_MONTHLY_ATTENDANCE`

月次勤怠締め申請の承認操作

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 月次勤怠締め申請ID |
| `company_id` | integer | Yes | 事業所ID |
| `target_round` | string | Yes | 対象round。差戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。取得APIレスポンス.current_roundを送信してください。 |
| `target_step_id` | string | Yes | 対象承認ステップID。取得APIレスポンス.current_step_idを送信してください。 |
| `approval_action` | string ("approve" | "cancel" | "feedback" | "force_feedback") | Yes | 申請操作。（approve:承認、cancel:取り消し、feedback:差戻し、force_feedback:承認取り消し） |
| `next_approver_id` | integer | No | 次のステップの承認者のユーザーID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Act On Approval Requests Overtime Work

**Slug:** `FREEE_ACT_ON_APPROVAL_REQUESTS_OVERTIME_WORK`

Action Approval Requests Overtime Work through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 残業申請ID |
| `payload` | object | Yes | JSON request body defined by the freee HR OpenAPI contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Act On Approval Requests Paid Holiday

**Slug:** `FREEE_ACT_ON_APPROVAL_REQUESTS_PAID_HOLIDAY`

Action Approval Requests Paid Holiday through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 有給休暇申請ID |
| `payload` | object | Yes | JSON request body defined by the freee HR OpenAPI contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Act On Approval Requests Special Holiday

**Slug:** `FREEE_ACT_ON_APPROVAL_REQUESTS_SPECIAL_HOLIDAY`

特別休暇申請の承認操作

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 特別休暇申請ID |
| `company_id` | integer | Yes | 事業所ID |
| `target_round` | string | Yes | 対象round。差戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。取得APIレスポンス.current_roundを送信してください。 |
| `target_step_id` | string | Yes | 対象承認ステップID。取得APIレスポンス.current_step_idを送信してください。 |
| `approval_action` | string ("approve" | "cancel" | "feedback" | "force_feedback") | Yes | 申請操作。（approve:承認、cancel:取り消し、feedback:差戻し、force_feedback:承認取り消し） |
| `next_approver_id` | integer | No | 次のステップの承認者のユーザーID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Act On Approval Requests Work Time

**Slug:** `FREEE_ACT_ON_APPROVAL_REQUESTS_WORK_TIME`

勤務時間修正申請の承認操作

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 勤務時間修正申請ID |
| `company_id` | integer | Yes | 事業所ID |
| `target_round` | string | Yes | 対象round。差戻し等により申請がstepの最初からやり直しになるとroundの値が増えます。取得APIレスポンス.current_roundを送信してください。 |
| `target_step_id` | string | Yes | 対象承認ステップID。取得APIレスポンス.current_step_idを送信してください。 |
| `approval_action` | string ("approve" | "cancel" | "feedback" | "force_feedback") | Yes | 申請操作。（approve:承認、cancel:取り消し、feedback:差戻し、force_feedback:承認取り消し） |
| `next_approver_id` | integer | No | 次のステップの承認者のユーザーID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Act On Expense Application

**Slug:** `FREEE_ACT_ON_EXPENSE_APPLICATION`

Execute Expense Application Action; this changes an existing approval state and may not be reversible.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `target_round` | integer | Yes | Official freee field `target_round`. |
| `next_group_id` | integer | No | Official freee field `next_group_id`. |
| `target_step_id` | integer | Yes | Official freee field `target_step_id`. |
| `approval_action` | string ("approve" | "force_approve" | "cancel" | "reject" | "feedback" | "force_feedback") | Yes | Official freee field `approval_action`. |
| `next_approver_id` | integer | No | Official freee field `next_approver_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Act On Payment Request

**Slug:** `FREEE_ACT_ON_PAYMENT_REQUEST`

Act On Payment Request using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |
| `target_round` | integer | Yes | Official freee Accounting target round value. |
| `next_group_id` | integer | No | Official freee Accounting next group id value. |
| `target_step_id` | integer | Yes | Official freee Accounting target step id value. |
| `approval_action` | string ("approve" | "force_approve" | "cancel" | "reject" | "feedback" | "force_feedback") | Yes | Official freee Accounting approval action value. |
| `next_approver_id` | integer | No | Official freee Accounting next approver id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Act On Purchase Request

**Slug:** `FREEE_ACT_ON_PURCHASE_REQUEST`

Act On Purchase Request using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `do_action` | string ("apply" | "approve" | "reject" | "feedback") | Yes | Official freee Accounting do action value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |
| `next_group_id` | integer | No | Official freee Accounting next group id value. |
| `next_approver_id` | integer | No | Official freee Accounting next approver id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Bulk Update Employee Dependent Rules

**Slug:** `FREEE_BULK_UPDATE_EMPLOYEE_DEPENDENT_RULES`

従業員の家族情報の更新

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | 更新対象年（必須） |
| `month` | integer | Yes | 更新対象月（必須） 締め日支払い日設定が翌月払いの従業員情報の場合は、 指定したmonth + 1の値が更新されます。 翌月払いの従業員の2022/01の従業員情報を更新する場合は、year=2021,month=12を指定してください。 |
| `company_id` | integer | Yes | 更新対象事業所ID（必須） |
| `employee_id` | integer | Yes | 従業員ID |
| `employee_dependent_rules` | array | Yes | 家族情報ルール |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Account Group

**Slug:** `FREEE_CREATE_ACCOUNT_GROUP`

Create Account Group using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Official freee field `name`. |
| `index` | integer | No | Official freee field `index`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `account_category_id` | integer | Yes | Official freee field `account_category_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Accounting Section

**Slug:** `FREEE_CREATE_ACCOUNTING_SECTION`

Create Accounting Section using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Official freee Accounting code value. |
| `name` | string | Yes | Official freee Accounting name value. |
| `long_name` | string | No | Official freee Accounting long name value. |
| `parent_id` | integer | No | Official freee Accounting parent id value. |
| `shortcut1` | string | No | Official freee Accounting shortcut1 value. |
| `shortcut2` | string | No | Official freee Accounting shortcut2 value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Account Item

**Slug:** `FREEE_CREATE_ACCOUNT_ITEM`

勘定科目の作成

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | 事業所ID |
| `account_item` | object | Yes | Provider body field `account_item`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Allowance

**Slug:** `FREEE_CREATE_ALLOWANCE`

Call the official freee HR operation to create allowance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `allowance` | object | Yes | Request body field `allowance` from the freee HR API. |
| `company_id` | integer | Yes | Query parameter `company_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Approval Request

**Slug:** `FREEE_CREATE_APPROVAL_REQUEST`

Create Approval Request using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `draft` | boolean | Yes | Official freee field `draft`. |
| `form_id` | integer | Yes | Official freee field `form_id`. |
| `parent_id` | integer | No | Official freee field `parent_id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `approver_id` | integer | No | Official freee field `approver_id`. |
| `request_items` | array | Yes | Official freee field `request_items`. |
| `application_date` | string | No | Official freee field `application_date`. |
| `applicant_group_id` | integer | No | Official freee field `applicant_group_id`. |
| `approval_flow_group_id` | integer | No | Official freee field `approval_flow_group_id`. |
| `approval_flow_route_id` | integer | Yes | Official freee field `approval_flow_route_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Approval Requests Monthly Attendance

**Slug:** `FREEE_CREATE_APPROVAL_REQUESTS_MONTHLY_ATTENDANCE`

月次勤怠締め申請の作成

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | 事業所ID（必須） |
| `approver_id` | integer | No | User ID to assign when the approval route uses resource_type selected_user; otherwise omit. |
| `target_year` | integer | Yes | 対象年（必須） |
| `target_month` | integer | Yes | 対象月（必須） |
| `approval_flow_route_id` | integer | Yes | 申請経路ID（必須） |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Approval Requests Overtime Work

**Slug:** `FREEE_CREATE_APPROVAL_REQUESTS_OVERTIME_WORK`

Create Approval Requests Overtime Work through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payload` | object | Yes | JSON request body defined by the freee HR OpenAPI contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Approval Requests Paid Holiday

**Slug:** `FREEE_CREATE_APPROVAL_REQUESTS_PAID_HOLIDAY`

Create Approval Requests Paid Holiday through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payload` | string | Yes | JSON request body defined by the freee HR OpenAPI contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Approval Requests Special Holiday

**Slug:** `FREEE_CREATE_APPROVAL_REQUESTS_SPECIAL_HOLIDAY`

特別休暇申請の作成

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_at` | string | No | 取得予定終了時間（条件付き必須） 取得単位が半休、時間休の場合は必須 |
| `comment` | string | No | 申請理由 |
| `start_at` | string | No | 取得予定開始時間（条件付き必須） 取得単位が半休、時間休の場合は必須 |
| `company_id` | integer | Yes | 事業所ID（必須） |
| `approver_id` | integer | No | User ID to assign when the approval route uses resource_type selected_user; otherwise omit. |
| `target_date` | string | Yes | 対象日（必須） |
| `holiday_type` | string ("full" | "half" | "morning" | "afternoon" | "hour") | Yes | 取得単位（必須）（full:全休、half:半休、morning:午前休、 afternoon:午後休、hour:時間休） |
| `approval_flow_route_id` | integer | Yes | 申請経路ID（必須） |
| `special_holiday_setting_id` | integer | Yes | 特別休暇設定ID（必須） |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Approval Requests Work Time

**Slug:** `FREEE_CREATE_APPROVAL_REQUESTS_WORK_TIME`

勤務時間修正申請の作成

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `comment` | string | No | 申請理由 |
| `company_id` | integer | Yes | 事業所ID（必須） |
| `approver_id` | integer | No | User ID to assign when the approval route uses resource_type selected_user; otherwise omit. |
| `target_date` | string | Yes | 対象日（必須） |
| `work_records` | array | No | 勤務時間のリスト |
| `break_records` | array | No | 休憩時間のリスト |
| `lateness_mins` | integer | No | 遅刻分の時間（分単位） |
| `clear_work_time` | boolean | No | false: 勤務時間を修正する true: 勤務時間を削除する 勤務時間を削除する場合は以下のパラメータは指定しないでください。 - work_records - lateness_mins - early_leaving_mins - break_records |
| `early_leaving_mins` | integer | No | 早退分の時間（分単位） |
| `approval_flow_route_id` | integer | Yes | 申請経路ID（必須） |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Deal

**Slug:** `FREEE_CREATE_DEAL`

取引（収入・支出）の作成

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("income" | "expense") | Yes | 収支区分 (収入: income, 支出: expense) |
| `details` | array | Yes | 取引の明細行（最大100行） |
| `due_date` | string | No | 支払期日(yyyy-mm-dd) |
| `payments` | array | No | 支払行一覧（配列）：未指定の場合、未決済の取引を作成します。 |
| `company_id` | integer | Yes | 事業所ID |
| `issue_date` | string | Yes | 発生日 (yyyy-mm-dd) |
| `partner_id` | integer | No | 取引先ID。partner_codeと同時に指定することはできません。 |
| `ref_number` | string | No | 管理番号 |
| `receipt_ids` | array | No | ファイルボックス（証憑ファイル）ID（配列） |
| `partner_code` | string | No | 取引先コード。利用するには事業所の設定で取引先コードの利用を有効にする必要があります。partner_idと同時に指定することはできません。 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Deal Payment

**Slug:** `FREEE_CREATE_DEAL_PAYMENT`

取引（収入・支出）の支払行の作成

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | 支払日 (yyyy-mm-dd) |
| `amount` | integer | Yes | 支払金額（円） |
| `deal_id` | integer | Yes | 取引ID |
| `company_id` | integer | Yes | 事業所ID |
| `from_walletable_id` | integer | Yes | 口座ID（from_walletable_typeがprivate_account_itemの場合は勘定科目ID） |
| `from_walletable_type` | string ("bank_account" | "credit_card" | "wallet" | "private_account_item") | Yes | 口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet, プライベート資金: private_account_item) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Deal Renew

**Slug:** `FREEE_CREATE_DEAL_RENEW`

Create Deal Renew using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `details` | array | Yes | Official freee field `details`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `update_date` | string | Yes | Official freee field `update_date`. |
| `renew_target_id` | integer | Yes | Official freee field `renew_target_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Deduction

**Slug:** `FREEE_CREATE_DEDUCTION`

Create Deduction through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payload` | object | Yes | JSON request body defined by the freee HR OpenAPI contract. |
| `company_id` | integer | Yes | 事業所ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Employee

**Slug:** `FREEE_CREATE_EMPLOYEE`

Create Employee through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payload` | object | Yes | JSON request body defined by the freee HR OpenAPI contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Employee Time Clock

**Slug:** `FREEE_CREATE_EMPLOYEE_TIME_CLOCK`

Call the official freee HR operation to create employee time clock.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("clock_in" | "break_begin" | "break_end" | "clock_out") | Yes | Request body field `type` from the freee HR API. |
| `datetime` | string | No | Request body field `datetime` from the freee HR API. |
| `base_date` | string | No | Request body field `base_date` from the freee HR API. |
| `company_id` | integer | Yes | Request body field `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Expense Application

**Slug:** `FREEE_CREATE_EXPENSE_APPLICATION`

Create Expense Application using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `draft` | boolean | No | Official freee field `draft`. |
| `title` | string | Yes | Official freee field `title`. |
| `tag_ids` | array | No | Official freee field `tag_ids`. |
| `parent_id` | integer | No | Official freee field `parent_id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `issue_date` | string | No | Official freee field `issue_date`. |
| `section_id` | integer | No | Official freee field `section_id`. |
| `approver_id` | integer | No | Official freee field `approver_id`. |
| `description` | string | No | Official freee field `description`. |
| `parent_type` | string | No | Official freee field `parent_type`. |
| `purchase_lines` | array | No | Official freee field `purchase_lines`. |
| `segment_1_tag_id` | integer | No | Official freee field `segment_1_tag_id`. |
| `segment_2_tag_id` | integer | No | Official freee field `segment_2_tag_id`. |
| `segment_3_tag_id` | integer | No | Official freee field `segment_3_tag_id`. |
| `applicant_group_id` | integer | No | Official freee field `applicant_group_id`. |
| `approval_flow_group_id` | integer | No | Official freee field `approval_flow_group_id`. |
| `approval_flow_route_id` | integer | No | Official freee field `approval_flow_route_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Expense Application Currency

**Slug:** `FREEE_CREATE_EXPENSE_APPLICATION_CURRENCY`

Create Expense Application Currency using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Official freee Accounting code value. |
| `name` | string | Yes | Official freee Accounting name value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |
| `description` | string | No | Official freee Accounting description value. |
| `search_status` | string ("usable" | "unusable") | Yes | Official freee Accounting search status value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Expense Application Line Template

**Slug:** `FREEE_CREATE_EXPENSE_APPLICATION_LINE_TEMPLATE`

経費科目の作成

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | 経費科目名 (1000文字以内) |
| `item_id` | integer | No | 経費科目に紐付ける品目のID。指定した事業所に存在する品目のIDのみ指定可能です（存在しない場合は400エラー）。勘定科目と品目の紐付けが設定されている事業所では、指定した勘定科目に紐付く品目のみ指定可能です。品目IDは /items のAPIから取得可能です。なお、レスポンスに品目IDは含まれません。 |
| `tax_code` | integer | Yes | 経費科目に紐付ける税区分コード（税区分のdisplay_categoryがtax_5: 5%表示の税区分, tax_r8: 軽減税率8%表示の税区分に該当するtax_codeのみ利用可能です。それ以外のtax_codeを指定した場合は400エラーになります。税区分のdisplay_categoryは /taxes/companies/{company_id}のAPIから取得可能です。） |
| `company_id` | integer | Yes | 事業所ID |
| `description` | string | No | 経費科目の説明 (1000文字以内) |
| `account_item_id` | integer | Yes | 経費科目に紐付ける勘定科目のID。指定した事業所に存在する勘定科目のIDのみ指定可能です（存在しない場合は400エラー）。勘定科目IDは /account_items のAPIから取得可能です。 |
| `line_description` | string | No | 内容の補足 (1000文字以内)。経費申請の作成時に内容欄へ何を入力すべきかを申請者に案内する文言 |
| `required_receipt` | boolean | No | 添付ファイルの必須/任意 falseを指定した時は申請時の領収書の添付を任意とします。 trueを指定した時は申請時の領収書の添付を必須とします。 未指定の時は申請時の領収書の添付を任意とします。 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create HR Group

**Slug:** `FREEE_CREATE_HR_GROUP`

Create an organizational group in a freee HR company, optionally beneath an existing parent group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Optional group code, 1-255 characters. |
| `name` | string | Yes | Group name, 1-255 characters. |
| `company_id` | integer | Yes | HR company ID in which to create the group. |
| `parent_group_id` | integer | No | Optional parent group ID; the resulting hierarchy must not exceed 10 levels. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Item

**Slug:** `FREEE_CREATE_ITEM`

Create Item using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Official freee Accounting code value. |
| `name` | string | Yes | Official freee Accounting name value. |
| `shortcut1` | string | No | Official freee Accounting shortcut1 value. |
| `shortcut2` | string | No | Official freee Accounting shortcut2 value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Journal Report

**Slug:** `FREEE_CREATE_JOURNAL_REPORT`

Create Journal Report using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `encoding` | string ("sjis" | "utf-8") | No | Official freee field `encoding`. |
| `end_date` | string | No | Official freee field `end_date`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `start_date` | string | No | Official freee field `start_date`. |
| `download_type` | string ("generic" | "generic_v2" | "csv" | "pdf") | Yes | Official freee field `download_type`. |
| `visible_ids__` | array | No | Official freee field `visible_ids[]`. |
| `visible_tags__` | array | No | Official freee field `visible_tags[]`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Manual Journal

**Slug:** `FREEE_CREATE_MANUAL_JOURNAL`

Create Manual Journal using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `details` | array | Yes | Official freee field `details`. |
| `adjustment` | boolean | No | Official freee field `adjustment`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `issue_date` | string | Yes | Official freee field `issue_date`. |
| `ref_number` | string | No | Official freee field `ref_number`. |
| `receipt_ids` | array | No | Official freee field `receipt_ids`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Accounting Partner

**Slug:** `FREEE_CREATE_PARTNER`

Create a business partner in a freee Accounting company and return its generated partner ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | Unique partner code; supply only when partner codes are enabled for the company. |
| `name` | string | Yes | Unique partner display name, up to 255 characters. |
| `email` | string | No | Partner contact email address, up to 255 characters. |
| `phone` | string | No | Partner contact phone number. |
| `long_name` | string | No | Formal legal or trade name, up to 255 characters. |
| `company_id` | integer | Yes | Company ID in which to create the partner. |
| `country_code` | string ("JP" | "ZZ") | No | Partner region: JP for Japan or ZZ for outside Japan. |
| `qualified_invoice_issuer` | boolean | No | Whether the partner is a qualified invoice issuer. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Payment Request

**Slug:** `FREEE_CREATE_PAYMENT_REQUEST`

Create Payment Request using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `draft` | boolean | Yes | Official freee Accounting draft value. |
| `title` | string | Yes | Official freee Accounting title value. |
| `bank_code` | string | No | Official freee Accounting bank code value. |
| `bank_name` | string | No | Official freee Accounting bank name value. |
| `parent_id` | integer | No | Official freee Accounting parent id value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |
| `issue_date` | string | Yes | Official freee Accounting issue date value. |
| `partner_id` | integer | No | Official freee Accounting partner id value. |
| `approver_id` | integer | No | Official freee Accounting approver id value. |
| `branch_code` | string | No | Official freee Accounting branch code value. |
| `branch_kana` | string | No | Official freee Accounting branch kana value. |
| `branch_name` | string | No | Official freee Accounting branch name value. |
| `description` | string | No | Official freee Accounting description value. |
| `receipt_ids` | array | No | Official freee Accounting receipt ids value. |
| `account_name` | string | No | Official freee Accounting account name value. |
| `account_type` | string ("ordinary" | "checking" | "earmarked" | "savings" | "other") | No | Official freee Accounting account type value. |
| `partner_code` | string | No | Official freee Accounting partner code value. |
| `payment_date` | string | No | Official freee Accounting payment date value. |
| `document_code` | string | No | Official freee Accounting document code value. |
| `account_number` | string | No | Official freee Accounting account number value. |
| `bank_name_kana` | string | No | Official freee Accounting bank name kana value. |
| `payment_method` | string ("none" | "domestic_bank_transfer" | "abroad_bank_transfer" | "account_transfer" | "credit_card") | No | Official freee Accounting payment method value. |
| `application_date` | string | No | Official freee Accounting application date value. |
| `applicant_group_id` | integer | No | Official freee Accounting applicant group id value. |
| `payment_request_lines` | array | Yes | Official freee Accounting payment request lines value. |
| `approval_flow_group_id` | integer | No | Official freee Accounting approval flow group id value. |
| `approval_flow_route_id` | integer | Yes | Official freee Accounting approval flow route id value. |
| `qualified_invoice_status` | string ("qualified" | "not_qualified" | "unspecified") | No | Official freee Accounting qualified invoice status value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Position

**Slug:** `FREEE_CREATE_POSITION`

役職の作成

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `position` | object | Yes | Value accepted by freee HR. |
| `company_id` | integer | Yes | 作成対象事業所ID（必須） |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Purchase Request

**Slug:** `FREEE_CREATE_PURCHASE_REQUEST`

Create Purchase Request using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | No | Official freee Accounting title value. |
| `status` | string ("draft" | "in_progress") | Yes | Use draft to save without submitting, or in_progress to submit for approval. |
| `parent_id` | integer | No | Official freee Accounting parent id value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |
| `description` | string | No | Official freee Accounting description value. |
| `parent_type` | string | No | Official freee Accounting parent type value. |
| `observer_user_ids` | array | No | Official freee Accounting observer user ids value. |
| `applicant_group_id` | integer | No | Official freee Accounting applicant group id value. |
| `occurrence_end_date` | string | No | Official freee Accounting occurrence end date value. |
| `occurrence_start_date` | string | No | Official freee Accounting occurrence start date value. |
| `approval_flow_group_id` | integer | No | Official freee Accounting approval flow group id value. |
| `approval_flow_route_id` | integer | No | Official freee Accounting approval flow route id value. |
| `purchase_request_lines` | array | No | Official freee Accounting purchase request lines value. |
| `purchase_request_form_id` | integer | Yes | Official freee Accounting purchase request form id value. |
| `approval_flow_approver_id` | integer | No | Official freee Accounting approval flow approver id value. |
| `purchase_request_custom_values` | array | No | Official freee Accounting purchase request custom values value. |
| `resubmission_from_purchase_request_id` | integer | No | Official freee Accounting resubmission from purchase request id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Receipt

**Slug:** `FREEE_CREATE_RECEIPT`

Create Receipt using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `receipt` | object | Yes | Official freee field `receipt`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `description` | string | No | Official freee field `description`. |
| `document_type` | string ("receipt" | "invoice" | "other") | No | Official freee field `document_type`. |
| `qualified_invoice` | string ("qualified" | "not_qualified" | "unselected") | No | Official freee field `qualified_invoice`. |
| `receipt_metadatum_amount` | integer | No | Official freee field `receipt_metadatum_amount`. |
| `receipt_metadatum_issue_date` | string | No | Official freee field `receipt_metadatum_issue_date`. |
| `receipt_metadatum_partner_name` | string | No | Official freee field `receipt_metadatum_partner_name`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Segment Tag

**Slug:** `FREEE_CREATE_SEGMENT_TAG`

セグメントタグの作成

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | セグメントタグコード (20文字以内、半角英数字・ハイフン・アンダースコアのみ)。事業所内の同じセグメント区分で重複できません。事業所の設定でセグメントタグコードを使用する設定にしている場合のみ保存され、設定が無効の場合は指定しても保存されません。省略した場合は未設定（null）になります。 |
| `name` | string | Yes | セグメントタグ名 (100文字以内)。事業所内の同じセグメント区分で重複できません。 |
| `shortcut1` | string | No | ショートカット1 (20文字以内)。Web画面などでセグメントタグを検索する際のキーワードとして使用します。省略した場合は未設定（null）になります。 |
| `shortcut2` | string | No | ショートカット2 (20文字以内)。Web画面などでセグメントタグを検索する際のキーワードとして使用します。省略した場合は未設定（null）になります。 |
| `company_id` | integer | Yes | セグメントタグを作成・更新する対象の事業所ID |
| `segment_id` | integer | Yes | セグメント区分（1、2、3のいずれか）。利用できる区分は事業所の契約プランによって異なります。 |
| `description` | string | No | 備考 (30文字以内)。省略した場合は未設定（null）になります。 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tag

**Slug:** `FREEE_CREATE_TAG`

Create Tag using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Official freee field `name`. |
| `shortcut1` | string | No | Official freee field `shortcut1`. |
| `shortcut2` | string | No | Official freee field `shortcut2`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Transfer

**Slug:** `FREEE_CREATE_TRANSFER`

Create Transfer using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | Official freee Accounting date value. |
| `amount` | integer | No | Official freee Accounting amount value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |
| `description` | string | No | Official freee Accounting description value. |
| `from_item_id` | integer | No | Official freee Accounting from item id value. |
| `from_tag_ids` | array | No | Official freee Accounting from tag ids value. |
| `to_walletables` | array | No | Official freee Accounting to walletables value. |
| `from_partner_id` | integer | No | Official freee Accounting from partner id value. |
| `from_section_id` | integer | No | Official freee Accounting from section id value. |
| `to_walletable_id` | integer | No | Official freee Accounting to walletable id value. |
| `from_walletable_id` | integer | Yes | Official freee Accounting from walletable id value. |
| `to_walletable_type` | string ("bank_account" | "credit_card" | "wallet") | No | Official freee Accounting to walletable type value. |
| `from_walletable_type` | string ("bank_account" | "credit_card" | "wallet") | Yes | Official freee Accounting from walletable type value. |
| `from_segment_1_tag_id` | integer | No | Official freee Accounting from segment 1 tag id value. |
| `from_segment_2_tag_id` | integer | No | Official freee Accounting from segment 2 tag id value. |
| `from_segment_3_tag_id` | integer | No | Official freee Accounting from segment 3 tag id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create User Matcher

**Slug:** `FREEE_CREATE_USER_MATCHER`

自動登録ルールの作成

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `act` | integer ("0" | "1" | "2" | "3" | "4" | "10" | "11" | "12") | Yes | 登録タイプ * 0: 取引を推測する(manual_standard) * 1: 取引を登録する(auto_standard) * 2: 振替を推測する(manual_transfer) * 3: 振替を登録する(auto_transfer) * 4: 無視する取引を登録する(auto_ignore) * 10: 無視する取引を推測する(manual_ignore) * 11: プライベート取引を推測する(manual_private) * 12: プライベート取引を登録する(auto_private) このAPIでは以下のactは非対応です: 5(manual_template), 6(manual_scrub), 7(auto_scrub), 8(manual_output_zengin_scrub), 9(auto_output_zengin_scrub) |
| `active` | boolean | Yes | 有効/無効 * true: 有効 * false: 無効 |
| `priority` | integer | Yes | 優先度 |
| `tax_name` | string | No | 税区分名 act=0,1(取引を推測/登録)の場合は必須。他のactでは指定しても無視されます。 |
| `condition` | integer ("0" | "1" | "2" | "3" | "4") | Yes | マッチ条件 * 0: 部分一致(partial) * 1: 前方一致(forward) * 2: 後方一致(backward) * 3: 完全一致(exact) * 4: 指定なし(wildcard) |
| `item_name` | string | No | 品目名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。 |
| `card_label` | string | No | カードラベル |
| `company_id` | integer | Yes | 事業所ID |
| `max_amount` | integer | No | 最大金額 (単位: 円) |
| `min_amount` | integer | No | 最小金額 (単位: 円) |
| `walletable` | string | No | 口座名。事業所に登録されている口座の名前を指定します。 |
| `description` | string | Yes | 説明文。明細の取引内容とマッチングする文字列を指定します。condition=4(指定なし)の場合は無視されます。 |
| `partner_name` | string | No | 取引先名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。 |
| `section_name` | string | No | 部門名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。 |
| `card_label_id` | integer | No | カードラベルID |
| `entry_side_str` | string ("income" | "expense") | Yes | 入金/出金 * income: 入金 * expense: 出金 |
| `deal_description` | string | No | 取引の備考 act=4,10,11,12(無視/プライベート)では指定しても無視されます。 |
| `account_item_name` | string | No | 勘定科目名 act=0,1(取引を推測/登録)の場合は必須。他のactでは指定しても無視されます。 |
| `default_tag_names` | array | No | メモタグ名の配列 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。 |
| `division_tag_1_name` | string | No | セグメント1タグ名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。 |
| `division_tag_2_name` | string | No | セグメント2タグ名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。 |
| `division_tag_3_name` | string | No | セグメント3タグ名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。 |
| `transfer_walletable` | string | No | 振替先口座名 act=2,3(振替を推測/登録)の場合に使用。他のactでは指定しても無視されます。 |
| `qualified_invoice_setting` | string ("non_qualified" | "qualified" | "depends_on_partner") | No | 適格請求書等 * non_qualified: 該当しない * qualified: 該当する * depends_on_partner: 取引先情報に準拠 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 depends_on_partnerを指定する場合は、partner_nameの指定が必要です。 |
| `suggest_tax_from_walletable_invoice` | boolean | No | 購入データ原本に準拠 * true: 準拠する * false: 準拠しない act=0,1(取引を推測/登録)かつ購入データ原本に対応した口座を指定した場合のみ使用可能。それ以外では指定しても無視されます。 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Walletable

**Slug:** `FREEE_CREATE_WALLETABLE`

Create Walletable using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Official freee field `name`. |
| `type` | string ("bank_account" | "credit_card" | "wallet") | Yes | Official freee field `type`. |
| `bank_id` | integer | No | Official freee field `bank_id`. |
| `is_asset` | boolean | No | Official freee field `is_asset`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Wallet Transaction

**Slug:** `FREEE_CREATE_WALLET_TRANSACTION`

Create Wallet Transaction using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | Official freee Accounting date value. |
| `amount` | integer | Yes | Official freee Accounting amount value. |
| `balance` | integer | No | Official freee Accounting balance value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |
| `entry_side` | string ("income" | "expense") | Yes | Official freee Accounting entry side value. |
| `description` | string | No | Official freee Accounting description value. |
| `walletable_id` | integer | Yes | Official freee Accounting walletable id value. |
| `walletable_type` | string ("bank_account" | "credit_card" | "wallet") | Yes | Official freee Accounting walletable type value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Accounting Section

**Slug:** `FREEE_DELETE_ACCOUNTING_SECTION`

Delete Accounting Section using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Account Item

**Slug:** `FREEE_DELETE_ACCOUNT_ITEM`

勘定科目の削除

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | 事業所ID |
| `account_item_id` | integer | Yes | 勘定科目ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Approval Request

**Slug:** `FREEE_DELETE_APPROVAL_REQUEST`

Permanently delete the target with Delete Approval Request; this operation is destructive and cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Deal

**Slug:** `FREEE_DELETE_DEAL`

取引（収入・支出）の削除

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deal_id` | integer | Yes | 取引ID |
| `company_id` | integer | Yes | 事業所ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Deal Payment

**Slug:** `FREEE_DELETE_DEAL_PAYMENT`

取引（収入・支出）の支払行の削除

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deal_id` | integer | Yes | 取引ID |
| `company_id` | integer | Yes | 事業所ID |
| `payment_id` | integer | Yes | 支払行ID（取引のレスポンスのpayments配列のid） |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Deal Renew

**Slug:** `FREEE_DELETE_DEAL_RENEW`

Permanently delete the target with Delete Deal Renew; this operation is destructive and cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `renew_id` | integer | Yes | Official freee field `renew_id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Expense Application

**Slug:** `FREEE_DELETE_EXPENSE_APPLICATION`

Permanently delete the target with Delete Expense Application; this operation is destructive and cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Expense Application Currency

**Slug:** `FREEE_DELETE_EXPENSE_APPLICATION_CURRENCY`

Delete Expense Application Currency using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Expense Application Line Template

**Slug:** `FREEE_DELETE_EXPENSE_APPLICATION_LINE_TEMPLATE`

経費科目の削除

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | 事業所ID |
| `expense_application_line_template_id` | integer | Yes | 経費科目ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete HR Group

**Slug:** `FREEE_DELETE_HR_GROUP`

Permanently delete one organizational group from a freee HR company. The deleted group cannot be restored; use this only for a group intended for removal, such as a test fixture.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | integer | Yes | Group ID to permanently delete. |
| `company_id` | integer | Yes | HR company ID that owns the group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Item

**Slug:** `FREEE_DELETE_ITEM`

Delete Item using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Manual Journal

**Slug:** `FREEE_DELETE_MANUAL_JOURNAL`

Permanently delete the target with Delete Manual Journal; this operation is destructive and cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Accounting Partner

**Slug:** `FREEE_DELETE_PARTNER`

Permanently delete one business partner from a freee Accounting company. This operation is irreversible: deleted partners cannot be restored. Before deleting an active partner, first call UPDATE_PARTNER with its current required name and available=false. Partners referenced by transactions cannot be deleted, and archived partners must be unarchived in freee before deletion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | Company ID that owns the partner. |
| `partner_id` | integer | Yes | Partner ID to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Payment Request

**Slug:** `FREEE_DELETE_PAYMENT_REQUEST`

Delete Payment Request using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Purchase Request

**Slug:** `FREEE_DELETE_PURCHASE_REQUEST`

Delete Purchase Request using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Receipt

**Slug:** `FREEE_DELETE_RECEIPT`

Permanently delete the target with Delete Receipt; this operation is destructive and cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Segment Tag

**Slug:** `FREEE_DELETE_SEGMENT_TAG`

セグメントタグの削除

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | 削除対象のセグメントタグが属する事業所ID |
| `segment_id` | integer | Yes | セグメント区分（1、2、3のいずれか）。利用できる区分は事業所の契約プランによって異なります。 |
| `segment_tag_id` | integer | Yes | 削除対象のセグメントタグID。一覧取得APIのレスポンスに含まれる id を指定します。 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Tag

**Slug:** `FREEE_DELETE_TAG`

Permanently delete the target with Delete Tag; this operation is destructive and cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Transfer

**Slug:** `FREEE_DELETE_TRANSFER`

Delete Transfer using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete User Matcher

**Slug:** `FREEE_DELETE_USER_MATCHER`

自動登録ルールの削除

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | 事業所ID |
| `user_matcher_id` | integer | Yes | 自動登録ルールID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Walletable

**Slug:** `FREEE_DELETE_WALLETABLE`

Permanently delete the target with Delete Walletable; this operation is destructive and cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `type` | string ("bank_account" | "credit_card" | "wallet") | Yes | Official freee field `type`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Wallet Transaction

**Slug:** `FREEE_DELETE_WALLET_TRANSACTION`

Delete Wallet Transaction using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Destroy Approval Requests Monthly Attendance

**Slug:** `FREEE_DESTROY_APPROVAL_REQUESTS_MONTHLY_ATTENDANCE`

月次勤怠締め申請の削除

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 月次勤怠締め申請ID |
| `company_id` | integer | Yes | 事業所ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Destroy Approval Requests Overtime Work

**Slug:** `FREEE_DESTROY_APPROVAL_REQUESTS_OVERTIME_WORK`

Destroy Approval Requests Overtime Work through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 残業申請ID |
| `company_id` | integer | Yes | 事業所ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Destroy Approval Requests Paid Holiday

**Slug:** `FREEE_DESTROY_APPROVAL_REQUESTS_PAID_HOLIDAY`

Destroy Approval Requests Paid Holiday through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 有給休暇申請ID |
| `company_id` | integer | Yes | 事業所ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Destroy Approval Requests Special Holiday

**Slug:** `FREEE_DESTROY_APPROVAL_REQUESTS_SPECIAL_HOLIDAY`

特別休暇申請の削除

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 特別休暇申請ID |
| `company_id` | integer | Yes | 事業所ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Destroy Approval Requests Work Time

**Slug:** `FREEE_DESTROY_APPROVAL_REQUESTS_WORK_TIME`

勤務時間修正申請の削除

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 勤務時間修正申請ID |
| `company_id` | integer | Yes | 事業所ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Destroy Employee

**Slug:** `FREEE_DESTROY_EMPLOYEE`

Destroy Employee through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 従業員ID |
| `company_id` | integer | Yes | 事業所ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Destroy Employee Allowance Rule

**Slug:** `FREEE_DESTROY_EMPLOYEE_ALLOWANCE_RULE`

Call the official freee HR operation to destroy employee allowance rule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Path parameter `id` from the freee HR API. |
| `year` | integer | Yes | Query parameter `year` from the freee HR API. |
| `month` | integer | Yes | Query parameter `month` from the freee HR API. |
| `company_id` | integer | Yes | Query parameter `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Destroy Employee Deduction Rule

**Slug:** `FREEE_DESTROY_EMPLOYEE_DEDUCTION_RULE`

Destroy Employee Deduction Rule through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 従業員控除ID |
| `year` | integer | Yes | 削除対象の控除ルールを判定する締め年 |
| `month` | integer | Yes | Payroll closing calendar month (1-12) of the deduction rule to delete. For January 2022 pay on a following-month schedule, the closing month is December 2021. |
| `company_id` | integer | Yes | 事業所ID |
| `employee_id` | integer | Yes | 従業員ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Destroy Employee Work Record

**Slug:** `FREEE_DESTROY_EMPLOYEE_WORK_RECORD`

Call the official freee HR operation to destroy employee work record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | Path parameter `date` from the freee HR API. |
| `company_id` | integer | Yes | Query parameter `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Destroy Position

**Slug:** `FREEE_DESTROY_POSITION`

役職の削除

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 役職ID |
| `company_id` | integer | Yes | 事業所ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Destroy Yearend Adjustment Housing Loan

**Slug:** `FREEE_DESTROY_YEAREND_ADJUSTMENT_HOUSING_LOAN`

Call the official freee HR operation to destroy yearend adjustment housing loan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Path parameter `id` from the freee HR API. |
| `year` | integer | Yes | Path parameter `year` from the freee HR API. |
| `company_id` | integer | Yes | Query parameter `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Destroy Yearend Adjustment Insurances

**Slug:** `FREEE_DESTROY_YEAREND_ADJUSTMENT_INSURANCES`

Call the official freee HR operation to destroy yearend adjustment insurances.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Path parameter `id` from the freee HR API. |
| `year` | integer | Yes | Path parameter `year` from the freee HR API. |
| `company_id` | integer | Yes | Query parameter `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Destroy Yearend Adjustment Previous Job

**Slug:** `FREEE_DESTROY_YEAREND_ADJUSTMENT_PREVIOUS_JOB`

Call the official freee HR operation to destroy yearend adjustment previous job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Path parameter `year` from the freee HR API. |
| `company_id` | integer | Yes | Query parameter `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Journal

**Slug:** `FREEE_DOWNLOAD_JOURNAL`

Download Journal using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Receipt

**Slug:** `FREEE_DOWNLOAD_RECEIPT`

Download Receipt using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Accounting Capabilities

**Slug:** `FREEE_GET_ACCOUNTING_CAPABILITIES`

Return the connected user's Accounting permissions for a company; capability flags do not guarantee paid-plan entitlement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | Company ID whose resource-level read, create, update, and delete capabilities to inspect. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Accounting Section

**Slug:** `FREEE_GET_ACCOUNTING_SECTION`

Get Accounting Section using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Item

**Slug:** `FREEE_GET_ACCOUNT_ITEM`

勘定科目の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | 事業所ID |
| `account_item_id` | integer | Yes | 勘定科目ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Allowance

**Slug:** `FREEE_GET_ALLOWANCE`

Call the official freee HR operation to get allowance.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Path parameter `id` from the freee HR API. |
| `company_id` | integer | Yes | Query parameter `company_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Approval Flow Route

**Slug:** `FREEE_GET_APPROVAL_FLOW_ROUTE`

申請経路の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | 事業所ID |
| `approval_flow_route_id` | integer | Yes | 申請経路ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Approval Request

**Slug:** `FREEE_GET_APPROVAL_REQUEST`

Get Approval Request using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Approval Request Form

**Slug:** `FREEE_GET_APPROVAL_REQUEST_FORM`

Get Approval Request Form using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Approval Requests Monthly Attendance

**Slug:** `FREEE_GET_APPROVAL_REQUESTS_MONTHLY_ATTENDANCE`

月次勤怠締め申請の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 月次勤怠締め申請ID |
| `company_id` | integer | Yes | 事業所ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Approval Requests Monthly Attendances

**Slug:** `FREEE_GET_APPROVAL_REQUESTS_MONTHLY_ATTENDANCES`

月次勤怠締め申請一覧の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 100) |
| `offset` | integer | No | 取得レコードのオフセット (デフォルト: 0) |
| `status` | string ("draft" | "in_progress" | "approved" | "feedback") | No | 申請ステータス - `draft` - 下書き - `in_progress` - 申請中 - `approved` - 承認済 - `feedback` - 差戻し |
| `company_id` | integer | Yes | 事業所ID |
| `approver_id` | integer | No | 現在承認ステップの承認者のユーザーID approver_idに値を指定する場合、指定なしの申請経路を利用した申請は返却されません |
| `next_cursor` | string | No | Continuation cursor returned by the previous page; omit for the first page. |
| `applicant_id` | integer | No | 申請者のユーザーID |
| `end_issue_date` | string | No | 申請終了日 |
| `end_target_date` | string | No | 対象終了日 |
| `start_issue_date` | string | No | 申請開始日 |
| `passed_auto_check` | boolean | No | 自動チェック結果 - trueを指定した場合、自動チェック結果がtrueの申請のみ返却します。 - falseを指定した場合、自動チェック結果がfalseの申請のみ返却します。 - キーごと指定しない場合、すべての申請を返却します。 |
| `start_target_date` | string | No | 対象開始日 |
| `application_number` | integer | No | 申請No |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Approval Requests Overtime Work

**Slug:** `FREEE_GET_APPROVAL_REQUESTS_OVERTIME_WORK`

Get Approval Requests Overtime Work through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 残業申請ID |
| `company_id` | integer | Yes | 事業所ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Approval Requests Overtime Works

**Slug:** `FREEE_GET_APPROVAL_REQUESTS_OVERTIME_WORKS`

Get Approval Requests Overtime Works through the freee HR API. Return one provider page using offset and limit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 100) |
| `offset` | integer | No | 取得レコードのオフセット (デフォルト: 0) |
| `status` | string ("draft" | "in_progress" | "approved" | "feedback") | No | 申請ステータス - `draft` - 下書き - `in_progress` - 申請中 - `approved` - 承認済 - `feedback` - 差戻し |
| `company_id` | integer | Yes | 事業所ID |
| `approver_id` | integer | No | 現在承認ステップの承認者のユーザーID  approver_idに値を指定する場合、指定なしの申請経路を利用した申請は返却されません |
| `next_cursor` | string | No | Continuation cursor returned by the previous page; omit for the first page. |
| `applicant_id` | integer | No | 申請者のユーザーID |
| `end_issue_date` | string | No | 申請終了日 |
| `end_target_date` | string | No | 対象終了日 |
| `start_issue_date` | string | No | 申請開始日 |
| `passed_auto_check` | boolean | No | 自動チェック結果 - trueを指定した場合、自動チェック結果がtrueの申請のみ返却します。 - falseを指定した場合、自動チェック結果がfalseの申請のみ返却します。 - キーごと指定しない場合、すべての申請を返却します。 |
| `start_target_date` | string | No | 対象開始日 |
| `application_number` | integer | No | 申請No |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Approval Requests Overtime Work Setting

**Slug:** `FREEE_GET_APPROVAL_REQUESTS_OVERTIME_WORK_SETTING`

Get Approval Requests Overtime Work Setting through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | 対象日(YYYY-MM-DD)(例:2018-08-01) - 申請の対象日を指定してください。 |
| `company_id` | integer | Yes | 事業所ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Approval Requests Paid Holiday

**Slug:** `FREEE_GET_APPROVAL_REQUESTS_PAID_HOLIDAY`

Get Approval Requests Paid Holiday through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 有給休暇申請ID |
| `company_id` | integer | Yes | 事業所ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Approval Requests Paid Holidays

**Slug:** `FREEE_GET_APPROVAL_REQUESTS_PAID_HOLIDAYS`

Get Approval Requests Paid Holidays through the freee HR API. Return one provider page using offset and limit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 100) |
| `offset` | integer | No | 取得レコードのオフセット (デフォルト: 0) |
| `status` | string ("draft" | "in_progress" | "approved" | "feedback") | No | 申請ステータス - `draft` - 下書き - `in_progress` - 申請中 - `approved` - 承認済 - `feedback` - 差戻し |
| `company_id` | integer | Yes | 事業所ID |
| `approver_id` | integer | No | 現在承認ステップの承認者のユーザーID  approver_idに値を指定する場合、指定なしの申請経路を利用した申請は返却されません |
| `next_cursor` | string | No | Continuation cursor returned by the previous page; omit for the first page. |
| `applicant_id` | integer | No | 申請者のユーザーID |
| `end_issue_date` | string | No | 申請終了日 |
| `end_target_date` | string | No | 対象終了日 |
| `start_issue_date` | string | No | 申請開始日 |
| `passed_auto_check` | boolean | No | 自動チェック結果 - trueを指定した場合、自動チェック結果がtrueの申請のみ返却します。 - falseを指定した場合、自動チェック結果がfalseの申請のみ返却します。 - キーごと指定しない場合、すべての申請を返却します。 |
| `start_target_date` | string | No | 対象開始日 |
| `application_number` | integer | No | 申請No |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Approval Requests Special Holiday

**Slug:** `FREEE_GET_APPROVAL_REQUESTS_SPECIAL_HOLIDAY`

特別休暇申請の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 特別休暇申請ID |
| `company_id` | integer | Yes | 事業所ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Approval Requests Special Holidays

**Slug:** `FREEE_GET_APPROVAL_REQUESTS_SPECIAL_HOLIDAYS`

特別休暇申請一覧の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 100) |
| `offset` | integer | No | 取得レコードのオフセット (デフォルト: 0) |
| `status` | string ("draft" | "in_progress" | "approved" | "feedback") | No | 申請ステータス - `draft` - 下書き - `in_progress` - 申請中 - `approved` - 承認済 - `feedback` - 差戻し |
| `company_id` | integer | Yes | 事業所ID |
| `approver_id` | integer | No | 現在承認ステップの承認者のユーザーID approver_idに値を指定する場合、指定なしの申請経路を利用した申請は返却されません |
| `next_cursor` | string | No | Continuation cursor returned by the previous page; omit for the first page. |
| `applicant_id` | integer | No | 申請者のユーザーID |
| `end_issue_date` | string | No | 申請終了日 |
| `end_target_date` | string | No | 対象終了日 |
| `start_issue_date` | string | No | 申請開始日 |
| `passed_auto_check` | boolean | No | 自動チェック結果 - trueを指定した場合、自動チェック結果がtrueの申請のみ返却します。 - falseを指定した場合、自動チェック結果がfalseの申請のみ返却します。 - キーごと指定しない場合、すべての申請を返却します。 |
| `start_target_date` | string | No | 対象開始日 |
| `application_number` | integer | No | 申請No |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Approval Requests Work Time

**Slug:** `FREEE_GET_APPROVAL_REQUESTS_WORK_TIME`

勤務時間修正申請の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 勤務時間修正申請ID |
| `company_id` | integer | Yes | 事業所ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Approval Requests Work Times

**Slug:** `FREEE_GET_APPROVAL_REQUESTS_WORK_TIMES`

勤務時間修正申請一覧の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 100) |
| `offset` | integer | No | 取得レコードのオフセット (デフォルト: 0) |
| `status` | string ("draft" | "in_progress" | "approved" | "feedback") | No | 申請ステータス - `draft` - 下書き - `in_progress` - 申請中 - `approved` - 承認済 - `feedback` - 差戻し |
| `company_id` | integer | Yes | 事業所ID |
| `approver_id` | integer | No | 現在承認ステップの承認者のユーザーID approver_idに値を指定する場合、指定なしの申請経路を利用した申請は返却されません |
| `next_cursor` | string | No | Continuation cursor returned by the previous page; omit for the first page. |
| `applicant_id` | integer | No | 申請者のユーザーID |
| `end_issue_date` | string | No | 申請終了日 |
| `end_target_date` | string | No | 対象終了日 |
| `start_issue_date` | string | No | 申請開始日 |
| `passed_auto_check` | boolean | No | 自動チェック結果 - trueを指定した場合、自動チェック結果がtrueの申請のみ返却します。 - falseを指定した場合、自動チェック結果がfalseの申請のみ返却します。 - キーごと指定しない場合、すべての申請を返却します。 |
| `start_target_date` | string | No | 対象開始日 |
| `application_number` | integer | No | 申請No |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Balance Sheet

**Slug:** `FREEE_GET_BALANCE_SHEET`

Return a freee Accounting balance sheet for a fiscal year or date range, with optional account, partner, item, section, or segment breakdowns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | No | Filter by item ID. Use 0 to include only transactions with no item selected. |
| `end_date` | string | No | Inclusive end date in YYYY-MM-DD. Must be supplied with start_date and cannot be combined with fiscal_year. |
| `breakdown` | string ("partner" | "item" | "section" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag") | No | Optional balance dimension. partner, item, section, and segment tag breakdowns require account_item display and produce nested arrays. account_item requires group display and expands account rows in balances. A dimension with at least 5,000 registered values is rejected by freee. |
| `end_month` | integer | No | Ending accounting month (1-12) for transaction-month filtering. The range follows fiscal-year order and may wrap across the calendar year; for example, a fiscal year beginning in October can use start_month 11 and end_month 9. Omit to use the last month of the current fiscal year. |
| `adjustment` | string ("only" | "without") | No | Use only to aggregate adjustment entries, or without to exclude them. Omit to include adjustment entries normally. |
| `company_id` | integer | Yes | Company ID whose balance sheet to retrieve. |
| `partner_id` | integer | No | Filter by partner ID. Use 0 to include only transactions with no partner selected. |
| `section_id` | integer | No | Filter by section ID. Use 0 to include only transactions with no section selected. |
| `start_date` | string | No | Inclusive start date in YYYY-MM-DD. Must be supplied with end_date and cannot be combined with fiscal_year. |
| `fiscal_year` | integer | No | Fiscal year identified by the year containing the fiscal period's start date. Omit to use freee's current fiscal year. |
| `start_month` | integer | No | Starting accounting month (1-12) for transaction-month filtering. Omit to use the first month of the current fiscal year. |
| `partner_code` | string | No | Filter by partner code. Available only when partner-code use is enabled in the company's settings. |
| `account_item_display` | string ("account_item" | "group") | No | Display balances by individual account item or by financial-statement group. The group mode can only use the account_item breakdown. |
| `approval_flow_status` | string ("without_in_progress" | "all") | No | Filter by journal-entry approval status: without_in_progress excludes unapproved entries (the provider default), while all includes every status. Available only on supported plans when journal approval flow is enabled for the company. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bank

**Slug:** `FREEE_GET_BANK`

Get Bank using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bonuses Employee Payroll Statement

**Slug:** `FREEE_GET_BONUSES_EMPLOYEE_PAYROLL_STATEMENT`

Call the official freee HR operation to get bonuses employee payroll statement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Query parameter `year` from the freee HR API. |
| `month` | integer | Yes | Query parameter `month` from the freee HR API. |
| `company_id` | integer | Yes | Query parameter `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bonuses Employee Payroll Statements

**Slug:** `FREEE_GET_BONUSES_EMPLOYEE_PAYROLL_STATEMENTS`

Call the official freee HR operation to get bonuses employee payroll statements.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Query parameter `year` from the freee HR API. |
| `limit` | integer | No | Query parameter `limit` from the freee HR API. |
| `month` | integer | Yes | Query parameter `month` from the freee HR API. |
| `offset` | integer | No | Query parameter `offset` from the freee HR API. |
| `company_id` | integer | Yes | Query parameter `company_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Company

**Slug:** `FREEE_GET_COMPANY`

Return one freee Accounting company's settings and fiscal years, and optionally include selected accounting reference lists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | Company ID to retrieve; the OAuth token must be authorized for this selected company. |
| `include_reference_data` | boolean | No | Whether to include account items, tax codes, items, partners, sections, tags, and walletables in the response. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current Accounting User

**Slug:** `FREEE_GET_CURRENT_ACCOUNTING_USER`

Return the connected freee Accounting user and company memberships; listed companies may still be outside the token's selected-company authorization boundary.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current HR User

**Slug:** `FREEE_GET_CURRENT_HR_USER`

Return the connected freee HR user, company memberships, HR roles, and linked employee IDs when available.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Accounting Deal

**Slug:** `FREEE_GET_DEAL`

Return one income or expense deal with journal details, payments, adjustments, attached receipt metadata, and optional receivable or payable accrual rows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deal_id` | integer | Yes | Deal ID to retrieve. |
| `company_id` | integer | Yes | Company ID that owns the deal. |
| `include_accruals` | boolean | No | Whether to include receivable and payable accrual rows when present. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Deduction

**Slug:** `FREEE_GET_DEDUCTION`

Get Deduction through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | その他控除ID |
| `company_id` | integer | Yes | 事業所ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee

**Slug:** `FREEE_GET_EMPLOYEE`

Get Employee through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 従業員ID |
| `year` | integer | Yes | 従業員情報を取得したい年 |
| `month` | integer | Yes | Payroll closing calendar month (1-12) of the employee information. For January 2022 pay on a following-month schedule, the closing month is December 2021. |
| `company_id` | integer | Yes | 事業所ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee Allowance Rules

**Slug:** `FREEE_GET_EMPLOYEE_ALLOWANCE_RULES`

Call the official freee HR operation to get employee allowance rules.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Query parameter `year` from the freee HR API. |
| `month` | integer | Yes | Query parameter `month` from the freee HR API. |
| `company_id` | integer | Yes | Query parameter `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee Bank Account Rule

**Slug:** `FREEE_GET_EMPLOYEE_BANK_ACCOUNT_RULE`

Call the official freee HR operation to get employee bank account rule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Query parameter `year` from the freee HR API. |
| `month` | integer | Yes | Query parameter `month` from the freee HR API. |
| `company_id` | integer | Yes | Query parameter `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee Basic Pay Rule

**Slug:** `FREEE_GET_EMPLOYEE_BASIC_PAY_RULE`

Call the official freee HR operation to get employee basic pay rule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Query parameter `year` from the freee HR API. |
| `month` | integer | Yes | Query parameter `month` from the freee HR API. |
| `company_id` | integer | Yes | Query parameter `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee Deduction Rules

**Slug:** `FREEE_GET_EMPLOYEE_DEDUCTION_RULES`

Get Employee Deduction Rules through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | 従業員情報を取得したい年 |
| `month` | integer | Yes | Payroll closing calendar month (1-12) of the employee deduction rules. For January 2022 pay on a following-month schedule, the closing month is December 2021. |
| `company_id` | integer | Yes | 事業所ID |
| `employee_id` | integer | Yes | 従業員ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee Dependent Rules

**Slug:** `FREEE_GET_EMPLOYEE_DEPENDENT_RULES`

従業員の家族情報の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | 従業員情報を取得したい年 |
| `month` | integer | Yes | 従業員情報を取得したい月 締め日支払い日設定が翌月払いの従業員情報の場合は、 指定したmonth + 1の値が検索結果として返します。 翌月払いの従業員の2022/01の従業員情報を取得する場合は、year=2021,month=12を指定してください。 |
| `company_id` | integer | Yes | 事業所ID |
| `employee_id` | integer | Yes | 従業員ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee Group Memberships

**Slug:** `FREEE_GET_EMPLOYEE_GROUP_MEMBERSHIPS`

Get Employee Group Memberships through the freee HR API. Return one provider page using offset and limit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 100) |
| `offset` | integer | No | 取得レコードのオフセット (デフォルト: 0) |
| `base_date` | string | Yes | 指定日。指定日付時点における所属情報をリストで返します。(YYYY-MM-DD)(例:2018-07-31) |
| `company_id` | integer | Yes | 事業所ID |
| `next_cursor` | string | No | Continuation cursor returned by the previous page; omit for the first page. |
| `employee_ids` | string | No | 取得対象とする従業員IDを指定することができます。指定しない場合は全従業員が対象となります。 (例:1,2,3,4,5) |
| `with_no_payroll_calculation` | boolean | No | trueを指定すると給与計算対象外の従業員情報をレスポンスに含めます。 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee Group Memberships By Employee Id

**Slug:** `FREEE_GET_EMPLOYEE_GROUP_MEMBERSHIPS_BY_EMPLOYEE_ID`

Get Employee Group Memberships By Employee Id through the freee HR API. Return one provider page using offset and limit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 100) |
| `offset` | integer | No | 取得レコードのオフセット (デフォルト: 0) |
| `base_date` | string | No | 指定日。指定日付時点における所属情報を返します。(YYYY-MM-DD)(例:2018-07-31) 省略した場合は全期間の所属履歴を返します。 |
| `company_id` | integer | Yes | 事業所ID |
| `employee_id` | integer | Yes | 従業員ID |
| `next_cursor` | string | No | Continuation cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee Health Insurance Rule

**Slug:** `FREEE_GET_EMPLOYEE_HEALTH_INSURANCE_RULE`

Get Employee Health Insurance Rule through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | 従業員情報を取得したい年 |
| `month` | integer | Yes | Payroll closing calendar month (1-12) of the employee health insurance rule. For January 2022 pay on a following-month schedule, the closing month is December 2021. |
| `company_id` | integer | Yes | 事業所ID |
| `employee_id` | integer | Yes | 従業員ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee Profile Custom Fields Rule

**Slug:** `FREEE_GET_EMPLOYEE_PROFILE_CUSTOM_FIELDS_RULE`

Get Employee Profile Custom Fields Rule through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | 従業員情報を取得したい年 |
| `month` | integer | Yes | Payroll closing calendar month (1-12) of the employee custom-field values. For January 2022 pay on a following-month schedule, the closing month is December 2021. |
| `company_id` | integer | Yes | 事業所ID |
| `employee_id` | integer | Yes | 従業員ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee Profile Rule

**Slug:** `FREEE_GET_EMPLOYEE_PROFILE_RULE`

Get Employee Profile Rule through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | 従業員情報を取得したい年 |
| `month` | integer | Yes | Payroll closing calendar month (1-12) of the employee profile. For January 2022 pay on a following-month schedule, the closing month is December 2021. |
| `company_id` | integer | Yes | 事業所ID |
| `employee_id` | integer | Yes | 従業員ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employees

**Slug:** `FREEE_GET_EMPLOYEES`

Get Employees through the freee HR API. Return one provider page using offset and limit.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | 従業員情報を取得したい年 |
| `limit` | integer | No | 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 100) |
| `month` | integer | Yes | Payroll closing calendar month (1-12) of the employee information. For January 2022 pay on a following-month schedule, the closing month is December 2021. |
| `offset` | integer | No | 取得レコードのオフセット (デフォルト: 0) |
| `company_id` | integer | Yes | 事業所ID |
| `next_cursor` | string | No | Continuation cursor returned by the previous page; omit for the first page. |
| `with_no_payroll_calculation` | boolean | No | trueを指定すると給与計算対象外の従業員情報をレスポンスに含めます。 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employees Attendance Tags

**Slug:** `FREEE_GET_EMPLOYEES_ATTENDANCE_TAGS`

Get Employees Attendance Tags through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | 事業所ID |
| `employee_id` | integer | Yes | 従業員ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employees Attendance Tags By Date

**Slug:** `FREEE_GET_EMPLOYEES_ATTENDANCE_TAGS_BY_DATE`

Get Employees Attendance Tags By Date through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | 対象年月日(YYYY-MM-DD)(例:2018-08-01) |
| `company_id` | integer | Yes | 事業所ID |
| `employee_id` | integer | Yes | 従業員ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employees Attendance Tag Summaries

**Slug:** `FREEE_GET_EMPLOYEES_ATTENDANCE_TAG_SUMMARIES`

勤怠タグ月次サマリの取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | 勤怠タグサマリを取得したい年 |
| `month` | integer | Yes | 勤怠タグサマリを取得したい月 |
| `company_id` | integer | Yes | 事業所ID |
| `employee_id` | integer | Yes | 従業員ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employees Special Holidays

**Slug:** `FREEE_GET_EMPLOYEES_SPECIAL_HOLIDAYS`

従業員の特別休暇一覧の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | 対象日 |
| `end_date` | string | No | 対象終了日 |
| `company_id` | integer | Yes | 事業所ID |
| `start_date` | string | No | 対象開始日 |
| `employee_id` | integer | Yes | 従業員ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee Time Clock

**Slug:** `FREEE_GET_EMPLOYEE_TIME_CLOCK`

Call the official freee HR operation to get employee time clock.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Path parameter `id` from the freee HR API. |
| `company_id` | integer | Yes | Query parameter `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee Time Clocks

**Slug:** `FREEE_GET_EMPLOYEE_TIME_CLOCKS`

Call the official freee HR operation to get employee time clocks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Query parameter `limit` from the freee HR API. |
| `offset` | integer | No | Query parameter `offset` from the freee HR API. |
| `to_date` | string | No | Query parameter `to_date` from the freee HR API. |
| `from_date` | string | No | Query parameter `from_date` from the freee HR API. |
| `company_id` | integer | Yes | Query parameter `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee Time Clocks Available Types

**Slug:** `FREEE_GET_EMPLOYEE_TIME_CLOCKS_AVAILABLE_TYPES`

Call the official freee HR operation to get employee time clocks available types.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | No | Query parameter `date` from the freee HR API. |
| `company_id` | integer | Yes | Query parameter `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee Welfare Pension Insurance Rule

**Slug:** `FREEE_GET_EMPLOYEE_WELFARE_PENSION_INSURANCE_RULE`

従業員の厚生年金保険の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | 従業員情報を取得したい年 |
| `month` | integer | Yes | 従業員情報を取得したい月 締め日支払い日設定が翌月払いの従業員情報の場合は、 指定したmonth + 1の値が検索結果として返します。 翌月払いの従業員の2022/01の従業員情報を取得する場合は、year=2021,month=12を指定してください。 |
| `company_id` | integer | Yes | 事業所ID |
| `employee_id` | integer | Yes | 従業員ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee Work Record

**Slug:** `FREEE_GET_EMPLOYEE_WORK_RECORD`

Call the official freee HR operation to get employee work record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | Path parameter `date` from the freee HR API. |
| `company_id` | integer | Yes | Query parameter `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Employee Work Record Summary

**Slug:** `FREEE_GET_EMPLOYEE_WORK_RECORD_SUMMARY`

Call the official freee HR operation to get employee work record summary.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Path parameter `year` from the freee HR API. |
| `month` | integer | Yes | Path parameter `month` from the freee HR API. |
| `company_id` | integer | Yes | Query parameter `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |
| `work_records` | boolean | No | Query parameter `work_records` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Expense Application

**Slug:** `FREEE_GET_EXPENSE_APPLICATION`

Get Expense Application using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Expense Application Currency

**Slug:** `FREEE_GET_EXPENSE_APPLICATION_CURRENCY`

Get Expense Application Currency using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Expense Application Form

**Slug:** `FREEE_GET_EXPENSE_APPLICATION_FORM`

Get Expense Application Form using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Expense Application Line Template

**Slug:** `FREEE_GET_EXPENSE_APPLICATION_LINE_TEMPLATE`

経費科目の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | 事業所ID |
| `expense_application_line_template_id` | integer | Yes | 経費科目ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get HR Approval Flow Route

**Slug:** `FREEE_GET_HR_APPROVAL_FLOW_ROUTE`

Get one HR approval flow route and its approval steps from a freee company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | HR approval flow route ID. |
| `company_id` | integer | Yes | HR company ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get HR Approval Flow Routes

**Slug:** `FREEE_GET_HR_APPROVAL_FLOW_ROUTES`

List approval flow routes available to HR workflows in a freee company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `usage` | string ("AttendanceWorkflow" | "PersonalDataWorkflow") | No | Only return routes usable for attendance or personal-data workflows. |
| `company_id` | integer | Yes | HR company ID. |
| `included_user_id` | integer | No | Only return routes that include this user as an approver. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Invoice

**Slug:** `FREEE_GET_INVOICE`

Get a current invoice by its freee Invoice API invoice ID. IDs from the retired freee Accounting invoices endpoint are not interchangeable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | freee company ID. |
| `invoice_id` | integer | Yes | freee Invoice API invoice ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Item

**Slug:** `FREEE_GET_ITEM`

Get Item using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Journal Report Status

**Slug:** `FREEE_GET_JOURNAL_REPORT_STATUS`

Get Journal Report Status using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Manual Journal

**Slug:** `FREEE_GET_MANUAL_JOURNAL`

Get Manual Journal using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Accounting Partner

**Slug:** `FREEE_GET_PARTNER`

Return full details for one business partner in a freee Accounting company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | Company ID that owns the partner. |
| `partner_id` | integer | Yes | Partner ID to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Payment Request

**Slug:** `FREEE_GET_PAYMENT_REQUEST`

Get Payment Request using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Purchase Request

**Slug:** `FREEE_GET_PURCHASE_REQUEST`

Get Purchase Request using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Purchase Request Form

**Slug:** `FREEE_GET_PURCHASE_REQUEST_FORM`

Get Purchase Request Form using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Quotation

**Slug:** `FREEE_GET_QUOTATION`

Get a current quotation by its freee Invoice API quotation ID. IDs from the retired freee Accounting quotations endpoint are not interchangeable.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | freee Invoice API quotation ID. |
| `company_id` | integer | Yes | freee company ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Receipt

**Slug:** `FREEE_GET_RECEIPT`

Get Receipt using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Salaries Employee Payroll Statement

**Slug:** `FREEE_GET_SALARIES_EMPLOYEE_PAYROLL_STATEMENT`

給与明細の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | 従業員情報を取得したい年 |
| `month` | integer | Yes | 従業員情報を取得したい月 |
| `company_id` | integer | Yes | 事業所ID |
| `employee_id` | integer | Yes | 従業員ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Salaries Employee Payroll Statements

**Slug:** `FREEE_GET_SALARIES_EMPLOYEE_PAYROLL_STATEMENTS`

給与明細一覧の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | 従業員情報を取得したい年 |
| `limit` | integer | No | 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 100) |
| `month` | integer | Yes | 従業員情報を取得したい月 |
| `offset` | integer | No | 取得レコードのオフセット (デフォルト: 0) |
| `company_id` | integer | Yes | 事業所ID |
| `next_cursor` | string | No | Continuation cursor returned by the previous page; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tag

**Slug:** `FREEE_GET_TAG`

Get Tag using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tax Code

**Slug:** `FREEE_GET_TAX_CODE`

Get Tax Code using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | integer | Yes | Official freee Accounting code value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Transfer

**Slug:** `FREEE_GET_TRANSFER`

Get Transfer using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trial Bs Three Years

**Slug:** `FREEE_GET_TRIAL_BS_THREE_YEARS`

貸借対照表(３期間比較)の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | No | 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） |
| `end_date` | string | No | 発生日で絞込：終了日(yyyy-mm-dd) |
| `end_month` | integer | No | 発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。 |
| `adjustment` | string ("only" | "without") | No | 決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * `only` - 決算整理仕訳のみを集計 * `without` - 決算整理仕訳を除外して集計 |
| `company_id` | integer | Yes | 事業所ID |
| `partner_id` | integer | No | 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） |
| `section_id` | integer | No | 部門IDで絞込（0を指定すると、部門が未選択で絞り込めます） |
| `start_date` | string | No | 発生日で絞込：開始日(yyyy-mm-dd) |
| `fiscal_year` | integer | No | 会計年度（会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019）。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。 |
| `start_month` | integer | No | 発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。 |
| `partner_code` | string | No | 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） |
| `approval_flow_status` | string ("without_in_progress" | "all") | No | 承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * `without_in_progress` - 未承認を除く（デフォルト） * `all` - 全ての承認ステータスを含む |
| `breakdown_display_type` | string ("partner" | "item" | "section" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag") | No | 内訳の表示。`account_item_display_type` と組み合わせ制約がある。 * `partner` / `item` / `section` / `segment_1_tag` / `segment_2_tag` / `segment_3_tag` は `account_item_display_type=account_item`（または省略）のときのみ指定可能。それぞれ各行の `balances[].partners` / `items` / `sections` / `segment_1_tags` / `segment_2_tags` / `segment_3_tags` に内訳配列を返す * `account_item` は `account_item_display_type=group` のときのみ指定可能。他の値と異なり内訳配列は返らず、決算書表示名行に続けて勘定科目行が同じ `balances[]` に展開される * 上記の組み合わせ以外（例: `account_item_display_type=group` かつ `partner` / `item` / `section` / `segment_*_tag`）は validation error になる 取引先、品目、部門、セグメント の各項目が単独で5,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。 例）取引先の登録数が5,000以上、品目の登録数が4,999以下の場合 * breakdown_display_type: 取引先を指定 → エラーになる * breakdown_display_type: 品目を指定 → エラーにならない |
| `account_item_display_type` | string ("account_item" | "group") | No | 勘定科目の表示。指定されない場合、`account_item` が指定されます。 * `account_item` - 勘定科目単位で表示 * `group` - 決算書表示単位で表示 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trial Bs Two Years

**Slug:** `FREEE_GET_TRIAL_BS_TWO_YEARS`

貸借対照表(前年比較)の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | No | 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） |
| `end_date` | string | No | 発生日で絞込：終了日(yyyy-mm-dd) |
| `end_month` | integer | No | 発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。 |
| `adjustment` | string ("only" | "without") | No | 決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * `only` - 決算整理仕訳のみを集計 * `without` - 決算整理仕訳を除外して集計 |
| `company_id` | integer | Yes | 事業所ID |
| `partner_id` | integer | No | 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） |
| `section_id` | integer | No | 部門IDで絞込（0を指定すると、部門が未選択で絞り込めます） |
| `start_date` | string | No | 発生日で絞込：開始日(yyyy-mm-dd) |
| `fiscal_year` | integer | No | 会計年度（会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019）。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。 |
| `start_month` | integer | No | 発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。 |
| `partner_code` | string | No | 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） |
| `approval_flow_status` | string ("without_in_progress" | "all") | No | 承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * `without_in_progress` - 未承認を除く（デフォルト） * `all` - 全ての承認ステータスを含む |
| `breakdown_display_type` | string ("partner" | "item" | "section" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag") | No | 内訳の表示。`account_item_display_type` と組み合わせ制約がある。 * `partner` / `item` / `section` / `segment_1_tag` / `segment_2_tag` / `segment_3_tag` は `account_item_display_type=account_item`（または省略）のときのみ指定可能。それぞれ各行の `balances[].partners` / `items` / `sections` / `segment_1_tags` / `segment_2_tags` / `segment_3_tags` に内訳配列を返す * `account_item` は `account_item_display_type=group` のときのみ指定可能。他の値と異なり内訳配列は返らず、決算書表示名行に続けて勘定科目行が同じ `balances[]` に展開される * 上記の組み合わせ以外（例: `account_item_display_type=group` かつ `partner` / `item` / `section` / `segment_*_tag`）は validation error になる 取引先、品目、部門、セグメント の各項目が単独で5,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。 例）取引先の登録数が5,000以上、品目の登録数が4,999以下の場合 * breakdown_display_type: 取引先を指定 → エラーになる * breakdown_display_type: 品目を指定 → エラーにならない |
| `account_item_display_type` | string ("account_item" | "group") | No | 勘定科目の表示。指定されない場合、`account_item` が指定されます。 * `account_item` - 勘定科目単位で表示 * `group` - 決算書表示単位で表示 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trial Cr

**Slug:** `FREEE_GET_TRIAL_CR`

製造原価報告書の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | No | 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） |
| `end_date` | string | No | 発生日で絞込：終了日(yyyy-mm-dd) |
| `end_month` | integer | No | 発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。 |
| `adjustment` | string ("only" | "without") | No | 決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * `only` - 決算整理仕訳のみを集計 * `without` - 決算整理仕訳を除外して集計 |
| `company_id` | integer | Yes | 事業所ID |
| `partner_id` | integer | No | 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） |
| `section_id` | integer | No | 部門IDで絞込（0を指定すると、部門が未選択で絞り込めます） |
| `start_date` | string | No | 発生日で絞込：開始日(yyyy-mm-dd) |
| `fiscal_year` | integer | No | 会計年度（会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019）。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。 |
| `start_month` | integer | No | 発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。 |
| `partner_code` | string | No | 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） |
| `cost_allocation` | string ("only" | "without") | No | 配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能で、利用できないプランで指定した場合はエラー（403）になります。 * `only` - 配賦仕訳のみを集計 * `without` - 配賦仕訳を除外して集計 |
| `approval_flow_status` | string ("without_in_progress" | "all") | No | 承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * `without_in_progress` - 未承認を除く（デフォルト） * `all` - 全ての承認ステータスを含む |
| `breakdown_display_type` | string ("partner" | "item" | "section" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag") | No | 内訳の表示。`account_item_display_type` と組み合わせ制約がある。 * `partner` / `item` / `section` / `segment_1_tag` / `segment_2_tag` / `segment_3_tag` は `account_item_display_type=account_item`（または省略）のときのみ指定可能。それぞれ各行の `balances[].partners` / `items` / `sections` / `segment_1_tags` / `segment_2_tags` / `segment_3_tags` に内訳配列を返す * `account_item` は `account_item_display_type=group` のときのみ指定可能。他の値と異なり内訳配列は返らず、決算書表示名行に続けて勘定科目行が同じ `balances[]` に展開される * 上記の組み合わせ以外（例: `account_item_display_type=group` かつ `partner` / `item` / `section` / `segment_*_tag`）は validation error になる 取引先、品目、部門、セグメント の各項目が単独で5,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。 例）取引先の登録数が5,000以上、品目の登録数が4,999以下の場合 * breakdown_display_type: 取引先を指定 → エラーになる * breakdown_display_type: 品目を指定 → エラーにならない |
| `account_item_display_type` | string ("account_item" | "group") | No | 勘定科目の表示。指定されない場合、`account_item` が指定されます。 * `account_item` - 勘定科目単位で表示 * `group` - 決算書表示単位で表示 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trial Cr Sections

**Slug:** `FREEE_GET_TRIAL_CR_SECTIONS`

製造原価報告書(部門比較)の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | No | 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） |
| `end_date` | string | No | 発生日で絞込：終了日(yyyy-mm-dd) |
| `end_month` | integer | No | 発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。 |
| `adjustment` | string ("only" | "without") | No | 決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * `only` - 決算整理仕訳のみを集計 * `without` - 決算整理仕訳を除外して集計 |
| `company_id` | integer | Yes | 事業所ID |
| `partner_id` | integer | No | 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） |
| `start_date` | string | No | 発生日で絞込：開始日(yyyy-mm-dd) |
| `fiscal_year` | integer | No | 会計年度（会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019）。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。 |
| `section_ids` | string | Yes | 比較する部門IDの指定。半角数字のIDを半角カンマ区切り（スペースなし）で1〜5つ指定してください。同じIDを重複して指定することはできません。0を指定すると、未選択の部門で比較できます。 |
| `start_month` | integer | No | 発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。 |
| `partner_code` | string | No | 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） |
| `cost_allocation` | string ("only" | "without") | No | 配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能で、利用できないプランで指定した場合はエラー（403）になります。 * `only` - 配賦仕訳のみを集計 * `without` - 配賦仕訳を除外して集計 |
| `approval_flow_status` | string ("without_in_progress" | "all") | No | 承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * `without_in_progress` - 未承認を除く（デフォルト） * `all` - 全ての承認ステータスを含む |
| `breakdown_display_type` | string ("partner" | "item" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag") | No | 内訳の表示。`account_item_display_type` と組み合わせ制約がある。 * `partner` / `item` / `segment_1_tag` / `segment_2_tag` / `segment_3_tag` は `account_item_display_type=account_item`（または省略）のときのみ指定可能。`balances[].sections[]` の各部門要素配下の `partners` / `items` / `segment_1_tags` / `segment_2_tags` / `segment_3_tags` に内訳配列を返す * `account_item` は `account_item_display_type=group` のときのみ指定可能。他の値と異なり内訳配列は返らず、決算書表示名行に続けて勘定科目行が同じ `balances[]` に展開される * 部門比較では `section` は指定できない * 上記の組み合わせ以外は validation error になる 取引先、品目、セグメント の各項目が単独で5,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。 例）取引先の登録数が5,000以上、品目の登録数が4,999以下の場合 * breakdown_display_type: 取引先を指定 → エラーになる * breakdown_display_type: 品目を指定 → エラーにならない |
| `account_item_display_type` | string ("account_item" | "group") | No | 勘定科目の表示。指定されない場合、`account_item` が指定されます。 * `account_item` - 勘定科目単位で表示 * `group` - 決算書表示単位で表示 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trial Cr Segment 1 Tags

**Slug:** `FREEE_GET_TRIAL_CR_SEGMENT_1_TAGS`

製造原価報告書(セグメント１比較)の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | No | 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） |
| `end_date` | string | No | 発生日で絞込：終了日(yyyy-mm-dd) |
| `end_month` | integer | No | 発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。 |
| `adjustment` | string ("only" | "without") | No | 決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * `only` - 決算整理仕訳のみを集計 * `without` - 決算整理仕訳を除外して集計 |
| `company_id` | integer | Yes | 事業所ID |
| `partner_id` | integer | No | 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） |
| `section_id` | integer | No | 部門IDで絞込（0を指定すると、部門が未選択で絞り込めます） |
| `start_date` | string | No | 発生日で絞込：開始日(yyyy-mm-dd) |
| `fiscal_year` | integer | No | 会計年度（会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019）。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。 |
| `start_month` | integer | No | 発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。 |
| `partner_code` | string | No | 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） |
| `cost_allocation` | string ("only" | "without") | No | 配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能で、利用できないプランで指定した場合はエラー（403）になります。 * `only` - 配賦仕訳のみを集計 * `without` - 配賦仕訳を除外して集計 |
| `segment_1_tag_ids` | string | Yes | 比較するセグメント1タグIDの指定。半角数字のIDを半角カンマ区切り（スペースなし）で1〜5つ指定してください。同じIDを重複して指定することはできません。0を指定すると、未選択のセグメント1タグで比較できます。 |
| `approval_flow_status` | string ("without_in_progress" | "all") | No | 承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * `without_in_progress` - 未承認を除く（デフォルト） * `all` - 全ての承認ステータスを含む |
| `breakdown_display_type` | string ("partner" | "item" | "section" | "account_item") | No | 内訳の表示。`account_item_display_type` と組み合わせ制約がある。 * `partner` / `item` / `section` は `account_item_display_type=account_item`（または省略）のときのみ指定可能。`balances[].segment_1_tags[]` の各セグメント1タグ要素配下の `partners` / `items` / `sections` に内訳配列を返す * `account_item` は `account_item_display_type=group` のときのみ指定可能。他の値と異なり内訳配列は返らず、決算書表示名行に続けて勘定科目行が同じ `balances[]` に展開される * 上記の組み合わせ以外は validation error になる 取引先、品目、部門 の各項目が単独で5,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。 例）取引先の登録数が5,000以上、品目の登録数が4,999以下の場合 * breakdown_display_type: 取引先を指定 → エラーになる * breakdown_display_type: 品目を指定 → エラーにならない |
| `account_item_display_type` | string ("account_item" | "group") | No | 勘定科目の表示。指定されない場合、`account_item` が指定されます。 * `account_item` - 勘定科目単位で表示 * `group` - 決算書表示単位で表示 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trial Cr Segment 2 Tags

**Slug:** `FREEE_GET_TRIAL_CR_SEGMENT_2_TAGS`

製造原価報告書(セグメント２比較)の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | No | 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） |
| `end_date` | string | No | 発生日で絞込：終了日(yyyy-mm-dd) |
| `end_month` | integer | No | 発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。 |
| `adjustment` | string ("only" | "without") | No | 決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * `only` - 決算整理仕訳のみを集計 * `without` - 決算整理仕訳を除外して集計 |
| `company_id` | integer | Yes | 事業所ID |
| `partner_id` | integer | No | 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） |
| `section_id` | integer | No | 部門IDで絞込（0を指定すると、部門が未選択で絞り込めます） |
| `start_date` | string | No | 発生日で絞込：開始日(yyyy-mm-dd) |
| `fiscal_year` | integer | No | 会計年度（会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019）。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。 |
| `start_month` | integer | No | 発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。 |
| `partner_code` | string | No | 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） |
| `cost_allocation` | string ("only" | "without") | No | 配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能で、利用できないプランで指定した場合はエラー（403）になります。 * `only` - 配賦仕訳のみを集計 * `without` - 配賦仕訳を除外して集計 |
| `segment_2_tag_ids` | string | Yes | 比較するセグメント2タグIDの指定。半角数字のIDを半角カンマ区切り（スペースなし）で1〜5つ指定してください。同じIDを重複して指定することはできません。0を指定すると、未選択のセグメント2タグで比較できます。 |
| `approval_flow_status` | string ("without_in_progress" | "all") | No | 承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * `without_in_progress` - 未承認を除く（デフォルト） * `all` - 全ての承認ステータスを含む |
| `breakdown_display_type` | string ("partner" | "item" | "section" | "account_item") | No | 内訳の表示。`account_item_display_type` と組み合わせ制約がある。 * `partner` / `item` / `section` は `account_item_display_type=account_item`（または省略）のときのみ指定可能。`balances[].segment_2_tags[]` の各セグメント2タグ要素配下の `partners` / `items` / `sections` に内訳配列を返す * `account_item` は `account_item_display_type=group` のときのみ指定可能。他の値と異なり内訳配列は返らず、決算書表示名行に続けて勘定科目行が同じ `balances[]` に展開される * 上記の組み合わせ以外は validation error になる 取引先、品目、部門 の各項目が単独で5,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。 例）取引先の登録数が5,000以上、品目の登録数が4,999以下の場合 * breakdown_display_type: 取引先を指定 → エラーになる * breakdown_display_type: 品目を指定 → エラーにならない |
| `account_item_display_type` | string ("account_item" | "group") | No | 勘定科目の表示。指定されない場合、`account_item` が指定されます。 * `account_item` - 勘定科目単位で表示 * `group` - 決算書表示単位で表示 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trial Cr Segment 3 Tags

**Slug:** `FREEE_GET_TRIAL_CR_SEGMENT_3_TAGS`

製造原価報告書(セグメント３比較)の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | No | 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） |
| `end_date` | string | No | 発生日で絞込：終了日(yyyy-mm-dd) |
| `end_month` | integer | No | 発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。 |
| `adjustment` | string ("only" | "without") | No | 決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * `only` - 決算整理仕訳のみを集計 * `without` - 決算整理仕訳を除外して集計 |
| `company_id` | integer | Yes | 事業所ID |
| `partner_id` | integer | No | 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） |
| `section_id` | integer | No | 部門IDで絞込（0を指定すると、部門が未選択で絞り込めます） |
| `start_date` | string | No | 発生日で絞込：開始日(yyyy-mm-dd) |
| `fiscal_year` | integer | No | 会計年度（会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019）。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。 |
| `start_month` | integer | No | 発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。 |
| `partner_code` | string | No | 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） |
| `cost_allocation` | string ("only" | "without") | No | 配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能で、利用できないプランで指定した場合はエラー（403）になります。 * `only` - 配賦仕訳のみを集計 * `without` - 配賦仕訳を除外して集計 |
| `segment_3_tag_ids` | string | Yes | 比較するセグメント3タグIDの指定。半角数字のIDを半角カンマ区切り（スペースなし）で1〜5つ指定してください。同じIDを重複して指定することはできません。0を指定すると、未選択のセグメント3タグで比較できます。 |
| `approval_flow_status` | string ("without_in_progress" | "all") | No | 承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * `without_in_progress` - 未承認を除く（デフォルト） * `all` - 全ての承認ステータスを含む |
| `breakdown_display_type` | string ("partner" | "item" | "section" | "account_item") | No | 内訳の表示。`account_item_display_type` と組み合わせ制約がある。 * `partner` / `item` / `section` は `account_item_display_type=account_item`（または省略）のときのみ指定可能。`balances[].segment_3_tags[]` の各セグメント3タグ要素配下の `partners` / `items` / `sections` に内訳配列を返す * `account_item` は `account_item_display_type=group` のときのみ指定可能。他の値と異なり内訳配列は返らず、決算書表示名行に続けて勘定科目行が同じ `balances[]` に展開される * 上記の組み合わせ以外は validation error になる 取引先、品目、部門 の各項目が単独で5,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。 例）取引先の登録数が5,000以上、品目の登録数が4,999以下の場合 * breakdown_display_type: 取引先を指定 → エラーになる * breakdown_display_type: 品目を指定 → エラーにならない |
| `account_item_display_type` | string ("account_item" | "group") | No | 勘定科目の表示。指定されない場合、`account_item` が指定されます。 * `account_item` - 勘定科目単位で表示 * `group` - 決算書表示単位で表示 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trial Cr Three Years

**Slug:** `FREEE_GET_TRIAL_CR_THREE_YEARS`

製造原価報告書(３期間比較)の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | No | 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） |
| `end_date` | string | No | 発生日で絞込：終了日(yyyy-mm-dd) |
| `end_month` | integer | No | 発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。 |
| `adjustment` | string ("only" | "without") | No | 決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * `only` - 決算整理仕訳のみを集計 * `without` - 決算整理仕訳を除外して集計 |
| `company_id` | integer | Yes | 事業所ID |
| `partner_id` | integer | No | 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） |
| `section_id` | integer | No | 部門IDで絞込（0を指定すると、部門が未選択で絞り込めます） |
| `start_date` | string | No | 発生日で絞込：開始日(yyyy-mm-dd) |
| `fiscal_year` | integer | No | 会計年度（会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019）。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。 |
| `start_month` | integer | No | 発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。 |
| `partner_code` | string | No | 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） |
| `cost_allocation` | string ("only" | "without") | No | 配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能で、利用できないプランで指定した場合はエラー（403）になります。 * `only` - 配賦仕訳のみを集計 * `without` - 配賦仕訳を除外して集計 |
| `approval_flow_status` | string ("without_in_progress" | "all") | No | 承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * `without_in_progress` - 未承認を除く（デフォルト） * `all` - 全ての承認ステータスを含む |
| `breakdown_display_type` | string ("partner" | "item" | "section" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag") | No | 内訳の表示。`account_item_display_type` と組み合わせ制約がある。 * `partner` / `item` / `section` / `segment_1_tag` / `segment_2_tag` / `segment_3_tag` は `account_item_display_type=account_item`（または省略）のときのみ指定可能。それぞれ各行の `balances[].partners` / `items` / `sections` / `segment_1_tags` / `segment_2_tags` / `segment_3_tags` に内訳配列を返す * `account_item` は `account_item_display_type=group` のときのみ指定可能。他の値と異なり内訳配列は返らず、決算書表示名行に続けて勘定科目行が同じ `balances[]` に展開される * 上記の組み合わせ以外（例: `account_item_display_type=group` かつ `partner` / `item` / `section` / `segment_*_tag`）は validation error になる 取引先、品目、部門、セグメント の各項目が単独で5,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。 例）取引先の登録数が5,000以上、品目の登録数が4,999以下の場合 * breakdown_display_type: 取引先を指定 → エラーになる * breakdown_display_type: 品目を指定 → エラーにならない |
| `account_item_display_type` | string ("account_item" | "group") | No | 勘定科目の表示。指定されない場合、`account_item` が指定されます。 * `account_item` - 勘定科目単位で表示 * `group` - 決算書表示単位で表示 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trial Cr Two Years

**Slug:** `FREEE_GET_TRIAL_CR_TWO_YEARS`

製造原価報告書(前年比較)の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | No | 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） |
| `end_date` | string | No | 発生日で絞込：終了日(yyyy-mm-dd) |
| `end_month` | integer | No | 発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。 |
| `adjustment` | string ("only" | "without") | No | 決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * `only` - 決算整理仕訳のみを集計 * `without` - 決算整理仕訳を除外して集計 |
| `company_id` | integer | Yes | 事業所ID |
| `partner_id` | integer | No | 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） |
| `section_id` | integer | No | 部門IDで絞込（0を指定すると、部門が未選択で絞り込めます） |
| `start_date` | string | No | 発生日で絞込：開始日(yyyy-mm-dd) |
| `fiscal_year` | integer | No | 会計年度（会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019）。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。 |
| `start_month` | integer | No | 発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。 |
| `partner_code` | string | No | 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） |
| `cost_allocation` | string ("only" | "without") | No | 配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能で、利用できないプランで指定した場合はエラー（403）になります。 * `only` - 配賦仕訳のみを集計 * `without` - 配賦仕訳を除外して集計 |
| `approval_flow_status` | string ("without_in_progress" | "all") | No | 承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * `without_in_progress` - 未承認を除く（デフォルト） * `all` - 全ての承認ステータスを含む |
| `breakdown_display_type` | string ("partner" | "item" | "section" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag") | No | 内訳の表示。`account_item_display_type` と組み合わせ制約がある。 * `partner` / `item` / `section` / `segment_1_tag` / `segment_2_tag` / `segment_3_tag` は `account_item_display_type=account_item`（または省略）のときのみ指定可能。それぞれ各行の `balances[].partners` / `items` / `sections` / `segment_1_tags` / `segment_2_tags` / `segment_3_tags` に内訳配列を返す * `account_item` は `account_item_display_type=group` のときのみ指定可能。他の値と異なり内訳配列は返らず、決算書表示名行に続けて勘定科目行が同じ `balances[]` に展開される * 上記の組み合わせ以外（例: `account_item_display_type=group` かつ `partner` / `item` / `section` / `segment_*_tag`）は validation error になる 取引先、品目、部門、セグメント の各項目が単独で5,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。 例）取引先の登録数が5,000以上、品目の登録数が4,999以下の場合 * breakdown_display_type: 取引先を指定 → エラーになる * breakdown_display_type: 品目を指定 → エラーにならない |
| `account_item_display_type` | string ("account_item" | "group") | No | 勘定科目の表示。指定されない場合、`account_item` が指定されます。 * `account_item` - 勘定科目単位で表示 * `group` - 決算書表示単位で表示 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trial Pl

**Slug:** `FREEE_GET_TRIAL_PL`

損益計算書の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | No | 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） |
| `end_date` | string | No | 発生日で絞込：終了日(yyyy-mm-dd) |
| `end_month` | integer | No | 発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。 |
| `adjustment` | string ("only" | "without") | No | 決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * `only` - 決算整理仕訳のみを集計 * `without` - 決算整理仕訳を除外して集計 |
| `company_id` | integer | Yes | 事業所ID |
| `partner_id` | integer | No | 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） |
| `section_id` | integer | No | 部門IDで絞込（0を指定すると、部門が未選択で絞り込めます） |
| `start_date` | string | No | 発生日で絞込：開始日(yyyy-mm-dd) |
| `fiscal_year` | integer | No | 会計年度（会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019）。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。 |
| `start_month` | integer | No | 発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。 |
| `partner_code` | string | No | 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） |
| `cost_allocation` | string ("only" | "without") | No | 配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能で、利用できないプランで指定した場合はエラー（403）になります。 * `only` - 配賦仕訳のみを集計 * `without` - 配賦仕訳を除外して集計 |
| `approval_flow_status` | string ("without_in_progress" | "all") | No | 承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * `without_in_progress` - 未承認を除く（デフォルト） * `all` - 全ての承認ステータスを含む |
| `breakdown_display_type` | string ("partner" | "item" | "section" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag") | No | 内訳の表示。`account_item_display_type` と組み合わせ制約がある。 * `partner` / `item` / `section` / `segment_1_tag` / `segment_2_tag` / `segment_3_tag` は `account_item_display_type=account_item`（または省略）のときのみ指定可能。それぞれ各行の `balances[].partners` / `items` / `sections` / `segment_1_tags` / `segment_2_tags` / `segment_3_tags` に内訳配列を返す * `account_item` は `account_item_display_type=group` のときのみ指定可能。他の値と異なり内訳配列は返らず、決算書表示名行に続けて勘定科目行が同じ `balances[]` に展開される * 上記の組み合わせ以外（例: `account_item_display_type=group` かつ `partner` / `item` / `section` / `segment_*_tag`）は validation error になる 取引先、品目、部門、セグメント の各項目が単独で5,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。 例）取引先の登録数が5,000以上、品目の登録数が4,999以下の場合 * breakdown_display_type: 取引先を指定 → エラーになる * breakdown_display_type: 品目を指定 → エラーにならない |
| `account_item_display_type` | string ("account_item" | "group") | No | 勘定科目の表示。指定されない場合、`account_item` が指定されます。 * `account_item` - 勘定科目単位で表示 * `group` - 決算書表示単位で表示 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trial Pl Sections

**Slug:** `FREEE_GET_TRIAL_PL_SECTIONS`

損益計算書(部門比較)の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | No | 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） |
| `end_date` | string | No | 発生日で絞込：終了日(yyyy-mm-dd) |
| `end_month` | integer | No | 発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。 |
| `adjustment` | string ("only" | "without") | No | 決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * `only` - 決算整理仕訳のみを集計 * `without` - 決算整理仕訳を除外して集計 |
| `company_id` | integer | Yes | 事業所ID |
| `partner_id` | integer | No | 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） |
| `start_date` | string | No | 発生日で絞込：開始日(yyyy-mm-dd) |
| `fiscal_year` | integer | No | 会計年度（会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019）。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。 |
| `section_ids` | string | Yes | 比較する部門IDの指定。半角数字のIDを半角カンマ区切り（スペースなし）で1〜5つ指定してください。同じIDを重複して指定することはできません。0を指定すると、未選択の部門で比較できます。 |
| `start_month` | integer | No | 発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。 |
| `partner_code` | string | No | 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） |
| `cost_allocation` | string ("only" | "without") | No | 配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能で、利用できないプランで指定した場合はエラー（403）になります。 * `only` - 配賦仕訳のみを集計 * `without` - 配賦仕訳を除外して集計 |
| `approval_flow_status` | string ("without_in_progress" | "all") | No | 承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * `without_in_progress` - 未承認を除く（デフォルト） * `all` - 全ての承認ステータスを含む |
| `breakdown_display_type` | string ("partner" | "item" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag") | No | 内訳の表示。`account_item_display_type` と組み合わせ制約がある。 * `partner` / `item` / `segment_1_tag` / `segment_2_tag` / `segment_3_tag` は `account_item_display_type=account_item`（または省略）のときのみ指定可能。`balances[].sections[]` の各部門要素配下の `partners` / `items` / `segment_1_tags` / `segment_2_tags` / `segment_3_tags` に内訳配列を返す * `account_item` は `account_item_display_type=group` のときのみ指定可能。他の値と異なり内訳配列は返らず、決算書表示名行に続けて勘定科目行が同じ `balances[]` に展開される * 部門比較では `section` は指定できない * 上記の組み合わせ以外は validation error になる 取引先、品目、セグメント の各項目が単独で5,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。 例）取引先の登録数が5,000以上、品目の登録数が4,999以下の場合 * breakdown_display_type: 取引先を指定 → エラーになる * breakdown_display_type: 品目を指定 → エラーにならない |
| `account_item_display_type` | string ("account_item" | "group") | No | 勘定科目の表示。指定されない場合、`account_item` が指定されます。 * `account_item` - 勘定科目単位で表示 * `group` - 決算書表示単位で表示 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trial Pl Segment 1 Tags

**Slug:** `FREEE_GET_TRIAL_PL_SEGMENT_1_TAGS`

損益計算書(セグメント１比較)の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | No | 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） |
| `end_date` | string | No | 発生日で絞込：終了日(yyyy-mm-dd) |
| `end_month` | integer | No | 発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。 |
| `adjustment` | string ("only" | "without") | No | 決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * `only` - 決算整理仕訳のみを集計 * `without` - 決算整理仕訳を除外して集計 |
| `company_id` | integer | Yes | 事業所ID |
| `partner_id` | integer | No | 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） |
| `section_id` | integer | No | 部門IDで絞込（0を指定すると、部門が未選択で絞り込めます） |
| `start_date` | string | No | 発生日で絞込：開始日(yyyy-mm-dd) |
| `fiscal_year` | integer | No | 会計年度（会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019）。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。 |
| `start_month` | integer | No | 発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。 |
| `partner_code` | string | No | 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） |
| `cost_allocation` | string ("only" | "without") | No | 配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能で、利用できないプランで指定した場合はエラー（403）になります。 * `only` - 配賦仕訳のみを集計 * `without` - 配賦仕訳を除外して集計 |
| `segment_1_tag_ids` | string | Yes | 比較するセグメント1タグIDの指定。半角数字のIDを半角カンマ区切り（スペースなし）で1〜5つ指定してください。同じIDを重複して指定することはできません。0を指定すると、未選択のセグメント1タグで比較できます。 |
| `approval_flow_status` | string ("without_in_progress" | "all") | No | 承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * `without_in_progress` - 未承認を除く（デフォルト） * `all` - 全ての承認ステータスを含む |
| `breakdown_display_type` | string ("partner" | "item" | "section" | "account_item") | No | 内訳の表示。`account_item_display_type` と組み合わせ制約がある。 * `partner` / `item` / `section` は `account_item_display_type=account_item`（または省略）のときのみ指定可能。`balances[].segment_1_tags[]` の各セグメント1タグ要素配下の `partners` / `items` / `sections` に内訳配列を返す * `account_item` は `account_item_display_type=group` のときのみ指定可能。他の値と異なり内訳配列は返らず、決算書表示名行に続けて勘定科目行が同じ `balances[]` に展開される * 上記の組み合わせ以外は validation error になる 取引先、品目、部門 の各項目が単独で5,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。 例）取引先の登録数が5,000以上、品目の登録数が4,999以下の場合 * breakdown_display_type: 取引先を指定 → エラーになる * breakdown_display_type: 品目を指定 → エラーにならない |
| `account_item_display_type` | string ("account_item" | "group") | No | 勘定科目の表示。指定されない場合、`account_item` が指定されます。 * `account_item` - 勘定科目単位で表示 * `group` - 決算書表示単位で表示 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trial Pl Segment 2 Tags

**Slug:** `FREEE_GET_TRIAL_PL_SEGMENT_2_TAGS`

損益計算書(セグメント２比較)の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | No | 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） |
| `end_date` | string | No | 発生日で絞込：終了日(yyyy-mm-dd) |
| `end_month` | integer | No | 発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。 |
| `adjustment` | string ("only" | "without") | No | 決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * `only` - 決算整理仕訳のみを集計 * `without` - 決算整理仕訳を除外して集計 |
| `company_id` | integer | Yes | 事業所ID |
| `partner_id` | integer | No | 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） |
| `section_id` | integer | No | 部門IDで絞込（0を指定すると、部門が未選択で絞り込めます） |
| `start_date` | string | No | 発生日で絞込：開始日(yyyy-mm-dd) |
| `fiscal_year` | integer | No | 会計年度（会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019）。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。 |
| `start_month` | integer | No | 発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。 |
| `partner_code` | string | No | 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） |
| `cost_allocation` | string ("only" | "without") | No | 配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能で、利用できないプランで指定した場合はエラー（403）になります。 * `only` - 配賦仕訳のみを集計 * `without` - 配賦仕訳を除外して集計 |
| `segment_2_tag_ids` | string | Yes | 比較するセグメント2タグIDの指定。半角数字のIDを半角カンマ区切り（スペースなし）で1〜5つ指定してください。同じIDを重複して指定することはできません。0を指定すると、未選択のセグメント2タグで比較できます。 |
| `approval_flow_status` | string ("without_in_progress" | "all") | No | 承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * `without_in_progress` - 未承認を除く（デフォルト） * `all` - 全ての承認ステータスを含む |
| `breakdown_display_type` | string ("partner" | "item" | "section" | "account_item") | No | 内訳の表示。`account_item_display_type` と組み合わせ制約がある。 * `partner` / `item` / `section` は `account_item_display_type=account_item`（または省略）のときのみ指定可能。`balances[].segment_2_tags[]` の各セグメント2タグ要素配下の `partners` / `items` / `sections` に内訳配列を返す * `account_item` は `account_item_display_type=group` のときのみ指定可能。他の値と異なり内訳配列は返らず、決算書表示名行に続けて勘定科目行が同じ `balances[]` に展開される * 上記の組み合わせ以外は validation error になる 取引先、品目、部門 の各項目が単独で5,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。 例）取引先の登録数が5,000以上、品目の登録数が4,999以下の場合 * breakdown_display_type: 取引先を指定 → エラーになる * breakdown_display_type: 品目を指定 → エラーにならない |
| `account_item_display_type` | string ("account_item" | "group") | No | 勘定科目の表示。指定されない場合、`account_item` が指定されます。 * `account_item` - 勘定科目単位で表示 * `group` - 決算書表示単位で表示 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trial Pl Segment 3 Tags

**Slug:** `FREEE_GET_TRIAL_PL_SEGMENT_3_TAGS`

損益計算書(セグメント３比較)の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | No | 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） |
| `end_date` | string | No | 発生日で絞込：終了日(yyyy-mm-dd) |
| `end_month` | integer | No | 発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。 |
| `adjustment` | string ("only" | "without") | No | 決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * `only` - 決算整理仕訳のみを集計 * `without` - 決算整理仕訳を除外して集計 |
| `company_id` | integer | Yes | 事業所ID |
| `partner_id` | integer | No | 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） |
| `section_id` | integer | No | 部門IDで絞込（0を指定すると、部門が未選択で絞り込めます） |
| `start_date` | string | No | 発生日で絞込：開始日(yyyy-mm-dd) |
| `fiscal_year` | integer | No | 会計年度（会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019）。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。 |
| `start_month` | integer | No | 発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。 |
| `partner_code` | string | No | 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） |
| `cost_allocation` | string ("only" | "without") | No | 配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能で、利用できないプランで指定した場合はエラー（403）になります。 * `only` - 配賦仕訳のみを集計 * `without` - 配賦仕訳を除外して集計 |
| `segment_3_tag_ids` | string | Yes | 比較するセグメント3タグIDの指定。半角数字のIDを半角カンマ区切り（スペースなし）で1〜5つ指定してください。同じIDを重複して指定することはできません。0を指定すると、未選択のセグメント3タグで比較できます。 |
| `approval_flow_status` | string ("without_in_progress" | "all") | No | 承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * `without_in_progress` - 未承認を除く（デフォルト） * `all` - 全ての承認ステータスを含む |
| `breakdown_display_type` | string ("partner" | "item" | "section" | "account_item") | No | 内訳の表示。`account_item_display_type` と組み合わせ制約がある。 * `partner` / `item` / `section` は `account_item_display_type=account_item`（または省略）のときのみ指定可能。`balances[].segment_3_tags[]` の各セグメント3タグ要素配下の `partners` / `items` / `sections` に内訳配列を返す * `account_item` は `account_item_display_type=group` のときのみ指定可能。他の値と異なり内訳配列は返らず、決算書表示名行に続けて勘定科目行が同じ `balances[]` に展開される * 上記の組み合わせ以外は validation error になる 取引先、品目、部門 の各項目が単独で5,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。 例）取引先の登録数が5,000以上、品目の登録数が4,999以下の場合 * breakdown_display_type: 取引先を指定 → エラーになる * breakdown_display_type: 品目を指定 → エラーにならない |
| `account_item_display_type` | string ("account_item" | "group") | No | 勘定科目の表示。指定されない場合、`account_item` が指定されます。 * `account_item` - 勘定科目単位で表示 * `group` - 決算書表示単位で表示 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trial Pl Three Years

**Slug:** `FREEE_GET_TRIAL_PL_THREE_YEARS`

損益計算書(３期間比較)の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | No | 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） |
| `end_date` | string | No | 発生日で絞込：終了日(yyyy-mm-dd) |
| `end_month` | integer | No | 発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。 |
| `adjustment` | string ("only" | "without") | No | 決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * `only` - 決算整理仕訳のみを集計 * `without` - 決算整理仕訳を除外して集計 |
| `company_id` | integer | Yes | 事業所ID |
| `partner_id` | integer | No | 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） |
| `section_id` | integer | No | 部門IDで絞込（0を指定すると、部門が未選択で絞り込めます） |
| `start_date` | string | No | 発生日で絞込：開始日(yyyy-mm-dd) |
| `fiscal_year` | integer | No | 会計年度（会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019）。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。 |
| `start_month` | integer | No | 発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。 |
| `partner_code` | string | No | 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） |
| `cost_allocation` | string ("only" | "without") | No | 配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能で、利用できないプランで指定した場合はエラー（403）になります。 * `only` - 配賦仕訳のみを集計 * `without` - 配賦仕訳を除外して集計 |
| `approval_flow_status` | string ("without_in_progress" | "all") | No | 承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * `without_in_progress` - 未承認を除く（デフォルト） * `all` - 全ての承認ステータスを含む |
| `breakdown_display_type` | string ("partner" | "item" | "section" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag") | No | 内訳の表示。`account_item_display_type` と組み合わせ制約がある。 * `partner` / `item` / `section` / `segment_1_tag` / `segment_2_tag` / `segment_3_tag` は `account_item_display_type=account_item`（または省略）のときのみ指定可能。それぞれ各行の `balances[].partners` / `items` / `sections` / `segment_1_tags` / `segment_2_tags` / `segment_3_tags` に内訳配列を返す * `account_item` は `account_item_display_type=group` のときのみ指定可能。他の値と異なり内訳配列は返らず、決算書表示名行に続けて勘定科目行が同じ `balances[]` に展開される * 上記の組み合わせ以外（例: `account_item_display_type=group` かつ `partner` / `item` / `section` / `segment_*_tag`）は validation error になる 取引先、品目、部門、セグメント の各項目が単独で5,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。 例）取引先の登録数が5,000以上、品目の登録数が4,999以下の場合 * breakdown_display_type: 取引先を指定 → エラーになる * breakdown_display_type: 品目を指定 → エラーにならない |
| `account_item_display_type` | string ("account_item" | "group") | No | 勘定科目の表示。指定されない場合、`account_item` が指定されます。 * `account_item` - 勘定科目単位で表示 * `group` - 決算書表示単位で表示 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Trial Pl Two Years

**Slug:** `FREEE_GET_TRIAL_PL_TWO_YEARS`

損益計算書(前年比較)の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `item_id` | integer | No | 品目IDで絞込（0を指定すると、品目が未選択で絞り込めます） |
| `end_date` | string | No | 発生日で絞込：終了日(yyyy-mm-dd) |
| `end_month` | integer | No | 発生月で絞込：終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, ... 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。 |
| `adjustment` | string ("only" | "without") | No | 決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * `only` - 決算整理仕訳のみを集計 * `without` - 決算整理仕訳を除外して集計 |
| `company_id` | integer | Yes | 事業所ID |
| `partner_id` | integer | No | 取引先IDで絞込（0を指定すると、取引先が未選択で絞り込めます） |
| `section_id` | integer | No | 部門IDで絞込（0を指定すると、部門が未選択で絞り込めます） |
| `start_date` | string | No | 発生日で絞込：開始日(yyyy-mm-dd) |
| `fiscal_year` | integer | No | 会計年度（会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019）。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。 |
| `start_month` | integer | No | 発生月で絞込：開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。 |
| `partner_code` | string | No | 取引先コードで絞込（事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です） |
| `cost_allocation` | string ("only" | "without") | No | 配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン（および旧法人ベーシックプラン）以上で利用可能で、利用できないプランで指定した場合はエラー（403）になります。 * `only` - 配賦仕訳のみを集計 * `without` - 配賦仕訳を除外して集計 |
| `approval_flow_status` | string ("without_in_progress" | "all") | No | 承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン（および旧法人プロフェッショナルプラン）以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * `without_in_progress` - 未承認を除く（デフォルト） * `all` - 全ての承認ステータスを含む |
| `breakdown_display_type` | string ("partner" | "item" | "section" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag") | No | 内訳の表示。`account_item_display_type` と組み合わせ制約がある。 * `partner` / `item` / `section` / `segment_1_tag` / `segment_2_tag` / `segment_3_tag` は `account_item_display_type=account_item`（または省略）のときのみ指定可能。それぞれ各行の `balances[].partners` / `items` / `sections` / `segment_1_tags` / `segment_2_tags` / `segment_3_tags` に内訳配列を返す * `account_item` は `account_item_display_type=group` のときのみ指定可能。他の値と異なり内訳配列は返らず、決算書表示名行に続けて勘定科目行が同じ `balances[]` に展開される * 上記の組み合わせ以外（例: `account_item_display_type=group` かつ `partner` / `item` / `section` / `segment_*_tag`）は validation error になる 取引先、品目、部門、セグメント の各項目が単独で5,000以上登録されている場合は、breakdown_display_type で該当項目を指定するとエラーになります。 例）取引先の登録数が5,000以上、品目の登録数が4,999以下の場合 * breakdown_display_type: 取引先を指定 → エラーになる * breakdown_display_type: 品目を指定 → エラーにならない |
| `account_item_display_type` | string ("account_item" | "group") | No | 勘定科目の表示。指定されない場合、`account_item` が指定されます。 * `account_item` - 勘定科目単位で表示 * `group` - 決算書表示単位で表示 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Matcher

**Slug:** `FREEE_GET_USER_MATCHER`

自動登録ルールの取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | 事業所ID |
| `user_matcher_id` | integer | Yes | 自動登録ルールID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Walletable

**Slug:** `FREEE_GET_WALLETABLE`

Get Walletable using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `type` | string ("bank_account" | "credit_card" | "wallet") | Yes | Official freee field `type`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `with_sync_status` | boolean | No | Official freee field `with_sync_status`. |
| `with_last_synced_at` | boolean | No | Official freee field `with_last_synced_at`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Wallet Transaction

**Slug:** `FREEE_GET_WALLET_TRANSACTION`

Get Wallet Transaction using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Yearend Adjustment Employee

**Slug:** `FREEE_GET_YEAREND_ADJUSTMENT_EMPLOYEE`

Call the official freee HR operation to get yearend adjustment employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Path parameter `year` from the freee HR API. |
| `company_id` | integer | Yes | Query parameter `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Yearend Adjustment Employees

**Slug:** `FREEE_GET_YEAREND_ADJUSTMENT_EMPLOYEES`

Call the official freee HR operation to get yearend adjustment employees.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Path parameter `year` from the freee HR API. |
| `limit` | integer | No | Query parameter `limit` from the freee HR API. |
| `offset` | integer | No | Query parameter `offset` from the freee HR API. |
| `company_id` | integer | Yes | Query parameter `company_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Accounting Sections

**Slug:** `FREEE_LIST_ACCOUNTING_SECTIONS`

List organizational sections configured in a freee Accounting company, optionally filtered by update date.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | Company ID whose Accounting sections to list. |
| `updated_to` | string | No | Inclusive latest update date in YYYY-MM-DD format (JST). |
| `updated_from` | string | No | Inclusive earliest update date in YYYY-MM-DD format (JST). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Accounting Account Items

**Slug:** `FREEE_LIST_ACCOUNT_ITEMS`

List or search the chart-of-accounts items available in a freee Accounting company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `keyword` | string | No | Partial-match search across account item code, name, and shortcuts; space- or tab-separated terms use AND matching. |
| `base_date` | string | No | Date in YYYY-MM-DD used to resolve each account item's default tax code; defaults to the request date. |
| `company_id` | integer | Yes | Company ID whose account items to list. |
| `updated_to` | string | No | Inclusive latest update date in YYYY-MM-DD format. |
| `updated_from` | string | No | Inclusive earliest update date in YYYY-MM-DD format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Approval Flow Routes

**Slug:** `FREEE_LIST_APPROVAL_FLOW_ROUTES`

申請経路一覧の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `usage` | string ("TxnApproval" | "ExpenseApplication" | "PaymentRequest" | "ApprovalRequest" | "DocApproval") | No | 申請種別（各申請種別が使用できる申請経路に絞り込めます。例えば、ApprovalRequest を指定すると、各種申請が使用できる申請経路に絞り込めます。未指定の場合は全ての申請種別の申請経路が対象になります。） * `TxnApproval` - 仕訳承認 * `ExpenseApplication` - 経費精算 * `PaymentRequest` - 支払依頼 * `ApprovalRequest` - 各種申請 * `DocApproval` - 請求書等 (見積書・納品書・請求書・発注書) |
| `company_id` | integer | Yes | 事業所ID |
| `request_form_id` | integer | No | 申請フォームID（指定した申請フォームが使用できる申請経路に絞り込めます。usage に ApprovalRequest を指定した場合のみ有効で、usage が ApprovalRequest 以外または未指定の場合、このパラメータは無視されます。指定した申請フォームが存在しない場合や無効な場合は空配列が返ります。） |
| `included_user_id` | integer | No | 経路に含まれるユーザーのユーザーID（指定したユーザーが承認ステップの承認者に含まれる申請経路に絞り込めます） |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Approval Request Forms

**Slug:** `FREEE_LIST_APPROVAL_REQUEST_FORMS`

List Approval Request Forms using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Approval Requests

**Slug:** `FREEE_LIST_APPROVAL_REQUESTS`

List Approval Requests using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Official freee field `limit`. |
| `title` | string | No | Official freee field `title`. |
| `offset` | integer | No | Official freee field `offset`. |
| `status` | string ("draft" | "in_progress" | "approved" | "rejected" | "feedback") | No | Official freee field `status`. |
| `form_id` | integer | No | Official freee field `form_id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `max_amount` | integer | No | Official freee field `max_amount`. |
| `min_amount` | integer | No | Official freee field `min_amount`. |
| `approver_id` | integer | No | Official freee field `approver_id`. |
| `applicant_id` | integer | No | Official freee field `applicant_id`. |
| `application_number` | integer | No | Official freee field `application_number`. |
| `end_application_date` | string | No | Official freee field `end_application_date`. |
| `start_application_date` | string | No | Official freee field `start_application_date`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Banks

**Slug:** `FREEE_LIST_BANKS`

List Banks using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("bank_account" | "credit_card" | "wallet") | No | Official freee field `type`. |
| `limit` | integer | No | Official freee field `limit`. |
| `offset` | integer | No | Official freee field `offset`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Companies

**Slug:** `FREEE_LIST_COMPANIES`

List freee Accounting companies associated with the connected user; use a company-scoped call to confirm the selected token can access a listed company.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Company Taxes

**Slug:** `FREEE_LIST_COMPANY_TAXES`

List Company Taxes using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `available` | boolean | No | Official freee Accounting available value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |
| `display_category` | string ("tax_5" | "tax_8" | "tax_r8" | "tax_10" | "tax_5_e80" | "tax_5_e70" | "tax_5_e50" | "tax_5_e30" | "tax_8_e80" | "tax_8_e70" | "tax_8_e50" | "tax_8_e30" | "tax_r8_e80" | "tax_r8_e70" | "tax_r8_e50" | "tax_r8_e30" | "tax_10_e80" | "tax_10_e70" | "tax_10_e50" | "tax_10_e30") | No | Official freee Accounting display category value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Accounting Deals

**Slug:** `FREEE_LIST_DEALS`

List income or expense deals in a freee Accounting company with date, settlement, partner, and account-item filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum deals to return on this page (1-100); deal detail rows can make responses large. |
| `status` | string ("unsettled" | "settled") | No | Filter by unsettled or settled payment status. |
| `deal_type` | string ("income" | "expense") | No | Filter by income or expense deals. |
| `issued_to` | string | No | Inclusive latest issue date in YYYY-MM-DD format. |
| `company_id` | integer | Yes | Company ID whose deals to list. |
| `partner_id` | integer | No | Filter by partner ID. |
| `issued_from` | string | No | Inclusive earliest issue date in YYYY-MM-DD format. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `account_item_id` | integer | No | Filter by account item ID. |
| `include_accruals` | boolean | No | Whether to include receivable and payable accrual rows when present. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Employees

**Slug:** `FREEE_LIST_EMPLOYEES`

List one cursor-paginated page of current and former employees in a freee HR company; requires a company administrator and does not require monthly payroll setup.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum employees to return on this page (1-100). |
| `company_id` | integer | Yes | HR company ID whose employees to list. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `include_non_payroll_employees` | boolean | No | Whether to include employees excluded from payroll calculation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Expense Application Currencies

**Slug:** `FREEE_LIST_EXPENSE_APPLICATION_CURRENCIES`

List Expense Application Currencies using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | Official freee Accounting company id value. |
| `search_status` | string ("usable" | "unusable") | No | Official freee Accounting search status value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Expense Application Line Templates

**Slug:** `FREEE_LIST_EXPENSE_APPLICATION_LINE_TEMPLATES`

経費科目一覧の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | 取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 100) |
| `offset` | integer | No | 取得レコードのオフセット (デフォルト: 0) |
| `company_id` | integer | Yes | 事業所ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Expense Applications

**Slug:** `FREEE_LIST_EXPENSE_APPLICATIONS`

List Expense Applications using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Official freee field `limit`. |
| `title` | string | No | Official freee field `title`. |
| `offset` | integer | No | Official freee field `offset`. |
| `status` | string ("draft" | "in_progress" | "approved" | "rejected" | "feedback" | "unsettled" | "settled") | No | Official freee field `status`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `max_amount` | integer | No | Official freee field `max_amount`. |
| `min_amount` | integer | No | Official freee field `min_amount`. |
| `approver_id` | integer | No | Official freee field `approver_id`. |
| `applicant_id` | integer | No | Official freee field `applicant_id`. |
| `end_issue_date` | string | No | Official freee field `end_issue_date`. |
| `payroll_attached` | boolean | No | Official freee field `payroll_attached`. |
| `start_issue_date` | string | No | Official freee field `start_issue_date`. |
| `application_number` | integer | No | Official freee field `application_number`. |
| `end_transaction_date` | string | No | Official freee field `end_transaction_date`. |
| `start_transaction_date` | string | No | Official freee field `start_transaction_date`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Fixed Assets

**Slug:** `FREEE_LIST_FIXED_ASSETS`

List Fixed Assets using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Official freee Accounting limit value. |
| `offset` | integer | No | Official freee Accounting offset value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |
| `target_date` | string | Yes | Official freee Accounting target date value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Form Selectables

**Slug:** `FREEE_LIST_FORM_SELECTABLES`

List Form Selectables using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `includes` | string | No | Official freee Accounting includes value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List General Ledgers

**Slug:** `FREEE_LIST_GENERAL_LEDGERS`

List General Ledgers using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_date` | string | Yes | Official freee field `end_date`. |
| `tag_name` | string | No | Official freee field `tag_name`. |
| `tax_name` | string ("課税" | "対象外" | "非課税" | "不課税" | "輸出等" | "未選択" | "課税売上" | "輸出売上" | "非課売上" | "非資売上" | "有価譲渡" | "対外売上" | "課税売返" | "輸出売返" | "非課売返" | "非資売返" | "課税売倒" | "輸出売倒" | "非課売倒" | "非資売倒" | "課税売回" | "課対輸本" | "非対輸本" | "共対輸本" | "課対輸税" | "非対輸税" | "共対輸税" | "地消貨割" | "課対仕入" | "非対仕入" | "共対仕入" | "非課仕入" | "対外仕入" | "課対仕返" | "非対仕返" | "共対仕返" | "非課仕返" | "課売上一" | "課売上二" | "課売上三" | "課売上四" | "課売上五" | "課売上六" | "課対輸返" | "非対輸返" | "共対輸返" | "課売返一" | "課売返二" | "課売返三" | "課売返四" | "課売返五" | "課売返六") | No | Official freee field `tax_name`. |
| `tax_rate` | string ("tax_rate_5" | "tax_rate_8" | "tax_rate_10" | "tax_rate_r8" | "tax_rate_5_exempt_80" | "tax_rate_5_exempt_70" | "tax_rate_5_exempt_50" | "tax_rate_5_exempt_30" | "tax_rate_8_exempt_80" | "tax_rate_8_exempt_70" | "tax_rate_8_exempt_50" | "tax_rate_8_exempt_30" | "tax_rate_10_exempt_80" | "tax_rate_10_exempt_70" | "tax_rate_10_exempt_50" | "tax_rate_10_exempt_30" | "tax_rate_r8_exempt_80" | "tax_rate_r8_exempt_70" | "tax_rate_r8_exempt_50" | "tax_rate_r8_exempt_30") | No | Official freee field `tax_rate`. |
| `item_name` | string | No | Official freee field `item_name`. |
| `adjustment` | string ("only" | "without") | No | Official freee field `adjustment`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `start_date` | string | Yes | Official freee field `start_date`. |
| `partner_name` | string | No | Official freee field `partner_name`. |
| `section_name` | string | No | Official freee field `section_name`. |
| `cost_allocation` | string ("only" | "without") | No | Official freee field `cost_allocation`. |
| `account_item_name` | string | No | Official freee field `account_item_name`. |
| `segment_tag_1_name` | string | No | Official freee field `segment_tag_1_name`. |
| `segment_tag_2_name` | string | No | Official freee field `segment_tag_2_name`. |
| `segment_tag_3_name` | string | No | Official freee field `segment_tag_3_name`. |
| `approval_flow_status` | string ("without_in_progress" | "all") | No | Official freee field `approval_flow_status`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List HR Allowances

**Slug:** `FREEE_LIST_HR_ALLOWANCES`

List configured allowance types in a freee HR company, optionally filtered by frequency and active status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum allowance types to return on this page (1-100). |
| `frequency` | string ("salary" | "salary_monthly" | "salary_this_month" | "bonus") | No | Filter by allowance payment frequency; omit to include every frequency. |
| `is_active` | boolean | No | Filter by whether the allowance type is currently active. |
| `company_id` | integer | Yes | HR company ID whose allowance types to list. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List HR Deductions

**Slug:** `FREEE_LIST_HR_DEDUCTIONS`

List configured deduction types in a freee HR company, optionally filtered by frequency and active status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum deduction types to return on this page (1-100). |
| `frequency` | string ("salary" | "salary_monthly" | "salary_this_month" | "bonus") | No | Filter by deduction frequency; omit to return every frequency. |
| `is_active` | boolean | No | Filter by whether the deduction type is currently active. |
| `company_id` | integer | Yes | HR company ID whose deduction types to list. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List HR Groups

**Slug:** `FREEE_LIST_HR_GROUPS`

List the organizational groups and hierarchy configured in a freee HR company.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | HR company ID whose organizational groups to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List HR Positions

**Slug:** `FREEE_LIST_HR_POSITIONS`

List job positions configured in a freee HR company, including their IDs, codes, and names.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | HR company ID whose job positions to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Invoices

**Slug:** `FREEE_LIST_INVOICES`

List current invoices from the freee Invoice API. This does not use the retired freee Accounting invoices endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of invoices to return (maximum 100). |
| `offset` | integer | No | Zero-based result offset. limit plus offset cannot exceed 10,000. |
| `subject` | string | No | Invoice subject. |
| `company_id` | integer | Yes | freee company ID. |
| `deal_status` | string ("registered" | "unregistered") | No | Filter by accounting deal registration status. |
| `partner_ids` | array | No | Return invoices for up to three partner IDs. |
| `cancel_status` | string ("canceled" | "uncanceled") | No | Filter by cancellation status. |
| `invoice_number` | string | No | Exact invoice number. |
| `payment_status` | string ("settled" | "unsettled" | "canceled" | "unprocessed" | "failed") | No | Filter by payment status. |
| `sending_status` | string ("sent" | "unsent") | No | Filter by sending status. |
| `end_billing_date` | string | No | Latest billing date (YYYY-MM-DD). |
| `end_payment_date` | string | No | Latest payment due date (YYYY-MM-DD). |
| `start_billing_date` | string | No | Earliest billing date (YYYY-MM-DD). |
| `start_payment_date` | string | No | Earliest payment due date (YYYY-MM-DD). |
| `sales_management_origin` | boolean | No | Include documents created by freee Sales. Requires access to those documents. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Items

**Slug:** `FREEE_LIST_ITEMS`

List Items using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Official freee Accounting limit value. |
| `offset` | integer | No | Official freee Accounting offset value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |
| `end_update_date` | string | No | Official freee Accounting end update date value. |
| `start_update_date` | string | No | Official freee Accounting start update date value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Manual Journals

**Slug:** `FREEE_LIST_MANUAL_JOURNALS`

List Manual Journals using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Official freee field `limit`. |
| `offset` | integer | No | Official freee field `offset`. |
| `item_id` | integer | No | Official freee field `item_id`. |
| `adjustment` | string ("only" | "without") | No | Official freee field `adjustment`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `entry_side` | string ("credit" | "debit") | No | Official freee field `entry_side`. |
| `max_amount` | integer | No | Official freee field `max_amount`. |
| `min_amount` | integer | No | Official freee field `min_amount`. |
| `partner_id` | integer | No | Official freee field `partner_id`. |
| `ref_number` | string | No | Official freee field `ref_number`. |
| `section_id` | integer | No | Official freee field `section_id`. |
| `txn_number` | string | No | Official freee field `txn_number`. |
| `partner_code` | string | No | Official freee field `partner_code`. |
| `comment_status` | string ("posted_with_mention" | "raised_with_mention" | "resolved_with_mention" | "posted" | "raised" | "resolved" | "none") | No | Official freee field `comment_status`. |
| `end_issue_date` | string | No | Official freee field `end_issue_date`. |
| `account_item_id` | integer | No | Official freee field `account_item_id`. |
| `segment_1_tag_id` | integer | No | Official freee field `segment_1_tag_id`. |
| `segment_2_tag_id` | integer | No | Official freee field `segment_2_tag_id`. |
| `segment_3_tag_id` | integer | No | Official freee field `segment_3_tag_id`. |
| `start_issue_date` | string | No | Official freee field `start_issue_date`. |
| `comment_important` | boolean | No | Official freee field `comment_important`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Accounting Partners

**Slug:** `FREEE_LIST_PARTNERS`

List or search non-archived business partners in a freee Accounting company, returning one bounded page per call.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum partners to return on this page (1-3000). |
| `keyword` | string | No | Partial-match search across partner code, names, kana names, and shortcuts; space-separated terms use AND matching. |
| `company_id` | integer | Yes | Company ID whose partners to list. |
| `updated_to` | string | No | Inclusive latest update date in YYYY-MM-DD format. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `updated_from` | string | No | Inclusive earliest update date in YYYY-MM-DD format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Payment Requests

**Slug:** `FREEE_LIST_PAYMENT_REQUESTS`

List Payment Requests using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Official freee Accounting limit value. |
| `title` | string | No | Official freee Accounting title value. |
| `offset` | integer | No | Official freee Accounting offset value. |
| `status` | string ("draft" | "in_progress" | "approved" | "rejected" | "feedback" | "unsettled" | "settled") | No | Official freee Accounting status value. |
| `observing` | string ("ignore_observing" | "only_observing") | No | Official freee Accounting observing value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |
| `max_amount` | integer | No | Official freee Accounting max amount value. |
| `min_amount` | integer | No | Official freee Accounting min amount value. |
| `partner_id` | integer | No | Official freee Accounting partner id value. |
| `section_id` | integer | No | Official freee Accounting section id value. |
| `approver_id` | integer | No | Official freee Accounting approver id value. |
| `applicant_id` | integer | No | Official freee Accounting applicant id value. |
| `partner_code` | string | No | Official freee Accounting partner code value. |
| `partner_name` | string | No | Official freee Accounting partner name value. |
| `document_code` | string | No | Official freee Accounting document code value. |
| `end_issue_date` | string | No | Official freee Accounting end issue date value. |
| `payment_method` | string ("none" | "domestic_bank_transfer" | "abroad_bank_transfer" | "account_transfer" | "credit_card") | No | Official freee Accounting payment method value. |
| `end_payment_date` | string | No | Official freee Accounting end payment date value. |
| `start_issue_date` | string | No | Official freee Accounting start issue date value. |
| `application_number` | integer | No | Official freee Accounting application number value. |
| `start_payment_date` | string | No | Official freee Accounting start payment date value. |
| `end_application_date` | string | No | Official freee Accounting end application date value. |
| `approval_flow_route_id` | integer | No | Official freee Accounting approval flow route id value. |
| `start_application_date` | string | No | Official freee Accounting start application date value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Purchase Request Forms

**Slug:** `FREEE_LIST_PURCHASE_REQUEST_FORMS`

List Purchase Request Forms using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Official freee Accounting limit value. |
| `offset` | integer | No | Official freee Accounting offset value. |
| `status` | string ("draft" | "active" | "deleted") | No | Official freee Accounting status value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Purchase Requests

**Slug:** `FREEE_LIST_PURCHASE_REQUESTS`

List Purchase Requests using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Official freee Accounting limit value. |
| `offset` | integer | No | Official freee Accounting offset value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Quotations

**Slug:** `FREEE_LIST_QUOTATIONS`

List current quotations from the freee Invoice API. This does not use the retired freee Accounting quotations endpoint.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Number of quotations to return (maximum 100). |
| `offset` | integer | No | Zero-based result offset. limit plus offset cannot exceed 10,000. |
| `subject` | string | No | Quotation subject. |
| `company_id` | integer | Yes | freee company ID. |
| `partner_ids` | array | No | Return quotations for up to three partner IDs. |
| `cancel_status` | string ("canceled" | "uncanceled") | No | Filter by cancellation status. |
| `sending_status` | string ("sent" | "unsent") | No | Filter by sending status. |
| `quotation_number` | string | No | Exact quotation number. |
| `end_quotation_date` | string | No | Latest quotation date (YYYY-MM-DD). |
| `end_expiration_date` | string | No | Latest expiration date (YYYY-MM-DD). |
| `start_quotation_date` | string | No | Earliest quotation date (YYYY-MM-DD). |
| `start_expiration_date` | string | No | Earliest expiration date (YYYY-MM-DD). |
| `sales_management_origin` | boolean | No | Include documents created by freee Sales. Requires access to those documents. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Receipts

**Slug:** `FREEE_LIST_RECEIPTS`

List Receipts using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Official freee field `limit`. |
| `number` | integer | No | Official freee field `number`. |
| `offset` | integer | No | Official freee field `offset`. |
| `category` | string ("all" | "without_deal" | "with_expense_application_line" | "with_deal" | "ignored") | No | Official freee field `category`. |
| `end_date` | string | Yes | Official freee field `end_date`. |
| `user_name` | string | No | Official freee field `user_name`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `start_date` | string | Yes | Official freee field `start_date`. |
| `comment_type` | string ("posted" | "raised" | "resolved") | No | Official freee field `comment_type`. |
| `comment_important` | boolean | No | Official freee field `comment_important`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Segment Tags

**Slug:** `FREEE_LIST_SEGMENT_TAGS`

セグメントタグ一覧の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | 取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 500) |
| `offset` | integer | No | 取得レコードのオフセット (デフォルト: 0) |
| `company_id` | integer | Yes | 取得対象の事業所ID |
| `segment_id` | integer | Yes | セグメント区分（1、2、3のいずれか）。利用できる区分は事業所の契約プランによって異なります。 |
| `end_update_date` | string | No | 更新日で絞り込む終了日 (yyyy-mm-dd, JST)。指定日を含む、それ以前に更新されたセグメントタグを対象にします。 |
| `start_update_date` | string | No | 更新日で絞り込む開始日 (yyyy-mm-dd, JST)。指定日を含む、それ以降に更新されたセグメントタグを対象にします。 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tags

**Slug:** `FREEE_LIST_TAGS`

List Tags using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Official freee field `limit`. |
| `offset` | integer | No | Official freee field `offset`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `end_update_date` | string | No | Official freee field `end_update_date`. |
| `start_update_date` | string | No | Official freee field `start_update_date`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Tax Codes

**Slug:** `FREEE_LIST_TAX_CODES`

List Tax Codes using the official freee Accounting API contract.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Transfers

**Slug:** `FREEE_LIST_TRANSFERS`

List Transfers using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Official freee Accounting limit value. |
| `offset` | integer | No | Official freee Accounting offset value. |
| `end_date` | string | No | Official freee Accounting end date value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |
| `start_date` | string | No | Official freee Accounting start date value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List User Matchers

**Slug:** `FREEE_LIST_USER_MATCHERS`

自動登録ルール一覧の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `act` | integer ("0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12") | No | 登録タイプで絞込 * 0: 取引を推測する(manual_standard) * 1: 取引を登録する(auto_standard) * 2: 振替を推測する(manual_transfer) * 3: 振替を登録する(auto_transfer) * 4: 無視する取引を登録する(auto_ignore) * 5: 取引テンプレートを推測する(manual_template) * 6: 未決済取引の消込を推測する(manual_scrub) * 7: 未決済取引の消込を登録する(auto_scrub) * 8: 一括振込ファイル消込を推測する(manual_output_zengin_scrub) * 9: 一括振込ファイル消込を登録する(auto_output_zengin_scrub) * 10: 無視する取引を推測する(manual_ignore) * 11: プライベート取引を推測する(manual_private) * 12: プライベート取引を登録する(auto_private) |
| `limit` | integer | No | 取得レコードの件数 (デフォルト: 30, 最大: 100) |
| `active` | string ("active" | "inactive" | "all") | No | 有効/無効/全てで絞込 (有効: active, 無効: inactive, 全て: all)。未指定の場合は有効なルールのみが返ります。 |
| `offset` | integer | No | 取得レコードのオフセット (デフォルト: 0)。offsetはlimitの倍数である必要があります。 |
| `company_id` | integer | Yes | 事業所ID |
| `created_by` | integer ("0" | "1") | No | 作成経由で絞込 * 0: ユーザーが作成(user) * 1: freeeが作成(freee) |
| `max_amount` | integer | No | 最大金額で絞込 (単位: 円)。ルールに設定された最大金額(max_amount)が指定値以下のルールを返します。 |
| `min_amount` | integer | No | 最小金額で絞込 (単位: 円)。ルールに設定された最小金額(min_amount)が指定値以上のルールを返します。 |
| `walletable` | string | No | 口座名で絞込 (完全一致)。指定した名前の口座が事業所に存在しない場合は空の一覧が返ります。 |
| `description` | string | No | 説明文で絞込 (部分一致) |
| `max_priority` | integer | No | 最大優先度で絞込。優先度(priority)が指定値以下のルールを返します。 |
| `min_priority` | integer | No | 最小優先度で絞込。優先度(priority)が指定値以上のルールを返します。 |
| `card_label_id` | integer | No | カードラベルIDで絞込 |
| `entry_side_str` | string ("income" | "expense") | No | 入金/出金で絞込 (入金: income, 出金: expense) |
| `max_corrected_wallet_txn_count` | integer | No | 最大正答件数で絞込。適用明細数(corrected_wallet_txn_count)が指定値以下のルールを返します。 |
| `min_corrected_wallet_txn_count` | integer | No | 最小正答件数で絞込。適用明細数(corrected_wallet_txn_count)が指定値以上のルールを返します。 |
| `max_corrected_wallet_txn_count_percentage` | integer | No | 最大正答率で絞込 (単位: パーセント)。適用率(corrected_wallet_txn_count_percentage)が指定値以下のルールを返します。 |
| `min_corrected_wallet_txn_count_percentage` | integer | No | 最小正答率で絞込 (単位: パーセント)。適用率(corrected_wallet_txn_count_percentage)が指定値以上のルールを返します。 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `FREEE_LIST_USERS`

事業所に所属するユーザー一覧の取得

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | 取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 3000) |
| `company_id` | integer | Yes | 事業所ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Walletables

**Slug:** `FREEE_LIST_WALLETABLES`

List Walletables using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("bank_account" | "credit_card" | "wallet") | No | Official freee field `type`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `with_balance` | boolean | No | Official freee field `with_balance`. |
| `end_update_date` | string | No | Official freee field `end_update_date`. |
| `with_sync_status` | boolean | No | Official freee field `with_sync_status`. |
| `start_update_date` | string | No | Official freee field `start_update_date`. |
| `with_last_synced_at` | boolean | No | Official freee field `with_last_synced_at`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Wallet Transactions

**Slug:** `FREEE_LIST_WALLET_TRANSACTIONS`

List Wallet Transactions using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Official freee Accounting limit value. |
| `offset` | integer | No | Official freee Accounting offset value. |
| `end_date` | string | No | Official freee Accounting end date value. |
| `sort_type` | string | No | Official freee Accounting sort type value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |
| `entry_side` | string ("income" | "expense") | No | Official freee Accounting entry side value. |
| `start_date` | string | No | Official freee Accounting start date value. |
| `walletable_id` | integer | No | Official freee Accounting walletable id value. |
| `walletable_type` | string ("bank_account" | "credit_card" | "wallet") | No | Official freee Accounting walletable type value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Post Yearend Adjustment Housing Loan

**Slug:** `FREEE_POST_YEAREND_ADJUSTMENT_HOUSING_LOAN`

Call the official freee HR operation to post yearend adjustment housing loan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Path parameter `year` from the freee HR API. |
| `company_id` | integer | Yes | Request body field `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |
| `housing_loan` | object | Yes | Request body field `housing_loan` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Post Yearend Adjustment Insurances

**Slug:** `FREEE_POST_YEAREND_ADJUSTMENT_INSURANCES`

Call the official freee HR operation to post yearend adjustment insurances.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Path parameter `year` from the freee HR API. |
| `insurance` | object | Yes | Request body field `insurance` from the freee HR API. |
| `company_id` | integer | Yes | Request body field `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Put Yearend Adjustment Dependents

**Slug:** `FREEE_PUT_YEAREND_ADJUSTMENT_DEPENDENTS`

Call the official freee HR operation to put yearend adjustment dependents.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Path parameter `year` from the freee HR API. |
| `company_id` | integer | Yes | Request body field `company_id` from the freee HR API. |
| `dependents` | array | Yes | Request body field `dependents` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Put Yearend Adjustment Employee

**Slug:** `FREEE_PUT_YEAREND_ADJUSTMENT_EMPLOYEE`

Call the official freee HR operation to put yearend adjustment employee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Path parameter `year` from the freee HR API. |
| `employee` | object | Yes | Request body field `employee` from the freee HR API. |
| `company_id` | integer | Yes | Request body field `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Put Yearend Adjustment Housing Loan

**Slug:** `FREEE_PUT_YEAREND_ADJUSTMENT_HOUSING_LOAN`

Call the official freee HR operation to put yearend adjustment housing loan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Path parameter `id` from the freee HR API. |
| `year` | integer | Yes | Path parameter `year` from the freee HR API. |
| `company_id` | integer | Yes | Request body field `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |
| `housing_loan` | object | Yes | Request body field `housing_loan` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Put Yearend Adjustment Housing Loan Deduction

**Slug:** `FREEE_PUT_YEAREND_ADJUSTMENT_HOUSING_LOAN_DEDUCTION`

Call the official freee HR operation to put yearend adjustment housing loan deduction.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Path parameter `year` from the freee HR API. |
| `company_id` | integer | Yes | Request body field `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |
| `housing_loan_deduction` | integer | Yes | Request body field `housing_loan_deduction` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Put Yearend Adjustment Insurances

**Slug:** `FREEE_PUT_YEAREND_ADJUSTMENT_INSURANCES`

Call the official freee HR operation to put yearend adjustment insurances.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Path parameter `id` from the freee HR API. |
| `year` | integer | Yes | Path parameter `year` from the freee HR API. |
| `insurance` | object | Yes | Request body field `insurance` from the freee HR API. |
| `company_id` | integer | Yes | Request body field `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Put Yearend Adjustment Payroll And Bonus

**Slug:** `FREEE_PUT_YEAREND_ADJUSTMENT_PAYROLL_AND_BONUS`

Call the official freee HR operation to put yearend adjustment payroll and bonus.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Path parameter `year` from the freee HR API. |
| `company_id` | integer | Yes | Request body field `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |
| `payroll_and_bonus` | object | Yes | Request body field `payroll_and_bonus` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Put Yearend Adjustment Previous Job

**Slug:** `FREEE_PUT_YEAREND_ADJUSTMENT_PREVIOUS_JOB`

Call the official freee HR operation to put yearend adjustment previous job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Path parameter `year` from the freee HR API. |
| `company_id` | integer | Yes | Request body field `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |
| `previous_job` | object | Yes | Request body field `previous_job` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Accounting Section

**Slug:** `FREEE_UPDATE_ACCOUNTING_SECTION`

Update Accounting Section using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `code` | string | No | Section code. Omitting this field or sending null clears the existing code; send the current value to preserve it. |
| `name` | string | Yes | Official freee Accounting name value. |
| `long_name` | string | No | Official freee Accounting long name value. |
| `parent_id` | integer | No | Official freee Accounting parent id value. |
| `shortcut1` | string | No | Official freee Accounting shortcut1 value. |
| `shortcut2` | string | No | Official freee Accounting shortcut2 value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Account Item

**Slug:** `FREEE_UPDATE_ACCOUNT_ITEM`

勘定科目の更新

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | 事業所ID |
| `account_item` | object | Yes | Provider body field `account_item`. |
| `account_item_id` | integer | Yes | 勘定科目ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Approval Request

**Slug:** `FREEE_UPDATE_APPROVAL_REQUEST`

Update Approval Request using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `draft` | boolean | Yes | Official freee field `draft`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `approver_id` | integer | No | Official freee field `approver_id`. |
| `request_items` | array | Yes | Official freee field `request_items`. |
| `application_date` | string | No | Official freee field `application_date`. |
| `applicant_group_id` | integer | No | Official freee field `applicant_group_id`. |
| `approval_flow_group_id` | integer | No | Official freee field `approval_flow_group_id`. |
| `approval_flow_route_id` | integer | Yes | Official freee field `approval_flow_route_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Approval Requests Monthly Attendance

**Slug:** `FREEE_UPDATE_APPROVAL_REQUESTS_MONTHLY_ATTENDANCE`

Update a monthly-attendance request after it has been returned with feedback. To edit an approved request, first use force_feedback on its approval action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 月次勤怠締め申請ID |
| `company_id` | integer | Yes | 事業所ID（必須） |
| `approver_id` | integer | No | 承認者のユーザーID |
| `approval_flow_route_id` | integer | Yes | 申請経路ID（必須） |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Approval Requests Overtime Work

**Slug:** `FREEE_UPDATE_APPROVAL_REQUESTS_OVERTIME_WORK`

Update an overtime-work request after it has been returned with feedback. To edit an approved request, first use force_feedback on its approval action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 残業申請ID |
| `payload` | object | Yes | JSON request body defined by the freee HR OpenAPI contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Approval Requests Paid Holiday

**Slug:** `FREEE_UPDATE_APPROVAL_REQUESTS_PAID_HOLIDAY`

Update a paid-holiday request after it has been returned with feedback. To edit an approved request, first use force_feedback on its approval action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 有給休暇申請ID |
| `payload` | string | Yes | JSON request body defined by the freee HR OpenAPI contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Approval Requests Special Holiday

**Slug:** `FREEE_UPDATE_APPROVAL_REQUESTS_SPECIAL_HOLIDAY`

Update a special-holiday request after it has been returned with feedback. To edit an approved request, first use force_feedback on its approval action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 特別休暇申請ID |
| `end_at` | string | No | 取得予定終了時間（条件付き必須） 取得単位が半休、時間休の場合は必須 |
| `comment` | string | No | 申請理由 |
| `start_at` | string | No | 取得予定開始時間（条件付き必須） 取得単位が半休、時間休の場合は必須 |
| `company_id` | integer | Yes | 事業所ID（必須） |
| `approver_id` | integer | No | 承認者のユーザーID |
| `target_date` | string | Yes | 対象日（必須） |
| `holiday_type` | string ("full" | "half" | "morning" | "afternoon" | "hour") | Yes | 取得単位（必須）（full:全休、half:半休、morning:午前休、 afternoon:午後休、hour:時間休） |
| `approval_flow_route_id` | integer | Yes | 申請経路ID（必須） |
| `special_holiday_setting_id` | integer | Yes | 特別休暇設定ID（必須） |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Approval Requests Work Time

**Slug:** `FREEE_UPDATE_APPROVAL_REQUESTS_WORK_TIME`

Update a work-time correction request after it has been returned with feedback. To edit an approved request, first use force_feedback on its approval action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 勤務時間修正申請ID |
| `comment` | string | No | 申請理由 |
| `company_id` | integer | Yes | 事業所ID（必須） |
| `approver_id` | integer | No | 承認者のユーザーID |
| `target_date` | string | Yes | 対象日（必須） |
| `work_records` | array | No | 勤務時間のリスト |
| `break_records` | array | No | 休憩時間のリスト |
| `lateness_mins` | integer | No | 遅刻分の時間（分単位） |
| `clear_work_time` | boolean | No | false: 勤務時間を修正する true: 勤務時間を削除する 勤務時間を削除する場合は以下のパラメータは指定しないでください。 - work_records - lateness_mins - early_leaving_mins - break_records |
| `early_leaving_mins` | integer | No | 早退分の時間（分単位） |
| `approval_flow_route_id` | integer | Yes | 申請経路ID（必須） |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Current User

**Slug:** `FREEE_UPDATE_CURRENT_USER`

ログインユーザーの更新

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `last_name` | string | No | 氏名（姓） (20文字以内)。キーを省略した場合は更新されません。空文字を指定すると未設定になります。 |
| `first_name` | string | No | 氏名（名） (20文字以内)。キーを省略した場合は更新されません。空文字を指定すると未設定になります。 |
| `display_name` | string | No | 表示名 (20文字以内)。キーを省略した場合は更新されません。空文字を指定すると未設定になります。 |
| `last_name_kana` | string | No | 氏名（カナ・姓） (20文字以内)。キーを省略した場合は更新されません。空文字を指定すると未設定になります。 |
| `first_name_kana` | string | No | 氏名（カナ・名） (20文字以内)。キーを省略した場合は更新されません。空文字を指定すると未設定になります。 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Deal

**Slug:** `FREEE_UPDATE_DEAL`

取引（収入・支出）の更新

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("income" | "expense") | Yes | 収支区分 (収入: income, 支出: expense) |
| `deal_id` | integer | Yes | 取引ID |
| `details` | array | Yes | 取引の明細行（最大100行）。detailsに含まれない既存の取引行は削除されます。更新後も残したい行は、必ず取引行ID（id）を指定してdetailsに含めてください。 |
| `due_date` | string | No | 支払期日(yyyy-mm-dd) |
| `company_id` | integer | Yes | 事業所ID |
| `issue_date` | string | Yes | 発生日 (yyyy-mm-dd) |
| `partner_id` | integer | No | 取引先ID。partner_codeと同時に指定することはできません。 |
| `ref_number` | string | No | 管理番号 |
| `receipt_ids` | array | No | ファイルボックス（証憑ファイル）ID（配列）。指定した場合、取引に紐づくファイルはこの配列の内容で置き換えられます。指定しない場合は変更されません。 |
| `partner_code` | string | No | 取引先コード。利用するには事業所の設定で取引先コードの利用を有効にする必要があります。partner_idと同時に指定することはできません。 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Deal Payment

**Slug:** `FREEE_UPDATE_DEAL_PAYMENT`

取引（収入・支出）の支払行の更新

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | 支払日 (yyyy-mm-dd) |
| `amount` | integer | Yes | 支払金額（円） |
| `deal_id` | integer | Yes | 取引ID |
| `company_id` | integer | Yes | 事業所ID |
| `payment_id` | integer | Yes | 支払行ID（取引のレスポンスのpayments配列のid） |
| `from_walletable_id` | integer | Yes | 口座ID（from_walletable_typeがprivate_account_itemの場合は勘定科目ID） |
| `from_walletable_type` | string ("bank_account" | "credit_card" | "wallet" | "private_account_item") | Yes | 口座区分 (銀行口座: bank_account, クレジットカード: credit_card, 現金: wallet, プライベート資金: private_account_item) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Deal Renew

**Slug:** `FREEE_UPDATE_DEAL_RENEW`

Update Deal Renew using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `details` | array | Yes | Official freee field `details`. |
| `renew_id` | integer | Yes | Official freee field `renew_id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `update_date` | string | Yes | Official freee field `update_date`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Employee

**Slug:** `FREEE_UPDATE_EMPLOYEE`

Update Employee through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 従業員ID |
| `payload` | object | Yes | JSON request body defined by the freee HR OpenAPI contract. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Employee Allowance Rules

**Slug:** `FREEE_UPDATE_EMPLOYEE_ALLOWANCE_RULES`

Call the official freee HR operation to update employee allowance rules.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Request body field `year` from the freee HR API. |
| `month` | integer | Yes | Request body field `month` from the freee HR API. |
| `company_id` | integer | Yes | Request body field `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |
| `employee_allowance_rule` | object | Yes | Request body field `employee_allowance_rule` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Employee Bank Account Rule

**Slug:** `FREEE_UPDATE_EMPLOYEE_BANK_ACCOUNT_RULE`

Call the official freee HR operation to update employee bank account rule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Request body field `year` from the freee HR API. |
| `month` | integer | Yes | Request body field `month` from the freee HR API. |
| `company_id` | integer | Yes | Request body field `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |
| `employee_bank_account_rule` | object | Yes | Request body field `employee_bank_account_rule` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Employee Basic Pay Rule

**Slug:** `FREEE_UPDATE_EMPLOYEE_BASIC_PAY_RULE`

Call the official freee HR operation to update employee basic pay rule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Request body field `year` from the freee HR API. |
| `month` | integer | Yes | Request body field `month` from the freee HR API. |
| `company_id` | integer | Yes | Request body field `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |
| `employee_basic_pay_rule` | object | Yes | Request body field `employee_basic_pay_rule` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Employee Deduction Rules

**Slug:** `FREEE_UPDATE_EMPLOYEE_DEDUCTION_RULES`

Update Employee Deduction Rules through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | 更新対象の控除ルールを判定する締め年 |
| `month` | integer | Yes | Payroll closing calendar month (1-12) of the deduction rules to update. For January 2022 pay on a following-month schedule, the closing month is December 2021. |
| `payload` | object | Yes | JSON request body defined by the freee HR OpenAPI contract. |
| `company_id` | integer | Yes | 事業所ID |
| `employee_id` | integer | Yes | 従業員ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Employee Health Insurance Rule

**Slug:** `FREEE_UPDATE_EMPLOYEE_HEALTH_INSURANCE_RULE`

Update Employee Health Insurance Rule through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payload` | object | Yes | JSON request body defined by the freee HR OpenAPI contract. |
| `employee_id` | integer | Yes | 従業員ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Employee Payroll Statement Remark

**Slug:** `FREEE_UPDATE_EMPLOYEE_PAYROLL_STATEMENT_REMARK`

給与明細の備考の更新

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | 更新対象の年 |
| `month` | integer | Yes | 更新対象の月 |
| `remark` | object | Yes | Value accepted by freee HR. |
| `company_id` | integer | Yes | 事業所ID |
| `employee_id` | integer | Yes | 従業員ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Employee Profile Rule

**Slug:** `FREEE_UPDATE_EMPLOYEE_PROFILE_RULE`

Update Employee Profile Rule through the freee HR API.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payload` | object | Yes | JSON request body defined by the freee HR OpenAPI contract. |
| `employee_id` | integer | Yes | 従業員ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Employees Attendance Tags

**Slug:** `FREEE_UPDATE_EMPLOYEES_ATTENDANCE_TAGS`

Replace an employee's attendance tags for a date. freee rejects changes after the corresponding month summary has been finalized.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | 更新対象年月日(YYYY-MM-DD)(例:2018-08-01) |
| `payload` | object | Yes | JSON request body defined by the freee HR OpenAPI contract. |
| `employee_id` | integer | Yes | 従業員ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Employees Attendance Tag Summaries

**Slug:** `FREEE_UPDATE_EMPLOYEES_ATTENDANCE_TAG_SUMMARIES`

勤怠タグ月次サマリの更新

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | 勤怠タグサマリを更新したい年 |
| `month` | integer | Yes | 勤怠タグサマリを更新したい月 |
| `company_id` | integer | Yes | 事業所ID |
| `employee_id` | integer | Yes | 従業員ID |
| `employee_attendance_tag_summaries` | array | Yes | 更新対象の勤怠タグサマリのリスト |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Employee Welfare Pension Insurance Rule

**Slug:** `FREEE_UPDATE_EMPLOYEE_WELFARE_PENSION_INSURANCE_RULE`

従業員の厚生年金保険の更新

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | 更新対象年（必須） |
| `month` | integer | Yes | 更新対象月（必須） 締め日支払い日設定が翌月払いの従業員情報の場合は、 指定したmonth + 1の値が更新されます。 翌月払いの従業員の2022/01の従業員情報を更新する場合は、year=2021,month=12を指定してください。 |
| `company_id` | integer | Yes | 更新対象事業所ID（必須） |
| `employee_id` | integer | Yes | 従業員ID |
| `employee_welfare_pension_insurance_rule` | object | Yes | Value accepted by freee HR. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Employee Work Record

**Slug:** `FREEE_UPDATE_EMPLOYEE_WORK_RECORD`

Update an employee's daily work record. freee rejects changes after the corresponding month summary has been finalized.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `date` | string | Yes | Path parameter `date` from the freee HR API. |
| `note` | string | No | Request body field `note` from the freee HR API. |
| `company_id` | integer | No | Request body field `company_id` from the freee HR API. |
| `is_absence` | boolean | No | Request body field `is_absence` from the freee HR API. |
| `clock_in_at` | string | No | Request body field `clock_in_at` from the freee HR API. |
| `day_pattern` | string ("normal_day" | "prescribed_holiday" | "legal_holiday") | No | Request body field `day_pattern` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |
| `clock_out_at` | string | No | Request body field `clock_out_at` from the freee HR API. |
| `paid_holiday` | integer ("0" | "1") | No | Request body field `paid_holiday` from the freee HR API. |
| `break_records` | array | No | Request body field `break_records` from the freee HR API. |
| `lateness_mins` | integer | No | Request body field `lateness_mins` from the freee HR API. |
| `paid_holidays` | array | No | Request body field `paid_holidays` from the freee HR API. |
| `special_holiday` | integer ("0" | "1") | No | Request body field `special_holiday` from the freee HR API. |
| `normal_work_mins` | integer | No | Request body field `normal_work_mins` from the freee HR API. |
| `early_leaving_mins` | integer | No | Request body field `early_leaving_mins` from the freee HR API. |
| `work_record_segments` | array | No | Request body field `work_record_segments` from the freee HR API. |
| `half_paid_holiday_mins` | integer | No | Request body field `half_paid_holiday_mins` from the freee HR API. |
| `normal_work_clock_in_at` | string | No | Request body field `normal_work_clock_in_at` from the freee HR API. |
| `hourly_paid_holiday_mins` | integer | No | Request body field `hourly_paid_holiday_mins` from the freee HR API. |
| `normal_work_clock_out_at` | string | No | Request body field `normal_work_clock_out_at` from the freee HR API. |
| `use_attendance_deduction` | boolean | No | Request body field `use_attendance_deduction` from the freee HR API. |
| `use_default_work_pattern` | boolean | No | Request body field `use_default_work_pattern` from the freee HR API. |
| `half_special_holiday_mins` | integer | No | Request body field `half_special_holiday_mins` from the freee HR API. |
| `special_holiday_setting_id` | integer | No | Request body field `special_holiday_setting_id` from the freee HR API. |
| `hourly_special_holiday_mins` | integer | No | Request body field `hourly_special_holiday_mins` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Employee Work Record Summary

**Slug:** `FREEE_UPDATE_EMPLOYEE_WORK_RECORD_SUMMARY`

Call the official freee HR operation to update employee work record summary.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `year` | integer | Yes | Path parameter `year` from the freee HR API. |
| `month` | integer | Yes | Path parameter `month` from the freee HR API. |
| `work_days` | number | No | Request body field `work_days` from the freee HR API. |
| `company_id` | integer | Yes | Request body field `company_id` from the freee HR API. |
| `employee_id` | integer | Yes | Path parameter `employee_id` from the freee HR API. |
| `num_absences` | number | No | Request body field `num_absences` from the freee HR API. |
| `total_work_mins` | integer | No | Request body field `total_work_mins` from the freee HR API. |
| `num_paid_holidays` | number | No | Request body field `num_paid_holidays` from the freee HR API. |
| `total_lateness_mins` | integer | No | Request body field `total_lateness_mins` from the freee HR API. |
| `work_days_on_weekdays` | number | No | Request body field `work_days_on_weekdays` from the freee HR API. |
| `total_normal_work_mins` | integer | No | Request body field `total_normal_work_mins` from the freee HR API. |
| `total_holiday_work_mins` | integer | No | Request body field `total_holiday_work_mins` from the freee HR API. |
| `total_early_leaving_mins` | integer | No | Request body field `total_early_leaving_mins` from the freee HR API. |
| `total_overtime_work_mins` | integer | No | Request body field `total_overtime_work_mins` from the freee HR API. |
| `total_shortage_work_mins` | integer | No | Request body field `total_shortage_work_mins` from the freee HR API. |
| `total_latenight_work_mins` | integer | No | Request body field `total_latenight_work_mins` from the freee HR API. |
| `num_absences_for_deduction` | number | No | Request body field `num_absences_for_deduction` from the freee HR API. |
| `work_days_on_legal_holidays` | number | No | Request body field `work_days_on_legal_holidays` from the freee HR API. |
| `total_excess_statutory_work_mins` | integer | No | Request body field `total_excess_statutory_work_mins` from the freee HR API. |
| `work_days_on_prescribed_holidays` | number | No | Request body field `work_days_on_prescribed_holidays` from the freee HR API. |
| `total_lateness_mins_for_deduction` | integer | No | Request body field `total_lateness_mins_for_deduction` from the freee HR API. |
| `total_prescribed_holiday_work_mins` | integer | No | Request body field `total_prescribed_holiday_work_mins` from the freee HR API. |
| `total_early_leaving_mins_for_deduction` | integer | No | Request body field `total_early_leaving_mins_for_deduction` from the freee HR API. |
| `total_actual_excess_statutory_work_mins` | integer | No | Request body field `total_actual_excess_statutory_work_mins` from the freee HR API. |
| `total_deemed_paid_excess_statutory_work_mins` | integer | No | Request body field `total_deemed_paid_excess_statutory_work_mins` from the freee HR API. |
| `total_deemed_paid_overtime_except_normal_work_mins` | integer | No | Request body field `total_deemed_paid_overtime_except_normal_work_mins` from the freee HR API. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Expense Application

**Slug:** `FREEE_UPDATE_EXPENSE_APPLICATION`

Update Expense Application using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `draft` | boolean | No | Official freee field `draft`. |
| `title` | string | Yes | Official freee field `title`. |
| `tag_ids` | array | No | Official freee field `tag_ids`. |
| `parent_id` | integer | No | Official freee field `parent_id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `issue_date` | string | No | Official freee field `issue_date`. |
| `section_id` | integer | No | Official freee field `section_id`. |
| `approver_id` | integer | No | Official freee field `approver_id`. |
| `description` | string | No | Official freee field `description`. |
| `parent_type` | string | No | Official freee field `parent_type`. |
| `purchase_lines` | array | No | Official freee field `purchase_lines`. |
| `segment_1_tag_id` | integer | No | Official freee field `segment_1_tag_id`. |
| `segment_2_tag_id` | integer | No | Official freee field `segment_2_tag_id`. |
| `segment_3_tag_id` | integer | No | Official freee field `segment_3_tag_id`. |
| `applicant_group_id` | integer | No | Official freee field `applicant_group_id`. |
| `approval_flow_group_id` | integer | No | Official freee field `approval_flow_group_id`. |
| `approval_flow_route_id` | integer | No | Official freee field `approval_flow_route_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Expense Application Currency

**Slug:** `FREEE_UPDATE_EXPENSE_APPLICATION_CURRENCY`

Update Expense Application Currency using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `code` | string | Yes | Official freee Accounting code value. |
| `name` | string | Yes | Official freee Accounting name value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |
| `description` | string | No | Official freee Accounting description value. |
| `search_status` | string ("usable" | "unusable") | Yes | Official freee Accounting search status value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Expense Application Form

**Slug:** `FREEE_UPDATE_EXPENSE_APPLICATION_FORM`

Update Expense Application Form using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `company_id` | integer | Yes | Official freee Accounting company id value. |
| `tag_setting` | string ("optional" | "required" | "disable") | Yes | Official freee Accounting tag setting value. |
| `use_currency` | boolean | Yes | Official freee Accounting use currency value. |
| `default_title` | string | Yes | Official freee Accounting default title value. |
| `section_setting` | string ("optional" | "required") | Yes | Official freee Accounting section setting value. |
| `observer_addition` | string ("disable" | "enable") | Yes | Official freee Accounting observer addition value. |
| `description_setting` | string ("optional" | "required") | Yes | Official freee Accounting description setting value. |
| `line_template_setting` | string ("optional" | "required" | "disable") | Yes | Official freee Accounting line template setting value. |
| `segment_1_tag_setting` | string ("optional" | "required" | "disable") | Yes | Official freee Accounting segment 1 tag setting value. |
| `segment_2_tag_setting` | string ("optional" | "required" | "disable") | Yes | Official freee Accounting segment 2 tag setting value. |
| `segment_3_tag_setting` | string ("optional" | "required" | "disable") | Yes | Official freee Accounting segment 3 tag setting value. |
| `commuter_pass_deduction` | string ("disable" | "enable") | Yes | Official freee Accounting commuter pass deduction value. |
| `allow_modify_on_approval` | boolean | Yes | Official freee Accounting allow modify on approval value. |
| `default_flow_route_src_id` | string | Yes | Official freee Accounting default flow route src id value. |
| `receipt_partner_name_setting` | string ("optional" | "required" | "disable") | Yes | Official freee Accounting receipt partner name setting value. |
| `require_parent_purchase_request` | boolean | Yes | Official freee Accounting require parent purchase request value. |
| `auto_calculation_amount_fraction` | string ("omit" | "round_up" | "round") | Yes | Official freee Accounting auto calculation amount fraction value. |
| `allow_modify_parent_application_by_admin` | boolean | Yes | Official freee Accounting allow modify parent application by admin value. |
| `allow_modify_parent_application_by_approver` | boolean | Yes | Official freee Accounting allow modify parent application by approver value. |
| `allow_modify_parent_application_by_applicant` | boolean | Yes | Official freee Accounting allow modify parent application by applicant value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Expense Application Line Template

**Slug:** `FREEE_UPDATE_EXPENSE_APPLICATION_LINE_TEMPLATE`

経費科目の更新

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | 経費科目名 (1000文字以内) |
| `item_id` | integer | No | 経費科目に紐付ける品目のID。指定した事業所に存在する品目のIDのみ指定可能です（存在しない場合は400エラー）。勘定科目と品目の紐付けが設定されている事業所では、指定した勘定科目に紐付く品目のみ指定可能です。品目IDは /items のAPIから取得可能です。なお、レスポンスに品目IDは含まれません。 |
| `tax_code` | integer | Yes | 経費科目に紐付ける税区分コード（税区分のdisplay_categoryがtax_5: 5%表示の税区分, tax_r8: 軽減税率8%表示の税区分に該当するtax_codeのみ利用可能です。それ以外のtax_codeを指定した場合は400エラーになります。税区分のdisplay_categoryは /taxes/companies/{company_id}のAPIから取得可能です。） |
| `company_id` | integer | Yes | 事業所ID |
| `description` | string | No | 経費科目の説明 (1000文字以内) |
| `account_item_id` | integer | Yes | 経費科目に紐付ける勘定科目のID。指定した事業所に存在する勘定科目のIDのみ指定可能です（存在しない場合は400エラー）。勘定科目IDは /account_items のAPIから取得可能です。 |
| `line_description` | string | No | 内容の補足 (1000文字以内)。経費申請の作成時に内容欄へ何を入力すべきかを申請者に案内する文言 |
| `required_receipt` | boolean | No | 添付ファイルの必須/任意 falseを指定した時は申請時の領収書の添付を任意とします。 trueを指定した時は申請時の領収書の添付を必須とします。 未指定の時は申請時の領収書の添付を任意とします。 |
| `expense_application_line_template_id` | integer | Yes | 経費科目ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Expense Application Parent Requests

**Slug:** `FREEE_UPDATE_EXPENSE_APPLICATION_PARENT_REQUESTS`

Link an approved general request to an in-progress or approved expense application, or unlink the current request by sending parent_id as null.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `parent_id` | string | Yes | ID of the approved general request to link to this expense application. Send null to remove the current link. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update HR Group

**Slug:** `FREEE_UPDATE_HR_GROUP`

Update an existing organizational group in a freee HR company. The supplied name replaces the existing name. Code must be supplied explicitly: pass a string to set or preserve the code, or null to clear it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Required replacement group code: pass a 1-255 character string to set or preserve it, or pass null to clear it. |
| `name` | string | Yes | Replacement group name, 1-255 characters. |
| `group_id` | integer | Yes | Group ID to update. |
| `company_id` | integer | Yes | HR company ID that owns the group. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Item

**Slug:** `FREEE_UPDATE_ITEM`

Update Item using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `code` | string | No | Item code. Omitting this field or sending null clears the existing code; send the current value to preserve it. |
| `name` | string | Yes | Official freee Accounting name value. |
| `shortcut1` | string | No | Official freee Accounting shortcut1 value. |
| `shortcut2` | string | No | Official freee Accounting shortcut2 value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Manual Journal

**Slug:** `FREEE_UPDATE_MANUAL_JOURNAL`

Update Manual Journal using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `details` | array | Yes | Official freee field `details`. |
| `adjustment` | boolean | No | Official freee field `adjustment`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `issue_date` | string | Yes | Official freee field `issue_date`. |
| `ref_number` | string | No | Official freee field `ref_number`. |
| `receipt_ids` | array | No | Official freee field `receipt_ids`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Accounting Partner

**Slug:** `FREEE_UPDATE_PARTNER`

Update the name, availability, and common contact fields of an existing freee Accounting partner.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique partner display name, up to 255 characters; required by freee even for a partial update. |
| `email` | string | No | Replacement partner contact email address. |
| `phone` | string | No | Replacement partner contact phone number. |
| `available` | boolean | No | Whether the partner remains available in Accounting input suggestions. |
| `long_name` | string | No | Formal legal or trade name, up to 255 characters. |
| `company_id` | integer | Yes | Company ID that owns the partner. |
| `partner_id` | integer | Yes | Partner ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Partner By Code

**Slug:** `FREEE_UPDATE_PARTNER_BY_CODE`

Update Partner By Code using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Official freee field `code`. |
| `name` | string | Yes | Official freee field `name`. |
| `email` | string | No | Official freee field `email`. |
| `phone` | string | No | Official freee field `phone`. |
| `org_code` | integer ("1" | "2") | No | Official freee field `org_code`. |
| `available` | boolean | No | Official freee field `available`. |
| `long_name` | string | No | Official freee field `long_name`. |
| `name_kana` | string | No | Official freee field `name_kana`. |
| `shortcut1` | string | No | Official freee field `shortcut1`. |
| `shortcut2` | string | No | Official freee field `shortcut2`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `contact_name` | string | No | Official freee field `contact_name`. |
| `country_code` | string ("JP" | "ZZ") | No | Official freee field `country_code`. |
| `default_title` | string | No | Official freee field `default_title`. |
| `address_attributes` | object | No | Official freee field `address_attributes`. |
| `payer_walletable_id` | integer | No | Official freee field `payer_walletable_id`. |
| `payment_term_attributes` | object | No | Official freee field `payment_term_attributes`. |
| `qualified_invoice_issuer` | boolean | No | Official freee field `qualified_invoice_issuer`. |
| `transfer_fee_handling_side` | string ("payer" | "payee") | No | Official freee field `transfer_fee_handling_side`. |
| `invoice_registration_number` | string | No | Official freee field `invoice_registration_number`. |
| `partner_doc_setting_attributes` | object | No | Official freee field `partner_doc_setting_attributes`. |
| `invoice_payment_term_attributes` | object | No | Official freee field `invoice_payment_term_attributes`. |
| `partner_bank_account_attributes` | object | No | Official freee field `partner_bank_account_attributes`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Payment Request

**Slug:** `FREEE_UPDATE_PAYMENT_REQUEST`

Update Payment Request using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `draft` | boolean | Yes | Official freee Accounting draft value. |
| `title` | string | Yes | Official freee Accounting title value. |
| `bank_code` | string | No | Official freee Accounting bank code value. |
| `bank_name` | string | No | Official freee Accounting bank name value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |
| `issue_date` | string | Yes | Official freee Accounting issue date value. |
| `partner_id` | integer | No | Official freee Accounting partner id value. |
| `approver_id` | integer | No | Official freee Accounting approver id value. |
| `branch_code` | string | No | Official freee Accounting branch code value. |
| `branch_kana` | string | No | Official freee Accounting branch kana value. |
| `branch_name` | string | No | Official freee Accounting branch name value. |
| `description` | string | No | Official freee Accounting description value. |
| `receipt_ids` | array | No | Official freee Accounting receipt ids value. |
| `account_name` | string | No | Official freee Accounting account name value. |
| `account_type` | string ("ordinary" | "checking" | "earmarked" | "savings" | "other") | No | Official freee Accounting account type value. |
| `partner_code` | string | No | Official freee Accounting partner code value. |
| `payment_date` | string | No | Official freee Accounting payment date value. |
| `document_code` | string | No | Official freee Accounting document code value. |
| `account_number` | string | No | Official freee Accounting account number value. |
| `bank_name_kana` | string | No | Official freee Accounting bank name kana value. |
| `payment_method` | string ("none" | "domestic_bank_transfer" | "abroad_bank_transfer" | "account_transfer" | "credit_card") | No | Official freee Accounting payment method value. |
| `application_date` | string | No | Official freee Accounting application date value. |
| `applicant_group_id` | integer | No | Official freee Accounting applicant group id value. |
| `payment_request_lines` | array | Yes | Official freee Accounting payment request lines value. |
| `approval_flow_group_id` | integer | No | Official freee Accounting approval flow group id value. |
| `approval_flow_route_id` | integer | Yes | Official freee Accounting approval flow route id value. |
| `qualified_invoice_status` | string ("qualified" | "not_qualified" | "unspecified") | No | Official freee Accounting qualified invoice status value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Position

**Slug:** `FREEE_UPDATE_POSITION`

役職の更新

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 役職ID |
| `position` | object | Yes | Value accepted by freee HR. |
| `company_id` | integer | Yes | 作成対象事業所ID（必須） |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Purchase Request

**Slug:** `FREEE_UPDATE_PURCHASE_REQUEST`

Update Purchase Request using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `title` | string | No | Official freee Accounting title value. |
| `status` | string ("draft" | "in_progress") | Yes | Use draft to save without submitting, or in_progress to submit for approval. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |
| `description` | string | No | Official freee Accounting description value. |
| `applicant_group_id` | integer | No | Official freee Accounting applicant group id value. |
| `occurrence_end_date` | string | No | Official freee Accounting occurrence end date value. |
| `occurrence_start_date` | string | No | Official freee Accounting occurrence start date value. |
| `approval_flow_group_id` | integer | No | Official freee Accounting approval flow group id value. |
| `approval_flow_route_id` | integer | No | Official freee Accounting approval flow route id value. |
| `purchase_request_lines` | array | No | Official freee Accounting purchase request lines value. |
| `purchase_request_form_id` | integer | Yes | Official freee Accounting purchase request form id value. |
| `approval_flow_approver_id` | integer | No | Official freee Accounting approval flow approver id value. |
| `purchase_request_custom_values` | array | No | Official freee Accounting purchase request custom values value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Receipt

**Slug:** `FREEE_UPDATE_RECEIPT`

Update Receipt using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |
| `description` | string | No | Official freee field `description`. |
| `document_type` | string ("receipt" | "invoice" | "other") | No | Official freee field `document_type`. |
| `qualified_invoice` | string ("qualified" | "not_qualified" | "unselected") | No | Official freee field `qualified_invoice`. |
| `receipt_metadatum` | object | No | Official freee field `receipt_metadatum`. |
| `invoice_registration_number` | string | No | Official freee field `invoice_registration_number`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Segment Tag

**Slug:** `FREEE_UPDATE_SEGMENT_TAG`

セグメントタグの更新

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | No | セグメントタグコード (20文字以内、半角英数字・ハイフン・アンダースコアのみ)。事業所内の同じセグメント区分で重複できません。事業所の設定でセグメントタグコードを使用する設定にしている場合のみ保存され、設定が無効の場合は指定しても保存されません。省略した場合は未設定（null）になります。 |
| `name` | string | Yes | セグメントタグ名 (100文字以内)。事業所内の同じセグメント区分で重複できません。 |
| `shortcut1` | string | No | ショートカット1 (20文字以内)。Web画面などでセグメントタグを検索する際のキーワードとして使用します。省略した場合は未設定（null）になります。 |
| `shortcut2` | string | No | ショートカット2 (20文字以内)。Web画面などでセグメントタグを検索する際のキーワードとして使用します。省略した場合は未設定（null）になります。 |
| `company_id` | integer | Yes | セグメントタグを作成・更新する対象の事業所ID |
| `segment_id` | integer | Yes | セグメント区分（1、2、3のいずれか）。利用できる区分は事業所の契約プランによって異なります。 |
| `description` | string | No | 備考 (30文字以内)。省略した場合は未設定（null）になります。 |
| `segment_tag_id` | integer | Yes | 更新対象のセグメントタグID。一覧取得APIのレスポンスに含まれる id を指定します。 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Tag

**Slug:** `FREEE_UPDATE_TAG`

Update Tag using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `name` | string | Yes | Official freee field `name`. |
| `shortcut1` | string | No | Official freee field `shortcut1`. |
| `shortcut2` | string | No | Official freee field `shortcut2`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Transfer

**Slug:** `FREEE_UPDATE_TRANSFER`

Update Transfer using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee Accounting id value. |
| `date` | string | Yes | Official freee Accounting date value. |
| `amount` | integer | No | Official freee Accounting amount value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |
| `description` | string | No | Official freee Accounting description value. |
| `from_item_id` | integer | No | Official freee Accounting from item id value. |
| `from_tag_ids` | array | No | Official freee Accounting from tag ids value. |
| `to_walletables` | array | No | Official freee Accounting to walletables value. |
| `from_partner_id` | integer | No | Official freee Accounting from partner id value. |
| `from_section_id` | integer | No | Official freee Accounting from section id value. |
| `to_walletable_id` | integer | No | Official freee Accounting to walletable id value. |
| `from_walletable_id` | integer | Yes | Official freee Accounting from walletable id value. |
| `to_walletable_type` | string ("bank_account" | "credit_card" | "wallet") | No | Official freee Accounting to walletable type value. |
| `from_walletable_type` | string ("bank_account" | "credit_card" | "wallet") | Yes | Official freee Accounting from walletable type value. |
| `from_segment_1_tag_id` | integer | No | Official freee Accounting from segment 1 tag id value. |
| `from_segment_2_tag_id` | integer | No | Official freee Accounting from segment 2 tag id value. |
| `from_segment_3_tag_id` | integer | No | Official freee Accounting from segment 3 tag id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Matcher

**Slug:** `FREEE_UPDATE_USER_MATCHER`

自動登録ルールの更新

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `act` | integer ("0" | "1" | "2" | "3" | "4" | "10" | "11" | "12") | Yes | 登録タイプ * 0: 取引を推測する(manual_standard) * 1: 取引を登録する(auto_standard) * 2: 振替を推測する(manual_transfer) * 3: 振替を登録する(auto_transfer) * 4: 無視する取引を登録する(auto_ignore) * 10: 無視する取引を推測する(manual_ignore) * 11: プライベート取引を推測する(manual_private) * 12: プライベート取引を登録する(auto_private) このAPIでは以下のactは非対応です: 5(manual_template), 6(manual_scrub), 7(auto_scrub), 8(manual_output_zengin_scrub), 9(auto_output_zengin_scrub) |
| `active` | boolean | Yes | 有効/無効 * true: 有効 * false: 無効 |
| `priority` | integer | Yes | 優先度 |
| `tax_name` | string | No | 税区分名 act=0,1(取引を推測/登録)の場合は必須。他のactでは指定しても無視されます。 |
| `condition` | integer ("0" | "1" | "2" | "3" | "4") | Yes | マッチ条件 * 0: 部分一致(partial) * 1: 前方一致(forward) * 2: 後方一致(backward) * 3: 完全一致(exact) * 4: 指定なし(wildcard) |
| `item_name` | string | No | 品目名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。 |
| `card_label` | string | No | カードラベル |
| `company_id` | integer | Yes | 事業所ID |
| `max_amount` | integer | No | 最大金額 (単位: 円) |
| `min_amount` | integer | No | 最小金額 (単位: 円) |
| `walletable` | string | No | 口座名。事業所に登録されている口座の名前を指定します。 |
| `description` | string | Yes | 説明文。明細の取引内容とマッチングする文字列を指定します。condition=4(指定なし)の場合は無視されます。 |
| `partner_name` | string | No | 取引先名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。 |
| `section_name` | string | No | 部門名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。 |
| `card_label_id` | integer | No | カードラベルID |
| `entry_side_str` | string ("income" | "expense") | Yes | 入金/出金 * income: 入金 * expense: 出金 |
| `user_matcher_id` | integer | Yes | 自動登録ルールID |
| `deal_description` | string | No | 取引の備考 act=4,10,11,12(無視/プライベート)では指定しても無視されます。 |
| `account_item_name` | string | No | 勘定科目名 act=0,1(取引を推測/登録)の場合は必須。他のactでは指定しても無視されます。 |
| `default_tag_names` | array | No | メモタグ名の配列 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。 |
| `division_tag_1_name` | string | No | セグメント1タグ名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。 |
| `division_tag_2_name` | string | No | セグメント2タグ名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。 |
| `division_tag_3_name` | string | No | セグメント3タグ名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。 |
| `transfer_walletable` | string | No | 振替先口座名 act=2,3(振替を推測/登録)の場合に使用。他のactでは指定しても無視されます。 |
| `qualified_invoice_setting` | string ("non_qualified" | "qualified" | "depends_on_partner") | No | 適格請求書等 * non_qualified: 該当しない * qualified: 該当する * depends_on_partner: 取引先情報に準拠 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 depends_on_partnerを指定する場合は、partner_nameの指定が必要です。 |
| `suggest_tax_from_walletable_invoice` | boolean | No | 購入データ原本に準拠 * true: 準拠する * false: 準拠しない act=0,1(取引を推測/登録)かつ購入データ原本に対応した口座を指定した場合のみ使用可能。それ以外では指定しても無視されます。 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Walletable

**Slug:** `FREEE_UPDATE_WALLETABLE`

Update Walletable using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Official freee field `id`. |
| `name` | string | Yes | Official freee field `name`. |
| `type` | string ("bank_account" | "credit_card" | "wallet") | Yes | Official freee field `type`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Accounting Section By Code

**Slug:** `FREEE_UPSERT_ACCOUNTING_SECTION_BY_CODE`

Upsert Accounting Section By Code using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Official freee Accounting code value. |
| `section` | object | Yes | Official freee Accounting section value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Account Item By Code

**Slug:** `FREEE_UPSERT_ACCOUNT_ITEM_BY_CODE`

勘定科目の更新（存在しない場合は作成）

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | 勘定科目コード (20文字以内)。半角英数字・ハイフン・アンダースコアのみ利用できます。このコードをキーに勘定科目を検索し、一致する勘定科目が存在すれば更新、存在しなければ作成します。 |
| `company_id` | integer | Yes | 事業所ID |
| `account_item` | object | Yes | Provider body field `account_item`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Item By Code

**Slug:** `FREEE_UPSERT_ITEM_BY_CODE`

Upsert Item By Code using the official freee Accounting API contract.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Official freee Accounting code value. |
| `item` | object | Yes | Official freee Accounting item value. |
| `company_id` | integer | Yes | Official freee Accounting company id value. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Partner By Code

**Slug:** `FREEE_UPSERT_PARTNER_BY_CODE`

Upsert Partner By Code using the official freee Accounting API operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | Official freee field `code`. |
| `partner` | object | Yes | Official freee field `partner`. |
| `company_id` | integer | Yes | Official freee field `company_id`. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upsert Segment Tag By Code

**Slug:** `FREEE_UPSERT_SEGMENT_TAG_BY_CODE`

セグメントタグの更新（作成）

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `code` | string | Yes | セグメントタグコード (20文字以内、半角英数字・ハイフン・アンダースコアのみ)。更新・作成対象を特定するキーであり、このコード自体は変更できません。 |
| `company_id` | integer | Yes | セグメントタグを更新・作成する対象の事業所ID |
| `segment_id` | integer | Yes | セグメント区分（1、2、3のいずれか）。利用できる区分は事業所の契約プランによって異なります。 |
| `segment_tag` | object | Yes | セグメントタグに設定する内容。code（セグメントタグコード）はこのオブジェクト内には指定できません。 |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |