Skip to content

Endpoint Index

Applies to: All subscriptions

Purpose

Give a complete inventory of the API surface, and — more usefully — mark clearly which parts are supported integration contracts and which exist to serve the product's own interface.

Audience

Integration developers, architects scoping an integration.

Prerequisites

Reference

Read this first

The platform exposes several hundred endpoints. Most serve the web application and follow its needs.

Category Stability Use it?
Integration contracts — ingest, write-back, mapping templates Versioned and stable Yes
Administrative Follows the admin console For provisioning and bulk work
Application Follows the user interface No. Not an integration contract

Building an integration against application endpoints is the most common cause of an integration breaking on an upgrade that was not intended to affect it.

Integration contracts

Area Base path Documented in
Document ingest /api/v1/ingest Ingest API
TDS ingest /api/v1/ingest/tds Ingest API
Write-back /api/v1/integration Write-back API
Mapping templates /api/admin/mapping-templates Mapping Templates API

Administrative

Area Base path Documented in
Users, audit, fiscal calendar /api/admin Administration API
Approval role ladder /api/admin/approval-roles Administration API
Machine credentials /api/admin/api-keys Administration API
Provider configuration /api/gsp, /api/admin/gsp Administration API
Document routing /api/admin/doc-type-routing Administration API
Onboarding /api/admin/onboarding Administration API
Integration policies /api/admin/policies Administration API
Write-back operations /api/v1/integration/admin Administration API
Write-back subscriptions /api/admin/writeback-subscriptions Administration API
ERP connection onboarding /api/admin/erp-connections Administration API
Entra consent callback (public) /api/erp-consent/callback Administration API

Application surface — for reference only

Listed so architects can see the shape of the system. Not integration contracts.

Area Base path What it serves
Authentication /api/auth Sign-in, password reset, one-time codes
e-Invoice /api/irn, /api/irn/workbench Generation, cancellation, details, printing
e-Way Bill /api/ewb, /api/ewb-doc Both pipelines, Part-B, extension, multi-vehicle
Consolidated e-Way Bill /api/cewb Trip sheets and lookups
Upload /api/invoices/upload, /api/jobs File upload and job monitoring
Correction /api/correction The Correction Cockpit
Validation utilities /api/validations Registration, identity and enterprise verification
Masters /api/masters Reference data
Dashboard /api/dashboard Summaries and alerts
Analytics /api/intelligence Findings and analysis
Notifications /api/notifications In-product notifications
Printing /api/invoice-print, /api/print-config Rendering and print configuration
Invoice Generation /api/v1/igm Masters, documents, numbering, approvals
General ledger /api/v1/gl Accounts, journals, periods, reports
TDS /api/tds Module root — configuration and shared lookups
TDS deductions /api/tds/deductions Deduction entries
TDS challans /api/tds/challans Challan records and payment detail
TDS returns /api/tds/returns Quarterly return preparation and FVU output
TDS certificates /api/tds/certificates Form 16/16A issuance
TDS notices /api/tds/notices TRACES notices and responses
TDS rates /api/tds/rates Section rate masters
Data privacy /api/privacy, /api/vendor Notices, consent, grievances, evidence
Help /api/help In-product help registry
Health /api/health Liveness probe

Authentication by surface

Surface Credential Registration header
/api/v1/ingest, /api/v1/integration Machine credential Not used — scope comes from the credential
/api/admin/* User token, administrative role Usually required
/api/* application User token Required
/api/health None Not used

Rate limiting by surface

Surface Limit
/api/auth 20 requests per 15 minutes
/api/v1/ingest, /api/v1/integration 200 requests per minute
Other surfaces See Rate Limits and Errors

The authentication limit is deliberately strict. A sign-in loop in a script will hit it quickly, and that is the intended behaviour.

Validation

Check Method Pass condition
Your integration uses only contract endpoints Review every call your integration makes All within ingest, write-back or mapping templates
No dependency on application endpoints Same review None. Any dependency is upgrade risk
Correct credential per surface Review your headers Machine credential for ingest and write-back; user token for administration
Rate limits respected Measure your call rate at peak Below the limit, with headroom
Authentication not called repeatedly Inspect your client Tokens cached

Troubleshooting

Symptom Cause Action
An integration broke after an upgrade It depends on application endpoints Move to the contract endpoints
403 on an administrative call Machine credential used where a user token is required Use the correct credential for the surface
429 while authenticating Sign-in called per request instead of caching a token Cache it
An endpoint exists but is undocumented It serves the application Do not build against it. Raise a request if the capability is genuinely needed as a contract
No endpoint for a needed capability It may not be exposed as a contract Ask before improvising against an application endpoint