1. Thêm hợp đồng

Phương thức POST

Địa chỉ sử dụng

https://api.econtract.cmcts.vn/contract/add?APIKey={apikey}&AccessCode={accesscode}

Json đầu vào

Giải thích các tham số mảng đầu vào. Dấu (*) bắt buộc có

AdUserId: (*) UserId hoặc email của người tạo hợp đồng => Lấy từ danh sách hàm User

AdDepartmentId: (*) Id hoặc mã phòng ban => Lấy từ danh sách hàm Department/list

AdCompanyId: (*) Id hoặc mã công ty => Lấy từ danh sách hàm Company/list

EffectedDate: Ngày hiệu lực hợp đồng nếu có

ExpiredDate: Ngày hết hạn hợp đồng nếu có

SignDate: Ngày dự kiến ký hợp đồng nếu có

ContractTypeId: (*) Loại hợp đồng => Lấy từ danh sách loại hợp đồng

ContractTemplateId: Mẫu hợp đồng => Lấy từ danh sách mẫu hợp đồng

UseTemplate: Tạo hợp đồng từ mẫu. Giá trị 1 nếu tạo lấy file từ mẫu. 0: Không lấy file chỉ lấy thiết lập

ContractId: (*) Id của hợp đồng duy nhất

PartnerId: Id đối tác ký hợp đồng

merge: 1 merge các file pdf. 0Không merge

UsingApiUrl: 1 Để lấy Url ký sử dụng cho các ứng dụng tích hợp

autosign: 1 tự động ký hợp đồng và chuyển đối tác. 0không tự động

SignTemplateId: (*) Id của mẫu người ký => Lấy từ danh sách mẫu người ký

WorkflowDefId: (*) Id của quy trình ký hợp đồng => Lấy từ danh sách quy trình

SignerId: Id của người ký chính hợp đồng => Lấy từ danh sách người ký

SignerSignatureId: Id của chữ ký của ngườu ký hợp đồng => Lấy trong hàm lấy thông tin chi tiết người ký

StampSignatureBase64: Mẫu dấu hoặc chữ ký nháy ký vào tất các các trang ở giữa phía dưới

StampWidth: Chiều rộng con dấu. Giá trị 0 tự động scale

StampHeight: Chiều cao con dấu. Giá trị 0 tự động scale

PartnerSignType: Kiểu ký của đối tác. token: Ký bằng token; ekyc: Ký bằng cấp chữ ký số 1 lần; esign: Ký bằng ekyc + cks24h; image: Chỉ ký bằng chữ ký hình ảnh

CallBackUrl: Địa chỉ CallBackUrl khi hợp đồng ký, hợp đồng bị từ chối

AllowRecall: 1 cho phép Recall lại hợp đồng khi đối tác chưa ký từ email notify

DisabledDrawSignature: 1 tắt chế độ ký bằng vẽ chữ ký. Chỉ cho upload ảnh chữ ký

SendEmailFromAddress: Gửi email thông báo notify từ địa chỉ email này. Chỉ có tác dụng khi thiết lập SMTP

ExpiredDays: Số ngày hết hạn ký hợp đồng cho đối tác

DisablePartnerDrawSignature: 1 tắt chế độ vẽ chữ ký của đối tác

NotifyEmails: Danh sách địa chỉ email nhận notify trong đó

• Email: Địa chỉ email nhận thông báo
• Mobile: Số điện thoại nhận thông báo
• FullName: Họ tên người nhận
• AllowRecallLink: Giá trị 1 nếu trong email nhận khi tạo hơp đồng có link để recall
• Created: Giá trị 1 nếu muốn nhận thông báo khi hợp đồng khởi tạo
• Recall: Giá trị 1 nếu muốn nhận thông báo khi hợp đồng được recall
• Reject: Giá trị 1 nếu muốn nhận thông báo khi đối tác từ chối ký hợp đồng
• PartnerSign: Giá trị 1 nếu muốn nhận thông báo khi đối tác ký hợp đồng
• OfficeSign: Giá trị 1 nếu muốn nhận thông báo khi đơn vị người ký chính ký hợp đồng
• OtherSign: Giá trị 1 nếu muốn nhận thông báo khi người tham gia trong đơn vị không phải người ký chính ký phê duyệt
• Expired: Giá trị 1 nếu muốn nhận thông báo khi hết hạn ký
• Finished: Giá trị 1 nếu muốn nhận thông báo khi hợp đồng ký kết
• Workflow: Giá trị 1 nếu muốn nhận thông báo khi chuyển quy trình

SignTemplateItems: Mảng thông tin đối tác ký chú ý lấy từ hàm "Lấy chi tiết mẫu tham gia ký" và chỉ thay đổi thông tin FullName, Email và mobile còn các tham số SignTemplateItemId Role Scope SSearchTerm SPositioncần giữ nguyên. Nếu không truyền mảng này thì trong trường hợp ký theo quy trình có đối tác (Partner) cần truyền các biến PartnerEmail, PartnerName

ContractAttachFiles:Mảng file hợp đồng trong đó
AttachFileName tên file ContentBase64 nội dung file Password mật khẩu file PDF nếu là file PDF và có mật khẩu Main 1 file hợp đồng 0 file gắn gèm AttachFileType có giá trị pdf (nếu nội dung file là pdf) hoặc doc (nếu nội dung file là word)