After installation, you must configure the integration before any invoices can be submitted. Configuration is done once per company.
Settings
TIMs INCOTEX Settings Doctype
Navigate to TIMs INCOTEX Settings in ERPNext (you can search from the top bar).
| Field | Description |
|---|---|
| Company | Select the ERPNext company this configuration applies to. Only one configuration is allowed per company. This field acts as the unique identifier. |
| Environment | Choose Production for live KRA submissions, or Sandbox for testing without real submissions. |
| Base URL | The root URL of your INCOTEX device's API. Provided by INCOTEX. |
| API Key | The authentication key for your INCOTEX device. Provided by INCOTEX. |
API Endpoint Configuration
INCOTEX uses different API endpoints depending on the invoice type and tax pricing model. All of the following must be configured:
| Endpoint Field | Purpose |
|---|---|
| Invoice URL (Item Price Inclusive) | Used when line item prices already include VAT. |
| Invoice URL (Item Price Exclusive) | Used when line item prices are exclusive of VAT (VAT is added on top). |
| Credit Note URL (Item Price Inclusive) | For credit notes/returns where prices include tax. |
| Credit Note URL (Item Price Exclusive) | For credit notes/returns where prices exclude tax. |
| Query URL | Used to query INCOTEX for details of an already-submitted invoice (e.g., to re-fetch the CU number). |
| Health Check URL | Used by the Health Check button to confirm the INCOTEX device is reachable and operational. |
The distinction between inclusive and exclusive endpoints is important. The integration reads your invoice's Sales Taxes and Charges table and the selected Tax Category to determine which endpoint to call. Setting these up correctly in your Tax Templates is a prerequisite for the integration to route calls to the right endpoint.
Other Settings
| Setting | Description |
|---|---|
| Enable Auto-Signing | When enabled, invoices are automatically signed after a successful INCOTEX submission. |
| Health Check Button | A manual button on the settings form that pings the Health Check URL and shows whether the INCOTEX device is reachable. Use this to verify your configuration is correct before going live. |
Last updated 5 days ago
Was this helpful?