Skip to Content
🚀 Welcome to Humansoft Open API Documentation

List Welfare Balance

ดึงข้อมูลยอดคงเหลือสวัสดิการของพนักงาน 1 คน ตามประเภทสวัสดิการและปี แสดงยอดยกมา วงเงิน ยอดใช้ไป และยอดคงเหลือ

Endpoint

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

Request Body

ParameterTypeRequiredDescriptionExample
employee_codestringYesรหัสพนักงาน"EMP001"
salary_type_idstring (base64)Yesรหัสประเภทสวัสดิการ"MjAyNjAzMDNTVFlQWDAwMDE="
yearstringYesปีที่ต้องการดูยอด (YYYY)"2026"

Request Body Example

{ "employee_code": "EMP001", "salary_type_id": "MjAyNjAzMDNTVFlQWDAwMDE=", "year": "2026" }

Response Format

Success Response (HTTP 200)

{ "code": 200, "message": "ดึงข้อมูลสำเร็จ", "payload": { "welfare_employee_id": "20260303WEMP00001", "employee_id": "20260309462FEF65EFCA", "salary_type_id": "20260303STYP00001", "welfare_year": "2026", "welfare_prev_amt": "5000.00", "welfare_quota_amt": "20000.00", "used_welfare_amt": "8000.00", "balance_welfare_amt": "17000.00", "salary_type_name": "สวัสดิการรักษาพยาบาล", "salary_type_name_en": "Medical Welfare" } }

Response Fields

FieldTypeDescription
welfare_employee_idstringรหัส Welfare Employee Config
employee_idstringรหัสพนักงาน
salary_type_idstringรหัสประเภทสวัสดิการ
welfare_yearstringปีสวัสดิการ
welfare_prev_amtstringยอดยกมาจากปีก่อน
welfare_quota_amtstringวงเงินสวัสดิการปีนี้
used_welfare_amtstringยอดที่ใช้ไปแล้ว
balance_welfare_amtstringยอดคงเหลือ (= prev + quota - used)
salary_type_namestringชื่อประเภทสวัสดิการ (TH)
salary_type_name_enstringชื่อประเภทสวัสดิการ (EN)

Error Response - Validation Failed (HTTP 422)

{ "code": 422, "message": "Validation failed", "errors": [ "Missing required parameter: salary_type_id" ] }

Error Response - Server Error (HTTP 400)

{ "code": 400, "message": "Internal server error" }

Code Examples

curl -X POST "https://openapi.humansoft.co.th/api/v1/open-apis/welfare/list_balance" \ -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "employee_code": "EMP001", "salary_type_id": "MjAyNjAzMDNTVFlQWDAwMDE=", "year": "2026" }'

Notes

ข้อควรทราบ:

  • salary_type_id ใน request ต้องเข้ารหัส Base64
  • ID ทั้งหมดใน response เป็น plain text
  • balance_welfare_amt = welfare_prev_amt + welfare_quota_amt - used_welfare_amt
  • used_welfare_amt คำนวณจากยอดที่ได้รับการอนุมัติแล้วเท่านั้น
  • ถ้าไม่มีข้อมูลสวัสดิการสำหรับปีนั้น payload จะเป็น []
  • Search Employee Balance - ดูยอดคงเหลือทุกประเภทสวัสดิการของพนักงาน
  • List Welfare Types - ดูประเภทสวัสดิการพร้อมยอดใช้ไป
  • Submit Welfare Document - สร้างเอกสารหลังตรวจสอบยอดแล้ว
Last updated on