Send an E-Invoice via Email

You can use this API to send an E-Invoice via Email to your customers.

Request Method

POST

Request URL

{{HOST}}/einv/v0/communication/send

Request Headers

Parameter	Data Type	Field Validations	Description
X-Cleartax-Auth-Token	String	NA	Mandatory. The auth token generated from the ClearTax user id and password.
gstin	String	NA	Users GSTIN

Request Path Params

There are no path parameters for this API.

Request Query Params

There are no query parameters for this API.

Request Body

Parameter	Data Type	Field Validations	Description
attachment_details	Object	NA	Mandatory, Attachment Details
communication_details	Object	NA	Mandatory, Communication Details like Template Type and Email Information

Attachment Details Object

Parameter	Data Type	Field Validations	Description
invoice_details	Object	NA	Mandatory, Invoice Details for which E-Invoice is to be sent in attachments

Invoice Details Object

Parameter	Data Type	Field Validations	Description
invoice_id	String	minLength: 1 maxLength: 16 pattern: "^([a-zA-Z1-9]{1}[a-zA-Z0-9\/-]{0,15})$"	Mandatory, Invoice/ Document Number
invoice_date	String	Format DD/MM/YYYY	Mandatory, Document Date
invoice_type	Enum	Enum Values: INV, CDN, DBN	Mandatory, Document Type: Invoice, Credit Note, or Debit Note

Communication Details

Parameter	Data Type	Field Validations	Description
template	Object	NA	Mandatory, Template Type
contacts	List	NA	Mandatory, Contact Details

Template Details Object

Parameter	Data Type	Validations	Description
template_type	String	INVOICE_GENERATED, INVOICE_CANCELLED, INVOICE_PAYMENT_REMINDER	Mandatory

Contact Details

Parameter	Data Type	Field Validations	Description
recipients	List	NA	Mandatory, Email Recipients - You can send multiple recipients for sending email

Email Recipient Details

Parameter	Data Type	Field Validations	Description
name	String	maxLength: 100	Optional, Name of the Person
email	String	maxLength:100	Mandatory, Email of the Person
email_recipient_type	Enum	TO, CC, BCC	Mandatory, Scope of the Email

Response Status Codes

HTTP Status Code	Description
200	For a successfully processed request (may be a success or validation error).
401	If the user is not authenticated for the operation.
403	If the user is not authorised for the operation.
500	If there are any unhandled exceptions on the Clear side.

Response Schema

Parameter	Data Type	Field Validations	Description
success	boolean	true, false	true if request is successful, false if request got failed
errors	Object	NA	Details of errors, null in case of success

Error Details Object

Parameter	Data Type	Field Validations	Description
error_code	String	NA	Error Code
error_message	String	NA	Error Message
error_source	String	ClearTax	Error Source

Sample Request and Response

Request

{
  "attachment_details": {
   "printTemplate": "62cfd0a9-d1ed-47b0-b260-f8y6f57e9c5e",
   "invoice_details": {
      "invoice_id": "DOC-1",
      "invoice_date": "24/06/2025",
      "invoice_type": "INV"
    }
  },
  "communication_details": {
    "template": {
      "template_type": "INVOICE_GENERATED"
    },
    "contacts": [
      {
        "recipients": [
          {
            "name": "Contact Person Name",
            "email": "[email protected]",
            "email_recipient_type": "TO"
          }
        ]
      }
    ]
  }
}

Response - Success:

HTTP Status Code : 200 OK

{
    "success": true,
    "errors": null
}

Response - Failure:

HTTP Status Code : 200 OK

{
    "success": false,
    "errors": {
        "error_code": "300102",
        "error_message": "You don't have any data present for the selected Document Details",
        "error_source": "CLEARTAX"
    }
}

API Validations

Currently there are no known validations for this API.

API Constraints

The Invoice should be present in the ClearTax database.