Lấy danh sách chứng từ
Ngày cập nhật: 30 tháng 4, 2023
Người cập nhật: VNPT eContract's team
Mục đích
Hàm lấy thông tin danh sách chứng từ của người dùng hoặc các chứng từ được chia sẻ từ các người dùng khác trong hệ thống.
- Request URL:
/api/documents - 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 chứng từ.
| Key | Type | Description |
|---|---|---|
status | int | Trạng thái chứng từ: 1: Chứng từ mới 2: Sẵn sàng 3: Đang xử lý 4: Đã hoàn tất 5: Đang hiệu chỉnh -3: Đã hủy -2: Đã xóa -1: Đã bị từ chối |
contractStatus | int | Trạng thái hợp đồng: 0: Không xác định 1: Còn hiệu lực 2: Gần hết hiệu lực -2: Chưa có hiệu lực -1: Hết hiệu lực |
documentTemplateId | int | Id mẫu chứng từ |
departmentId | int | Id bộ phận |
documentTypeId | int | Id loại chứng từ |
recipientIds | Array[int] | Mảng Id người nhận |
createdByUserId | int | Id người tạo |
batchImportId | int | Id lô import |
createdFrom | string | Tạo từ ngày |
createdTo | string | Tạo đến ngày |
completedFrom | string | Hoàn thành từ ngày |
completedTo | string | Hoàn thành đến ngày |
customerCode | string | Mã khách hàng |
waitToApprove | boolean | Chờ duyệt |
waitToSignDigital | boolean | Chờ ký số |
waitToSignDraw | boolean | Chờ ký nháy |
contractValueFrom | string | Giá trị hợp đồng từ |
contractValueTo | string | Giá trị hợp đồng đến |
search | string | Thông tin tìm kiếm theo mã chứng từ hoặc tên 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: FA902
Request: /api/documents?page=1&pageSize=10&search=FA902
Mẫu response body
{
"data": {
"items": [
{
"id": "fa07d61e-0fff-41a3-e618-08dad69d1b1b",
"createdDate": "2022-12-05T15:45:47.8532528",
"lastModifiedDate": "2022-12-05T15:46:07.5741114",
"no": "FA902",
"subject": "Hợp đồng FA902",
"hasVerified": false,
"fileType": 0,
"status": {
"value": 2,
"description": "Ready document"
},
"contractStatus": {
"value": 0,
"description": "Undefined"
},
"description": "Chứng từ thử nghiệm",
"department": {
"id": 33,
"name": "VNPT eContract",
"code": "DHB",
},
"createdByUserId": 1163,
"processRecipientCount": 2,
"waitingProcess": {
"id": "cfa4f1cd-7db3-477d-8de7-08dad69d1b3b",
"createdDate": "2022-12-05T15:45:47.8532366",
"comId": 164,
"isOrder": true,
"orderNo": 1,
"pageSign": 1,
"position": "28,672,208,762",
"displayType": {
"value": 0,
"description": "0"
},
"accessPermission": {
"value": 2,
"description": "Sign draw"
},
"status": {
"value": 1,
"description": "Waiting"
},
"processedByUserId": 1163,
"documentId": "fa07d61e-0fff-41a3-e618-08dad69d1b1b"
},
"processInOrder": true,
"isWaitToSignDraw": false,
"isWaitToSignDigital": false,
"isWaitToApprove": false,
"isCancelable": false,
"isEditable": false,
"isShareable": false,
"isAccessable": false,
"isExpired": false,
"canDownload": false,
"type": {
"id": 1089,
"code": "CNCL",
"name": "Hợp đồng cấp nước",
"description": "Hợp đồng của cấp nước chợ lớn",
"documentCount": 1
},
"documentTemplate": {
"id": 1141,
"name": "Mẫu hợp đồng thuê nhà",
"createdDate": "2022-11-18T16:07:18.1590328",
"fileName": "DocTemplate.docx",
"downloadUrl": "{HOST}/Api/Download?token=...",
"pdfDownloadUrl":"{HOST}/Api/Download?token...",
"isShareable": false,
"isDeletelable": false,
"isUpdateable": false
},
"batchImport": {
"id": 1232,
"createdDate": "2022-12-05T15:45:44.199619",
"uploadedByUserId": 1163,
"numberOfRecords": 2,
"name": "20221205.A5BO",
},
"processes": [
{
"id": "cfa4f1cd-7db3-477d-8de7-08dad69d1b3b",
"createdDate": "2022-12-05T15:45:47.8532366",
"comId": 164,
"isOrder": true,
"orderNo": 1,
"pageSign": 1,
"position": "28,672,208,762",
"displayType": {
"value": 0,
"description": "0"
},
"accessPermission": {
"value": 2,
"description": "Sign draw"
},
"status": {
"value": 1,
"description": "Waiting"
},
"processedByUserId": 1163,
"documentId": "fa07d61e-0fff-41a3-e618-08dad69d1b1b"
}
],
"histories": [],
"attachments": [],
"relatedDocuments": [],
"messages": [],
"file": {
"name": "FA902.pdf",
"size": 186793
},
"downloadUrl": "{HOST}/Api/Download?token=..."
}
],
"totalCount": 1,
"pageCount": 1,
"page": 1,
"pageSize": 10,
"hasNextPage": false,
"hasPreviousPage": false
},
"success": true,
"code": 0,
"messages": []
}