List Welfare Salary Types
ดึงรายการประเภทสวัสดิการ พร้อมยอดใช้ไปและวงเงิน (เมื่อระบุพนักงาน) รองรับสองโหมดการใช้งาน
Endpoint
POST /api/v1/open-apis/welfare/list_salary_typesRequest Body
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
employee_code | string | No | รหัสพนักงาน ถ้าระบุจะดึงพร้อมยอดสวัสดิการ | "EMP001" |
welfare_year | string | No | ปีสวัสดิการ (YYYY) จำเป็นเมื่อระบุ employee_code | "2026" |
from | string | No | "subMenu" = ดึงทุกประเภทโดยไม่กรอง | "subMenu" |
โหมดที่ 1: ดึงทุกประเภทสวัสดิการ (ไม่ระบุพนักงาน)
{}โหมดที่ 2: ดึงประเภทสวัสดิการพร้อมยอดของพนักงาน
{
"employee_code": "EMP001",
"welfare_year": "2026"
}Response Format
Success Response - โหมดที่ 1: ทุกประเภท (HTTP 200)
{
"code": 200,
"message": "ดึงรายการสำเร็จ",
"payload": [
{
"salary_type_id": "20260303STYP00001",
"salary_type_name": "สวัสดิการรักษาพยาบาล",
"salary_type_name_en": "Medical Welfare",
"salary_cal_type_lv": "Welfare"
}
]
}Success Response - โหมดที่ 2: พร้อมยอดพนักงาน (HTTP 200)
{
"code": 200,
"message": "ดึงรายการสำเร็จ",
"payload": [
{
"salary_type_id": "20260303STYP00001",
"salary_type_name": "สวัสดิการรักษาพยาบาล",
"salary_type_name_en": "Medical Welfare",
"employee_id": "20260309462FEF65EFCA",
"welfare_prev_amt": 5000.00,
"welfare_quota_amt": 20000.00,
"used_welfare_amt": 8000.00
}
]
}Response Fields (โหมดที่ 1)
| Field | Type | Description |
|---|---|---|
salary_type_id | string | รหัสประเภทสวัสดิการ |
salary_type_name | string | ชื่อประเภทสวัสดิการ (ตามภาษาที่ตั้งค่า) |
salary_type_name_en | string | ชื่อประเภทสวัสดิการ (EN) |
salary_cal_type_lv | string | ประเภทการคำนวณ ("Welfare") |
Response Fields เพิ่มเติม (โหมดที่ 2)
| Field | Type | Description |
|---|---|---|
employee_id | string | รหัสพนักงาน |
welfare_prev_amt | number | ยอดยกมา |
welfare_quota_amt | number | วงเงินปีนี้ |
used_welfare_amt | number | ยอดใช้ไปแล้ว |
Error Response - Validation Failed (HTTP 422)
{
"code": 422,
"message": "Validation failed",
"errors": [
"Missing required parameter: welfare_year"
]
}Error Response - Employee Not Found (HTTP 400)
{
"code": 400,
"message": "ไม่พบข้อมูลพนักงาน"
}Code Examples
cURL
# โหมดที่ 1: ดึงทุกประเภทสวัสดิการ
curl -X POST "https://openapi.humansoft.co.th/api/v1/open-apis/welfare/list_salary_types" \
-H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'
# โหมดที่ 2: ดึงพร้อมยอดของพนักงาน
curl -X POST "https://openapi.humansoft.co.th/api/v1/open-apis/welfare/list_salary_types" \
-H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"employee_code": "EMP001",
"welfare_year": "2026"
}'Notes
ข้อควรทราบ:
salary_type_idใน response เป็น plain text- เมื่อระบุ
employee_codeต้องระบุwelfare_yearด้วย welfare_prev_amt,welfare_quota_amt,used_welfare_amtจะมีเฉพาะในโหมดระบุพนักงาน- ชื่อ
salary_type_nameจะแสดงตามภาษาที่ตั้งค่าไว้ (THหรือEN)
Related APIs
- Submit Welfare Document - สร้างเอกสารสวัสดิการ (ต้องใช้
salary_type_idจาก API นี้) - List Balance - ดูยอดคงเหลือเฉพาะประเภทเดียว
- Search Employee Balance - ดูยอดทุกประเภทของพนักงาน
Last updated on