Skip to Content
🚀 Welcome to Humansoft Open API Documentation
DocumentationAPI ReferenceReport (รายงาน)NVAT (ภงด.3)NVAT Month (ภงด.3 รายเดือน)

NVAT Month Report (ภงด.3)

ดึงรายงานภาษีเงินได้หัก ณ ที่จ่าย ประจำเดือน (ภงด.3) ตามงวดเดือนที่ระบุ ผลลัพธ์จัดเรียงตามบริษัท สาขา แผนก และสามารถส่งออกได้หลายรูปแบบ ทั้ง JSON, Excel, PDF และ Text

Endpoint

POST /api/v1/open-apis/report/nvat-month?path_action=nvat_month

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

Request Parameters

Required Parameters

ParameterTypeRequiredDescriptionExample
authorize_idstringYesรหัสผู้เรียก API"EMP001"
year_monthstringYesงวดเดือนที่ขอรายงาน (YYYY-MM)"2026-03"

Optional Parameters — Output/Export

ParameterTypeDefaultDescriptionExample
typestringjsonรูปแบบผลลัพธ์: json, excel, pdf1, pdf2, pdf3, text1"json"
filenamestring-ชื่อไฟล์ที่ส่งออก (ใช้กับ excel, pdf*, text*)"รายงานภาษี ณ ที่จ่าย 03-2026"
sign_datestring-วันที่ลงนาม/ออกเอกสาร (YYYY-MM-DD) ใช้กับ pdf3"2026-03-31"
employee_groupstring-ใช้กรองใน text1"01"

Optional Parameters — Filter

ParameterTypeDescriptionExample
company_listsarrayกรองตามบริษัท (id เป็น base64)[{"id":"MjAyNTExMjdENDU3M0M0MjE2Mzk="}]
branch_listsarrayกรองตามสาขา (id เป็น base64)[{"id":"MjAyNTExMjdENDU3M0M0MjE2Mzk="}]
employee_listsarrayกรองพนักงานรายบุคคล (id เป็น base64)[{"id":"MjAyNTExMjdENDU3M0M0MjE2Mzk="}]
lists_flagstringFULL = กรองเฉพาะงวดเต็ม"FULL"
payment_methodstringกรองตามวิธีการจ่ายเงิน"01"
employee_type_grouparrayกลุ่มประเภทพนักงาน (array ของ base64 string)["MjAyNTExMjdENDU3M0M0MjE2Mzk="]
employee_type_codearrayรหัสประเภทพนักงาน (plain string)["01"]
  • ทุก ID ใน company_lists, branch_lists, employee_lists ต้อง encode เป็น base64 ก่อนส่ง
  • employee_type_group เป็น array ของ base64 string โดยตรง (ไม่ใช่ array of object)

branch_lists — โหมดการกรองตามสาขา

จำนวนสาขาพฤติกรรม
ไม่ระบุ / ว่างเปล่าใช้ company_id จากบริษัทที่ resolve ได้ — ไม่กรองตามสาขา
1 สาขาดึง company_id และ branch_id จริงจาก master สาขา (โหมดสาขาเดี่ยว)
มากกว่า 1 สาขาใช้ company_id ระดับบริษัท + branchList สำหรับ query multi-branch

employee_type_group + employee_type_code — Logic การกรอง 3 กรณี

กรณีเงื่อนไขผลลัพธ์
กลุ่ม + รหัสมีทั้งสองอย่างmerge แถวจากกลุ่ม + ต่อด้วยแถวที่ตรง employee_type_code
รหัสอย่างเดียวมีเฉพาะ employee_type_codeกรองเฉพาะแถวที่ตรง employee_type_code
กลุ่มอย่างเดียวมีเฉพาะ employee_type_groupดึง master employee ของงวดนั้น แล้วกรองตาม employee_type_group_id

text1 — เงื่อนไข Filter เพิ่มเติม

เมื่อใช้ type = text1 ระบบจะกรองพนักงานที่:

  • summary_before_rate > 0 (มีเงินได้ก่อนหักภาษี)
  • AND reference_code_1 = employee_group (parameter ที่ส่งมา)

ค่า type — รูปแบบผลลัพธ์

ค่าความหมายMIME Type
jsonข้อมูลตาราง JSONapplication/json
excelไฟล์ Excel รูปแบบ ภงด.3application/vnd.ms-excel
pdf1PDF แบบฟอร์ม ภงด.3 หน้า 1+2application/pdf
pdf2PDF ใบแนบ ภงด.3 (รายชื่อ)application/pdf
pdf3PDF 50ทวิ รายบุคคล (ใช้ร่วมกับ sign_date)application/pdf
text1ไฟล์ Text รูปแบบสรรพากร (ใช้ร่วมกับ employee_group)text/plain

Example Request Body

{ "authorize_id": "EMP001", "year_month": "2026-03", "type": "json", "branch_lists": [ {"id": "MjAyNTExMjdENDU3M0M0MjE2Mzk="} ], "lists_flag": "FULL" }

Response Format

Success Response (JSON type)

{ "code": "200", "message": "Success", "payload": { "column": [ "ลำดับ", "เลขประจำตัวประชาชน", "หนังสือเดินทาง/ใบอนุญาตทำงาน", "ชื่อ-นามสกุล", "วัน/เดือน/ปี", "เงินได้", "ภาษีที่หัก" ], "row": [ [ { "value": 1, "colspan": 1, "align": "center" }, { "value": "1234567890123", "colspan": 1, "align": "center" }, { "value": "", "colspan": 1, "align": "center" }, { "value": "นายสมชาย ใจดี", "colspan": 1, "align": "left" }, { "value": "31/03/2026", "colspan": 1, "align": "center" }, { "value": "25,000.00", "colspan": 1, "align": "right" }, { "value": "1,250.00", "colspan": 1, "align": "right" }, { "value": "emp_id_here", "colspan": 1, "align": "center", "extra": { "employee_id": "emp_id_here", "tax_month_code": "03", "tax_year_code": "2026", "xtra_slip_lists": [] } } ] ], "footer": [ { "value": "รวม", "colspan": 5, "align": "center" }, { "value": "25,000.00", "colspan": 1, "align": "right" }, { "value": "1,250.00", "colspan": 1, "align": "right" } ] } }

Response Fields

FieldTypeDescription
payload.columnarray<string>ชื่อคอลัมน์ของตาราง
payload.rowarray<array<Cell>>แถวข้อมูลพนักงาน — Cell สุดท้ายมี extra
payload.footerarray<Cell>แถวสรุปยอดรวม

extra Object (คอลัมน์สุดท้ายของแต่ละแถว)

FieldTypeDescription
employee_idstringรหัสพนักงาน (ใช้ส่งต่อไปยัง API อื่น)
tax_month_codestringรหัสเดือนภาษี (MM)
tax_year_codestringรหัสปีภาษี (YYYY)
xtra_slip_listsarray<string>รายการ xtra slip ที่ผูกกับพนักงานในงวดนี้

Error Response

HTTP StatusDescription
400พารามิเตอร์ไม่ครบ / รูปแบบไม่ถูกต้อง / ไม่สามารถ resolve บริษัทได้
401API Key ไม่ถูกต้องหรือไม่ได้ส่ง
403ไม่มีสิทธิ์เรียก API นี้
500เกิดข้อผิดพลาดที่เซิร์ฟเวอร์

หาก year_month ไม่มีข้อมูลงวดเงินเดือน ระบบจะ return payload ที่มี column และ footer แต่ row ว่างเปล่า โดยไม่ถือเป็น error


Code Examples

curl -X POST "https://openapi.humansoft.co.th/api/v1/open-apis/report/nvat-month?path_action=nvat_month" \ -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "authorize_id": "EMP001", "year_month": "2026-03", "type": "json" }'

  • Delete Person Tax NVAT - ลบข้อมูลภาษี ณ ที่จ่ายรายบุคคลตามงวดเดือน
Last updated on