Skip to Content
🚀 Welcome to Humansoft Open API Documentation

Get Salary Certificate List

ดึงรายการเอกสารหนังสือรับรองเงินเดือน พร้อมตัวกรองโครงสร้างองค์กร สายการอนุมัติ และการแบ่งหน้า

ใช้ API นี้เพื่อดึงรายการเอกสารหนังสือรับรองเงินเดือนทั้งหมด รองรับการกรองตามหลายเงื่อนไข ผลลัพธ์จัดกลุ่มตามพนักงาน เหมาะสำหรับแสดงผลบน Dashboard หรือ Mobile App

Endpoint

GET /api/v1/open-apis/salary-certificate/get-list POST /api/v1/open-apis/salary-certificate/get-list

Request Body

Required Parameters

ParameterTypeRequiredDescriptionExample
document_flow_lvstringYesสถานะเอกสาร"01"
req_yearstringYesปีที่ขอเอกสาร (YYYY)"2026"

Optional Parameters

ParameterTypeRequiredDescriptionExample
req_monthstringNoเดือนที่ขอเอกสาร (MM)"03"
from_dtstringNoวันที่เริ่มต้นช่วงกรอง (YYYY-MM-DD)"2026-01-01"
to_dtstringNoวันที่สิ้นสุดช่วงกรอง (YYYY-MM-DD)"2026-03-31"
authorize_linebooleanNoเปิดกรองตามสายการอนุมัติtrue
platformstringNoระบุ platform"web-hrs"
hashtagsarrayNoกรองตาม hashtag["งานขาย", "IT"]
employee_listsarrayNoกรองตามพนักงาน (array ของ {id} base64)ดูตัวอย่าง
company_listsarrayNoกรองตามบริษัท (array ของ {id} base64)ดูตัวอย่าง
branch_listsarrayNoกรองตามสาขา (array ของ {id} base64)ดูตัวอย่าง
department_listsarrayNoกรองตามแผนก (array ของ {id} base64)ดูตัวอย่าง
division_listsarrayNoกรองตามฝ่าย (array ของ {id} base64)ดูตัวอย่าง
section_listsarrayNoกรองตามแผนกย่อย (array ของ {id} base64)ดูตัวอย่าง
position_listsarrayNoกรองตามตำแหน่ง (array ของ {id} base64)ดูตัวอย่าง
_PAGEintegerNoหน้าปัจจุบัน ค่าเริ่มต้น 11
_NUMBER_PER_PAGEintegerNoจำนวนรายการต่อหน้า (1-1000)20

List Parameter Format

ทุก *_lists parameter ต้องเป็น array ของ object ที่มี id เป็น Base64 encoded:

[ {"id": "MjAyNjAzMDk0NjI1RUY2NUVGQ0E="}, {"id": "MjAyNjAzMDk0NjI1RUY2NUVGQ0I="} ]

Option Values: document_flow_lv

ValueDescription (TH)Description (EN)Filter Includes
01รออนุมัติPending Approvalรวม 01, 06, 07-11
02อนุมัติแล้วApprovedเฉพาะ 02
03ไม่อนุมัติNot Approvedเฉพาะ 03
04ส่งเอกสารแล้วSent Documentเฉพาะ 04
05ได้รับเอกสารแล้วReceive Documentเฉพาะ 05
07หัวหน้าอนุมัติManager Approvedรวม 07-11

เมื่อกรองด้วย 01 ระบบจะรวมสถานะ 01, 06, 07-11 (ทุกสถานะที่ยังไม่ผ่านการอนุมัติขั้นสุดท้าย)

Response Format

Success Response (HTTP 200)

{ "code": 200, "message": "สำเร็จ", "payload": [ { "profile": { "employee_id": "20260309462FEF65EFCA", "employee_code": "EMP001", "photograph": "images/userPlaceHolder.png", "employee_name": "ธาวัน", "employee_last_name": "รายเดือน", "employee_nickname": "วัน", "position_name": "นักพัฒนาระบบ", "department_name": "ฝ่ายไอที", "division_name": "", "section_name": "", "branch_name": "สำนักงานใหญ่", "count_docs": 2 }, "docs": [ { "doc_type": "Salary_Certificate", "doc_id": "20260305IMP00000001", "employee_id": "20260309462FEF65EFCA", "approve_by": "สมชาย ผู้จัดการ", "header": "ขอหนังสือรับรองเงินเดือน", "detail": "เพื่อใช้ยื่นกู้สินเชื่อธนาคาร", "status_detail": "รออนุมัติ", "status": "รออนุมัติ", "authorize_flag": true, "created": "2026-03-09 11:00:00", "created_format": "09/03/2026 11:00", "send_doc_address": "ธนาคารกสิกรไทย สาขาสยาม", "document_flow_lv": "01", "doc_approver_name": null } ] } ], "_PAGINATION": { "_TOTAL_RECORDS": 5, "_PAGE": 1, "_NUMBER_PER_PAGE": 20 } }

Empty Result Response (HTTP 200)

{ "code": 200, "message": "สำเร็จ", "payload": [], "_PAGINATION": { "_TOTAL_RECORDS": 0, "_PAGE": 1, "_NUMBER_PER_PAGE": 0 } }

Error Response - Validation Failed (HTTP 400)

{ "code": 400, "message": "การตรวจสอบข้อมูลล้มเหลว", "errors": [ "'document_flow_lv' is required", "'req_year' is required" ] }

Response Fields

Profile (โปรไฟล์พนักงาน)

FieldTypeDescription
employee_idstringรหัสพนักงาน (20 ตัวอักษร, plain text)
employee_codestringรหัสพนักงาน
photographstringURL รูปภาพ
employee_namestringชื่อพนักงาน
employee_last_namestringนามสกุลพนักงาน
employee_nicknamestringชื่อเล่น
position_namestringตำแหน่ง
department_namestringแผนก
division_namestring | nullฝ่าย
section_namestring | nullแผนกย่อย
branch_namestringสาขา
count_docsintegerจำนวนเอกสาร

Docs (รายการเอกสาร)

FieldTypeDescription
doc_typestringประเภทเอกสาร ("Salary_Certificate")
doc_idstringรหัสเอกสาร (20 ตัวอักษร, plain text)
employee_idstringรหัสพนักงาน
approve_bystring | nullชื่อผู้อนุมัติ
headerstringหัวข้อเอกสาร
detailstringรายละเอียดเอกสาร
status_detailstringรายละเอียดสถานะ
statusstringชื่อสถานะเอกสาร
authorize_flagbooleanสิทธิ์อนุมัติตามสายงาน
createdstringวันเวลาสร้าง (YYYY-MM-DD HH:mm:ss)
created_formatstringวันเวลาสร้าง format (DD/MM/YYYY HH:mm)
send_doc_addressstring | nullที่อยู่จัดส่ง
document_flow_lvstringสถานะเอกสาร (จัดกลุ่มแล้ว)
doc_approver_namestring | nullชื่อผู้อนุมัติเอกสาร

Pagination

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

Code Examples

curl -X GET "https://openapi.humansoft.co.th/api/v1/open-apis/salary-certificate/get-list?document_flow_lv=01&req_year=2026&_PAGE=1&_NUMBER_PER_PAGE=20" \ -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \ -H "Content-Type: application/json"

Notes

ข้อควรทราบ:

  • ฟิลด์ _id ใน response เป็น plain text 20 ตัวอักษร
  • ฟิลด์ _id ใน request (เช่น employee_lists, company_lists) ต้องเข้ารหัส Base64
  • document_flow_lv ใน response จะถูกจัดกลุ่ม: สถานะ 01, 06, 07-11 แสดงเป็น 01
  • ผลลัพธ์จัดกลุ่มตามพนักงาน แต่ละพนักงานมี profile และ docs array
  • ถ้าไม่มีสิทธิ์ดูเงินเดือน เงินเดือนจะแสดงเป็น "XXXX"
  • from_dt และ to_dt มีลำดับความสำคัญสูงกว่า req_year / req_month
  • Get Detail - ดูรายละเอียดเอกสาร
  • Submit - สร้างเอกสารใหม่
  • Approve - อนุมัติเอกสาร
  • Delete - ลบเอกสาร
  • Export PDF - สร้าง PDF ของเอกสาร
Last updated on