Get Employee Loan Detail

ดึงข้อมูลเงินกู้/ภาระหนี้สินรายการเดียวของพนักงาน พร้อมรายละเอียดงวดผ่อนทั้งหมด

ใช้ API นี้เพื่อดึงข้อมูลเงินกู้เชิงลึกของรายการเดียว รวมถึงยอดเงินต้น ดอกเบี้ย ยอดผ่อนต่องวด และสถานะของแต่ละงวด เหมาะสำหรับแสดงรายละเอียดเงินกู้ หรือตรวจสอบสถานะการชำระก่อนทำการแก้ไข

Endpoint


GET /api/v1/open-apis/employee-loans/get-detail

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

Request Parameters

Required Parameters

ส่งเป็น query parameter ต่อท้าย URL

Parameter	Type	Required	Description	Example
`employee_loan_id`	string	Yes	รหัสเงินกู้ (Base64)	`MjAyNjA3MDRBMUIyQzNENEU1RjY=`

employee_loan_id เป็นค่า Base64 จึงต้อง URL-encode ก่อนใส่ใน query string (เช่น = จะกลายเป็น %3D) ไลบรารีฝั่งไคลเอนต์ส่วนใหญ่ (URLSearchParams, requests, http_build_query) จะเข้ารหัสให้อัตโนมัติ

Response Format

Success Response (HTTP 200)

payload เป็น array ของผลลัพธ์ (ปกติมี 1 รายการ เนื่องจากค้นด้วย employee_loan_id เดียว) แต่ละรายการประกอบด้วย profile (ข้อมูลพนักงาน) และ loan[] (ข้อมูลเงินกู้ พร้อม period[] ตารางงวดผ่อนทั้งหมด)


{
  "code": 200,
  "message": "สำเร็จ",
  "payload": [
    {
      "profile": {
        "employee_id": "20260704112233AABBCC",
        "employee_code": "EMP001",
        "employee_name": "สมชาย",
        "employee_last_name": "ใจดี",
        "employee_nickname": "ชาย",
        "branch_name": "สำนักงานใหญ่",
        "department_name": "ฝ่ายบุคคล",
        "division_name": "งานบริหารบุคคล",
        "section_name": "งานสวัสดิการ",
        "position_name": "เจ้าหน้าที่บุคคล"
      },
      "loan": [
        {
          "employee_loan_id": "20260704A1B2C3D4E5F6",
          "salary_type_id": "MjAyNjAzMTY2RTZCQzg3NjQ4MDI=",
          "salary_type_name": "เงินกู้ยืมพนักงาน",
          "salary_type_name_en": "Employee Loan",
          "employee_loan_dt": "2026-07-04",
          "employee_loan_start": "2026-07",
          "employee_loan_type_lv": "01",
          "employee_loan_total": 10000,
          "employee_loan_down": 100,
          "employee_loan_amt": 9900,
          "employee_loan_interest": 0,
          "employee_loan_interest_type": "0",
          "employee_loan_amt_principle": 9900,
          "employee_loan_amt_interest": 0,
          "employee_loan_amt_period": 990,
          "employee_loan_period": 10,
          "employee_loan_pay_period": 990,
          "employee_loan_desc": "เงินกู้ยืมเพิ่งนำเข้า",
          "employee_loan_status": "N",
          "employee_loan_status_update": null,
          "employee_loan_status_remark": null,
          "period": [
            {
              "employee_loan_period_id": "20260704AAAA11112222",
              "employee_loan_period_month": "2026-07",
              "employee_loan_period_seq": 1,
              "employee_loan_period_principle": 990,
              "employee_loan_period_interest": 0,
              "employee_loan_period_amt": 990,
              "employee_loan_period_status": "N"
            },
            {
              "employee_loan_period_id": "20260804BBBB33334444",
              "employee_loan_period_month": "2026-08",
              "employee_loan_period_seq": 2,
              "employee_loan_period_principle": 990,
              "employee_loan_period_interest": 0,
              "employee_loan_period_amt": 990,
              "employee_loan_period_status": "N"
            }
          ]
        }
      ]
    }
  ]
}

loan[].salary_type_id ถูกส่งกลับมาในรูปแบบ Base64 อยู่แล้ว จึงสามารถนำค่าที่ได้ไปใช้เป็นพารามิเตอร์ salary_type_id ในคำขออื่นได้โดยตรง โดยไม่ต้องเข้ารหัสซ้ำ

Error Response - Forbidden (HTTP 403)


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

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

Error Response - Validation Failed (HTTP 422)


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

สาเหตุ: ไม่ได้ส่ง employee_loan_id

Error Response - Employee Loan Not Found (HTTP 404)


{
  "code": 404,
  "message": "ไม่พบข้อมูลเงินกู้"
}

สาเหตุ: employee_loan_id ที่ส่งมาไม่มีอยู่ในระบบ

Error Response - Invalid Request (HTTP 400)


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

สาเหตุ: เกิดข้อผิดพลาดอื่นที่ไม่ใช่การตรวจสอบพารามิเตอร์หรือไม่พบข้อมูล — ข้อความ message จะสะท้อนข้อผิดพลาดจริงที่เกิดขึ้น ณ ขณะนั้น ไม่ใช่ข้อความคงที่ตามตัวอย่างด้านบนเสมอไป

Response Fields

Profile Fields (`payload[].profile`)

Field	Type	Nullable	Description
`employee_id`	string	No	รหัสพนักงาน (Plain text)
`employee_code`	string	No	รหัสพนักงาน
`employee_name`	string	No	ชื่อพนักงาน
`employee_last_name`	string	No	นามสกุลพนักงาน
`employee_nickname`	string	No	ชื่อเล่น
`branch_name`	string	No	สาขา
`department_name`	string	No	แผนก
`division_name`	string	No	ฝ่าย
`section_name`	string	No	ส่วนงาน
`position_name`	string	No	ตำแหน่ง

Loan Fields (`payload[].loan[]`)

Field	Type	Nullable	Description
`employee_loan_id`	string	No	รหัสเงินกู้ (Plain text)
`salary_type_id`	string	No	รหัสประเภทเงินหักในสลิป (Base64 — ส่งกลับเป็นพารามิเตอร์ `salary_type_id` ได้โดยตรง)
`salary_type_name`	string	No	ชื่อประเภทเงินหัก
`salary_type_name_en`	string	No	ชื่อประเภทเงินหัก (ภาษาอังกฤษ)
`employee_loan_dt`	string	No	วันที่ยื่นกู้ (YYYY-MM-DD)
`employee_loan_start`	string	No	เดือนเริ่มหัก (YYYY-MM)
`employee_loan_type_lv`	string	No	ประเภทเงินกู้
`employee_loan_total`	float	No	ยอดกู้ทั้งหมด
`employee_loan_down`	float	No	ยอดหักครั้งแรก (เงินดาวน์)
`employee_loan_amt`	float	No	ยอดกู้สุทธิ
`employee_loan_interest`	float	No	ยอดดอกเบี้ย
`employee_loan_interest_type`	string	No	ประเภทดอกเบี้ย (`0` = ต้นลดดอกลด, `1` = คงที่, `2` = ระบุดอกเบี้ยรวม)
`employee_loan_amt_principle`	float	No	ยอดเงินต้นรวม
`employee_loan_amt_interest`	float	No	ยอดดอกเบี้ยรวม
`employee_loan_amt_period`	float	No	ยอดผ่อนต่องวด
`employee_loan_period`	int	No	จำนวนงวด
`employee_loan_pay_period`	float	No	ยอดที่ชำระต่องวด
`employee_loan_desc`	string	Yes	รายละเอียดเงินกู้
`employee_loan_status`	string	No	สถานะเงินกู้ (`N` = Active, `C` = Cancel, `Y` = Finished)
`employee_loan_status_update`	string	Yes	วันเวลาที่เปลี่ยนสถานะล่าสุด
`employee_loan_status_remark`	string	Yes	หมายเหตุการเปลี่ยนสถานะ

Period Fields (`payload[].loan[].period[]`)

Field	Type	Nullable	Description
`employee_loan_period_id`	string	No	รหัสงวดผ่อน (Plain text)
`employee_loan_period_month`	string	No	เดือนของงวด (YYYY-MM)
`employee_loan_period_seq`	int	No	ลำดับงวด
`employee_loan_period_principle`	float	No	เงินต้นของงวด
`employee_loan_period_interest`	float	No	ดอกเบี้ยของงวด
`employee_loan_period_amt`	float	No	ยอดชำระของงวด
`employee_loan_period_status`	string	No	สถานะงวด (`N` = ยังไม่ชำระ (Pending), `Y` = ชำระแล้ว (Paid))

Code Examples

cURL


# employee_loan_id เป็น Base64 → ต้อง URL-encode ใน query string (เช่น '=' → %3D)
curl -X GET "https://openapi.humansoft.co.th/api/v1/open-apis/employee-loans/get-detail?employee_loan_id=MjAyNjA3MDRBMUIyQzNENEU1RjY%3D" \
  -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY"

JavaScript


const params = new URLSearchParams({
  employee_loan_id: 'MjAyNjA3MDRBMUIyQzNENEU1RjY='
})
 
const response = await fetch(
  `https://openapi.humansoft.co.th/api/v1/open-apis/employee-loans/get-detail?${params}`,
  {
    method: 'GET',
    headers: {
      'Ocp-Apim-Subscription-Key': 'YOUR_API_KEY'
    }
  }
)
 
const data = await response.json()
 
if (data.code === 200) {
  const loan = data.payload[0].loan[0]
  console.log('ยอดกู้สุทธิ:', loan.employee_loan_amt)
  console.log('สถานะ:', loan.employee_loan_status)
  console.log('จำนวนงวด:', loan.period.length)
} else {
  console.error('Error:', data.errors || data.message)
}

Python


import requests
 
url = "https://openapi.humansoft.co.th/api/v1/open-apis/employee-loans/get-detail"
headers = {
    "Ocp-Apim-Subscription-Key": "YOUR_API_KEY"
}
params = {
    "employee_loan_id": "MjAyNjA3MDRBMUIyQzNENEU1RjY="
}
 
response = requests.get(url, headers=headers, params=params)
data = response.json()
 
if data['code'] == 200:
    loan = data['payload'][0]['loan'][0]
    print('ยอดกู้สุทธิ:', loan['employee_loan_amt'])
    print('สถานะ:', loan['employee_loan_status'])
    print('จำนวนงวด:', len(loan['period']))
else:
    print('Error:', data.get('errors') or data.get('message'))

PHP


<?php
$params = http_build_query([
    "employee_loan_id" => "MjAyNjA3MDRBMUIyQzNENEU1RjY="
]);
 
$url = "https://openapi.humansoft.co.th/api/v1/open-apis/employee-loans/get-detail?" . $params;
 
$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);
 
if ($data['code'] === 200) {
    $loan = $data['payload'][0]['loan'][0];
    echo "ยอดกู้สุทธิ: " . $loan['employee_loan_amt'] . "\n";
    echo "สถานะ: " . $loan['employee_loan_status'] . "\n";
    echo "จำนวนงวด: " . count($loan['period']);
} else {
    echo "Error: " . ($data['errors'][0] ?? $data['message']);
}
 
curl_close($ch);
?>

Validation Rules

Parameter	Validation	Error Message
`employee_loan_id`	ต้องระบุ และเข้ารหัสเป็น Base64	`'employee_loan_id' is required`
`employee_loan_id`	ต้องมีอยู่ในระบบ	คืน HTTP 404 `ไม่พบข้อมูลเงินกู้`

Employee Loans Overview - ภาพรวมโมดูลเงินกู้พนักงาน
Get Employee Loan List - ดึงรายการเงินกู้ของพนักงาน
Update Employee Loan - แก้ไขข้อมูลเงินกู้
Create Employee Loan - สร้างเงินกู้ใหม่