The entity reference documents the xMatix data model itself: every business entity, every field on it, and what that field does to the process the entity drives. Where the product manuals explain how to work — create an order, run payroll, close a ticket — this section explains what the data is.
Each entity page carries:
- The field table — every field with its name, label, type, whether it is required, picklist values where they apply, and a note on what the field does and how it affects downstream behavior (pricing, posting, approval, sync).
- Actions — the buttons and server actions the entity exposes, with what executing each one actually does.
- Validations — the rules that block a save, with the error message each produces.
- Lookup filters — how the entity's lookup fields constrain which records can be picked.
- Lookups as links — a field that points at another entity links straight to that entity's own reference page, so you can walk the model.
- Related entities — the relationships in and out.
Where to start
- All entities — the alphabetical index.
- Using entity screens — a screenshot-led walkthrough of a populated list, every Account creation tab, and every Account detail tab.
- Working with records day to day? Start with the product manuals instead and use this section when you need to know exactly what a field means.
- Building on the model — custom fields, rules, integrations? Pair this with Customization and the Developer guide.
Common questions
How current is this reference?
It is kept in sync with the production data model, so what you read here matches the product you are using. If a field exists in your tenant but not here, it is most likely a custom field added by your administrators — custom fields are tenant-specific and are not part of the platform reference.
Why is a field's note blank?
The field's name, label, type and requiredness always reflect the current model, but the explanatory notes are written and reviewed by people. A blank note means that write-up is still in progress.