Skip to Content
🚀 Welcome to Humansoft Open API Documentation

List Welfare Employee By Type

ดึงรายการพนักงานพร้อมข้อมูล Config สวัสดิการตามประเภทและปี รองรับ Pagination

Endpoint

POST /api/v1/open-apis/welfare/list_welfare_employee_by_type

Request Parameters

Required Parameters

ParameterTypeRequiredDescriptionExample
salary_type_idstring (base64)Yesรหัสประเภทสวัสดิการ"MjAyNjAzMDNTVFlQWDAwMDE="
welfare_yearstringYesปีสวัสดิการ (YYYY)"2026"

Optional Parameters

ParameterTypeRequiredDescriptionExample
_PAGEintegerNoหน้าที่ต้องการ (default: 1)1
_NUMBER_PER_PAGEintegerNoจำนวนรายการต่อหน้า (default: ทั้งหมด)20

Request Body Example

{ "salary_type_id": "MjAyNjAzMDNTVFlQWDAwMDE=", "welfare_year": "2026", "_PAGE": 1, "_NUMBER_PER_PAGE": 20 }

Response Format

Success Response (HTTP 200)

{ "code": 200, "message": "ดึงข้อมูลสำเร็จ", "payload": [ { "employee_id": "20260309462FEF65EFCA", "employee_code": "EMP001", "employee_name": "สมหมาย", "employee_last_name": "พนักงาน", "employee_nickname": "หมาย", "company_name": "บริษัท ตัวอย่าง จำกัด", "department_name": "แผนกบุคคล", "position_name": "เจ้าหน้าที่", "welfare_list": { "welfare_employee_id": "20260303WEMP00001", "employee_id": "20260309462FEF65EFCA", "salary_type_id": "20260303STYP00001", "welfare_year": "2026", "welfare_quota_amt": "20000.00", "welfare_prev_amt": "5000.00" } }, { "employee_id": "20260309462FEF65EFCB", "employee_code": "EMP002", "employee_name": "สมศักดิ์", "employee_last_name": "รักงาน", "employee_nickname": "ศักดิ์", "company_name": "บริษัท ตัวอย่าง จำกัด", "department_name": "แผนกบัญชี", "position_name": "นักบัญชี", "welfare_list": null } ], "_PAGINATION": { "_TOTAL_RECORDS": 50, "_PAGE": 1, "_NUMBER_PER_PAGE": 20 } }

Response Fields - payload[]

FieldTypeDescription
employee_idstringรหัสพนักงาน (plain text)
employee_codestringรหัสพนักงาน (ตัวอักษร)
employee_namestringชื่อพนักงาน
employee_last_namestringนามสกุล
employee_nicknamestringชื่อเล่น
company_namestringชื่อบริษัท
department_namestringชื่อแผนก
position_namestringชื่อตำแหน่ง
welfare_listobject|nullConfig สวัสดิการ (null = ยังไม่ได้ตั้งค่า)

Response Fields - welfare_list (ถ้ามี)

FieldTypeDescription
welfare_employee_idstringรหัส Config (plain text)
welfare_quota_amtstringวงเงินสวัสดิการ
welfare_prev_amtstringยอดยกมา

Response Fields - _PAGINATION

FieldTypeDescription
_TOTAL_RECORDSintegerจำนวนพนักงานทั้งหมด
_PAGEintegerหน้าปัจจุบัน
_NUMBER_PER_PAGEintegerจำนวนรายการต่อหน้า

Error Response - Validation Failed (HTTP 422)

{ "code": 422, "message": "Validation failed", "errors": [ "'salary_type_id' and 'welfare_year' are required" ] }

Code Examples

curl -X POST "https://openapi.humansoft.co.th/api/v1/open-apis/welfare/list_welfare_employee_by_type" \ -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "salary_type_id": "MjAyNjAzMDNTVFlQWDAwMDE=", "welfare_year": "2026", "_PAGE": 1, "_NUMBER_PER_PAGE": 20 }'

Notes

ข้อควรทราบ:

  • salary_type_id ใน request ต้องเข้ารหัส Base64
  • ID ทั้งหมดใน response เป็น plain text
  • welfare_list = null หมายความว่าพนักงานคนนั้นยังไม่มี Config สำหรับประเภทสวัสดิการนี้ในปีนั้น
  • ถ้าไม่ระบุ _PAGE และ _NUMBER_PER_PAGE ระบบจะคืนทุกรายการ
  • Create Config - เพิ่ม Config ให้พนักงานที่ welfare_list = null
  • Update Multiple - อัปเดตหลายพนักงานพร้อมกัน
Last updated on