/v1/invoices/quotaHạn mức hoá đơn
Xem ngân sách hoá đơn của doanh nghiệp trên trang quản lý: tổng số đã có và số còn lại để phát hành.
Giới thiệu
API trả ngân sách hoá đơn của doanh nghiệp trên trang quản lý: total là tổng số hoá đơn trong hạn mức, remaining là số còn lại có thể dùng để phát hành.
Dùng khi cần biết còn bao nhiêu hoá đơn trước khi tạo hoá đơn hoặc duyệt thêm số lượng cho mẫu. Đây là hạn mức tổng của tài khoản, không phải số lượng gắn từng mẫu số–ký hiệu.
Gọi endpoint này sau khi đã lấy token. Header Authorization dùng token đó. Gửi thêm API key trong header api_key và App ID trong header app_id. Các giá trị phải cùng ứng dụng, cùng môi trường.
Không gửi username hay password trang quản lý hoá đơn trong request. Hệ thống dùng tài khoản đã gắn với ứng dụng trên trang quản trị để đăng nhập và xử lý phần mẫu hoá đơn.
Endpoint
Gửi GET không có query. Host phải cùng môi trường với token. Sandbox: https://sandbox.api.hddt.dev. Live: https://api.hddt.dev.
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ụ
Request mẫu trên sandbox.
curl https://sandbox.api.hddt.dev/v1/invoices/quota \
-H "Authorization: Bearer $HDDT_TOKEN" \
-H "api_key: $HDDT_API_KEY" \
-H "app_id: $HDDT_APP_ID"Phản hồi
Khi token còn hiệu lực, API trả 200 OK.
objectstringBắt buộcLuôn là invoice_quota.
totalintegerBắt buộcTổng số hoá đơn trong ngân sách / hạn mức của tài khoản.
remainingintegerBắt buộcSố hoá đơn còn lại có thể dùng để phát hành.
{
"object": "invoice_quota",
"total": 1000,
"remaining": 850
}Mã lỗi
Các trường hợp thường gặp:
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.
502 bad_gateway—Tuỳ chọnỨng dụng chưa được gắn tài khoản trang quản lý hoá đơn, hoặc hệ thống không đăng nhập được bằng tài khoản đó.