SAInvoice API - Thông tin hóa đơn

API thực hiện lấy thông tin hóa đơn và thông tin chi tiết hóa đơn từ id của hóa đơn.

Các thông tin cấu hình cần thiết:

Tên Mô tả
CompanyCode Mã nhà hàng lấy
AccessToken Chuỗi token xác thực

Để lấy các thông tin trên xem bài viết account/login

About

URL Phiên bản Thay đổi
graphapi.cukcuk.vn 1.0

Schemes

Scheme
https

Endpoints

api/v1/sainvoices/{refId}

GET

Lấy chi tiết hóa đơn theo id

Expected Response Types
HttpCode ServiceResult.ErrorType Mô tả
401 Chuỗi AccessToken hết hạn hoặc không hợp lệ cần phải gọi cấp phát lại
200 0 Không có lỗi
200 1 Tham số không hợp lệ null or empty
200 2 Mã nhà hàng không tồn tại
200 5 Tham số lấy phân trang vượt quá số lượng cấu hình cho phép (max 100)
200 6 Tham số ngày giờ không hợp lệ (01/01/1753 - 31/12/9999)
200 7 Thiết lập kết nối CUKCUK đang ở trạng thái ngắt, không thể lấy dữ liệu
200 100 Lỗi nội bộ API Graph
200 102 Request bị từ chối, do có request cùng loại đang xử lý. Vui lòng chờ xử lý xong hoặc chờ request đang xử lý timeout thì gọi lại.
Parameters
Name In Description Required? Type
refId uri id hóa đơn cần lấy thông tin true string
Headers (gửi lên theo header field)
Name In Description Required? Type
Authorization header Header key cấu hình AccessToken (dạng Bearer AccessToken) true string
CompanyCode header Header key cấu hình mã nhà hàng CompanyCode true string

Ví dụ:

CompanyCode: demoquanviet
Authorization: Bearer utFYFHGRrnz-JWVCViIjy4k3CtKWOJDBY6wvL5X_5k9jm14tLIP6qPgCXdupERxyv78hWzSAF_rtK1RRAbtwc-M96sUIzFQ4bSfeY_2xYCzmZBTPNKbohxMHDbR2F4eeNk_dM_7B5Zod8-qGhT7LDwtE_23cuRWeK_qWkYHk2rMiqJM-vd9dYHANtq4OVI-Y8fYZ4B_Q_wPvsZl6svkSNLX2RQygFMOccGsC_G3dv1MbUf2KWjOHcr_SBPH66jQPs8V3CbZ_Eywo7vShkqdenhvNqdNOg9Gl56tybzW4YfcAvmYMUUOEuc7-ffyHfUnE
Content Types Produced
Produces
application/json
Content Types Consumed
Consumes
application/json
Response

Trả về đối tượng ServiceResult với ServiceResult.Data là SAInvoice

Example

Ví dụ gọi GET tới

https://graphapi.cukcuk.vn/api/v1/sainvoices/53B8D27D-2C4E-4B34-9881-0015F6765E9D

Hệ thống sẽ trả về ServiceResult với ServiceResult.Data là SAInvoice JSON response

{
  "Code": 200,
  "Data": {
    "RefId": "53b8d27d-2c4e-4b34-9881-0015f6765e9d",
    "RefType": 550,
    "RefNo": "2007000044",
    "RefDate": "2020-07-24T16:44:32.577",
    "BranchId": "994c6fe5-da83-441b-a0e8-57a6fed98fb2",
    "OrderId": "846fe019-87f1-4e8b-a0f4-50739494a496",
    "OrderType": 1,
    "EmployeeId": "12c271ea-478c-4350-b55d-162d66208838",
    "EmployeeName": "Dung Nguyễn",
    "DeliveryPartnerID": "6c694a57-52ab-454b-ace4-60cf09e2583a",
    "DeliveryPartnerName": "Bác xe ôm",
    "WaiterEmployeeName": "",
    "TableName": "",
    "Description": "",
    "DepositAmount": 0.0,
    "Amount": 50000.0,
    "DeliveryAmount": 0.0,
    "ServiceRate": 0.0,
    "ServiceAmount": 0.0,
    "VATRate": 0.0,
    "VATAmount": 0.0,
    "DiscountAmount": 0.0,
    "PromotionRate": 0.0,
    "PromotionAmount": 0.0,
    "PromotionItemsAmount": 0.0,
    "ReceiveAmount": 0.0,
    "ReturnAmount": 0.0,
    "TotalAmount": 50000.0,
    "SaleAmount": 50000.0,
    "TotalItemAmount": 50000.0,
    "TotalItemAmountAfterTax": 0.0,
    "TipAmount": 0.0,
    "ServiceTaxRate": 0.0,
    "DeliveryTaxRate": 0.0,
    "PaymentStatus": 3,
    "AvailablePoint": 0,
    "UsedPoint": 0,
    "AddPoint": 0,
    "SAInvoiceDetails": [
      {
        "RefDetailID": "8ffaba83-7d45-4c07-ac6e-a6c482c09ef0",
        "RefDetailType": 1,
        "RefID": "53b8d27d-2c4e-4b34-9881-0015f6765e9d",
        "ItemID": "d8c7b4ef-b935-4fa8-9a04-f28d73bc0e98",
        "ItemName": "XK",
        "Quantity": 1.0,
        "UnitPrice": 50000.0,
        "UnitID": "e2d4815b-385b-4995-980c-4f636a27a1ed",
        "UnitName": "Cái",
        "Amount": 50000.0,
        "DiscountRate": 0.0,
        "SortOrder": 1,
        "InventoryItemType": 1,
        "HaveAddition": false,
        "IsSeftPrice": false,
        "PromotionRate": 0.0,
        "PromotionType": 0,
        "PromotionName": "",
        "OrderDetailID": "d60b1a7e-e5c6-451a-94dc-a2844b31b284",
        "IsSelected": false,
        "SAInvoicePromotionAmount": 0.0,
        "ItemCode": "XK",
        "PromotionAmount": 0.0,
        "AllocationAmount": 0.0,
        "PreTaxAmount": 50000.0,
        "AllocationDeliveryPromotionAmount": 20000.0
      }
    ],
    "SAInvoicePayments": [
      {
        "SAInvoicePaymentID": "f7954d7d-c586-4d06-a32b-defe9159ddbc",
        "RefID": "53b8d27d-2c4e-4b34-9881-0015f6765e9d",
        "PaymentType": 1,
        "Amount": 50000.0,
        "PaymentName": "Tiền mặt",
        "FoodAmount": 0.0,
        "DrinkAmount": 0.0,
        "ApplyVoucherType": 0,
        "VoucherAllAmount": 0.0,
        "VoucherFoodAmount": 0.0,
        "VoucherDrinkAmount": 0.0,
        "ExchangeRate": 0.0,
        "ExchangeAmount": 0.0
      }
    ],
     "SAVATInfo": {
      "VATID": "80469e2e-5ffd-4e1f-a826-ad789b4c3013",
      "RefID": "8ba889d0-a764-4eb5-b016-3673db10a99b",
      "ReceiverEIvoiceName": "abc",
      "Tel": "0378887459",
      "CompanyName": "ABC",
      "CompanyAddress": "HN",
      "TaxCode": "0100786940-993",
      "Email": "abc@gmail.com",
      "Status": true,
      "StatusReleaseEInvoice": 1,
      "EInvoiceNumber": "00000018",
      "StatusSendEmail": 0,
      "TransactionID": "6RT2CX1LZ1",
      "SellerTaxCode": "0109831978",
      "TemplateCode": "1",
      "InvoiceSeries": "1C23MIA",
      "RefDateReleaseEInvoice": "2023-03-28T10:25:54.933+07:00",
      "StatusSendToTax": 0,
      "AccountObjectIdentificationNumber": "CMND1234",
      "IsCalculatingMachinePublishing": true
    },
  },
  "Total": 0,
  "Success": true
}

Definitions

SAInvoice Definition

Property Type Format Mô tả
RefId string guid Id hóa đơn
RefType int Loại hóa đơn
RefNo string Số hóa đơn
RefDate datetime Ngày phát sinh hóa đơn
BranchId string guid Id chi nhánh
OrderId string guid Id đơn hàng được thanh toán
OrderType int Loại đơn hàng, xem tại đây
ShippingDate datetime Thời gian giao hàng
ShippingDueDate datetime Thời gian hẹn trả khách
CustomerId string guid Id khách hàng
CustomerName string Tên khách hàng
CustomerTel string Số điện thoại khách hàng
MembershipCardId string guid Id hạng thẻ của khách tại thời gian phát sinh hóa đơn
EmployeeId string guid Id nhân viên thu ngân
EmployeeName string Tên nhân viên thu ngân
DeliveryEmployeeId string guid Id nhân viên giao hàng
DeliveryEmployeeName string Tên nhân viên giao hàng
DeliveryPartnerID string guid Id đối tác giao hàng
DeliveryPartnerName string Tên đối tác giao hàng
WaiterEmployeeId string guid Tên nhân viên phục vụ
WaiterEmployeeName string Tên nhân viên phục vụ
ShippingAddress string Địa chỉ giao hàng (với đơn hàng giao tận nơi)
PromotionId string guid Id chương trình khuyến mại theo hóa đơn
PromotionName string Tên chương trình khuyến mại theo hóa đơn
TableName string Bàn được chọn (với đơn hàng phục vụ tại bàn)
Description string Ghi chú cho hóa đơn
DepositAmount decimal Tiền đặt cọc
Amount decimal Tiền hàng
DeliveryAmount decimal Phí giao hàng
ServiceRate decimal Tỷ lệ phí dịch vụ (tính theo %)
ServiceAmount decimal Phí dịch vụ
VATRate decimal Tỷ lệ thuế (tính theo %)
VATAmount decimal Tiền thuế
DiscountAmount decimal Số tiền khuyến mại
PromotionRate decimal Tỷ lệ khuyến mại theo hóa đơn (tính theo %)
PromotionAmount decimal Giảm giá theo hóa đơn
PromotionItemsAmount decimal Giảm giá các mặt hàng
ReceiveAmount decimal Số tiền đã trả
ReturnAmount decimal Số tiền trả lại cho khách
TotalAmount decimal Tổng thanh toán
SaleAmount decimal Doanh số
TotalItemAmount decimal Thành tiền
TotalItemAmountAfterTax decimal Thành tiền sau thuế
TipAmount decimal Tiền tip
ServiceTaxRate decimal Thuế suất cho phí dịch vụ
DeliveryTaxRate decimal Thuế suất cho phí giao hàng
CancelDate datetime Ngày hủy hóa đơn
CancelBy string Tên người hủy hóa đơn
CancelReason string Lý do hủy hóa đơn
PaymentStatus int Trạng thái thanh toán hóa đơn, xem tại đây[#paymentstatus-definition]
AvailablePoint int Số điểm có trước khi thanh toán hóa đơn
UsedPoint int Số điểm sử dụng trong hóa đơn
AddPoint int Số điểm tích được trong hóa đơn
SAInvoiceDetails Array<InvoiceDetail> Danh sách hàng hóa chi tiết trong hóa đơn
SAInvoicePayments Array<InvoicePayment> Danh sách thông tin thanh toán của hóa đơn
SAInvoiceCoupons Array<InvoiceCoupon> Danh sách các mã ưu đãi trong hóa đơn
SAVATInfo SAVATInfo Thông tin phát hành hóa đơn GTGT

OrderType Definition

Giá trị Mô tả
1 Đơn hàng phục vụ tại nhà hàng
2 Đơn hàng gói mang về
3 Đơn hàng giao tận nơi
4 Đặt chỗ trước

PaymentStatus Definition

Giá trị Mô tả
0 Chưa thanh toán
1 Chưa thu tiền
2 Ghi nợ
3 Đã thu tiền
4 Đã hủy
5 Tạm hủy

InvoiceDetail Definition

Property Type Format Mô tả
RefDetailId string guid Id detail hóa đơn
RefID string guid Id hóa đơn bán hàng
RefDetailType int Loại chi tiết, xem tại đây
ItemID string guid Id mặt hàng
ItemName string Tên mặt hàng
Quantity decimal Số lượng
UnitPrice decimal Đơn giá
UnitID string guid Id đơn vị tính
UnitName string Tên đơn vị tính
Amount decimal Thành tiền
DiscountRate decimal Tỷ lệ chiết khấu (tính theo %)
Description string Ghi chú
SortOrder int Thứ tự sắp xếp trong hóa đơn
ParentID string guid Id dòng cha
InventoryItemAdditionID string guid Id sở thích phục vụ
InventoryItemType int Loại mặt hàng, xem tại đây
IsSeftPrice bool Đơn giá thay đổi theo thời giá (true: có, false: không)
PromotionRate decimal Tỷ lệ khuyến mại (tính theo %)
PromotionType int Loại khuyến mại, xem tại đây
PromotionName string Tên khuyến mại
OrderDetailID string guid Id order detail
SAInvoicePromotionAmount decimal Tiền khuyến mại trên hóa đơn
RefDate datetime Ngày lập hóa đơn
ItemCode string Mã hàng
PromotionAmount decimal Tiền khuyến mại
InventoryItemCategoryID string guid Mã nhóm vật tư hàng hóa
AllocationAmount decimal Số tiền phân bổ của khuyến mại cho dòng chi tiết
PreTaxAmount decimal Tiền trước thuế của món
TaxRate decimal Thuế suất cho món (tính theo %)
TaxAmount decimal Tiền thuế cho món
AllocationDeliveryPromotionAmount decimal Phân bố chiết khấu giao hàng

InvoicePayment Definition

Property Type Format Mô tả
SAInvoicePaymentID string guid Id thông tin tin thanh toán
RefID string guid Id hóa đơn
RefNo string guid Số chứng từ của SAInvoice
PaymentType int Loại thanh toán, xem tại đây
Amount decimal Số tiền
CustomerID string guid Id khách ghi nợ
CustomerName string Tên khách ghi nợ
PaymentName string Tên loại thanh toán
VoucherID string guid Id thẻ voucher
VoucherQuantity int Số lượng voucher
VoucherAmount decimal Giá trị của voucher
VoucherCode string Mã voucher
VoucherName string Tên voucher
CardID string guid Id thẻ ngân hàng
CardName string Tên thẻ ngân hàng
ApplyVoucherType int Loại áp dụng voucher, xem tại đây
VoucherAllAmount decimal Số tiền khi áp dụng cho tất cả
VoucherFoodAmount decimal Số tiền khi chọn áp dụng món ăn
VoucherDrinkAmount decimal Số tiền khi chọn áp dụng đồ uống
CardNo string 4 số cuối thẻ ATM
ApprovalCode string Mã chuẩn chi
CustomerAddress string Địa chỉ khách hàng thanh toán
BankName string Tên tài khoản ngân hàng
BankAccountNumber string Số tài khoản
CurrencyID string guid Id đồng tiền thanh toán
MainCurrency string Đồng tiền chinh
ExchangeRate decimal Tỷ giá quy đổi
ExchangeAmount decimal Tiền quy đổi

InvoiceCoupon Definition

Property Type Format Mô tả
SAInvoiceCouponID string guid Id mã ưu đãi trong hóa đơn
RefID string guid Id hóa đơn
CouponID string guid Id mã ưu đãi
CouponCode string Mã ưu đãi
DiscountType int Loại ưu đãi (1: theo phần trăm, 2: theo số tiền)
DiscountPercent decimal Phần trăm giảm giá
DiscountAmount decimal Số tiền giảm giá
ApplyFromDate datetime Áp dụng từ ngày
ApplyToDate datetime Áp dụng đến ngày
ApplyCondition string Điều kiện áp dụng
IsUnlimitedApply bool Không giới hạn số lần áp dụng (true: không giới hạn, false: giới hạn số lần áp dụng)
ApplyFor string Áp dụng cho
InvoiceDiscountAmount decimal Số tiền khuyến mại hóa đơn

SAVATInfo Definition

Property Type Format Mô tả
VATID string guid Id hóa đơn điện tử
RefID string guid Id hóa đơn bán hàng
ReceiverEIvoiceName string Tên khách hàng
Tel string Số điện thoại
CompanyName string Tên công ty
CompanyAddress string Địa chỉ công ty
TaxCode string Mã số thuế
Email string Email người nhận hóa đơn
Status bool Khách có lấy hóa đơn giá trị gia tăng
StatusReleaseEInvoice int Trạng thái phát hành hóa đơn ,xem tại đây
EInvoiceNumber string Số hóa đơn khi phát hành hóa đơn điện tử
StatusSendEmail int Trạng thái gửi email cho khách hàng (0: chưa gửi, 1: đã gửi)
TransactionID string Transaction phát hành hóa đơn điện tử
SellerTaxCode string Mã số thuế tài khoản phát hành
TemplateCode string Mã mẫu số hóa đơn
InvoiceSeries string Ký hiệu của mẫu số hóa đơn
RefDateReleaseEInvoice datetime Ngày phát hành hóa đơn
StatusSendToTax int? Trạng thái gửi cơ quan thuế, xem tại đây
AccountObjectIdentificationNumber string Số cmnd/cccd
IsCalculatingMachinePublishing bool? Phát hành dưới máy tính tiền
ErrorNoteEinvoice string Ghi chú sai sót

RefDetailType Definition

Giá trị Mô tả
1 Món ăn
2 Món ăn thêm
3 Mặt hàng khác
4 Khuyến mại theo món ăn

PromotionType Definition

Giá trị Mô tả
1 Theo chương trình khuyến mại
2 Món mời
3 Khuyến mại khác

PaymentType Definition

Giá trị Mô tả
1 Tiền mặt
2 Thẻ ATM
3 Thẻ VISA
4 Thẻ Master Card
5 Ghi nợ
6 Thẻ voucher
7 Thẻ trả trước

ApplyVoucherType Definition

Giá trị Mô tả
1 Tất cả
2 Món ăn
3 Đồ uống
4 Tùy chọn

InventoryItemType Definition

Giá trị Mô tả
1 Món ăn
2 Món ăn theo nguyên vật liệu
3 Món ăn theo nhóm
4 Combo
5 Đồ uống đóng chai
6 Đồ uống pha chế
7 Mặt hàng khác
8 Nguyên vật liệu
10 Đồ uống theo nhóm

ServiceResult Definition

Property Type Format Mô tả
Code int Mã lỗi HttpCode (200, 500...)
ErrorType int Loại lỗi
ErrorMessage string Thông tin lỗi
Success bool True - không có lỗi logic xảy ra
Environment string Môi trường triển khai của api
Data string object Dữ liệu trả về client
Total int Tổng số bản ghi khi lấy dữ liệu phân trang

StatusReleaseEInvoice Definition

  • Trạng thái phát hành
Giá trị Mô tả
1 Đã phát hành
-1 Phát hành lỗi
0 Đang phát hành
-2 Chưa phát hành
2 Chờ cấp mã
3 Gửi lỗi
4 Đã cấp mã
5 Từ chối cấp mã

StatusSendToTax Definition

  • Trạng thái gửi cơ quan thuế
Giá trị Mô tả
0 Chưa gửi
1 Đã gửi
2 CQT tiếp nhận
3 CQT không tiếp nhận
4 Gửi lỗi

ErrorType Definition

  • Dải mã lỗi chung
HttpCode ServiceResult.ErrorType Mô tả
401 Chuỗi AccessToken hết hạn hoặc không hợp lệ cần phải gọi cấp phát lại
200 0 Không có lỗi
200 1 Tham số không hợp lệ null or empty
200 2 Mã nhà hàng không tồn tại
200 3 Mã Appid không tồn tại trên hệ thống
200 4 Chuỗi thông tin chữ ký đăng nhập không hợp lệ, timeout
200 5 Tham số lấy phân trang vượt quá số lượng cấu hình cho phép (max 100)
200 6 Tham số ngày giờ không hợp lệ (01/01/1753 - 31/12/9999)
200 7 Thiết lập kết nối CUKCUK đang ở trạng thái ngắt, không thể lấy dữ liệu
  • Dải mã lỗi nghiêm trọng
HttpCode ServiceResult.ErrorType Mô tả
200 100 Lỗi nội bộ API Graph
200 102 Request bị từ chối, do có request cùng loại đang xử lý. Vui lòng chờ xử lý xong hoặc chờ request đang xử lý timeout thì gọi lại.
Ví dụ: Khi đang gọi api login mà api chưa trả về dữ liệu lại tiếp tục gọi request login này sẽ trả về lỗi này.