Invoices API - Chi tiết hóa đơn

API thực hiện lấy thông tin chi tiết hóa đơn theo id hóa đơn master

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

Tên Mô tả
CompanyCode Mã cửa hàng lấy
AccessToken Chuỗi token xác thực
Environment Sub path để gọi request tới api lấy dữ liệu

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

About

URL Phiên bản
graphapi.mshopkeeper.vn/{Environment} 1.0

Schemes

Scheme
https

Endpoints

api/v1/invoices/detailbyrefid

POST

Lấy danh sách hàng hóa trong hóa đơn

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ã cửa hàng không tồn tại
200 7 Thiết lập kết nối MShopKeeper đ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
param body Đối tượng chứa thông tin lấy chi tiết hóa đơn true InvoiceDetailRequestParam
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ã cửa hàng CompanyCode true string

Ví dụ:

CompanyCode: demoquanao
Authorization: Bearer 06S1YMPgDJl65xE5tYzAJlNmVALHVHlLZg9euMUaUTO9C0Jm8TL3L4isto97ApKdQbVVX2rUJUTfXbBBipo1B5UvAgl3hwDYh8bNGVVUNp6B99Ht3KZQkwVh2SNblX-vulGSNatV-NF1KOfNJImOUsVXimxVEX3n2lnRV0A_mbJ_XP0sliGqbMzwa9YtY-jts4Iu06TaFOqBpBhndS-mofDlZlKkVqYklwy6cDzBktas7Xfi5MOsCujCDYO_0WFauBQCPDVnSj6ew_3Nm5ollwynkmErSmVf2E4cShM4700
Content Types Produced
Produces
application/json
Content Types Consumed
Consumes
application/json
Response

Trả về đối tượng ServiceResult với ServiceResult.Data là Array<InvoiceDetailInfo>

Example

Ví dụ gửi tham số gọi tới api

JSON InvoiceDetailRequestParam

{
  "RefID": "5998a94d-b13c-4b20-8892-b0774afea11d"
}

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

{
  "Code": 200,
  "Data": {
    "AmountReturn": 0.0,
    "DiscountAmountReturn": 0.0,
    "TotalAmountReturn": 0.0,
    "TotalItemAmount": 8650000.0,
    "DiscountAmount": 0.0,
    "TotalItemDiscountAmount": 0.0,
    "DeliveryAmount": 0.0,
    "VATAmount": 0.0,
    "DepositAmount": 0.0,
    "VoucherAmount": 0.0,
    "CashAmount": 8650000.0,
    "CardAmount": 0.0,
    "NotTakeChangeAmount": 0.0,
    "ChangeDeductedAmount": 0.0,
    "DebitAmount": 0.0,
    "ReturnCashAmount": 0.0,
    "ReturnCardAmount": 0.0,
    "ChangeAmount": 0.0,
    "ReturnExchangeAmount": 0.0,
    "ReduceDebtAmount": 0.0,
    "InvoiceType": 550,
    "InvoiceNumber": "1908010001",
    "OrderNumber": "DT000001",
    "InvoiceDate": "2019-08-01T16:41:11.643+07:00",
    "InvoiceTime": "2019-08-01T16:41:11.643+07:00",
    "BranchId": "8c3d6b0d-3b58-4379-bffb-1ccea7a7f884",
    "PaymentStatus": 3,
    "InvoiceDetailType": 0,
    "Cashier": "Nguyễn Văn Anh",
    "SaleStaff": "Nguyễn Văn Anh",
    "CustomerName": "Trần Nhi",
    "Tel": "0812345678",
    "DeliveryAddress": "số 1, ngõ 7, Phường Dịch Vọng, Quận Cầu Giấy, Hà Nội",
    "CustomerProvinceOrCity": "Hà Nội",
    "CustomerDistrict": "Quận Cầu Giấy",
    "CustomerWardOrCommune": "Phường Dịch Vọng",
    "CustomerStreet": "số 1, ngõ 7",
    "IsCOD": false,
    "IsDebit": false,
    "AdditionBillType": 0,
    "DebitCustomerId": "00000000-0000-0000-0000-000000000000",
    "CustomerId": "94319332-cbee-4676-9420-d5f8aa9d96ba",
    "Point": 0.0,
    "InvocieDetails": [
      {
        "InvoiceDetailType": 1,
        "SKU": "SCS01",
        "Name": "Set công sở: <i>\nVáy xòe (Đỏ): 1 Chiếc, \nÁo nữ cổ tròn: 1 Chiếc</i>",
        "EncodeInventoryItemName": "Set công sở: <i><br>Váy xòe (Đỏ): 1 Chiếc, <br>Áo nữ cổ tròn: 1 Chiếc</i>",
        "Quantity": 1.0,
        "UnitPrice": 400000.0,
        "Amount": 400000.0,
        "TotalAmount": 400000.0,
        "DiscountAmount": 0.0,
        "SortOrder": 1,
        "UnitName": "Bộ"
      },
      {
        "InvoiceDetailType": 1,
        "SKU": "ASM01-TR-28",
        "Name": "Áo sơ mi (Trắng/28)",
        "EncodeInventoryItemName": "Áo sơ mi (Trắng/28)",
        "Quantity": 1.0,
        "UnitPrice": 8000000.0,
        "Amount": 8000000.0,
        "TotalAmount": 8000000.0,
        "DiscountAmount": 0.0,
        "SortOrder": 2,
        "UnitName": "Thùng"
      },
      {
        "InvoiceDetailType": 1,
        "SKU": "ASM01-TR-28",
        "Name": "Áo sơ mi (Trắng/28)",
        "EncodeInventoryItemName": "Áo sơ mi (Trắng/28)",
        "Quantity": 1.0,
        "UnitPrice": 250000.0,
        "Amount": 250000.0,
        "TotalAmount": 250000.0,
        "DiscountAmount": 0.0,
        "SortOrder": 3,
        "UnitName": "Chiếc"
      }
    ]
  },
  "Total": 0,
  "Success": true,
  "Environment": "g1"
}

Definitions

InvoiceDetailRequestParam Definition

Tham số lấy dữ liệu chi nhánh cửa hàng

Property Type Format Mô tả
Page int Số trang lấy dữ liệu
Limit int Số bản ghi lấy trên 1 trang (max 100)
SortField string Tên trường cần sắp xếp mặc định InvoiceNumber - Số hóa đơn, các trường trong dữ liệu trả về
SortType int Chiều sắp xếp: 1 - tăng dần, 2 - giảm dần theo alphabet
FromDate string datetime (isodate) Lấy dữ liệu từ ngày, ví dụ: "2019-07-30T23:59:59.999Z"
ToDate string datetime (isodate) Lấy dữ liệu đến ngày
CustomerID string guid Id khách hàng cần lấy, truyền null nếu lấy toàn bộ khách hàng
BranchID string guid Id chi nhánh cần lấy, truyền null để lấy dữ liệu toàn bộ chi nhánh

InvoiceDetailInfo Definition

Property Type Format Mô tả
AmountReturn decimal Số tiền đổi trả
DiscountAmountReturn decimal Tổng số tiền khuyến mại đổi trả
TotalAmountReturn decimal Tổng số tiền đổi trả
TotalItemAmount decimal Tổng tiền hàng hóa (tổng tiền các mặt hàng trong hóa đơn)
DiscountAmount decimal Số tiền giảm giá toàn hóa đơn
TotalItemDiscountAmount decimal TotalItemDiscountAmount
DeliveryAmount decimal Tiền giao hàng
VATAmount decimal Tiền thuế giá trị gia tăng
DepositAmount decimal Số tiền ghi nợ
VoucherAmount decimal Số tiền thanh toán bằng voucher
CashAmount decimal Số tiền thanh toán bằng tiền mặt
CardAmount decimal Số tiền thanh toán bằng tiền gửi
NotTakeChangeAmount decimal Khách không lấy tiền thừa
ChangeDeductedAmount decimal Bớt tiền lẻ cho khách
DebitAmount decimal Số tiền khách nợ
ReturnCashAmount decimal Số tiền trả lại bằng tiền mặt
ReturnCardAmount decimal Số tiền trả lại bằng thẻ
ChangeAmount decimal Tiền trả lại khách
ReturnExchangeAmount decimal Tiền đổi trả
ReduceDebtAmount decimal Tiền giảm nợ
PromotionNames string Tên khuyến mại
InvoiceType int Loại hóa đơn: 550 - Bán hàng, 551 - Giao hàng, 552 - Nhập bù, 553 - Đổi trả
InvoiceNumber string Số hóa đơn
OrderNumber string Số đơn hàng
InvoiceDate datetime Ngày tạo hóa đơn
InvoiceTime datetime Giờ tạo hóa đơn
BranchId string guid Id chi nhánh bán hàng
PaymentStatus int Trạng thái hóa đơn
CustomerName string Tên khách hàng
Cashier string Tên thu ngân
SaleStaff string Tên nhân viên bán hàng
Tel string Số điện thoại khách hàng
DeliveryAddress string Địa chỉ giao hàng
CustomerProvinceOrCity string Địa chỉ khách hàng: tỉnh thành
CustomerDistrict string Địa chỉ khách hàng: quận huyện
CustomerWardOrCommune string Địa chỉ khách hàng: đường phố, số nhà
BaCustomerStreetrcode string Mã vạch
Barcode string Mã vạch
DeliveryDate string datetime Ngày giao hàng với hóa đơn giao hàng
DeliveryCode string Mã vận đơn
EcomOrderCode string Mã đơn trên sàn
MemberLevelName string Hạng thẻ
Note string Ghi chú
IsCOD bool true - Hóa đơn giao hàng thu COD(Cash On Delivery)
IsDebit bool true - Khách nợ
EmployeeName string Tên nhân viên bán hàng
AdditionBillType int Loại hóa đơn nhập bù: 1 - lập tại cửa hàng, 2 - lập bù giao hàng
SaleChannelName string Tên kênh bán hàng (Facebook, Shopee...)
ReturnExchangeRefNo string Số hóa đơn đổi trả
DebitCustomerId string guid Id khách hàng nợ
DebitCustomerName string Tên khách nợ
CustomerId string guid Id khách hảng trên hóa đơn
CustomerName string Tên khách nợ
InvocieDetails array Danh sách hàng hóa trong hóa đơn List<InvoiceDetail>

InvoiceDetail Definition

Property Type Format Mô tả
InvoiceDetailType int Loại chi tiết hàng hóa trên hóa đơn
ParentId string guid Id của mặt hàng gốc (áp dụng cho các dòng khuyến mại - khuyến mại cho hàng hóa nào)
Name string Tên hàng hóa
Quantity decimal Số lượng
ItemType int Loại mặt hàng: 1: Hàng Hoá, 2: Combo
UnitId string guid Id đơn vị tính
UnitName string Tên đơn vị tính
UnitPrice decimal Giá bán
Amount decimal Tiền hàng
TotalAmount decimal Thành tiền
DiscountAmount decimal Số tiền giảm giá toàn hóa đơn
SortOrder int Số thứ tự hiển thị trên hóa đơn

PaymentStatus Definition

Giá trị Mô tả
-1000 Không xác định
1 Chưa thanh toán
2 Ghi nợ
3 Đã thanh toán
4 Đã hủy
5 Giao hàng - Chờ giao hàng
6 Giao hàng - Đang giao hàng
7 Giao hàng - Thất bại
8 Giao hàng - Hoàn thành
9 Giao hàng - Đã chuyển hoàn
10 Giao hàng - Chờ thu COD

InvoiceDetailType Definition

Giá trị Mô tả
1 Hàng hóa để tính tiền
2 Loại khuyến mại theo mặt hàng
3 Hàng hóa trả lại
4 Loại Khuyến mại cho hàng hóa trả lại

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

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ã cửa 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 MShopKeeper đ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.