/v1/invoices/signKý hoá đơn nháp
Ký một hoá đơn đã lưu nháp. Gửi invoice_code là UUID lấy từ data.id của API Tạo hoá đơn.
Giới thiệu
API ký một hoá đơn đang ở trạng thái nháp. Tạo nháp bằng API Tạo hoá đơn với issue_mode bằng 0, rồi gửi UUID trong data.id vào invoice_code của API này.
Hoá đơn đã phát hành không ký lại bằng API này. Trên sandbox, hoá đơn không được gửi tới cơ quan thuế.
Endpoint
Gửi POST với JSON. Sandbox: https://sandbox.api.hddt.dev. Live: https://api.hddt.dev.
Chỉ hoá đơn nháp
Header
Token, API key và App ID phải cùng ứng dụng, cùng môi trường.
AuthorizationstringBắt buộcBearer token lấy từ API Lấy token.
api_keystringBắt buộcAPI key của ứng dụng.
app_idstringBắt buộcĐịnh danh ứng dụng (UUID). Sao chép App ID trên trang chi tiết ứng dụng (tab Kết nối & bảo mật).
Content-TypestringBắt buộcapplication/json.
Body
Chỉ gửi mã số của hoá đơn nháp cần ký.
invoice_codestringBắt buộcUUID của hoá đơn nháp, lấy từ data.id của API Tạo hoá đơn.
Ví dụ
Ký hoá đơn nháp có id 7c9e6679-7425-40de-944b-e07fc1f90ae7 trên sandbox.
curl -X POST https://sandbox.api.hddt.dev/v1/invoices/sign \
-H "Authorization: Bearer $HDDT_TOKEN" \
-H "api_key: $HDDT_API_KEY" \
-H "app_id: $HDDT_APP_ID" \
-H "Content-Type: application/json" \
-d '{
"invoice_code": "7c9e6679-7425-40de-944b-e07fc1f90ae7"
}'Phản hồi
Khi ký được hoá đơn, success là true. data là dữ liệu trả về sau khi ký.
successbooleanBắt buộctrue khi ký được hoá đơn, false khi thất bại.
dataobjectBắt buộcDữ liệu trả về khi ký thành công. Khi thất bại có thể trống.
error_codestringBắt buộcTrống khi thành công. Khi thất bại là mã lỗi nghiệp vụ.
messagestringBắt buộcThông báo thành công hoặc thất bại.
{
"success": true,
"data": {},
"error_code": "",
"message": "Thành công"
}Mã lỗi
Khi hoá đơn không được ký, success là false, error_code và message mô tả lỗi nghiệp vụ. Lỗi xác thực và định dạng của hddt.dev vẫn trả mã HTTP kèm error.code và error.message.
401 unauthorized—Tuỳ chọnThiếu token hoặc header api_key, token sai hoặc hết hạn, API key đã thu hồi, hoặc key không cùng ứng dụng và môi trường với token. Gọi lại API Lấy token nếu token hết hạn.
422 validation_error—Tuỳ chọnThiếu invoice_code.