Report API Module
ภาพรวม (Overview)
โมดูล Report เป็น API สำหรับการออกรายงานด้านภาษีของพนักงาน ครอบคลุมรายงานภาษีหัก ณ ที่จ่าย (ภงด.3) รายงานภาษีประจำเดือน (ภงด.1) รายงานภาษีประจำปี (ภงด.1ก) และหนังสือรับรองภาษีรายบุคคล (50ทวิ/ภงด.91)
โครงสร้าง API
API ในโมดูล Report ส่วนใหญ่ใช้ path_action เป็น parameter เพื่อระบุประเภทรายงาน และรองรับ output หลายรูปแบบ (JSON, Excel, PDF, Text)
| Operation | Endpoint | Method |
|---|---|---|
| ออกรายงาน | /api/v1/open-apis/report/{action} | POST |
Sub-modules
NVAT (ภาษีหัก ณ ที่จ่าย — ภงด.3)
ออกรายงานภาษีหัก ณ ที่จ่ายประจำเดือน ภงด.3 และจัดการข้อมูลภาษีรายบุคคล
API Endpoints:
| Endpoint | รายละเอียด |
|---|---|
| NVAT Month | ดึงรายงานภาษีหัก ณ ที่จ่ายประจำเดือน (ภงด.3) |
| Delete Person Tax NVAT | ลบข้อมูลภาษีหัก ณ ที่จ่ายรายบุคคล |
Tax Month (ภาษีประจำเดือน — ภงด.1)
ออกรายงานภาษีหัก ณ ที่จ่ายประจำเดือน ภงด.1 ทั้งรูปแบบฟอร์มและรายละเอียดการตรวจสอบ
API Endpoints:
| Endpoint | รายละเอียด |
|---|---|
| Tax Month | รายงานภาษีประจำเดือน (ภงด.1 Form) |
| Tax Month Audit | รายละเอียดการตรวจสอบภาษีประจำเดือน |
Tax Year (ภาษีประจำปี — ภงด.1ก)
ออกรายงานภาษีประจำปี ภงด.1ก รองรับทั้งรูปแบบฟอร์มสรุปประจำปีและรูปแบบ Matrix สำหรับการตรวจสอบ
API Endpoints:
| Endpoint | รายละเอียด |
|---|---|
| Tax Year | รายงานภาษีประจำปี (ภงด.1ก Annual) |
| Tax Audit | ตรวจสอบภาษีประจำปีแบบ Matrix |
Personal Tax (50ทวิ / ภงด.91)
ออกหนังสือรับรองภาษีหัก ณ ที่จ่ายรายบุคคล (50ทวิ/ภงด.91) และใบแนบ ภงด.91
API Endpoints:
| Endpoint | รายละเอียด |
|---|---|
| Tax 91 | หนังสือรับรองภาษีรายบุคคล 50ทวิ/ภงด.91 |
| Attachment PND91 | ใบแนบ ภงด.91 |
Standard Response Format
Success Response
{
"code": 200,
"message": "สำเร็จ",
"payload": [ ... ]
}Error Response
{
"code": 400,
"message": "ไม่สำเร็จ",
"errors": ["กรุณาระบุ 'path_action'"]
}Common Parameters
Output Format
API ส่วนใหญ่รองรับ output หลายรูปแบบผ่าน parameter output_type:
| Value | Description |
|---|---|
json | ข้อมูลในรูปแบบ JSON |
excel | ไฟล์ Excel (Base64) |
pdf1, pdf2, pdf3 | ไฟล์ PDF รูปแบบต่างๆ (Base64) |
text1, text2 | ไฟล์ Text รูปแบบต่างๆ |
Era Format
API บางตัว (เช่น Tax 91, Tax Year) รองรับการแสดงปีแบบ พ.ศ. ผ่าน parameter era_format:
| Value | Description |
|---|---|
BE | พุทธศักราช (Buddhist Era) |
AD | คริสตศักราช (Anno Domini) — ค่าเริ่มต้น |
Parameter ที่ลงท้ายด้วย _id ใน Request ต้องเข้ารหัส Base64 เสมอ แต่ใน Response จะเป็น plain text 20 ตัวอักษร