Lead

This page documents the CRM lead domain in tSM.

1. Business Context

Lead models pre-customer commercial opportunity. It is used before conversion to a customer/account structure and supports qualification, prioritization, and source tracking.

Lead data can be linked to contacts and later converted into customer entities.

1.1 Telco and TMF perspective

In telco, Lead is used to control the front part of the commercial funnel before formal customer/account structures are created. It usually carries qualification and routing data needed by presales, partner channels, and outbound teams.

TMF note:

• there is no single dominant TMF Open API that universally standardizes operator lead management,
• implementations commonly bridge lead data to TMF629 customer context and TMF620/TMF622 product and order context at conversion time.

2. Scope

This page covers:

• Lead
• LeadType
• LeadRating
• LeadSource

3. Entity: Lead

3.1 Behavior Notes

• partyName is required and represents the lead company/party.
• status and priority support lead lifecycle handling.
• leadType, leadRating, and leadSource are configurable via registers.
• Contact attributes reuse the shared CRM contact value-object model.
• chars typically carries qualification inputs such as expected revenue, region, technology interest, or partner-source details.

3.2 Attribute Reference

Attribute	Type	Required	Read-only	Description
id	UUID	No	No	Technical primary key.
key	String	No	No	Business identifier.
status	LeadStatus	Yes	No	Lead lifecycle status.
partyName	String	Yes	No	Company/party name.
leadRating	String	Yes	No	FK to LeadRating.code.
description	String	No	No	Description.
priority	LeadPriority	No	No	Lead priority enum.
leadSource	String	Yes	No	FK to LeadSource.code.
contactInstants	List of ContactInstant	No	No	Generic contact identifiers.
phones	List of Phone	No	No	Phone contacts.
emails	List of Email	No	No	Email contacts.
websites	List of Web	No	No	Website contacts.
dataBoxes	List of DataBox	No	No	Data-box contacts.
dataTags	List of String	No	No	Labels/tags.
processingData	ProcessingData	No	Write-only	Transient processing context.
chars	TsmChars	No	No	Dynamic lead characteristics.
leadType	String	Yes	No	FK to LeadType.code.

3.3 Enum: LeadPriority

Value	Meaning
HIGH	High priority lead.
MEDIUM	Medium priority lead.
LOW	Low priority lead.

3.4 Enum: LeadStatus

Value	Meaning
NEW	Newly created lead.
IN_PROGRESS	Lead is being worked on.
CONVERTED	Converted to internal customer structure.
CONVERTED_EXTERNAL	Converted externally.
REJECTED	Rejected lead.
LATER	Deferred for later action.
UNSUCCESSFUL	Closed as unsuccessful.
WORKING	Actively processed.
NON_WORKING	Not actively processed.

4. Register: LeadType

Attribute	Type	Required	Read-only	Description
id	UUID	No	No	Register row UUID.
code	String	Yes	No	Technical code.
name	String	Yes	No	Display name.
validityFrom	Date	No	No	Validity start.
validityTo	Date	No	No	Validity end.
description	String	No	No	Description.
localizationData	LocalizationData	No	No	Localized labels/descriptions.
entitySpecId	UUID	No	No	Optional specification link.
mnemonicCode	String	No	No	Mnemonic/business code.
createPrivilege	String	No	No	Privilege needed for create.
registry	Map	No	No	Register metadata.
processingData	ProcessingData	No	Write-only	Transient processing context.
icon	String	No	No	Icon.
tsmModule	String	No	No	Module code.
config	Map	No	No	Additional config payload.
dataTags	List of String	No	No	Labels/tags.

5. Register: LeadRating

Attribute	Type	Required	Read-only	Description
id	UUID	No	No	Register row UUID.
code	String	Yes	No	Technical code.
name	String	Yes	No	Display name.
validityFrom	Date	No	No	Validity start.
validityTo	Date	No	No	Validity end.
description	String	No	No	Description.
localizationData	LocalizationData	No	No	Localized labels/descriptions.
dataTags	List of String	No	No	Labels/tags.
config	Map	No	No	Additional config payload.

6. Register: LeadSource

Attribute	Type	Required	Read-only	Description
id	UUID	No	No	Register row UUID.
code	String	Yes	No	Technical code.
name	String	Yes	No	Display name.
validityFrom	Date	No	No	Validity start.
validityTo	Date	No	No	Validity end.
description	String	No	No	Description.
localizationData	LocalizationData	No	No	Localized labels/descriptions.
dataTags	List of String	No	No	Labels/tags.
config	Map	No	No	Additional config payload.

Related Documentation

• CRM Module
• Customer
• Person