Gửi quy trình lô chứng từ import
Ngày cập nhật: 18 tháng 8, 2026
Người cập nhật: VNPT eContract's team
Mục đích
Kích hoạt gửi quy trình ký/duyệt cho toàn bộ chứng từ đã được tạo trong lô import ở bước 7.4.
Response trả về chi tiết đầy đủ của lô import sau khi gửi: status chuyển sang "Process sent" (Đã gửi xử lý), kèm danh sách documents (các chứng từ trong lô) với waitingProcess thể hiện thông tin người đang chờ xử lý ở bước tiếp theo trong quy trình ký.
- Request URL:
/api/batch-imports/send/{batchImportId} - HTTP method:
POST - HTTP content-type:
application/json - Authorize:
Bearer token - Parameter:
| Key | Position | Type | Bắt buộc | Mô tả |
|---|---|---|---|---|
batchImportId | Path param | int | Có | Id lô import trả về ở API mục 7.4 (ví dụ: /api/batch-imports/send/22945) |
batchImportId | Body | int | Có | Trùng giá trị với path param trong dữ liệu test thực tế |
Lưu ý: Body request lặp lại batchImportId đã có trong path — cần đối chiếu thêm với đội phát triển hệ thống xem có thể lược bỏ một trong hai hay không, hoặc đây là yêu cầu bắt buộc của thiết kế API hiện tại.
Ngoài ra, kết quả test ghi nhận API này có thể phát sinh thời gian xử lý ngắn phía backend do tính chất xử lý bất đồng bộ. Đối tác tích hợp nên áp dụng cơ chế retry/timeout hợp lý và kết hợp tra cứu trạng thái lô import khi gọi API này.
Request mẫu
{
"batchImportId": 22945
}
Response mẫu — HTTP 200
{
"data": {
"id": 22945,
"createdDate": "2026-08-05T13:21:56.0319878",
"uploadedByUserId": 27938,
"uploadedByUser": {
"id": 27938,
"code": "trinhttv",
"name": "Trần Thị Việt Trinh",
"email": "trinhttv@vnpt.vn",
"username": "trinhttv@vnpt.vn"
},
"numberOfRecords": 1,
"name": "Import lô HĐLĐ xác định thời hạn HDLD-NVC-20260805062154B",
"documentType": {
"id": 8950,
"code": "HDLD",
"name": "Hợp đồng lao động",
"documentCount": 1,
"enableVnptSeal": false,
"requireVerifiedUserSigning": false,
"children": []
},
"status": {
"value": 999,
"description": "Process sent"
},
"documents": [
{
"id": "367fe4a4-1d85-489a-bc8e-5ab2ec42b222",
"no": "HDLD-NVC-20260805062154B",
"subject": "Hợp đồng lao động Nguyễn Văn Cường 154B",
"status": {
"value": 2,
"description": "Ready"
},
"contractStatus": {
"value": 1,
"description": "Contract valid"
},
"processRecipientCount": 2,
"waitingProcess": {
"id": "0f0ad3cb-6aaa-4dea-b8f1-4c387f15f3d2",
"orderNo": 1,
"displayType": {
"value": 2,
"description": "Text and image"
},
"accessPermission": {
"value": 2,
"description": "Sign draw"
},
"status": {
"value": 1,
"description": "Waiting"
},
"processedByUser": {
"id": 70400,
"code": "BAOTH",
"name": "Tô Hoài Bảo",
"email": "baoth@vnpt.vn",
"username": "baoth@vnpt.vn"
}
},
"downloadUrl": "http://10.70.100.213:2036/Api/Download?token=<rút_gọn...>"
}
],
"errors": [],
"importType": {
"value": 3,
"description": "Labor contracts created from templates"
}
},
"success": true,
"code": 0,
"messages": [
"Send batch document success"
]
}
Một số trường phụ trong từng đối tượng document (như histories, attachments, fillingItems...) đã được lược bớt ở response mẫu trên để dễ theo dõi.
Response Parameter
| Key | Type | Description |
|---|---|---|
data | object | Thông tin chi tiết lô import sau khi đã gửi quy trình ký (xem chi tiết bên dưới) |
success | boolean | Trạng thái xử lý yêu cầu (true: Thành công, false: Thất bại) |
code | int | Mã trạng thái phản hồi |
messages | array | Danh sách thông báo kết quả xử lý từ hệ thống |
Chi tiết đối tượng data trong Response:
| Key | Type | Description |
|---|---|---|
id | int | ID lô import (BatchImportId) |
createdDate | string | Thời gian tạo lô (định dạng ISO 8601) |
uploadedByUserId | int | ID người dùng tải lên lô import |
uploadedByUser | object | Thông tin chi tiết người dùng tải lên lô (id, code, name, email, username) |
numberOfRecords | int | Tổng số bản ghi hợp đồng trong lô import |
name | string | Tên lô import |
documentType | object | Thông tin loại chứng từ (id: 8950, code: HDLD, name: Hợp đồng lao động, ...) |
status | object | Trạng thái xử lý lô (value: 999, description: Process sent — Đã gửi quy trình) |
documents | array | Danh sách các chứng từ đã được khởi tạo quy trình trong lô (xem bên dưới) |
errors | array | Danh sách các thông báo lỗi phát sinh (nếu có) |
importType | object | Loại import (3: Labor contracts created from templates) |
Chi tiết từng đối tượng trong mảng documents:
| Key | Type | Description |
|---|---|---|
id | string | GUID của chứng từ |
no | string | Số hợp đồng/chứng từ |
subject | string | Tiêu đề chứng từ |
status | object | Trạng thái chứng từ (value: 2, description: Ready — Sẵn sàng ký) |
contractStatus | object | Trạng thái hợp đồng (value: 1, description: Contract valid) |
processRecipientCount | int | Tổng số người tham gia trong quy trình ký |
waitingProcess | object | Thông tin bước đang chờ xử lý hiện tại (xem bên dưới) |
downloadUrl | string | Đường dẫn tải file chứng từ |
Chi tiết đối tượng waitingProcess trong documents:
| Key | Type | Description |
|---|---|---|
id | string | GUID của bước xử lý |
orderNo | int | Thứ tự bước trong quy trình ký (1: Bước đầu tiên) |
displayType | object | Hình thức hiển thị (value: 2, description: Text and image) |
accessPermission | object | Quyền xử lý (value: 2, description: Sign draw — Ký nháy) |
status | object | Trạng thái bước (value: 1, description: Waiting — Đang chờ ký) |
processedByUser | object | Thông tin người dùng cần thực hiện ký/duyệt ở bước này (id, code, name, email, username) |