Nhảy tới nội dung
Phiên bản: 2.3.0

Lấy thông tin mẫu chứng từ

Ngày cập nhật: 18 tháng 08, 2026
Người cập nhật: VNPT eContract's team


Mục đích​

Hàm thực hiện lấy thông tin mẫu chứng từ thông qua id của mẫu chứng từ

  • Request URL: /api/document-templates/{id}
  • HTTP method: GET
  • Authorize: Bearer token
  • Parameter:
KeyTypeDescription
idint[Bắt buộc] Id mẫu chứng từ

Mẫu request​

Thông tin id của mẫu chứng từ: id = 1149
Request: /api/document-templates/1149

Mẫu response body​

{
"data": {
"id": 1149,
"name": "Mẫu HĐ Lao động 2025",
"fillableFields": [
{
"key": "{{ngay}}",
"name": "ngay",
"description": "Ngày"
},
{
"key": "{{thang}}",
"name": "thang"
},
{
"key": "{{nam}}",
"name": "nam"
},
{
"key": "{{so_hd}}",
"name": "so_hd"
},
{
"key": "{{nld_hoten}}",
"name": "nld_hoten",
"description": "Họ và tên NLD"
},
{
"key": "{{nld_namsinh}}",
"name": "nld_namsinh"
},
{
"key": "{{nld_diachi}}",
"name": "nld_diachi"
},
{
"key": "{{nld_cccd}}",
"name": "nld_cccd"
},
{
"key": "{{muc_luong}}",
"name": "muc_luong"
}
],
"createdDate": "2022-11-22T14:18:25.3990136",
"fileName": "HĐ Lao động.docx",
"downloadUrl": "{HOST}/Api/Download?token=...",
"pdfDownloadUrl": "{HOST}/Api/Download?token=...",
"isDisabled": false,
"isLaborContractTemplate": false
},
"success": true,
"code": 0,
"messages": []
}

Mô tả Response Body​

KeyTypeDescription
successbooleanTrạng thái phản hồi của yêu cầu (true: Thành công, false: Thất bại)
codeintMã phản hồi từ hệ thống
messagesarrayDanh sách thông báo hoặc lỗi trả về từ hệ thống
dataobjectĐối tượng chứa thông tin chi tiết của mẫu chứng từ (xem chi tiết bên dưới)

Chi tiết dữ liệu trong data:​

KeyTypeDescription
idintID mẫu chứng từ
namestringTên mẫu chứng từ
fillableFieldsarrayDanh sách các trường dữ liệu động có thể điền thông tin (Array[object]) (xem chi tiết bên dưới)
createdDatestringThời gian tạo mẫu chứng từ (định dạng ISO 8601)
fileNamestringTên tệp tin mẫu
downloadUrlstringĐường dẫn tải tệp tin gốc
pdfDownloadUrlstringĐường dẫn tải tệp tin dưới dạng PDF
isDisabledbooleanTrạng thái vô hiệu hóa mẫu chứng từ (true: Đã bị vô hiệu hóa, false: Hoạt động bình thường)
isLaborContractTemplatebooleanCó phải mẫu hợp đồng lao động hay không (true: Có, false: Không)

Chi tiết danh sách fillableFields:​

Danh sách chứa các trường dữ liệu dynamic trong mẫu chứng từ với các thuộc tính của 1 phần tử:

KeyTypeDescription
keystringKhóa định danh trường dữ liệu trong mẫu (ví dụ: {{ngay}}, {{so_hd}})
namestringTên trường dữ liệu
descriptionstringMô tả chi tiết ý nghĩa của trường dữ liệu