MÔ TẢ KẾT NỐI GIỮA PHẦN MỀM KẾ TOÁN
VỚI CỔNG HÓA ÐƠN ÐIỆN TỬ THÔNG QUA CÁC HÀM API
A : Định nghĩa header api
key | value | description |
Content-Type | application/json | |
apikey | ********** | Giá trị cấp api cấp cho server |
sessionkey | ********** | Giá trị sessionKey được cấp bởi chương trình. |
B : Trạng thái
Trạng thái hóa đơn | Trạng thái ký số | |||
CREATED | Mới tạo | NOSIGN | Chưa ký | |
USING | Đang sử dụng | SIGNED | Đã ký | |
CANCEL | Đã hủy | CUSSIGNED | Khách hàng ký xác nhận | |
ADJUSTED | Đã điều chỉnh | |||
CHANGE | Đã thay thế | |||
DELETE | Đã xóa |
C : Mô tả hàm kết nối
1 Tạo hóa đơn
URI: /invoice/create
METHOD: POST
DATA INPUT
Request Header
key | value | description |
Content-Type | application/json | |
apikey | ********** | Giá trị cấp api cấp cho server |
sessionkey | ********** | Giá trị sessionKey được cấp bởi chương trình. |
Request Body
key | data type | require | description | |
CompanyName | String | x | Tên đơnvị phát hành hóa đơn | |
CompanyAddress | String | x | Địa chỉ đơn vị phát hành hóa đơn | |
CompanyTaxCode | String | x | Mã số thuế đơn vị phát hành | |
InvoiceForm | String | x | Mẫu hóa đơn | |
SerialNo | String | x | Ký hiệu | |
InvoiceDate | String | x | Ngày lập hóa đơn (yyyyMMdd) | |
PaymentDate | String | x | Ngày thanh toán (yyyyMMdd) | |
Tax | Number | x | Thuế suất | |
TotalTax | Number | x | Cộng tiền thuế | |
TotalBeforTax | Number | x | Cộng tiền hàng | |
TotalAfterTax | Number | x | Tổng tiền thanh toán | |
AmountWords | String | x | Số tiền bằng chữ | |
CurrencyCode | String | x | Loại tiền | |
ExchangeRates | Number | x | Tỷ giá | |
CustomerName | String | x | Tên khách hàng | |
CustomerTaxCode | String | x | Mã số thuế khách hàng | |
CustomerCompanyName | String | x | Tên đơn vị | |
CustomerAddress | String | x | Địa chị khách hàng | |
CustomerPhone | String | Số điện thoại khách hàng | ||
CustomerMobile | String | Di động | ||
CustomerFax | String | Fax | ||
CustomerEmail | String | x | Email khách hàng | |
CustomerWebsite | String | Website khách hàng | ||
CustomerBankAccountNo | String | Số TK khách hàng | ||
CustomerBankName | String | Tên ngân hàng | ||
CustomerPaymentMethodID | String | x | Hình thức thanh toán | |
Remark | String | Ghi chú | ||
InvoiceProducts | String | x | Danh sách sản phẩm | |
Id | String | Mã sản phẩm | ||
Name | String | x | Tên sản phẩm | |
Unit | String | x | Đơn vị tính | |
Quantity | Number | x | Số lượng | |
Cost | Number | x | Đơn giá | |
Amount | Number | x | Thành tiền |
DATA OUTPUT
key | value | description |
responsecode | Mã lỗi (0: thànhcông) | |
responsemessage | Mô tả lỗi | |
InvoiceNo | Số hóa đơn mới tạo | |
InvoiceStatus | Trạng thái hóa đơn |
2 Cập nhật thông tin hóa đơn
URI: /invoice/update/{invoiceNumber}
METHOD: PUT
DATA INPUT
Request Header
key | value | description |
Content-Type | application/json | |
apikey | ********** | Giá trị cấp api cấp cho server |
sessionkey | ********** | Giá trị sessionKey được cấp bởi chương trình. |
Request Body
key | data type | require | description | |
CompanyName | String | x | Tên đơn vị phát hành hóa đơn | |
CompanyAddress | String | x | Địa chỉ đơn vị phát hành hóa đơn | |
CompanyTaxCode | String | x | Mã số thuế đơn vị phát hành | |
InvoiceForm | String | x | Mẫu hóa đơn | |
SerialNo | String | x | Ký hiệu | |
InvoiceDate | String | x | Ngày lập hóa đơn (yyyyMMdd) | |
PaymentDate | String | x | Ngày thanh toán (yyyyMMdd) | |
Tax | Number | x | Thuế suất | |
TotalTax | Number | x | Cộng tiền thuế | |
TotalBeforTax | Number | x | Cộng tiền hàng | |
TotalAfterTax | Number | x | Tổng tiền thanh toán | |
AmountWords | String | x | Số tiền bằng chữ | |
CurrencyCode | String | x | Loại tiền | |
ExchangeRates | Number | x | Tỷ giá | |
CustomerName | String | x | Tên khách hàng | |
CustomerTaxCode | String | x | Mã số thuế khách hàng | |
CustomerCompanyName | String | x | Tên đơnvị | |
CustomerAddress | String | x | Địa chị khách hàng | |
CustomerPhone | String | Số điện thoại khách hàng | ||
CustomerMobile | String | Di động | ||
CustomerFax | String | Fax | ||
CustomerEmail | String | x | Email khách hàng | |
CustomerWebsite | String | Website khách hàng | ||
CustomerBankAccountNo | String | Số TK khách hàng | ||
CustomerBankName | String | Tên ngân hàng | ||
CustomerPaymentMethodID | String | x | Hình thức thanh toán | |
Remark | String | Ghi chú | ||
InvoiceProducts | String | x | Danh sách sản phẩm | |
Id | String | Mã sản phẩm | ||
Name | String | x | Tên sản phẩm | |
Unit | String | x | Đơn vị tính | |
Quantity | Number | x | Số lượng | |
Cost | Number | x | Đơn giá | |
Amount | Number | x | Thành tiền |
DATA OUTPUT
key | value | description |
responsecode | Mã lỗi (0: thànhcông) | |
responsemessage | Mô tả lỗi |
3 Xóa hóa đơn cuối cùng chưa ký
URI: /invoice/deleteLastInvoiceNoSign/{invoiceNumber}
METHOD: DELETE
DATA INPUT
Request Header
key | value | description |
Content-Type | application/json | |
apikey | ********** | Giá trị cấp api cấp cho server |
sessionkey | ********** | Giá trị sessionKey được cấp bởi chương trình. |
Request Body
key | data type | require | description | |
CompanyTaxCode | String | x | Mã số thuế đơn vị phát hành | |
InvoiceForm | String | x | Mẫu hóa đơn | |
SerialNo | String | x | Ký hiệu | |
InvoiceDate | String | x | Ngày lập hóa đơn (yyyyMMdd) |
DATA OUTPUT
key | value | description |
responsecode | Mã lỗi (0: thànhcông) | |
responsemessage | Mô tả lỗi |
4 Xem trạng thái hóa đơn
URI: /invoice/getStatus
METHOD: POST
DATA INPUT
Request Header
key | value | description |
Content-Type | application/json | |
apikey | ********** | Giá trị cấp api cấp cho server |
sessionkey | ********** | Giá trị sessionKey được cấp bởi chương trình. |
Request Body
key | data type | require | description | |
CompanyTaxCode | String | x | Mã số thuế đơn vị phát hành | |
InvoiceForm | String | x | Mẫu hóa đơn | |
SerialNo | String | x | Ký hiệu | |
InvoiceNo | String | x | Số hóa đơn | |
InvoiceDate | String | x | Ngày lập hóa đơn (yyyyMMdd) |
DATA OUTPUT
key | value | description |
responsecode | Mã lỗi (0: thànhcông) | |
responsemessage | Mô tả lỗi | |
InvoiceStatus | Trạng thái hóa đơn | |
SignStatus | Trạng thái ký số |
5 Xem thông tin mẫu hóa đơn của nhà phát hành
URI: /invoice/getIssuerFormInvoice
METHOD: GET
DATA INPUT
Request Header
key | value | description |
Content-Type | application/json | |
apikey | ********** | Giá trị cấp api cấp cho server |
sessionkey | ********** | Giá trị sessionKey được cấp bởi chương trình. |
Request Body (NONE)
key | data type | require | description |
DATA OUTPUT
key | value | description |
responsecode | Mã lỗi (0: thànhcông) | |
responsemessage | Mô tả lỗi | |
IssuerTaxCode | Mã số thuế nhà phát hành | |
IsssuerName | Tên nhà phát hành | |
FormInvoices | Danh sách mẫu hóa đơn | |
InvoiceFormCode | Mẫu số | |
SignsInvoice | Ký hiệu |
6 Liệt kê danh sách hóa đơn theo ngày
URI: /invoice/getBillsByDate
METHOD: POST
DATA INPUT
Request Header
key | value | description |
Content-Type | application/json | |
apikey | ********** | Giá trị cấp api cấp cho server |
sessionkey | ********** | Giá trị sessionKey được cấp bởi chương trình. |
Request Body
key | data type | require | description |
FromDate | String | x | Từ ngày (yyyyMMdd) |
ToDate | String | x | Đến ngày (yyyyMMdd) |
Status | String | Trạng thái hóa đơn |
DATA OUTPUT
key | value | description |
responsecode | Number | Mã lỗi (0: thànhcông) |
responsemessage | String | Mô tả lỗi |
[bills] | List | Danh sách hóa đơn |
EinvoiceNumber | String | Số hóa đơn |
InvoiceFormCode | String | Mẫu hóa đơn |
SignsInvoice | String | Ký hiệu |
CreateDate | String | Ngày tạo (yyyyMMdd) |
CustomerEmail | String | Email khách hàng |
CustomerTaxCode | String | Mã số thuế khách hàng |
CompanyName | String | Tên đơn vị |
AmountNotVAT | Number | Số tiền chưa VAT |
AmountVAT | Number | Số tiền VAT |
SumAmount | Number | Tổng tiền |
UserCreate | String | User tạo |
EinvoiceStatus | String | Trạng thái hóa đơn |
SignStatus | String | Trạng thái ký số |