CRM and Digital API notes
For the REST API — the path grammar, access endpoints, authentication, paging, response envelopes and error codes — see the developer integration path. There is one API for the whole platform; there is no separate Digital CRM API.
Integrate an external system →
The endpoint families this module’s applets call
Every mapping is under the tenant prefix core2/tnt/dm/ (Core2Config.TENANT_DOMAIN_URL_PREFIX)
and takes the platform’s ordinary headers. The families, with the constant that names each in
Core2Config.java:
| Family | Prefix | What it serves | Notes |
|---|---|---|---|
| Contact centre | core2/tnt/dm/alg/cc/… (ALG_CC_MODULE) | Tasks (…/tasks), conversations (…/conversations), sessions, e-mail threads, rules and actions, agents, teams, queues, virtual contacts and endpoints — 79 controllers | Conversation, message and session bodies are read from and written to the tenant’s MongoDB store; tasks, queues and configuration are PostgreSQL. Live updates reach the desk over a WebSocket, not by polling these endpoints |
| Sales force | core2/tnt/dm/sfa/… (SFA_MODULE) | Contacts (…/sfa-contact-hdr), address books, organisations, leads, deals (…/deals) with their activities, comments, work logs, calendar events and links, projects and their source / stage / type / rating / qualification links, sales groups — 42 controllers | The sales-group endpoints are shared with the Commission Scheme applet |
| Engagement register | core2/tnt/dm/erp/aat/engagements/… (ERP_MODULE_PREFIX + AUDIT_ASSURANCE_TAX_PREFIX + ENGAGEMENT_PREFIX) | Engagement headers, fiscal year ends, categories | Each has /backoffice-ep and /etl-ep variants; the ETL variants are how engagements are bulk-loaded |
| Calendars and events | core2/tnt/dm/cms/… (CMS_MODULE_PREFIX) | Calendars, calendar members, events (…/calendar-events), event links, participants, company links, post links, the notification queue | The notification-queue controller exists; no job processor consumes the queue |
| Event expenses | core2/tnt/dm/erp/aat/claims/reports/event-expenses-reports/… | single-event/backoffice-ep/{calendar_event_hdr_guid}, multiple-events/backoffice-ep, each with a /statistics sibling — all POST | Served by ClaimReportController; gated by TNT_AAT_CLAIM_REPORT_* |
| Credit-status sweep | core2/tnt/dm/erp/entities/blacklist-overdue-customers/backoffice-ep (POST) | Runs EntityService.blacklistOverdueCustomers on demand — the same code ENTITY_BLACKLIST_CUSTOMER_PROCESSOR runs as a batch | Core, not CRM; listed because it is the only credit-control entry point and readers look for it here |
The endpoint suffixes above are the values in the controllers’ @RequestMapping and
@PostMapping annotations at the commit read; the developer integration path explains the
backoffice-ep / etl-ep / customer-ep suffix convention and how to authenticate.
What there is no endpoint for
No document type exists for a conversation, task, lead, deal, engagement, calendar or event, so there is no generic-document endpoint for any of them, no FINAL, and no posting to query. Nothing under these families computes analytics, sentiment, churn or SLA figures; the dashboard and report endpoints return counts and listings.