Skip to main content
freee logo
  • Category: accounting
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 267
  • Triggers: 0
  • Slug: FREEE
  • Version: 20261101_00

Tools

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

Input Parameters

integer
required
Official freee field id.
integer
required
Official freee field company_id.
integer
required
Official freee field target_round.
integer
Official freee field next_group_id.
integer
required
Official freee field target_step_id.
string ("approve" | "force_approve" | "cancel" | "reject" | "feedback" | "force_feedback")
required
Official freee field approval_action.
integer
Official freee field next_approver_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_ACT_ON_APPROVAL_REQUESTS_MONTHLY_ATTENDANCE月次勤怠締め申請の承認操作

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_ACT_ON_APPROVAL_REQUESTS_OVERTIME_WORKAction Approval Requests Overtime Work through the freee HR API.

Input Parameters

integer
required
残業申請ID
object
required
JSON request body defined by the freee HR OpenAPI contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_ACT_ON_APPROVAL_REQUESTS_PAID_HOLIDAYAction Approval Requests Paid Holiday through the freee HR API.

Input Parameters

integer
required
有給休暇申請ID
object
required
JSON request body defined by the freee HR OpenAPI contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_ACT_ON_APPROVAL_REQUESTS_SPECIAL_HOLIDAY特別休暇申請の承認操作

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_ACT_ON_APPROVAL_REQUESTS_WORK_TIME勤務時間修正申請の承認操作

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_ACT_ON_EXPENSE_APPLICATIONExecute Expense Application Action; this changes an existing approval state and may not be reversible.

Input Parameters

integer
required
Official freee field id.
integer
required
Official freee field company_id.
integer
required
Official freee field target_round.
integer
Official freee field next_group_id.
integer
required
Official freee field target_step_id.
string ("approve" | "force_approve" | "cancel" | "reject" | "feedback" | "force_feedback")
required
Official freee field approval_action.
integer
Official freee field next_approver_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_ACT_ON_PAYMENT_REQUESTAct On Payment Request using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
integer
required
Official freee Accounting company id value.
integer
required
Official freee Accounting target round value.
integer
Official freee Accounting next group id value.
integer
required
Official freee Accounting target step id value.
string ("approve" | "force_approve" | "cancel" | "reject" | "feedback" | "force_feedback")
required
Official freee Accounting approval action value.
integer
Official freee Accounting next approver id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_ACT_ON_PURCHASE_REQUESTAct On Purchase Request using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
string ("apply" | "approve" | "reject" | "feedback")
required
Official freee Accounting do action value.
integer
required
Official freee Accounting company id value.
integer
Official freee Accounting next group id value.
integer
Official freee Accounting next approver id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_BULK_UPDATE_EMPLOYEE_DEPENDENT_RULESUpdate an employee’s family information in bulk for a specified company and period. The request can also create family records without IDs and delete records marked for destruction.

Input Parameters

integer
required
更新対象年(必須)
integer
required
更新対象月(必須) 締め日支払い日設定が翌月払いの従業員情報の場合は、 指定したmonth + 1の値が更新されます。 翌月払いの従業員の2022/01の従業員情報を更新する場合は、year=2021,month=12を指定してください。
integer
required
更新対象事業所ID(必須)
integer
required
従業員ID
array
required
家族情報ルール

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_ACCOUNT_GROUPCreate Account Group using the official freee Accounting API operation.

Input Parameters

string
required
Official freee field name.
integer
Official freee field index.
integer
required
Official freee field company_id.
integer
required
Official freee field account_category_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_ACCOUNTING_SECTIONCreate Accounting Section using the official freee Accounting API contract.

Input Parameters

string
Official freee Accounting code value.
string
required
Official freee Accounting name value.
string
Official freee Accounting long name value.
integer
Official freee Accounting parent id value.
string
Official freee Accounting shortcut1 value.
string
Official freee Accounting shortcut2 value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_ACCOUNT_ITEM勘定科目の作成

Input Parameters

integer
required
事業所ID
object
required
Provider body field account_item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_ALLOWANCECreate a fixed, directly specified salary allowance in freee HR.

Input Parameters

object
required
Request body field allowance from the freee HR API.
integer
required
Query parameter company_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_APPROVAL_REQUESTCreate Approval Request using the official freee Accounting API operation.

Input Parameters

boolean
required
Official freee field draft.
integer
required
Official freee field form_id.
integer
Official freee field parent_id.
integer
required
Official freee field company_id.
integer
Official freee field approver_id.
array
required
Official freee field request_items.
string
Official freee field application_date.
integer
Official freee field applicant_group_id.
integer
Official freee field approval_flow_group_id.
integer
required
Official freee field approval_flow_route_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_APPROVAL_REQUESTS_MONTHLY_ATTENDANCE月次勤怠締め申請の作成

Input Parameters

integer
required
事業所ID(必須)
integer
User ID to assign when the approval route uses resource_type selected_user; otherwise omit.
integer
required
対象年(必須)
integer
required
対象月(必須)
integer
required
申請経路ID(必須)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_APPROVAL_REQUESTS_OVERTIME_WORKCreate Approval Requests Overtime Work through the freee HR API.

Input Parameters

object
required
JSON request body defined by the freee HR OpenAPI contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_APPROVAL_REQUESTS_PAID_HOLIDAYCreate Approval Requests Paid Holiday through the freee HR API.

Input Parameters

string
required
JSON request body defined by the freee HR OpenAPI contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_APPROVAL_REQUESTS_SPECIAL_HOLIDAY特別休暇申請の作成

Input Parameters

string
取得予定終了時間(条件付き必須) 取得単位が半休、時間休の場合は必須
string
申請理由
string
取得予定開始時間(条件付き必須) 取得単位が半休、時間休の場合は必須
integer
required
事業所ID(必須)
integer
User ID to assign when the approval route uses resource_type selected_user; otherwise omit.
string
required
対象日(必須)
string ("full" | "half" | "morning" | "afternoon" | "hour")
required
取得単位(必須)(full:全休、half:半休、morning:午前休、 afternoon:午後休、hour:時間休)
integer
required
申請経路ID(必須)
integer
required
特別休暇設定ID(必須)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_APPROVAL_REQUESTS_WORK_TIME勤務時間修正申請の作成

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_DEAL取引(収入・支出)の作成

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_DEAL_PAYMENT取引(収入・支出)の支払行の作成

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_DEAL_RENEWCreate Deal Renew using the official freee Accounting API operation.

Input Parameters

integer
required
Official freee field id.
array
required
Official freee field details.
integer
required
Official freee field company_id.
string
required
Official freee field update_date.
integer
required
Official freee field renew_target_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_DEDUCTIONCreate Deduction through the freee HR API.

Input Parameters

object
required
JSON request body defined by the freee HR OpenAPI contract.
integer
required
事業所ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_EMPLOYEECreate Employee through the freee HR API.

Input Parameters

object
required
JSON request body defined by the freee HR OpenAPI contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_EMPLOYEE_TIME_CLOCKCall the official freee HR operation to create employee time clock.

Input Parameters

string ("clock_in" | "break_begin" | "break_end" | "clock_out")
required
Request body field type from the freee HR API.
string
Request body field datetime from the freee HR API.
string
Request body field base_date from the freee HR API.
integer
required
Request body field company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_EXPENSE_APPLICATIONCreate Expense Application using the official freee Accounting API operation.

Input Parameters

boolean
Official freee field draft.
string
required
Official freee field title.
array
Official freee field tag_ids.
integer
Official freee field parent_id.
integer
required
Official freee field company_id.
string
Official freee field issue_date.
integer
Official freee field section_id.
integer
Official freee field approver_id.
string
Official freee field description.
string
Official freee field parent_type.
array
Official freee field purchase_lines.
integer
Official freee field segment_1_tag_id.
integer
Official freee field segment_2_tag_id.
integer
Official freee field segment_3_tag_id.
integer
Official freee field applicant_group_id.
integer
Official freee field approval_flow_group_id.
integer
Official freee field approval_flow_route_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_EXPENSE_APPLICATION_CURRENCYCreate Expense Application Currency using the official freee Accounting API contract.

Input Parameters

string
required
Official freee Accounting code value.
string
required
Official freee Accounting name value.
integer
required
Official freee Accounting company id value.
string
Official freee Accounting description value.
string ("usable" | "unusable")
required
Official freee Accounting search status value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_EXPENSE_APPLICATION_LINE_TEMPLATE経費科目の作成

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_HR_GROUPCreate an organizational group in a freee HR company, optionally beneath an existing parent group.

Input Parameters

string
Optional group code, 1-255 characters.
string
required
Group name, 1-255 characters.
integer
required
HR company ID in which to create the group.
integer
Optional parent group ID; the resulting hierarchy must not exceed 10 levels.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_ITEMCreate Item using the official freee Accounting API contract.

Input Parameters

string
Official freee Accounting code value.
string
required
Official freee Accounting name value.
string
Official freee Accounting shortcut1 value.
string
Official freee Accounting shortcut2 value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_JOURNAL_REPORTRequest creation of a freee Accounting journal report. The accepted response includes a status URL for tracking report generation.

Input Parameters

string ("sjis" | "utf-8")
Official freee field encoding.
string
Official freee field end_date.
integer
required
Official freee field company_id.
string
Official freee field start_date.
string ("generic" | "generic_v2" | "csv" | "pdf")
required
Official freee field download_type.
array
Official freee field visible_ids[].
array
Official freee field visible_tags[].

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_MANUAL_JOURNALCreate Manual Journal using the official freee Accounting API operation.

Input Parameters

array
required
Official freee field details.
boolean
Official freee field adjustment.
integer
required
Official freee field company_id.
string
required
Official freee field issue_date.
string
Official freee field ref_number.
array
Official freee field receipt_ids.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_PARTNERCreate a business partner in a freee Accounting company and return its generated partner ID.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_PAYMENT_REQUESTCreate Payment Request using the official freee Accounting API contract.

Input Parameters

boolean
required
Official freee Accounting draft value.
string
required
Official freee Accounting title value.
string
Official freee Accounting bank code value.
string
Official freee Accounting bank name value.
integer
Official freee Accounting parent id value.
integer
required
Official freee Accounting company id value.
string
required
Official freee Accounting issue date value.
integer
Official freee Accounting partner id value.
integer
Official freee Accounting approver id value.
string
Official freee Accounting branch code value.
string
Official freee Accounting branch kana value.
string
Official freee Accounting branch name value.
string
Official freee Accounting description value.
array
Official freee Accounting receipt ids value.
string
Official freee Accounting account name value.
string ("ordinary" | "checking" | "earmarked" | "savings" | "other")
Official freee Accounting account type value.
string
Official freee Accounting partner code value.
string
Official freee Accounting payment date value.
string
Official freee Accounting document code value.
string
Official freee Accounting account number value.
string
Official freee Accounting bank name kana value.
string ("none" | "domestic_bank_transfer" | "abroad_bank_transfer" | "account_transfer" | "credit_card")
Official freee Accounting payment method value.
string
Official freee Accounting application date value.
integer
Official freee Accounting applicant group id value.
array
required
Official freee Accounting payment request lines value.
integer
Official freee Accounting approval flow group id value.
integer
required
Official freee Accounting approval flow route id value.
string ("qualified" | "not_qualified" | "unspecified")
Official freee Accounting qualified invoice status value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_POSITION役職の作成

Input Parameters

object
required
Value accepted by freee HR.
integer
required
作成対象事業所ID(必須)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_PURCHASE_REQUESTCreate Purchase Request using the official freee Accounting API contract.

Input Parameters

string
Official freee Accounting title value.
string ("draft" | "in_progress")
required
Use draft to save without submitting, or in_progress to submit for approval.
integer
Official freee Accounting parent id value.
integer
required
Official freee Accounting company id value.
string
Official freee Accounting description value.
string
Official freee Accounting parent type value.
array
Official freee Accounting observer user ids value.
integer
Official freee Accounting applicant group id value.
string
Official freee Accounting occurrence end date value.
string
Official freee Accounting occurrence start date value.
integer
Official freee Accounting approval flow group id value.
integer
Official freee Accounting approval flow route id value.
array
Official freee Accounting purchase request lines value.
integer
required
Official freee Accounting purchase request form id value.
integer
Official freee Accounting approval flow approver id value.
array
Official freee Accounting purchase request custom values value.
integer
Official freee Accounting resubmission from purchase request id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_RECEIPTCreate Receipt using the official freee Accounting API operation.

Input Parameters

object
required
Official freee field receipt.
integer
required
Official freee field company_id.
string
Official freee field description.
string ("receipt" | "invoice" | "other")
Official freee field document_type.
string ("qualified" | "not_qualified" | "unselected")
Official freee field qualified_invoice.
integer
Official freee field receipt_metadatum_amount.
string
Official freee field receipt_metadatum_issue_date.
string
Official freee field receipt_metadatum_partner_name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_SEGMENT_TAGセグメントタグの作成

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_TAGCreate Tag using the official freee Accounting API operation.

Input Parameters

string
required
Official freee field name.
string
Official freee field shortcut1.
string
Official freee field shortcut2.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_TRANSFERCreate Transfer using the official freee Accounting API contract.

Input Parameters

string
required
Official freee Accounting date value.
integer
Official freee Accounting amount value.
integer
required
Official freee Accounting company id value.
string
Official freee Accounting description value.
integer
Official freee Accounting from item id value.
array
Official freee Accounting from tag ids value.
array
Official freee Accounting to walletables value.
integer
Official freee Accounting from partner id value.
integer
Official freee Accounting from section id value.
integer
Official freee Accounting to walletable id value.
integer
required
Official freee Accounting from walletable id value.
string ("bank_account" | "credit_card" | "wallet")
Official freee Accounting to walletable type value.
string ("bank_account" | "credit_card" | "wallet")
required
Official freee Accounting from walletable type value.
integer
Official freee Accounting from segment 1 tag id value.
integer
Official freee Accounting from segment 2 tag id value.
integer
Official freee Accounting from segment 3 tag id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_USER_MATCHER自動登録ルールの作成

Input Parameters

integer ("0" | "1" | "2" | "3" | "4" | "10" | "11" | "12")
required
登録タイプ * 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)
boolean
required
有効/無効 * true: 有効 * false: 無効
integer
required
優先度
string
税区分名 act=0,1(取引を推測/登録)の場合は必須。他のactでは指定しても無視されます。
integer ("0" | "1" | "2" | "3" | "4")
required
マッチ条件 * 0: 部分一致(partial) * 1: 前方一致(forward) * 2: 後方一致(backward) * 3: 完全一致(exact) * 4: 指定なし(wildcard)
string
品目名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。
string
カードラベル
integer
required
事業所ID
integer
最大金額 (単位: 円)
integer
最小金額 (単位: 円)
string
口座名。事業所に登録されている口座の名前を指定します。
string
required
説明文。明細の取引内容とマッチングする文字列を指定します。condition=4(指定なし)の場合は無視されます。
string
取引先名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。
string
部門名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。
integer
カードラベルID
string ("income" | "expense")
required
入金/出金 * income: 入金 * expense: 出金
string
取引の備考 act=4,10,11,12(無視/プライベート)では指定しても無視されます。
string
勘定科目名 act=0,1(取引を推測/登録)の場合は必須。他のactでは指定しても無視されます。
array
メモタグ名の配列 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。
string
セグメント1タグ名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。
string
セグメント2タグ名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。
string
セグメント3タグ名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。
string
振替先口座名 act=2,3(振替を推測/登録)の場合に使用。他のactでは指定しても無視されます。
string ("non_qualified" | "qualified" | "depends_on_partner")
適格請求書等 * non_qualified: 該当しない * qualified: 該当する * depends_on_partner: 取引先情報に準拠 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 depends_on_partnerを指定する場合は、partner_nameの指定が必要です。
boolean
購入データ原本に準拠 * true: 準拠する * false: 準拠しない act=0,1(取引を推測/登録)かつ購入データ原本に対応した口座を指定した場合のみ使用可能。それ以外では指定しても無視されます。

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_WALLETABLECreate Walletable using the official freee Accounting API operation.

Input Parameters

string
required
Official freee field name.
string ("bank_account" | "credit_card" | "wallet")
required
Official freee field type.
integer
Official freee field bank_id.
boolean
Official freee field is_asset.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_CREATE_WALLET_TRANSACTIONCreate Wallet Transaction using the official freee Accounting API contract.

Input Parameters

string
required
Official freee Accounting date value.
integer
required
Official freee Accounting amount value.
integer
Official freee Accounting balance value.
integer
required
Official freee Accounting company id value.
string ("income" | "expense")
required
Official freee Accounting entry side value.
string
Official freee Accounting description value.
integer
required
Official freee Accounting walletable id value.
string ("bank_account" | "credit_card" | "wallet")
required
Official freee Accounting walletable type value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_ACCOUNTING_SECTIONDelete Accounting Section using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_ACCOUNT_ITEM勘定科目の削除

Input Parameters

integer
required
事業所ID
integer
required
勘定科目ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_APPROVAL_REQUESTPermanently delete the target with Delete Approval Request; this operation is destructive and cannot be undone.

Input Parameters

integer
required
Official freee field id.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_DEAL取引(収入・支出)の削除

Input Parameters

integer
required
取引ID
integer
required
事業所ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_DEAL_PAYMENT取引(収入・支出)の支払行の削除

Input Parameters

integer
required
取引ID
integer
required
事業所ID
integer
required
支払行ID(取引のレスポンスのpayments配列のid)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_DEAL_RENEWPermanently delete the target with Delete Deal Renew; this operation is destructive and cannot be undone.

Input Parameters

integer
required
Official freee field id.
integer
required
Official freee field renew_id.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_EXPENSE_APPLICATIONPermanently delete the target with Delete Expense Application; this operation is destructive and cannot be undone.

Input Parameters

integer
required
Official freee field id.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_EXPENSE_APPLICATION_CURRENCYDelete Expense Application Currency using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_EXPENSE_APPLICATION_LINE_TEMPLATE経費科目の削除

Input Parameters

integer
required
事業所ID
integer
required
経費科目ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_HR_GROUPPermanently 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

integer
required
Group ID to permanently delete.
integer
required
HR company ID that owns the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_ITEMDelete Item using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_MANUAL_JOURNALPermanently delete the target with Delete Manual Journal; this operation is destructive and cannot be undone.

Input Parameters

integer
required
Official freee field id.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_PARTNERPermanently 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

integer
required
Company ID that owns the partner.
integer
required
Partner ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_PAYMENT_REQUESTDelete Payment Request using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_PURCHASE_REQUESTDelete Purchase Request using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_RECEIPTPermanently delete the target with Delete Receipt; this operation is destructive and cannot be undone.

Input Parameters

integer
required
Official freee field id.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_SEGMENT_TAGセグメントタグの削除

Input Parameters

integer
required
削除対象のセグメントタグが属する事業所ID
integer
required
セグメント区分(1、2、3のいずれか)。利用できる区分は事業所の契約プランによって異なります。
integer
required
削除対象のセグメントタグID。一覧取得APIのレスポンスに含まれる id を指定します。

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_TAGPermanently delete the target with Delete Tag; this operation is destructive and cannot be undone.

Input Parameters

integer
required
Official freee field id.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_TRANSFERDelete Transfer using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_USER_MATCHER自動登録ルールの削除

Input Parameters

integer
required
事業所ID
integer
required
自動登録ルールID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_WALLETABLEPermanently delete the target with Delete Walletable; this operation is destructive and cannot be undone.

Input Parameters

integer
required
Official freee field id.
string ("bank_account" | "credit_card" | "wallet")
required
Official freee field type.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DELETE_WALLET_TRANSACTIONDelete Wallet Transaction using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DESTROY_APPROVAL_REQUESTS_MONTHLY_ATTENDANCE月次勤怠締め申請の削除

Input Parameters

integer
required
月次勤怠締め申請ID
integer
required
事業所ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DESTROY_APPROVAL_REQUESTS_OVERTIME_WORKDestroy Approval Requests Overtime Work through the freee HR API.

Input Parameters

integer
required
残業申請ID
integer
required
事業所ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DESTROY_APPROVAL_REQUESTS_PAID_HOLIDAYDestroy Approval Requests Paid Holiday through the freee HR API.

Input Parameters

integer
required
有給休暇申請ID
integer
required
事業所ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DESTROY_APPROVAL_REQUESTS_SPECIAL_HOLIDAY特別休暇申請の削除

Input Parameters

integer
required
特別休暇申請ID
integer
required
事業所ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DESTROY_APPROVAL_REQUESTS_WORK_TIME勤務時間修正申請の削除

Input Parameters

integer
required
勤務時間修正申請ID
integer
required
事業所ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DESTROY_EMPLOYEEDestroy Employee through the freee HR API.

Input Parameters

integer
required
従業員ID
integer
required
事業所ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DESTROY_EMPLOYEE_ALLOWANCE_RULECall the official freee HR operation to destroy employee allowance rule.

Input Parameters

integer
required
Path parameter id from the freee HR API.
integer
required
Query parameter year from the freee HR API.
integer
required
Query parameter month from the freee HR API.
integer
required
Query parameter company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DESTROY_EMPLOYEE_DEDUCTION_RULEDestroy Employee Deduction Rule through the freee HR API.

Input Parameters

integer
required
従業員控除ID
integer
required
削除対象の控除ルールを判定する締め年
integer
required
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.
integer
required
事業所ID
integer
required
従業員ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DESTROY_EMPLOYEE_WORK_RECORDCall the official freee HR operation to destroy employee work record.

Input Parameters

string
required
Path parameter date from the freee HR API.
integer
required
Query parameter company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DESTROY_POSITION役職の削除

Input Parameters

integer
required
役職ID
integer
required
事業所ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DESTROY_YEAREND_ADJUSTMENT_HOUSING_LOANCall the official freee HR operation to destroy yearend adjustment housing loan.

Input Parameters

integer
required
Path parameter id from the freee HR API.
integer
required
Path parameter year from the freee HR API.
integer
required
Query parameter company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DESTROY_YEAREND_ADJUSTMENT_INSURANCESCall the official freee HR operation to destroy yearend adjustment insurances.

Input Parameters

integer
required
Path parameter id from the freee HR API.
integer
required
Path parameter year from the freee HR API.
integer
required
Query parameter company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DESTROY_YEAREND_ADJUSTMENT_PREVIOUS_JOBCall the official freee HR operation to destroy yearend adjustment previous job.

Input Parameters

integer
required
Path parameter year from the freee HR API.
integer
required
Query parameter company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DOWNLOAD_JOURNALDownload a journal report file through the freee Accounting API and return a file reference. Downloads are limited to 100 MiB.

Input Parameters

integer
required
Official freee field id.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_DOWNLOAD_RECEIPTDownload a receipt file through the freee Accounting API and return a file reference. Downloads are limited to 100 MiB.

Input Parameters

integer
required
Official freee field id.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_ACCOUNTING_CAPABILITIESReturn the connected user’s Accounting permissions for a company; capability flags do not guarantee paid-plan entitlement.

Input Parameters

integer
required
Company ID whose resource-level read, create, update, and delete capabilities to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_ACCOUNTING_SECTIONGet Accounting Section using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_ACCOUNT_ITEM勘定科目の取得

Input Parameters

integer
required
事業所ID
integer
required
勘定科目ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_ALLOWANCECall the official freee HR operation to get allowance.

Input Parameters

integer
required
Path parameter id from the freee HR API.
integer
required
Query parameter company_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_APPROVAL_FLOW_ROUTE申請経路の取得

Input Parameters

integer
required
事業所ID
integer
required
申請経路ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_APPROVAL_REQUESTGet Approval Request using the official freee Accounting API operation.

Input Parameters

integer
required
Official freee field id.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_APPROVAL_REQUEST_FORMGet Approval Request Form using the official freee Accounting API operation.

Input Parameters

integer
required
Official freee field id.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_APPROVAL_REQUESTS_MONTHLY_ATTENDANCE月次勤怠締め申請の取得

Input Parameters

integer
required
月次勤怠締め申請ID
integer
required
事業所ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_APPROVAL_REQUESTS_MONTHLY_ATTENDANCES月次勤怠締め申請一覧の取得

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_APPROVAL_REQUESTS_OVERTIME_WORKGet Approval Requests Overtime Work through the freee HR API.

Input Parameters

integer
required
残業申請ID
integer
required
事業所ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_APPROVAL_REQUESTS_OVERTIME_WORKSGet Approval Requests Overtime Works through the freee HR API. Return one provider page using offset and limit.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_APPROVAL_REQUESTS_OVERTIME_WORK_SETTINGGet Approval Requests Overtime Work Setting through the freee HR API.

Input Parameters

string
required
対象日(YYYY-MM-DD)(例:2018-08-01) - 申請の対象日を指定してください。
integer
required
事業所ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_APPROVAL_REQUESTS_PAID_HOLIDAYGet Approval Requests Paid Holiday through the freee HR API.

Input Parameters

integer
required
有給休暇申請ID
integer
required
事業所ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_APPROVAL_REQUESTS_PAID_HOLIDAYSGet Approval Requests Paid Holidays through the freee HR API. Return one provider page using offset and limit.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_APPROVAL_REQUESTS_SPECIAL_HOLIDAY特別休暇申請の取得

Input Parameters

integer
required
特別休暇申請ID
integer
required
事業所ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_APPROVAL_REQUESTS_SPECIAL_HOLIDAYS特別休暇申請一覧の取得

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_APPROVAL_REQUESTS_WORK_TIME勤務時間修正申請の取得

Input Parameters

integer
required
勤務時間修正申請ID
integer
required
事業所ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_APPROVAL_REQUESTS_WORK_TIMES勤務時間修正申請一覧の取得

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_BALANCE_SHEETReturn a freee Accounting balance sheet for a fiscal year or date range, with optional account, partner, item, section, or segment breakdowns. The response indicates whether the aggregation is up to date.

Input Parameters

integer
Filter by item ID. Use 0 to include only transactions with no item selected.
string
Inclusive end date in YYYY-MM-DD. Must be supplied with start_date and cannot be combined with fiscal_year.
string ("partner" | "item" | "section" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag")
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.
integer
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.
string ("only" | "without")
Use only to aggregate adjustment entries, or without to exclude them. Omit to include adjustment entries normally.
integer
required
Company ID whose balance sheet to retrieve.
integer
Filter by partner ID. Use 0 to include only transactions with no partner selected.
integer
Filter by section ID. Use 0 to include only transactions with no section selected.
string
Inclusive start date in YYYY-MM-DD. Must be supplied with end_date and cannot be combined with fiscal_year.
integer
Fiscal year identified by the year containing the fiscal period’s start date. Omit to use freee’s current fiscal year.
integer
Starting accounting month (1-12) for transaction-month filtering. Omit to use the first month of the current fiscal year.
string
Filter by partner code. Available only when partner-code use is enabled in the company’s settings.
string ("account_item" | "group")
Display balances by individual account item or by financial-statement group. The group mode can only use the account_item breakdown.
string ("without_in_progress" | "all")
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_BANKGet Bank using the official freee Accounting API operation.

Input Parameters

integer
required
Official freee field id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_BONUSES_EMPLOYEE_PAYROLL_STATEMENTCall the official freee HR operation to get bonuses employee payroll statement.

Input Parameters

integer
required
Query parameter year from the freee HR API.
integer
required
Query parameter month from the freee HR API.
integer
required
Query parameter company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_BONUSES_EMPLOYEE_PAYROLL_STATEMENTSCall the official freee HR operation to get bonuses employee payroll statements.

Input Parameters

integer
required
Query parameter year from the freee HR API.
integer
Query parameter limit from the freee HR API.
integer
required
Query parameter month from the freee HR API.
integer
Query parameter offset from the freee HR API.
integer
required
Query parameter company_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_COMPANYReturn one freee Accounting company’s settings and fiscal years, and optionally include selected accounting reference lists.

Input Parameters

integer
required
Company ID to retrieve; the OAuth token must be authorized for this selected company.
boolean
Whether to include account items, tax codes, items, partners, sections, tags, and walletables in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_CURRENT_ACCOUNTING_USERReturn the connected freee Accounting user and company memberships; listed companies may still be outside the token’s selected-company authorization boundary.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_CURRENT_HR_USERReturn the connected freee HR user, company memberships, HR roles, and linked employee IDs when available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_DEALReturn one income or expense deal with journal details, payments, adjustments, attached receipt metadata, and optional receivable or payable accrual rows.

Input Parameters

integer
required
Deal ID to retrieve.
integer
required
Company ID that owns the deal.
boolean
Whether to include receivable and payable accrual rows when present.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_DEDUCTIONGet Deduction through the freee HR API.

Input Parameters

integer
required
その他控除ID
integer
required
事業所ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEEGet Employee through the freee HR API.

Input Parameters

integer
required
従業員ID
integer
required
従業員情報を取得したい年
integer
required
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.
integer
required
事業所ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEE_ALLOWANCE_RULESCall the official freee HR operation to get employee allowance rules.

Input Parameters

integer
required
Query parameter year from the freee HR API.
integer
required
Query parameter month from the freee HR API.
integer
required
Query parameter company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEE_BANK_ACCOUNT_RULECall the official freee HR operation to get employee bank account rule.

Input Parameters

integer
required
Query parameter year from the freee HR API.
integer
required
Query parameter month from the freee HR API.
integer
required
Query parameter company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEE_BASIC_PAY_RULECall the official freee HR operation to get employee basic pay rule.

Input Parameters

integer
required
Query parameter year from the freee HR API.
integer
required
Query parameter month from the freee HR API.
integer
required
Query parameter company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEE_DEDUCTION_RULESGet Employee Deduction Rules through the freee HR API.

Input Parameters

integer
required
従業員情報を取得したい年
integer
required
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.
integer
required
事業所ID
integer
required
従業員ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEE_DEPENDENT_RULES従業員の家族情報の取得

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEE_GROUP_MEMBERSHIPSGet Employee Group Memberships through the freee HR API. Return one provider page using offset and limit.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEE_GROUP_MEMBERSHIPS_BY_EMPLOYEE_IDGet Employee Group Memberships By Employee Id through the freee HR API. Return one provider page using offset and limit.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEE_HEALTH_INSURANCE_RULEGet Employee Health Insurance Rule through the freee HR API.

Input Parameters

integer
required
従業員情報を取得したい年
integer
required
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.
integer
required
事業所ID
integer
required
従業員ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEE_PROFILE_CUSTOM_FIELDS_RULEGet Employee Profile Custom Fields Rule through the freee HR API.

Input Parameters

integer
required
従業員情報を取得したい年
integer
required
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.
integer
required
事業所ID
integer
required
従業員ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEE_PROFILE_RULEGet Employee Profile Rule through the freee HR API.

Input Parameters

integer
required
従業員情報を取得したい年
integer
required
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.
integer
required
事業所ID
integer
required
従業員ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEESGet Employees through the freee HR API. Return one provider page using offset and limit.

Input Parameters

integer
required
従業員情報を取得したい年
integer
取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 100)
integer
required
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.
integer
取得レコードのオフセット (デフォルト: 0)
integer
required
事業所ID
string
Continuation cursor returned by the previous page; omit for the first page.
boolean
trueを指定すると給与計算対象外の従業員情報をレスポンスに含めます。

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEES_ATTENDANCE_TAGSGet Employees Attendance Tags through the freee HR API.

Input Parameters

integer
required
事業所ID
integer
required
従業員ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEES_ATTENDANCE_TAGS_BY_DATEGet Employees Attendance Tags By Date through the freee HR API.

Input Parameters

string
required
対象年月日(YYYY-MM-DD)(例:2018-08-01)
integer
required
事業所ID
integer
required
従業員ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEES_ATTENDANCE_TAG_SUMMARIES勤怠タグ月次サマリの取得

Input Parameters

integer
required
勤怠タグサマリを取得したい年
integer
required
勤怠タグサマリを取得したい月
integer
required
事業所ID
integer
required
従業員ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEES_SPECIAL_HOLIDAYS従業員の特別休暇一覧の取得

Input Parameters

string
対象日
string
対象終了日
integer
required
事業所ID
string
対象開始日
integer
required
従業員ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEE_TIME_CLOCKCall the official freee HR operation to get employee time clock.

Input Parameters

integer
required
Path parameter id from the freee HR API.
integer
required
Query parameter company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEE_TIME_CLOCKSCall the official freee HR operation to get employee time clocks.

Input Parameters

integer
Query parameter limit from the freee HR API.
integer
Query parameter offset from the freee HR API.
string
Query parameter to_date from the freee HR API.
string
Query parameter from_date from the freee HR API.
integer
required
Query parameter company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEE_TIME_CLOCKS_AVAILABLE_TYPESCall the official freee HR operation to get employee time clocks available types.

Input Parameters

string
Query parameter date from the freee HR API.
integer
required
Query parameter company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEE_WELFARE_PENSION_INSURANCE_RULE従業員の厚生年金保険の取得

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEE_WORK_RECORDCall the official freee HR operation to get employee work record.

Input Parameters

string
required
Path parameter date from the freee HR API.
integer
required
Query parameter company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EMPLOYEE_WORK_RECORD_SUMMARYCall the official freee HR operation to get employee work record summary.

Input Parameters

integer
required
Path parameter year from the freee HR API.
integer
required
Path parameter month from the freee HR API.
integer
required
Query parameter company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.
boolean
Query parameter work_records from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EXPENSE_APPLICATIONGet Expense Application using the official freee Accounting API operation.

Input Parameters

integer
required
Official freee field id.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EXPENSE_APPLICATION_CURRENCYGet Expense Application Currency using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EXPENSE_APPLICATION_FORMGet Expense Application Form using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_EXPENSE_APPLICATION_LINE_TEMPLATE経費科目の取得

Input Parameters

integer
required
事業所ID
integer
required
経費科目ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_HR_APPROVAL_FLOW_ROUTEGet one HR approval flow route and its approval steps from a freee company.

Input Parameters

integer
required
HR approval flow route ID.
integer
required
HR company ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_HR_APPROVAL_FLOW_ROUTESList approval flow routes available to HR workflows in a freee company.

Input Parameters

string ("AttendanceWorkflow" | "PersonalDataWorkflow")
Only return routes usable for attendance or personal-data workflows.
integer
required
HR company ID.
integer
Only return routes that include this user as an approver.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_INVOICEGet a current invoice by its freee Invoice API invoice ID. IDs from the retired freee Accounting invoices endpoint are not interchangeable.

Input Parameters

integer
required
freee company ID.
integer
required
freee Invoice API invoice ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_ITEMGet Item using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_JOURNAL_REPORT_STATUSGet Journal Report Status using the official freee Accounting API operation.

Input Parameters

integer
required
Official freee field id.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_MANUAL_JOURNALGet Manual Journal using the official freee Accounting API operation.

Input Parameters

integer
required
Official freee field id.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_PARTNERReturn full details for one business partner in a freee Accounting company.

Input Parameters

integer
required
Company ID that owns the partner.
integer
required
Partner ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_PAYMENT_REQUESTGet Payment Request using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_PURCHASE_REQUESTGet Purchase Request using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_PURCHASE_REQUEST_FORMGet Purchase Request Form using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_QUOTATIONGet a current quotation by its freee Invoice API quotation ID. IDs from the retired freee Accounting quotations endpoint are not interchangeable.

Input Parameters

integer
required
freee Invoice API quotation ID.
integer
required
freee company ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_RECEIPTGet Receipt using the official freee Accounting API operation.

Input Parameters

integer
required
Official freee field id.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_SALARIES_EMPLOYEE_PAYROLL_STATEMENT給与明細の取得

Input Parameters

integer
required
従業員情報を取得したい年
integer
required
従業員情報を取得したい月
integer
required
事業所ID
integer
required
従業員ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_SALARIES_EMPLOYEE_PAYROLL_STATEMENTS給与明細一覧の取得

Input Parameters

integer
required
従業員情報を取得したい年
integer
取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 100)
integer
required
従業員情報を取得したい月
integer
取得レコードのオフセット (デフォルト: 0)
integer
required
事業所ID
string
Continuation cursor returned by the previous page; omit for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_TAGGet Tag using the official freee Accounting API operation.

Input Parameters

integer
required
Official freee field id.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_TAX_CODEGet Tax Code using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting code value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_TRANSFERGet Transfer using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_TRIAL_BS_THREE_YEARS貸借対照表(3期間比較)の取得

Input Parameters

integer
品目IDで絞込(0を指定すると、品目が未選択で絞り込めます)
string
発生日で絞込:終了日(yyyy-mm-dd)
integer
発生月で絞込:終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, … 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。
string ("only" | "without")
決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * only - 決算整理仕訳のみを集計 * without - 決算整理仕訳を除外して集計
integer
required
事業所ID
integer
取引先IDで絞込(0を指定すると、取引先が未選択で絞り込めます)
integer
部門IDで絞込(0を指定すると、部門が未選択で絞り込めます)
string
発生日で絞込:開始日(yyyy-mm-dd)
integer
会計年度(会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019)。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。
integer
発生月で絞込:開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。
string
取引先コードで絞込(事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です)
string ("without_in_progress" | "all")
承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン(および旧法人プロフェッショナルプラン)以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * without_in_progress - 未承認を除く(デフォルト) * all - 全ての承認ステータスを含む
string ("partner" | "item" | "section" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag")
内訳の表示。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: 品目を指定 → エラーにならない
string ("account_item" | "group")
勘定科目の表示。指定されない場合、account_item が指定されます。 * account_item - 勘定科目単位で表示 * group - 決算書表示単位で表示

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_TRIAL_BS_TWO_YEARS貸借対照表(前年比較)の取得

Input Parameters

integer
品目IDで絞込(0を指定すると、品目が未選択で絞り込めます)
string
発生日で絞込:終了日(yyyy-mm-dd)
integer
発生月で絞込:終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, … 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。
string ("only" | "without")
決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * only - 決算整理仕訳のみを集計 * without - 決算整理仕訳を除外して集計
integer
required
事業所ID
integer
取引先IDで絞込(0を指定すると、取引先が未選択で絞り込めます)
integer
部門IDで絞込(0を指定すると、部門が未選択で絞り込めます)
string
発生日で絞込:開始日(yyyy-mm-dd)
integer
会計年度(会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019)。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。
integer
発生月で絞込:開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。
string
取引先コードで絞込(事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です)
string ("without_in_progress" | "all")
承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン(および旧法人プロフェッショナルプラン)以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * without_in_progress - 未承認を除く(デフォルト) * all - 全ての承認ステータスを含む
string ("partner" | "item" | "section" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag")
内訳の表示。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: 品目を指定 → エラーにならない
string ("account_item" | "group")
勘定科目の表示。指定されない場合、account_item が指定されます。 * account_item - 勘定科目単位で表示 * group - 決算書表示単位で表示

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_TRIAL_CR製造原価報告書の取得

Input Parameters

integer
品目IDで絞込(0を指定すると、品目が未選択で絞り込めます)
string
発生日で絞込:終了日(yyyy-mm-dd)
integer
発生月で絞込:終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, … 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。
string ("only" | "without")
決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * only - 決算整理仕訳のみを集計 * without - 決算整理仕訳を除外して集計
integer
required
事業所ID
integer
取引先IDで絞込(0を指定すると、取引先が未選択で絞り込めます)
integer
部門IDで絞込(0を指定すると、部門が未選択で絞り込めます)
string
発生日で絞込:開始日(yyyy-mm-dd)
integer
会計年度(会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019)。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。
integer
発生月で絞込:開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。
string
取引先コードで絞込(事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です)
string ("only" | "without")
配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン(および旧法人ベーシックプラン)以上で利用可能で、利用できないプランで指定した場合はエラー(403)になります。 * only - 配賦仕訳のみを集計 * without - 配賦仕訳を除外して集計
string ("without_in_progress" | "all")
承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン(および旧法人プロフェッショナルプラン)以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * without_in_progress - 未承認を除く(デフォルト) * all - 全ての承認ステータスを含む
string ("partner" | "item" | "section" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag")
内訳の表示。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: 品目を指定 → エラーにならない
string ("account_item" | "group")
勘定科目の表示。指定されない場合、account_item が指定されます。 * account_item - 勘定科目単位で表示 * group - 決算書表示単位で表示

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_TRIAL_CR_SECTIONS製造原価報告書(部門比較)の取得

Input Parameters

integer
品目IDで絞込(0を指定すると、品目が未選択で絞り込めます)
string
発生日で絞込:終了日(yyyy-mm-dd)
integer
発生月で絞込:終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, … 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。
string ("only" | "without")
決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * only - 決算整理仕訳のみを集計 * without - 決算整理仕訳を除外して集計
integer
required
事業所ID
integer
取引先IDで絞込(0を指定すると、取引先が未選択で絞り込めます)
string
発生日で絞込:開始日(yyyy-mm-dd)
integer
会計年度(会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019)。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。
string
required
比較する部門IDの指定。半角数字のIDを半角カンマ区切り(スペースなし)で1〜5つ指定してください。同じIDを重複して指定することはできません。0を指定すると、未選択の部門で比較できます。
integer
発生月で絞込:開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。
string
取引先コードで絞込(事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です)
string ("only" | "without")
配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン(および旧法人ベーシックプラン)以上で利用可能で、利用できないプランで指定した場合はエラー(403)になります。 * only - 配賦仕訳のみを集計 * without - 配賦仕訳を除外して集計
string ("without_in_progress" | "all")
承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン(および旧法人プロフェッショナルプラン)以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * without_in_progress - 未承認を除く(デフォルト) * all - 全ての承認ステータスを含む
string ("partner" | "item" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag")
内訳の表示。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: 品目を指定 → エラーにならない
string ("account_item" | "group")
勘定科目の表示。指定されない場合、account_item が指定されます。 * account_item - 勘定科目単位で表示 * group - 決算書表示単位で表示

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_TRIAL_CR_SEGMENT_1_TAGS製造原価報告書(セグメント1比較)の取得

Input Parameters

integer
品目IDで絞込(0を指定すると、品目が未選択で絞り込めます)
string
発生日で絞込:終了日(yyyy-mm-dd)
integer
発生月で絞込:終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, … 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。
string ("only" | "without")
決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * only - 決算整理仕訳のみを集計 * without - 決算整理仕訳を除外して集計
integer
required
事業所ID
integer
取引先IDで絞込(0を指定すると、取引先が未選択で絞り込めます)
integer
部門IDで絞込(0を指定すると、部門が未選択で絞り込めます)
string
発生日で絞込:開始日(yyyy-mm-dd)
integer
会計年度(会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019)。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。
integer
発生月で絞込:開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。
string
取引先コードで絞込(事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です)
string ("only" | "without")
配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン(および旧法人ベーシックプラン)以上で利用可能で、利用できないプランで指定した場合はエラー(403)になります。 * only - 配賦仕訳のみを集計 * without - 配賦仕訳を除外して集計
string
required
比較するセグメント1タグIDの指定。半角数字のIDを半角カンマ区切り(スペースなし)で1〜5つ指定してください。同じIDを重複して指定することはできません。0を指定すると、未選択のセグメント1タグで比較できます。
string ("without_in_progress" | "all")
承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン(および旧法人プロフェッショナルプラン)以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * without_in_progress - 未承認を除く(デフォルト) * all - 全ての承認ステータスを含む
string ("partner" | "item" | "section" | "account_item")
内訳の表示。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: 品目を指定 → エラーにならない
string ("account_item" | "group")
勘定科目の表示。指定されない場合、account_item が指定されます。 * account_item - 勘定科目単位で表示 * group - 決算書表示単位で表示

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_TRIAL_CR_SEGMENT_2_TAGS製造原価報告書(セグメント2比較)の取得

Input Parameters

integer
品目IDで絞込(0を指定すると、品目が未選択で絞り込めます)
string
発生日で絞込:終了日(yyyy-mm-dd)
integer
発生月で絞込:終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, … 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。
string ("only" | "without")
決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * only - 決算整理仕訳のみを集計 * without - 決算整理仕訳を除外して集計
integer
required
事業所ID
integer
取引先IDで絞込(0を指定すると、取引先が未選択で絞り込めます)
integer
部門IDで絞込(0を指定すると、部門が未選択で絞り込めます)
string
発生日で絞込:開始日(yyyy-mm-dd)
integer
会計年度(会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019)。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。
integer
発生月で絞込:開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。
string
取引先コードで絞込(事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です)
string ("only" | "without")
配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン(および旧法人ベーシックプラン)以上で利用可能で、利用できないプランで指定した場合はエラー(403)になります。 * only - 配賦仕訳のみを集計 * without - 配賦仕訳を除外して集計
string
required
比較するセグメント2タグIDの指定。半角数字のIDを半角カンマ区切り(スペースなし)で1〜5つ指定してください。同じIDを重複して指定することはできません。0を指定すると、未選択のセグメント2タグで比較できます。
string ("without_in_progress" | "all")
承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン(および旧法人プロフェッショナルプラン)以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * without_in_progress - 未承認を除く(デフォルト) * all - 全ての承認ステータスを含む
string ("partner" | "item" | "section" | "account_item")
内訳の表示。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: 品目を指定 → エラーにならない
string ("account_item" | "group")
勘定科目の表示。指定されない場合、account_item が指定されます。 * account_item - 勘定科目単位で表示 * group - 決算書表示単位で表示

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_TRIAL_CR_SEGMENT_3_TAGS製造原価報告書(セグメント3比較)の取得

Input Parameters

integer
品目IDで絞込(0を指定すると、品目が未選択で絞り込めます)
string
発生日で絞込:終了日(yyyy-mm-dd)
integer
発生月で絞込:終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, … 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。
string ("only" | "without")
決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * only - 決算整理仕訳のみを集計 * without - 決算整理仕訳を除外して集計
integer
required
事業所ID
integer
取引先IDで絞込(0を指定すると、取引先が未選択で絞り込めます)
integer
部門IDで絞込(0を指定すると、部門が未選択で絞り込めます)
string
発生日で絞込:開始日(yyyy-mm-dd)
integer
会計年度(会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019)。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。
integer
発生月で絞込:開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。
string
取引先コードで絞込(事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です)
string ("only" | "without")
配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン(および旧法人ベーシックプラン)以上で利用可能で、利用できないプランで指定した場合はエラー(403)になります。 * only - 配賦仕訳のみを集計 * without - 配賦仕訳を除外して集計
string
required
比較するセグメント3タグIDの指定。半角数字のIDを半角カンマ区切り(スペースなし)で1〜5つ指定してください。同じIDを重複して指定することはできません。0を指定すると、未選択のセグメント3タグで比較できます。
string ("without_in_progress" | "all")
承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン(および旧法人プロフェッショナルプラン)以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * without_in_progress - 未承認を除く(デフォルト) * all - 全ての承認ステータスを含む
string ("partner" | "item" | "section" | "account_item")
内訳の表示。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: 品目を指定 → エラーにならない
string ("account_item" | "group")
勘定科目の表示。指定されない場合、account_item が指定されます。 * account_item - 勘定科目単位で表示 * group - 決算書表示単位で表示

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_TRIAL_CR_THREE_YEARS製造原価報告書(3期間比較)の取得

Input Parameters

integer
品目IDで絞込(0を指定すると、品目が未選択で絞り込めます)
string
発生日で絞込:終了日(yyyy-mm-dd)
integer
発生月で絞込:終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, … 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。
string ("only" | "without")
決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * only - 決算整理仕訳のみを集計 * without - 決算整理仕訳を除外して集計
integer
required
事業所ID
integer
取引先IDで絞込(0を指定すると、取引先が未選択で絞り込めます)
integer
部門IDで絞込(0を指定すると、部門が未選択で絞り込めます)
string
発生日で絞込:開始日(yyyy-mm-dd)
integer
会計年度(会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019)。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。
integer
発生月で絞込:開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。
string
取引先コードで絞込(事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です)
string ("only" | "without")
配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン(および旧法人ベーシックプラン)以上で利用可能で、利用できないプランで指定した場合はエラー(403)になります。 * only - 配賦仕訳のみを集計 * without - 配賦仕訳を除外して集計
string ("without_in_progress" | "all")
承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン(および旧法人プロフェッショナルプラン)以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * without_in_progress - 未承認を除く(デフォルト) * all - 全ての承認ステータスを含む
string ("partner" | "item" | "section" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag")
内訳の表示。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: 品目を指定 → エラーにならない
string ("account_item" | "group")
勘定科目の表示。指定されない場合、account_item が指定されます。 * account_item - 勘定科目単位で表示 * group - 決算書表示単位で表示

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_TRIAL_CR_TWO_YEARS製造原価報告書(前年比較)の取得

Input Parameters

integer
品目IDで絞込(0を指定すると、品目が未選択で絞り込めます)
string
発生日で絞込:終了日(yyyy-mm-dd)
integer
発生月で絞込:終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, … 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。
string ("only" | "without")
決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * only - 決算整理仕訳のみを集計 * without - 決算整理仕訳を除外して集計
integer
required
事業所ID
integer
取引先IDで絞込(0を指定すると、取引先が未選択で絞り込めます)
integer
部門IDで絞込(0を指定すると、部門が未選択で絞り込めます)
string
発生日で絞込:開始日(yyyy-mm-dd)
integer
会計年度(会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019)。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。
integer
発生月で絞込:開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。
string
取引先コードで絞込(事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です)
string ("only" | "without")
配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン(および旧法人ベーシックプラン)以上で利用可能で、利用できないプランで指定した場合はエラー(403)になります。 * only - 配賦仕訳のみを集計 * without - 配賦仕訳を除外して集計
string ("without_in_progress" | "all")
承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン(および旧法人プロフェッショナルプラン)以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * without_in_progress - 未承認を除く(デフォルト) * all - 全ての承認ステータスを含む
string ("partner" | "item" | "section" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag")
内訳の表示。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: 品目を指定 → エラーにならない
string ("account_item" | "group")
勘定科目の表示。指定されない場合、account_item が指定されます。 * account_item - 勘定科目単位で表示 * group - 決算書表示単位で表示

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_TRIAL_PL損益計算書の取得

Input Parameters

integer
品目IDで絞込(0を指定すると、品目が未選択で絞り込めます)
string
発生日で絞込:終了日(yyyy-mm-dd)
integer
発生月で絞込:終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, … 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。
string ("only" | "without")
決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * only - 決算整理仕訳のみを集計 * without - 決算整理仕訳を除外して集計
integer
required
事業所ID
integer
取引先IDで絞込(0を指定すると、取引先が未選択で絞り込めます)
integer
部門IDで絞込(0を指定すると、部門が未選択で絞り込めます)
string
発生日で絞込:開始日(yyyy-mm-dd)
integer
会計年度(会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019)。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。
integer
発生月で絞込:開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。
string
取引先コードで絞込(事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です)
string ("only" | "without")
配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン(および旧法人ベーシックプラン)以上で利用可能で、利用できないプランで指定した場合はエラー(403)になります。 * only - 配賦仕訳のみを集計 * without - 配賦仕訳を除外して集計
string ("without_in_progress" | "all")
承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン(および旧法人プロフェッショナルプラン)以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * without_in_progress - 未承認を除く(デフォルト) * all - 全ての承認ステータスを含む
string ("partner" | "item" | "section" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag")
内訳の表示。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: 品目を指定 → エラーにならない
string ("account_item" | "group")
勘定科目の表示。指定されない場合、account_item が指定されます。 * account_item - 勘定科目単位で表示 * group - 決算書表示単位で表示

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_TRIAL_PL_SECTIONS損益計算書(部門比較)の取得

Input Parameters

integer
品目IDで絞込(0を指定すると、品目が未選択で絞り込めます)
string
発生日で絞込:終了日(yyyy-mm-dd)
integer
発生月で絞込:終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, … 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。
string ("only" | "without")
決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * only - 決算整理仕訳のみを集計 * without - 決算整理仕訳を除外して集計
integer
required
事業所ID
integer
取引先IDで絞込(0を指定すると、取引先が未選択で絞り込めます)
string
発生日で絞込:開始日(yyyy-mm-dd)
integer
会計年度(会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019)。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。
string
required
比較する部門IDの指定。半角数字のIDを半角カンマ区切り(スペースなし)で1〜5つ指定してください。同じIDを重複して指定することはできません。0を指定すると、未選択の部門で比較できます。
integer
発生月で絞込:開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。
string
取引先コードで絞込(事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です)
string ("only" | "without")
配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン(および旧法人ベーシックプラン)以上で利用可能で、利用できないプランで指定した場合はエラー(403)になります。 * only - 配賦仕訳のみを集計 * without - 配賦仕訳を除外して集計
string ("without_in_progress" | "all")
承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン(および旧法人プロフェッショナルプラン)以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * without_in_progress - 未承認を除く(デフォルト) * all - 全ての承認ステータスを含む
string ("partner" | "item" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag")
内訳の表示。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: 品目を指定 → エラーにならない
string ("account_item" | "group")
勘定科目の表示。指定されない場合、account_item が指定されます。 * account_item - 勘定科目単位で表示 * group - 決算書表示単位で表示

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_TRIAL_PL_SEGMENT_1_TAGS損益計算書(セグメント1比較)の取得

Input Parameters

integer
品目IDで絞込(0を指定すると、品目が未選択で絞り込めます)
string
発生日で絞込:終了日(yyyy-mm-dd)
integer
発生月で絞込:終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, … 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。
string ("only" | "without")
決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * only - 決算整理仕訳のみを集計 * without - 決算整理仕訳を除外して集計
integer
required
事業所ID
integer
取引先IDで絞込(0を指定すると、取引先が未選択で絞り込めます)
integer
部門IDで絞込(0を指定すると、部門が未選択で絞り込めます)
string
発生日で絞込:開始日(yyyy-mm-dd)
integer
会計年度(会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019)。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。
integer
発生月で絞込:開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。
string
取引先コードで絞込(事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です)
string ("only" | "without")
配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン(および旧法人ベーシックプラン)以上で利用可能で、利用できないプランで指定した場合はエラー(403)になります。 * only - 配賦仕訳のみを集計 * without - 配賦仕訳を除外して集計
string
required
比較するセグメント1タグIDの指定。半角数字のIDを半角カンマ区切り(スペースなし)で1〜5つ指定してください。同じIDを重複して指定することはできません。0を指定すると、未選択のセグメント1タグで比較できます。
string ("without_in_progress" | "all")
承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン(および旧法人プロフェッショナルプラン)以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * without_in_progress - 未承認を除く(デフォルト) * all - 全ての承認ステータスを含む
string ("partner" | "item" | "section" | "account_item")
内訳の表示。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: 品目を指定 → エラーにならない
string ("account_item" | "group")
勘定科目の表示。指定されない場合、account_item が指定されます。 * account_item - 勘定科目単位で表示 * group - 決算書表示単位で表示

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_TRIAL_PL_SEGMENT_2_TAGS損益計算書(セグメント2比較)の取得

Input Parameters

integer
品目IDで絞込(0を指定すると、品目が未選択で絞り込めます)
string
発生日で絞込:終了日(yyyy-mm-dd)
integer
発生月で絞込:終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, … 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。
string ("only" | "without")
決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * only - 決算整理仕訳のみを集計 * without - 決算整理仕訳を除外して集計
integer
required
事業所ID
integer
取引先IDで絞込(0を指定すると、取引先が未選択で絞り込めます)
integer
部門IDで絞込(0を指定すると、部門が未選択で絞り込めます)
string
発生日で絞込:開始日(yyyy-mm-dd)
integer
会計年度(会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019)。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。
integer
発生月で絞込:開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。
string
取引先コードで絞込(事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です)
string ("only" | "without")
配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン(および旧法人ベーシックプラン)以上で利用可能で、利用できないプランで指定した場合はエラー(403)になります。 * only - 配賦仕訳のみを集計 * without - 配賦仕訳を除外して集計
string
required
比較するセグメント2タグIDの指定。半角数字のIDを半角カンマ区切り(スペースなし)で1〜5つ指定してください。同じIDを重複して指定することはできません。0を指定すると、未選択のセグメント2タグで比較できます。
string ("without_in_progress" | "all")
承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン(および旧法人プロフェッショナルプラン)以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * without_in_progress - 未承認を除く(デフォルト) * all - 全ての承認ステータスを含む
string ("partner" | "item" | "section" | "account_item")
内訳の表示。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: 品目を指定 → エラーにならない
string ("account_item" | "group")
勘定科目の表示。指定されない場合、account_item が指定されます。 * account_item - 勘定科目単位で表示 * group - 決算書表示単位で表示

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_TRIAL_PL_SEGMENT_3_TAGS損益計算書(セグメント3比較)の取得

Input Parameters

integer
品目IDで絞込(0を指定すると、品目が未選択で絞り込めます)
string
発生日で絞込:終了日(yyyy-mm-dd)
integer
発生月で絞込:終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, … 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。
string ("only" | "without")
決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * only - 決算整理仕訳のみを集計 * without - 決算整理仕訳を除外して集計
integer
required
事業所ID
integer
取引先IDで絞込(0を指定すると、取引先が未選択で絞り込めます)
integer
部門IDで絞込(0を指定すると、部門が未選択で絞り込めます)
string
発生日で絞込:開始日(yyyy-mm-dd)
integer
会計年度(会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019)。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。
integer
発生月で絞込:開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。
string
取引先コードで絞込(事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です)
string ("only" | "without")
配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン(および旧法人ベーシックプラン)以上で利用可能で、利用できないプランで指定した場合はエラー(403)になります。 * only - 配賦仕訳のみを集計 * without - 配賦仕訳を除外して集計
string
required
比較するセグメント3タグIDの指定。半角数字のIDを半角カンマ区切り(スペースなし)で1〜5つ指定してください。同じIDを重複して指定することはできません。0を指定すると、未選択のセグメント3タグで比較できます。
string ("without_in_progress" | "all")
承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン(および旧法人プロフェッショナルプラン)以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * without_in_progress - 未承認を除く(デフォルト) * all - 全ての承認ステータスを含む
string ("partner" | "item" | "section" | "account_item")
内訳の表示。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: 品目を指定 → エラーにならない
string ("account_item" | "group")
勘定科目の表示。指定されない場合、account_item が指定されます。 * account_item - 勘定科目単位で表示 * group - 決算書表示単位で表示

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_TRIAL_PL_THREE_YEARS損益計算書(3期間比較)の取得

Input Parameters

integer
品目IDで絞込(0を指定すると、品目が未選択で絞り込めます)
string
発生日で絞込:終了日(yyyy-mm-dd)
integer
発生月で絞込:終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, … 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。
string ("only" | "without")
決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * only - 決算整理仕訳のみを集計 * without - 決算整理仕訳を除外して集計
integer
required
事業所ID
integer
取引先IDで絞込(0を指定すると、取引先が未選択で絞り込めます)
integer
部門IDで絞込(0を指定すると、部門が未選択で絞り込めます)
string
発生日で絞込:開始日(yyyy-mm-dd)
integer
会計年度(会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019)。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。
integer
発生月で絞込:開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。
string
取引先コードで絞込(事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です)
string ("only" | "without")
配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン(および旧法人ベーシックプラン)以上で利用可能で、利用できないプランで指定した場合はエラー(403)になります。 * only - 配賦仕訳のみを集計 * without - 配賦仕訳を除外して集計
string ("without_in_progress" | "all")
承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン(および旧法人プロフェッショナルプラン)以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * without_in_progress - 未承認を除く(デフォルト) * all - 全ての承認ステータスを含む
string ("partner" | "item" | "section" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag")
内訳の表示。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: 品目を指定 → エラーにならない
string ("account_item" | "group")
勘定科目の表示。指定されない場合、account_item が指定されます。 * account_item - 勘定科目単位で表示 * group - 決算書表示単位で表示

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_TRIAL_PL_TWO_YEARS損益計算書(前年比較)の取得

Input Parameters

integer
品目IDで絞込(0を指定すると、品目が未選択で絞り込めます)
string
発生日で絞込:終了日(yyyy-mm-dd)
integer
発生月で絞込:終了会計月(1-12)(会計年度が10月始まりでstart_monthが11なら11, 12, 1, … 9のいずれかを指定する)。指定されない場合、現在の会計年度の期末月が指定されます。
string ("only" | "without")
決算整理仕訳の絞り込み条件。指定されない場合、決算整理仕訳を含む金額が返却されます。 * only - 決算整理仕訳のみを集計 * without - 決算整理仕訳を除外して集計
integer
required
事業所ID
integer
取引先IDで絞込(0を指定すると、取引先が未選択で絞り込めます)
integer
部門IDで絞込(0を指定すると、部門が未選択で絞り込めます)
string
発生日で絞込:開始日(yyyy-mm-dd)
integer
会計年度(会計期間の開始日が属する年。例: 会計期間が 2019-04-01 開始なら 2019)。会計年度の作成後に期間を変更した場合などに、指定した年と実際に集計対象となる会計年度がずれることがあります。意図した期間が集計されない場合は、fiscal_year ではなく start_date・end_date で期間を指定してください。
integer
発生月で絞込:開始会計月(1-12)。指定されない場合、現在の会計年度の期首月が指定されます。
string
取引先コードで絞込(事業所設定で取引先コードの利用を有効にしている場合のみ利用可能です)
string ("only" | "without")
配賦仕訳の絞り込み条件。指定されない場合、配賦仕訳を含む金額が返却されます。法人スタンダードプラン(および旧法人ベーシックプラン)以上で利用可能で、利用できないプランで指定した場合はエラー(403)になります。 * only - 配賦仕訳のみを集計 * without - 配賦仕訳を除外して集計
string ("without_in_progress" | "all")
承認ステータスの絞り込み条件。プレミアムプラン、法人アドバンスプラン(および旧法人プロフェッショナルプラン)以上で、かつ事業所の設定から仕訳承認フローの利用を有効にした場合に指定可能です。 * without_in_progress - 未承認を除く(デフォルト) * all - 全ての承認ステータスを含む
string ("partner" | "item" | "section" | "account_item" | "segment_1_tag" | "segment_2_tag" | "segment_3_tag")
内訳の表示。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: 品目を指定 → エラーにならない
string ("account_item" | "group")
勘定科目の表示。指定されない場合、account_item が指定されます。 * account_item - 勘定科目単位で表示 * group - 決算書表示単位で表示

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_USER_MATCHER自動登録ルールの取得

Input Parameters

integer
required
事業所ID
integer
required
自動登録ルールID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_WALLETABLEGet Walletable using the official freee Accounting API operation.

Input Parameters

integer
required
Official freee field id.
string ("bank_account" | "credit_card" | "wallet")
required
Official freee field type.
integer
required
Official freee field company_id.
boolean
Official freee field with_sync_status.
boolean
Official freee field with_last_synced_at.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_WALLET_TRANSACTIONGet Wallet Transaction using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_YEAREND_ADJUSTMENT_EMPLOYEECall the official freee HR operation to get yearend adjustment employee.

Input Parameters

integer
required
Path parameter year from the freee HR API.
integer
required
Query parameter company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_GET_YEAREND_ADJUSTMENT_EMPLOYEESCall the official freee HR operation to get yearend adjustment employees.

Input Parameters

integer
required
Path parameter year from the freee HR API.
integer
Query parameter limit from the freee HR API.
integer
Query parameter offset from the freee HR API.
integer
required
Query parameter company_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_ACCOUNTING_SECTIONSList organizational sections configured in a freee Accounting company, optionally filtered by update date.

Input Parameters

integer
required
Company ID whose Accounting sections to list.
string
Inclusive latest update date in YYYY-MM-DD format (JST).
string
Inclusive earliest update date in YYYY-MM-DD format (JST).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_ACCOUNT_ITEMSList or search the chart-of-accounts items available in a freee Accounting company.

Input Parameters

string
Partial-match search across account item code, name, and shortcuts; space- or tab-separated terms use AND matching.
string
Date in YYYY-MM-DD used to resolve each account item’s default tax code; defaults to the request date.
integer
required
Company ID whose account items to list.
string
Inclusive latest update date in YYYY-MM-DD format.
string
Inclusive earliest update date in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_APPROVAL_FLOW_ROUTES申請経路一覧の取得

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_APPROVAL_REQUEST_FORMSList Approval Request Forms using the official freee Accounting API operation.

Input Parameters

integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_APPROVAL_REQUESTSList Approval Requests using the official freee Accounting API operation.

Input Parameters

integer
Official freee field limit.
string
Official freee field title.
integer
Official freee field offset.
string ("draft" | "in_progress" | "approved" | "rejected" | "feedback")
Official freee field status.
integer
Official freee field form_id.
integer
required
Official freee field company_id.
integer
Official freee field max_amount.
integer
Official freee field min_amount.
integer
Official freee field approver_id.
integer
Official freee field applicant_id.
integer
Official freee field application_number.
string
Official freee field end_application_date.
string
Official freee field start_application_date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_BANKSList Banks using the official freee Accounting API operation.

Input Parameters

string ("bank_account" | "credit_card" | "wallet")
Official freee field type.
integer
Official freee field limit.
integer
Official freee field offset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_COMPANIESList freee Accounting companies associated with the connected user; use a company-scoped call to confirm the selected token can access a listed company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_COMPANY_TAXESList Company Taxes using the official freee Accounting API contract.

Input Parameters

boolean
Official freee Accounting available value.
integer
required
Official freee Accounting company id value.
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")
Official freee Accounting display category value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_DEALSList income or expense deals in a freee Accounting company with date, settlement, partner, and account-item filters.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_EMPLOYEESList 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

integer
Maximum employees to return on this page (1-100).
integer
required
HR company ID whose employees to list.
string
Opaque continuation cursor returned by a previous call; omit for the first page.
boolean
Whether to include employees excluded from payroll calculation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_EXPENSE_APPLICATION_CURRENCIESList Expense Application Currencies using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting company id value.
string ("usable" | "unusable")
Official freee Accounting search status value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_EXPENSE_APPLICATION_LINE_TEMPLATES経費科目一覧の取得

Input Parameters

integer
取得レコードの件数 (デフォルト: 20, 最小: 1, 最大: 100)
integer
取得レコードのオフセット (デフォルト: 0)
integer
required
事業所ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_EXPENSE_APPLICATIONSList Expense Applications using the official freee Accounting API operation.

Input Parameters

integer
Official freee field limit.
string
Official freee field title.
integer
Official freee field offset.
string ("draft" | "in_progress" | "approved" | "rejected" | "feedback" | "unsettled" | "settled")
Official freee field status.
integer
required
Official freee field company_id.
integer
Official freee field max_amount.
integer
Official freee field min_amount.
integer
Official freee field approver_id.
integer
Official freee field applicant_id.
string
Official freee field end_issue_date.
boolean
Official freee field payroll_attached.
string
Official freee field start_issue_date.
integer
Official freee field application_number.
string
Official freee field end_transaction_date.
string
Official freee field start_transaction_date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_FIXED_ASSETSList Fixed Assets using the official freee Accounting API contract.

Input Parameters

integer
Official freee Accounting limit value.
integer
Official freee Accounting offset value.
integer
required
Official freee Accounting company id value.
string
required
Official freee Accounting target date value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_FORM_SELECTABLESList Form Selectables using the official freee Accounting API contract.

Input Parameters

string
Official freee Accounting includes value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_GENERAL_LEDGERSList General Ledgers using the official freee Accounting API operation.

Input Parameters

string
required
Official freee field end_date.
string
Official freee field tag_name.
string ("課税" | "対象外" | "非課税" | "不課税" | "輸出等" | "未選択" | "課税売上" | "輸出売上" | "非課売上" | "非資売上" | "有価譲渡" | "対外売上" | "課税売返" | "輸出売返" | "非課売返" | "非資売返" | "課税売倒" | "輸出売倒" | "非課売倒" | "非資売倒" | "課税売回" | "課対輸本" | "非対輸本" | "共対輸本" | "課対輸税" | "非対輸税" | "共対輸税" | "地消貨割" | "課対仕入" | "非対仕入" | "共対仕入" | "非課仕入" | "対外仕入" | "課対仕返" | "非対仕返" | "共対仕返" | "非課仕返" | "課売上一" | "課売上二" | "課売上三" | "課売上四" | "課売上五" | "課売上六" | "課対輸返" | "非対輸返" | "共対輸返" | "課売返一" | "課売返二" | "課売返三" | "課売返四" | "課売返五" | "課売返六")
Official freee field tax_name.
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")
Official freee field tax_rate.
string
Official freee field item_name.
string ("only" | "without")
Official freee field adjustment.
integer
required
Official freee field company_id.
string
required
Official freee field start_date.
string
Official freee field partner_name.
string
Official freee field section_name.
string ("only" | "without")
Official freee field cost_allocation.
string
Official freee field account_item_name.
string
Official freee field segment_tag_1_name.
string
Official freee field segment_tag_2_name.
string
Official freee field segment_tag_3_name.
string ("without_in_progress" | "all")
Official freee field approval_flow_status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_HR_ALLOWANCESList configured allowance types in a freee HR company, optionally filtered by frequency and active status.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_HR_DEDUCTIONSList configured deduction types in a freee HR company, optionally filtered by frequency and active status.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_HR_GROUPSList the organizational groups and hierarchy configured in a freee HR company.

Input Parameters

integer
required
HR company ID whose organizational groups to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_HR_POSITIONSList job positions configured in a freee HR company, including their IDs, codes, and names.

Input Parameters

integer
required
HR company ID whose job positions to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_INVOICESList current invoices from the freee Invoice API. This does not use the retired freee Accounting invoices endpoint.

Input Parameters

integer
Number of invoices to return (maximum 100).
integer
Zero-based result offset. limit plus offset cannot exceed 10,000.
string
Invoice subject.
integer
required
freee company ID.
string ("registered" | "unregistered")
Filter by accounting deal registration status.
array
Return invoices for up to three partner IDs.
string ("canceled" | "uncanceled")
Filter by cancellation status.
string
Exact invoice number.
string ("settled" | "unsettled" | "canceled" | "unprocessed" | "failed")
Filter by payment status.
string ("sent" | "unsent")
Filter by sending status.
string
Latest billing date (YYYY-MM-DD).
string
Latest payment due date (YYYY-MM-DD).
string
Earliest billing date (YYYY-MM-DD).
string
Earliest payment due date (YYYY-MM-DD).
boolean
Include documents created by freee Sales. Requires access to those documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_ITEMSList Items using the official freee Accounting API contract.

Input Parameters

integer
Official freee Accounting limit value.
integer
Official freee Accounting offset value.
integer
required
Official freee Accounting company id value.
string
Official freee Accounting end update date value.
string
Official freee Accounting start update date value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_MANUAL_JOURNALSList Manual Journals using the official freee Accounting API operation.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_PARTNERSList or search non-archived business partners in a freee Accounting company, returning one bounded page per call.

Input Parameters

integer
Maximum partners to return on this page (1-3000).
string
Partial-match search across partner code, names, kana names, and shortcuts; space-separated terms use AND matching.
integer
required
Company ID whose partners to list.
string
Inclusive latest update date in YYYY-MM-DD format.
string
Opaque continuation cursor returned by a previous call; omit for the first page.
string
Inclusive earliest update date in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_PAYMENT_REQUESTSList Payment Requests using the official freee Accounting API contract.

Input Parameters

integer
Official freee Accounting limit value.
string
Official freee Accounting title value.
integer
Official freee Accounting offset value.
string ("draft" | "in_progress" | "approved" | "rejected" | "feedback" | "unsettled" | "settled")
Official freee Accounting status value.
string ("ignore_observing" | "only_observing")
Official freee Accounting observing value.
integer
required
Official freee Accounting company id value.
integer
Official freee Accounting max amount value.
integer
Official freee Accounting min amount value.
integer
Official freee Accounting partner id value.
integer
Official freee Accounting section id value.
integer
Official freee Accounting approver id value.
integer
Official freee Accounting applicant id value.
string
Official freee Accounting partner code value.
string
Official freee Accounting partner name value.
string
Official freee Accounting document code value.
string
Official freee Accounting end issue date value.
string ("none" | "domestic_bank_transfer" | "abroad_bank_transfer" | "account_transfer" | "credit_card")
Official freee Accounting payment method value.
string
Official freee Accounting end payment date value.
string
Official freee Accounting start issue date value.
integer
Official freee Accounting application number value.
string
Official freee Accounting start payment date value.
string
Official freee Accounting end application date value.
integer
Official freee Accounting approval flow route id value.
string
Official freee Accounting start application date value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_PURCHASE_REQUEST_FORMSList Purchase Request Forms using the official freee Accounting API contract.

Input Parameters

integer
Official freee Accounting limit value.
integer
Official freee Accounting offset value.
string ("draft" | "active" | "deleted")
Official freee Accounting status value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_PURCHASE_REQUESTSList Purchase Requests using the official freee Accounting API contract.

Input Parameters

integer
Official freee Accounting limit value.
integer
Official freee Accounting offset value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_QUOTATIONSList current quotations from the freee Invoice API. This does not use the retired freee Accounting quotations endpoint.

Input Parameters

integer
Number of quotations to return (maximum 100).
integer
Zero-based result offset. limit plus offset cannot exceed 10,000.
string
Quotation subject.
integer
required
freee company ID.
array
Return quotations for up to three partner IDs.
string ("canceled" | "uncanceled")
Filter by cancellation status.
string ("sent" | "unsent")
Filter by sending status.
string
Exact quotation number.
string
Latest quotation date (YYYY-MM-DD).
string
Latest expiration date (YYYY-MM-DD).
string
Earliest quotation date (YYYY-MM-DD).
string
Earliest expiration date (YYYY-MM-DD).
boolean
Include documents created by freee Sales. Requires access to those documents.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_RECEIPTSList Receipts using the official freee Accounting API operation.

Input Parameters

integer
Official freee field limit.
integer
Official freee field number.
integer
Official freee field offset.
string ("all" | "without_deal" | "with_expense_application_line" | "with_deal" | "ignored")
Official freee field category.
string
required
Official freee field end_date.
string
Official freee field user_name.
integer
required
Official freee field company_id.
string
required
Official freee field start_date.
string ("posted" | "raised" | "resolved")
Official freee field comment_type.
boolean
Official freee field comment_important.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_SEGMENT_TAGSセグメントタグ一覧の取得

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_TAGSList Tags using the official freee Accounting API operation.

Input Parameters

integer
Official freee field limit.
integer
Official freee field offset.
integer
required
Official freee field company_id.
string
Official freee field end_update_date.
string
Official freee field start_update_date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_TAX_CODESList Tax Codes using the official freee Accounting API contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_TRANSFERSList Transfers using the official freee Accounting API contract.

Input Parameters

integer
Official freee Accounting limit value.
integer
Official freee Accounting offset value.
string
Official freee Accounting end date value.
integer
required
Official freee Accounting company id value.
string
Official freee Accounting start date value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_USER_MATCHERS自動登録ルール一覧の取得

Input Parameters

integer ("0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "10" | "11" | "12")
登録タイプで絞込 * 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)
integer
取得レコードの件数 (デフォルト: 30, 最大: 100)
string ("active" | "inactive" | "all")
有効/無効/全てで絞込 (有効: active, 無効: inactive, 全て: all)。未指定の場合は有効なルールのみが返ります。
integer
取得レコードのオフセット (デフォルト: 0)。offsetはlimitの倍数である必要があります。
integer
required
事業所ID
integer ("0" | "1")
作成経由で絞込 * 0: ユーザーが作成(user) * 1: freeeが作成(freee)
integer
最大金額で絞込 (単位: 円)。ルールに設定された最大金額(max_amount)が指定値以下のルールを返します。
integer
最小金額で絞込 (単位: 円)。ルールに設定された最小金額(min_amount)が指定値以上のルールを返します。
string
口座名で絞込 (完全一致)。指定した名前の口座が事業所に存在しない場合は空の一覧が返ります。
string
説明文で絞込 (部分一致)
integer
最大優先度で絞込。優先度(priority)が指定値以下のルールを返します。
integer
最小優先度で絞込。優先度(priority)が指定値以上のルールを返します。
integer
カードラベルIDで絞込
string ("income" | "expense")
入金/出金で絞込 (入金: income, 出金: expense)
integer
最大正答件数で絞込。適用明細数(corrected_wallet_txn_count)が指定値以下のルールを返します。
integer
最小正答件数で絞込。適用明細数(corrected_wallet_txn_count)が指定値以上のルールを返します。
integer
最大正答率で絞込 (単位: パーセント)。適用率(corrected_wallet_txn_count_percentage)が指定値以下のルールを返します。
integer
最小正答率で絞込 (単位: パーセント)。適用率(corrected_wallet_txn_count_percentage)が指定値以上のルールを返します。

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_USERS事業所に所属するユーザー一覧の取得

Input Parameters

integer
取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 3000)
integer
required
事業所ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_WALLETABLESList Walletables using the official freee Accounting API operation.

Input Parameters

string ("bank_account" | "credit_card" | "wallet")
Official freee field type.
integer
required
Official freee field company_id.
boolean
Official freee field with_balance.
string
Official freee field end_update_date.
boolean
Official freee field with_sync_status.
string
Official freee field start_update_date.
boolean
Official freee field with_last_synced_at.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_LIST_WALLET_TRANSACTIONSList Wallet Transactions using the official freee Accounting API contract.

Input Parameters

integer
Official freee Accounting limit value.
integer
Official freee Accounting offset value.
string
Official freee Accounting end date value.
string
Official freee Accounting sort type value.
integer
required
Official freee Accounting company id value.
string ("income" | "expense")
Official freee Accounting entry side value.
string
Official freee Accounting start date value.
integer
Official freee Accounting walletable id value.
string ("bank_account" | "credit_card" | "wallet")
Official freee Accounting walletable type value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_POST_YEAREND_ADJUSTMENT_HOUSING_LOANCall the official freee HR operation to post yearend adjustment housing loan.

Input Parameters

integer
required
Path parameter year from the freee HR API.
integer
required
Request body field company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.
object
required
Request body field housing_loan from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_POST_YEAREND_ADJUSTMENT_INSURANCESCall the official freee HR operation to post yearend adjustment insurances.

Input Parameters

integer
required
Path parameter year from the freee HR API.
object
required
Request body field insurance from the freee HR API.
integer
required
Request body field company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_PUT_YEAREND_ADJUSTMENT_DEPENDENTSCall the official freee HR operation to put yearend adjustment dependents.

Input Parameters

integer
required
Path parameter year from the freee HR API.
integer
required
Request body field company_id from the freee HR API.
array
required
Request body field dependents from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_PUT_YEAREND_ADJUSTMENT_EMPLOYEECall the official freee HR operation to put yearend adjustment employee.

Input Parameters

integer
required
Path parameter year from the freee HR API.
object
required
Request body field employee from the freee HR API.
integer
required
Request body field company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_PUT_YEAREND_ADJUSTMENT_HOUSING_LOANCall the official freee HR operation to put yearend adjustment housing loan.

Input Parameters

integer
required
Path parameter id from the freee HR API.
integer
required
Path parameter year from the freee HR API.
integer
required
Request body field company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.
object
required
Request body field housing_loan from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_PUT_YEAREND_ADJUSTMENT_HOUSING_LOAN_DEDUCTIONCall the official freee HR operation to put yearend adjustment housing loan deduction.

Input Parameters

integer
required
Path parameter year from the freee HR API.
integer
required
Request body field company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.
integer
required
Request body field housing_loan_deduction from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_PUT_YEAREND_ADJUSTMENT_INSURANCESCall the official freee HR operation to put yearend adjustment insurances.

Input Parameters

integer
required
Path parameter id from the freee HR API.
integer
required
Path parameter year from the freee HR API.
object
required
Request body field insurance from the freee HR API.
integer
required
Request body field company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_PUT_YEAREND_ADJUSTMENT_PAYROLL_AND_BONUSCall the official freee HR operation to put yearend adjustment payroll and bonus.

Input Parameters

integer
required
Path parameter year from the freee HR API.
integer
required
Request body field company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.
object
required
Request body field payroll_and_bonus from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_PUT_YEAREND_ADJUSTMENT_PREVIOUS_JOBCall the official freee HR operation to put yearend adjustment previous job.

Input Parameters

integer
required
Path parameter year from the freee HR API.
integer
required
Request body field company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.
object
required
Request body field previous_job from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_ACCOUNTING_SECTIONUpdate Accounting Section using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
string
Section code. Omitting this field or sending null clears the existing code; send the current value to preserve it.
string
required
Official freee Accounting name value.
string
Official freee Accounting long name value.
integer
Official freee Accounting parent id value.
string
Official freee Accounting shortcut1 value.
string
Official freee Accounting shortcut2 value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_ACCOUNT_ITEM勘定科目の更新

Input Parameters

integer
required
事業所ID
object
required
Provider body field account_item.
integer
required
勘定科目ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_APPROVAL_REQUESTUpdate Approval Request using the official freee Accounting API operation.

Input Parameters

integer
required
Official freee field id.
boolean
required
Official freee field draft.
integer
required
Official freee field company_id.
integer
Official freee field approver_id.
array
required
Official freee field request_items.
string
Official freee field application_date.
integer
Official freee field applicant_group_id.
integer
Official freee field approval_flow_group_id.
integer
required
Official freee field approval_flow_route_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_APPROVAL_REQUESTS_MONTHLY_ATTENDANCEUpdate 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

integer
required
月次勤怠締め申請ID
integer
required
事業所ID(必須)
integer
承認者のユーザーID
integer
required
申請経路ID(必須)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_APPROVAL_REQUESTS_OVERTIME_WORKUpdate 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

integer
required
残業申請ID
object
required
JSON request body defined by the freee HR OpenAPI contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_APPROVAL_REQUESTS_PAID_HOLIDAYUpdate 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

integer
required
有給休暇申請ID
string
required
JSON request body defined by the freee HR OpenAPI contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_APPROVAL_REQUESTS_SPECIAL_HOLIDAYUpdate 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

integer
required
特別休暇申請ID
string
取得予定終了時間(条件付き必須) 取得単位が半休、時間休の場合は必須
string
申請理由
string
取得予定開始時間(条件付き必須) 取得単位が半休、時間休の場合は必須
integer
required
事業所ID(必須)
integer
承認者のユーザーID
string
required
対象日(必須)
string ("full" | "half" | "morning" | "afternoon" | "hour")
required
取得単位(必須)(full:全休、half:半休、morning:午前休、 afternoon:午後休、hour:時間休)
integer
required
申請経路ID(必須)
integer
required
特別休暇設定ID(必須)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_APPROVAL_REQUESTS_WORK_TIMEUpdate 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

integer
required
勤務時間修正申請ID
string
申請理由
integer
required
事業所ID(必須)
integer
承認者のユーザーID
string
required
対象日(必須)
array
勤務時間のリスト
array
休憩時間のリスト
integer
遅刻分の時間(分単位)
boolean
false: 勤務時間を修正する true: 勤務時間を削除する 勤務時間を削除する場合は以下のパラメータは指定しないでください。 - work_records - lateness_mins - early_leaving_mins - break_records
integer
早退分の時間(分単位)
integer
required
申請経路ID(必須)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_CURRENT_USERログインユーザーの更新

Input Parameters

string
氏名(姓) (20文字以内)。キーを省略した場合は更新されません。空文字を指定すると未設定になります。
string
氏名(名) (20文字以内)。キーを省略した場合は更新されません。空文字を指定すると未設定になります。
string
表示名 (20文字以内)。キーを省略した場合は更新されません。空文字を指定すると未設定になります。
string
氏名(カナ・姓) (20文字以内)。キーを省略した場合は更新されません。空文字を指定すると未設定になります。
string
氏名(カナ・名) (20文字以内)。キーを省略した場合は更新されません。空文字を指定すると未設定になります。

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_DEAL取引(収入・支出)の更新

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_DEAL_PAYMENT取引(収入・支出)の支払行の更新

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_DEAL_RENEWUpdate Deal Renew using the official freee Accounting API operation.

Input Parameters

integer
required
Official freee field id.
array
required
Official freee field details.
integer
required
Official freee field renew_id.
integer
required
Official freee field company_id.
string
required
Official freee field update_date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_EMPLOYEEUpdate Employee through the freee HR API.

Input Parameters

integer
required
従業員ID
object
required
JSON request body defined by the freee HR OpenAPI contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_EMPLOYEE_ALLOWANCE_RULESCall the official freee HR operation to update employee allowance rules.

Input Parameters

integer
required
Request body field year from the freee HR API.
integer
required
Request body field month from the freee HR API.
integer
required
Request body field company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.
object
required
Request body field employee_allowance_rule from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_EMPLOYEE_BANK_ACCOUNT_RULECall the official freee HR operation to update employee bank account rule.

Input Parameters

integer
required
Request body field year from the freee HR API.
integer
required
Request body field month from the freee HR API.
integer
required
Request body field company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.
object
required
Request body field employee_bank_account_rule from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_EMPLOYEE_BASIC_PAY_RULECall the official freee HR operation to update employee basic pay rule.

Input Parameters

integer
required
Request body field year from the freee HR API.
integer
required
Request body field month from the freee HR API.
integer
required
Request body field company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.
object
required
Request body field employee_basic_pay_rule from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_EMPLOYEE_DEDUCTION_RULESUpdate Employee Deduction Rules through the freee HR API.

Input Parameters

integer
required
更新対象の控除ルールを判定する締め年
integer
required
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.
object
required
JSON request body defined by the freee HR OpenAPI contract.
integer
required
事業所ID
integer
required
従業員ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_EMPLOYEE_HEALTH_INSURANCE_RULEUpdate Employee Health Insurance Rule through the freee HR API.

Input Parameters

object
required
JSON request body defined by the freee HR OpenAPI contract.
integer
required
従業員ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_EMPLOYEE_PAYROLL_STATEMENT_REMARK給与明細の備考の更新

Input Parameters

integer
required
更新対象の年
integer
required
更新対象の月
object
required
Value accepted by freee HR.
integer
required
事業所ID
integer
required
従業員ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_EMPLOYEE_PROFILE_RULEUpdate Employee Profile Rule through the freee HR API.

Input Parameters

object
required
JSON request body defined by the freee HR OpenAPI contract.
integer
required
従業員ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_EMPLOYEES_ATTENDANCE_TAGSReplace an employee’s attendance tags for a date. freee rejects changes after the corresponding month summary has been finalized.

Input Parameters

string
required
更新対象年月日(YYYY-MM-DD)(例:2018-08-01)
object
required
JSON request body defined by the freee HR OpenAPI contract.
integer
required
従業員ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_EMPLOYEES_ATTENDANCE_TAG_SUMMARIES勤怠タグ月次サマリの更新

Input Parameters

integer
required
勤怠タグサマリを更新したい年
integer
required
勤怠タグサマリを更新したい月
integer
required
事業所ID
integer
required
従業員ID
array
required
更新対象の勤怠タグサマリのリスト

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_EMPLOYEE_WELFARE_PENSION_INSURANCE_RULE従業員の厚生年金保険の更新

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_EMPLOYEE_WORK_RECORDUpdate an employee’s daily work record. freee rejects changes after the corresponding month summary has been finalized.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_EMPLOYEE_WORK_RECORD_SUMMARYCall the official freee HR operation to update employee work record summary.

Input Parameters

integer
required
Path parameter year from the freee HR API.
integer
required
Path parameter month from the freee HR API.
number
Request body field work_days from the freee HR API.
integer
required
Request body field company_id from the freee HR API.
integer
required
Path parameter employee_id from the freee HR API.
number
Request body field num_absences from the freee HR API.
integer
Request body field total_work_mins from the freee HR API.
number
Request body field num_paid_holidays from the freee HR API.
integer
Request body field total_lateness_mins from the freee HR API.
number
Request body field work_days_on_weekdays from the freee HR API.
integer
Request body field total_normal_work_mins from the freee HR API.
integer
Request body field total_holiday_work_mins from the freee HR API.
integer
Request body field total_early_leaving_mins from the freee HR API.
integer
Request body field total_overtime_work_mins from the freee HR API.
integer
Request body field total_shortage_work_mins from the freee HR API.
integer
Request body field total_latenight_work_mins from the freee HR API.
number
Request body field num_absences_for_deduction from the freee HR API.
Request body field work_days_on_legal_holidays from the freee HR API.
integer
Request body field total_excess_statutory_work_mins from the freee HR API.
number
Request body field work_days_on_prescribed_holidays from the freee HR API.
integer
Request body field total_lateness_mins_for_deduction from the freee HR API.
integer
Request body field total_prescribed_holiday_work_mins from the freee HR API.
integer
Request body field total_early_leaving_mins_for_deduction from the freee HR API.
integer
Request body field total_actual_excess_statutory_work_mins from the freee HR API.
integer
Request body field total_deemed_paid_excess_statutory_work_mins from the freee HR API.
integer
Request body field total_deemed_paid_overtime_except_normal_work_mins from the freee HR API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_EXPENSE_APPLICATIONUpdate Expense Application using the official freee Accounting API operation.

Input Parameters

integer
required
Official freee field id.
boolean
Official freee field draft.
string
required
Official freee field title.
array
Official freee field tag_ids.
integer
Official freee field parent_id.
integer
required
Official freee field company_id.
string
Official freee field issue_date.
integer
Official freee field section_id.
integer
Official freee field approver_id.
string
Official freee field description.
string
Official freee field parent_type.
array
Official freee field purchase_lines.
integer
Official freee field segment_1_tag_id.
integer
Official freee field segment_2_tag_id.
integer
Official freee field segment_3_tag_id.
integer
Official freee field applicant_group_id.
integer
Official freee field approval_flow_group_id.
integer
Official freee field approval_flow_route_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_EXPENSE_APPLICATION_CURRENCYUpdate Expense Application Currency using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
string
required
Official freee Accounting code value.
string
required
Official freee Accounting name value.
integer
required
Official freee Accounting company id value.
string
Official freee Accounting description value.
string ("usable" | "unusable")
required
Official freee Accounting search status value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_EXPENSE_APPLICATION_FORMUpdate Expense Application Form using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting company id value.
string ("optional" | "required" | "disable")
required
Official freee Accounting tag setting value.
boolean
required
Official freee Accounting use currency value.
string
required
Official freee Accounting default title value.
string ("optional" | "required")
required
Official freee Accounting section setting value.
string ("disable" | "enable")
required
Official freee Accounting observer addition value.
string ("optional" | "required")
required
Official freee Accounting description setting value.
string ("optional" | "required" | "disable")
required
Official freee Accounting line template setting value.
string ("optional" | "required" | "disable")
required
Official freee Accounting segment 1 tag setting value.
string ("optional" | "required" | "disable")
required
Official freee Accounting segment 2 tag setting value.
string ("optional" | "required" | "disable")
required
Official freee Accounting segment 3 tag setting value.
string ("disable" | "enable")
required
Official freee Accounting commuter pass deduction value.
boolean
required
Official freee Accounting allow modify on approval value.
string
required
Official freee Accounting default flow route src id value.
string ("optional" | "required" | "disable")
required
Official freee Accounting receipt partner name setting value.
boolean
required
Official freee Accounting require parent purchase request value.
string ("omit" | "round_up" | "round")
required
Official freee Accounting auto calculation amount fraction value.
boolean
required
Official freee Accounting allow modify parent application by admin value.
boolean
required
Official freee Accounting allow modify parent application by approver value.
boolean
required
Official freee Accounting allow modify parent application by applicant value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_EXPENSE_APPLICATION_LINE_TEMPLATE経費科目の更新

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_EXPENSE_APPLICATION_PARENT_REQUESTSLink 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

integer
required
Official freee field id.
string
required
ID of the approved general request to link to this expense application. Send null to remove the current link.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_HR_GROUPUpdate 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

string
required
Required replacement group code: pass a 1-255 character string to set or preserve it, or pass null to clear it.
string
required
Replacement group name, 1-255 characters.
integer
required
Group ID to update.
integer
required
HR company ID that owns the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_ITEMUpdate Item using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
string
Item code. Omitting this field or sending null clears the existing code; send the current value to preserve it.
string
required
Official freee Accounting name value.
string
Official freee Accounting shortcut1 value.
string
Official freee Accounting shortcut2 value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_MANUAL_JOURNALUpdate Manual Journal using the official freee Accounting API operation.

Input Parameters

integer
required
Official freee field id.
array
required
Official freee field details.
boolean
Official freee field adjustment.
integer
required
Official freee field company_id.
string
required
Official freee field issue_date.
string
Official freee field ref_number.
array
Official freee field receipt_ids.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_PARTNERUpdate the name, availability, and common contact fields of an existing freee Accounting partner.

Input Parameters

string
required
Unique partner display name, up to 255 characters; required by freee even for a partial update.
string
Replacement partner contact email address.
string
Replacement partner contact phone number.
boolean
Whether the partner remains available in Accounting input suggestions.
string
Formal legal or trade name, up to 255 characters.
integer
required
Company ID that owns the partner.
integer
required
Partner ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_PARTNER_BY_CODEUpdate Partner By Code using the official freee Accounting API operation.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_PAYMENT_REQUESTUpdate Payment Request using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
boolean
required
Official freee Accounting draft value.
string
required
Official freee Accounting title value.
string
Official freee Accounting bank code value.
string
Official freee Accounting bank name value.
integer
required
Official freee Accounting company id value.
string
required
Official freee Accounting issue date value.
integer
Official freee Accounting partner id value.
integer
Official freee Accounting approver id value.
string
Official freee Accounting branch code value.
string
Official freee Accounting branch kana value.
string
Official freee Accounting branch name value.
string
Official freee Accounting description value.
array
Official freee Accounting receipt ids value.
string
Official freee Accounting account name value.
string ("ordinary" | "checking" | "earmarked" | "savings" | "other")
Official freee Accounting account type value.
string
Official freee Accounting partner code value.
string
Official freee Accounting payment date value.
string
Official freee Accounting document code value.
string
Official freee Accounting account number value.
string
Official freee Accounting bank name kana value.
string ("none" | "domestic_bank_transfer" | "abroad_bank_transfer" | "account_transfer" | "credit_card")
Official freee Accounting payment method value.
string
Official freee Accounting application date value.
integer
Official freee Accounting applicant group id value.
array
required
Official freee Accounting payment request lines value.
integer
Official freee Accounting approval flow group id value.
integer
required
Official freee Accounting approval flow route id value.
string ("qualified" | "not_qualified" | "unspecified")
Official freee Accounting qualified invoice status value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_POSITION役職の更新

Input Parameters

integer
required
役職ID
object
required
Value accepted by freee HR.
integer
required
作成対象事業所ID(必須)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_PURCHASE_REQUESTUpdate Purchase Request using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
string
Official freee Accounting title value.
string ("draft" | "in_progress")
required
Use draft to save without submitting, or in_progress to submit for approval.
integer
required
Official freee Accounting company id value.
string
Official freee Accounting description value.
integer
Official freee Accounting applicant group id value.
string
Official freee Accounting occurrence end date value.
string
Official freee Accounting occurrence start date value.
integer
Official freee Accounting approval flow group id value.
integer
Official freee Accounting approval flow route id value.
array
Official freee Accounting purchase request lines value.
integer
required
Official freee Accounting purchase request form id value.
integer
Official freee Accounting approval flow approver id value.
array
Official freee Accounting purchase request custom values value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_RECEIPTUpdate Receipt using the official freee Accounting API operation.

Input Parameters

integer
required
Official freee field id.
integer
required
Official freee field company_id.
string
Official freee field description.
string ("receipt" | "invoice" | "other")
Official freee field document_type.
string ("qualified" | "not_qualified" | "unselected")
Official freee field qualified_invoice.
object
Official freee field receipt_metadatum.
string
Official freee field invoice_registration_number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_SEGMENT_TAGセグメントタグの更新

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_TAGUpdate Tag using the official freee Accounting API operation.

Input Parameters

integer
required
Official freee field id.
string
required
Official freee field name.
string
Official freee field shortcut1.
string
Official freee field shortcut2.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_TRANSFERUpdate Transfer using the official freee Accounting API contract.

Input Parameters

integer
required
Official freee Accounting id value.
string
required
Official freee Accounting date value.
integer
Official freee Accounting amount value.
integer
required
Official freee Accounting company id value.
string
Official freee Accounting description value.
integer
Official freee Accounting from item id value.
array
Official freee Accounting from tag ids value.
array
Official freee Accounting to walletables value.
integer
Official freee Accounting from partner id value.
integer
Official freee Accounting from section id value.
integer
Official freee Accounting to walletable id value.
integer
required
Official freee Accounting from walletable id value.
string ("bank_account" | "credit_card" | "wallet")
Official freee Accounting to walletable type value.
string ("bank_account" | "credit_card" | "wallet")
required
Official freee Accounting from walletable type value.
integer
Official freee Accounting from segment 1 tag id value.
integer
Official freee Accounting from segment 2 tag id value.
integer
Official freee Accounting from segment 3 tag id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_USER_MATCHER自動登録ルールの更新

Input Parameters

integer ("0" | "1" | "2" | "3" | "4" | "10" | "11" | "12")
required
登録タイプ * 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)
boolean
required
有効/無効 * true: 有効 * false: 無効
integer
required
優先度
string
税区分名 act=0,1(取引を推測/登録)の場合は必須。他のactでは指定しても無視されます。
integer ("0" | "1" | "2" | "3" | "4")
required
マッチ条件 * 0: 部分一致(partial) * 1: 前方一致(forward) * 2: 後方一致(backward) * 3: 完全一致(exact) * 4: 指定なし(wildcard)
string
品目名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。
string
カードラベル
integer
required
事業所ID
integer
最大金額 (単位: 円)
integer
最小金額 (単位: 円)
string
口座名。事業所に登録されている口座の名前を指定します。
string
required
説明文。明細の取引内容とマッチングする文字列を指定します。condition=4(指定なし)の場合は無視されます。
string
取引先名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。
string
部門名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。
integer
カードラベルID
string ("income" | "expense")
required
入金/出金 * income: 入金 * expense: 出金
integer
required
自動登録ルールID
string
取引の備考 act=4,10,11,12(無視/プライベート)では指定しても無視されます。
string
勘定科目名 act=0,1(取引を推測/登録)の場合は必須。他のactでは指定しても無視されます。
array
メモタグ名の配列 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。
string
セグメント1タグ名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。
string
セグメント2タグ名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。
string
セグメント3タグ名 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 指定した名前が登録されていない場合、新規にタグとして作成されます。
string
振替先口座名 act=2,3(振替を推測/登録)の場合に使用。他のactでは指定しても無視されます。
string ("non_qualified" | "qualified" | "depends_on_partner")
適格請求書等 * non_qualified: 該当しない * qualified: 該当する * depends_on_partner: 取引先情報に準拠 act=0,1(取引を推測/登録)の場合のみ使用可能。他のactでは指定しても無視されます。 depends_on_partnerを指定する場合は、partner_nameの指定が必要です。
boolean
購入データ原本に準拠 * true: 準拠する * false: 準拠しない act=0,1(取引を推測/登録)かつ購入データ原本に対応した口座を指定した場合のみ使用可能。それ以外では指定しても無視されます。

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPDATE_WALLETABLEUpdate the name of a freee Accounting walletable identified by type and ID for a company.

Input Parameters

integer
required
Official freee field id.
string
required
Official freee field name.
string ("bank_account" | "credit_card" | "wallet")
required
Official freee field type.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPSERT_ACCOUNTING_SECTION_BY_CODEUpsert Accounting Section By Code using the official freee Accounting API contract.

Input Parameters

string
required
Official freee Accounting code value.
object
required
Official freee Accounting section value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPSERT_ACCOUNT_ITEM_BY_CODE勘定科目コードをキーに勘定科目を更新し、存在しない場合は作成します。

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPSERT_ITEM_BY_CODEUpsert Item By Code using the official freee Accounting API contract.

Input Parameters

string
required
Official freee Accounting code value.
object
required
Official freee Accounting item value.
integer
required
Official freee Accounting company id value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPSERT_PARTNER_BY_CODEUpsert Partner By Code using the official freee Accounting API operation.

Input Parameters

string
required
Official freee field code.
object
required
Official freee field partner.
integer
required
Official freee field company_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: FREEE_UPSERT_SEGMENT_TAG_BY_CODE指定したセグメント区分で、コードをキーにセグメントタグを更新または作成します。

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not