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

Tạo lô chứng từ xử lý hàng loạt

Ngày cập nhật: 29 tháng 09, 2026
Người cập nhật: VNPT eContract's team

Mục đích​

Hàm tạo một lô xử lý từ danh sách chứng từ và quyền xử lý được chỉ định. Sử dụng data.id trả về làm batchProcessId khi gọi API Xử lý chứng từ hàng loạt.

  • Request URL: /api/documents/create-batch-process
  • HTTP method: POST
  • HTTP content-type: application/json
  • Authorize: Bearer token
  • Parameter:
KeyTypeDescription
documentIdsArray[string][Bắt buộc] Mảng các id của chứng từ
accessPermissionCodestring[Bắt buộc] Quyền truy cập
cẩn thận
  • documentIds phải là các chứng từ có lượt xử lý hợp lệ đang chờ người dùng đăng nhập xử lý.
  • Người dùng đăng nhập phải tham gia quy trình của các chứng từ được đưa vào lô.
  • Một accessPermissionCode được áp dụng cho toàn bộ lô xử lý.
mẹo

accessPermissionCode là các quyền truy cập xử lý chứng từ:

  • V là chỉ xem
  • D là ký số (được hỗ trợ)
  • E là ký điện tử (được hỗ trợ)
  • EKYC là ký eKYC
  • DR là ký nháy (được hỗ trợ)
  • A là phê duyệt (được hỗ trợ)
  • F là điền dữ liệu
  • C là điều phối

Mẫu request​

{
    "documentIds": [
        "f184943f-e394-42e8-98b3-1e3d178ee62c",
        "9c7a4764-2b4b-4169-8be8-d528491af0cb"
    ],
    "accessPermissionCode": "DR"
}

Mẫu response body​

{
    "data": {
        "id": "673c0f4f-8744-4cf7-1061-08dc9a457201",
        "comId": 2211,
        "processes": [
            {
                "id": "2d446004-f560-40ba-3d78-08dc837a4c87",
                "createdDate": "2024-06-03T13:41:58.6093432",
                "comId": 2211,
                "isOrder": true,
                "orderNo": 1,
                "pageSign": 2,
                "position": "414,624,520,676",
                "displayType": {
                    "value": 0,
                    "description": "0"
                },
                "accessPermission": {
                    "value": 2,
                    "description": "Sign draw"
                },
                "status": {
                    "value": 1,
                    "description": "Waiting"
                },
                "processedByUserId": 6199,
                "documentId": "f184943f-e394-42e8-98b3-1e3d178ee62c",
                "fileInfoId": "0ae400d4-96ee-4861-9de2-1f6c2e7e3ec5",
                "fillingItems": []
            },
            {
                "id": "c843fdf2-d2a3-405b-3ca6-08dc837a4c87",
                "createdDate": "2024-06-03T10:11:56.8206304",
                "comId": 2211,
                "isOrder": true,
                "orderNo": 1,
                "pageSign": 1,
                "position": "414,78,520,130",
                "displayType": {
                    "value": 0,
                    "description": "0"
                },
                "accessPermission": {
                    "value": 2,
                    "description": "Sign draw"
                },
                "status": {
                    "value": 1,
                    "description": "Waiting"
                },
                "processedByUserId": 6199,
                "documentId": "9c7a4764-2b4b-4169-8be8-d528491af0cb",
                "fillingItems": []
            }
        ],
        "accessPermission": {
            "value": 2,
            "description": "Sign draw"
        },
        "status": {
            "value": 1,
            "description": "New"
        }
    },
    "success": true,
    "code": 0,
    "messages": [
        "Batch process created successfully"
    ]
}

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 trả về từ hệ thống (Ví dụ: ["Batch process created successfully"])
dataobjectĐối tượng chứa thông tin lô chứng từ vừa khởi tạo (xem chi tiết bên dưới)

Chi tiết dữ liệu trong data:​

KeyTypeDescription
idstringID của lô xử lý hàng loạt (định dạng GUID)
comIdintID công ty/đơn vị
accessPermissionobjectQuyền xử lý áp dụng cho lô chứng từ: {"value": int, "description": string} (Ví dụ: Sign draw,...)
statusobjectTrạng thái của lô chứng từ: {"value": int, "description": string}
1: New (Mới khởi tạo)
processesarrayDanh sách thông tin các lượt xử lý chi tiết tương ứng với từng chứng từ trong lô (Array[object]) (xem chi tiết bên dưới)

Chi tiết mảng processes:​

Danh sách các đối tượng mô tả thông tin chi tiết từng bước xử lý của các chứng từ nằm trong lô hàng loạt:

KeyTypeDescription
idstringID lượt xử lý quy trình (định dạng GUID)
createdDatestringThời gian tạo lượt xử lý (định dạng ISO 8601)
comIdintID công ty/đơn vị
isOrderbooleanĐã đến lượt xử lý hay chưa (true: Đã đến lượt, false: Chưa đến lượt)
orderNointSố thứ tự xử lý trong quy trình
pageSignintTrang đặt chữ ký trên chứng từ
positionstringTọa độ vị trí chữ ký (định dạng "x1,y1,x2,y2")
displayTypeobjectLoại hiển thị chữ ký: {"value": int, "description": string}
accessPermissionobjectQuyền xử lý trong lượt: {"value": int, "description": string} (Ví dụ: Sign draw, Approve,...)
statusobjectTrạng thái lượt xử lý: {"value": int, "description": string} (Ví dụ: Waiting, Signed,...)
processedByUserIdintID người dùng chịu trách nhiệm xử lý lượt này
documentIdstringID của chứng từ riêng lẻ nằm trong lô (định dạng GUID)
fillingItemsarrayDanh sách các trường dữ liệu cần điền (Array[object])
fileInfoIdstringID file thành phần gắn với lượt xử lý, trong trường hợp chứng từ nguồn có nhiều file.

Các lỗi thường gặp​

MessageDescription
Only user who are part of the process can create a batch processing task. Please verify the user account used to create the batch.Chỉ người dùng nằm trong quy trình xử lý chứng từ mới có quyền tạo lô xử lý hàng loạt. Vui lòng kiểm tra lại tài khoản người dùng thực hiện.
No valid processes found for the provided documents.Không tìm thấy quy trình xử lý hợp lệ nào ứng với danh sách ID chứng từ truyền vào (có thể do chứng từ không tồn tại, đã hoàn thành hoặc không có luồng xử lý phù hợp).
Cập nhật lần cuối vào bởi NghiepPV