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

Xử lý chứng từ hàng loạt

Ngày cập nhật: 02 tháng 01, 2025
Người cập nhật: VNPT eContract's team


Mục đích

Hàm thực hiện xử lý chứng từ hàng loạt theo quy trình, bao gồm: ký và phê duyệt chứng từ.

Lưu ý

Hàm xử lý chứng từ hàng loạt yêu cầu batchProcessId từ API Tạo lô chứng từ xử lý hàng loạt.

  • Request URL: /api/documents/batch-process
  • HTTP method: POST
  • HTTP content-type: application/json
  • Authorize: Bearer token
  • Parameter:
KeyTypeDescription
batchProcessIdstring[Bắt buộc] Id của lô xử lý data.id (lấy từ response của API Tạo lô chứng từ xử lý hàng loạt)
reasonstring[Bắt buộc] Lý do
rejectboolean[Bắt buộc] Từ chối ký chứng từ
true: từ chối ký chứng từ
otpstring[Bắt buộc] Mã xác nhận OTP
// lần đầu truyền null,
// lần thứ 2 truyền giá trị OTP xác nhận ký/từ chối ký chứng từ trong email/sms
signatureDisplayModeint[Bắt buộc] Chế độ hiển thị chữ ký
1: Chỉ văn bản
2: Văn bản và hình ảnh
3: Chỉ hình ảnh
signatureImagestring[Bắt buộc] Hình ảnh chữ ký
// chuỗi base64 của hình ảnh chữ ký
signingPageint[Bắt buộc] Số trang ký
signingPositionstring[Bắt buộc] Vị trí / tọa độ ký
Rectagle = llx, lly, urx, ury
- llx, lly = tọa độ góc dưới cùng bên trái của chữ ký
- urx = llx + width
- ury = lly + height
Gốc tọa độ là điểm dưới cùng bên trái của tài liệu
signatureTextstring[Bắt buộc] Nội dung ký
fontSizeint[Bắt buộc] Cỡ chữ
showReasonboolean[Bắt buộc] Hiển thị lý do
false: không hiển thị lý do ký
true: hiển thị lý do ký
confirmTermsConditionsboolean[Bắt buộc] Xác nhận điều khoản pháp lý trước khi xử lý chứng từ
false: Không đồng ý
true: đồng ý

Mẫu request lần 1 (json)

{
"batchProcessId": "673c0f4f-8744-4cf7-1061-08dc9a457201",
"reason": "Sign this valid documents",
"reject": false,
"otp": null,
"signatureDisplayMode": 3,
"signatureImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAD…",
"signingPage": null,
"signingPosition": null,
"signatureText": "Tran Viet Trinh",
"fontSize": 12,
"showReason": false,
"confirmTermsConditions": true
}

Mẫu response body lần 1

{
"data": {
"isBatchProcess": false,
"isSingleProcess": false,
"isProcessedByWorkerService": false,
"batchProcessId": "673c0f4f-8744-4cf7-1061-08dc9a457201",
"documentId": "00000000-0000-0000-0000-000000000000",
"documentIds": [],
"accessPermission": 2,
"signMethod": 2,
"signatureDisplayMode": 2,
"batchProcessStatus": 0,
"signingPage": 0,
"signatureText": "Ký hàng loạt chứng từ",
"reason": "Đồng ý với nội dung trình ký",
"confirmReason": "Đồng ý với nội dung trình ký",
"showReason": false,
"fontSize": 0,
"receiveOtpMethod": 2,
"receiveOtpPhone": "0912345678",
"receiveOtpEmail": "trinhttv@email.com",
"requireOtpConfirmation": true,
"vnptCaPluginAdvancedSign": false,
"drawSigns": [],
"documentMessages": [],
"histories": [],
"digitalSignatures": [],
"processes": [],
"documents": [],
"sharedUsers": [],
"sharedDepartments": [],
"sharedUserGroups": [],
"sharedUserIds": [],
"sharedDepartmentIds": [],
"sharedUserGroupIds": [],
"signatureVerifications": [],
"confirmTermsConditions": false,
"documentIndex": 1,
"fillingItems": [],
"isFillPreview": false,
"isSmartCaLoginRequired": false,
"isBusinessSmartCaAccount": false,
"smartCaCerts": []
},
"success": true,
"code": 100,
"messages": [
"Send confirmation otp success"
]
}

Mẫu request lần 2 (json) (Sau khi có thông tin mã OTP nhận được từ Email/SMS)

{
"batchProcessId": "673c0f4f-8744-4cf7-1061-08dc9a457201",
"reason": "Sign this valid documents",
"reject": false,
"otp": "089278", // OTP will be sent to the user's email or SMS
"signatureDisplayMode": 3,
"signatureImage": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAD…",
"signingPage": null,
"signingPosition": null,
"signatureText": "Tran Viet Trinh",
"fontSize": 12,
"showReason": false,
"confirmTermsConditions": true
}

Mẫu response body lần 2

{
"success": true,
"code": 0,
"messages": [
"Sign draw batch document success"
]
}