Bảng hàm API kết nối Hoá đơn điện tử VNPT

  • 2,6K Lượt xem
  • Bài cuối 14 Tháng Mười Hai 2018
khaibl đăng này 13 Tháng Mười Hai 2018

Xem file đính kèm

TÀI LIỆU MÔ TẢ WEBSERVICE HĐĐT

 

I.    Mô hình tích hợp:

1.  Thủ tục Cập nhật khách hàng

 

   

 

 

2.  Thủ tục Phát hành hóa đơn

 

   

 

 

3.  Thủ tục Thanh toán gạch nợ

 

   

 

   Ghi chú: Các tham số sau VNPT sẽ cung cấp ngay khi VNPT dựng xong portal  cho khách hàng:

-       Account/ACPass: Tài khoản được cấp phát cho nhân viên gọi lệnh phát hành hóa đơn.

-       username/pass: Tài khoản được cấp phát cho khách hàng để gọi service.

-       pattern, serial: Mẫu số và ký hiệu hóa đơn (VNPT sẽ tạo pattern, serial mẫu hỗ trợ cho việc tích hợp kiểm thử ban đầu; sau đó sẽ chỉnh lại theo pattern và serial mà khách hàng đã đăng ký với cục thuế).


II.    Phương thức tích hợp

-     Giao thức trao đổi thông tin giữa phần mềm và hệ thống HĐĐT: Thông qua cuộc gọi hàm webservice.

 

III.    Mô tả đầu hàm

1.  Cập nhật dữ liệu khách hàng

Int UpdateCus (string xmlCusData, string username, string pass, int convert)

Mô tả

·       xmlCusData: String XML dữ liệu khách hàng

·       username/pass: Tài khoản cung cấp cho nhân viên có quyền để gọi service

·       convert: Mặc định là 0, 0 – Không cần convert từ TCVN3 sang Unicode. 1- Cần convert từ TCVN3 sang Unicode

·       Trả về: giá trị Int thông báo kết quả/Lỗi gặp phải

 

Kết quả trả về

Mô tả

Ghi chú

-1

Tài khoản đăng nhập sai

hoặc không có quyền

 

-2

Không import được khách

hàng vào db

Có rollback db

-3

Dữ liệu xml đầu vào không

đúng quy định

Chỉ cần 1 customer trong chuỗi xml không hợp lệ, không thực hiện update trên tất cả dữ liệu đưa vào

-5

Có khách hàng đã tồn tại

Có rollback db

N

Số lượng khách hàngã đ

import và update

N>0, N là kiểu integer

 

Cấu trúc của xmlCusData (các trường * là bắt buộc):

<Customers>

<Customer>

<Name>Tên khách hàng*</Name>

<Code>Mã khách hàng*</Code>

<TaxCode>Mã số thuế (bắt buộc với khách hàng là doanh nghiệp)</TaxCode>


<Address>Địa chỉ thanh toán*</Address>

<BankAccountName>Tên tài khoản ngân hàng</BankAccountName>

<BankName>Tên ngân hàng</BankName>

<BankNumber>Số tài khoản</BankNumber>

<Email>Email*</Email>

<Fax>Số fax</Fax>

<Phone>Điện thoại</Phone>

<ContactPerson>Liên hệ</ContactPerson>

<RepresentPerson>Người đại diện</RepresentPerson>

<CusType>Loại khách hàng (1: Doanh nghiệp/0: Cá nhân)*</CusType>

</Customer>

<Customer>...</Customer>

</Customers>

 

2.  Gán chứng thư cho khách hàng

Int setCusCert(string certSerial, string certString, string cusCode, string username, string pass)

Mô tả

 

·       certSerial: chuỗi serial của chứng thư cần gán

·       certString: chuỗi chứng thư cần gán(base64)

·       cusCode: mã khách hàng

·       username/pass: Tài khoản cung cấp cho nhân viên có quyền để gọi service

·       Trả về: giá trị Int thông báo kết quả/Lỗi gặp phải

 

 

Kết quả trả về

Mô tả

Ghi chú

-1

Tài khoản đăng nhập sai

hoặc không có quyền

 

-2

Chuỗi certString không hợp lệ hoặc không khớp với

certSerrial

 

-3

Không  tồn  tại  khách  hàng

tương   ứng   với             cusCode, hoặc khách  hàng ko  phải là

 

 

 

đơn vị kế toán

-5

Không update được cert cho

khách hàng

-7

Không tồn tại doanh nghiệp

tương ứng với tài khoản

1

Gán cert thành công


 

 

3.  Phát hành hóa đơn

String ImportAndPublishInv(string Account, string ACpass, string xmlInvData, string username, string pass, string pattern, string serial, int convert).

Mô tả

 

·       Account/ACPass : Tài khoản được cấp phát cho nhân viên gọi lệnh phát hành hóa

đơn

·       username/pass: Tài khoản được cấp phát cho khách hàng để gọi service.

·       xmlInvData: String XML dữ liệu hóa đơn

·       convert: Mặc định là 0, 0 – Không cần convert từ TCVN3 sang Unicode. 1- Cần convert từ TCVN3 sang Unicode

·       pattern, serial: mẫu số và ký hiệu hóa đơn.

·       Trả về: String kết quả

 

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

hoặc không có quyền

 

ERR

Dữ liệu xml đầu vào

không đúng quy định

Chỉ cần 1 invoice trong chuỗi xml không hợp lệ, không thực hiện phát hành trên tất cả dữ liệu đưa vào

ERR:5

Không phát hành được

DB roll back

 

Kết quả trả về

Mô tả

Ghi chú

 

hóa đơn

 

ERR:6

Không đủ số hóa đơn

cho lô phát hành

 

ERR:7

User name không phù hợp, không tìm thấy company tương ứng cho

user.

 

ERR:10

Lô có số hóa đơn vượt

quá max cho phép

 

ERR:20

Pattern và serial không phù hợp, hoặc không tồn tại  hóa  đơn ãđđăng  kí có sử dụng Pattern và serial truyền vào

Chỉ chấp nhận đồng thời nhập cả Pattern và serial hoặc đồng thời để trống cả pattern và serial      

OKattern;serial1- key1_num1,key2_num12,key3_num3…

 

(Ví dụ: OK:01GTKT3/001;AA/12E-

key1_1,key2_2,key3_3,key4_4,key5_5)

-   OK € đã phát hành    hóa    đơn thành công

-   Pattern   € Mẫu số của  các hóa đơn đã phát hành

-   Serial1 € serial của dãy các hóa đơn phát hành

-   num1,  num2… là các số hóa đơn

-   key1,key2… là khóa để nhận biết hóa đơn phát hành cho khách hàng nào(lấy từ đầu vào)

-     Cách      hóa

đơn         

serial   khác nhau    phân

cách       bởi dấu “;”

- Các số hóa đơn phân cách bởi “,”

 

Note:

 

Tiền tố ERR € có lỗi khi thực hiện hàm

 

Tiền tố OK € thực hiện phát hành hóa đơn thành công

Chỉ chấp nhận phát hành lô tối đa 5000 hóa đơn.


Cấu trúc của xmlInvData (các trường * là bắt buộc):

 

<Invoices>

<Inv>

<key>Giá trị khóa để phân biệt hóa đơn xuất cho khách hàng nào</key>

<Invoice>

<CusCode>Mã khách hàng*</CusCode>

<CusName>Tên khách hàng*</CusName>

<CusAddress>Địa chỉ khách hàng*</CusAddress>

<CusPhone>Điện thoại khách hàng</CusPhone>

<CusTaxCode>Mã số thuế KH (Bắt buộc với KH là Doanh nghiệp)</CusTaxCode>

<PaymentMethod>Phương thức thanh toán</PaymentMethod>

<KindOfService>Tháng hóa đơn</KindOfService>

<Products>

<Product>

<ProdName>Tên sản phẩm*</ProdName>

<ProdUnit>Đơn vị tính</ProdUnit>

<ProdQuantity>Số lượng</ProdQuantity>

<ProdPrice>Đơn giá</ProdPrice>

<Amount>Tổng tiền*</Amount>

</Product>

</Products>

<Total>Tổng tiền trước thuế*</Total>

<DiscountAmount>Tiền giảm trừ</ DiscountAmount>

<VATRate>Thuế GTGT*</VATRate>

<VATAmount>Tiền thuế GTGT*</VATAmount>

<Amount>Tổng tiền*</Amount>

<AmountInWords>Số tiền viết bằng chữ*</AmountInWords>

<Extra>Các nội dung mở rộng</Extra>

<ArisingDate>Ngày phát hành hóa đơn</ArisingDate>


<PaymentStatus>Trạng thái thanh toán hóa đơn ban đầu(0,1 – chưa thanh toán, đã thanh toán)</PaymentStatus>

<ResourceCode>Mã vùng dữ liệu</ResourceCode>

</Invoice>

</Inv>

<Inv>...</Inv>

</Invoices>

 

4.  Gạch nợ hóa đơn theo Fkey

String confirmPaymentFkey(string lstFkey, string userName, string userPass)

Mô tả:

 

·       lstFkey: Chuỗi Fkey xác định hóa đơn cần lấy(các Fkey phân biệt nhau bằng “_&rdquo

VD: 012013_022013_032013

 

·       userName/userPass*: user name/password để gọi webservices (Do hệ thống HĐĐT

cung cấp)

·       String trả về:

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

 

ERR:6

Không tìm thấy hóa đơn

tương ứng chuỗi đưa vào

 

ERR:7

Không gạch nợ được

 

ERR:13

Hóa  đơn ãđ đư    ợc gạch

nợ

 

“OK”

Đánh dấu hóa đơn trong list đã được gạch nợ

 

 

 

5.  Thanh toán, Gạch nợ hóa đơn

String confirmPayment(string lstInvToken, string userName, string userPass)

Mô tả:

 

·       lstInvToken:     Chuỗi    token    xác    định    hóa    đơn                          cần        lấy(theo          cấu      trúc patternt;serial;sốhóađơn)

VD: 01GTKT2/001;AA/13E;10_01GTKT2/001;AA/13E;11

 

·       userName/userPass*: user name/password để gọi webservices (Do hệ thống HĐĐT

cung cấp)


·       String trả về:

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

 

ERR:6

Không tìm thấy hóa đơn

tương ứng chuỗi đưa vào

 

ERR:7

Không gạch nợ được

 

ERR:13

Hóa  đơn ãđ đư    ợc gạch

nợ

 

“OK”

Đánh dấu hóa đơn trong list đã được gạch nợ

 

 

6.  Bỏ gạch nợ hóa đơn theo FKey

String UnconfirmPaymentFkey(string lstFkey, string userName, string userPass)

Mô tả:

 

·       lstFkey: Chuỗi Fkey xác định hóa đơn cần lấy(các Fkey phân biệt nhau bằng “_&rdquo

VD: 012013_022013_032013

 

·       userName/userPass*: user name/password để gọi webservices (Do hệ thống HĐĐT

cung cấp)

·       String trả về:

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

 

ERR:6

Không tìm thấy hóa đơn

tương ứng chuỗi đưa vào

 

ERR:7

Không bỏ gạch nợ được

 

ERR:13

Hóa   đơn ã đđư             ợc bỏ

gạch nợ

 

“OK”

Đánh dấu hóa đơn trong list đã bỏ gạch nợ

 

 

 

7.  Điều chỉnh hóa đơn

String adjustInv (string Account, string ACpass, string xmlInvData, string username, string password, string fkey, int convert).


Mô tả

 

·       Account/ACPass : Tài khoản được cấp phát cho nhân viên gọi lệnh phát hành hóa

đơn

·       Username/pass: Tài khoản được cấp phát cho khách hàng để gọi service.

·       xmlInvData: String XML dữ liệu hóa đơn cũ và hóa đơn điều chỉnh

·       fkey: Chuỗi key xác định hóa đơn cần điều chỉnh

·       Convert: Mặc định là 0, 0 – Không cần convert từ TCVN3 sang Unicode. 1- Cần convert từ TCVN3 sang Unicode

·       Trả về: String kết quả

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai hoặc không có

quyền

 

ERR:2

Hóa đơn cần điều

chỉnh không tồn tại

 

ERR

Dữ liệu xml đầu vào

không đúng quy định

 

ERR:5

Không phát hành

được hóa đơn

 

ERR:6

Dải hóa đơn cũ đã hết

 

ERR:7

User name không phù hợp, không tìm thấy company tương ứng

cho user.

 

ERR:8

Hóa đơn cần điều chỉnh đã bị thay thế. Không thể điều chỉnh

được nữa.

 

ERR:9

Trạng thái hóa đơn không được điều

chỉnh

 

OK: pattern;serial;key_invNumber (Ví dụ:

OK:01GTKT3/001;AA/12E;key_0000002)

-   OK € đã phát hành hóa đơn thành công

-   Patter€                      Mẫu số của hóa đơn điều chỉnh

-   Serial €

 

Kết quả trả về

Mô tả

Ghi chú

 

serial của hóa đơn điều chỉnh

-       invNumber: số hóa đơn điều chỉnh

-       key: khóa để xác định hóa đơn

 

Note:

 

Tiền tố ERR € có lỗi khi thực hiện hàm

 

Tiền tố OK € thực hiện điều chỉnh hóa đơn thành công

 

 

Cấu trúc của xmlInvData (các trường * là bắt buộc):

 

<AdjustInv>

<key>Khóa cho hóa đơn mới</key >

<CusCode>Mã khách hàng*</CusCode>

<CusName>Tên khách hàng*</CusName>

<CusAddress>Địa chỉ khách hàng*</CusAddress>

<CusPhone>Điện thoại khách hàng</CusPhone>

<CusTaxCode>Mã số thuế KH (Bắt buộc với KH là Doanh nghiệp)</CusTaxCode>

<PaymentMethod>Phương thức thanh toán</PaymentMethod>

 

<KindOfService>Tháng hóa đơn</KindOfService>

<Type>Loại hóa đơn chỉnh sửa(int-mặc định lấy là 2) 2-Điều chỉnh tăng, 3-Điều chỉnh giảm, 4- Hóa đơn điều chỉnh thông tin</Type>

<Products>

 

<Product>

<ProdName>Tên sản phẩm*</ProdName>

<ProdUnit>Đơn vị tính</ProdUnit>

<ProdQuantity>Số lượng</ProdQuantity>


<ProdPrice>Đơn giá</ProdPrice>

<Amount>Tổng tiền*</Amount>

</Product>

</Products>

<Total>Tổng tiền trước thuế*</Total>

<VATRate>Thuế GTGT*</VATRate>

<VATAmount>Tiền thuế GTGT*</VATAmount>

<Amount>Tổng tiền*</Amount>

<AmountInWords>Số tiền viết bằng chữ*</AmountInWords>

<Extra>Các nội dung mở rộng</Extra>

<ArisingDate>Ngày phát hành hóa đơn</ArisingDate>

<PaymentStatus>Trạng thái thanh toán hóa đơn ban đầu(0,1 – chưa thanh toán, đã thanh toán)</PaymentStatus>

<ResourceCode>Mã vùng dữ liệu</ResourceCode>

</AdjustInv>

 

8.  Thay thế hóa đơn

String replaceInv (string Account, string ACpass, string xmlInvData, string username, string password, string fkey, int convert).

Mô tả

 

·       Account/ACPass : Tài khoản được cấp phát cho nhân viên gọi lệnh phát hành hóa

đơn

·       Username/pass: Tài khoản được cấp phát cho khách hàng để gọi service.

·       xmlInvData: String XML dữ liệu hóa đơn cũ và hóa đơn thay thế

·       fkey: Chuỗi key xác định hóa đơn cần thay thế

·       convert: Mặc định là 0, 0 – Không cần convert từ TCVN3 sang Unicode. 1- Cần convert từ TCVN3 sang Unicode

·       Trả về: String kết quả

 

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập

 

 

sai hoặc không có

quyền

 

ERR:2

Không tồn tại hóa

đơn cần thay thế

 

ERR

Dữ liệu xml đầu vào

không đúng quy định

 

ERR:5

Có lỗi trong quá trình

thay thế hóa đơn

DB roll

back

ERR:6

Dải hóa đơn cũ đã hết

 

ERR:7

User name không phù hợp, không tìm thấy company tương ứng

cho user.

 

ERR:8

Hóa đơn đã được thay

thế rồi. Không thể thay thế nữa.

 

ERR:9

Trạng thái hóa đơn ko

được thay thế

 

OK: pattern;serial;key_invNumber (Ví dụ:

OK:01GTKT3/001;AA/12E;key_0000001)

-   OK € đã thay thế hóa đơn thành công

-   Patterm € Mẫu số của hóa đơn thay thế

-   Serial € serial của hóa đơn thay thế

-   invNumber:số hóa đơn thay thế cho hóa đơn cũ

-   key: khóa xác định hóa đơn mới

 

 

Note:

 

Tiền tố ERR € có lỗi khi thực hiện hàm

 

Tiền tố OK € thực hiện thay thế hóa đơn thành công


Cấu trúc của xmlInvData (các trường * là bắt buộc):

 

< ReplaceInv>

<key>Khóa cho hóa đơn mới</key>

<CusCode>Mã khách hàng*</CusCode>

<CusName>Tên khách hàng*</CusName>

<CusAddress>Địa chỉ khách hàng*</CusAddress>

<CusPhone>Điện thoại khách hàng</CusPhone>

<CusTaxCode>Mã số thuế KH (Bắt buộc với KH là Doanh nghiệp)</CusTaxCode>

<PaymentMethod>Phương thức thanh toán</PaymentMethod>

 

<KindOfService>Tháng hóa đơn</KindOfService>

<Products>

<Product>

<ProdName>Tên sản phẩm*</ProdName>

<ProdUnit>Đơn vị tính</ProdUnit>

<ProdQuantity>Số lượng</ProdQuantity>

<ProdPrice>Đơn giá</ProdPrice>

<Amount>Tổng tiền*</Amount>

</Product>

</Products>

<Total>Tổng tiền trước thuế*</Total>

<VATRate>Thuế GTGT*</VATRate>

<VATAmount>Tiền thuế GTGT*</VATAmount>

<Amount>Tổng tiền*</Amount>

<AmountInWords>Số tiền viết bằng chữ*</AmountInWords>

<Extra>Các nội dung mở rộng</Extra>

<ArisingDate>Ngày phát hành hóa đơn</ArisingDate>

<PaymentStatus>Trạng thái thanh toán hóa đơn ban đầu(0,1 – chưa thanh toán, đã thanh toán)</PaymentStatus>

<ResourceCode>Mã vùng dữ liệu</ResourceCode>

</ ReplaceInv>


9.  Lấy hóa đơn theo khách hàng

String listInvByCus(string cusCode, string fromDate, string toDate, string userName, string userPass)

Mô tả:

 

·       cusCode*: Mã đơn vị cần lấy hóa đơn về

·       fromDate: ngày bắt đầu tìm kiếm. String theo định dạng dd/MM/yyyy (20/05/2013). Nếu truyền vào null tìm kiếm theo tất cả các ngày

·       toDate: ngày kết thúc tìm kiếm. String theo định dạng dd/MM/yyyy. Nếu truyền vào null tìm kiếm theo tất cả các ngày

·       userName/userPass*: account/password để gọi web services. Do Hệ thống HĐĐT

cung cấp.

·       Trả về: string kết quả cụ thể được mô tả dưới đây

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

 

ERR

Không tồn tài khách hàng tương ứng với cusCode

 

ERR:4

Công ty chưa được đăng kí mẫu hóa đơn nào

 

ERR:7

User name không phù hợp, không tìm thấy company tương ứng cho

user.

 

OK:

chuỗi_xml_trả_về

thông tin các hóa đơn đã phát hành, đã sửa đổi, đã thay thế, đã sử dụng của công ty, cấu trúc dưới dạng chuỗi xml. Mỗi thẻ <Inv> tương ứng với một hóa đơn

Thẻ <status> chứa trạng thái hóa đơn: 1- hóa đơn đã phát hành, 3 -  hóa đơn bị thay thế, 4- hóa đơn bị điều chỉnh

Trả về một string xml

Cấu trúc của chuỗi xml trả về


<Data>

<Item > //tương ứng với 1 hóa đơn

<index>Tháng xuất hóa đơn </index>

<fkey>Fkey để xác định hóa đơn </fkey >

<name>Tên hóa đơn</name>

<publishDate>Ngày phát hành hóa đơn</publishDate>

<signStatus>Trạng thái kí khách hàng</signStatus>

<pattern>Mẫu hóa đơn<pattern>

<serial>Serial hóa đơn</serial>

<invNum>Số hóa đơn</invNum>

<payment>Trạng thái thanh toán (0/1)</payment>

<Amount>Tổng tiền của hóa đơn </Amount>

<status>Trạng thái hóa đơn(1,3,4)</status >

 

</Item >

 

<Item ></Item >….Hóa đơn khác

</Data>

 

10.  Hàm tìm hóa đơn theo Fkey

String listInvByCusFkey(string fkey, string fromDate, string toDate, string userName, string userPass)

Mô tả:

 

·       fkey*: Mã xác định hóa đơn

·       fromDate: ngày bắt đầu tìm kiếm. String theo định dạng dd/MM/yyyy (20/05/2013). Nếu truyền vào null tìm kiếm theo tất cả các ngày

·       toDate: ngày kết thúc tìm kiếm. String theo định dạng dd/MM/yyyy. Nếu truyền vào null tìm kiếm theo tất cả các ngày

·       userName/userPass*: account/password để gọi web services. Do Hệ thống HĐĐT

cung cấp.

·       Trả về: string kết quả cụ thể được mô tả dưới đây

 

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

 

ERR:4

Công ty chưa được đăng kí mẫu hóa đơn nào

 

ERR:7

User name không phù hợp, không tìm thấy company tương ứng cho

user.

 

OK:

chuỗi_xml_trả_về

thông tin các hóa đơn đã phát hành, đã sửa đổi, đã thay thế, đã sử dụng của công ty, cấu trúc dưới dạng chuỗi xml. Mỗi thẻ <Inv> tương ứng với một hóa đơn

Thẻ <status> chứa trạng thái hóa đơn: 1- hóa đơn đã phát hành, 3 -  hóa đơn bị thay thế, 4- hóa đơn bị điều chỉnh

Trả về một string xml

 

 

Cấu trúc của chuỗi xml trả về

<Data>

<Item > //tương ứng với 1 hóa đơn

<index>Tháng xuất hóa đơn </index>

<cusCode>Tên hóa đơn</cusCode>

<name>Tên hóa đơn</name>

<publishDate>Ngày phát hành hóa đơn</publishDate>

<signStatus>Trạng thái kí khách hàng</signStatus>

<pattern>Mẫu hóa đơn<pattern>

<serial>Serial hóa đơn</serial>

<invNum>Số hóa đơn</invNum>

<payment>trạng thái thanh toán hóa đơn (0/1)</payment>

<amount>Tổng tiền của hóa đơn </amount>

<status>Trạng thái hóa đơn(1,3,4)</status >

 

</Item >

 

<Item ></Item >….Hóa đơn khác

</Data>

 

11.  Lấy thông tin chi tiết hóa đơn

String getInvView(string invToken, string userName, string userPass)

Mô tả:

 

·       invToken : Chuỗi token xác định hóa đơn cần lấy

·       userName/userPass*: user name/password để gọi webservices (Do hệ thống

HĐĐT cung cấp)

·       String trả về:


 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

 

ERR:4

Không tìm thấy Pattern

 

ERR:6

Không tìm thấy hóa đơn

 

ERR:7

User name không phù hợp, không tìm thấy company tương ứng cho

user.

 

ERR:11

Hóa đơn chưa thanh toán

nên không xem được

 

chuỗi_hml_trả_về

Trả về chuỗi hml tương ứng với hóa đơn

Trả về một hóa đơn dưới dạng html

 

12.  Lấy thông tin chi tiết hóa đơn theo Fkey

String getInvViewFkey(string fkey, string userName, string userPass)

Mô tả:

 

·       fkey : Chuỗi key xác định hóa đơn cần lấy

·       userName/userPass*: user name/password để gọi webservices (Do hệ thống

HĐĐT cung cấp)

·       String trả về:

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

 

ERR:6

Không tìm thấy hóa đơn

 

ERR:7

User name không phù hợp, không tìm thấy company tương ứng cho

user.

 

ERR:11

Hóa đơn chưa thanh toán

nên không xem được

 

ERR:

Lỗi khác

 

chuỗi_hml_trả_về

Trả về chuỗi hml tương ứng với hóa đơn

Trả về một hóa đơn dưới dạng html

 

13.  Chuyển đổi chứng minh nguồn gốc xuất xứ

String    convertForVerify(string     invToken,    string    userName,              string                                    userPass)

 

Mô tả: Chuyển đổi chứng minh nguồn gốc xuất xứ cho hóa đơn. Mỗi hóa đơn chỉ được chuyển đổi 1 lần duy nhất

·       invToken : Chuỗi token xác định hóa đơn cần lấy

·       userName/userPass*: user name/password để gọi webservices (Do hệ thống HĐĐT

cung cấp)

·       String trả về:

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

 

ERR:6

Không tìm thấy hóa đơn

 

ERR:7

User name không phù hợp, không tìm thấy

company tương ứng cho user.

 

ERR:8

Hóa đơn đã đư ợc chuyển

đổi

 

chuỗi_hml_trả_về

Trả về chuỗi hml tương ứng với hóa đơn đã chuyển đổi

Trả về một hóa đơn dưới dạng html

 

14.  Chuyển đổi chứng minh nguồn gốc xuất xứ theo Fkey

String    convertForVerifyFkey(string    fkey,    string     userName,              string                                            userPass)

 

Mô tả: Chuyển đổi chứng minh nguồn gốc xuất xứ cho hóa đơn. Mỗi hóa đơn chỉ được chuyển đổi 1 lần duy nhất

·       fkey : Chuỗi key xác định hóa đơn cần lấy

·       userName/userPass*: user name/password để gọi webservices (Do hệ thống HĐĐT

cung cấp)

·       String trả về:

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

 

ERR:6

Không tìm thấy hóa đơn

 

ERR:7

User name không phù hợp, không tìm thấy company tương ứng cho

user.

 

ERR:8

Hóa đơn đã đư ợc chuyển

đổi

 

chuỗi_hml_trả_về

Trả về chuỗi hml tương ng  với          hóa   đơnã   đ chuyển đổi

Trả về một hóa đơn dưới dạng html

 

 

15.  Download hóa đơn

String downloadInv(string invToken, string userName, string userPass)

Mô tả:

 

·       invToken : Chuỗi token xác định hóa đơn cần lấy

·       userName/userPass*: user name/password để gọi webservices (Do hệ thống HĐĐT

cung cấp)

·       String trả về:

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

 

ERR:4

Không tìm thấy Pattern

 

ERR:6

Không tìm thấy hóa đơn

 

ERR:7

User name không phù hợp, không tìm thấy

company tương ứng cho user.

 

ERR:11

Hóa đơn chưa thanh toán

nên không xem được

 

chuỗi_Xml_trả_về

Trả về chuỗi Xml tương ứng với hóa đơn

Trả về một hóa đơn dưới dạng string Xml

 

 

16.  Download hóa đơn theo Fkey

String downloadInvFkey(string fkey, string userName, string userPass)

Mô tả:


·       fkey : Chuỗi key xác định hóa đơn cần lấy

·       userName/userPass*: user name/password để gọi webservices (Do hệ thống HĐĐT

cung cấp)

·       String trả về:

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

 

ERR:6

Không tìm thấy hóa đơn

 

ERR:7

User name không phù hợp, không tìm thấy company tương ứng cho

user.

 

ERR:11

Hóa đơn chưa thanh toán

nên không xem được

 

ERR:

Lỗi khác

 

chuỗi_Xml_trả_về

Trả về chuỗi Xml tương ứng với hóa đơn

Trả về một hóa đơn dưới dạng string Xml

 

17.  Download hóa đơn theo Fkey (Hóa đơn không cần thanh toán) String downloadInvFkeyNoPay(string fkey, string userName, string userPass) Mô tả:

·       fkey : Chuỗi key xác định hóa đơn cần lấy

·       userName/userPass*: user name/password để gọi webservices (Do hệ thống HĐĐT

cung cấp)

·       String trả về:

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

 

ERR:6

Không tìm thấy hóa đơn

 

ERR:7

User name không phù hợp, không tìm thấy company tương ứng cho

user.

 

ERR:

Lỗi khác

 

chuỗi_Xml_trả_về

Trả về chuỗi Xml tương ứng với hóa đơn

Trả về một hóa đơn dưới dạng string Xml

 

 

18.  Download hóa đơn định dạng PDF theo Fkey

String downloadInvPDFFkey(string fkey, string userName, string userPass)

Mô tả:

 

·       fkey : Chuỗi key xác định hóa đơn cần lấy

·       userName/userPass*: user name/password để gọi webservices (Do hệ thống HĐĐT

cung cấp)

·       String trả về:

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

 

ERR:6

Không tìm thấy hóa đơn

 

ERR:7

User name không phù hợp, không tìm thấy company tương ứng cho

user.

 

ERR:11

Hóa đơn chưa thanh toán

nên không xem được

 

ERR:

Lỗi khác

 

chuỗi_Pdf_trả_về

Trả về chuỗi Pdf tương ứng với hóa đơn

Trả về một hóa đơn dưới dạng string Pdf

 

19. Download hóa đơn định dạng PDF theo Fkey (Hóa đơn không cần thanh toán)

String downloadInvPDFFkeyNoPay(string fkey, string userName, string userPass)

Mô tả:

 

·       fkey : Chuỗi key xác định hóa đơn cần lấy

·       userName/userPass*: user name/password để gọi webservices (Do hệ thống HĐĐT

cung cấp)

·       String trả về:

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

 

ERR:6

Không tìm thấy hóa đơn

 

ERR:7

User name không phù hợp, không tìm thấy

company tương ứng cho user.

 

ERR:

Lỗi khác

 

chuỗi_Pdf_trả_về

Trả về chuỗi Pdf tương ứng với hóa đơn

Trả về một hóa đơn dưới dạng string Pdf

 

 

20.  Lấy giá trị hash cho việc kí hóa đơn

String getDigest (string cusCode, string invToken, string userName, string userPass)

Mô tả:

 

·       cusCode: mã khách hàng

·       invToken : Chuỗi token xác định hóa đơn cần lấy

·       userName/userPass*: user name/password để gọi webservices (Do hệ thống HĐĐT

cung cấp)

·       String trả về:

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

 

ERR

Không tồn tại khách

hàng tương ứng với cusCode

 

ERR:5

Chứng thư không đúng

với khách hàng

 

ERR:6

Không tìm thấy hóa đơn

 

ERR:7

User name không phù hợp, không tìm thấy

company tương ứng cho user.

 

chuỗi xml_trả_về

Trả về chuỗi xml theo cấu trúc

 

 

 

Cấu trúc của chuỗi xml trả về


<Data>

<text>giá trị base64(hash) của hóa đơn</text>

<xmlData>rỗng</xmlData

</Data>

21.  Cập nhật trạng thái hóa đơn

String ConfirmSiganture (string signValue, string invToken, string userName, string userPass)

Mô tả:

 

·       signValue: giá trị chữ kí

·       invToken : Chuỗi token xác định hóa đơn

·       userName/userPass*: user name/password để gọi webservices (Do hệ thống HĐĐT

cung cấp)

·       String trả về:

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

 

ERR:6

Không tìm thấy hóa đơn

 

ERR:7

User name không phù hợp, không tìm thấy company tương ứng cho

user.

 

chuỗi hml_trả_về

Trả về chuỗi hml của hóa

đơn đã kí

 

 

 

22.  Phân phối hóa đơn

String deliverInv(string lstInvToken, string userName, string userPass)

Mô tả:

 

·       lstInvToken:     Chuỗi    token    xác    định    hóa    đơn                          cần        lấy(theo          cấu      trúc patternt;serial;sốhóađơn)

VD: 01GTKT2/001;AA/13E;10_01GTKT2/001;AA/13E;11

 

·       userName/userPass*: user name/password để gọi webservices (Do hệ thống HĐĐT

cung cấp)

·       String trả về:

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

 

ERR:6

Không tìm thấy hóa đơn

 

ERR:7

User name không phù hợp, không tìm thấy

company tương ứng cho user.

 

“OK”

Đánh dấu hóa đơn trong list đã được phân phối

 

 

 

23.  Báo cáo tình hình sử dụng hóa đơn

String reportInvUsed(int year, int quarter, string username, string pass)

Mô tả:

 

·       year: Năm báo cáo

·       quarter: kì báo cáo

·       userName/userPass*: user name/password để gọi webservices (Do hệ thống HĐĐT

cung cấp)

·       String trả về:

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

 

ERR:7

User name không phù hợp, không tìm thấy company tương ứng cho

user.

 

Chuỗi xml

Trả về chuỗi xml mô tả báo cáo tình hình sử dụng hóa đơn

 

 

24.  Báo cáo bảng hàng hóa hàng tháng

String reportMonth (int year, int month, string username, string pass)

Mô tả:

 

·       year: Năm báo cáo

·       month: tháng báo cáo

·       userName/userPass*: user name/password để gọi webservices (Do hệ thống HĐĐT

cung cấp)

·       String trả về:


 

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai

 

ERR:7

User name không phù hợp, không tìm thấy

company tương ứng cho user.

 

Chuỗi xml

Trả về chuỗi xml mô tả báo cáo bảng kê hàng hóa

 

 

 

25.  Hủy hóa đơn (không thay thế, điều chỉnh)

String cancelInv (string Account, string ACpass, string fkey, string username, string password).

Mô tả

 

·       Account/ACPass : Tài khoản được cấp phát cho nhân viên gọi lệnh hủy hóa đơn

·       Username/pass: Tài khoản được cấp phát cho khách hàng để gọi service.

·       fkey: Chuỗi xác định hóa đơn cần hủy

·       Trả về: String kết quả

 

 

Kết quả trả về

Mô tả

Ghi chú

ERR:1

Tài khoản đăng nhập sai hoặc không có

quyền

 

ERR:2

Không tồn tại hóa đơn cần hủy

 

ERR:8

Hóa đơn đã được thay thế rồi, hủy rồi

 

ERR:9

Trạng thái hóa đơn ko được hủy

Tùy thuộc vào

yêu cầu nghiệp vụ

OK:

Hủy thành công

 

 

File đính kèm

mantm đăng này 14 Tháng Mười Hai 2018

Tài liệu hóa đơn điện tử VNPT của công ty Đại Vạn Phát

File đính kèm

Close
www.sthink.com.vn