xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField Sales & SFACRMRewardsClaimsInventoryProcurementWarehouse ManagementField ServiceServiceSupportTelephony & MessagingFinance & AccountingPayrollExpense ManagementCommercePortalsAnalytics & ReportingData StudioMobile AppSee all products →
PLATFORM
Platform overviewApp BuilderAutomationIntegrationsSecurity & GovernanceChange ManagementDevelopers
SENSE AI
Sense AI overviewSense AssistSense ControlSense VisionAI StudioTrust & governanceIn Claude & ChatGPTUse cases
SOLUTIONS
Auto DMSConsumer Goods DMSSales Force Automation (SFA) FMCG & DistributionManufacturing & Dealer NetworksAutomotive & DealershipsPharma & HealthcareConsumer DurablesAgri-InputsBuilding MaterialsService NetworksWarehousing & 3PLFinancial AccountingERP SoftwareIndia GST ComplianceUAE VAT & e-InvoicingSaudi ZATCA & VATAll solutions →
RESOURCES
Knowledge CenterDeveloper & CLIBlogGuidesWhat is xMatix?Company facts
COMPANY
AboutCareersPartnersEventsContactAuthorsLegal
Sign in Request demo
Home/Docs/Entity Reference/Contract — entity reference
REFERENCE · Last reviewed

Contract — entity reference

The agreement record in the Contracts app: a register entry for a service or maintenance agreement with a customer account, optionally tied to one asset. It holds the contract name, the start and end dates, the line of business, billing and shipping addresses, special terms, a description, the signature facts and a status you maintain (Draft, Pending Approval, Verified, Active). New contracts are numbered from the CN series on first save and start in Draft. It is a record only: no server logic acts on it, so nothing changes when it becomes Active or reaches its end date, and no quote, order, service order or invoice reads it. Enforced service cover comes from asset service contracts. Contract lines, terms, SLAs and PM tasks are separate registers; a contract line has no Contract field, so lines are not tied to a contract. The shipped record page offers Edit and Delete; Clone is granted but not on the shipped page.

Fields

FieldLabelTypeRequiredWhat it does
AccountIdAccountLookup → AccountThe customer the agreement is with. Optional. Nothing is copied from the account: the billing and shipping addresses are typed separately.
ActivatedDateActivated DateDateThe date the agreement went live. On the shipped New/Edit form above the tabs; it is typed, never set by changing the status, and is not shown on the record page.
AssetIdAssetLookup → AssetThe single asset the agreement covers, when there is one. Optional, shown in the list and the page header. Multi-asset agreements record the asset count on contract lines and the asset on each PM task.
BillingAddressBilling AddressTextThe billing address as free text. Not looked up or copied from the account.
CompanySignedDateCompany Signed DateDateAndTimeThe date and time your organization signed.
ContactIdContactLookup → ContactNot stored: there is no column behind this field and it is on no shipped form. The customer signatory relation uses a separate Customer Signed By field, which is also on no shipped form.
ContractEndDateContract End DateDateThe date the agreement ends. Reaching it changes nothing: the status stays as it is until you change it.
ContractNameContract NameTextThe business title of the agreement, for example the customer and the scope. Free text, not unique, shown beside the number in the All Contracts list and the page header.
ContractNumberContract NumberNumberA numeric field that no shipped form, view or process fills. The contract's number is in Name; the shipped preview card shows this field, so it appears blank there.
ContractStartDateContract Start DateDateThe date cover under the agreement begins. Not checked against the end date or the term.
ContractTermsContract Terms (Months)NumberLabelled Contract Terms (Months) on the form and in the page header, but not stored: a value typed here is accepted and then lost, so the field always reads back empty. Record the term through the start and end dates (and the description) instead.
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
CustomerSignedDateCustomer Signed DateDateThe date the customer signed.
CustomerSignedTitleCustomer Signed TitleTextThe job title of the person who signed for the customer.
DescriptionDescriptionTextFree-text notes about the agreement.
IdIdGuidYes
LOBLOBPickListLine of business. A picklist with one shipped value, Automobile; your administrator maintains the list. Used by the shipped contract dashboards to group contracts. Values: Automobile.
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextYesThe contract number. It is not on the New form: on first save it is filled automatically from the Contract Name Setting (series CN, day-month-year date and a six-digit counter with no separator, for example CN26102026000001; the counter restarts each day as shipped).
OwnerExpirationOwner ExpirationPickListFree text that no shipped form or process uses.
OwnerIdOwnerLookup → UserAccountYes
RecordTypeIdRecord TypeGuid, hidden
ShippingAddressShipping AddressTextThe service or shipping address as free text. Not looked up or copied from the account.
SpecialTermsSpecial TermsTextShort free text for terms that differ from your standard ones.
StatusStatusPickListThe lifecycle stage you maintain: Draft (the default for a new contract), Pending Approval, Verified, Active. It is not on the New/Edit form; change it on the record's Details tab. Nothing changes it automatically and nothing reacts to it, and there is no shipped expired or cancelled value. Values: Draft, Pending Approval, Verified, Active.
SubscriptionKeySubscription KeyGuid, hiddenYes
UpdatedDateTimeModified DateDateAndTimeYes

Actions

ActionLabelTypeWhat it does
CloneCloneServerAction (Clone)Creates a copy of the contract header with a new CN number. Lines, terms, SLAs and PM tasks are not copied, and the copy keeps the original's Status, so reset it to Draft. Granted to several shipped profiles but not on the shipped record page; an administrator adds it to the page header to use it.
EditEditEditEdit
NewNewNewNew
NewCreateNew CreateUIActionNew
  • Contact — looks up via CustomerSignedById
  • Asset — looks up via AssetId
  • Account — looks up via AccountId