Lấy danh sách 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 lấy thông tin danh sách các mẫu chứng từ mà người dùng đã tạo trên hệ thống hoặc các mẫu chứng từ mà người dùng được chia sẻ.
- Request URL:
/api/document-templates - HTTP method:
GET - Authorize:
Bearer token - Parameter: Không yêu cầu, tuy nhiên có thể thêm các tùy chọn bên dưới để thực hiện lọc hoặc tìm kiếm danh sách mẫu chứng từ.
| Key | Type | Description |
|---|---|---|
search | string | Thông tin tìm kiếm theo tên mẫu chứng từ |
page | int | Số trang cần lấy dữ liệu (Mặc định hệ thống đang là 1) |
pagesize | int | Số record dữ liệu mà hệ thống sẽ trả về sau mỗi request (Mặc định hệ thống đang là 10 record) |
Mẫu request
Query param:
page: 1
pageSize: 20
search: FILE MẪU IMPORT LÔ
Request: /api/document-templates?page=1&pageSize=10&search=FILE MẪU IMPORT LÔ
Mẫu response body
{
"data": {
"items": [
{
"id": 1149,
"name": "FILE MẪU IMPORT LÔ",
"createdDate": "2022-11-22T14:18:25.3990136",
"fileName": "HĐ Dịch vụ Cấp nước Dochub.docx",
"createdByUser": {
"id": 2341,
"comId": 164,
"code": "phannhan",
"name": "Phan Nhan",
"phone": "091938XXXX",
"email": "example@email.com",
"username": "example@email.com",
},
"downloadUrl": "{HOST}/Api/Download?token=...",
"pdfDownloadUrl": "{HOST}/Api/Download?token=...",
"isDisabled": false,
"isLaborContractTemplate": false
}
],
"totalCount": 1,
"pageCount": 1,
"page": 1,
"pageSize": 10,
"hasNextPage": false,
"hasPreviousPage": 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 danh sách mẫu chứng từ và thông tin phân trang (xem chi tiết bên dưới) |
Chi tiết dữ liệu trong data:
| Key | Type | Description |
|---|---|---|
items | array | Danh sách các mẫu chứng từ (Array[object]) (xem chi tiết bên dưới) |
totalCount | int | Tổng số bản ghi tìm thấy |
pageCount | int | Tổng số trang |
page | int | Trang hiện tại |
pageSize | int | Số lượng bản ghi trên một trang |
hasNextPage | boolean | Có trang tiếp theo hay không (true: Có, false: Không) |
hasPreviousPage | boolean | Có trang trước đó hay không (true: Có, false: Không) |
Chi tiết danh sách items:
Danh sách chứa các đối tượng mẫu chứng từ với các thuộc tính của 1 phần tử:
| Key | Type | Description |
|---|---|---|
id | int | ID mẫu chứng từ |
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 mẫu |
createdByUser | object | Thông tin chi tiết người tạo mẫu chứng từ: {
"id": "ID người tạo",
"comId": "ID công ty",
"code": "Mã người tạo",
"name": "Tên người tạo",
"phone": "Số điện thoại người tạo",
"email": "Email người tạo",
"username": "Tên đăng nhập"
} |
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: Đã vô hiệu hóa, false: Đang hoạt động) |
isLaborContractTemplate | boolean | Có phải mẫu hợp đồng lao động hay không (true: Có, false: Không) |