Show / Hide Table of Contents

    Gửi email cho khách hàng các hóa đơn/vé
    điển tử sau khi phát hành

    Mô tả chi tiết

    1. Request

    1.1 Url API

    Method URL API (BaseUrl lấy ở mô tả chung)
    POST <BaseUrl>/sendemail

    1.2 Header

    Content-Type: application-json
    Authorization: Bearer <token lấy ở api Lấy token Authorization>
    

    1.3 Body

    {
        "SendEmailDatas":
                    [{
                        "TransactionID":"Mã tra cứu",
                        "ReceiverName":"Tên người nhận",
                        "ReceiverEmail":"Email nhận hóa đơn",
                        "CCEmail":"Email cc",
                        "ReplyEmail":"Email reply phản hồi"
                    }](list đối tượng SendEmailDatas),
        "IsInvoiceCode":false<đánh dấu hóa đơn có mã hay không mã>,
        "IsInvoiceCalculatingMachine":true/false {nếu là hóa đơn máy tính tiền thì đánh dấu true}
    }
    

    1.4 Response

    {
        "success": true,
        "errorCode": null,
        "descriptionErrorCode": null,
        "errors": [],
        "data": [
                    {
                        "TransactionID": "Mã tra cứu",
                        "RefID": "RefID của hóa đơn",
                        "RefDetailID": "RefID của detail liên quan",
                        "SendEmailStatus": Trạng thái gửi mail(0:Chưa gửi,1:Đang gửi,2:Gửi lỗi,3:Đã gửi,4:Yêu cầu gửi mail),
                        "ErrorCode": "Mã lỗi nếu có"
                    }
                ](list đối tượng SendEmailResult),
        "customData": ""
    }
    

    3 Mô tả đối tượng SendEmailDatas trong request

    /// <summary>
    /// Tham số gửi Email
    /// </summary>
    public class SendEmailParameter
    {
     /// <summary>
     /// Danh sách thông tin gửi email
     /// </summary>
     public List<SendEmailData> SendEmailDatas { get; set; }
    
     /// <summary>
     /// Hóa đơn có mã hay không
     /// </summary>
     public bool IsInvoiceCode { get; set; }
    
     /// <summary>
     ///  Hóa đơn từ máy tính tiền
     /// </summary>
     public bool? IsInvoiceCalculatingMachine { get; set; } = false;
    
    }
    
    /// <summary>
    /// Tham số gửi Email
    /// </summary>
    public class SendEmailData
    {
     /// <summary>
     /// Mã tra cứu
     /// </summary>
     public string TransactionID { get; set; }
    
     /// <summary>
     /// Tên người nhận
     /// </summary>
     public string ReceiverName { get; set; }
    
     /// <summary>
     /// List Email
     /// </summary>
     public string ReceiverEmail { get; set; }
    
     /// <summary>
     /// Email cc
     /// </summary>
     public string CCEmail { get; set; }
    
     /// <summary>
     /// địa chỉ email khi reply
     /// </summary>
     public string ReplyEmail { get; set; }
    }
    

    3 Mô tả đối tượng SendEmailResult trong respone

    /// <summary>
    /// Kết quả gửi email
    /// </summary>
    public class SendEmailResult
    {
    /// <summary>
    /// Mã tra cứu hóa đơn
    /// </summary>
    public string TransactionID { get; set; }
    /// <summary>
    /// ID hóa đơn
    /// </summary>
    public string RefID { get; set; }
    /// <summary>
    /// ID của dòng TBSS detail
    /// </summary>
    public System.Guid RefDetailID { get; set; }
    
    /// <summary>
    /// Trạng thái gửi
    ///(0:Chưa gửi,1:Đang gửi,2:Gửi lỗi,3:Đã gửi,4:Yêu cầu gửi mail)
    /// </summary>
    public SendEmailStatus SendEmailStatus { get; set; }
    
    /// <summary>
    /// Mã lỗi
    /// </summary>
    public string ErrorCode { get; set; }
    }
    

    3. Ví dụ:

    3.1 Request

    URL: https://testapi.meinvoice.vn/api/integration/invoice/sendemail
    HEADERS:
        Content-Type: application-json
        Authorization: Bearer <token lấy ở api Lấy token Authorization>
    BODY:
        {
        "SendEmailDatas": [
                {
                    "TransactionID": "_8CKUJ52_Z",
                    "ReceiverName": "test All In One",
                    "ReceiverEmail": "nmdai@software.misa.com.vn",
                    "CCEmail": null,
                    "BCCEmail": null    
                }
            ],
        "IsInvoiceCode": true,
        "IsInvoiceCalculatingMachine": false
    }
    

    3.2 Response

    {
    "success": false,
    "errorCode": null,
    "descriptionErrorCode": null,
    "errors": [],
    "data": "[{\"TransactionID\":\"_8CKUJ52_Z\",\"RefID\":\"21E34AFA-38F3-4506-A222-7C3AFC55B8E2\",\"RefDetailID\":\"00000000-0000-0000-0000-000000000000\",\"SendEmailStatus\":3,\"ErrorCode\":\"\"}]",
    "customData": ""
    }
    

    4 Tài liệu tham khảo (Curl Postman)

    curl --location --request POST 'https://testapi.meinvoice.vn/api/integration/invoice/sendemail' \
    --header 'Authorization: Bearer <token lấy ở api Lấy token Authorization>' \
    --data-raw '{
    "SendEmailDatas": [
        {
            "TransactionID": "_8CKUJ52_Z",
            "ReceiverName": "test All In One",
            "ReceiverEmail": "nmdai@software.misa.com.vn",
            "CCEmail": null,
            "BCCEmail": null    
        }
    ],
    "IsInvoiceCode": true,
    "IsInvoiceCalculatingMachine": false
    }'
    
    Back to top Copyright © 2015-2016 Microsoft
    Generated by DocFX