Setting up the ClearTax API configuration in NetSuite involves specifying several URL endpoints for various functionalities. Each endpoint has a distinct purpose and requires a clear understanding to ensure proper integration. Below is a detailed explanation of each field for both GST and TDS contexts.
1. Generate IRN Endpoint
- Explanation: This field stores the URL endpoint used to generate the Invoice Reference Number (IRN) for invoices via the ClearTax API. The IRN is a unique identifier for each invoice, essential for GST compliance.
2. Get Invoice PDF IRN Endpoint
- Explanation: This field stores the URL endpoint used to retrieve the PDF version of an invoice using the IRN via the ClearTax API. This feature allows you to obtain a PDF document of the specified invoice.
3. Get Invoice by IRN Endpoint
- Explanation: This field stores the URL endpoint used to fetch detailed information about an invoice using its IRN via the ClearTax API. It helps retrieve all necessary details of a specific invoice.
4. GST Authentication Endpoint
- Explanation: This field stores the URL endpoint used to authenticate and obtain an access token for GST-related operations via the ClearTax API. This token is necessary for accessing other GST endpoints.
5. GST Generate IRN Endpoint
- Explanation: This field stores the URL endpoint used to generate the IRN for GST invoices via the ClearTax API. This is a crucial step for GST compliance.
6. GST Get Invoice PDF IRN Endpoint
- Explanation: This field stores the URL endpoint used to retrieve the PDF version of a GST invoice using the IRN via the ClearTax API. It provides a secure way to obtain a PDF copy of the invoice.
7. GST Get Invoice by IRN Endpoint
- Explanation: This field stores the URL endpoint used to fetch detailed information about a GST invoice using its IRN via the ClearTax API. It helps retrieve comprehensive details of a specific GST invoice.
8. TDS Authentication Endpoint
- Explanation: This field stores the URL endpoint used to authenticate and obtain an access token for TDS-related operations via the ClearTax API. This token is necessary for accessing other TDS endpoints.
9. TDS Generate IRN Endpoint
- Explanation: This field stores the URL endpoint used to generate the IRN for TDS invoices via the ClearTax API. This is a crucial step for TDS compliance.
10. TDS Get Invoice PDF IRN Endpoint
- Explanation: This field stores the URL endpoint used to retrieve the PDF version of a TDS invoice using the IRN via the ClearTax API. It provides a secure way to obtain a PDF copy of the invoice.
11. TDS Get Invoice by IRN Endpoint
- Explanation: This field stores the URL endpoint used to fetch detailed information about a TDS invoice using its IRN via the ClearTax API. It helps retrieve comprehensive details of a specific TDS invoice.
12. Get Pre-signed URL
- GST Explanation: This field stores the URL endpoint used to obtain a pre-signed URL for uploading documents related to GST via the ClearTax API. This URL allows secure and authenticated uploads of GST-related files.
- TDS Explanation: This field stores the URL endpoint used to obtain a pre-signed URL for uploading documents related to TDS via the ClearTax API. This URL allows secure and authenticated uploads of TDS-related files.
13. Trigger File Ingestion
- GST Explanation: This field stores the URL endpoint used to trigger the ingestion of uploaded GST-related documents via the ClearTax API. This endpoint processes and integrates the uploaded GST files into the system.
- TDS Explanation: This field stores the URL endpoint used to trigger the ingestion of uploaded TDS-related documents via the ClearTax API. This endpoint processes and integrates the uploaded TDS files into the system.
14. Get File Ingestion Status
- GST Explanation: This field stores the URL endpoint used to check the status of ingested GST-related documents via the ClearTax API. This endpoint provides updates on the processing status of the uploaded GST files.
- TDS Explanation: This field stores the URL endpoint used to check the status of ingested TDS-related documents via the ClearTax API. This endpoint provides updates on the processing status of the uploaded TDS files.