Lấy danh sách loại 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 loại chứng từ

• Request URL: /api/document-types
• 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 loại chứng từ.

Key	Type	Description
search	string	Thông tin tìm kiếm theo tên loại chứng từ hoặc mã loại 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: 10
    search: HD-LAODONG
Request: /api/document-types?page=1&pageSize=10&search=HD-LAODONG

Mẫu response body

{
    "data": {
        "items": [
            {
                "id": 1085,
                "code": "HD-LAODONG",
                "name": "Hợp đồng lao động",
                "processTemplate": {
                    "id": 1089,
                    "createdDate": "2022-09-12T10:29:23.4146356",
                    "processInOrder": false,
                    "isPublic": false,
                    "items": []
                },
                "documentCount": 4,
                "enableVnptSeal": true,
                "requireVerifiedUserSigning": true
            },
        ],
        "totalCount": 1,
        "pageCount": 2,
        "page": 1,
        "pageSize": 10,
        "hasNextPage": true,
        "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 loại 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 loại 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 loại chứng từ với các thuộc tính của 1 phần tử:

Key	Type	Description
id	int	ID loại chứng từ
code	string	Mã loại chứng từ
name	string	Tên loại chứng từ
processTemplate	object	Thông tin mẫu quy trình áp dụng mặc định cho loại chứng từ này: { "id": "ID mẫu quy trình", "createdDate": "Thời gian tạo mẫu quy trình (ISO 8601)", "processInOrder": "Xử lý theo thứ tự (boolean)", "isPublic": "Trạng thái công khai (boolean)" }
documentCount	int	Số lượng chứng từ đang thuộc loại chứng từ này
enableVnptSeal	boolean	Chứng thực thông điệp VNPT SEAL (true: Bật, false: Tắt)
requireVerifiedUserSigning	boolean	Yêu cầu người ký đã xác thực danh tính (true: Bắt buộc xác thực, false: Không bắt buộc)