Tạo 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 tạo mới mẫu chứng từ với dữ liệu đầu vào là file có định dạng .docx.
- Request URL:
/api/document-templates/create - HTTP method:
POST - HTTP content-type:
multipart/form-data - Authorize:
Bearer token - Parameter:
| Key | Type | Description |
|---|---|---|
file | file | [Bắt buộc] File mẫu chứng từ |
name | string | [Bắt buộc] Tên mẫu chứng từ |
description | string | Mô tả mẫu chứng từ |
IsLaborContractTemplate | boolean | Có phải mẫu hợp đồng lao động (true: Có, false: Không) |
Mẫu response body
{
"data": {
"id": 1149,
"name": "FILE MẪU IMPORT LÔ",
"createdDate": "2022-11-22T14:18:25.3990136",
"fillableFields": [
{
"key": "{{ngay}}",
"name": "ngay",
"description": "Ngày"
},
{
"key": "{{thang}}",
"name": "thang"
},
{
"key": "{{nam}}",
"name": "nam"
}
],
"fileName": "HĐ Dịch vụ Cấp nước Test Dochub.docx",
"downloadUrl": "{HOST}/Api/Download?token=...",
"pdfDownloadUrl": "{HOST}/Api/Download?token=...",
"isDisabled": false,
"isLaborContractTemplate": false
},
"success": true,
"code": 0,
"messages": [
"Create file template success"
]
}
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 (Xem chi tiết bên dưới) |
data | object | Đối tượng chứa thông tin chi tiết của mẫu chứng từ vừa khởi tạo (xem chi tiết bên dưới) |
Chi tiết dữ liệu trong data:
| Key | Type | Description |
|---|---|---|
id | int | ID của mẫu chứng từ vừa tạo |
name | string | Tên mẫu chứng từ |
createdDate | string | Thời gian tạo mẫu chứng từ (định dạng ISO 8601) |
fileName | string | Tên tệp tin gốc đã tải lên |
downloadUrl | string | Đường dẫn tải tệp tin mẫu gốc (.docx) |
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 |
Danh sách các message
| Message | Description |
|---|---|
| "Create file template success" | Tạo chứng từ thành công |
| "Can not find any placeholder" | Thiếu trường dữ liệu động {{*}} trong file |
| "Extension (.*) is not allowed!" | Sai định dạng file |