Remove Employee Loan

ลบเงินกู้ของพนักงานออกจากระบบ รวมถึงตารางงวดผ่อนทั้งหมดที่เกี่ยวข้อง

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

Endpoint


POST /api/v1/open-apis/employee-loans/remove

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

Request Parameters

Required Parameters

Parameter	Type	Required	Description	Example
`employee_loan_id`	string	Yes	รหัสเงินกู้ที่ต้องการลบ (Base64)	`MjAyNjA3MDRBMUIyQzNENEU1RjY=`

Optional Parameters

Parameter	Type	Default	Description	Example
`authorize_id`	string	`''`	ID ผู้ทำรายการ (Base64) — ถ้าส่งมา ต้องเป็น user ที่มีอยู่จริง มิฉะนั้นได้ 422	`MjAyNjA3MDRVU0VSMDAwMDAx`

หา authorize_id ได้อย่างไร: รับค่าจาก Get Employee Data Filter โดยใช้ path_action=get-user พร้อม employee_code ของผู้ทำรายการ — ใช้ค่า user_id ที่ได้กลับมาเป็น authorize_id

Request Body Example


{
  "employee_loan_id": "MjAyNjA3MDRBMUIyQzNENEU1RjY="
}

Response Format

Success Response (HTTP 200)

payload คืนเฉพาะ employee_loan_id ที่ถูกลบเท่านั้น (รูปแบบ Plain text) — ไม่มี timestamp หรือจำนวนงวดที่ลบแนบมาด้วย


{
  "code": 200,
  "message": "ลบข้อมูลเงินกู้สำเร็จ",
  "payload": {
    "employee_loan_id": "20260704A1B2C3D4E5F6"
  }
}

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, หรือ authorize_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

Field	Type	Nullable	Description
`employee_loan_id`	string	No	รหัสเงินกู้ที่ถูกลบ (Plain text)

Code Examples

cURL


curl -X POST "https://openapi.humansoft.co.th/api/v1/open-apis/employee-loans/remove" \
  -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "employee_loan_id": "MjAyNjA3MDRBMUIyQzNENEU1RjY="
  }'

JavaScript


const response = await fetch(
  'https://openapi.humansoft.co.th/api/v1/open-apis/employee-loans/remove',
  {
    method: 'POST',
    headers: {
      'Ocp-Apim-Subscription-Key': 'YOUR_API_KEY',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      employee_loan_id: 'MjAyNjA3MDRBMUIyQzNENEU1RjY='
    })
  }
)
 
const data = await response.json()
 
if (data.code === 200) {
  console.log('ลบข้อมูลเงินกู้สำเร็จ:', data.payload.employee_loan_id)
} else {
  console.error('Error:', data.errors || data.message)
}

Python


import requests
 
url = "https://openapi.humansoft.co.th/api/v1/open-apis/employee-loans/remove"
headers = {
    "Ocp-Apim-Subscription-Key": "YOUR_API_KEY",
    "Content-Type": "application/json"
}
payload = {
    "employee_loan_id": "MjAyNjA3MDRBMUIyQzNENEU1RjY="
}
 
response = requests.post(url, headers=headers, json=payload)
data = response.json()
 
if data['code'] == 200:
    print('ลบข้อมูลเงินกู้สำเร็จ:', data['payload']['employee_loan_id'])
else:
    print('Error:', data.get('errors') or data.get('message'))

PHP


<?php
$url = "https://openapi.humansoft.co.th/api/v1/open-apis/employee-loans/remove";
 
$headers = [
    "Ocp-Apim-Subscription-Key: YOUR_API_KEY",
    "Content-Type: application/json"
];
 
$payload = [
    "employee_loan_id" => "MjAyNjA3MDRBMUIyQzNENEU1RjY="
];
 
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
 
$response = curl_exec($ch);
$data = json_decode($response, true);
 
if ($data['code'] === 200) {
    echo "ลบข้อมูลเงินกู้สำเร็จ: " . $data['payload']['employee_loan_id'];
} 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)
`authorize_id`	optional — หากส่งมาต้องเป็น user ที่มีอยู่จริง	`'authorize_id' is invalid or does not exist` (HTTP 422)

Business Rules

การลบเงินกู้เป็นการกระทำที่ไม่สามารถย้อนกลับได้ — โปรดตรวจสอบก่อนดำเนินการ:

การลบไม่สามารถกู้คืนได้ เมื่อลบแล้วข้อมูลจะไม่สามารถเรียกกลับมาได้
ตารางงวดผ่อนทั้งหมดที่เกี่ยวข้องกับเงินกู้นี้จะถูกลบไปพร้อมกัน
ควรดึงข้อมูลเงินกู้ออกมาสำรองไว้ก่อนลบ หากต้องอ้างอิงในภายหลัง
หากต้องการเพียงหยุดการหักเงินชั่วคราว แนะนำให้ใช้ Close Employee Loan แทน ซึ่งจะเก็บข้อมูลไว้และเปิดใช้งานอีกครั้งได้ด้วย Resume Employee Loan

Get Loan List - ตรวจสอบรายการเงินกู้ก่อนลบ
Get Loan Detail - ดูรายละเอียดเงินกู้ก่อนลบ
Close Employee Loan - ปิดเงินกู้ชั่วคราว (ทางเลือกแทนการลบ)
Resume Employee Loan - เปิดใช้งานเงินกู้ที่ปิดไปแล้วอีกครั้ง