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:
| Key | Type | Description |
|---|---|---|
id | int | [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
| Key | Type | Description |
|---|---|---|
success | boolean | Trạng thái phản hồi của yêu cầu (true: Thành công, false: Thất bại) |
code | int | Mã phản hồi từ hệ thống |
messages | array | Danh sách thông báo hoặc lỗi trả về từ hệ thống |
data | object | Đố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:
| Key | Type | Description |
|---|---|---|
id | int | ID mẫu chứng từ |
name | string | Tên mẫu chứng từ |
fillableFields | array | Danh 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) |
createdDate | string | Thời gian tạo mẫu chứng từ (định dạng ISO 8601) |
fileName | string | Tên tệp tin mẫu |
downloadUrl | string | Đường dẫn tải tệp tin gốc |
pdfDownloadUrl | string | Đường dẫn tải tệp tin dưới dạng PDF |
isDisabled | boolean | Trạ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) |
isLaborContractTemplate | boolean | Có 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ử:
| Key | Type | Description |
|---|---|---|
key | string | Khóa định danh trường dữ liệu trong mẫu (ví dụ: {{ngay}}, {{so_hd}}) |
name | string | Tên trường dữ liệu |
description | string | Mô tả chi tiết ý nghĩa của trường dữ liệu |