Mandatory.
User auth token.
| | x-clear-vat | String | Cannot be empty |Mandatory.
VAT 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-clear-country-code | String | Cannot be empty |Mandatory.
Country Code.
| | x-request-id | UUID | Should be unique for every request |Optional.
Unique request ID.
| ### Request Path Params There are no path params for this API. ### Request Query Params | Parameter | Data Type | Field Validations | Description | | ------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ | | document-id | String | NA |Conditional.
Required if these fields are not provided- document-number, document-date, document-type, taxpayer-identifier
| | template-id | String | NA |Optional.
Default is “2” (Standard Invoice Template).
Contact your CSM for Custom Print Templates.
| | einvoice-type | ENUM | SALES, PURCHASE |Optional.
Default: SALES, if key not passed.
| | document-number | String | NA |Conditional.
Document Number of Invoice.
Required if document-id is not provided.
| | document-date | String | yyyy-mm-dd |Conditional.
Document Date of Invoice.
Required if document-id is not provided.
| | document-type | ENUM |REQUEST\_FOR\_PAYMENT
DEBIT\_NOTE\_GOODS\_OR\_SERVICES
METERED\_SERVICES\_INVOICE
DEBIT\_NOTE\_FINANCIAL\_ADJUSTMENTS
TAX\_NOTIFICATION
FINAL\_PAYMENT\_REQUEST
PAYMENT\_REQUEST\_COMPLETED\_UNITS
COMMERCIAL\_INVOICE\_PACKING\_LIST
COMMERCIAL\_INVOICE
COMMISSION\_NOTE
DEBIT\_NOTE
PREPAYMENT\_INVOICE
TAX\_INVOICE
FACTORED\_INVOICE
CONSIGNMENT\_INVOICE
FORWARDERS\_INVOICE\_DISCREPANCY
INSURERS\_INVOICE
FORWARDERS\_INVOICE
FREIGHT\_INVOICE
CLAIM\_NOTIFICATION
CONSULAR\_INVOICE
PARTIAL\_CONSTRUCTION\_INVOICE
PARTIAL\_FINAL\_CONSTRUCTION\_INVOICE
FINAL\_CONSTRUCTION\_INVOICE
CREDIT\_NOTE\_GOODS\_OR\_SERVICES
CREDIT\_NOTE\_FINANCIAL\_ADJUSTMENTS
CREDIT\_NOTE
FACTORED\_CREDIT\_NOTE
FORWARDERS\_CREDIT\_NOTE
|Conditional.
Document Type of Invoice.
Required if document-id is not provided.
| | taxpayer-identifier | String | NA |Conditional.
Issuer VAT.
Required if document-id is not provided.
| ### Request Body There is no request body for this API. ### 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 Request & Response #### **Request** There is no request body for this API. #### Response (Success) HTTP Status Code: 200 OK PDF File containing Invoice Data. #### Response (Error) HTTP Status Code 404 ```json { "ErrorDetails": [ { "ErrorCode": "EINV-DOC-NF-001", "ErrorMessage": "You don't have any data present for the selected Document Details", "ErrorSource": "CLEARTAX" } ] } ``` ### API Validations 1. The Document Id should be valid and the invoice data for this document must be present in Clear. ### API Constraints 1. 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. 2. 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. 3. If data is not present in the cleartax then the API will return HTTP Status Code 404.