API Documentation
- オリジン
- 本番環境:
https://cloud.tkc.co.jp - 検証環境:
https://cloud-demo.tkc.co.jp
- 本番環境:
勤怠項目情報 ¶
勤怠項目情報の取得 ¶
GET /px/tc09999001/tfa/api/v1/attendances?offset=1?limit=20?is_active_only=1
Requests
Headers
Content-Type: application/jsonResponses
Headers
Content-Type: application/jsonBody
{
"status": 200,
"total_count": 200,
"attendances": [
{
"cd_attnd": "0001",
"nm_attnd": "平日出勤",
"nm_attndunit": "日",
"cat_cntattnd": 2,
"is_active": 1,
"is_inpamnt": 1,
"is_fixed": 1
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "成功"
},
"total_count": {
"type": "number",
"description": "件数"
},
"attendances": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cd_attnd": {
"type": "string",
"description": "勤怠項目コード(4桁、半角数字)"
},
"nm_attnd": {
"type": "string",
"description": "勤怠項目名(16桁、全半角可)"
},
"nm_attndunit": {
"type": "string",
"description": "単位名(4桁、全半角可)"
},
"cat_cntattnd": {
"type": "number",
"enum": [
1,
2
],
"description": "数量カウント方法(1:数値、2:時間)"
},
"is_active": {
"type": "number",
"description": "使用するか(1: 使用する, 0: 使用しない)"
},
"is_inpamnt": {
"type": "number",
"description": "入力可能な項目か(1: 可, 0: 不可)"
},
"is_fixed": {
"type": "number",
"description": "固定の項目か(1: 固定, 0: 任意に追加した項目)"
}
},
"required": [
"cd_attnd",
"nm_attnd",
"cat_cntattnd",
"is_active",
"is_inpamnt",
"is_fixed"
]
},
"description": "勤怠項目情報 cd_attndの昇順に並ぶ"
}
},
"required": [
"status",
"total_count"
]
}Headers
Content-Type: application/jsonBody
{
"status": 400,
"errors": [
{
"code": 1,
"message": "不正なリクエストです"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "パラメータの間違い・立上げ開始されていない など"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "number",
"enum": [
1
],
"description": "エラーコード(1: 立上げ開始されていない)"
},
"message": {
"type": "string",
"description": "エラーメッセージ"
}
},
"required": [
"message"
]
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 401,
"errors": [
{
"message": "トークンが存在しないか無効です"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "トークンがないもしくはトークンが無効の場合"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "エラーメッセージ"
}
}
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}勤怠項目情報の取得GET/px/{ocode}/{locale}/api/v1/attendances{?offset}{?limit}{?is_active_only}
処理概要
- 勤怠項目情報を取得する
URI Parameters
- ocode
string(required) Example: tc09999001企業コード
- locale
string(required) Example: tfaシステム識別子
- offset
number(optional) Default: 0 Example: 1取得レコードのオフセット
- limit
number(optional) Default: 20 Example: 20取得レコードの件数 (min: 1, max: 1000)
- is_active_only
number(optional) Default: 0 Example: 1利用している項目のみか (1:現在利用している項目のみ,0:すべての項目)
給与支給項目情報 ¶
給与支給項目情報の取得 ¶
GET /px/tc09999001/tfa/api/v1/salarypayments?offset=1?limit=20?is_active_only=1
Requests
Headers
Content-Type: application/jsonResponses
Headers
Content-Type: application/jsonBody
{
"status": 200,
"total_count": 200,
"salarypayments": [
{
"cd_salarypymt": "0001",
"nm_salarypymt": "基本給",
"cat_itminp": 1,
"is_taxincometax": 1,
"is_wageinstd": 1,
"is_salaryddct": 1,
"is_sireward": 1,
"is_sifix": 1,
"is_liwage": 1,
"cat_jourkind": 1,
"amnt_unit": "123456.7891",
"cat_cntquantity": 2,
"cat_round": 1,
"salaryratepymts": [
{
"cd_salarypymt_src": "0001"
}
],
"cd_formula: `0001` (string, optional) - 計算式コード（4桁、半角数字。cat_itminpが8": "計算式の場合のみ値を返却し、それ以外は空文字を返却）",
"cd_wagetable: `0001` (string, optional) - 賃金テーブルコード（4桁、半角数字。cat_itminpが9": "賃金テーブルの場合のみ値を返却し、それ以外は空文字を返却）",
"cd_condition: `0001` (string, optional) - 条件式コード（4桁、半角数字。cat_itminpが13": "条件式の場合のみ値を返却し、それ以外は空文字を返却）",
"is_active": 1
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "成功"
},
"total_count": {
"type": "number",
"description": "件数"
},
"salarypayments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cd_salarypymt": {
"type": "string",
"description": "給与支給項目コード(4桁、半角数字)"
},
"nm_salarypymt": {
"type": "string",
"description": "給与支給項目名(16桁、全半角可)"
},
"cat_itminp": {
"type": "number",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13
],
"description": "項目属性(1:定額、2:定額（入力値は次回に引き継がれない）、3:毎回入力、4:数量×単価、5:割合、6:現物、7:同額控除、8:計算式、9:賃金テーブル、10:項目種類毎の自動集計、11:日給、12:時給、13:条件式。2と7が返ることはない(2は現在使用されていない、7は給与支給項目では選択不可))"
},
"is_taxincometax": {
"type": "number",
"description": "所得税課税するか(1:課税、0:非課税)"
},
"is_wageinstd": {
"type": "number",
"description": "基準内賃金か(1:該当、0:非該当)"
},
"is_salaryddct": {
"type": "number",
"description": "給与控除計算対象か(1:対象、0:対象外)"
},
"is_sireward": {
"type": "number",
"description": "社保報酬か(1:該当、0:非該当)"
},
"is_sifix": {
"type": "number",
"description": "固定的賃金か(1:該当、0:非該当)"
},
"is_liwage": {
"type": "number",
"description": "労保賃金か(1:該当、0:非該当)"
},
"cat_jourkind": {
"type": "number",
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"description": "仕訳計上区分(0:設定なし、1:使用人給与、2:役員給与、3:使用人賞与、4:役員賞与、5:福利厚生費、6:法定福利費。給与支給項目では0か1か2か5のみ返る。給与控除額(日)、給与控除額(時間)、定期除く通勤手当、課税支給額、支給合計の場合は0を返却。その他は1か2か5を返却)"
},
"amnt_unit": {
"type": "string",
"description": "単価（整数部6桁、小数部4桁、マイナス入力可）"
},
"cat_cntquantity": {
"type": "number",
"enum": [
0,
1,
2
],
"description": "数量カウント方法(0:設定なし、1:数値、2:時間。項目属性が10:項目種類毎の自動集計の場合は0を返却)"
},
"cat_round": {
"type": "number",
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"description": "端数処理区分(0:設定なし、1:１円未満四捨五入、2:１円未満切捨て、3:１円未満切上げ、4:１０円未満四捨五入、5:１０円未満切捨て、6:１０円未満切上げ。項目属性が10:項目種類毎の自動集計の場合は0を返却)"
},
"salaryratepymts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cd_salarypymt_src": {
"type": "string",
"description": "計算基準となる支給項目コード（4桁、半角数字）"
}
},
"required": [
"cd_salarypymt_src"
]
},
"description": "給与支給項目ごとの割合給の計算基準項目（cat_itminpが5:割合の場合のみ値を返却し、それ以外は空配列を返却）、並び順はcd_salarypymt_srcの昇順"
},
"cd_formula: `0001` (string, optional) - 計算式コード（4桁、半角数字。cat_itminpが8": {
"type": "string"
},
"cd_wagetable: `0001` (string, optional) - 賃金テーブルコード（4桁、半角数字。cat_itminpが9": {
"type": "string"
},
"cd_condition: `0001` (string, optional) - 条件式コード（4桁、半角数字。cat_itminpが13": {
"type": "string"
},
"is_active": {
"type": "number",
"description": "使用するか(1: 使用する、0: 使用しない)"
}
},
"required": [
"cd_salarypymt",
"nm_salarypymt",
"cat_itminp",
"is_taxincometax",
"is_wageinstd",
"is_salaryddct",
"is_sireward",
"is_sifix",
"is_liwage",
"cat_jourkind",
"amnt_unit",
"cat_cntquantity",
"cat_round",
"is_active"
]
},
"description": "給与支給項目情報、並び順はcd_salarypymtの昇順"
}
},
"required": [
"status",
"total_count"
]
}Headers
Content-Type: application/jsonBody
{
"status": 400,
"errors": [
{
"code": 1,
"message": "不正なリクエストです"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "パラメータの間違い・立上げ開始されていないなど"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "number",
"enum": [
1
],
"description": "エラーコード(1: 立上げ開始されていない)"
},
"message": {
"type": "string",
"description": "エラーメッセージ"
}
},
"required": [
"message"
]
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 401,
"errors": [
{
"message": "トークンが存在しないか無効です"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "トークンがないもしくはトークンが無効の場合"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "エラーメッセージ"
}
}
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}給与支給項目情報の取得GET/px/{ocode}/{locale}/api/v1/salarypayments{?offset}{?limit}{?is_active_only}
処理概要
- 給与支給項目情報を取得する
URI Parameters
- ocode
string(required) Example: tc09999001企業コード
- locale
string(required) Example: tfaシステム識別子
- offset
number(optional) Default: 0 Example: 1取得レコードのオフセット
- limit
number(optional) Default: 20 Example: 20取得レコードの件数 (min: 1, max: 1000)
- is_active_only
number(optional) Default: 0 Example: 1利用している項目のみか (1:現在利用している項目のみ,0:すべての項目)
給与控除情報 ¶
給与控除情報の取得 ¶
GET /px/tc09999001/tfa/api/v1/salarydeductions?offset=1?limit=20?is_active_only=1
Requests
Headers
Content-Type: application/jsonResponses
Headers
Content-Type: application/jsonBody
{
"status": 200,
"total_count": 200,
"salarydeductions": [
{
"cd_salaryddct": "0001",
"nm_salaryddct": "健保（一般）",
"cat_itminp": 1,
"amnt_unit": "123456.789",
"cat_cntquantity": 2,
"cat_round": 1,
"salaryrateddcts": [
{
"cat_rateddct": 1,
"cd_salarypymt_src": "0001",
"cd_salaryddct_src": "0001",
"cat_taxbase_src": 0,
"is_add": 1
}
],
"cd_salarypymt4ddct: `0001` (string, optional) - 同額控除支給項目コード（4桁、半角数字。cat_itminpが7": "同額控除の場合のみ値を返却し、それ以外は空文字を返却）",
"cd_formula: `0001` (string, optional) - 計算式コード（4桁、半角数字。cat_itminpが8": "計算式の場合のみ値を返却し、それ以外は空文字を返却）",
"cd_wagetable: `0001` (string, optional) - 賃金テーブルコード（4桁、半角数字。cat_itminpが9": "賃金テーブルの場合のみ値を返却し、それ以外は空文字を返却）",
"cd_condition: `0001` (string, optional) - 条件式コード（4桁、半角数字。cat_itminpが13": "条件式の場合のみ値を返却し、それ以外は空文字を返却）",
"is_active": 1
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "成功"
},
"total_count": {
"type": "number",
"description": "件数"
},
"salarydeductions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cd_salaryddct": {
"type": "string",
"description": "給与控除コード(4桁、半角数字)"
},
"nm_salaryddct": {
"type": "string",
"description": "給与控除名(16桁、全半角可)"
},
"cat_itminp": {
"type": "number",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13
],
"description": "項目属性(1:定額、2:定額（入力値は次回に引き継がれない）、3:毎回入力、4:数量×単価、5:割合、6:現物、7:同額控除、8:計算式、9:賃金テーブル、10:項目種類毎の自動集計、11:日給、12:時給、13:条件式)"
},
"amnt_unit": {
"type": "string",
"description": "単価（整数部6桁、小数部4桁、マイナス入力可）"
},
"cat_cntquantity": {
"type": "number",
"enum": [
0,
1,
2
],
"description": "数量カウント方法(0:設定なし、1:数値、2:時間。項目属性が10:項目種類毎の自動集計の場合は0を返却)"
},
"cat_round": {
"type": "number",
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"description": "端数処理区分(0:設定なし、1:１円未満四捨五入、2:１円未満切り捨て、3:１円未満切り上げ、4:１０円未満四捨五入、5:１０円未満切り捨て、6:１０円未満切り上げ。項目属性が10:項目種類毎の自動集計の場合は0を返却)"
},
"salaryrateddcts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cat_rateddct": {
"type": "number",
"enum": [
1,
2,
3,
4
],
"description": "割合給基準項目種類(1:支給、2:控除、3:税額社会保険基礎データ、4:所得税控除後金額)"
},
"cd_salarypymt_src": {
"type": "string",
"description": "割合給計算項目 支給項目コード（4桁、半角数字。cat_rateddctが1:支給の場合のみ値を返却し、それ以外は空文字を返却）"
},
"cd_salaryddct_src": {
"type": "string",
"description": "割合給計算項目 控除項目コード（4桁、半角数字。cat_rateddctが2:控除または4:所得税控除後金額の場合のみ値を返却し、それ以外は空文字を返却）"
},
"cat_taxbase_src": {
"type": "number",
"enum": [
0,
1,
2,
3,
4,
5,
6,
7,
8
],
"description": "税額・社会保険基礎データ区分（0:利用しない、1:基準内賃金計、2:社会保険報酬計、3:社会保険固定的賃金計、4:労働保険賃金計、5:役員賞与計、6:使用人賞与計、7:社会保険報酬の固定的賃金分、8:社会保険報酬の非固定的賃金分）"
},
"is_add": {
"type": "number",
"description": "加算か(1:加算、0:減算)"
}
},
"required": [
"cat_rateddct",
"cat_taxbase_src",
"is_add"
]
},
"description": "給与控除項目ごとの割合給の計算基準項目（cat_itminpが5:割合の場合のみ値を返却し、それ以外は空配列を返却、並び順はcat_rateddct, cd_salarypymt_src, cd_salaryddct_src, cat_taxbase_srcの昇順）"
},
"cd_salarypymt4ddct: `0001` (string, optional) - 同額控除支給項目コード（4桁、半角数字。cat_itminpが7": {
"type": "string"
},
"cd_formula: `0001` (string, optional) - 計算式コード（4桁、半角数字。cat_itminpが8": {
"type": "string"
},
"cd_wagetable: `0001` (string, optional) - 賃金テーブルコード（4桁、半角数字。cat_itminpが9": {
"type": "string"
},
"cd_condition: `0001` (string, optional) - 条件式コード（4桁、半角数字。cat_itminpが13": {
"type": "string"
},
"is_active": {
"type": "number",
"description": "使用するか(1: 使用する, 0: 使用しない)"
}
},
"required": [
"cd_salaryddct",
"nm_salaryddct",
"cat_itminp",
"amnt_unit",
"cat_cntquantity",
"cat_round",
"is_active"
]
},
"description": "給与控除情報 cd_salaryddctの昇順に並ぶ"
}
},
"required": [
"status",
"total_count"
]
}Headers
Content-Type: application/jsonBody
{
"status": 400,
"errors": [
{
"code": 1,
"message": "不正なリクエストです"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "パラメータの間違い・立上げ開始されていない など"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "number",
"enum": [
1
],
"description": "エラーコード(1: 立上げ開始されていない)"
},
"message": {
"type": "string",
"description": "エラーメッセージ"
}
},
"required": [
"message"
]
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 401,
"errors": [
{
"message": "トークンが存在しないか無効です"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "トークンがないもしくはトークンが無効の場合"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "エラーメッセージ"
}
}
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}給与控除情報の取得GET/px/{ocode}/{locale}/api/v1/salarydeductions{?offset}{?limit}{?is_active_only}
処理概要
- 給与控除情報を取得する
URI Parameters
- ocode
string(required) Example: tc09999001企業コード
- locale
string(required) Example: tfaシステム識別子
- offset
number(optional) Default: 0 Example: 1取得レコードのオフセット
- limit
number(optional) Default: 20 Example: 20取得レコードの件数 (min: 1, max: 1000)
- is_active_only
number(optional) Default: 0 Example: 1利用している項目のみか (1:現在利用している項目のみ,0:すべての項目)
時間外項目情報 ¶
時間外項目情報の取得 ¶
GET /px/tc09999001/tfa/api/v1/overtimes
Requests
Headers
Content-Type: application/jsonResponses
Headers
Content-Type: application/jsonBody
{
"status": 200,
"overtimes": [
{
"cd_overtime": "A",
"nm_overtime": "法定外"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "成功"
},
"overtimes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cd_overtime": {
"type": "string",
"description": "時間外項目コード(1桁、半角英字)"
},
"nm_overtime": {
"type": "string",
"description": "時間外項目名(8桁、全半角可)"
}
},
"required": [
"cd_overtime",
"nm_overtime"
]
},
"description": "時間外項目情報 cd_overtimeの昇順に並ぶ"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 400,
"errors": [
{
"code": 1,
"message": "不正なリクエストです"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "パラメータの間違い・立上げ開始されていない など"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "number",
"enum": [
1
],
"description": "エラーコード(1: 立上げ開始されていない)"
},
"message": {
"type": "string",
"description": "エラーメッセージ"
}
},
"required": [
"message"
]
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 401,
"errors": [
{
"message": "トークンが存在しないか無効です"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "トークンがないもしくはトークンが無効の場合"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "エラーメッセージ"
}
}
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}時間外項目情報の取得GET/px/{ocode}/{locale}/api/v1/overtimes
処理概要
- 時間外項目情報を取得する
URI Parameters
- ocode
string(required) Example: tc09999001企業コード
- locale
string(required) Example: tfaシステム識別子
事業所情報 ¶
事業所情報の取得 ¶
GET /px/tc09999001/tfa/api/v1/offices
Requests
Headers
Content-Type: application/jsonResponses
Headers
Content-Type: application/jsonBody
{
"status": 200,
"offices": [
{
"cd_office": "0001",
"nm_office": "ＡＢＣオートサプライ株式会社",
"kana_office": "ｴｰﾋﾞｰｼｰｵｰﾄｻﾌﾟﾗｲ",
"cd_postal": "1628585",
"address1": "東京都新宿区揚場町2-1",
"address2": "軽子坂MNビル5F",
"kana_address1": "ﾄｳｷｮｳﾄｼﾝｼﾞｭｸｸｱｹﾞﾊﾞﾁｮｳ2-1",
"kana_address2": "ｶﾙｺｻﾞｶMNﾋﾞﾙ5F",
"phoneno": "03-1234-5678",
"is_appliedhi": 1,
"is_appliedli": 1,
"is_head": 1,
"cd_parentoffice": "0001",
"officehealthinsurances": {
"is_join": 1,
"cat_hi": 1,
"cd_pcg": "13",
"is_specified": 1,
"healthinsurancerates": [
{
"ymd_b": "2026-03-01",
"cat_hibiz": 1,
"rate_cpny: `98.5` (string, optional) - 全社分保険料率(整数4桁、小数点以下3桁、千分率)(cat_hibizが1の場合は必須入力。cat_hibizが2,3の場合はnull可)": "",
"rate_employee: `49.25` (string, optional) - 従業員負担分保険料率(整数4桁、小数点以下3桁、千分率)(cat_hibizが1の場合は必須入力。cat_hibizが2,3の場合はnull可)": "",
"rate_office: `49.25` (string, optional) - 事業主負担分保険料率(整数4桁、小数点以下3桁、千分率)(cat_hibizが1の場合は必須入力。cat_hibizが2,3の場合はnull可)": ""
}
],
"childsupportrates": [
{
"ymd_b": "2026-04-01",
"rate_cpny": "2.3",
"rate_employee": "1.15",
"rate_office": "1.15"
}
],
"careinsurancerates": [
{
"ymd_b": "2026-03-01",
"rate_cpny": "16.2",
"rate_employee": "8.1",
"rate_office": "8.1"
}
],
"symbol_left": "新",
"symbol_right": "Ｔ３ＨＴ",
"no_hi": "123"
},
"officewelfarepensions": {
"is_joinwp": 1,
"is_specified": 1,
"is_joinwpf": 1,
"welfarepensionfundquitrates": [
{
"ymd_b": "2017-09-01",
"cat_sijob": 1,
"rate_wpfquit": 5
}
],
"welfarepensionrates": [
{
"ymd_b": "2017-09-01",
"cat_sijob": 1,
"rate_cpny": "183.0",
"rate_employee": "91.5",
"rate_office": "91.5"
}
],
"welfarepensionfundrates": [
{
"ymd_b": "2017-09-01",
"cat_paysrc": 1,
"cat_sijob": 1,
"rate_cpny": "24.0",
"rate_employee": "12.0",
"rate_office": "12.0"
}
],
"childcarerates": [
{
"ymd_b": "2020-04-01",
"rate_childcare": "3.6"
}
],
"symbol_left": "新",
"symbol_right": "Ｔ３ＨＴ",
"no_wp": "123",
"no_office": "147963258"
},
"officelaborinsurances": {
"is_joinei": 1,
"cat_eiapplied": 1,
"is_joinii": 1,
"employmentinsurancerates": [
{
"ymd_b": "2026-04-01",
"rate_cpny": "16.5",
"rate_employee": "6.0",
"rate_office": "10.5"
}
],
"industrialinjuryinsurancerates": [
{
"ymd_b": "2025-04-01",
"rate_ii": "9.5"
}
],
"asbestosrates": [
{
"ymd_b": "2014-04-01",
"rate_asbst": "0.02"
}
],
"no_pcg": "09",
"no_palm": "1",
"no_province": "01",
"no_backbone": "702740",
"no_branch": "000",
"nm_jobcentre": "飯田橋",
"no_ei1": "0901",
"no_ei2": "002868",
"no_ei3": "2",
"ymd_ei": "2026-04-01",
"ymd_ii": "2026-04-01"
},
"officeerequests": {
"cd_submission_si": "49511200070000000000124",
"cd_submission_li": "49511000010000000003825",
"symbol_left": "12",
"symbol_right": "987",
"no_hi": "123",
"id_employee": 1,
"mail_staff": "abcde@example.com",
"phoneno_staff": "03-1234-5678"
}
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "成功"
},
"offices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cd_office": {
"type": "string",
"description": "事業所コード(4桁、半角数字)"
},
"nm_office": {
"type": "string",
"description": "事業所名称(60桁、全半角可)"
},
"kana_office": {
"type": "string",
"description": "事業所名称ﾌﾘｶﾞﾅ(40桁、半角英数字、半角カナ、半角記号、半角スペース)"
},
"cd_postal": {
"type": "string",
"description": "郵便番号(7桁、半角数字)"
},
"address1": {
"type": "string",
"description": "住所上段(40桁、全半角可)"
},
"address2": {
"type": "string",
"description": "住所下段(40桁、全半角可)"
},
"kana_address1": {
"type": "string",
"description": "住所ﾌﾘｶﾞﾅ上段(40桁、半角英数字、半角カナ、半角記号、半角スペース)"
},
"kana_address2": {
"type": "string",
"description": "住所ﾌﾘｶﾞﾅ下段(40桁、半角英数字、半角カナ、半角記号、半角スペース)"
},
"phoneno": {
"type": "string",
"description": "電話番号(20桁、半角数字、+、-)"
},
"is_appliedhi": {
"type": "number",
"description": "健康保険適用事業所か(1: 健康保険適用事業所, 0: 健康保険適用事業所でない)"
},
"is_appliedli": {
"type": "number",
"description": "労働保険適用事業所か(1: 労働保険適用事業所, 0: 労働保険適用事業所でない)"
},
"is_head": {
"type": "number",
"description": "本社か(1: 本社, 0: 本社でない)"
},
"cd_parentoffice": {
"type": "string",
"description": "親の事業所コード(4桁、半角数字)"
},
"officehealthinsurances": {
"type": "object",
"properties": {
"is_join": {
"type": "number",
"description": "健康保険加入か(1: 加入, 0: 非加入)"
},
"cat_hi": {
"type": "number",
"enum": [
1,
2
],
"description": "健康保険種類(1: 全国健康保険協会管掌健康保険, 2: 健康保険組合)"
},
"cd_pcg": {
"type": "string",
"description": "都道府県コード(2桁、半角数字)"
},
"is_specified": {
"type": "number",
"description": "介護保険特定被保険者の適用があるか(1: 適用あり, 0: 適用なし)"
},
"healthinsurancerates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ymd_b": {
"type": "string",
"description": "適用開始日"
},
"cat_hibiz": {
"type": "number",
"enum": [
1,
2,
3
],
"description": "健康保険事業種類(1: 一般, 2: 特定, 3: 基本)"
},
"rate_cpny: `98.5` (string, optional) - 全社分保険料率(整数4桁、小数点以下3桁、千分率)(cat_hibizが1の場合は必須入力。cat_hibizが2,3の場合はnull可)": {
"type": "string"
},
"rate_employee: `49.25` (string, optional) - 従業員負担分保険料率(整数4桁、小数点以下3桁、千分率)(cat_hibizが1の場合は必須入力。cat_hibizが2,3の場合はnull可)": {
"type": "string"
},
"rate_office: `49.25` (string, optional) - 事業主負担分保険料率(整数4桁、小数点以下3桁、千分率)(cat_hibizが1の場合は必須入力。cat_hibizが2,3の場合はnull可)": {
"type": "string"
}
},
"required": [
"ymd_b",
"cat_hibiz"
]
},
"description": "健康保険料率(cat_hibizが1,2,3の3レコード固定で返却、ymd_bはレコード間で同値)"
},
"childsupportrates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ymd_b": {
"type": "string",
"description": "適用開始日"
},
"rate_cpny": {
"type": "string",
"description": "全社分保険料率(整数4桁、小数点以下3桁、千分率)"
},
"rate_employee": {
"type": "string",
"description": "従業員負担分保険料率(整数4桁、小数点以下3桁、千分率)"
},
"rate_office": {
"type": "string",
"description": "事業主負担分保険料率(整数4桁、小数点以下3桁、千分率)"
}
},
"required": [
"ymd_b",
"rate_cpny",
"rate_employee",
"rate_office"
]
},
"description": "子ども・子育て支援金率(is_headが1の場合のみ情報を返却(1レコードのみ)、is_headが0の場合は空の配列を返却)"
},
"careinsurancerates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ymd_b": {
"type": "string",
"description": "適用開始日"
},
"rate_cpny": {
"type": "string",
"description": "全社分保険料率(整数4桁、小数点以下3桁、千分率)"
},
"rate_employee": {
"type": "string",
"description": "従業員負担分保険料率(整数4桁、小数点以下3桁、千分率)"
},
"rate_office": {
"type": "string",
"description": "事業主負担分保険料率(整数4桁、小数点以下3桁、千分率)"
}
},
"required": [
"ymd_b",
"rate_cpny",
"rate_employee",
"rate_office"
]
},
"description": "介護保険料率(is_headが1の場合のみ情報を返却(1レコードのみ)、is_headが0の場合は空の配列を返却)"
},
"symbol_left": {
"type": "string",
"description": "健康保険記号左(4桁、全角)"
},
"symbol_right": {
"type": "string",
"description": "健康保険記号右(4桁、全角)"
},
"no_hi": {
"type": "string",
"description": "健康保険番号(6桁、半角英数記号)"
}
},
"required": [
"is_join",
"cat_hi",
"is_specified",
"healthinsurancerates"
],
"additionalProperties": false,
"description": "健保・子育て・介護情報(is_appliedhiが1の場合のみ情報を返却、is_appliedhiが0の場合は空のハッシュを返却)"
},
"officewelfarepensions": {
"type": "object",
"properties": {
"is_joinwp": {
"type": "number",
"description": "厚生年金保険加入か(1: 加入, 0: 非加入)"
},
"is_specified": {
"type": "number",
"description": "厚生年金短時間労働者特定適用事業所か(1: 該当する, 0: 該当しない)"
},
"is_joinwpf": {
"type": "number",
"description": "厚生年金基金加入か(1: 加入, 0: 非加入)"
},
"welfarepensionfundquitrates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ymd_b": {
"type": "string",
"description": "適用開始日"
},
"cat_sijob": {
"type": "number",
"enum": [
1,
2
],
"description": "社会保険種別(1: 一般, 2: 坑内員)"
},
"rate_wpfquit": {
"type": "number",
"description": "厚生年金基金免除料率(整数のみ2桁、千分率、0~50の間)"
}
},
"required": [
"ymd_b",
"cat_sijob",
"rate_wpfquit"
]
},
"description": "厚生年金基金免除料率(cat_sijobが1,2の2レコード固定で返却、ymd_bはレコード間で同値)"
},
"welfarepensionrates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ymd_b": {
"type": "string",
"description": "適用開始日"
},
"cat_sijob": {
"type": "number",
"enum": [
1,
2
],
"description": "社会保険種別(1: 一般, 2: 坑内員)"
},
"rate_cpny": {
"type": "string",
"description": "全社分保険料率(整数4桁、小数点以下3桁、千分率)"
},
"rate_employee": {
"type": "string",
"description": "従業員負担分保険料率(整数4桁、小数点以下3桁、千分率)"
},
"rate_office": {
"type": "string",
"description": "事業主負担分保険料率(整数4桁、小数点以下3桁、千分率)"
}
},
"required": [
"ymd_b",
"cat_sijob",
"rate_cpny",
"rate_employee",
"rate_office"
]
},
"description": "厚生年金保険料率(cat_sijobが1,2の2レコード固定で返却、ymd_bはレコード間で同値)"
},
"welfarepensionfundrates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ymd_b": {
"type": "string",
"description": "適用開始日"
},
"cat_paysrc": {
"type": "number",
"enum": [
1,
2
],
"description": "給与賞与区分(1: 給与, 2: 賞与)"
},
"cat_sijob": {
"type": "number",
"enum": [
1,
2
],
"description": "社会保険種別(1: 一般, 2: 坑内員)"
},
"rate_cpny": {
"type": "string",
"description": "全社分保険料率(整数4桁、小数点以下3桁、千分率)"
},
"rate_employee": {
"type": "string",
"description": "従業員負担分保険料率(整数4桁、小数点以下3桁、千分率)"
},
"rate_office": {
"type": "string",
"description": "事業主負担分保険料率(整数4桁、小数点以下3桁、千分率)"
}
},
"required": [
"ymd_b",
"cat_paysrc",
"cat_sijob",
"rate_cpny",
"rate_employee",
"rate_office"
]
},
"description": "厚生年金基金料率(cat_paysrcが1,2、それぞれcat_sijobが1,2の4レコード固定で返却、ymd_bはレコード間で同値)"
},
"childcarerates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ymd_b": {
"type": "string",
"description": "適用開始日"
},
"rate_childcare": {
"type": "string",
"description": "子ども・子育て拠出金率(整数4桁、小数点以下2桁、千分率)"
}
},
"required": [
"ymd_b",
"rate_childcare"
]
},
"description": "子ども・子育て拠出金率(1レコードのみ)"
},
"symbol_left": {
"type": "string",
"description": "厚生年金保険記号左(4桁、全角)"
},
"symbol_right": {
"type": "string",
"description": "厚生年金保険記号右(4桁、全角)"
},
"no_wp": {
"type": "string",
"description": "厚生年金保険番号(6桁、半角英数記号)"
},
"no_office": {
"type": "string",
"description": "厚生年金保険番号(11桁、半角英数記号)"
}
},
"required": [
"is_joinwp",
"is_specified",
"is_joinwpf",
"welfarepensionfundquitrates",
"welfarepensionrates",
"welfarepensionfundrates",
"childcarerates"
],
"additionalProperties": false,
"description": "厚生年金保険・基金情報(is_headが1の場合のみ情報を返却(1レコードのみ)、is_headが0の場合は空のハッシュを返却)"
},
"officelaborinsurances": {
"type": "object",
"properties": {
"is_joinei": {
"type": "number",
"description": "雇用保険加入か(1: 加入, 0: 非加入)"
},
"cat_eiapplied": {
"type": "number",
"enum": [
1,
2,
3
],
"description": "適用事業の種類(1: 一般, 2: 農林水産・清酒製造業, 3: 建設業)"
},
"is_joinii": {
"type": "number",
"description": "労災保険加入か(1: 加入, 0: 非加入)"
},
"employmentinsurancerates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ymd_b": {
"type": "string",
"description": "適用開始日"
},
"rate_cpny": {
"type": "string",
"description": "全社分保険料率(整数2桁、小数点以下2桁、千分率)"
},
"rate_employee": {
"type": "string",
"description": "従業員負担分保険料率(整数2桁、小数点以下2桁、千分率)"
},
"rate_office": {
"type": "string",
"description": "事業主負担分保険料率(整数2桁、小数点以下2桁、千分率)"
}
},
"required": [
"ymd_b",
"rate_cpny",
"rate_employee",
"rate_office"
]
},
"description": "雇用保険料率(1レコードのみ)"
},
"industrialinjuryinsurancerates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ymd_b": {
"type": "string",
"description": "適用開始日"
},
"rate_ii": {
"type": "string",
"description": "労災保険料率(整数4桁、小数点以下3桁、千分率)"
}
},
"required": [
"ymd_b",
"rate_ii"
]
},
"description": "労災保険料率(1レコードのみ)"
},
"asbestosrates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"ymd_b": {
"type": "string",
"description": "適用開始日"
},
"rate_asbst": {
"type": "string",
"description": "一般拠出金率(整数4桁、小数点以下2桁、千分率)"
}
},
"required": [
"ymd_b",
"rate_asbst"
]
},
"description": "一般拠出金率(is_headが1の場合のみ情報を返却(1レコードのみ)、is_headが0の場合は空の配列を返却)"
},
"no_pcg": {
"type": "string",
"description": "労働保険番号都道府県(2桁、半角英数記号)"
},
"no_palm": {
"type": "string",
"description": "労働保険番号所掌(1桁、半角英数記号)"
},
"no_province": {
"type": "string",
"description": "労働保険番号管轄(2桁、半角英数記号)"
},
"no_backbone": {
"type": "string",
"description": "労働保険番号基幹(6桁、半角英数記号)"
},
"no_branch": {
"type": "string",
"description": "労働保険番号枝番(3桁、半角英数記号)"
},
"nm_jobcentre": {
"type": "string",
"description": "提出先公共職業安定所(10桁、全角)"
},
"no_ei1": {
"type": "string",
"description": "雇用保険事業者番号1(4桁、半角英数記号)"
},
"no_ei2": {
"type": "string",
"description": "雇用保険事業者番号2(6桁、半角英数記号)"
},
"no_ei3": {
"type": "string",
"description": "雇用保険事業者番号3(1桁、半角英数記号)"
},
"ymd_ei": {
"type": "string",
"description": "雇用保険関係成立日"
},
"ymd_ii": {
"type": "string",
"description": "労災保険関係成立日"
}
},
"required": [
"is_joinei",
"cat_eiapplied",
"is_joinii",
"employmentinsurancerates",
"industrialinjuryinsurancerates"
],
"additionalProperties": false,
"description": "労働保険情報(is_appliedliが1の場合のみ情報を返却、is_appliedliが0の場合は空のハッシュを返却)"
},
"officeerequests": {
"type": "object",
"properties": {
"cd_submission_si": {
"type": "string",
"description": "社会保険届出の提出先(30桁、半角数字)"
},
"cd_submission_li": {
"type": "string",
"description": "雇用保険届出の提出先(30桁、半角数字)"
},
"symbol_left": {
"type": "string",
"description": "事業所整理記号(年金事務所提出用)左(2桁、半角数字)"
},
"symbol_right": {
"type": "string",
"description": "事業所整理記号(年金事務所提出用)右(4桁、全半角可)"
},
"no_hi": {
"type": "string",
"description": "事業所整理番号(年金事務所提出用)(5桁、半角数字)"
},
"id_employee": {
"type": "number",
"description": "連絡先担当者ID"
},
"mail_staff": {
"type": "string",
"description": "連絡先メールアドレス(256桁、全半角可)"
},
"phoneno_staff": {
"type": "string",
"description": "連絡先電話番号(20桁、半角数字、+、-)"
}
},
"additionalProperties": false,
"description": "e-Gov電子申請情報"
}
},
"required": [
"cd_office",
"is_appliedhi",
"is_appliedli",
"is_head",
"officeerequests"
]
},
"description": "事業所情報(階層構成は親と子の２階層のみ。並び順はまず親の事業所をord_dspの昇順で並べ、その間に子の事業所をord_dspの昇順で並べる(親1,子1-1,子1-2,親2,子2-1,子2-2...))"
}
},
"required": [
"status",
"offices"
]
}Headers
Content-Type: application/jsonBody
{
"status": 400,
"errors": [
{
"code": 1,
"message": "不正なリクエストです"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "パラメータの間違い・立上げ開始されていない など"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "number",
"enum": [
1
],
"description": "エラーコード(1: 立上げ開始されていない)"
},
"message": {
"type": "string",
"description": "エラーメッセージ"
}
},
"required": [
"message"
]
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 401,
"errors": [
{
"message": "トークンが存在しないか無効です"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "トークンがないもしくはトークンが無効の場合"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "エラーメッセージ"
}
}
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}事業所情報の取得GET/px/{ocode}/{locale}/api/v1/offices
処理概要
- 事業所情報を取得する
URI Parameters
- ocode
string(required) Example: tc09999001企業コード
- locale
string(required) Example: tfaシステム識別子
部署情報 ¶
部署情報の取得 ¶
GET /px/tc09999001/tfa/api/v1/divisions?offset=1?limit=20
Requests
Headers
Content-Type: application/jsonResponses
Headers
Content-Type: application/jsonBody
{
"status": 200,
"total_count": 200,
"divisions": [
{
"cd_div": "001",
"nm_div": "営業部",
"kana_div": "エイギョウブ",
"snm_div": "営業",
"is_cpny": 1,
"cd_parentdiv": "008"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "成功"
},
"total_count": {
"type": "number",
"description": "件数"
},
"divisions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cd_div": {
"type": "string",
"description": "部署コード"
},
"nm_div": {
"type": "string",
"description": "部署名"
},
"kana_div": {
"type": "string",
"description": "部署名フリガナ"
},
"snm_div": {
"type": "string",
"description": "部署略称"
},
"is_cpny": {
"type": "number",
"description": "全社か否か(1: 全社 0: 全社以外の部署)"
},
"cd_parentdiv": {
"type": "string",
"description": "親部署コード(自部署の一つ上の階層の部署コードをセット)"
}
},
"required": [
"cd_div",
"nm_div",
"kana_div",
"snm_div",
"is_cpny",
"cd_parentdiv"
]
},
"description": "部署情報 ord_dspの昇順に並ぶ"
}
},
"required": [
"status",
"total_count"
]
}Headers
Content-Type: application/jsonBody
{
"status": 400,
"errors": [
{
"code": 1,
"message": "不正なリクエストです"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "パラメータの間違い・立上げ開始されていない など"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "number",
"enum": [
1
],
"description": "エラーコード(1: 立上げ開始されていない)"
},
"message": {
"type": "string",
"description": "エラーメッセージ"
}
},
"required": [
"message"
]
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 401,
"errors": [
{
"message": "トークンが存在しないか無効です"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "トークンがないもしくはトークンが無効の場合"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "エラーメッセージ"
}
}
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}部署情報の取得GET/px/{ocode}/{locale}/api/v1/divisions{?offset}{?limit}
処理概要
- 部署情報を取得する
URI Parameters
- ocode
string(required) Example: tc09999001企業コード
- locale
string(required) Example: tfaシステム識別子
- offset
number(optional) Default: 0 Example: 1取得レコードのオフセット
- limit
number(optional) Default: 20 Example: 20取得レコードの件数 (min: 1, max: 1000)
社員情報の取得 ¶
社員情報の取得 ¶
GET /px/tc09999001/tfa/api/v1/employees?offset=1?limit=20?sort=no_employee?is_retired=1?cd_office=0001?is_include_childoffice=1?cd_div=200?cd_dep=200?is_include_childdep=1?cd_deptreecat=001?cat_employees=1,2
Requests
Headers
Content-Type: application/jsonResponses
Headers
Content-Type: application/jsonBody
{
"status": 200,
"total_count": 200,
"employees": [
{
"no_employee": "0000001",
"nm_family": "山田",
"nm_first": "太郎",
"kana_family": "ﾔﾏﾀﾞ",
"kana_first": "ﾀﾛｳ",
"gender": "M",
"ymd_birth": "1989-01-08",
"cd_postal": "1628585",
"address1": "東京都新宿区揚場町2-1",
"address2": "軽子坂MNビル5F",
"kana_address1": "ﾄｳｷｮｳﾄｼﾝｼﾞｭｸｸ2-1",
"kana_address2": "ｶﾙｺﾞｻﾞｶMNﾋﾞﾙ5F",
"cd_town_address": "13104",
"cd_town_regtax": "13104",
"phoneno1": "0120-11-1111",
"phoneno2": "0120-11-1111",
"mail1": "aaaaa@example.com",
"mail2": "aaaaa@example.com",
"ymd_hire": "2000-04-01",
"cd_office": "0001",
"cd_div": "001",
"cd_dep": "001",
"cd_salarysystem": "0001",
"cd_bonussystem": "0001",
"cat_employee": 3,
"nm_position": "チーフ",
"cat_taxtbl": 1,
"cat_taxprice": 1,
"is_retired": 1,
"is_absence": 1,
"id_employee": 1
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "成功"
},
"total_count": {
"type": "number",
"description": "件数"
},
"employees": {
"type": "array",
"items": {
"type": "object",
"properties": {
"no_employee": {
"type": "string",
"description": "社員番号(7桁、半角数字)"
},
"nm_family": {
"type": "string",
"description": "氏名(姓)(60桁、全半角可)"
},
"nm_first": {
"type": "string",
"description": "氏名(名)(60桁、全半角可)"
},
"kana_family": {
"type": "string",
"description": "ﾌﾘｶﾞﾅ(姓)(30桁、半角英数字、半角カナ、半角記号、半角スペース)"
},
"kana_first": {
"type": "string",
"description": "ﾌﾘｶﾞﾅ(名)(30桁、半角英数字、半角カナ、半角記号、半角スペース)"
},
"gender": {
"type": "string",
"description": "性別(M: 男性, F: 女性)"
},
"ymd_birth": {
"type": "string",
"description": "生年月日"
},
"cd_postal": {
"type": "string",
"description": "郵便番号(7桁、半角数字)"
},
"address1": {
"type": "string",
"description": "住所上段(40桁、全半角可)"
},
"address2": {
"type": "string",
"description": "住所下段(40桁、全半角可)"
},
"kana_address1": {
"type": "string",
"description": "住所上段カナ(40桁、半角)"
},
"kana_address2": {
"type": "string",
"description": "住所下段カナ(40桁、半角)"
},
"cd_town_address": {
"type": "string",
"description": "住所地市町村コード(5桁、半角数字)"
},
"cd_town_regtax": {
"type": "string",
"description": "住民税納付先市町村コード(5桁、半角数字)"
},
"phoneno1": {
"type": "string",
"description": "電話番号1(20桁、全半角可)"
},
"phoneno2": {
"type": "string",
"description": "電話番号2(20桁、全半角可)"
},
"mail1": {
"type": "string",
"description": "メール1(256桁、全半角可)"
},
"mail2": {
"type": "string",
"description": "メール2(256桁、全半角可)"
},
"ymd_hire": {
"type": [
"string",
"null"
],
"description": "入社年月日"
},
"cd_office": {
"type": "string",
"description": "事業所コード(4桁、半角数字)"
},
"cd_div": {
"type": "string",
"description": "部署コード(3桁、半角数字)"
},
"cd_dep": {
"type": "string",
"description": "部門コード(3桁、半角数字)"
},
"cd_salarysystem": {
"type": "string",
"description": "給与体系コード(4桁、半角数字)"
},
"cd_bonussystem": {
"type": "string",
"description": "賞与体系コード(4桁、半角数字)"
},
"cat_employee": {
"type": "number",
"enum": [
1,
2,
3,
4,
5,
6
],
"description": "役社員区分(1: 役員, 2: 兼務役員, 3: 社員, 4: 嘱託, 5: パート・アルバイト, 6: その他)"
},
"nm_position": {
"type": "string",
"description": "役職名(20桁、全半角可)"
},
"cat_taxtbl": {
"type": "number",
"enum": [
1,
2,
3,
4,
5
],
"description": "税表区分(1: 甲, 2: 乙, 3: 丙, 4: 非居住者, 5: 課税なし)"
},
"cat_taxprice": {
"type": "number",
"enum": [
0,
1,
2
],
"description": "税額表区分(0: 指定なし 1: 月額 2: 日額 )"
},
"is_retired": {
"type": "number",
"description": "退職済みか(1: 退職済み, 0: 退職済みでない)"
},
"is_absence": {
"type": "number",
"description": "休職中か(1: 休職中, 0: 休職中でない)"
},
"id_employee": {
"type": "number",
"description": "社員ID"
}
},
"required": [
"no_employee",
"gender",
"ymd_birth",
"cd_office",
"cd_div",
"cd_dep",
"cd_salarysystem",
"cd_bonussystem",
"cat_employee",
"cat_taxtbl",
"cat_taxprice",
"is_retired",
"is_absence",
"id_employee"
]
},
"description": "社員情報"
}
},
"required": [
"status",
"total_count"
]
}Headers
Content-Type: application/jsonBody
{
"status": 400,
"errors": [
{
"code": 1,
"message": "不正なリクエストです"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "パラメータの間違い・立上げ開始されていない など"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "number",
"enum": [
1
],
"description": "エラーコード(1: 立上げ開始されていない)"
},
"message": {
"type": "string",
"description": "エラーメッセージ"
}
},
"required": [
"message"
]
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 401,
"errors": [
{
"message": "トークンが存在しないか無効です"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "トークンがないもしくはトークンが無効の場合"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "エラーメッセージ"
}
}
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}社員情報の取得GET/px/{ocode}/{locale}/api/v1/employees{?offset}{?limit}{?sort}{?is_retired}{?cd_office}{?is_include_childoffice}{?cd_div}{?cd_dep}{?is_include_childdep}{?cd_deptreecat}{?cat_employees}
処理概要
- 社員情報を取得する
URI Parameters
- ocode
string(required) Example: tc09999001企業コード
- locale
string(required) Example: tfaシステム識別子
- offset
number(optional) Default: 0 Example: 1取得レコードのオフセット
- limit
number(optional) Default: 20 Example: 20取得レコードの件数 (min: 1, max: 1000)
- sort
string(optional) Default: no_employee Example: no_employeeソート項目の指定
-
ソートの指定が必要な場合、
sort={項目名}と指定します。降順の場合は項目名の直前に-を付与。 -
ソートの指定が可能なのは以下の項目です
- no_employee: 社員番号
- ord_dsp_div: 部署並び順
- cd_salarysystem: 給与体系コード
-
※例
- 社員番号昇順、部署並び順降順でソートする場合
?sort=no_employee,-ord_dsp_div
- 社員番号昇順、部署並び順降順でソートする場合
-
- is_retired
number(optional) Example: 1退職済みか (1:退職済みのみ,0:退職済み以外のみ, 指定なし:絞り込まない)
- cd_office
string(optional) Example: 0001事業所コード (渡されない場合は絞り込まない)
- is_include_childoffice
number(optional) Example: 1子事業所所属社員も取得するか (0：取得しない,1:取得する,指定なし：取得しない)
- cd_div
string(optional) Example: 200部署コード (渡されない場合は絞り込まない)
- cd_dep
string(optional) Example: 200部門コード (渡されない場合は絞り込まない)
- is_include_childdep
number(optional) Example: 1子部門所属社員も取得するか (0：取得しない,1:取得する,指定なし：取得しない)
- cd_deptreecat
string(optional) Example: 001部門階層分類コード (子部門所属社員も取得する場合のみ必須)
- cat_employees
string(optional) Example: 1,2役社員区分(渡されない場合は絞り込まない)
-
複数指定が必要な場合、取得したい区分をカンマ区切りで指定してください
-
区分は以下の通り
- 1: 役員
- 2: 兼務役員
- 3: 社員
- 4: 嘱託
- 5: パート・アルバイト
- 6: その他
-
※例
- 役員、兼務役員を取得する場合
?cat_employees=1,2
- 役員、兼務役員を取得する場合
-
給与体系情報 ¶
給与体系情報の取得 ¶
GET /px/tc09999001/tfa/api/v1/salarysystems
Requests
Headers
Content-Type: application/jsonResponses
Headers
Content-Type: application/jsonBody
{
"status": 200,
"salarysystems": [
{
"cd_salarysystem": "0001",
"nm_salarysystem": "正社員",
"cat_paymonth": 2,
"cat_multipay": 2,
"salarysystempaytimeconfigs": [
{
"cnt_pymt": 1,
"day_pymt": 5,
"cat_refmonth_st": 2,
"day_st": 1,
"cat_refmonth_end": 2,
"day_end": 1
}
],
"cat_bnkholiday": 2,
"is_roundovertimeunit": 1,
"cat_roundovertimeunit": 2,
"cat_roundovertime": 2,
"cat_roundddct": 2,
"is_frctdepsit": 1,
"cat_frctdpst": 1,
"amnt_frctdpst": 100,
"cat_baseday": 1,
"cd_attnd_base": "0001",
"cd_attnd_ddct": "0009",
"cd_phptn": "001",
"salaryattnd2salarysystems": [
{
"cd_attnd": "0001"
}
],
"salarypymt2salarysystems": [
{
"cd_salarypymt": "0001"
}
],
"salarysystempymt": {
"cat_itminp": 1,
"amnt_unit": 1000,
"cat_cntquantity": 1,
"cat_round": 2,
"cd_formula": "0001",
"cd_wagetable": "0001",
"cd_condition": "0001",
"salarysystemratepymts": [
{
"cd_salarypymt_src": "0001"
}
]
},
"salaryddct2salarysystems": [
{
"cd_salaryddct": "0001"
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "成功"
},
"salarysystems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cd_salarysystem": {
"type": "string",
"description": "給与体系コード(4桁、半角数字)"
},
"nm_salarysystem": {
"type": "string",
"description": "給与体系名(16桁、全半角可)"
},
"cat_paymonth": {
"type": "number",
"enum": [
1,
2,
3
],
"description": "給与支給月と月分の関係（1:同じ月（３月分給与として３月に支給）、2:月分が前月（２月分給与として３月に支給）、3:月分が翌月（４月分給与として３月に支給））"
},
"cat_multipay": {
"type": "number",
"enum": [
1,
2,
3,
4
],
"description": "同月内支給回数区分（1:月１回、2:半月ごと、3:10日ごと、4:随時）"
},
"salarysystempaytimeconfigs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cnt_pymt": {
"type": "number",
"description": "同月内での支給回数"
},
"day_pymt": {
"type": "number",
"description": "支給日（末の場合は0）"
},
"cat_refmonth_st": {
"type": "number",
"enum": [
1,
2,
3
],
"description": "給与体系起算日の基準月（1:当月、2:前月、3:前々月）"
},
"day_st": {
"type": "number",
"description": "起算日（末日は0）。レスポンスには常にキーを含み、未設定時はnull"
},
"cat_refmonth_end": {
"type": "number",
"enum": [
1,
2,
3
],
"description": "給与体系締め日の基準月（1:当月、2:前月、3:前々月）"
},
"day_end": {
"type": "number",
"description": "締め日（末日は0）。レスポンスには常にキーを含み、未設定時はnull"
}
},
"required": [
"cnt_pymt",
"day_pymt",
"cat_refmonth_st",
"day_st",
"cat_refmonth_end",
"day_end"
]
},
"description": "給与体系ごとの支給時期設定。給与体系コードの昇順、同月内での支給回数の昇順に並ぶ。随時の場合には空の配列を返す。"
},
"cat_bnkholiday": {
"type": "number",
"enum": [
1,
2,
3
],
"description": "金融機関の休日の場合の取扱(1: 前に繰り上げ、2: 後に繰り下げ、3: そのまま)"
},
"is_roundovertimeunit": {
"type": "number",
"description": "時間外手当単価を端数処理するか(1: する, 0: しない)"
},
"cat_roundovertimeunit": {
"type": "number",
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"description": "時間外手当単価の端数処理区分(0:時間外手当単価の端数処理区分を使用しない, 1:１円未満四捨五入、2:１円未満切り捨て、3:１円未満切り上げ、4:１０円未満四捨五入、5:１０円未満切り捨て、6:１０円未満切り上げ)"
},
"cat_roundovertime": {
"type": "number",
"enum": [
1,
2,
3,
4,
5,
6
],
"description": "時間外手当の端数処理区分(1:１円未満四捨五入、2:１円未満切り捨て、3:１円未満切り上げ、4:１０円未満四捨五入、5:１０円未満切り捨て、6:１０円未満切り上げ)"
},
"cat_roundddct": {
"type": "number",
"enum": [
1,
2,
3,
4,
5,
6
],
"description": "控除の端数処理区分(1:１円未満四捨五入、2:１円未満切り捨て、3:１円未満切り上げ、4:１０円未満四捨五入、5:１０円未満切り捨て、6:１０円未満切り上げ)"
},
"is_frctdepsit": {
"type": "number",
"description": "端数預け金処理するか(1: する, 0: しない)"
},
"cat_frctdpst": {
"type": "number",
"enum": [
1,
2
],
"description": "端数預け金の処理方法(1:次月分に加算、2:自社管理)"
},
"amnt_frctdpst": {
"type": "number",
"description": "端数預け金処理 端数基準額"
},
"cat_baseday": {
"type": "number",
"enum": [
1,
2
],
"description": "算定基礎届での欠勤控除時の支払基礎日数の算定母数(1:暦日数、2:勤怠項目)"
},
"cd_attnd_base": {
"type": "string",
"description": "支払基礎日数で基準となる勤怠項目コード(4桁、半角数字)"
},
"cd_attnd_ddct": {
"type": "string",
"description": "社保支払基礎日数で控除する勤怠項目コード(4桁、半角数字)"
},
"cd_phptn": {
"type": "string",
"description": "有給休暇付与パターンコード(3桁、半角数字)"
},
"salaryattnd2salarysystems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cd_attnd": {
"type": "string",
"description": "勤怠項目コード(4桁、半角数字)"
}
},
"required": [
"cd_attnd"
]
},
"description": "給与体系と勤怠項目の関連付け。表示順の昇順に並ぶ"
},
"salarypymt2salarysystems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cd_salarypymt": {
"type": "string",
"description": "給与支給項目コード(4桁、半角数字)"
}
},
"required": [
"cd_salarypymt"
]
},
"description": "給与体系と支給項目の関連付け。表示順の昇順に並ぶ"
},
"salarysystempymt": {
"type": "object",
"properties": {
"cat_itminp": {
"type": "number",
"enum": [
1,
2,
3,
4,
5,
6,
7,
8,
9,
10,
11,
12,
13
],
"description": "項目属性(1:定額、2:定額（入力値は次回に引き継がれない）、3:毎回入力、4:数量×単価、5:割合、6:現物、7:同額控除、8:計算式、9:賃金テーブル、10:項目種類毎の自動集計、11:日給、12:時給、13:条件式)"
},
"amnt_unit": {
"type": "number",
"description": "単価（整数部６桁、小数部４桁）項目属性が数量×単価のときのみ使用"
},
"cat_cntquantity": {
"type": "number",
"enum": [
0,
1,
2
],
"description": "数量カウント方法(0:項目属性が数量ｘ単価ではない, 1:数値、2:時間) 項目属性が数量×単価のときのみ使用"
},
"cat_round": {
"type": "number",
"enum": [
0,
1,
2,
3,
4,
5,
6
],
"description": "端数処理区分(0:端数処理区分を使用しない, 1:１円未満四捨五入、2:１円未満切り捨て、3:１円未満切り上げ、4:１０円未満四捨五入、5:１０円未満切り捨て、6:１０円未満切り上げ)"
},
"cd_formula": {
"type": "string",
"description": "計算式コード(4桁、半角数字)。レスポンスには常にキーを含み、項目属性が計算式以外の場合は空文字"
},
"cd_wagetable": {
"type": "string",
"description": "賃金テーブルコード(4桁、半角数字)。レスポンスには常にキーを含み、項目属性が賃金テーブル以外の場合は空文字"
},
"cd_condition": {
"type": "string",
"description": "条件式コード(4桁、半角数字)。レスポンスには常にキーを含み、項目属性が条件式以外の場合は空文字"
},
"salarysystemratepymts": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cd_salarypymt_src": {
"type": "string",
"description": "割合給計算項目 支給項目コード(4桁、半角数字)。項目属性が割合のときのみ使用"
}
},
"required": [
"cd_salarypymt_src"
]
},
"description": "給与体系ごとの支給項目。割合給の基準項目（現状は通勤手当のみセットされる）。割合給計算項目 支給項目コードの昇順に並ぶ。項目属性が割合以外の場合は空の配列を返す。"
}
},
"required": [
"cat_itminp",
"amnt_unit",
"cat_cntquantity",
"cat_round",
"cd_formula",
"cd_wagetable",
"cd_condition"
],
"description": "給与体系毎の支給項目設定（現在は、通勤手当のみ設定可能）"
},
"salaryddct2salarysystems": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cd_salaryddct": {
"type": "string",
"description": "給与控除項目コード(4桁、半角数字)"
}
},
"required": [
"cd_salaryddct"
]
},
"description": "給与体系と控除項目の関連付け。表示順の昇順に並ぶ"
}
},
"required": [
"cd_salarysystem",
"nm_salarysystem",
"cat_paymonth",
"cat_multipay",
"cat_bnkholiday",
"is_roundovertimeunit",
"cat_roundovertimeunit",
"cat_roundovertime",
"cat_roundddct",
"is_frctdepsit",
"cat_frctdpst",
"amnt_frctdpst",
"cat_baseday",
"cd_attnd_base",
"cd_attnd_ddct",
"cd_phptn"
]
},
"description": "給与体系情報。cd_salarysystemの昇順に並ぶ"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 400,
"errors": [
{
"code": 1,
"message": "不正なリクエストです"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "パラメータの間違い・立上げ開始されていない など"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "number",
"enum": [
1
],
"description": "エラーコード(1: 立上げ開始されていない)"
},
"message": {
"type": "string",
"description": "エラーメッセージ"
}
},
"required": [
"message"
]
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 401,
"errors": [
{
"message": "トークンが存在しないか無効です"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "トークンがないもしくはトークンが無効の場合"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "エラーメッセージ"
}
}
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}給与体系情報の取得GET/px/{ocode}/{locale}/api/v1/salarysystems
処理概要
- 給与体系情報を取得する。
URI Parameters
- ocode
string(required) Example: tc09999001企業コード
- locale
string(required) Example: tfaシステム識別子
支給日情報の取得 ¶
支給日情報の取得 ¶
GET /px/tc09999001/tfa/api/v1/salarypaymentdates?ymd_pymt_b=2026-01-01?ymd_pymt_e=2026-12-31?sort=ymd_pymt
Requests
Headers
Content-Type: application/jsonResponses
Headers
Content-Type: application/jsonBody
{
"status": 200,
"salarypaymentdates": [
{
"cd_salarysystem": "0001",
"ymd_pymt": "2026-01-31",
"is_preusesystem 1": 0,
"is_inkind 1": 0,
"ym_proc": 202601,
"ymd_initial": "2026-01-01",
"ymd_closed": "2026-01-31",
"is_closed": 1
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "成功"
},
"salarypaymentdates": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cd_salarysystem": {
"type": "string",
"description": "給与体系コード(4桁、半角数字)"
},
"ymd_pymt": {
"type": "string",
"description": "支給日"
},
"is_preusesystem 1": {
"type": "number",
"description": "利用開始前の支給か(1: 利用開始前の支給, 0: 利用開始前の支給でない)"
},
"is_inkind 1": {
"type": "number",
"description": "現物支給か(1: 現物支給, 0: 現物支給でない)"
},
"ym_proc": {
"type": "number",
"description": "支給月分"
},
"ymd_initial": {
"type": "string",
"description": "計算期間の起算日"
},
"ymd_closed": {
"type": "string",
"description": "計算期間の締め日"
},
"is_closed": {
"type": "number",
"description": "確定済みか(1: 確定済み, 0: 確定済みでない)"
}
},
"required": [
"cd_salarysystem",
"ymd_pymt",
"is_preusesystem 1",
"is_inkind 1",
"ym_proc",
"ymd_initial",
"ymd_closed",
"is_closed"
]
},
"description": "支給日情報"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 400,
"errors": [
{
"code": 1,
"message": "不正なリクエストです"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "パラメータの間違い・立上げ開始されていない など"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"code": {
"type": "number",
"enum": [
1
],
"description": "エラーコード(1: 立上げ開始されていない)"
},
"message": {
"type": "string",
"description": "エラーメッセージ"
}
},
"required": [
"message"
]
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 401,
"errors": [
{
"message": "トークンが存在しないか無効です"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "トークンがないもしくはトークンが無効の場合"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "エラーメッセージ"
}
}
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}支給日情報の取得GET/px/{ocode}/{locale}/api/v1/salarypaymentdates{?ymd_pymt_b}{?ymd_pymt_e}{?sort}
処理概要
- 支給日情報を取得する
URI Parameters
- ocode
string(required) Example: tc09999001企業コード
- locale
string(required) Example: tfaシステム識別子
- ymd_pymt_b
string(required) Example: 2026-01-01支給日の開始
- ymd_pymt_e
string(required) Example: 2026-12-31支給日の終了
- sort
string(optional) Default: ymd_pymt,cd_salarysystem Example: ymd_pymtソート項目の指定
-
ソートの指定が必要な場合、
sort={項目名}と指定します。降順の場合は項目名の直前に-を付与。 -
ソートの指定が可能なのは以下の項目です
- ymd_pymt: 支給日
- cd_salarysystem: 給与体系コード
-
※例
- 支給日昇順、給与体系コード降順でソートする場合
?sort=ymd_pymt,-cd_salarysystem
- 支給日昇順、給与体系コード降順でソートする場合
-
勤怠実績 ¶
勤怠実績の登録 ¶
POST /px/tc09999001/tfa/api/v1/attendanceresults/2025-01-31
Requests
Headers
Content-Type: application/jsonBody
{
"attendanceresults": [
{
"no_employee": "0000001",
"employeeattendanceresults": [
{
"cd_attnd": "0001",
"cnt_attnd: 20.05 (number) - 勤怠回数(整数部３桁、小数部２桁) ※ 勤怠項目が数量(cat_cntattnd=1)の場合に必須": "",
"times_attnd: `00:00` (string) - 勤怠時間（HH:MM）※ 勤怠項目が時間(cat_cntattnd=2)の場合に必須": ""
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"attendanceresults": {
"type": "array",
"items": {
"type": "object",
"properties": {
"no_employee": {
"type": "string",
"description": "社員番号"
},
"employeeattendanceresults": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cd_attnd": {
"type": "string",
"description": "勤怠項目コード(4桁、半角数字)"
},
"cnt_attnd: 20.05 (number) - 勤怠回数(整数部３桁、小数部２桁) ※ 勤怠項目が数量(cat_cntattnd=1)の場合に必須": {
"type": "string"
},
"times_attnd: `00:00` (string) - 勤怠時間（HH:MM）※ 勤怠項目が時間(cat_cntattnd=2)の場合に必須": {
"type": "string"
}
},
"required": [
"cd_attnd"
]
},
"description": "社員に紐づく勤怠実績"
}
},
"required": [
"no_employee"
]
},
"description": "勤怠実績情報"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"status": 200
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "成功"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 400,
"errors": [
{
"no_employee": "0000001",
"cd_attnd": "0001",
"code": 12,
"message": "勤怠項目が存在しません。"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "パラメータの間違い・バリデーションエラー発生時 など"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"no_employee": {
"type": [
"string",
"null"
],
"description": "社員番号"
},
"cd_attnd": {
"type": [
"string",
"null"
],
"description": "勤怠項目コード"
},
"code": {
"type": [
"number",
"null"
],
"description": "エラーコード"
},
"message": {
"type": "string",
"description": "エラーメッセージ"
}
},
"required": [
"message"
]
},
"description": "エラー内容 ※詳細は別表参照"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 401,
"errors": [
{
"message": "トークンが存在しないか無効です"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "トークンがないもしくはトークンが無効の場合"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "エラーメッセージ"
}
}
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 405,
"errors": [
{
"message": "メソッドは許可されていません。"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "HTTPステータスコード"
},
"errors": {
"type": "array",
"description": "エラー内容"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 406,
"errors": [
{
"message": "許可されていないフォーマットです。"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "HTTPステータスコード"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "エラーメッセージ"
}
}
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 409,
"errors": [
{
"message": "他のクライアントで修正・削除されています"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "HTTPステータスコード"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "エラーメッセージ"
}
}
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "HTTPステータスコード"
}
},
"required": [
"status"
]
}勤怠実績の登録POST/px/{ocode}/{locale}/api/v1/attendanceresults/{ymd_pymt}
処理概要
- 勤怠実績を登録する。リクエストは最大２００人分可能。
httpステータス
URI Parameters
- ocode
string(required) Example: tc09999001企業コード
- locale
string(required) Example: tfaシステム識別子
- ymd_pymt
string(required) Example: 2025-01-31支給日
時間外実績の登録 ¶
時間外実績の登録 ¶
POST /px/tc09999001/tfa/api/v1/overtimeresults/2025-01-31
Requests
Headers
Content-Type: application/jsonBody
{
"overtimeresults": [
{
"no_employee": "0000001",
"employeeovertimeresults": [
{
"cd_overtime": "A",
"cnt_times": "00:00"
}
]
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"overtimeresults": {
"type": "array",
"items": {
"type": "object",
"properties": {
"no_employee": {
"type": "string",
"description": "社員番号"
},
"employeeovertimeresults": {
"type": "array",
"items": {
"type": "object",
"properties": {
"cd_overtime": {
"type": "string",
"description": "時間外項目コード(1桁、半角英字)"
},
"cnt_times": {
"type": "string",
"description": "時間外時間（HH:MM）"
}
},
"required": [
"cd_overtime",
"cnt_times"
]
},
"description": "社員に紐づく時間外実績"
}
},
"required": [
"no_employee"
]
},
"description": "時間外実績情報"
}
}
}Responses
Headers
Content-Type: application/jsonBody
{
"status": 200
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "成功"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 400,
"errors": [
{
"no_employee": "0000001",
"cd_overtime": "X",
"code": 21,
"message": "時間外手当が存在しません。"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "パラメータの間違い・バリデーションエラー発生時 など"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"no_employee": {
"type": [
"string",
"null"
],
"description": "社員番号"
},
"cd_overtime": {
"type": [
"string",
"null"
],
"description": "時間外項目コード"
},
"code": {
"type": [
"number",
"null"
],
"description": "エラーコード"
},
"message": {
"type": "string",
"description": "エラーメッセージ"
}
},
"required": [
"message"
]
},
"description": "エラー内容 ※詳細は別表参照"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 401,
"errors": [
{
"message": "トークンが存在しないか無効です"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "トークンがないもしくはトークンが無効の場合"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "エラーメッセージ"
}
}
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 405,
"errors": [
{
"message": "メソッドは許可されていません。"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "HTTPステータスコード"
},
"errors": {
"type": "array",
"description": "エラー内容"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 406,
"errors": [
{
"message": "許可されていないフォーマットです。"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "HTTPステータスコード"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "エラーメッセージ"
}
}
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 409,
"errors": [
{
"message": "他のクライアントで修正・削除されています"
}
]
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "HTTPステータスコード"
},
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "エラーメッセージ"
}
}
},
"description": "エラー内容"
}
},
"required": [
"status"
]
}Headers
Content-Type: application/jsonBody
{
"status": 500
}Schema
{
"$schema": "http://json-schema.org/draft-04/schema#",
"type": "object",
"properties": {
"status": {
"type": "number",
"description": "HTTPステータスコード"
}
},
"required": [
"status"
]
}時間外実績の登録POST/px/{ocode}/{locale}/api/v1/overtimeresults/{ymd_pymt}
処理概要
- 時間外実績を登録する。リクエストは最大２００人分可能。
httpステータス
URI Parameters
- ocode
string(required) Example: tc09999001企業コード
- locale
string(required) Example: tfaシステム識別子
- ymd_pymt
string(required) Example: 2025-01-31支給日
Generated by aglio on 11 Jun 2026