/v1/invoices/{id}Xoá hoá đơn nháp
Xoá một hoá đơn đang lưu nháp. Hoá đơn đã phát hành không xoá bằng API này.
Giới thiệu
API xoá một hoá đơn đang lưu 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 lên đường dẫn của API này.
Hoá đơn đã phát hành không xoá được. Muốn bỏ một hoá đơn đã phát hành thì dùng quy trình thông báo sai sót, không dùng API này. Thao tác không hoàn tác được.
Endpoint
Gửi DELETE với UUID của hoá đơn nháp trên đường dẫn. 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).
Ví dụ
Xoá hoá đơn nháp có id 7c9e6679-7425-40de-944b-e07fc1f90ae7 trên sandbox.
curl -X DELETE https://sandbox.api.hddt.dev/v1/invoices/7c9e6679-7425-40de-944b-e07fc1f90ae7 \
-H "Authorization: Bearer $HDDT_TOKEN" \
-H "api_key: $HDDT_API_KEY" \
-H "app_id: $HDDT_APP_ID"Phản hồi
Khi xoá được hoá đơn nháp, success là true. data.id là UUID vừa xoá. data.deleted là true. Nếu ứng dụng đã đăng ký sự kiện invoice_draft_deleted, hệ thống gửi webhook sau khi xoá.
successbooleanBắt buộctrue khi xoá được hoá đơn nháp, false khi thất bại.
dataobjectBắt buộcKết quả xoá. Khi thành công có id và deleted.
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.
idstringBắt buộcUUID của hoá đơn nháp vừa xoá, nằm trong data.
deletedbooleanBắt buộcLuôn là true khi xoá thành công, nằm trong data.
{
"success": true,
"data": {
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"deleted": true
},
"error_code": "",
"message": "Thành công"
}Mã lỗi
Khi hoá đơn không được xoá, 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.
404 not_found—Tuỳ chọnKhông có hoá đơn nháp với id này trong ứng dụng, hoặc hoá đơn đã được xoá.
422 validation_error—Tuỳ chọnid không phải UUID, hoặc hoá đơn không còn là nháp (đã ký hoặc đã phát hành).