Get E-Invoice PDF
Get the PDF version of an E-Invoice based on the invoice identifiers of the invoice data already sent to Clear.
Request Method
GET
Request URL
Request Headers
Parameter | Data Type | Field Validations | Description |
---|---|---|---|
x-cleartax-auth-token | String | Cannot be empty | Mandatory. User auth token. |
x-clear-tin | String | Cannot be empty | Mandatory. TIN of the entity |
x-clear-branch | String | Should be a valid branch from the user account | Optional. Branch name (store name) added in the user account which maps to a TIN of the entity. |
x-request-id | UUID | Should be unique for every request | Optional. Unique request ID. |
Request Path Params
There are no path paramaters for this API.
Request Query Params
Parameter | Data Type | Field Validations | Description |
---|---|---|---|
document-id | String | NA | Mandatory. If other Document Details are not specified |
template-id | String | NA | Optional. Default is “39” (Standard Invoice Template). To know the print template ID, refer to “How to get print template ID?”. |
einvoice-type | ENUM | SALES, PURCHASE, SALES_B2C | Default: SALES |
If using Custom Print Templates by CT, reach out to your CSM for Print Template Id.
Request Body
There will be no request body for this API.
Sample Request
Request URL
Response Status Codes
HTTP Status Code | Description |
---|---|
200 | For successfully printed |
400 | For any cleartax validation error |
401 | If the user is not authenticated for the operation |
403 | If the user is not authorized for the operation |
404 | If data is not present |
5XX | Unhandled exception |
Response Schema
The response will be a PDF file for a successful scenario. In case of an error, the error response will be an array of error details objects.
Sample Response (Success)
HTTP Status Code
200
Response Body
Sample Response (Error)
HTTP Status Code 404
Response Body
API Validations
The Document Id should be valid and the invoice data for this document must be present in Clear.
API Constraints
This API needs to be authenticated with a valid user authentication token. If the auth token is not present or is invalid, the API will return HTTP Status Code 401.
If the auth token is valid, but the user does not have the authorization to print E-Invoice, then the API will return HTTP Status Code 403.
If data is not present in the Clear then the API will return HTTP Status Code 404.
Last updated