Skip to main content

Understand the MyCRM data model

The API organises information into resources and relationships. Understanding the business meaning of those resources makes queries easier to design and their results easier to explain.

Organisation → Advisers
↓
Contact groups → Contacts → Addresses
↓ ↕
Financial records Deals
↓
Participants, notes,
structures and securities

This is a conceptual map, not a complete relationship schema. Use the API reference for the exact relationship names and directions supported by each resource.

Resource familyBusiness meaning
Advisers and organisationsThe professional and organisation context
Contact groupsRelated clients and their shared context
ContactsIndividual people or businesses.
DealsResidential loan applications.
Asset finance dealsAsset-finance application summaries and their adviser and applicants
Asset finance referralsReferral summaries with proposed amounts, adviser and person/business applicants
Commercial finance dealsBusiness-lending summaries and their adviser and applicants
Assets, liabilities, incomes and expensesContact financial information and their relationships
Reference dataCategories, types, statuses and other lookup values
External referencesMappings to identifiers in another system

For work assigned to an adviser, see create and manage tasks. A task can link to a contact group or deal and has its own progress, priority and due date.

Keep identifiers distinct​

A client contact ID, contact group ID, adviser ID and deal ID are different identifiers. The UserId request header takes the permitted adviser contact identifier; it is not the client contact you are reading.

Use the resource type and id together when following relationships. Reference values should come from the documented lookup resources rather than hard-coded display labels.

Start with contacts, deals, financial resources or directory resources. For how these connections appear on the wire, see JSON:API relationships.