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

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ừ.
KeyTypeDescription
searchstringThông tin tìm kiếm theo tên mẫu chứng từ
pageintSố trang cần lấy dữ liệu (Mặc định hệ thống đang là 1)
pagesizeintSố 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​

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 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:​

KeyTypeDescription
itemsarrayDanh sách các mẫu chứng từ (Array[object]) (xem chi tiết bên dưới)
totalCountintTổng số bản ghi tìm thấy
pageCountintTổng số trang
pageintTrang hiện tại
pageSizeintSố lượng bản ghi trên một trang
hasNextPagebooleanCó trang tiếp theo hay không (true: Có, false: Không)
hasPreviousPagebooleanCó 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ử:

KeyTypeDescription
idintID mẫu chứng từ
namestringTên mẫu chứng từ
createdDatestringThời gian tạo mẫu chứng từ (định dạng ISO 8601)
fileNamestringTên tệp tin mẫu
createdByUserobjectThô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"
}
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: Đã vô hiệu hóa, false: Đang hoạt động)
isLaborContractTemplatebooleanCó phải mẫu hợp đồng lao động hay không (true: Có, false: Không)