ActiveServiceContractRequired | Active Service Contract Required | Boolean | | When on, a service order, opportunity or quote (header or line) that names this definition is refused unless the asset holds a matching, unused, unlapsed asset service contract, and the entitlement's date, hours and reading limits plus grace are checked. Not on the seeded forms; add it to the layout to set it. |
BillingAccountId | BillingAccount | Lookup → Account | | The payer for work under this definition, shown with the label BillingAccount. Customer invoices are made out to it when Bill To Partner Account is off; claims use it as the supplier account unless the asset's own service contract names a billing account. Not copied onto entitlements created at invoicing. |
BillToPartnerAccount | Bill To Partner Account | Boolean | Yes | When on, customer invoices raised from a service order for work under this definition are made out to the service order's partner account instead of the customer. Takes precedence over BillingAccount on invoices. Claims ignore this switch. |
ContractPostingTreatment | Contract Posting Treatment | PickList | | How covered work is billed: Generate Claims, Generate Invoices or Auto Generate Claims. An opportunity, quote or service order line that names this definition takes this value as its Posting Type when the line's item is on the definition's lines; otherwise a blank Posting Type becomes Generate Invoices. For the second and third contracts of a split line it decides whether the share is invoiced or claimed. Values: Generate Claims, Generate Invoices, Auto Generate Claims. |
CreatedById | Created By | Lookup → UserAccount | Yes | |
CreatedDateTime | Created Date | DateAndTime | Yes | |
DateEffectiveFrom | Date Effective From | Date | | First invoice date on which selling the contract item creates entitlements from this definition. Blank means no lower limit. It does not affect entitlements that already exist or which definitions a service order can name. |
DateEffectiveTill | Date Effective Till | Date | | Last invoice date (inclusive) on which selling the contract item creates entitlements from this definition. Blank means no end. Existing entitlements keep their own valid-till dates. |
ExternalId | External | Text, unique | | |
FromDays | From Days | Decimal | | Days after the invoice date at which the service falls due: the entitlement's Due Date is the invoice date plus this value. Contract-schedule campaigns send reminder leads against that due date. |
GraceUsageDays | Grace Usage (Days) | Decimal | | Days added to the entitlement's valid-till date before it counts as lapsed. Copied onto each entitlement at invoicing; the checks read the entitlement's copy. |
GraceUsageHours | Grace Usage (Hours) | Decimal | | Hours added to the entitlement's valid-till hours before it counts as lapsed. Copied onto each entitlement at invoicing. |
GraceUsageReading | Grace Usage (Reading) | Decimal | | Reading (for example kilometres) added to the entitlement's valid-till reading before it counts as lapsed. Copied onto each entitlement at invoicing. |
Id | Id | Guid | Yes | |
IsActive | Is Active | Boolean | Yes | Shown on the record but not read by any process: an inactive definition still creates entitlements when its item is invoiced and is still offered in the service order and line pickers. Use Date Effective Till to stop new sales creating entitlements. |
IsScopeRestricted | Is Scope Restricted | Boolean | Yes | When on, a line that names this definition needs a matching asset service contract, its item must be one of that entitlement's scope lines, and its quantity must not exceed the scope line's pending quantity. Not on the seeded forms. |
ItemId | Item | Lookup → Item | | The contract item (Item Type Service Contract) whose sale creates entitlements from this definition. An invoice line matches when its item equals this item, or its SKU equals the definition's SKU. |
ItemLotTypeId | Item Lot Type | Lookup → ItemLotType | | Not read by any process: entitlement creation matches on item or SKU only, so the lot type does not restrict anything. Not on the seeded forms. |
MaximumUsageHours | Maximum Usage (Hours) | Number | | Upper end of the hours band. Service order and opportunity headers that name this definition must record Usage Reading (Hours) at or below it (0 means no upper bound for that check). Copied to the entitlement's valid-till hours, where 0 makes any recorded hours reading count as lapsed. Must be at least Minimum Usage (Hours). |
MaximumUsageReading | Maximum Usage (Reading) | Decimal | | Upper end of the reading band (for example kilometres). Headers that name this definition must record Usage Reading at or below it (0 means no bound for that check). Copied to the entitlement's valid-till reading, where 0 makes any recorded reading count as lapsed. Must be at least Minimum Usage (Reading) when set. |
MinimumUsageHours | Minimum Usage (Hours) | Decimal | | Lower end of the hours band, also copied to the entitlement's due-in hours. A seeded validation refuses any save, new or edit, while this is 0 or less (message: Usage Hours cannot be less than 0), so enter a positive value. Headers that name the definition and record Usage Reading (Hours) below it are refused. |
MinimumUsageReading | Minimum Usage (Reading) | Decimal | | Lower end of the reading band, also copied to the entitlement's due-on reading. Headers that name this definition and record a Usage Reading below it are refused; 0 means no lower bound. |
ModifiedById | Modified By | Lookup → UserAccount | Yes | |
Name | Name | Text | Yes | The definition's name, typed by you; there is no numbering series. It is what pickers on service orders, opportunities, quotes, campaigns and the mobile service case form show. |
OwnerId | Owner | Lookup → UserAccount | Yes | |
PopulateContractLines | Populate Contract Lines (Future Use) | Boolean | Yes | Labelled Populate Contract Lines (Future Use). Not read on the definition and not copied to entitlements; the switch that adds lines to new documents is the one on the asset service contract. |
RecordTypeId | Record Type | Guid, hidden | | |
RestrictAssetContractLinesGeneration | Restrict Asset Contract Lines Generation | Boolean | Yes | When on, entitlements created at invoicing get no scope lines; otherwise every definition line is copied with its component item and quantity. Not on the seeded forms. |
ServiceType | Service Type | PickList | | Descriptive only, whichever value is chosen: no process or picker filter reads it. The service order line picker filters on Application To Type instead. Values: Warranty Repairs, Paid Repairs, Maintanence, AMC. |
SingleUseContract | Single Use Contract | Boolean | Yes | When on, a line that names this definition needs a matching asset service contract, and one marked Is Utilized is refused with This is a Single Use contract and has already been utilised!. No process sets Is Utilized, so mark it on the entitlement once it has been used. |
SKUId | SKU | Lookup → SKU | | Optional SKU of the contract item. An invoice line also matches this definition when its SKU equals this one. Not on the seeded forms. |
ToDays | To Days | Decimal | | Days after the invoice date at which cover ends: the entitlement's valid-till date is the invoice date plus this value (plus Grace Usage (Days) before it lapses). Left at the default 0, the entitlement lapses the day after the sale. |
UIProps | UI Props | Text | | |
UpdatedDateTime | Modified Date | DateAndTime | Yes | |
WeightageInvoiceChargeItemId | ItWeightage Invoice Charge Itemem | Lookup → Item | | The charge item used when this definition is the second or third contract on a split service order line: its share is raised as a separate invoice line or claim line for this item. A split line naming a definition without it is refused. |