マネーフォワードクラウド給与

概要

マネーフォワードクラウド給与 API version 2 の概要

JSON Schema

API で利用可能なリソース定義については JSON Schema でも提供されています。

JSON Schema には API を通してアクセス可能なリソースと、リソースにアクセスするためのURL、
どのようにそれらのリソースを扱うことができるかといった定義が記述されています。

JSON Schema は以下の URL から参照出来ます。

https://payroll.moneyforward.com/api/v2/schema

API エンドポイント

https://payroll.moneyforward.com/api/v2

※ テスト時はホスト名を別途お伝えするホストに置き換えてご利用ください。

アクセス制限

API へのアクセス制限は、接続元 IP チェック及び、APIアクセス識別子によって行います。

APIアクセス識別子

uuid を直接お伝えさせていただきます。

各 API のエンドポイントへリクエストを送信する際、必ず付与していただきます。

サンプル

?identifier=be48858b-be33-4898-80ce-190bb87e089a

会社識別子

API 接続時に、アクセスしたい会社を特定するための識別子として、office_api_key が必要です。

office_api_key は、マネーフォワードクラウド給与に給与担当者としてログインしている状態で、
「連携設定」ページの、外部システム連携用識別子 項目に表示されている、uuid となります。

サンプル

https:://payroll.moneyforward.com/api/v2/offices/dfe07ba7-8b37-411b-a677-426da419e8f7/payrolls

APIレスポンス

API は成功・失敗に関わらず、ステータスコードと、場合によっては JSON をレスポンスボディとして返却します。

エラーレスポンス

API 側でエラーが発生した場合、以下の形式でステータス及び JSON をレスポンスとして返却します。

HTTP/1.1 404 Not Found

{
  "id": "office_not_found",
  "message": ":office_api_key で指定された会社が見つかりませんでした。"
}

レスポンスステータス

API が返却するステータスコードと、その概要の一覧です。

Status	Error Id	Description
200 OK
404 Not Found	`not_found_error`	指定されたリソースが見つかりませんでした。指定されたパラメータが誤っている可能性があります。
404 Not Found	`office_not_found_error`	`office_api_key` で指定された会社が見つかりません。`office_api_key` が間違っているか、既に会社が削除されている可能性があります。
404 Not Found	`payroll_not_found_error`	`payroll_id` で指定された給与計算が見つかりません。`payroll_id` が間違っているか、既に給与計算がキャンセルされている可能性があります。
404 Not Found	`bonus_not_found_error`	`bonus_id` で指定された賞与計算が見つかりません。`bonus_id` が間違っているか、既に賞与計算がキャンセルされている可能性があります。
404 Not Found	`employee_not_found_error`	`employee_id` で指定された従業員が見つかりません。`employee_id` が間違っているか、既に従業員が削除されている可能性があります。
500 Internal Server Error	`server_error`	サーバー内で予期せぬエラーが発生しています。
500 Internal Server Error	`database_error`	データ不整合が発生するパラメータが送信されたため、処理を中止しました。

Office

マネーフォワードクラウド給与における、会社に相当するリソースです。

従業員一覧

マネーフォワードクラウド給与に登録されている、全ての従業員を返却します。
※退職済みの従業員も含まれます。

GET /offices/{office_api_key}/employees

必須パラメータ

Name	Type	Description	Example
identifier	string	連携識別子	`"be48858b-be33-4898-80ce-190bb87e089a"`

Curl サンプル

$ curl -n https://payroll.moneyforward.com/api/v2/offices/$OFFICE_API_KEY/employees
 -G \
  -d identifier=be48858b-be33-4898-80ce-190bb87e089a

レスポンスサンプル

HTTP/1.1 200 OK

{
  "employees": [
    {
      "employee_id": "1W1V4e_QqVrROmY1nXTOOA",
      "number": "A0001",
      "name": "財前 太郎",
      "name_kana": "ザイマエ タロウ",
      "joined_at": "2015-04-01",
      "retired_at": "2019-03-31"
    }
  ]
}

レスポンス内容

Name	Type	Description	Example
employees	array		`[{"employee_id":"1W1V4e_QqVrROmY1nXTOOA","number":"A0001","name":"財前太郎","name_kana":"ザイマエタロウ","joined_at":"2015-04-01","retired_at":"2019-03-31"}]`
employees/employee_id	string	従業員識別子	`"1W1V4e_QqVrROmY1nXTOOA"`
employees/number	nullable string	従業員番号	`"A0001"`
employees/name	string	従業員氏名	`"財前太郎"`
employees/name_kana	nullable string	従業員氏名フリガナ	`"ザイマエタロウ"`
employees/joined_at	date	入社日	`"2015-04-01"`
employees/retired_at	nullable date	退職日	`"2019-03-31"`

従業員詳細

マネーフォワードクラウド給与に登録されている、全ての従業員のうち、employee_id で指定された従業員の詳細情報を返却します。

GET /offices/{office_api_key}/employees/{employee_id}

必須パラメータ

Name	Type	Description	Example
identifier	string	連携識別子	`"be48858b-be33-4898-80ce-190bb87e089a"`

Curl サンプル

$ curl -n https://payroll.moneyforward.com/api/v2/offices/$OFFICE_API_KEY/employees/$EMPLOYEE_ID
 -G \
  -d identifier=be48858b-be33-4898-80ce-190bb87e089a

レスポンスサンプル

HTTP/1.1 200 OK

{
  "employee_id": "1W1V4e_QqVrROmY1nXTOOA",
  "name": "財前 太郎",
  "name_kana": "ザイマエ タロウ",
  "gender": "male",
  "birthday": "1987-01-23",
  "tel": "03-1234-5678",
  "address": {
    "zip_code": "108-0023",
    "prefecture_code": 13,
    "address1": "港区芝浦 3-1-21",
    "address1_kana": "ミナトクシバウラ 3-1-21",
    "address2": "msb Tamachi 田町ステーションタワーS 21F",
    "address2_kana": "ムスブタマチステーションタワーS 21F",
    "municipality": "港区",
    "municipality_kana": "ミナトク",
    "house_number": "芝浦3-1-21",
    "house_number_kana": "シバウラ 3-1-21",
    "building": "msb Tamachi 田町ステーションタワーS 21F",
    "building_kana": "ムスブタマチステーションタワーS 21F"
  },
  "joined_at": "2015-04-01",
  "retired_at": "2019-03-31",
  "retirement_type": "general",
  "retirement_reason": "一身上の都合",
  "number": "A0001",
  "contract_type": "regular",
  "salary_form": "monthly",
  "group": "東京本社",
  "department": "開発部門",
  "occupation": "エンジニア",
  "resident_tax": {
    "municipality_of_payroll_payment_report_submission": "東京都港区",
    "municipality_of_resident_tax_payment": "東京都中野区",
    "resident_tax_identification_number": 12345678
  },
  "income_tax": {
    "tax_list_type": "one",
    "widow_type": "not_covered",
    "handicap_type": "not_covered",
    "working_student_type": "not_covered",
    "minor_type": "not_covered",
    "victim_type": "not_covered",
    "foreigner_type": "not_covered",
    "resident_type": "resident"
  },
  "dependents": [
    {
      "name": "財前 花子",
      "name_kana": "ザイマエ ハナコ",
      "birthday": "1987-03-21",
      "relationship": "wife",
      "gender": "male",
      "is_dependent": "covered",
      "lodger_type": "live_with",
      "handicap_type": "not_covered",
      "is_health_insurance_dependent": "joined"
    }
  ],
  "payment_items": [
    {
      "name": "基本給",
      "amount": 500000
    }
  ],
  "commuting_allowance": {
    "payment_condition": "fixed_amount_payment",
    "office_attendance_item_name": null,
    "allowance_interval": "every_month",
    "allowance_month": "every",
    "commuting_methods": [
      {
        "type": "transportation",
        "allowance_method": "allowance_in_salary",
        "departure_place": "渋谷",
        "arrival_place": "田町",
        "allowance": 10000,
        "allowance_month": "every",
        "payment_condition": "fixed_amount_payment"
      }
    ]
  },
  "health_insurance": {
    "standard_monthly_remuneration": 485000,
    "applied_at": "2015-04-01",
    "number1": 1,
    "expired_at": "2019-03-31",
    "expired_reason": "other"
  },
  "welfare_annuity_insurance": {
    "standard_monthly_remuneration": 485000,
    "applied_at": "2015-04-01",
    "number1": 1,
    "number2": 2,
    "expired_at": "2019-03-31",
    "expired_reason": "other"
  },
  "compensation_insurance": {
    "employee_type": "worker"
  },
  "unemployment_insurance": {
    "levy_exemption": "not_covered",
    "number1": 1234,
    "number2": 567890,
    "number3": 1,
    "applied_at": "2015-04-01",
    "expired_at": "2019-03-31",
    "expired_reason": "other_entrepreneur_request"
  },
  "accounts": [
    {
      "name": "給与振込用",
      "bank_name": "三井住友銀行",
      "bank_branch_name": "三田支店",
      "holder_name": "財前太郎",
      "holder_name_kana": "ザイマエタロウ",
      "number": 123456
    }
  ]
}

レスポンス内容

Name Type Description Example

employee_id string 従業員識別子 "1W1V4e_QqVrROmY1nXTOOA"

name string 氏名 "財前太郎"

name_kana nullable string 氏名フリガナ "ザイマエタロウ"

gender

string

性別

識別子	性別
`male`	`男`
`female`	`女`

"male"

birthday nullable date 生年月日 "1987-01-23"

tel nullable string 電話番号 "03-1234-5678"

address:zip_code nullable string 郵便番号 "108-0023"

address:prefecture_code string 都道府県番号
※0埋めした上で必ず2桁の文字列として出力されます。（例:北海道は "01" となります） 13

address:address1 nullable string 住所1 "港区芝浦 3-1-21"

address:address1_kana nullable string 住所1 フリガナ "ミナトクシバウラ 3-1-21"

address:address2 nullable string 住所2 "msb Tamachi 田町ステーションタワーS 21F"

address:address2_kana nullable string 住所2 フリガナ "ムスブタマチステーションタワーS 21F"

address:municipality nullable string 市区町村フリガナ "港区"

address:municipality_kana nullable string 市区町村（フリガナ）フリガナ "ミナトク"

address:house_number nullable string 丁目・番地フリガナ "芝浦3-1-21"

address:house_number_kana nullable string 丁目・番地（フリガナ）フリガナ "シバウラ 3-1-21"

address:building nullable string マンション/ビル等フリガナ "msb Tamachi 田町ステーションタワーS 21F"

address:building_kana nullable string マンション/ビル等（フリガナ）フリガナ "ムスブタマチステーションタワーS 21F"

joined_at date 入社日 "2015-04-01"

retired_at nullable date 退職日 "2019-03-31"

retirement_type

nullable string

退職区分

識別子	退職区分
`general`	`一般退職`
`disability`	`障害退職`
`dead`	`死亡退職`

"general"

retirement_reason nullable string 退職理由 "一身上の都合"

number nullable string 従業員番号 "A0001"

contract_type

string

契約種別

識別子	契約種別
`executive`	`役員`
`director_employee`	`使用人兼務役員`
`regular`	`正社員`
`contract`	`契約社員`
`nonregular`	`嘱託社員`
`parttime`	`パート`
`arbeit`	`アルバイト`
`etc`	`その他`

"regular"

salary_form

string

給与区分

識別子	給与区分
`monthly`	`月給制`
`hourly`	`時給制`
`daily`	`日給制`

"monthly"

group string 所属事業所 "東京本社"

department nullable string 部門 "開発部門"

occupation nullable string 職種 "エンジニア"

resident_tax:municipality_of_payroll_payment_report_submission nullable string 給与支払報告書提出先市区町村 "東京都港区"

resident_tax:municipality_of_resident_tax_payment nullable string 住民税納付先市区町村 "東京都中野区"

resident_tax:resident_tax_identification_number nullable string 宛名番号 12345678

income_tax:tax_list_type

string

税額表区分

識別子	税額表区分
`one`	`甲`
`two`	`乙`
`three`	`丙`

"one"

income_tax:widow_type

string

寡婦(夫)区分

識別子	寡婦(夫)区分
`not_covered`	`対象外`
`general`	`寡婦(夫)`
`special`	`特別寡婦`

"not_covered"

income_tax:handicap_type

string

障害者区分

識別子	障害者区分
`not_covered`	`対象外`
`general`	`一般障がい者`
`special`	`特別障がい者`

"not_covered"

income_tax:working_student_type

string

勤労学生区分

識別子	勤労学生区分
`not_covered`	`対象外`
`working_student`	`勤労学生`

"not_covered"

income_tax:minor_type

string

未成年者区分

識別子	未成年者区分
`not_covered`	`対象外`
`minor`	`未成年者`

"not_covered"

income_tax:victim_type

string

災害者区分

識別子	災害者区分
`not_covered`	`対象外`
`victim`	`災害者`

"not_covered"

income_tax:foreigner_type

string

外国人区分

識別子	外国人区分
`not_covered`	`対象外`
`foreigner`	`外国人`

"not_covered"

income_tax:resident_type

string

居住者区分

識別子	居住者区分
`resident`	`居住者`
`nonresident`	`非居住者`

"resident"

dependents array 従業員詳細画面で設定されている扶養親族のリスト [{"name":"財前花子","name_kana":"ザイマエハナコ","birthday":"1987-03-21","relationship":"wife","gender":"male","is_dependent":"covered","lodger_type":"live_with","handicap_type":"not_covered","is_health_insurance_dependent":"joined"}]

dependents/name string 扶養親族氏名 "財前花子"

dependents/name_kana nullable string 扶養親族氏名フリガナ "ザイマエハナコ"

dependents/birthday date 生年月日 "1987-03-21"

dependents/relationship

string

続柄

識別子	続柄
`husband`	`夫`
`wife`	`妻`
`son`	`息子`
`daughter`	`娘`
`father`	`父`
`mother`	`母`
`elder_brother`	`兄`
`elder_sister`	`姉`
`brother`	`弟`
`sister`	`妹`
`grandfather`	`祖父`
`grandmother`	`祖母`
`grandson`	`孫息子`
`granddaughter`	`孫娘`
`nephew`	`甥`
`niece`	`姪`
`uncle`	`叔父`
`aunt`	`叔母`
`father_in_law`	`義父`
`mother_in_law`	`義母`

"wife"

dependents/gender

string

性別

識別子	性別
`male`	`男`
`female`	`女`

"male"

dependents/is_dependent

string

扶養区分

識別子	扶養区分
`covered`	`対象`
`not_covered`	`対象外`

"covered"

dependents/lodger_type

string

同居区分

識別子	同居区分
`live_with`	`同居`
`not_covered`	`対象外`
`not_covered_overseas`	`対象外(国外)`

"live_with"

dependents/handicap_type

string

障害者区分

識別子	障害者区分
`not_covered`	`対象外`
`general`	`一般障がい者`
`special`	`特別障がい者`

"not_covered"

dependents/is_health_insurance_dependent

string

健保扶養区分

識別子	健保扶養区分
`joined`	`加入`
`not_joined`	`未加入`

"joined"

payment_items array 従業員詳細画面で設定されている支給項目のリスト [{"name":"基本給","amount":500000}]

payment_items/name string 支給項目の名称 "基本給"

payment_items/amount integer 金額 500000

commuting_allowance:payment_condition

string

この情報は通勤手段に表示されます。
通勤手当支給条件

識別子	支給条件
`flow_amount_payment`	`出勤日数に応じて支給`
`fixed_amount_payment`	`定額で支給`

"fixed_amount_payment"

commuting_allowance:office_attendance_item_name nullable string 通勤手当使用勤怠項目 null

commuting_allowance:allowance_interval

string

この情報は通勤手段に表示されます。
通勤手当支給間隔

識別子	支給間隔
`every_month`	`毎月`
`every_second_months`	`2ヶ月毎`
`every_three_months`	`3ヶ月毎`
`every_six_months`	`6ヶ月毎`

"every_month"

commuting_allowance:allowance_month

string

この情報は通勤手段に表示されます。
通勤手当支給月

識別子	支給月
`every`	`毎月`
`odd`	`1,3,5,7,9,11月`
`even`	`2,4,6,8,10,12月`
`one_four_seven_ten`	`1,4,7,10月`
`two_five_eight_eleven`	`2,5,8,11月`
`three_six_nine_twelve`	`3,6,9,12月`
`one_seven`	`1,7月`
`two_eight`	`2,8月`
`three_nine`	`3,9月`
`four_ten`	`4,10月`
`five_eleven`	`5,11月`
`six_twelve`	`6,12月`

"every"

commuting_allowance:commuting_methods array 通勤手段 [{"type":"transportation","allowance_method":"allowance_in_salary","departure_place":"渋谷","arrival_place":"田町","allowance":10000,"allowance_month":"every","payment_condition":"fixed_amount_payment"}]

commuting_allowance:commuting_methods/type

string

通勤手段

識別子	通勤手段
`train`	`電車`
`bus`	`バス`
`car`	`車`
`bicycle`	`自転車`
`motorcycle`	`バイク`
`walk`	`徒歩`

"transportation"

commuting_allowance:commuting_methods/allowance_method

string

通勤手当支給方法

識別子	支給方法
`allowance_in_salary`	`金銭`
`allowance_in_kind`	`現物`

"allowance_in_salary"

commuting_allowance:commuting_methods/departure_place nullable string 出発地点 "渋谷"

commuting_allowance:commuting_methods/arrival_place nullable string 到着地点 "田町"

commuting_allowance:commuting_methods/allowance integer 支給額 10000

commuting_allowance:commuting_methods/allowance_month

string

新しい情報
通勤手当支給月

識別子	支給月
`every`	`毎月`
`odd`	`1,3,5,7,9,11月`
`even`	`2,4,6,8,10,12月`
`one_four_seven_ten`	`1,4,7,10月`
`two_five_eight_eleven`	`2,5,8,11月`
`three_six_nine_twelve`	`3,6,9,12月`
`one_seven`	`1,7月`
`two_eight`	`2,8月`
`three_nine`	`3,9月`
`four_ten`	`4,10月`
`five_eleven`	`5,11月`
`six_twelve`	`6,12月`

"every"

commuting_allowance:commuting_methods/payment_condition

string

新しい情報
通勤手当支給条件

識別子	支給条件
`flow_amount_payment`	`出勤日数に応じて支給`
`fixed_amount_payment`	`定額で支給`

"fixed_amount_payment"

health_insurance:standard_monthly_remuneration nullable integer 健康保険標準報酬月額
※対象となる報酬月額の範囲の最低値または標準報酬月額が返却されます。 485000

health_insurance:applied_at nullable date 健康保険資格取得年月日 "2015-04-01"

health_insurance:number1 nullable string 健康保険被保険者整理番号 1

health_insurance:expired_at nullable date 健康保険資格喪失年月日 "2019-03-31"

health_insurance:expired_reason

string

健康保険資格資格喪失原因

識別子	資格資格喪失原因
`other`	`その他`
`dead`	`死亡`
`75years`	`75歳`
`disability_determination`	`障がい者認定`

"other"

welfare_annuity_insurance:standard_monthly_remuneration nullable integer 厚生年金保険標準報酬月額
※対象となる報酬月額の範囲の最低値または標準報酬月額が返却されます。 485000

welfare_annuity_insurance:applied_at nullable date 厚生年金保険資格取得年月日 "2015-04-01"

welfare_annuity_insurance:number1 nullable string 厚生年金保険被保険者整理番号 1

welfare_annuity_insurance:number2 nullable string 厚生年金保険被保険者整理番号 2

welfare_annuity_insurance:expired_at nullable date 厚生年金保険資格喪失年月日 "2019-03-31"

welfare_annuity_insurance:expired_reason

string

厚生年金保険資格資格喪失原因

識別子	資格資格喪失原因
`other`	`その他`
`dead`	`死亡`
`75years`	`75歳`
`disability_determination`	`障がい者認定`

"other"

compensation_insurance:employee_type

nullable string

労災保険従業員区分

識別子	従業員区分
`worker`	`常用`
`temporary_worker`	`臨時`
`director_employee`	`役員で労働者扱いの者`

"worker"

unemployment_insurance:levy_exemption

string

雇用保険免除対象高年齢労働者区分

識別子	免除対象高年齢労働者
`covered`	`対象`
`not_covered`	`対象外`

"not_covered"

unemployment_insurance:number1 nullable string 雇用保険被保険者番号 1234

unemployment_insurance:number2 nullable string 雇用保険被保険者番号 567890

unemployment_insurance:number3 nullable string 雇用保険被保険者番号 1

unemployment_insurance:applied_at nullable date 雇用保険資格取得年月日 "2015-04-01"

unemployment_insurance:expired_at nullable date 雇用保険離職等年月日 "2019-03-31"

unemployment_insurance:expired_reason

string

雇用保険資格資格喪失原因

識別子	資格資格喪失原因
`other_entrepreneur_request`	`事業主都合以外の離職`
`entrepreneur_request`	`事業主都合の離職`
`other`	`離職以外の理由`

"other_entrepreneur_request"

accounts array 口座情報 [{"name":"給与振込用","bank_name":"三井住友銀行","bank_branch_name":"三田支店","holder_name":"財前太郎","holder_name_kana":"ザイマエタロウ","number":123456}]

accounts/name string 口座名 "給与振込用"

accounts/bank_name string 金融機関名 "三井住友銀行"

accounts/bank_branch_name string 支店名 "三田支店"

accounts/holder_name nullable string 口座名義人 "財前太郎"

accounts/holder_name_kana string 口座名義人（フリガナ） "ザイマエタロウ"

accounts/number string 口座番号 123456

部門一覧

マネーフォワードクラウド給与の基本設定ページで表示されている、全ての部門を返却します。

GET /offices/{office_api_key}/departments

必須パラメータ

Name	Type	Description	Example
identifier	string	連携識別子	`"be48858b-be33-4898-80ce-190bb87e089a"`

Curl サンプル

$ curl -n https://payroll.moneyforward.com/api/v2/offices/$OFFICE_API_KEY/departments
 -G \
  -d identifier=be48858b-be33-4898-80ce-190bb87e089a

レスポンスサンプル

HTTP/1.1 200 OK

{
  "departments": [
    {
      "name": "営業部"
    }
  ]
}

レスポンス内容

Name	Type	Description	Example
departments	array		`[{"name":"営業部"}]`
departments/name	string	部門名	`"営業部"`

支給項目一覧

マネーフォワードクラウド給与の支給項目設定ページで表示されている、全ての支給項目を返却します。
※ユーザが追加した項目も出力対象です。

GET /offices/{office_api_key}/office_payment_items

必須パラメータ

Name	Type	Description	Example
identifier	string	連携識別子	`"be48858b-be33-4898-80ce-190bb87e089a"`

Curl サンプル

$ curl -n https://payroll.moneyforward.com/api/v2/offices/$OFFICE_API_KEY/office_payment_items
 -G \
  -d identifier=be48858b-be33-4898-80ce-190bb87e089a

レスポンスサンプル

HTTP/1.1 200 OK

{
  "office_payment_items": [
    {
      "name": "基本給",
      "type": "月給",
      "is_active?": true
    }
  ]
}

レスポンス内容

Name	Type	Description	Example
office_payment_items	array		`[{"name":"基本給","type":"月給","is_active?":true}]`
office_payment_items/name	string	支給項目の名称	`"基本給"`
office_payment_items/type	string	支給項目の区分	`"月給"`
office_payment_items/is_active?	boolean	現在有効な項目であるか	`true`

控除項目一覧

マネーフォワードクラウド給与の控除項目設定ページで表示されている、全ての控除項目を返却します。
※ユーザが追加した項目も出力対象です。

GET /offices/{office_api_key}/office_deduction_items

必須パラメータ

Name	Type	Description	Example
identifier	string	連携識別子	`"be48858b-be33-4898-80ce-190bb87e089a"`

Curl サンプル

$ curl -n https://payroll.moneyforward.com/api/v2/offices/$OFFICE_API_KEY/office_deduction_items
 -G \
  -d identifier=be48858b-be33-4898-80ce-190bb87e089a

レスポンスサンプル

HTTP/1.1 200 OK

{
  "office_deduction_items": [
    {
      "name": "健康保険料",
      "is_active?": true
    }
  ]
}

レスポンス内容

Name	Type	Description	Example
office_deduction_items	array		`[{"name":"健康保険料","is_active?":true}]`
office_deduction_items/name	string	控除項目の名称	`"健康保険料"`
office_deduction_items/is_active?	boolean	現在有効な項目であるか	`true`

勤怠項目一覧

マネーフォワードクラウド給与の勤怠項目設定ページで表示されている、全ての勤怠項目を返却します。
※ユーザが追加した項目も出力対象です。

GET /offices/{office_api_key}/office_attendance_items

必須パラメータ

Name	Type	Description	Example
identifier	string	連携識別子	`"be48858b-be33-4898-80ce-190bb87e089a"`

Curl サンプル

$ curl -n https://payroll.moneyforward.com/api/v2/offices/$OFFICE_API_KEY/office_attendance_items
 -G \
  -d identifier=be48858b-be33-4898-80ce-190bb87e089a

レスポンスサンプル

HTTP/1.1 200 OK

{
  "office_attendance_items": [
    {
      "attendance_category_id": 1,
      "attendance_category_name": "所定労働",
      "name": "1日の所定労働時間",
      "is_active?": true,
      "unit": "hours_decimal_1"
    }
  ]
}

レスポンス内容

Name Type Description Example

office_attendance_items array [{"attendance_category_id":1,"attendance_category_name":"所定労働","name":"1日の所定労働時間","is_active?":true,"unit":"hours_decimal_1"}]

office_attendance_items/attendance_category_id integer 勤怠カテゴリID 1

office_attendance_items/attendance_category_name string 勤怠カテゴリ名 "所定労働"

office_attendance_items/name string 勤怠項目の名称 "1日の所定労働時間"

office_attendance_items/is_active? boolean 現在有効な項目であるか true

office_attendance_items/unit

string

勤怠項目の単位

識別子	単位
`days`	`0.0日`
`hours`	`0時間`
`hours_decimal_1`	`0.0時間`
`hours_decimal_2`	`0.00時間`
`number_of_times`	`0.0回`
`minutes`	`000時間00分`

"hours_decimal_1"

会社負担額項目一覧

給与計算結果詳細、賞与計算結果詳細に含まれる会社負担額項目の一覧を返却します。

GET /offices/{office_api_key}/office_absorption_items

必須パラメータ

Name	Type	Description	Example
identifier	string	連携識別子	`"be48858b-be33-4898-80ce-190bb87e089a"`

Curl サンプル

$ curl -n https://payroll.moneyforward.com/api/v2/offices/$OFFICE_API_KEY/office_absorption_items
 -G \
  -d identifier=be48858b-be33-4898-80ce-190bb87e089a

レスポンスサンプル

HTTP/1.1 200 OK

{
  "office_absorption_items": [
    {
      "name": "健康保険料"
    }
  ]
}

レスポンス内容

Name	Type	Description	Example
office_absorption_items	array		`[{"name":"健康保険料"}]`
office_absorption_items/name	string	会社負担額項目の名称	`"健康保険料"`

給与計算グループ一覧

給与計算グループの一覧を返却します。

GET /offices/{office_api_key}/payroll_groups

必須パラメータ

Name	Type	Description	Example
identifier	string	連携識別子	`"be48858b-be33-4898-80ce-190bb87e089a"`

Curl サンプル

$ curl -n https://payroll.moneyforward.com/api/v2/offices/$OFFICE_API_KEY/payroll_groups
 -G \
  -d identifier=be48858b-be33-4898-80ce-190bb87e089a

レスポンスサンプル

HTTP/1.1 200 OK

{
  "payroll_groups": [
    {
      "payroll_group_id": "L3oQZ4dBO7j9HdLGmBOjdw",
      "name": "末締翌25払",
      "closing_day": "末日",
      "payday": "翌月25日"
    }
  ]
}

レスポンス内容

Name	Type	Description	Example
payroll_groups	array		`[{"payroll_group_id":"L3oQZ4dBO7j9HdLGmBOjdw","name":"末締翌25払","closing_day":"末日","payday":"翌月25日"}]`
payroll_groups/payroll_group_id	string	給与計算グループの識別子	`"L3oQZ4dBO7j9HdLGmBOjdw"`
payroll_groups/name	string	給与計算グループの名称	`"末締翌25払"`
payroll_groups/closing_day	string	給与計算グループの締め日設定	`"末日"`
payroll_groups/payday	string	給与計算グループの支給日設定	`"翌月25日"`

給与計算結果一覧

「確定済み」となっている給与計算の一覧を返却します。
※ 給与計算はキャンセルが可能なので、取得のタイミングによって、キャンセルされた給与計算が一覧に含まれない可能性があります。

GET /offices/{office_api_key}/payrolls

必須パラメータ

Name	Type	Description	Example
identifier	string	連携識別子	`"be48858b-be33-4898-80ce-190bb87e089a"`

Curl サンプル

$ curl -n https://payroll.moneyforward.com/api/v2/offices/$OFFICE_API_KEY/payrolls
 -G \
  -d identifier=be48858b-be33-4898-80ce-190bb87e089a

レスポンスサンプル

HTTP/1.1 200 OK

{
  "payrolls": [
    {
      "payroll_id": "L3oQZ4dBO7j9HdLGmBOjdw",
      "payroll_group_id": "L3oQZ4dBO7j9HdLGmBOjdw",
      "closed_at": "2017-03-31",
      "paid_at": "2017-04-20",
      "name": "平成29年01月度 給与"
    }
  ]
}

レスポンス内容

Name	Type	Description	Example
payrolls	array		`[{"payroll_id":"L3oQZ4dBO7j9HdLGmBOjdw","payroll_group_id":"L3oQZ4dBO7j9HdLGmBOjdw","closed_at":"2017-03-31","paid_at":"2017-04-20","name":"平成29年01月度給与"}]`
payrolls/payroll_id	string	給与計算の識別子	`"L3oQZ4dBO7j9HdLGmBOjdw"`
payrolls/payroll_group_id	string	給与計算グループの識別子	`"L3oQZ4dBO7j9HdLGmBOjdw"`
payrolls/closed_at	date	給与計算の締め日	`"2017-03-31"`
payrolls/paid_at	date	給与計算の支給日	`"2017-04-20"`
payrolls/name	string	給与計算の名称	`"平成29年01月度給与"`

給与計算結果詳細

「確定済み」となっている給与計算のうち、payroll_id で指定された給与計算の、従業員単位の「支給項目・控除項目・合計項目・勤怠項目」の計算結果の一覧を返却します。
※ 給与計算はキャンセルが可能なので、取得のタイミングによって、payroll_not_found_error となる可能性があります。

GET /offices/{office_api_key}/payrolls/{payroll_id}

必須パラメータ

Name	Type	Description	Example
identifier	string	連携識別子	`"be48858b-be33-4898-80ce-190bb87e089a"`

Curl サンプル

$ curl -n https://payroll.moneyforward.com/api/v2/offices/$OFFICE_API_KEY/payrolls/$PAYROLL_ID
 -G \
  -d identifier=be48858b-be33-4898-80ce-190bb87e089a

レスポンスサンプル

HTTP/1.1 200 OK

{
  "employees": [
    {
      "id": "1W1V4e_QqVrROmY1nXTOOA",
      "number": "A0001",
      "name": "財前 太郎",
      "name_kana": "ザイマエ タロウ",
      "department": {
        "name": "営業部"
      },
      "payment_items": [
        {
          "name": "基本給(月給)",
          "amount": 350000
        }
      ],
      "deduction_items": [
        {
          "name": "健康保険料",
          "amount": 14865
        }
      ],
      "attendance_items": [
        {
          "name": "残業時間",
          "unit": "hours_decimal_2",
          "number": 21.34
        }
      ],
      "absorption_items": [
        {
          "name": "健康保険料",
          "amount": 14865
        }
      ],
      "balances": [
        {
          "name": "課税支給合計",
          "amount": 500000
        }
      ],
      "miscellaneous_information": {
        "memo": "今月もお疲れ様でした！"
      }
    }
  ]
}

レスポンス内容

Name Type Description Example

employees array [{"id":"1W1V4e_QqVrROmY1nXTOOA","number":"A0001","name":"財前太郎","name_kana":"ザイマエタロウ","department":{"name":"営業部"},"payment_items":[{"name":"基本給(月給)","amount":350000}],"deduction_items":[{"name":"健康保険料","amount":14865}],"attendance_items":[{"name":"残業時間","unit":"hours_decimal_2","number":21.34}],"absorption_items":[{"name":"健康保険料","amount":14865}],"balances":[{"name":"課税支給合計","amount":500000}],"miscellaneous_information":{"memo":"今月もお疲れ様でした！"}}]

employees/id string 従業員識別子 "1W1V4e_QqVrROmY1nXTOOA"

employees/number nullable string 従業員番号 "A0001"

employees/name string 従業員氏名 "財前太郎"

employees/name_kana nullable string 従業員氏名フリガナ "ザイマエタロウ"

employees/department nullable object null

employees/department:name string 部門名 "営業部"

employees/payment_items array [{"name":"基本給(月給)","amount":350000}]

employees/payment_items/name string 支給項目名 "基本給(月給)"

employees/payment_items/amount integer 金額 350000

employees/deduction_items array [{"name":"健康保険料","amount":14865}]

employees/deduction_items/name string 控除項目名 "健康保険料"

employees/deduction_items/amount integer 金額 14865

employees/attendance_items array [{"name":"残業時間","unit":"hours_decimal_2","number":21.34}]

employees/attendance_items/name string 勤怠項目名 "残業時間"

employees/attendance_items/unit

string

勤怠項目の単位

識別子	単位
`days`	`0.0日`
`hours`	`0時間`
`hours_decimal_1`	`0.0時間`
`hours_decimal_2`	`0.00時間`
`number_of_times`	`0.0回`
`minutes`	`000時間00分`

"hours_decimal_2"

employees/attendance_items/number number 時間または日数（小数点2桁） 21.34

employees/absorption_items array [{"name":"健康保険料","amount":14865}]

employees/absorption_items/name string 会社負担額項目名 "健康保険料"

employees/absorption_items/amount integer 金額 14865

employees/balances array [{"name":"課税支給合計","amount":500000}]

employees/balances/name string 合計項目名 "課税支給合計"

employees/balances/amount integer 金額 500000

employees/miscellaneous_information:memo nullable string 備考欄 "今月もお疲れ様でした！"

賞与計算結果一覧

「確定済み」となっている賞与計算の一覧を返却します。
※ 賞与計算はキャンセルが可能なので、取得のタイミングによって、キャンセルされた賞与計算が一覧に含まれない可能性があります。

GET /offices/{office_api_key}/bonuses

必須パラメータ

Name	Type	Description	Example
identifier	string	連携識別子	`"be48858b-be33-4898-80ce-190bb87e089a"`

Curl サンプル

$ curl -n https://payroll.moneyforward.com/api/v2/offices/$OFFICE_API_KEY/bonuses
 -G \
  -d identifier=be48858b-be33-4898-80ce-190bb87e089a

レスポンスサンプル

HTTP/1.1 200 OK

{
  "bonuses": [
    {
      "bonus_id": "L3oQZ4dBO7j9HdLGmBOjdw",
      "started_at": "2017-01-01",
      "expired_at": "2017-05-31",
      "paid_at": "2017-06-20",
      "name": "平成29年度夏季賞与"
    }
  ]
}

レスポンス内容

Name	Type	Description	Example
bonuses	array		`[{"bonus_id":"L3oQZ4dBO7j9HdLGmBOjdw","started_at":"2017-01-01","expired_at":"2017-05-31","paid_at":"2017-06-20","name":"平成29年度夏季賞与"}]`
bonuses/bonus_id	string	賞与計算の識別子	`"L3oQZ4dBO7j9HdLGmBOjdw"`
bonuses/started_at	date	賞与対象期間の開始日	`"2017-01-01"`
bonuses/expired_at	date	賞与対象期間の満了日	`"2017-05-31"`
bonuses/paid_at	date	賞与計算の支給日	`"2017-06-20"`
bonuses/name	string	賞与計算の名称	`"平成29年度夏季賞与"`

賞与計算結果詳細

「確定済み」となっている賞与計算のうち、bonus_id で指定された賞与計算の、従業員単位の「支給項目・控除項目・合計項目」の計算結果の一覧を返却します。
※ 賞与計算はキャンセル及び削除が可能なので、取得のタイミングによって、bonus_not_found_error となる可能性があります。

GET /offices/{office_api_key}/bonuses/{bonus_id}

必須パラメータ

Name	Type	Description	Example
identifier	string	連携識別子	`"be48858b-be33-4898-80ce-190bb87e089a"`

Curl サンプル

$ curl -n https://payroll.moneyforward.com/api/v2/offices/$OFFICE_API_KEY/bonuses/$BONUS_ID
 -G \
  -d identifier=be48858b-be33-4898-80ce-190bb87e089a

レスポンスサンプル

HTTP/1.1 200 OK

{
  "employees": [
    {
      "id": "1W1V4e_QqVrROmY1nXTOOA",
      "number": "A0001",
      "name": "財前 太郎",
      "name_kana": "ザイマエ タロウ",
      "department": {
        "name": "営業部"
      },
      "payment_items": [
        {
          "name": "賞与手当",
          "amount": 500000
        }
      ],
      "deduction_items": [
        {
          "name": "健康保険料",
          "amount": 14865
        }
      ],
      "absorption_items": [
        {
          "name": "健康保険料",
          "amount": 14865
        }
      ],
      "balances": [
        {
          "name": "課税支給合計",
          "amount": 500000
        }
      ],
      "miscellaneous_information": {
        "memo": "前期大活躍でしたね！今期もよろしくお願いします！"
      }
    }
  ]
}

レスポンス内容

Name	Type	Description	Example
employees	array		`[{"id":"1W1V4e_QqVrROmY1nXTOOA","number":"A0001","name":"財前太郎","name_kana":"ザイマエタロウ","department":{"name":"営業部"},"payment_items":[{"name":"賞与手当","amount":500000}],"deduction_items":[{"name":"健康保険料","amount":14865}],"absorption_items":[{"name":"健康保険料","amount":14865}],"balances":[{"name":"課税支給合計","amount":500000}],"miscellaneous_information":{"memo":"前期大活躍でしたね！今期もよろしくお願いします！"}}]`
employees/id	string	従業員識別子	`"1W1V4e_QqVrROmY1nXTOOA"`
employees/number	nullable string	従業員番号	`"A0001"`
employees/name	string	従業員氏名	`"財前太郎"`
employees/name_kana	nullable string	従業員氏名フリガナ	`"ザイマエタロウ"`
employees/department	nullable object		`null`
employees/department:name	string	部門名	`"営業部"`
employees/payment_items	array		`[{"name":"賞与手当","amount":500000}]`
employees/payment_items/name	string	支給項目名	`"賞与手当"`
employees/payment_items/amount	integer	金額	`500000`
employees/deduction_items	array		`[{"name":"健康保険料","amount":14865}]`
employees/deduction_items/name	string	控除項目名	`"健康保険料"`
employees/deduction_items/amount	integer	金額	`14865`
employees/absorption_items	array		`[{"name":"健康保険料","amount":14865}]`
employees/absorption_items/name	string	会社負担額項目名	`"健康保険料"`
employees/absorption_items/amount	integer	金額	`14865`
employees/balances	array		`[{"name":"課税支給合計","amount":500000}]`
employees/balances/name	string	合計項目名 ※賞与計算には「固定賃金合計」「役員報酬合計」「割増基礎合計」「控除基礎合計」は含まれません	`"課税支給合計"`
employees/balances/amount	integer	金額	`500000`
employees/miscellaneous_information:memo	nullable string	備考欄	`"前期大活躍でしたね！今期もよろしくお願いします！"`

概要

JSON Schema

API エンドポイント

アクセス制限

APIアクセス識別子

サンプル

会社識別子

サンプル

APIレスポンス

エラーレスポンス

レスポンスステータス

Office

従業員一覧

必須パラメータ

Curl サンプル

レスポンス サンプル

レスポンス内容

従業員詳細

必須パラメータ

Curl サンプル

レスポンス サンプル

レスポンス内容

部門一覧

必須パラメータ

Curl サンプル

レスポンス サンプル

レスポンス内容

支給項目一覧

必須パラメータ

Curl サンプル

レスポンス サンプル

レスポンス内容

控除項目一覧

必須パラメータ

Curl サンプル

レスポンス サンプル

レスポンス内容

勤怠項目一覧

必須パラメータ

Curl サンプル

レスポンス サンプル

レスポンス内容

会社負担額項目一覧

必須パラメータ

Curl サンプル

レスポンス サンプル

レスポンス内容

給与計算グループ一覧

必須パラメータ

Curl サンプル

レスポンス サンプル

レスポンス内容

給与計算結果一覧

必須パラメータ

Curl サンプル

レスポンス サンプル

レスポンス内容

給与計算結果詳細

必須パラメータ

Curl サンプル

レスポンス サンプル

レスポンス内容

賞与計算結果一覧

必須パラメータ

Curl サンプル

レスポンス サンプル

レスポンス内容

賞与計算結果詳細

必須パラメータ

Curl サンプル

レスポンス サンプル

レスポンス内容

レスポンスサンプル

レスポンスサンプル

レスポンスサンプル

レスポンスサンプル

レスポンスサンプル

レスポンスサンプル

レスポンスサンプル

レスポンスサンプル

レスポンスサンプル

レスポンスサンプル

レスポンスサンプル

レスポンスサンプル