Get Employee Loan Types

ดึงรายการประเภทเงินหัก (Salary Type) ที่ใช้เป็นเงินกู้/ภาระหนี้สินของพนักงาน

ใช้ API นี้เพื่อดึงรายการประเภทเงินหักแบบเงินกู้ทั้งหมดของบริษัท (salary type ที่มี salary_cal_type_lv = "Loan") ค่า salary_type_id ที่ได้จะนำไปใช้เป็นพารามิเตอร์ตอนสร้างเงินกู้ผ่าน Create Employee Loan

Endpoint


GET /api/v1/open-apis/employee-loans/get-loan-type

สิทธิ์ที่ต้องการ: API Key ต้องมีสิทธิ์ ข้อมูลการยื่นเอกสาร (document:manage)

Request Parameters

API นี้ไม่รับพารามิเตอร์ใด ๆ เป็นการเรียกแบบ GET ที่ส่งเฉพาะ Header สำหรับ API Key เท่านั้น (ไม่ต้องส่ง query string หรือ request body) ระบบจะคืนรายการประเภทเงินกู้ทั้งหมดของบริษัทตามสิทธิ์ของ API Key

Response Format

Success Response (HTTP 200)

payload เป็น array ของประเภทเงินกู้ โดยแต่ละ item คือ 1 salary type ที่เป็นเงินกู้ เรียงตามลำดับการแสดงผลที่กำหนดในระบบ


{
  "code": 200,
  "message": "สำเร็จ",
  "payload": [
    {
      "salary_type_id": "202603166E6BC8764802",
      "salary_type_code": "L01",
      "salary_type_name": "เงินกู้สวัสดิการ",
      "salary_type_name_en": "Welfare Loan",
      "salary_cal_type_lv": "Loan"
    },
    {
      "salary_type_id": "202603166E6BC8764803",
      "salary_type_code": "L02",
      "salary_type_name": "เงินกู้ฉุกเฉิน",
      "salary_type_name_en": "Emergency Loan",
      "salary_cal_type_lv": "Loan"
    }
  ]
}

salary_type_id ที่คืนมาจาก endpoint นี้เป็น Plain text ต้องเข้ารหัสเป็น Base64 ก่อนนำไปส่งเป็นพารามิเตอร์ salary_type_id ใน Create Employee Loan เช่น 202603166E6BC8764802 → MjAyNjAzMTY2RTZCQzg3NjQ4MDI=

Error Response - Forbidden (HTTP 403)


{
  "code": 403,
  "message": "Forbidden: Insufficient permissions",
  "error": {
    "type": "PERMISSION_DENIED"
  }
}

สาเหตุ: API Key ไม่มีสิทธิ์ document:manage

Error Response - Bad Request (HTTP 400)


{
  "code": 400,
  "message": "ล้มเหลว"
}

สาเหตุ: เกิดข้อผิดพลาดระหว่างดึงข้อมูล ค่า message จะสะท้อนสาเหตุจริงของข้อผิดพลาด (ไม่ใช่ข้อความคงที่)

Response Fields

payload เป็น array โดยแต่ละ item เป็นข้อมูลประเภทเงินหัก (ฟิลด์ภายในระบบถูกตัดออกแล้ว) ฟิลด์หลักที่ใช้อ้างอิงมีดังนี้

Field	Type	Nullable	Description
`salary_type_id`	string	No	รหัสประเภทเงินหัก (Plain text) — ต้องเข้ารหัส Base64 ก่อนนำไปส่งเป็น `salary_type_id` ใน Create Employee Loan
`salary_type_code`	string	No	รหัสย่อประเภทเงินหัก
`salary_type_name`	string	No	ชื่อประเภทเงินหัก (ไทย)
`salary_type_name_en`	string	No	ชื่อประเภทเงินหัก (อังกฤษ)
`salary_cal_type_lv`	string	No	ระดับการคำนวณ — จะเป็น `Loan` เสมอสำหรับ endpoint นี้

Code Examples

cURL


curl -X GET "https://openapi.humansoft.co.th/api/v1/open-apis/employee-loans/get-loan-type" \
  -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY"

JavaScript


const response = await fetch(
  'https://openapi.humansoft.co.th/api/v1/open-apis/employee-loans/get-loan-type',
  {
    method: 'GET',
    headers: {
      'Ocp-Apim-Subscription-Key': 'YOUR_API_KEY'
    }
  }
)
 
const data = await response.json()
 
// แสดงรายการประเภทเงินกู้
data.payload.forEach(type => {
  console.log(`${type.salary_type_code} - ${type.salary_type_name} (${type.salary_type_id})`)
})

Python


import requests
 
url = "https://openapi.humansoft.co.th/api/v1/open-apis/employee-loans/get-loan-type"
headers = {
    "Ocp-Apim-Subscription-Key": "YOUR_API_KEY"
}
 
response = requests.get(url, headers=headers)
data = response.json()
 
# แสดงรายการประเภทเงินกู้
for loan_type in data['payload']:
    print(f"{loan_type['salary_type_code']} - {loan_type['salary_type_name']} ({loan_type['salary_type_id']})")

PHP


<?php
$url = "https://openapi.humansoft.co.th/api/v1/open-apis/employee-loans/get-loan-type";
 
$headers = [
    "Ocp-Apim-Subscription-Key: YOUR_API_KEY",
];
 
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
 
$response = curl_exec($ch);
$data = json_decode($response, true);
 
// แสดงรายการประเภทเงินกู้
foreach ($data['payload'] as $loanType) {
    echo "{$loanType['salary_type_code']} - {$loanType['salary_type_name']} ({$loanType['salary_type_id']})\n";
}
 
curl_close($ch);
?>

Notes

Use Cases

เตรียมข้อมูลก่อนสร้างเงินกู้ - เรียก endpoint นี้เพื่อดูประเภทเงินกู้ที่บริษัทเปิดใช้งาน แล้วเลือก salary_type_id ที่ต้องการ (เข้ารหัส Base64) ไปใช้ตอนสร้างเงินกู้
แสดงตัวเลือกให้ผู้ใช้ - นำ salary_type_code และ salary_type_name ไปแสดงเป็นตัวเลือกในฟอร์มสร้างเงินกู้

Employee Loans Overview - ภาพรวมโมดูลจัดการเงินกู้พนักงาน
Create Employee Loan - สร้างเงินกู้โดยใช้ salary_type_id ที่ได้จาก endpoint นี้ (เข้ารหัส Base64)
Get Employee Loan List - ดึงรายการเงินกู้ของพนักงาน