Invoices API - Danh sách hóa đơn theo KH

API thực hiện lấy danh sách hóa đơn theo khách hàng.

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	Thay đổi
graphapi.mshopkeeper.vn/{Environment}	1.0.0.8	Danh sách hóa đơn theo KH
graphapi.mshopkeeper.vn/{Environment}	1.0

Schemes

Scheme
https

Endpoints

api/v1/invoices/invoicebycustomer

POST

Lấy danh sách hóa đơn theo KH

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 lấy dữ liệu hóa đơn	true	InvoiceByCustomerRequestParam

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<Invoice> tổng số hàng hóa có trong hệ thống qua ServiceResult.Total

Example

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

JSON InvoiceByCustomerRequestParam

{
  "CustomerCode": "KH000012",
  "InvoiceNumber": "1908010001",
  "Limit": 100,
  "SortField": "InvoiceNumber",
  "SortType": "1"
}

Hệ thống sẽ trả về ServiceResult với Data là Array<Invoice> JSON response

{
  "Code": 200,
  "Data": [
    {
      "InvoiceId": "5998a94d-b13c-4b20-8892-b0774afea11d",
      "InvoiceType": 550,
      "InvoiceNumber": "1908010001",
      "InvoiceDate": "2019-08-01T16:41:11.643+07:00",
      "InvoiceTime": "2019-08-01T16:41:11.643+07:00",
      "BranchId": "8c3d6b0d-3b58-4379-bffb-1ccea7a7f884",
      "BranchName": "Chi nhánh số 2 - Cầu giấy",
      "TotalAmount": 8650000.0,
      "CostAmount": 0.0,
      "TaxAmount": 0.0,
      "TotalItemAmount": 8650000.0,
      "VATAmount": 0.0,
      "DiscountAmount": 0.0,
      "CashAmount": 8650000.0,
      "CardAmount": 0.0,
      "VoucherAmount": 0.0,
      "DebitAmount": 0.0,
      "ActualAmount": 8650000.0,
      "CustomerName": "Văn Bình",
      "Cashier": "Nguyễn Văn Anh",
      "SaleStaff": "Nguyễn Văn Anh",
      "PaymentStatus": 3,
      "Tel": "0812345678",
      "Address": "số 1, ngõ 7, Phường Dịch Vọng, Quận Cầu Giấy, Hà Nội",
      "IsCOD": false,
      "AdditionBillType": 0,
      "HasConnectedShippingPartner": false,
      "Point": 0.0
    },
    {
      "InvoiceId": "62fc6f29-4b81-4d65-9fa8-7ce0981b472f",
      "InvoiceType": 550,
      "InvoiceNumber": "1908010002",
      "InvoiceDate": "2019-08-01T16:42:37.233+07:00",
      "InvoiceTime": "2019-08-01T16:42:37.233+07:00",
      "BranchId": "8c3d6b0d-3b58-4379-bffb-1ccea7a7f884",
      "BranchName": "Chi nhánh số 2 - Cầu giấy",
      "TotalAmount": 5700000.0,
      "CostAmount": 0.0,
      "TaxAmount": 0.0,
      "TotalItemAmount": 5700000.0,
      "VATAmount": 0.0,
      "DiscountAmount": 0.0,
      "CashAmount": 5700000.0,
      "CardAmount": 0.0,
      "VoucherAmount": 0.0,
      "DebitAmount": 0.0,
      "ActualAmount": 5700000.0,
      "CustomerName": "Văn Bình",
      "Cashier": "Nguyễn Văn Anh",
      "SaleStaff": "Nguyễn Văn Anh",
      "PaymentStatus": 3,
      "Tel": "0812345678",
      "Address": "số 1, ngõ 7, Phường Dịch Vọng, Quận Cầu Giấy, Hà Nội",
      "IsCOD": false,
      "AdditionBillType": 0,
      "HasConnectedShippingPartner": false,
      "Point": 0.0
    },
    {
      "InvoiceId": "d8ab914f-0e80-44d6-9be9-5d77a5bca1ec",
      "InvoiceType": 551,
      "InvoiceNumber": "1908010004",
      "InvoiceDate": "2019-08-01T16:44:01.107+07:00",
      "InvoiceTime": "2019-08-01T16:44:01.107+07:00",
      "BranchId": "8c3d6b0d-3b58-4379-bffb-1ccea7a7f884",
      "BranchName": "Chi nhánh số 2 - Cầu giấy",
      "TotalAmount": 400000.0,
      "CostAmount": 0.0,
      "TaxAmount": 0.0,
      "TotalItemAmount": 400000.0,
      "VATAmount": 0.0,
      "DiscountAmount": 0.0,
      "CashAmount": 400000.0,
      "CardAmount": 0.0,
      "VoucherAmount": 0.0,
      "DebitAmount": 0.0,
      "ActualAmount": 400000.0,
      "CustomerName": "Văn Bình",
      "Cashier": "Nguyễn Văn Anh",
      "SaleStaff": "Nguyễn Văn Anh",
      "Note": "",
      "PaymentStatus": 8,
      "Tel": "0812345678",
      "Address": "số 1, ngõ 7, Phường Dịch Vọng, Quận Cầu Giấy, Hà Nội",
      "DeliveryDate": "2019-08-01T00:00:00+07:00",
      "IsCOD": false,
      "AdditionBillType": 0,
      "SaleChannelName": "Website",
      "HasConnectedShippingPartner": false,
      "Point": 0.0
    },
    {
      "InvoiceId": "12fbd099-4551-4d75-8817-0e9efb4ef7b2",
      "InvoiceType": 550,
      "InvoiceNumber": "1908010005",
      "InvoiceDate": "2019-08-01T16:44:17.793+07:00",
      "InvoiceTime": "2019-08-01T16:44:17.793+07:00",
      "BranchId": "8c3d6b0d-3b58-4379-bffb-1ccea7a7f884",
      "BranchName": "Chi nhánh số 2 - Cầu giấy",
      "TotalAmount": 1000000.0,
      "CostAmount": 0.0,
      "TaxAmount": 0.0,
      "TotalItemAmount": 1000000.0,
      "VATAmount": 0.0,
      "DiscountAmount": 0.0,
      "CashAmount": 1000000.0,
      "CardAmount": 0.0,
      "VoucherAmount": 0.0,
      "DebitAmount": 0.0,
      "ActualAmount": 1000000.0,
      "CustomerName": "Văn Bình",
      "Cashier": "Nguyễn Văn Anh",
      "SaleStaff": "Nguyễn Văn Anh",
      "PaymentStatus": 3,
      "Tel": "0812345678",
      "Address": "số 1, ngõ 7, Phường Dịch Vọng, Quận Cầu Giấy, Hà Nội",
      "IsCOD": false,
      "AdditionBillType": 0,
      "HasConnectedShippingPartner": false,
      "Point": 0.0
    }
  ],
  "Total": 4,
  "Success": true,
  "Environment": "g1"
}

Definitions

InvoiceByCustomerRequestParam Definition

Tham số lấy dữ liệu danh sách hóa đơn theo KH

Property	Type	Mô tả
CustomerCode	string	Mã KH
InvoiceNumber	string	Số hóa đơn
Limit	int	Số bản ghi cần lấy
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

Invoice Definition

Property	Type	Format	Mô tả
InvoiceId	string	guid	Id hóa đơn
InvoiceNumber	string		Số hóa đơn
InvoiceType	int		Loại mặt hàng: 1: Hàng Hoá, 2: Combo
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
BranchName	string		Tên chi nhánh
Barcode	string		Mã vạch
TotalAmount	decimal		Tổng tiền = tổng tiền hàng hóa + tiền phí + thuế - tiền khuyến mại
CostAmount	decimal		Tiền phí (phí giao hàng, đổi trả)
TaxAmount	decimal		Tiền thuế
TotalItemAmount	decimal		Tổng tiền hàng hóa (tổng tiền các mặt hàng trong hóa đơn)
VATAmount	decimal		Tiền thuế giá trị gia tăng
DiscountAmount	decimal		Số tiền giảm giá toàn hóa đơn
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
VoucherAmount	decimal		Số tiền thanh toán bằng voucher
DebitAmount	decimal		Số tiền khách nợ
ActualAmount	decimal		Số tiền thực thu
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
Note	string		Ghi chú
PaymentStatus	int		Trạng thái hóa đơn
Tel	string		Số điện thoại khách hàng
Address	string		Địa chỉ khách hàng
MemberLevelName	string		Hạng thẻ
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
IsCOD	bool		true - Hóa đơn giao hàng thu COD(Cash On Delivery)
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ả
HasConnectedShippingPartner	bool		True - Hóa đơn có kết nối đối tác giao hàng, false không

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

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

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	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.