xMatix
Sign in Request demo
xMatix
PRODUCTS
SalesField SalesCRMRewardsClaimsInventoryProcurementWarehouse 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
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 Line — entity reference
REFERENCE · Last reviewed

Contract Line — entity reference

One covered-scope line of a service/maintenance agreement: the catalog Item covered or supplied, quantity and pricing (unit price, cost price, discount), the count of customer assets covered, contracted hours, and the preventive-maintenance visit cadence. Multi-year agreements are split into one line per contract year (YearNumber against ContractYears). Billing and delivery can be redirected per line via Bill To Account and Ship To Account, which may differ from the owning Account. It is the parent of PMTask (the individual scheduled maintenance visits). Important: in first-party metadata ContractLine has no foreign key to the Contract header — its only relations are to Account, Item and PMTask — so an agent cannot join Contract to ContractLine without tenant customization.

Fields

FieldLabelTypeRequiredWhat it does
AccountIdAccountLookup → AccountThe customer Account this line serves. This is the line's anchor relationship: ContractLine has no foreign key to the Contract header in first-party metadata.
AssetcountAsset countNumberNumber of customer assets covered by this line. A stored count, not a rollup — no first-party code recomputes it from asset records.
BilledAmountBilled AmountDecimalAmount billed against this line so far. A stored value maintained by entry or import — no first-party handler recalculates it from invoices.
BillingTreatmentBillingTreatmentPickListClassification of how the line is billed. Picklist-typed but with no first-party values seeded — the vocabulary is tenant-defined.
BillToAccountIdBill To AccountLookup → AccountAccount invoiced for this line when billing is redirected; it may differ from the line's owning Account.
ContractHoursContract HoursNumber
ContractYearsContract YearsNumberTotal duration of the parent agreement in years; used together with YearNumber when a multi-year agreement is split into one line per year.
CostPriceCost PriceDecimal
CreatedByIdCreated ByLookup → UserAccountYes
CreatedDateTimeCreated DateDateAndTimeYes
DiscountDiscountPercent
IdIdGuidYes
IspartssupplyIs parts supplyBooleanFlags a parts-supply line as opposed to a service/maintenance line. Defaults to false; no first-party server logic branches on it.
IsunderwarrantyIs under warrantyBooleanFlags that the equipment covered by this line is still under warranty. Defaults to false and is informational in first-party code — no billing logic branches on it.
ItemIdItemLookup → ItemLookup to the catalog Item (service or part) that this line covers or supplies.
LineitemdescriptionLine item descriptionText
ModifiedByIdModified ByLookup → UserAccountYes
NameNameTextYes
OwnerIdOwnerLookup → UserAccountYes
QuantityQuantityNumber
RecordTypeIdRecord TypeGuid, hidden
RemarksRemarksText
SeriesSeriesText
ShipToAccountIdShip To AccountLookup → AccountAccount receiving the delivery or service for this line when it differs from the owning Account.
SubscriptionKeySubscription KeyGuid, hiddenYes
UnitPriceUnit PriceDecimal
UpdatedDateTimeModified DateDateAndTimeYes
VendornameVendor nameTextVendor name captured as free text — not a lookup to Account or any supplier entity.
VisitFrequencyVisit FrequencyPickListHow often preventive-maintenance visits are due under this line. Picklist-typed with no first-party values seeded, and informational only: no first-party scheduler creates PMTask rows from it.
YearNumberYear NumberNumberWhich contract year this line covers when a multi-year agreement is split into per-year lines; read alongside ContractYears.

Actions

ActionLabelTypeWhat it does
CloneCloneServerAction (Clone)Create a copy of this record
deletedeleteDeleteDelete
NewNewNewInlineNew
  • Item — looks up via ItemId
  • Account — looks up via ShipToAccountId
  • Account — looks up via AccountId
  • Account — looks up via BillToAccountId
  • PMTask — referenced by via ContractLineId